Deploy

Deploy

Overview

Deploy is the tool of ConnectPlaza where you can upload your interfaces to your end users, the ConnectPlaza ConnectAgents. You can only enter the Deploy interface if you have permission to do so. 

First time to enter Deploy

If you enter the ConnectPlaza Deploy for the first time you will see the next selection screen.

In this screen you can select the agent you want to perform some actions to. After selecting the ConnectAgent, you will be presented with the main screen of ConnectPlaza Deploy.

 

If you are a developer you can see all the tabs you are licenced to, at the top of the screen. If you are an End User, you will probably only see the Deploy tab. 

This is the main screen of Deploy, when you have no connection to a ConnectAgent. When you first login into this application, you will probably have no ConnectAgent installed. You can get your ConnectAgent here. Deploy will configure it for you, and you can download it. 

As you can see, the ConnectPlaza Deploy screen is divided in a few sections. At the top left you will find the Agent generator, the Connection check and the Legend.

At the top right, above the Agent configuration tab, you will see a few buttons: 

  • The selector for the connectAgents End User (Developer only)
  • The Home button
  • Number of logged in users button
  • The help button

The workspace will tell you anything about your ConnectAgent, but we will discuss this later. For now it will show you the Agent configuration, as you have no connection to your ConnectPlaza Connect Agent. 

Agent generator

You can generate your ConnectPlaza Connect Agent by clicking on the  next to the Agent generator. In the Agent configuration, set the Use reverse connect on, this is by default. Do not change this value, until told by one of the ConnectPlaza employees. If this value is changes, press Save, to update the settings. You must generate the agent again after changing the settings, or you must modify your connectagent.properties file on the agent, in case of a production system. 

When you enter the Agent generator, you will be presented with the following screen: 

The ConnectAgent software must be installed on the End Users machine. To do this, look into the technical documentation about installing the ConnectAgent for your machine. 

Field Description
Use reverse connect This flag must be always on. Do not change this flag, until told by one of the ConnectPlaza employees

Internal IP-address (blank = 127.0.0.1)

Internal bind address for you ConnectPlaza ConnectAgent. This is the bind address where your internal network can access the ConnectAgent. If you use the default setting, you will only be able to access the ConnectAgent, from the machine on which it is installed (localhost/127.0.0.1). If you want to be able to access this ConnectAgent from other machines in your network, enter your machines IP address in this box

Agent HTTP port

HTTP port for your ConnectAgent, default 8088. Change if necessary. 

Agent HTTPS port

HTTPS port for your ConnectAgent, default 8443, Change if necessary

Agent License key

Your ConnectAgent license key. This value is for identification only. This value cannot be changed. 
Type*

 

Select your Analyze database connection. This selection will setup a default connection with the Analyze database at your site. Beware of the fact that not all JDBC drivers are available at default. To upload your driver .jar into the ConnectAgent directory <ConnectPlazaInstallDir>/jars/endorsed and restart your ConnectAgent.

ATTENTION!!

The following database types are for development / testing purposes only:

  • Embedded
  • InMemory

InMemory, means that the database is totally working in the computer's memory. If you restart the agent, the Analzye database will be lost and created again as an empty database.

If you use an Embedded database, the database is created on disk but will work for the biggest part in memory. So after restart, the data will be preserved. 

 

Press the Generate button to generate your ConnectAgent. The file will be presented to you via a download box. You can save the .zip file anywhere. 

Deploy, your home page

When open ConnectPlaza Deploy and you can connect to your ConnectAgent, you will see the following screen: 

This is your standard home page of Deploy. At the left you see the Agent generator you need this to generate a new ConnectAgent. 

Next you see that your ConnectAgent is connected with Deploy.

 

You can also remote restart your ConnectAgent here. Press the button, Restart agent, to do this

Last, you will see a legend. This legend refers to the interfaces.

In the cockpit of this screen you see a button to go to your Deploy workspace overview,  .

Under this button you will find the widgets. These widgets will be placed by ConnectPlaza. You can read these widgets or discard the widget by pressing the  button on the title of the widget. If you want to retrieve a widget, you can add them on this desktop again by pressing the empty widget. 

This will open the Add widget box.

Select the widget, by clicking on the widget you want to add to your desktop, the widget will be placed instantly.

Updates available for your agent

If there is an update available for your ConnectAgent, you will be notified on this dashboard by a orange box like below:

Click on this button and you will be rerouted to the Agent Updates page. 

Workspace overview

When you click the Workspace overview button, you will be redirected to the following screen: 

You can see 5 tabs on the screen

  • Business connectors
  • Certificate management
  • Agent updates
  • Agent configuration
  • Agent log

Business connectors

This are the available business connectors for this agent. Every row is an business connector. The row is divided into the following parts. 

Part Description
Indicator. This will tell you the status of the business connector. Check the Legend, to find out what the colours mean.
Name of the business connector. If the name is System, this business connector consists of internal or system interfaces needed to perform system tasks of the ConnectAgent. 
Number. This number represents the number of interfaces within the business connector. 

