Runtime page in Jitterbit Management Console

Overview

Introduction

The Runtime 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.

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

Operation details table

The available columns are as follows:

• Name: The name of the API or operation associated with the log entry. For operation entries with children, click the Expand icon to reveal the entire chain. Click the Minimize icon to collapse an operation and its children. (Applies to all log types.)

• Log Type: The type of log entry: Custom API, Proxy API, or OData API for operations triggered by an API call, or Operation for operations run directly. (Applies to all log types.)

• Environment: The name of the environment the operation was deployed to. (Applies to all log types.)

• Status: The status of the log entry. For Custom API, Proxy API, and OData API log entries, this is the HTTP status code (see w3.org status code definitions). For Operation log entries, this is 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.

    Tip

    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 Studio SOAP or Salesforce endpoints, or Design Studio web services or Salesforce endpoints.)

  If an operation has operation debug logging enabled at the operation level, and the operation was run on a 10.48 or later agent, the Status column in the Debug Logging tab shows the status of the operation step:

  • 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. (Applies to all log types.)

• Finished: The time the operation's status last changed. (Applies to all log types.)

• Duration: The time elapsed between Started and Finished. (Applies to all log types.)

• ID: The unique identifier for the log entry. (Applies to all log types.)

• API Service URL: The complete URL for calling the API, including the base URL, service root, version, and any path parameters. This column is populated only for Custom API, Proxy API, and OData API log entries.

• Agent: The agent name. This column is populated only for Operation log entries.

• Project: The name of the project where the operation is running. This column is populated only for Operation log entries.

• Root Operation Instance GUID: 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. This column is populated only for Operation log entries. To copy the value, hover on it, then click Copy content.

• Operation ID: The operation's globally unique identifier (GUID). This column is populated only for Operation log entries. (This column is hidden by default.)

• Actions: Hover on an operation to reveal available actions. Actions differ by log type:

  For Custom API, Proxy API, and OData API log entries:

  • View: Open the log details.
  • Open API: Open the API in API Manager.

  For Operation log entries:

  • View: Open the log details.
  • 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.
  • Go to operation: Open the project in Studio, and select the operation. This action is available only for Studio operations, not Design Studio operations.

When there are more than 100 operations, they are split into pages of approximately 100 each. To keep linked operation chains intact, all child operations of the last parent shown on a page are included on that page, even if the total exceeds 100. You can move through pages 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 a log entry's details, select one in the table. The Messages and Logs drawer opens at the bottom of the window with the following tabs, depending on the log type:

• Custom API, Proxy API, and OData API log entries: Messages and Debug Logging.
• Operation log entries: Messages, Activity Logs, Debug Files, and Debug Logging.

Messages tab

The Messages tab content differs depending on the log type of the selected entry.

API log entries

When a Custom API, Proxy API, or OData API log entry is selected, the Messages tab displays details about the API call in the following collapsible sections: API information, Call information, Call log, and API Payload (when enabled).

API information

The API information section displays the following details:

• API: The name of the API that triggered the operation. Click to open the API configuration in a new tab in API Manager.

• Version: The version number of the API.

• API type: The type of the API, one of the following:

  • CUSTOM_API: A custom API created in API Manager.
  • ODATA: An OData API created in API Manager.

• Request Method: The HTTP method used for the API call. Possible values include GET, POST, PUT, DELETE, PATCH, and MERGE.

• API request ID: A unique identifier for the API request. You can use this ID to correlate logs across different systems and to search for specific requests. Click to copy the value.

• Source IP: The IP address of the client application or server that made the API request.

• API gateway: The API gateway that processed the request. This field shows the domain name of either the cloud API gateway or private API gateway that handled the API call.

• API service URL: The complete URL for calling the API, including the base URL, service root, version, and any path parameters. This is the full API service URL as consumed by the client.

• Source Application: The application or browser that made the API request.

Call information

The Call information section displays the HTTP request headers sent with the API call under a Request headers label. Each header is displayed as a key-value pair, such as accept, accept_encoding, content_length, fulluri, host, user_agent, and forwarding headers.

Call log

The Call log section displays system-level log messages generated during processing of the API request. Click to copy the log to your clipboard.

API Payload

The API Payload section displays the request and response payload data for the API call. This section is visible when one or both of the following are enabled in the API's Settings tab: Enable debug mode until or Show Request & Response Payloads in Logs.

The section is split into two panels:

• Request body: The payload sent with the API request.

• Response body: The payload returned by the API. If the response payload exceeds the display limit, it is shown with a (Truncated) label.

Each panel provides the following controls:

• Search: Search the payload for a specific string.

• Copy: Copy the payload to your clipboard.

• Download: Download the payload as a file.

Operation log entries

When an Operation log entry is selected, the Messages tab displays the following:

