Configuration types for integration servers and integration runtimes

Managing configuration objects from the Configuration page

The Configuration page provides a way to manage configuration objects independently of integration servers or integration runtimes. You can open this page by clicking the Configuration icon in the navigation pane. All configuration objects that you and other users have created in the Dashboard are displayed in the configurations table.

• If an App Connect Designer instance is created in the same namespace as your App Connect Dashboard instance, the configurations table includes configurations that were automatically created when the Designer instance was created. These configurations are prefixed with the name of the Designer instance. For example, if the Designer instance is named des-quickstart, you'll see configurations of various types that are named in the format des-quickstart-designer-xxx, where xxx represents an abbreviation of the configuration type. You cannot delete these configurations.
• If a switch server is installed in the same namespace as your App Connect Dashboard instance, three preconfigured entries named default-agentx, default-agenta, and default-privatenetworkagent are also displayed by default in the configurations table. These entries represent configuration objects (of type Agentx, AgentA, and Private Network Agent) for the switch server, which provides support for callable flows, remote administration, and private network connections.

Creating a configuration object

To create a configuration object of a particular type, click Create configuration. You can then select a configuration type and define valid content in the Create configuration panel. For more information, see the Learn more about the configuration types links at the bottom of this topic.

Updating a configuration object

To replace the content or settings of an existing configuration object with an updated definition, open the options menu for that configuration object and click Update.

When the Update configuration panel opens, update the configuration object as follows:

• If the configuration object is of type Accounts, which contains secrets, any fields that cannot be updated are disabled in Form view. The fields with sensitive data (which are depicted with a Show/Hide password icon ), will reveal a value of REDACTED if you click the icon. You cannot view the existing values for security reasons, but you can overwrite them if required; for example, to change a password or specify a new client ID or secret. (If you do not need to update a REDACTED value, you can leave it untouched. The text REDACTED is purely for display purposes and masks the real value.)
  

  For fields with non-sensitive data, the data is shown in plain text that you can overwrite. (Values that you do not update will remain unchanged.)

  
  Note:

  You can update the fields in Form view, but not in Code view.

  You can also use the Import file icon to import an accounts.yaml file that contains updated values for the configuration object. The settings in the file will completely overwrite your existing account details.

  You can also add or remove accounts as part of the update.

• For configuration object types that contain secrets and present a text editor for the content (for example, Agentx or setdbparms.txt), any fields that cannot be updated are disabled, and the text editor displays a value of REDACTED for security reasons. You can overwrite this value by pasting the contents of an existing file in the text editor (for example, agentx.json or setdbparms.txt).

  You can also use the Import file icon to import a file that contains updated contents for the configuration object. When you click View file contents to return to the text editor, you'll see the contents of the imported file.

• For the remaining configuration types, you can update the settings in the text editor, or import an updated file to replace the existing content. (Any fields that cannot be updated are disabled.) You can complete either of the following steps depending on the configuration type:
  • Overwrite the content of the text editor by pasting the contents of an existing file. Or use the Import file icon to import a file that contains updated contents for the configuration object, and then click View file contents to view the contents in the text editor.
  • Drag and drop the file into the boxed area, or click within the boxed area to select the file from a file browser.

To save your changes, click the Update button.

• If the configuration object is currently applied to one or more integration servers, or to integration runtimes at version 12.0.10.0-r1 or earlier, a restart is triggered for those integration servers or integration runtimes to apply the updated configuration.
• If the configuration object is applied to one or more integration runtimes (at version 12.0.10.0-r2 or later) and is of type Accounts, the updated configuration is automatically applied without triggering a restart of those integration runtimes. If the configuration object is applied to one or more integration runtimes and is of any other type, a restart is triggered for those integration runtimes to apply the updated configuration.

For information about the content and file formats that are required for the configuration types, see the Learn more about the configuration types links at the end of this topic.

Deleting a configuration object

To delete a configuration object that's no longer needed, open the options menu for that configuration object, click Delete, and then confirm the deletion. A configuration object cannot be deleted if it's currently deployed to an integration server or integration runtime.

You can use the search box to filter the entries in the configurations table.

Creating and selecting configuration objects while deploying an integration server or integration runtime

While creating an integration server on the Create an App Connect Integration Server page or an integration runtime on the Deploy to Integration Runtime page, you can view all existing configuration objects (that you and other users have created) when you progress to the Configuration view. These configuration objects are displayed in the configurations table and you can either select one or more configuration objects to use with the integration server or integration runtime, or you can create configuration objects by clicking Create configuration. For information about creating configuration objects, see the Learn more about the configuration types links at the end of this topic. After creating a configuration object, you can select its check box if you want to apply that configuration to the integration server or integration runtime.

If a switch server is installed in the same namespace as your App Connect Dashboard instance (for callable flow capability), a preconfigured default-agentx entry will be displayed by default in the configurations table. This entry represents the configuration object for the switch server. When you create an integration server or integration runtime that includes a callable flow, the default-agentx check box will be selected by default. Only clear this check box if you intend to use an external switch server instead. For information about creating a configuration object for an external switch server, see Agentx type. You must select this new configuration entry for the integration server or integration runtime before you create the server.

Learn more about the configuration types

Use the following links to learn more about each configuration type: