Runtime Operations page in Jitterbit Management Console

Introduction

The Runtime Operations page is a table of operation logs. When an operation is executed, an operation log is generated. An operation log contains information about when and where an operation ran, the operation status, the number of source and target records processed, and any log messages. Whether detailed log messages are displayed depends on permission and access levels and whether cloud logging is enabled. When operation debug logging (for cloud agents or for private agents) is enabled for an individual operation, each operation log also contains input and output data for the operation.

To open the Runtime Operations page, select Management Console > Runtime Operations from the Harmony portal menu:

To access this page, you must be either a Harmony organization administrator (a member of a role with the Admin permission), or a member of a role with Execute or View Logs environment access.

By default, the Runtime Operations page does not show successful custom API or OData services API operations. To include them, enable operation debug logging on the operation, or, for private agents only, set EnableLogging=true in the [APIOperation] section of the private agent configuration file.

The page's tools and regions are mentioned throughout this document. They are identified in the image below:

Operation details table

The default table columns arrangement is as follows:

• Operation: The name of the Integration Studio or Design Studio operation. If an operation has children, click the Expand icon to reveal the entire chain. Click a Minimize icon to collapse an operation and its children.
• Environment: The name of the environment the operation was deployed to.
• Agent: The agent name.

• Root Operation Instance Guid: (beta) The globally unique identifier (GUID) of the operation's root (top-level) operation. This field is empty for root operations, and the column is hidden by default. To copy the value, hover on it, then click Copy content.

  Note

  Root Operation Instance Guid is a beta feature that will be developed further in the future.

• Status: The status of the operation, one of the following:

  • Submitted: An operation was submitted to the Harmony queue, but has not yet been accepted by an agent for execution.
  • Received: An agent acknowledges receiving the request to run an operation.
  • Pending: An operation is queued to run on an agent.
  • Running: An agent is executing the operation.
  • Cancel Requested: A request to cancel the operation has been made. Operations may show this status yet continue to run after canceling.
  • Canceled: The operation was canceled.
  • Success: The operation completed successfully.
  • Success With Info: The operation completed successfully with non-fatal issues.

  • Success With Warning: The operation completed successfully with warnings as shown in the log messages.

    An extra subelement warning in the log messages can generally be ignored. This warning indicates a connector's API payload returned more nodes or fields of data than those defined in the response data schema.

  • Success With Child Error: The operation completed successfully, but one or more child operations suffered fatal errors. (Applies to synchronous operations.)

  • Error: The operation failed.
  • Soap Fault: The operation failed with a SOAP fault. (Applies to operations with Integration Studio SOAP or Salesforce endpoints, or Design Studio web services or Salesforce endpoints.)

• Operation step status: Operation steps appear in the Debug Logging tab only when that operation has operation debug logging enabled at the operation level (for cloud agents or for private agents) and the operation was run on a 10.48 or later agent. Operation steps can have these possible statuses:

  • Complete: The operation step was executed and completed without any errors.

  • Error: The operation step was executed but could not be completed due to an error.

  • Incomplete: The operation step was not executed or completed. Possible reasons for this status include that the operation step is waiting to be executed or that there was an error in a previous operation step preventing the following step from executing.

• Started: The time the operation run was requested.

• Finished: The time the operation's status last changed.

• Actions: Hover on an operation to reveal the following actions:

  • Cancel Operations: Stop an operation that is in Submitted, Received, Pending, or Running status.

  • Go to operation: Open the project in Integration Studio, and select the operation.

When there are more than 100 operations, they are split into pages of 100 each. You can move through them using these navigation buttons at the bottom of the table:

• Previous Page: Go to the previous page.
• Next Page: Go to the next page.

To see an operation log's details, select one in the table. A drawer opens at the bottom of the window with four tabs, Messages, Activity Logs, Debug Files, and Debug Logging.

Messages tab

This tab shows the following:

• Source Records: The number of records read from the source system.
• Target Records: The number of records posted to the target system.
• Message: Log details including any of the following:
  • System-generated messages indicating that the operation completed without error.
  • Information and warning messages returned by either the source or target systems.
  • Validation warnings returned by the Jitterbit transformation, validation, and scripting services.
  • User-defined messages generated by the WriteToOperationLog() function.

To see an operation's log messages in the Messages tab, the following must be true:

• You must be a member of a role with a minimum of Read organization permission and Execute environment access. (An environment access level of View Logs is not sufficient.)
• Cloud logging is enabled on the private agent group. (Cloud logging is always enabled on cloud agent groups.) When disabled, and if your network configuration lets you connect directly to the agent host, log messages can be viewed securely by clicking the link View log messages from Agent.

Activity Logs tab

This tab contains links to success or failure files created by the Salesforce, Salesforce Service Cloud, or ServiceMax activities running on a private agent.

The files are in CSV format. To download one, click on its link.

Activity log files are automatically deleted after 14 days by the private agent's file cleanup service. You can change this behavior in the [ResultFiles] section of the private agent jitterbit.conf file, or by changing the file cleanup service rules.

Activity log downloads are disabled for cloud agents. You may see download links for cloud agent activity logs, but any attempt to download logs generates an error message.

Debug Files tab

This tab contains links to debug log files. When enabled, these are generated for all operations running on a private agent, or for selected Integration Studio or Design Studio operations running on any agent type.

Debug Logging tab

When debug logging is enabled at the operation level (for cloud agents or for private agents) and the operation was run on a 10.48 or later agent, this tab shows the details of an Integration Studio operation's full execution hierarchy. When the selected operation is linked with operation actions, logs for downstream operations are also included.