• Source Records: When using an FTP or Database activity as a source, the count of records that have been read from the source system is displayed. For other connectors, the count reads 0 regardless of the number of source records.

• Target Records: When using an FTP or Database activity as a target, the count of records that have been posted to the target system is displayed. For other connectors, the count reads 0 regardless of the number of target records.

• 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 Invoke Operation tool (when Raise error if operation fails is enabled) or the WriteToOperationLog() function.

  Note

  • Dates and times in log messages appear in their original format from the source and aren't converted to local browser time.
  • Log messages that exceed ~100 KB in size (~99,000 characters) are truncated, denoted with message truncated appearing at the end of the log.

  Click to copy or to download the log messages.

• Messages logged in pre-transformation scripts: Messages generated during pre-transformation script execution. Click to copy or to download.

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 View Logs environment access.
• 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 attempting to download logs generates an error message.

Debug Files tab

When debug logging is enabled for private agents, this tab contains a link to download operation debug log files. The debug files are removed after 1 day by default, or as configured in a private agent's cleanup rules.

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 a Studio operation's full execution hierarchy. The operation log view displays a split view with operation logs in the left panel and detailed log information for the selected operation in the right panel. The view uses the selected table controls to filter results. If operations are chained with operation actions or the RunOperation function, those operations are listed under the parent operation.

When operation debug logging is enabled, this tab may also display component input and output data and API request and response data (when the operation is triggered by an API Manager API). Request and response payload is included only when Show Request & Response Payloads in Logs is also enabled in the API's Settings tab.

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.

When you open the operation log view, the first operation log in the list is selected by default. The detailed log information for this operation appears in the right panel.

• Name: The name of the operation or operation step. The carets, 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 to collapse or expand all parent operations.

• 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 for operations (not operation steps):

  • 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 Studio, and select the operation.

• Refresh: Click to refresh the list of operation logs.

• Filter Columns: Click to open a drawer that allows you to reorder the columns or adjust their visibility in the operation list panel:

  

  • 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.

• Resize columns: Drag a column's Resize bar to resize it.

• Operation log: To show or hide a log for an individual operation, click an operation from the list.

  • 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, a graphical representation of the operation or operation step is displayed in the operation list panel.

Icons for activities and transformations used as operation steps are displayed. You can click an operation step to show or hide the component input and output data for that individual operation step. Each input and output log entry is limited to 100 MB. If the data for an individual input or output log entry exceeds 100 MB, 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.

API request and response data

When an operation is triggered by an API Manager custom API or OData API, the amount of information displayed in operation logs depends on which settings are enabled:

To enable operation debug logging, see operation debug logging for cloud agents or operation debug logging for private agents. To display request and response payloads, enable Show Request & Response Payloads in Logs in the API's Settings tab.

API information

The operation log can display the following information for API calls:

• API: The name of the API that triggered the operation.

  • Open API in new tab: Click to open the API in a new tab in API Manager.

• API type: This field can have one of the following types:

  • CUSTOM_API: A custom API created in API Manager.
  • ODATA: An OData API created in API Manager.

• Request Method: The HTTP method used for the API call. Possible values include GET, POST, PUT, DELETE, PATCH, and MERGE.

• API request ID: A unique identifier for the API request. You can use this ID to correlate logs across different systems and to search for specific requests. Click the copy icon to copy the value.

• Source IP: The IP address of the client application or server that made the API request.

• API gateway: The API gateway that processed the request. This field shows the domain name of either the cloud API gateway or private API gateway that handled the API call.

• API service URL: The complete URL for calling the API, including the base URL, service root, version, and any path parameters. This is the full API service URL as consumed by the client.

• Source Application: The application or browser that made the API request.

Call information

The operation log displays a Call information section with the HTTP request headers sent with the API call. Each header is displayed as a key-value pair, such as accept, accept_encoding, content_length, fulluri, host, user_agent, and forwarding headers.

Call log

The operation log also displays a Call log section with detailed trace information about the API request processing. This information can be used for troubleshooting API gateway issues, timeout problems, or understanding the API's internal processing flow. The specific content of the call log varies depending on the API configuration, gateway settings, and whether any issues occurred during request processing.

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, and status keys, values can include the wildcard character %, which matches any string. You can use value% (starts with), %value (ends with), or %value% (contains) patterns.

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

When the Execution tree view toggle is enabled, a query returns results for the full execution chain of any matching entry: for an operation key query, results include the full hierarchy of parent and child operations linked to the operation, as well as the parent API log entry if the operation was triggered by an API call. The keyword string is highlighted in blue within the results. When the Execution tree view toggle is disabled, only the entries directly matching the query are returned.

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 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. Your browser's locale determines how dates are shown.

  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.

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

  

  Select an auto refresh interval, one of Never (the default), 1 minute, 5 minutes, 15 minutes, or 30 minutes, then click the Save button.

  To refresh the table at any time, click Refresh.