Configure the IIB Agent

The page guides you on how to integrate IIB Agent on AIX, Linux, and Windows. The installation steps for IIB agent are the same for AIX, Linux, and Windows. The installation steps for IIB, ACE 11, and ACE 12 are also provided.

  1. Specify the settings for the agent-controller communication.
    In the controller-info.xml file, set these properties:
    • account-name : Account name of the controller login.
    • account-access-key : Access key. This key is used for verification with the controller.
    • application-name : Name of the application that the IIB server belongs to.
    • controller-host : Hostname of the controller.
    • controller-port : Port number of the controller. The SaaS Controller port is 443.

    • controller-proxy-host: Host name or IP address of any proxy required for the agent to connect to the controller.

    • controller-proxy-port: Port number of any proxy required for the agent to connect to the controller.

    • controller-proxy-username: Username for authenticating with the proxy.

    • controller-proxy-password: Password for authenticating with the proxy user.

    • controller-proxy-passwordfile: Full path name of a file containing the password for authenticating with the proxy user.

    • controller-ssl-enabled : SSL login. Set 1 to enable, 0 to disable. If you disable Controller SSL, you must set the restrict-tls property to false.
    • restrict-tls : Set true to use the best possible TLS version for all the Controller connections. By default, it is set to true .
    • controller-cert-file: Full path to the PEM format X509 certificate for SSL. See Enable SSL for the C/C++ SDK for more information on obtaining the file.
    • log-dir : Path to the directory containing the IIB agent log files. The default path is /tmp/appd . Logs that are written before this configuration are logged in this path.
    • log-level: Level of the logs. Set this property to trace|debug|info|warning|error. Error is the highest priority and trace is the lowest priority.
    • tier-name : Name of the tier representing the broker.
    • user-exit : Exit name of the user. This must be in the alphanumeric format, as provided to the mqsichangebroker command.
    • <log-settings> </log-settings>: Log settings of the agent. For more information, see Configure Agent Log File Size.
    • disable-correlation: Enable or disable correlation of specific backends. Set 1 to enable, 0 to disable.disable-http-correlation: Set 1 to enable, 0 to disable.disable-jms-correlation: Set 1 to enable, 0 to disable.disable-mq-correlation: Set 1 to enable, 0 to disable.
    • flow-level-visibility-enabled: Flow level visibility option. Set 1 to enable, 0 to disable. The default value is 0. See IIB Agent Flow Level Visibility.
    • <node-reuse>true</node-reuse>: Set this property to reuse the node names of historical VMs for new VMs. It prevents the rapid increase of differently named nodes. See Enable the Node Name Reuse.
    • <node-reuse-prefix>prefixName</node-reuse-prefix>: Use this property when node-reuse is set to true . If you do not set this property, the IIB agent generates node names as per the internal node name standards of IBM. See Enable the Node Name Reuse.
  2. Run the following command to stop the broker.
    mqsistop <broker_name>
    To configure user exits, your broker must be stopped.
  3. Install the IIB agent user exit.
    Ensure that the IIB agent user exit is enabled by default, for all the flows. Perform the steps based on the version applicable to you.
    OptionDescription
    IIB 10 Run the following command:mqsichangebroker <broker_name> -x <install-directory> -e <user_exit_name>
    ACE 11, ACE 12

    Perform the following in the node.conf.yaml file. You can find the file in the path: <path-to-installation-directory>/<broker-name>/node.conf.yaml.

    UserExits:

    • activeUserExitList: '<User Exit Name>' #Specify the name of user exit
    • userExitPath:'<path>' #specify the path.
    Note: The agent starts and stops with the broker, if it is installed on the broker.
  4. Run the following command to start the broker. 
    mqsistart <broker_name>
For IIB 10, you can monitor a subset of your message flows. You can exclude flows that are of less importance from being monitored by running the following command: 
mqsichangeflowuserexits <broker_name> -e <integrationServerName> -f <MessageFlow> -k <application_name> -i <user_exit_name>