Versions Compared

Key

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

...

...


Info

This topic might be out-of-date and is replaced by the following:


In this article

Table of Contents
maxLevel2
absoluteUrltrue

...

Field Key

Type

Description

prepare_handoff_timestamp

String

The Pipeline runtime prepare handoff time.

feed_call

Boolean

A flag that indicates if the pipeline should increment the API meter (True/False).

class_fqid

String

The Pipeline class_id with version number at the end. Format: <class_id>_<version>.

duration

Integer

The Pipeline execution duration

parent_ruuid

String

The runtime ID of the parent Pipeline.

create_time

String

The time that the runtime is created.

snode_id

String

The Snaplex node ID of the Pipeline instance.

org_snode_id

String

The Snaplex node ID for the Org in which the Pipeline resides.

env_map

Map

The Snaplex environment.

instance_version

Integer

The version of instance captured by the API.

user_id

String

The user who ran the Pipeline.

project_snode_id

String

The Snaplex node ID for the Project in which the Pipeline resides.

notification

Map

Indicates if a notification is set up for the Pipeline runtime.

notification.recipients

String

Indicates who receives the notification.

notification.states

String

When runtime state is changed to one of the other states, send notification to recipients.

label

String

The label for the Pipeline.

class_version

String

The version of the Snap Pack.

snaplex_label

String

The name of the Snaplex and the JCC node label.

time_stamp

String

The time stamp of the current operation,  regardless of the runtime state.

error_list

List

List of errors encountered at runtime.

cc_start_ms

Integer

The start of the runtime on JCC node in milliseconds.

invoker

String 

The user who invoked the API.

poll_time_stamp

String

The time when the SnapLogic control plane receives the runtime from JCC node.

ccid

String

The ID for the JCC node instance.

delivery_options

Map

Delivery options set on a child Pipeline.

cc_external_uri

String

The external URI of the JCC node executing the Pipeline.

runtime_path_id

String

The identifier of the Snaplex, made by the following combination:  <subscriber_id>/<plex_environment>/<plex_location>.

documents_count

Integer

The number of documents processed in the runtime.

failure

String

Indicates if a failure occurred during document processing.

reason

String

Indicates the reason for a failure.

parent_pipeline_fqid

String

The unique ID for the Pipeline Execute Snap in the parent Pipeline that called the child Pipeline.

cc_end_ms

String

The end of the runtime on the JCC Node in milliseconds.

runtime_label

String

The name of the Snaplex.

cc_poll_ms

Integer

The time when the JCC node pushes the runtime status in milliseconds.

class_id

String

Instance identifier of the Pipeline instance.

statistics_time_stamp

String

The time at which the JCC node collects statistics.

cc_prepare_start_ms

Integer

The start time when the JCC node prepares the runtime.

instance_id

String

The Pipeline runtime instance identifier; it is the same as the Pipeline runtime ID.

parent_pipeline_ruuid

String

The runtime ID of the parent Pipeline.

plex_path

String

The path of the Snaplex.

resolution

String

The suggested action to take when the runtime fails.

cc_prepare_end_ms

Integer

The finish time when the JCC node prepares the runtime.

pipe_invoker

String 

The method of invocation.

referencesList

The references to other SnapLogic Assets in the Pipeline runtime, including the following reference types:

  • path. The path to the referenced Asset.
  • pipe_origin.  If applicable, the referenced parent Pipeline (indicated by pipe_exec or subpipeline).
  • time_updated. The time of the most recent Asset update.
  • asset_type. The type of Asset that is referenced.
  • snode_id. The type of ID for the referenced SnapLogic Asset.
message_historymap

The messages from a FeedMaster during the runtime. Each message includes the following timestamps:

  • recv_time. The time when a FeedMaster node receives the message to send to the JCC node.
  • start_time. The time when the JCC node receives the message from the FeedMaster node.
  • ack_time. The time when the JCC node acknowledges the message and removes it.
  • reply_time.  The time when the JCC node replies to a message sent from the FeedMaster node.
delivery_countIntegerThe number of messages delivered to the FeedMaster. Another field named JMSXDeliveryCount reports the same statistic.

Monitoring API Usage for Tasks 

...