Updating event data lookup properties

You can modify event data lookup properties for Sterling B2B Integrator and specify event data lookup property names so that events in Sterling B2B Integrator are available in Global Mailbox.

About this task

Event data lookup is configured by default when you install Global Mailbox and Sterling B2B Integrator. If you need to change the default configuration, you can modify the event data lookup properties by using the appConfigUtility command.

To modify event data lookup properties for Sterling B2B Integrator:.

Procedure

  1. Locate the /<install_dir>/MailboxUtilities/admin/bin directory (UNIX/Linux) or \<install_dir>\MailboxUtilities\admin\bin (Windows).
    Tip: Replace <install_dir> with the directory where your instance is installed.
  2. Optional: To see the available options, run the ./appConfigUtility.sh (Linux® or UNIX) or appConfigUtility.bat (Windows).
  3. To modify event data lookup, type ./appConfigUtility.sh setEventDataLookup (Linux or UNIX) and appConfigUtility.bat setEventDataLookup (Windows).
  4. Enter the following parameters and values to suit your needs, in the format: ./appConfigUtility.sh setEventDataLookup <parameter="value"> (Linux or UNIX) and appConfigUtility.bat setEventDataLookup <parameter="value"> (Windows).
    Important: Replace <parameter="value"> with appropriate parameter and value. For example, to modify the application name, type ./appConfigUtility.sh setEventDataLookup --appName="B2Bi" (Linux or UNIX) and ./appConfigUtility.bat setEventDataLookup --appName="B2Bi" (Windows).
    --appID
    The unique ID of the application. The following value is an example for the --appID parameter:
    --appID="application id"
    --appName
    The name of the application. This name is displayed in the Application field in the user permissions wizard in Global Mailbox. The appName is ignored if appID is specified. The following value is an example for the --appName parameter:
    --appName="Sterling B2B Integrator" client 12
    --enable
    Specifies whether Sterling B2B Integrator supports event data lookup REST API. Valid values are true and false. The following value is an example for the --enable parameter:
    --enable="true"
    --dcName
    The name of a data center. Specifying a value for this parameter is optional. If a value is not specified, the default is the name of the local data center. The following value is an example for the --dcName parameter:
    --dcName="DC1"
    --baseURL
    Where Sterling B2B Integrator is accessed, in the format:
    scheme://host:port/context
    The following URL is an example:
    https://host.loc.ustx.ibm.com:99999/api/V1
    The appConfigUtility constructs the URLs by appending the following extensions:
    • ListUsers - /users
    • GetUsers - /users/{id}
    The following URL is an example construction by the appConfigUtility:
    https://host.loc.ustx.ibm.com:99999/api/V1/users
    --authUser
    The user ID for Event Data Lookup REST API authentication. During installation, the value of --authUser is gmbx_user.
    --authPassword
    The password for Event Data Lookup REST API authentication. During installation, the value of --authPassword is password.
    --removeURL
    The URL to be removed from the list of URLs for the specified data center. Specifying a value for this parameter is optional. This parameter can also be used to modify a base URL. To modify a URL, specify the URL name on the --removeURL option and specify its new value on the --baseURL option. The following URL is an example for the --removeURL parameter:
    https://host.loc.ustx.ibm.com:99999/api/V1
    --adminUser
    Global Mailbox administrator user. The following value is an example for the --adminUser parameter:
    --adminUser=admin
    --adminPassword
    Global Mailbox administrator password. A value for this parameter must be provided if --adminUser is specified. Otherwise, utility prompts for value. The following value is an example for the --adminPassword parameter:
    --adminPassword=password

What to do next

Important: You must run the setEventDataLookup command again under following circumstances:
  • If the user ID gmbx_user is deleted or changed. You must run the setEventDataLookup command and change --authUser and --authPassword.
  • If the host name or port of a Sterling B2B Integrator node changes. You must run the setEventDataLookup command and change the URL by specifying:
    --removeURL=<old URL> --baseURL= <new URL>
    Where
    • <old URL> is the old URL with the old host name or port of the Sterling B2B Integrator node
    • <new URL> is the new URL with the new host name or port of the Sterling B2B Integrator node
  • If Sterling B2B Integrator node is uninstalled. You must run the setEventDataLookup command and specify the URL of the uninstalled Sterling B2B Integrator node in the --removeURL option.