Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

    StatusIconDescription
    SUBMITTED
    Image Modified

    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
    • RunOperation() function from a script or transformation
    • Any tool, including JitterbitUtils, that calls the Jitterbit Harmony API
    RECEIVED
    No IconOnce 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
    Image Modified
    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
    Image Modified
    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
    Image Modified

    If you want to stop an operation that is in SubmittedReceivedPending, 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
    Image Modified
    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
    Image Modified
    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
    Image Modified
    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
    Image Modified
    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
    Image Modified
    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
    Image Modified
    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
    Image Modified
    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.
    Tip
    TIP: Functions documentation is available under Cloud Studio Functions or Design Studio Formula Builder, respecitvely.
  • 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 far right column rightmost column of the Activities table . If you want to stop an operation that is in SubmittedPending, or Running status, click the "X" in this column.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 SubmittedReceived, 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 SubmittedReceived, 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.

    Info

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

Anchor
search
search

...

Searching 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 Image Removed located icon located to the left of the search bar to execute the search.: 

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

  • TipEXAMPLE: 
  • For example:

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

  • TipEXAMPLE: operation
    • 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.
  • TipEXAMPLE: 
  • For example:
    • project=SFDC-SAP returns any operation contained in the SFDC-SAP project that has been run.
  • tip
  • 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.

  • TipEXAMPLE: 
  • For example:

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

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

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

  • TipEXAMPLE:
  • For example:

    • lastActivity=10/04/2016 would return all activities on 10/04/2016.
  • Multiple Criteria:  Enter multiple search criteria separated by a semicolon.

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

...

The Messages tab displays this information:

Image RemovedImage Added

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

...

Info
NOTE: Downloading of activity logs is disabled on Cloud Agents. For security, logs from Cloud Agents are removed as soon as they are no longer required for an operation to execute properly. Though a download link may be shown, you will receive an error message if you attempt to download using that link.


HideElements
metastrue

Easy Heading Free
headingIndent0
expandOptiondisable-expand-collapse
navigationTitleOn This Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default
HideElements
metastrue