CDS Callouts

Callout Sequence
Callout Parameters
Callout Miscellany

CDS Callout Sequence

DISTRIBUTOR-SIDE CALLOUT SEQUENCE

PreJobCallout
executed before the scan of the SourceDir directory.

MidJobCallout
executed before the transfer of content to the Agents.

EndJobCallout
executed after moving the content on the Agents to the "live" directory.

AGENT-SIDE CALLOUT SEQUENCE

AgentPreAcceptCallout
executed while the Distributor is verifying the source availability on each Agent host.

AgentPreUpdateCallout
executed before the Agent copies the new content to the "live" directory.

AgentPostUpdateCallout
executed after the Agent copies the new content to the "live" directory.
AgentPreStartCallout
executed before the Agent restarts web servers only if the Agent is configured to do so.

AgentPostStartCallout
executed after the Agent restarts web servers only if the Agent is configured to do so.

AgentPostCommitCallout
executed after the Agent sends a notification to the Distributor, only if it is notification of a successful job.

AgentPostAbortCallout
executed after the Agent sends a notification to the Distributor if the notification is one of failure, or if the Agent host fails the source availablity check, or if the job is to be aborted and the job has passed the transfer-of-content stage.

CDS Callout Parameters

As of CDS 3.5, there are both Distributor-side and Agent-side callout capabilities, and each side receives a slightly different list of parameters. In both cases, the callout parameters are passed to the callout script via standard input (STDIN on Unix), and are newline-delimited.

DISTRIBUTOR-SIDE CALLOUT PARAMETERS

BeginParams	marks the start of input parameters on standard input
Scalar FormatVersion number	number indicating the callout parameters version
Scalar Checkpoint number	the checkpoint number of the calling job
Scalar JobName string	the name of the calling job
Scalar JobState string	the current state of the calling job: Starting InProgress Succeeded Failed Aborted Unknown
Scalar JobType string	the type of the calling job: Normal Catchup Revert
Scalar MappingName string	the name of the mapping used by the calling job
Scalar ManifestFile string	full path to the user-readable manifest file (null if not present)
Scalar SourceDir string	full path to the source directory for the indicated mapping (null if not present)
Scalar RevertDir string	full path to the revert directory for the indicated mapping (null if not present)
Array Destinations number	announces the start of the Destinations array and the number of array elements
BeginElement	marks the start of an array element
Scalar Name string	the name of a destination host
Scalar Directory string	full path to the destination directory on the destination host
Scalar State string	status of destination host: Ok Job Complete Sync Lost Host Out of Sync
EndElement	marks the end of an array element
EndParams	marks the end of input parameters on standard input

AGENT-SIDE CALLOUT PARAMETERS

BeginParams	marks the start of input parameters on standard input
Scalar FormatVersion number	number indicating the callout parameters version
Scalar Checkpoint number	the checkpoint number of the calling job
Scalar JobName string	the name of the calling job
Scalar JobState string	the current state of the calling job: PreAccept PreUpdate PostUpdate PreRestartServers PostRestartServers PostCommit PostAbort
Scalar JobType string	the type of the calling job: Normal Catchup Revert
Scalar MappingName string	name of the mapping associated with the calling job
Scalar ManifestFile string	full path to the user-readable manifest file (null if not present)
Scalar SourceDir string	full path to the source directory for this mapping (null if not present)
Scalar RevertDir string	full path to the mapping's revert directory (null if not present)
Scalar Destination string	full path to the destination directory for the current job
Scalar Archive string	full path to the archive file for the current job (null if not present)
EndParams	marks the end of input parameters on standard input

Callout Parameter Miscellany

The ManifestFile will be null for the Distributor-side PreJobCallout and the Agent-side PreAcceptCallout scripts.
The Archive will be null for the Agent-side PreAcceptCallout script.
The Distributor-side MidJobCallout script will not be executed if the Distributor job fails before reaching that stage.
The Agent-side callout scripts will not be executed if the Distributor fails to reach that stage, or the Agent falls out of sync before reaching the point of executing the callout scripts. The only exception to this is the PostAbortCallout script, which will be invoked if the PreAcceptCallout script was called and either the job fails or the Agent drops out of the job. The PostAbortCallout script will only be executed when the Agent realizes that the job has not succeeded.
Command-line arguments can be passed to the callout scripts be used by specifying those options when the bcd_cp's smp command is used to set the callouts. However, the Distributor's registry setting StartableProcessesFile must also contain the same command-line options, as the exact strings for execution are checked.
All CDS Agents must wait until the other CDS Agents are finished with a callout script for a particular stage in the process before they can continue to the next step in the job.
The Job Complete state of Distributor-side callouts is issued when the Agent has successfully committed the deltas to the "live" directory on the Agent system. This state does not arise for jobs which have no deltas, for no commit is ever done, thus their state is an Ok.