Functions

Functions are used to make changes to the repository and/or the workflow database:

• CancelPublicationTasksFunction: cancel any outstanding task related to publication. This function is called, amongst others, when a scheduled publication is canceled or a document is unpublished.
• CheckConsistencyFunction: due to bugs in early versions of the workflow we had to check whether the data in the repository still matched the data in the workflow database. This function is not needed when you do not have workflows created with an early version of the workflow.
• ClearPublicationDatesFunction: deletes the publication dates when a document is unpublished.
• ClearPublicationTaskIdFunction: delete the publication task ID when the task has finished.
• ClearRequestedPublicationDatesFunction: delete the requested publication dates when the editor approves or disapproves the publication.
• ClearScheduledPublicationDatesFunction: delete the scheduled publication dates when a document is published or the publication is canceled.
• ClearUnpublicationTaskIdFunction: delete the unpublication task ID when the task has finished.
• CopyObjectToLiveRepositoryFunction: copies the document to the live (location in the) repository when the document is published.
• DeterminePublicationDatesFunction: determine which publication dates to use based on the input of the user.
• MoveScheduledPublicationDateToPublicationDateFunction: moves the scheduled publication dates to the publication dates when the time to publish has been reached.
• RemoveObjectFromLiveRepositoryFunction: delete the document from the live (location in the) repository when the document is unpublished.
• SaveDraftFunction: make a copy of the current content and add it to the list of drafts.
• StartPublicationTaskFunction: start the task that will publish the document in the future. This is called when a document is published with a publication in the future.
• StartUnpublicationTaskFunction: start the task that will unpublish the document in the future. This is called when a document is published with an unpublication date in the future.
• StoreCreatorFunction: store the user ID of the person that created the document during document creation.
• StoreDisapprovalReasonFunction: store the reason entered by the editor when he disapproves a publication or deletion request.
• StoreLocationFunction: store the location of the document in the document in the workflow instance so the workflow functions, conditions, etc. can find the document if needed.
• StoreModifierFunction: store the person that modified the document during a save.
• StorePublicationDatesFunction: store the publication dates when a document is published so the CMS can see whether or not a document is currently published.
• StoreRequestedPublicationDatesFunction: store the requested publication dates entered by a user when he requests a publication.
• StoreScheduledPublicationDatesFunction: store the scheduled publication dates when an editor publishes a document with a publication date in the future.
• VersionOnPublicationActionIfNeededFunction: create a version containing the current content of the document when the document is published or unpublished. This is only invoked when this has been enabled for the document by setting WebDAV property 'createVersionOnPublication' or 'createVersionOnUnpublication' to 'true'.

Conditions

Conditions are used to determine whether or not an action is applicable at this moment:

• HasBeenSavedCondition: determines whether a document has been saved at least once in the editor after creation. This is used to determine whether or not the 'publish' action is applicable.
• IsPublishedCondition: determines whether or not the document is published. This is used to determine whether or not the 'unpublishNow' action is applicable.
• PublicationDateAfterNowCondition: determines whether or not the publication date is after now. This is used to determine which step the workflow should transition to.

Data retrievers

Data retriever are used to retrieve the data with which the form of a workflow action will be filled, or to retrieve data for columns in the todo list:

• DisapprovedDeletionDataRetriever: retrieves data for columns in the 'disapproved deletions' todo list.
• DisapprovedPublicationDataRetriever: retrieves data for columns in the 'disapproved publications' todo list.
• PublishInitialDataRetriever: retrieves data for the form for the 'publish' action.
• RequestPublicationInitialDataRetriever: retrieves data for the form for the 'request publication' action.
• WaitingForDeletionReviewDataRetriever: retrieves data for columns in the 'waiting for deletion review' todo list.
• WaitingForPublicationReviewDataRetriever: retrieves data for columns in the 'waiting for publication review' todo list.

Tasks

Tasks are used to perform workflow actions in the future:

• PublicationTask: invokes the 'scheduledPublication' action.
• UnpublicationTask: invokes the 'scheduledUnpublication' action.

Helpers

Helpers contain functionality used by multiple functions, conditions, etc:

• RepositoryHelper: functions which make changes to the repository.
• VersionCreatingComponent: base class for functions, conditions, etc. that need to create versions of the document.
• WorkflowTask: base class for workflow tasks.