...
Below is a glossary of terms used in this Chapter.
Term Used | Meaning |
Named Configuration / Named Object | A name-value pair that stores the configuration given against the name specified |
Registry | A location within which all named configurations are stored |
Artifact | An artifact can refer to any entity in an Event Process that requires configuration. For example, service instances, routes, ports are some artifacts. |
...
The figure below shows the Configuration Repository View with the types of configuration available.
Figure 1: Configuration Repository View
...
To add a new service configuration, right-click on the Service node in the Configuration Repository view and select the Add Configuration option.
Figure 2: Context menu to add named configuration
Select the Guid and the Version of the service. Few components like FTPGet have multiple configuration types. Select the appropriate type and click Next, as shown in the figure below.
Figure 23: Service Configuration
To demonstrate the addition of a New Configuration, the FileReader is used as an example and the FileReader configuration details are displayed. Click on Next and the provide values of the for configuration. Click Finish to save the configuration, as shown in the figure below.
Figure 34: FileReader Configuration
To use the newly added configuration, open the Custom Property Sheet (CPS) of the component and click on the ellipsis button against the property FileReader Configuration, as shown in the figure below.
Figure 45: FileReader Custom Property Sheet
The FileReader Config dialog box is displayed. Select the Load from option and add the configuration name. Click on the Load button to load the configuration details. testService. Provide additional configuration details for the FileReader and click Finish to save the CPS settings.
By default, no named configuration is used. To use a Named Configuration, select it from the drop-down.
Figure 6: Named configuration appearing in the drop-down
The configuration set in the service configuration gets auto-populated.
Note |
---|
These auto-populated properties cannot be edited. |
Figure 7: Service configuration getting auto-populated
The named configuration that is referred by the component will be used by the component both at the time of configuration and at the runtime.
If the configuration property is a manageable property then it can be viewed from the Environment Properties section within the Event Process properties.
Figure 58: Event Process Environment Properties
...
To define a resource configuration, right-click on Resource in the Configuration Repository view and the select Add Configuration option. A dialog is displayed as shown in the figure below.
Figure 69: Resource Configuration
Provide basic details of the configuration and select the type of configuration required. Properties are automatically updated on the next page depending upon the type of configuration selected.
Click Next and provide configuration details that need to be filled in and click Finish to save the configuration, as shown in the figure below.
Figure 710: Connection Configuration
...
Open Custom Property Sheets of a component that has Connection Configuration details could be, for example, JMS: 4.0. Click the ellipsis button against the Connection Configuration property. This launches the dialog box shown in the figure below.
Figure 811: Connection Configuration
By default, no named configuration is used. To use a Named Configuration, select the Load it from option and type the configuration name and click the Load button to load configuration details, as shown in the figure below.
Figure 9: Loading Configurationthe drop-down.
Figure 12: Loading Configuration
The configuration set in the resource configuration gets auto-populated.
Figure 13: Resource Configuration auto-populated
Similarly, a resource configuration can also be created using the Save to option in the Named Configuration section.
...
A route configuration can be created using the Add Configuration option in the Configuration Repository view. Route Configuration contains route specific properties such as Compress Messages, Encrypt Messages and Durable Subscription. Select the Durable Source as "Route".
Figure 10: Route Configuration
To use a route named configuration on a route, select the route and in the route properties move to the Messaging section. A property called Configuration lists all route named configurations.
Select the named configuration requiredset. The corresponding configuration properties are automatically updated, though grayed out to prevent editing, as shown in the figure below.
Figure 11: Selecting Route Configuration
...
To add a configuration, right click on Selectors in the Configuration Repository view and select the Add Configuration option. The required selectors can be defined and saved as a Named Configuration using this dialog box displayed in the figure below.
Figure 12: Selector Configuration
To use the selector on the route being used, navigate to the Selectors tab in the Route properties section and select the Named Configuration from the the Configuration property drop-down menu in the property Configuration. The fields of the properties entered are grayed, as shown in the figure below so that they can not be edited. The properties entered are selected at runtime.
Figure 13: Using Selector Configuration on route
...
To use the Transformation Named Configuration, right click on a route and select the Configure Transformation > Use Named Configuration option, as shown in the figure below.
Figure 16: Using named configuration on route
...
In the Configuration Repository view, right click on Port and select the Add Configuration option to define a named configuration port, as shown in the figure below.
Figure 20: Port Configuration details
Provide details of the configuration name, environment, port type and destination type and click Next.
Figure 21: Input Port Configuration
- Provide the port messaging configurations such as transaction details, Number of Sessions, message selector and so on and click Finish to save the configuration as a Named Configuration as shown in the figure above.
- Once Named Configurations are added to the repository, a User has the choice to either define Port properties or to refer to an existing Port Named Configuration of the same type. This option is provided in the Messaging tab of Port properties.
- In the figure below, when the input port of a component (chat2) is selected, the property Configuration lists all the available input port Named Configurations. By default, no Named Configuration is used and the property is set to <None>.
- When a configuration is selected, the configuration details are loaded and the property fields are then grayed out to prevent further editing.
Figure 22: Configuration selection in port properties
...
To use the Workflow Named Configuration, select a component port and in the Properties view. Select the configuration as shown in the figure below. The configuration will be applied to the selected port.
Figure 24: Using workflow configuration on port
...
To add Runtime Arguments Named Configuration, right-click on Runtime Arguments in the Configuration Repository view and select the Add Configuration option. A dialog box is displayed as shown in the figure below.
...
- Destination Type
- Custom Destination
- Encryption Algorithm
- Encryption key
- Allow padding key
- Initialization vector(Optional based on Algorithm selected)
To add a destination named configuration, right click on Destination in the Named Configuration repository and select AddTo define a Destination Configuration, right click on Destination in the Configuration Repository view and select the Add Configuration option. Enter the configuration name, select the environment and click the Next button. Enter values for Destination Configuration and click Finish to save as the Named Configuration, as shown in the figure below.
Figure 30: Destination Configuration
To use the Destination Named Configuration, select a component port and in the Properties view. Select the JMSDetination as shown in the figure below. Select the list from Configuration and the configuration will be applied to the selected port.
Figure 31: Using Destination Configuration
Funclet Configuration
To use a function across multiple systems or applications, add funclets to the global repository.
Click the Add button to add named configuration. Refer to the Global Funclet Repository section to know how to configure.
MessageFilters Configuration
...
To define a MessageFilters Configuration, right-click on MessageFilters in the Configuration Repository view and select the Add Configuration option. Enter the configuration name, select the environment and click the Next button. Enter values for MessageFilters Configuration and click Finish to save as the Named Configuration, as shown in the figure below.
Figure 32: MessageFilters Configuration
To use the MessageFilters Named Configuration, select a component port and in the Properties view. Select the MessageFilters configuration as shown in the figure below. The configuration will be applied to the selected port.
Figure 33: Using MessageFilters configuration on port
...
This section explains how Users users can create new configurations, modify existing ones and use the configurations already defined at the time of orchestration:
...
At various locations in the Custom Property Sheet (CPS) of components, an option is provided to save the configurations defined in the CPS as a named object, as shown in the figure below. When this option is chosen, the configuration defined in the CPS of the component will be saved against the given named object at the time of closing/finishing the CPS wizard.
Figure 36: SMTP connection Configuration
Exporting /Importing Named Configuration
1. Local
To Offline
To export, right-click on named object and select the Export to offline mode to export the Named Configuration Offline.
To Local Disk
To export, right-click on named object and select the the Export to Local Disk option option to export the configuration to the local disk. The configuration will be stored in a zip file.
Figure 37: Importing from local disk
From Offline
To import, Right right-click on named object and select the Import from local disk icon as shown in the in the figure below and below and select the named configuration zip file from the local repository.
Figure 37: Importing from local disk
2. Offline mode
To export, right-click on named object and select the Export to offline mode to export the Named Configuration Offline.
From Local Disk
For importing to Server from offline mode, the server should be added in the list of connection available for offline mode, by default local server enterprise server will be in to list. In offline Named Configuration repository right click on the intended named object and select select Export to Server and and select server from the list of servers connections available.
...
Named objects can be deleted/renamed using the Configuration Repository view in eStudio. Right click on the desired named object in the Configuration Repository view and choose the appropriate option from the pop-up menu, as shown in the figure below.
Figure 38: Saving/Deleting/Renaming Configurations
...
The named objects that are referred from routes are resolved at the time of launching/synchronizing Event Processes. Note:
Note |
---|
During synchronization of an Event Process, changes made to named objects used by routes that already exist will not take effect. Only those changes made to named objects used by newly created routes take effect. |
Security
The permissions given below are available at the Enterprise Server Level to govern the usage of named configurations within Event Processes. By default, only the administrators' group is allowed to perform the actions protected by these permissions. Administrators can also assign permissions to other Users to perform one or more of these actions. Navigate to the Security -> Global Permissions page in the dashboard to view and modify these permissions.
...