How to use IBM App Connect with Crystal Ball

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Crystal Ball

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page or flow editor. If necessary, work with your Crystal Ball administrator to obtain these values.

Crystal Ball connection fields:

• Server URL: Specify the URL for the API server that makes runtime calls.
• Access token: The access token used to access the Crystal Ball APIs.
• Allow self-signed certificates: Set to true or false. Set to true if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false.
• Override server URL: Required if you want to connect to an endpoint in a private network by using the private network client, or if you want to override the server URL. Specify an override value for the host and port for the connector in the format <http or https>://<host_name>:<port>. If you are not using the private network client or do not require an override, leave this field blank.
• Private network connection: Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)

To obtain the connection values for Crystal Ball, see Obtaining connection values for Crystal Ball.

To connect to a Crystal Ball endpoint from the App Connect Designer Applications and APIs page for the first time, expand Crystal Ball, then click Connect.

General Considerations

Before you use App Connect Designer with Crystal Ball, take note of the following considerations:

• You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

  For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and Actions

Crystal Ball events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Crystal Ball actions

Your flow completes these actions on this application.