Skip to Content

Activities

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 for Harmony organization administrators (members of a role with the Admin organization permission) or members of a role that has been granted Execute environment access to cancel any operation that has not completed.

Members of a role that has been granted View Logs environment access can also access the Activities page.

To access the Activities page, log in to the Harmony Portal, then use the Harmony Portal in the top left to go to Management Console > Activities:

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 Harmony Portal).

Operation logs can also be viewed from the Cloud Studio operation logs and Design Studio operation logs pages.

Managing Activities

The Activities table shows information about each operation, referred to as an operation log. Operations from both Cloud Studio and Design Studio projects are included.

Operation logs, including detailed log messages from both Cloud Agents and Private Agents, are retained for 30 days by Harmony.

Important

By default, successful API operations (configured for Custom APIs or OData Services) are not included in the operation logs unless one of these settings is enabled:

  • Cloud Agents: For API operations on a Cloud Agent, operation debug logging must be enabled on the operation.
  • Private Agents: For API operations on a Private Agent, either operation debug logging must be enabled on the operation or you must set EnableLogging=true in the [APIOperation] section of the Private Agent configuration file.

  • attachment

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

      Status
      Icon Description
      SUBMITTED attachment When operations are submitted to the Harmony queue, but have yet to be picked up by an agent for execution, they will have a Submitted status. Operations can be submitted via several means:
      • Jitterbit scheduling service or external scheduling service
      • Manual execution of the operation in Cloud Studio or Design Studio
      • A RunOperation() function from a script or transformation
      • Any tool, including JitterbitUtils, that calls the Harmony API
      RECEIVED No Icon Once an agent is picked and the agent has acknowledged that it has received the request to run an operation, the status is changed to Received.
      PENDING attachment Once an operation is scheduled to run in an agent's operation engine, the status is changed to Pending. Operations should not be in Pending status for long durations, as agents should pick up the request and start running operations in a short amount of time.
      RUNNING attachment Once the agent starts executing an operation, the status should change to Running. Operations will remain in this status until they complete or they encounter an error. Jitterbit will start logging messages generated by the operation as it runs so that users can track which part of the operation is currently being executed.
      CANCEL REQUESTED attachment

      If you want to stop an operation that is in Submitted, Received, Pending, or Running status, click the "X" in the far right column, Cancel.

      Alternatively, you can enable another operation to cancel an operation using a combination of the GetOperationQueue() function and CancelOperation().

      Once a cancel is requested, the operation status will change to Cancel Requested. An operation should not remain in this status for long, as the agent should cancel the operation in a fairly short period of time.

      CANCELED attachment Once an agent cancels an operation, it sets the status to Canceled and the operation is terminated. All log information up to the point of cancellation will be available for review in the log messages, so the user will know at which point the operation was canceled. The log messages also indicate if the operation was manually canceled by a user.
      SUCCESS attachment Once an agent completes the execution of an operation, if the outcome was a success without warnings from the target system, or warning written in the transformation using the WriteToOperationLog() function, then the status is set to Success.
      SUCCESS WITH INFO attachment If the agent completes the execution of an operation, but there were non-fatal issues in the transformation or posting to the target system or the WriteToOperationLog() function was used to write messages to the log, then the status is set to Success with Info. This alerts the user to check for information in the log messages.
      SUCCESS WITH WARNING attachment If the agent completes the execution of an operation, but there were non-fatal issues in the transformation or posting to the target system, and there was a warning, then the status is set to Success with Warning. This alerts the user to check for warnings in the log messages.
      SUCCESS WITH CHILD ERROR attachment If the agent completes the successful execution of an operation, but within one or more child operations, there was a fatal error in writing to the target system, or there was a fatal validation error in the transformation, or the transformation logic triggered the RaiseError() function, then the operation status is set to Success with Child Error. This status does not apply to asynchronous operations.
      ERROR attachment If the agent completes the execution of an operation, but there was a fatal error in writing to the target system, or there was a fatal validation error in the transformation, or the transformation logic triggered the RaiseError() function, then the operation status is set to Error and the operation execution terminates.
      SOAP FAULT attachment If the agent completes the execution of an operation, and the outcome was a SOAP fault, then the status is set to SOAP Fault. This status is applicable only for operations using a Cloud Studio SOAP or Salesforce endpoint, or for operations using Design Studio Web Services or the Salesforce Wizard.
      DELAYED STATUS No Icon If the agent does not return an operation log for any reason, Delayed Status is displayed. Harmony will attempt to fetch logs six times, with a 10-second timeout between each call. Refresh or check the logs again later.

      Tip

      Functions documentation is available under Cloud Studio Functions or Design Studio Formula Builder, respectively.

    • Submitted Date: The time the operation run was requested.

    • Last Activity Date: The time the operation's status last changed.

    • Cancel: To stop an operation that is in Submitted, Received, Pending, or Running status, click the "X" in this column.

    Canceling Activities

    As noted above, canceling activities can be done using the rightmost column of the Activities table and clicking "X". There are two different types of canceling that can occur, either a hard cancel or soft cancel, depending on the operation's status:

    • Hard Cancel: An operation that is in Running status will be hard canceled after clicking "X" in the rightmost column. A hard cancel will send a request to the agent to immediately cancel the running operation and the status will change to Cancel Requested. Once the agent cancels the operation, the status will be set to Canceled.

    • Soft Cancel: An operation that is in Submitted, Received, or Pending status will be soft canceled after clicking "X" in the rightmost column. You may want to soft cancel an operation when an agent is not responding and the operation is remaining in Submitted, Received, or Pending status and is not changing to Running status. For a soft cancel, the status will be set to Canceled, though the operation may still run.

      Note

      A soft cancel does not send a request to the agent and may result in an operation that still runs.

    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:

    attachment

    • Calendar Datepicker: To search by predefined or custom dates, click the calendar icon attachment 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:

      attachment

      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:

      attachment

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

      attachment

    • 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. For example:

      • operation=New Delete returns any instance of the New Delete operation that has been run.

      • 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. For example:

      • project=SFDC-SAP returns any operation contained in the SFDC-SAP project that has been run.

      • 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. For example:

      • environment=DEnv returns any operation deployed in the DEnv environment that has been run.

      • 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. For example:

      • agent=Windows% returns all agents whose name begins with "Windows".
    • Status: Enter "status=" immediately followed by the status. For wildcard searches, enter the first few letters of the status followed by a percent (%) symbol. For example:

      • status=SUCCESS% would return all statuses starting with SUCCESS, such as SUCCESS WITH WARNING.
    • Date Submitted: Enter "submitted" immediately followed by an evaluation such as \<= or >=. Then enter the date or date range to search. For 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. For example:

      • lastActivity=10/04/2016 would return all activities on 10/04/2016.
    • Multiple Criteria: Enter multiple search criteria separated by a semicolon. For 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.

    Sorting 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, and Debug Files.

    Messages

    The Messages tab displays this information:

    attachment

    • Source Records: A count of records that have been read from the source system.
    • Target Records: A count of records that have been posted to the target system.
    • 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 (see Log Messages below).

    Log Messages

    Log messages include these log details:

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

    Log messages are accessible to users who are a member of a role with a minimum of Read organization permission and Execute environment access (see Harmony Permissions and Access). An environment access level of View Logs is not sufficient.

    Cloud logging is an option set in a Private Agent Group's settings (see Add Agent Groups in Agents > Agent Groups) that determines if log data is temporarily saved and accessible from within the Harmony cloud. Cloud logging is always enabled on Jitterbit Cloud Agent Groups. The information displayed in the Messages tab depends on whether cloud logging is enabled:

    • Cloud Logging Is Enabled: When cloud logging is enabled, log messages are displayed after Message:

      attachment

    • Cloud Logging Is Disabled: When cloud logging is disabled, log messages can be viewed securely using the link View log messages from Agent, if your network configuration allows direct access to the agent server. The log messages are generated from the Private Agent and are displayed in a separate browser tab.

      attachment

    Activity Logs

    If you are running an operation containing a Salesforce, Salesforce Service Cloud, or ServiceMax activity on a Private Agent, success and failure files are available for download in the Activities page of the Management Console. Select the relevant operation in the Activities table and click the Activity Logs tab in the bottom section of the screen to display download links for the files if available:

    success failure logs

    • Download Success File: If you are running the operation on a Private Agent, click the Download link to save the success records as a CSV file.

    • Download Failure File: If you are running the operation on a Private Agent, click the Download link to save the failure records as a CSV file.

    Note

    By default, success and failure files are automatically deleted from the Private Agent after 14 days by the Jitterbit File Cleanup Service. The number of days the files are saved can be changed by editing the [ResultFiles] section in the jitterbit.conf file. You can also change the success and failure file retention rules by editing the Jitterbit File Cleanup Service Rules for Private Agents.

    Activity log downloads are disabled for Cloud Agents. If the links are visible, you will receive an error message if you attempt a download.

    Debug Files

    If using Private Agents and debug mode is enabled, the Debug Files tab contains a link to download the debug logs. Debug logging allows you to log debug messages to files on a Private 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 Operation Debug Logging).

    Note

    Downloading of activity logs is disabled on Cloud Agents. Though a download link may be shown, you will receive an error message if you attempt to download using that link.