Integrations Page

Use the Integrations page of Administration Console to view and manage your deployed integrations. From this page, you can stop and start integrations, add a new deployment for an integration file, or delete an integration file from the Integration Service. You can also open a detailed view of each integration, where you can start and stop the integration and view the logged messages, action status, and variables that are related to the integration and its actions.

To open the Integrations page, click Integrations in the left navigation pane of Administration Console.

The page has two views: one for viewing and managing all deployed integrations and the other for viewing detailed information for a selected integration.

Deployed Integrations View

The deployed integrations view of the Integration page is displayed by default when you click Integrations in the left navigation pane of Administration Console.

The following options appear at the top-right area of this view:

Start All: Starts all currently deployed integrations.
Stop All: Stops all currently deployed integrations.
Add: Starts the Deploy Integration File wizard, which you can use to create and schedule a deployment for any of your saved integration files.

Integration file tables

Each deployed integration file is listed on the page by its file name, together with a table that lists the integrations that are contained in the integration file and that includes information about each integration, as described in the following columns:

Status: Indicates the status of the integration (such as running, waiting for events, or stopped).
Name: Displays the name of the integration.
Last Executed Event: Shows the last time that an integration event occurred during the integration's current run time.
Event Occurrences: Shows the number of events that occurred during the integration's current run time.
Last Error Message: Shows the last error message that was logged by the integration.

You can start or stop an individual integration, as follows:

Start: Starts the integration so that it begins to monitor for the integration event.
Stop: Stops the integration so that it no longer monitors for the integration event.

You can remove an integration file from the Integration Service, as follows:

Remove: Removes the integration file from the Integration Service. Because the integration file is no longer deployed, it is also no longer displayed on the Integrations page. This operation does not delete the integration file; you can re-deploy it at any time.

You can customize the integration file tables by changing the column width, sorting by ascending or descending order, or adding a filter. For more information, refer to Customizing the Message Output Table.

Detailed Integration View

To access the detailed integration view of the Integration page, click the name of the integration that you want from an integration file table in the deployed integrations view.

To return to the deployed integrations view, click at the top left of the page.

The following information and options are available in this view.

Integration Details

The integration details are located at the top of the status pane and include general information about the running of the integration. This information includes the following:

Integration Name: Displays the name of the integration. It includes the name of the integration file to which the integration belongs and the server on which the integration file is deployed.
Start: Starts the integration.
Stop: Stops the integration.
Status: Indicates whether the integration is stopped or waiting for events.
Event Occurrences: Indicates the number of events that occurred during the integration's current run time.
Last Started: Indicates when the integration was last started.
Integration Type: Indicates the type of integration.
Run Time: Displays the amount of time that elapsed since the integration was last started.
Last Executed Event: Indicates the last time an integration event occurred during the integration's current run time.
Number of Failures: Displays how many failures occurred during the integration's current run time.

Integration Events

The Integration Events section displays an event message for each time that an integration event occurred during the integration's current run time. The event messages are listed in the order in which they occur. The list displays the status for each event and any error messages. The toolbar includes the following controls:

Search: Searches the output messages by keywords that you enter.
: Copies the selected status message to the Clipboard.
: Plays back the selected event.
: Displays the previous event message.
: Displays the next event message.

You can view or save an event message by using the following methods:

To view an event message, point to the message, click the icon to open the Message Details dialog, or use the secondary mouse button to click the message and then click Message Details.
To copy the message to the Clipboard, click the icon to open the Message Details dialog and then click , or use the secondary mouse button to click the message and then click Copy Message Text.

When you use the secondary mouse button to click a message, the following options are available:

Message Details: Opens the Message Details dialog, which includes a Message area that provides message details and a Variable State area that provides information about the event variables and their old and new values.
Playback Integration Event: Plays back the selected event.
Show Latest Messages: Displays the most recent messages in the Integration Events area.
Copy Message Text: Copies the selected status message to the Clipboard.
Export: Opens the Save File dialog so that you can save the event as a file. The default file type is *.xml.

When you use the secondary mouse button to click a column header, options for customizing the message output table are available. For more information, refer to Customizing the Message Output Table.

Output

The output section at the bottom of the Integrations page displays details on the following tabs.

Messages

The Messages tab displays logged messages that are associated with the integration and its actions. By default, the message output table includes all errors, warnings, and messages. You can customize this table by clicking Errors, Warnings, or Messages to show or hide these items. You can also customize this table to make the messages easier to find and manage.

The Messages tab include the following options and controls:

Errors: Shows or hides the logged errors.
Warnings: Shows or hides the logged warnings.
Messages: Shows or hides the logged messages.
: Copies the event message to the Clipboard.
: Plays back the selected event.
Search: Searches the output messages by keywords that you enter.
: Displays the most recent messages in the list.
: Provides the following message options:
- View Output Messages in Window: Opens a separate Output Messages window, which you can scroll through to view the output messages that are related to the most recently tested integration. This window includes the same controls that are available in the Messages tab.
- View Message History: Opens the Integration Messages window, where you can quickly view the output messages for any of the integrations that are part of the integration file. In the left navigation pane, click the integration whose messages you want to view. This window provides many of the same controls as the Output Messages window and additionally includes a refresh control for refreshing the message list. You can also customize this window to make the messages easier to find and manage.
- Clear Messages: Clears the contents of the Message list.
- Export Messages to XML: Opens the Save File dialog so that you can export the messages to an *.xml file.
: Provides a list of available criteria to filter the messages by. To access this feature, point to the header of the column that you want to filter by (Status, Message, or Message Timestamp) until the icon appears, click the icon, and then click to select the criteria that you want to filter by. This icon is displayed automatically when a filter is in use.
: Opens the Message Details dialog for the message whose icon was clicked.