View Jitterbit Developer Portal
- Created by Christina Jacobsen, last modified by Lisa Brown on Jan 05, 2021
Introduction
The Activities page of the Management Console shows the runtime status of operations and the sequence in which a related operation ran, as well as provides the ability to cancel any operation that has not completed.
To access the Activities page, log in to the Jitterbit Harmony Portal, then use the Harmony Portal in the top left to go to Management Console > Activities:
NOTE: Make sure you are accessing the desired organization, which can be changed in the top navigation bar (see Changing the Selected Organization in Jitterbit Harmony Portal).
Managing Activities
The Activities table shows information about each operation. Operations from both Cloud Studio and Design Studio projects are included.
This specific information is provided by column:
Operation | The name that identifies the operation as assigned by the user (see Cloud Studio Operations or Design Studio Operations). | |||||||||||||||||||||||||||||||||||||||
Project | The name that identifies the project that the operation belongs to. Projects can have operations that have the same name as operations in other projects. | |||||||||||||||||||||||||||||||||||||||
Environment | The name of the environment the operation was deployed to. Project environments often have operations with the same name, so knowing if the operation was in a certain environment (for example, development, test, or production) is critical to identifying the operation. | |||||||||||||||||||||||||||||||||||||||
Agent | The identification of the agent that the operation instance was assigned to. | |||||||||||||||||||||||||||||||||||||||
Status | This field can have these values:
TIP: Functions documentation is available under Cloud Studio Functions or Design Studio Formula Builder, respecitvely. | |||||||||||||||||||||||||||||||||||||||
Submitted Date | The time the operation run was requested. | |||||||||||||||||||||||||||||||||||||||
Latest Activity Date | The time the operation's status last changed. | |||||||||||||||||||||||||||||||||||||||
Cancel | To stop an operation that is in Submitted, Pending, or Running status, click the "X" in this column. |
Cancel Activities
As noted above, canceling activities can be done using the far right column of the Activities table. If you want to stop an operation that is in Submitted, Pending, or Running status, click the "X" in this column.
Search for Activities
You can search for activities either by using the calendar datepicker to the right of the search bar to select predefined or custom dates, or by entering search criteria directly into the search bar:
Calendar Datepicker: To search by predefined or custom dates, click the calendar icon
located to the right of the search bar. The dropdown will provide predefined searches for operations within the past 24, 48, or 72 hours, as well as the option to provide a custom time:
Click on any of the predefined times to load search results for the selected timeframe. Or click the Custom time option to open a popup where you can select your date/time criteria:
Search Bar: Using the search bar provides additional options for filtering data. Enter search criteria directly into the search bar located directly above the Activities table. The search criteria are explained below.
After your criteria are entered, click on the refresh icon
located to the left of the search bar to execute the search.
Operation Name: Enter "operation=" immediately followed by the name of the operation. For wildcard searches, enter the first few letters of the name of the operation followed by a percent (%) symbol.
EXAMPLE:operation=New Delete
returns any instance of the New Delete operation that has been run.EXAMPLE:operation=New%
returns all instances of any operations with names that start with "New".Project Name: Enter "project=" immediately followed by the name of the project. For wildcard searches, enter the first few letters of the name of the project followed by a percent (%) symbol.
EXAMPLE:project=SFDC-SAP
returns any operation contained in the SFDC-SAP project that has been run.EXAMPLE:project=SFDC%
returns all instances of any operation contained in any project name that starts with "SFDC".Environment Name: Enter "environment=" immediately followed by the name of the environment. For wildcard searches, enter the first few letters of the name of the environment followed by a percent (%) symbol.
EXAMPLE:environment=DEnv
returns any operation deployed in the DEnv environment that has been run.EXAMPLE:environment=DE%
returns all instances of any operation deployed to any environment name that starts with "DE".Agent Name: Enter "agent=" immediately followed by the name of the agent. For wildcard searches, enter the first few letters of the name of the agent followed by a percent (%) symbol.
Status: Enter "status=" immediately followed by the status. For wildcard searches, enter the first few letters of the status followed by a percent (%) symbol.
Date Submitted: Enter "submitted" immediately followed by an evaluation such as <= or >=. Then enter the date or date range to search.
EXAMPLE:submitted>=9/12/2016
would return all activities since 9/12/2016.Last Activity Date: Enter "lastActivity" immediately followed by an evaluation such as <= or >=. Then enter the date or date range to search.
EXAMPLE:lastActivity=10/04/2016
would return all activities on 10/04/2016.Multiple Criteria: Enter multiple search criteria separated by a semicolon.
EXAMPLE:operation=New%; submitted=04/04/2016
returns all instances of any operations with names that start with "New" and that were submitted to run on April 4, 2016.
Sort Activities
Click the column header in any column to sort the table based on the data in that column in ascending order. A white arrow pointing up will display in the column to the right of the header name.
Click the column header twice in any column to sort the table based on the data in that column in descending order. A white arrow pointing down will display in the column to the right of the header name.
Viewing Detailed Information
When an operation in the Activities table is selected, the tabs at the bottom section of the screen become available: Messages, Activity Logs, Debug Files.
View Messages with Cloud Logging Enabled
The Cloud Logging option determines if logging data will be temporarily saved and accessible from within the cloud. This option is set on the Agent Group. Cloud Logging will always be set to enabled in the Jitterbit Cloud Agent Groups. When this option is enabled, the logged data is temporarily stored on the cloud and viewable on the Messages tab of the Activities page.
The Source Records and Target Records display the number of records read from the source system and posted to the target. This information is displayed within the Message portion of the tab:
- System-generated message informing if the operation completed without any errors.
- Information and warning messages returned by either the source or target system.
- Validation warnings returned by the Jitterbit transformation, validation, and scripting services.
- User-defined messages included in the project design using the
WriteToOperationLog()
function.
View Messages with Cloud Logging Disabled
If Cloud Logging is set to disabled, logged data can only be viewed securely. When an operation is run, a link will display within the Messages tab of the Activities page. Click the link to display the logged information in a separate popup window generated from the Private Agent in which the operation was run.
The Source Records and Target Records display the number of records read from the source system and posted to the target.
Click the link "View log messages from Agent" in order to view additional information securely. The logged information displays in a separate popup window generated from the Private Agent running on a local machine located behind the organization's firewall. This information is displayed within the popup window:
- System-generated message informing if the operation completed without any errors.
- Information and warning messages returned by either the source or target system.
- Validation warnings returned by the Jitterbit transformation, validation, and scripting services.
- User-defined messages included in the project design using the
WriteToOperationLog()
function.
View Activity Logs
If the selected operation results in a success/failure file, this tab will contain a link to download those activity logs.
WARNING: Downloading of operation result files is disabled on agents in a Cloud Agent Group. For security, logs from Agents in a Cloud Agent Group are removed as soon as they are no longer required for an operation to execute properly. Though a download link may show in the Management Console, you will receive an error message if you attempt to download using that link.
View Debug Files
If debug mode is enabled, the Debug Files tab will contain a link to download the debug logs. Debug logging allows you to log debug messages to files on the Jitterbit Agent. You can enable debug mode at the operation level (see Cloud Studio Operation Options or Design Studio Operation Options) or at the project level (see Enabling Debug Logging).
WARNING: Downloading of operation debug files is disabled on agents in a Cloud Agent Group. For security, logs from Agents in a Cloud Agent Group are removed as soon as they are no longer required for an operation to execute properly. Though a download link may show in the Management Console, you will receive an error message if you attempt to download using that link.
Last updated: Jan 05, 2021
2 Comments
Anonymous
How can I get more than 10 results?
Success Admin
Thank you for your question. Please go to Getting Support and follow the instructions to submit a ticket to Support.