To open the business connector and see which interfaces are within the business connector, click on the arrow at the right of the row, the business connector will open. 

Interfaces

After you opened the selected business connector, you will see the interfaces you build in this business connector. 

You can see 4 parts on this screen. 

Part Description
Ready to install These interfaces are ready to install
Installed These interfaces are installed
Running These interfaces are installed and running
Problem These interfaces are installed, but have problems


You can see that every box has a  button. When you press this button, a menu will open. You can select one of the following options:

Option Description
Open your installation screen to install your interface
Stop the running interface
Start the installed interface
Open the log for the specific interface

 

Installing/Uninstalling/Updating an interface

To install or update an interface you select the Open option in one of the menu's. The following screen will be presented to you: 

On this screen you will find the created snapshots and releases you have created. Keep in mind that the system will only save five snapshots. Releases will always be saved and in this list. You can see that it is a release version by the extension -RELEASE, at the end of the version number. 

If you only want to see your release versions, you can remove the tick at the View snapshots selection box. Only the releases will be visible.

At the left you see some information about the interface:

At the right you see all the versions available to you. You can see a  near the version, which is installed on your system. When you click on the menu button at the installed version of the interface, you can Reinstall or Uninstall, the selected version of your interface. If you press the menu button with a version not yet installed on your system, you can Install this version on your ConnectPlaza ConnectAgent.

Menu Description
Reinstall This reinstalls the same version of your interface. This opens your installation dialog windows and you can alter your dynamic values. The old interface will be uninstalled from your system, and the same one will be installed on your system. 
Uninstall This will uninstall the interface from your system. It will be no longer available
Install Install the selected version to the system. If this is a new interface, it will be installed, otherwise the installed version will be uninstalled and the selected version will be installed. 

 

Updates available

You can see if an update is available if the indicator has an orange indication: . If you open the Business connector, you will see an indication at the interface itself, that there is an update available.

If you open the detail, via the Open option, you will see that a new version is available.

You can install the new version via the popup menu option Install. Stopping the interface is not necessary. After installation, the indication, for update available, will be removed.

Incompatible agent message

If you have built a new interface just after ConnectPlaza Cloud has been upgraded, your interface and your ConnectAgent will be out of sync. Your interface has a later version number and cannot be installed on your older ConnectAgent.

You can run the older version of but cannot upgrade to the latest version just build.

Stopping an interface

To stop a running interface select the option Stop from the popup menu.

Starting an interface

To start an interface, select the option Start from the popup menu. The selected interface will be added to the row Running if the interface started without errors.

Log

An installed interface, running or not, has a log file. This log file can be partial read via the deploy interface. The system will read 10.000 characters from the end of the logfile. If you need more information, you have to enter the system and check the logfiles by hand.
You can set the depth of the logging via this option. To open the log for the specific interface, select Log in the popup menu. 

You can scroll up and down to look into this logfile. To refresh the logfile, press the  button. To set the depth of the logging, select the appropriate selection at the top right corner of this screen. The options are:

Log depth Description
Tracelog You see only the components where the message has been passed
Tracelogmsg As same as tracelog, but the message will also be printed out
Minimal As tracelogmsg, only error messages
Normal Information logging and error messages
Full Debug information

 

 

Certificate management

With the Certificate management tab, you can administer your trusted certificates. You can manage your Java trust store with this application. 

Field Description
Alias Alias name of your certificate. This name will be used in your applications
Common name Common name of the certificate
Valid until Expiration date of the certificate
Remove button. Click this button to remove the certificate

 

Adding a certificate

Add a certificate to your trust store by clicking on the  button at the top right of the screen. 

Drag your certificate in this screen or click in the middle of the screen to open a File Upload screen, like this:

The file will be uploaded to the trust store. After you have uploaded all the certificates you need, restart your ConnectAgent by pressing the Restart agent button, in order to activate the new trust store. 

Removing a certificate

If you want to remove a certificate, select the  button at the end of the row of the certificate you want to remove from the trust store. You will be asked if you are sure you want to remove the certificate permanently.

Select Remove to remove the certificate. You have to restart your ConnectAgent by pressing the Restart agent button, in order to activate the new trust store. 

Agent updates

The system will download all available updates by itself. It will place them on your system, ready for installation. In this tab you can setup the behaviour, how the updates will be installed. You will see the next options:

 

Field  Description
The following updates are available These updates are available. If you click on the version number you will be redirected to the release notes page in the documentation website
Apply updates to version Here you can set your installation strategy
Select update report Here you can select the update report. The report will be shown in a window below this selection. 


You can set your install strategy by selecting one of the options below. 

Option Description
Always Downloads all updates available. 
Off Downloads no updates.
Only maintenance Downloads only maintenance updates 
<Version Number> You can select a version number here. The system will install all updates until this version. 

 

