AgentA type

Use the AgentA type to create a configuration object (or agent) that a deployed integration runtime requires to connect to a switch server and provide remote administration capability.


Summary of key details for the configuration type

File name or type Contains secrets Path extracted/imported to Maximum allowed per integration runtime
agenta.json Yes /home/aceuser/ace-server/config/iibswitch/agenta/agenta.json 1

About the agenta.json file

The AgentA type is used to provide an agenta.json file that the integration runtime requires to use a switch server and connectivity agents for remote administration. A switch server is a special type of integration server that routes data, and is typically created in the same namespace as your App Connect Dashboard instance, as described in App Connect Switch Server reference. Connectivity agents contain the certificates that your flows require to communicate securely with the switch server. An agenta.json file is used to configure the connectivity agents to connect securely to the switch server.

When a switch server is created, a configuration object of type AgentA is automatically created with the name switchServerName-agenta. If the switch server is created in the same namespace as your App Connect Dashboard instance, you see this preconfigured configuration object in the configurations table in the Dashboard, with the name default-agenta (assuming that the switch server was given the recommended name of default).

An integration runtime can connect to only one switch server, so you can select (or apply) only one configuration of type AgentA for an integration runtime. However, multiple integration runtimes can connect to the same switch server.

Note:

Because a configuration object of type AgentA is automatically provided for the default switch server, you can manually create a configuration object of this type only if you prefer to use an external switch server.

Creating a configuration for the AgentA type by using the configuration panel

If you want your integration runtime to connect to an external switch server instead of the internal switch server, you can create an AgentA-type configuration while creating an integration runtime, or independently, as follows:

  1. Open the Configuration page by clicking the Configuration icon Configuration icon in the navigation pane, or go to the Configuration view of an integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select AgentA from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that might help you identify the external switch server being used.
    Create configuration panel
  5. Complete the AgentA section by completing either of the following steps:
    • Copy the contents of your generated agenta.json file and then paste it into the AgentA text editor.
      AgentA text editor with pasted contents
    • Import your generated agenta.json file from your file system:
      1. Click the Import agenta file icon Import icon.
      2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
        Import agenta view

        The name of the imported file is displayed.

      3. If you want to view the file contents, click View file contents to return to the text editor.
        AgentA text editor with imported contents
    Tip: For security reasons, the agenta.json content that you add is available only as REDACTED content after you create the configuration. If you need to update this configuration later, you must upload another agenta.json file.
  6. Click Create. The configuration is added to the configurations table and can be selected for use with an integration runtime.

Updating or deleting a configuration

If you need to update the content or settings in a configuration, or delete a configuration that's no longer needed, see Managing configuration objects from the Configuration page.