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.
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. Default value is "Checkpoint" |
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 or editing job |
If set to yes, SwitchClient displays an extra button that allows the user to edit and/or replace jobs 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 |
Enter and display metadata |
If set to "Yes", you can specify or display optional or required metadata fields a user needs to review, update or fill in before allowing the job to go through this Checkpoint. |
Metadata fields |
Specify the metadata fields a user needs to review, update or fill in. Click
this |
Dataset name |
The name of the dataset in which the specified metadata fields will be stored is 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:
|
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 |
button to invoke the
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.