Save your selection and restart your ConnectAgent to activate your selection. If you have installed until the desired version number, the value will be set to OFF.

After the installation, you can retrieve the logfile via the Select update report selection box. Select the report from the selection list:

The report will be shown in the viewer like below.

REMEMBER!!!

If the backend / ConnectPlaza webservice is upgraded and you build a bundle, you will see the next version number as part of you version number of your bundle. You cannot deploy a bundle with a higher build version to an agent of a lower version. It will simply not work.

I.E. If ConnectPlaza is upgraded to version 3.4.0, and you build a bundle of your interface after the upgrade, you cannot deploy this bundle to a 3.3.x ConnectAgent. You MUST update your environment.

Agent configuration

As of version 3.5.0 you can configure your ConnectAgent settings, Analyze settings and Control settings from ConnectPlaza Deploy. These settings modify the connectplaza-agent.properties, connectplaza-analyze.properties and connectplaza-control.properties files.

The screen consist of two parts, the Connection Settings for the agent, and the configurator for the properties files.

Connection Settings

If you have downloaded a new agent, you can set/check  the initialization values here. There are two options for the ConnectAgent, running via the Reverse connect option or via a direct connection to the server. The default option is Use reverse connect. For more information about the using the reversed gateway, click here.

If, for some reason, you cannot use the reverse connect option, remove the flag. You will be presented the following options:

Field Description
Custom address (IP Part) IP address of the ConnectAgent, where the Deploy backend (at ConnectPlaza) can connect to, in order to connect to your ConnectAgent. This is an outside IP address.
Custom address (Port part) Port number of the IP Address for connecting the Deploy backend to your ConnectAgent. 

 

Press to save your settings. These settings will be inserted into the ConnectAgent when you  download it from the site. 

Configuration settings

This part of the screen shows the selected property file. You can select the following property files:

  • Analyze
  • ConnectAgent

Select the file using the dropdown selection box at the right of the screen:

The system is build to display all the settings in the property file, if there is a corresponding MetaTag in our system.

A line of the configfile will be displayed in the following format:

Checkbox if the selected option is active. If the checkbox is not set the option is commented out and the default value is used for this field.
Description of the property. This is set in a MetaDataFile of the ConnectAgent.

Value of the property.

 

If we look into the configuration file of this agent, we see the following setting for this property:

connect.jetty.connector.host=10.1.0.184

If we now disable this setting, this line will be commented  out with a #, the default will be active.

You see a few things are changed. You cannot add a value anymore, and the default value is show in the configurator.Now save the file, you must restart the agent to activate the new settings.

After saving the new settings you can check the configuration file you can see the changes:

#connect.jetty.connector.host=10.1.0.184

 

Agent log

You will see the last 10.000 characters of your ConnectAgent logfile here. If you need more information, you have to enter the system and check the logfiles by hand.
You can set the depth of the logging. You can scroll up and down to look into this logfile. To refresh the logfile, press the  button. To set the depth of the logging, select the appropriate selection at the top right corner of this screen. The options are:

Log depth Description
Tracelog You see only the components where the message has been passed
Tracelogmsg As same as Tracelog, but the message will also be printed out
Minimal As Tracelogmsg, only error messages
Normal Information logging and error messages
Full Debug information

 

As of version 3.6.0, files larger than 10 MB will not be displayed in the logs anymore. Instead a message will appear that a file larger than 10 MB is used. This is done to prevent memory issues within the ConnectAgent.

For instance:

20191007 11:49:56.078 [cpTaskScheduler-33] DEBUG c.o.myesb.connect.log.TraceLogger - GenericMessage [payload=ConnectMessageImpl [parts={msgprt0=ConnectMessagePartStringImpl [content=Payload 20971520 larger than 10485760 bytes, payload too large, id=msgprt0, partNumber=0, properties=]}, properties=(connectmessageTimestamp=1570441796045,connectmessageID=98ecc7de-13ee-4155-9238-4e878f939b11,file_name=10mb.txt,)], headers={myesb-channel-id=LFS-Pickup-and-send, myesb-component-id=null-producer-1, file_name=10mb.txt, flowstart=10710915066100, history=LFS.LFS-Pickup-and-send.file-pickup-1.FileConsumer,LFS.LFS-Pickup-and-send.file-pickup-1.filterChannel,LFS.LFS-Pickup-and-send.InboundServiceChannel,LFS.LFS-Pickup-and-send.Service,LFS.LFS-Pickup-and-send.OutboundServiceChannel,LFS.LFS-Pickup-and-send.null-producer-1.enricherOutboundChannel, myesb-componenttype-id=Producer, file_originalFile=E:\data\agent-testomgeving-360\connectplaza-agent\temp\in\10mb.txt, id=1b6c4236-da92-3c76-d3e7-0dec3b34b764, myesb-adapter-id=LFS, timestamp=1570441796077}]