Parent operations (and any child operations beneath them) are sorted in ascending order by Started. The table can be sorted (for top-level operations only) by Name, Started, Finished, Duration, or Status by clicking the respective header row.

• Name: The name of the operation or operation step. The disclosure triangles, which can be used to expand or collapse additional rows, are shown on parent operations and on operations for which component input and output data are available:

  • Parent operations: When a parent operation is expanded, additional rows for its child operations appear in the order in which they were executed. By default, all parent operations are expanded. Use the collapse list or expand list icons in the column's header to collapse or expand all parent operations.

• Input/Output: Input and output data accessed through this part of the log table is described under Component input and output data.

• Started: The date and time the operation or operation step began running, displayed as the local browser time.

• Finished: The date and time the operation or operation step stopped running, displayed as the local browser time.

• Duration: The time elapsed between Started and Finished, reported in seconds for operations and in milliseconds for operation steps.

• Status: The status of the operation or operation step. For a complete list of possible statuses, see Operation details table earlier on this page.

• Actions: These actions are available:

  • Cancel operation: Enabled for operations that are in Submitted, Received, Pending, or Running status.

    Cancel operation sends a request to the agent to stop the operation. Once clicked, the Cancel Requested status is displayed next to the real-time operation status.

    Note

    Operations that have a Cancel Requested status may still run.

  • Go to operation: Open the project in Integration Studio, and select the operation.

• Operation log: To show or hide a log for an individual operation, click anywhere on an operation row except on the icons shown in the Input/Output column:

  

  • Log messages: Log messages include the log details for the selected operation. Whether log messages are displayed depends on the current user's permissions and access levels and whether cloud logging is enabled. For more information, see Messages tab earlier on this page.

    Note

    Dates and times displayed within the log messages themselves are not converted to local browser time, but are reported in their original format from the source of the log message.

  • Copy: Copies the log data to your clipboard.

  • Download: Downloads the log messages as a text file.

  • Show / hide: Shows or hides the log messages.

Component input and output data

Component input and output data is generated when an operation has operation debug logging enabled at the operation level (for cloud agents or for private agents) and the operation was run on a 10.48 or later agent.

When component input and output data is present, an Input/Output column showing a graphical representation of the operation or operation step is displayed in the operation log table.

In the Input/Output column, icons for activities and transformations used as operation steps can be clicked to show or hide the component input and output data for that individual operation step. Each input and output log entry is limited to 100MB. If the data for an individual input or output log entry exceeds 100MB, no data will be displayed.

• Search: Search the data for the entered text.

• Copy: Copies the log data to your clipboard.

• Download: Downloads the input or output data as a file in the appropriate data format. The file is named with the operation step name followed by _input or _output as appropriate.

Queries

A query is one or more key/value terms. Multiple terms are separated by semicolons. A term has the form <key><operator><value>. For the operation, project, environment, agent keys, values can include a wild card character, %, which matches any string.

To use a query, enter a valid query specification in the search bar then press return:

The following table shows the available query term components:

Query examples

The following are example query terms:

Saved queries

Queries can be saved and used, then edited or deleted, as follows:

• To save a query, click Save query. The query form opens:

  

  Enter or select values for the following fields, then click Save:

  • Name: A name for the query.
  • Query: One or more query terms using the same syntax as the search bar. You can add terms in the following ways:
    • Click the field to show a list of available search terms. Select one to enter it into the query field, then add an operator and a value.
    • Select one of the query suggestions.
    • Enter a query term, followed by a semicolon.

  • Columns: Select the columns to display in the search results.

    

  When saved, the Saved queries form opens:

  

  Click Saved queries to close it.

• To use a saved query, click Saved queries, then click the query you want to run. The query terms are copied to the query bar, and the query runs automatically.

• To edit a saved query, click Saved queries, click the Edit icon for query you want to edit. The query opens in the Edit query drawer:

  

  Edit the query, then click Save to save it, or Cancel to cancel.

• To delete a saved query, click Saved queries, then click the Delete icon for the one you want to delete. A Delete Saved Query dialog asks you to confirm. Click Delete to continue, or Cancel to cancel.

Time range

The Runtime Operations page returns time period shown in the time range menu:

To change the period, open the menu and select one of the following options:

• Last 24 hours
• Last 48 hours
• Last 72 hours

• Custom time: Select to open the Custom time dialog. With this, you can filter operations based on the dates for the Started and Finished fields:

  

  Click a calendar icon to open a date picker for a field:

  

  Set either or both of the from or to dates using the calendar.

  To set a time enter the hour and minute (in HH:MM) format and the time period (AM or PM).

  Click anywhere on the Custom Time dialog to close the date picker.

  When either or both field date ranges are set, click Apply. To clear the range, click Clear. To clear a field's dates, click its icon.

Page settings

You can sort the table, rearrange its columns, or refresh its contents:

• Sort: To sort the table in ascending order, click any column heading. Click again to reverse the sort order.

• Columns: To change the arrangement and visibility of columns, click Filter Columns. The Columns drawer opens:

  

  The drawer has the following controls:

  • Show All: Make all columns visible.
  • Move: Drag and drop to change the position of the column relative to others.
  • Hide: The column is visible. Click to hide it.
  • Show: The column is hidden. Click to show it.
  • Save: Save the columns.
  • Cancel: Close the columns drawer without saving changes.

• Refresh: The table updates automatically. The default interval is 5 minutes.

  To change the automatic refresh interval, click Settings. The Settings drawer opens:

  

  Select an auto refresh interval, one of 1, 5, 15, or 30 minutes, then click Save.

  To refresh the table at any time, click Refresh.