Checkpoint

Checkpoint is a processor that holds jobs for human intervention. A SwitchClient user with the appropriate access rights can review jobs in a checkpoint and redirect them along any of the checkpoint’s outgoing connections. See Working with checkpoints.

The name shown to the SwitchClient user for each outgoing connection is the name of the connection, or if it is empty, the name of the target folder.

The backing folder for a checkpoint is always auto-managed.

Keywords

Keywords can be used with the search function above the elements pane.

The keywords for the Checkpoint element are:

Internet
web
network
communication
transfer
interact
client
user
route
approve
metadata

Connections

Checkpoint allows any number of outgoing move connections.

Properties

Property	Description
Name	The name of the flow element displayed in the canvas
Allow multiple outputs	If set to yes, the SwitchClient user can send copies of a job along more than one outgoing connection; otherwise the job is sent along exactly one of the outgoing connections
Enable report viewing	If set to yes, SwitchClient offers extra buttons to view or save a report obtained by retrieving the metadata dataset named in the property described below This feature is most often used with datasets picked up through a traffic-light connection by setting "Carry this type of files" to "Data with log"
Report dataset name	The metadata dataset name for the report to be viewed by the client
Allow replacing job	If set to yes, SwitchClient displays an extra button that allows the user to replace the job with a new version (presumably edited on the client user's computer) before moving it out of the checkpoint; the original job is lost, but its metadata is preserved See Replacing a job for more information on the replacement process
Display metadata	If set to yes, SwitchClient shows the user a list of values determined by evaluating script expressions in the context of the job (so that the values can be derived from metadata attached to the job); see Using metadata and Defining client fields for more information
Metadata fields	Definitions for the metadata fields to be displayed (read-only); see Defining client fields for more information
Require metadata entry	If set to yes, the SwitchClient user is asked to complete metadata fields before moving along a job; see Picking up metadata and Defining client fields for more information
Metadata fields	Definitions for the metadata fields to be entered; see Defining client fields for more information
Dataset name	A name for the set of metadata entered here; see Picking up metadata for more information
Attach user as email info	If set to yes, the handling user's email address is added to each job's email info as the job is moved along the flow In addition, the checkpoint updates the “user name” attribute in the internal job ticket as follows: If this property is set to yes, the “user name” attribute is always set to the name of the checkpoint client user moving the job along, regardless of its previous value If this property is set to no, the “user name” attribute is set to the new name only if it was empty to begin with
Fail jobs after timeout	If set to yes, jobs are failed after residing in the checkpoint for a certain period of time (specified in the subordinate properties) Failed jobs are moved to the outgoing connection specified in the subordinate properties or to the problem jobs folder
Unit	Selects the unit for the subsequent property: Minutes, Hours, Days
Timeout delay	The timeout delay in the units indicated by the previous property (0 means ‘no timeout’)
Fail connection	The name of the connection to which failed jobs must be moved If this property value is empty or if the specified name doesn’t match any of the outgoing connection names, failed jobs are moved to the problem jobs folder

Picking up client fields as metadata

The checkpoint tool picks up metadata fields entered by the SwitchClient user when moving along a job. Specifically, when a user moves along a job residing in a checkpoint and the list of editable field definitions in the checkpoint's “Metadata fields” property is nonempty, the checkpoint creates a metadata dataset and associates it with the job’s job ticket under the specified dataset name.

Note that a checkpoint always creates a completely new dataset, i.e. it does not update or modify an existing dataset (even if the job was previously moved through the same or another checkpoint). If the job already has dataset association with the same name, the reference to the old dataset is removed and replaced by the new one.

Refer to Client fields schema for details on the format of the generated metadata.