Create an Agent Group

Before installing the connectivity agent, you must create an agent group in Oracle Integration. For a single Oracle Integration instance, you can create up to five agent groups. You can associate up to two connectivity agents with an agent group.

Creating the agent group also creates the necessary artifacts required for message exchange, including an OAuth client application in your identity domain or Oracle Identity Cloud Service environment. The OAuth client application allows the connectivity agent to use OAuth 2.0 token-based authentication when invoking Oracle Integration endpoints. You can edit the connection name after creation.

  1. Plan your connectivity agent setup, including the number of agent groups to create and the number of agents in each group.
  2. In the navigation pane, click Design, then Agents.
  3. Click Create.

    The Create agent group panel opens.

  4. Enter the following information, then click Create.
    Field Description

    Name

    Provide a meaningful name so that others can understand the agent name. The name must be unique among all agent names in the system. The name can consist of the following:

    • Letters (A-Z, a-z)

    • Numbers (0-9)

    • Spaces ( )

    • Special characters ( _ - )

    The name must not begin or end with a space and cannot be longer than 50 characters.

    Identifier

    Accept the default identifier value or change it, if necessary. The identifier is initially the same as the agent group name you provided, but in upper case. When you install the agent, the identifier value is automatically included in the InstallerProfile.cfg file.

    Note: After creating the agent group, you cannot edit the agent group identifier. Instead, you must delete and recreate another agent group to associate with a different agent group identifier.

    Description

    Provide a meaningful description so that others can understand the responsibilities of the agent group.

    Use only one agent at a time

    If you plan to associate two connectivity agents with the agent group, you must specify whether one or both agents are active at any given time.

    The preferred setup for a production service instance is associating two agents with the agent group and leaving this setting disabled. However, if you use some specific adapters, you might need or want to enable this setting.

    Spend a few minutes planning your setup because you can't change this setting later. (But you can delete an agent group and create it again.)

    Notes:

    • If you select Use only one agent at a time and then associate only one connectivity agent with the agent group, the agent group works as if you never selected the option. You must associate a second agent with that agent group to achieve active-passive agent functionality.

    • You cannot change the Use only one agent at a time setting after creating an agent group. However, you can delete the agent group and create a new agent group.

    This action automatically creates an OAuth client application in the identity domain or Oracle Identity Cloud Service. The application name takes the following form:
    agent_group_name-instance_identity_provider_name

    This enables the connectivity agent to use OAuth 2.0 token-based authentication when invoking endpoints. In Oracle Integration 3, each agent group has its own OAuth client application.

If you enabled Use only one agent at a time, the label Singleton appears next to the agent group name.