Docflow. Tasks

Tasks and Tasks Groups. Common properties

In the Application Model, the Task node or Tasks Group node exposes following properties:

• Deadline: specifies the required completion date. The Task (or Group) should be completed by this date.
• ExpectedStart: specifies the start date. The Task (or Group) should be started on this date.
• NotificationDate: specifies the notification date. The user will be reminded about the Task (or Group) on this date.

• Executor: specifies the Task executor. It can be a Role, a user, or a user group.
• ExecutorType: specifies the type of executor.
• IsTemplate: a boolean value, the True value means that the current Task (or Group) is a template (see Create By Template Task below).
• TaskExecutionCriteria: a boolean value, the False value means that Task execution is not required, it will be completed at once.
• Index: specifies the sequential index number of the Task (or Group). It is required when the Task (or Group) is included in a sequential group.

Common task properties

In the Application Model, the Task node exposes the following properties:

• SetDocumentStatus: a boolean value, the True value means that the Task will change document status.
• DocumentStatus: specifies the document status. This status will be set after execution of the Task. It can be: Draft, Archive, or Publish.
• Stage: specifies the stage name for the current Task.
• IsClonable: a boolean value, the True value means that the Task can be cloned.
• IsRequired: a boolean value, the True value means that execution of the Task is required. It has effect only in parallel Task Groups. It is necessary to execute all required Tasks to complete a parallel Task Groups.
• ViewProperties: specifies the collection of Document Properties, that must be displayed in the AutoForm when the Task is executed.
• FailureCriterias: specifies the collection of failure criteria. Each item is a criterion; the Task can not be completed if a failure criterion is not satisfied.

The Failure Criterias node exposes two required properties:

• CriteriaExpression: specifies the calculated expression that determines the criterion. The condition is constructed based on the expression rules.
• ErrorText: specifies the text message that will be displayed if the criterion is not satisfied.

 

The following describes the types of Xafari Docflow Tasks and their properties

Task - Instruction.

It displays the Autoform.

Task – Detail View

It displays the Detail View. The task node exposes 4 specific properties:

• AllowEditObject: a boolean value. It specifies the view mode. The True value means that the Detail View will be displayed in the edit mode. It is only effective for Web applications.
• ObjectKeyValue: specifies the object key, used to retrieve the object that will be displayed in the Detail View. It is possible to use an expression.
• ObjectType: specifies the type of the object that will be displayed in the Detail View.
• View: specifies the Detail View that will be displayed

Task – List View

It displays the List View with the specified parameters. The node exposes three specific properties:

• BackFilter: specifies the filter to be applied to the List View.
• ObjectType: specifies the type of the displayed object.
• View: specifies the List View to be displayed.

Task – Create By Template

It is used to create a task based on a template. The node exposes three specific properties:

• Template: specifies the template that will be used for creating a new Task.
• Iterator: specifies the InitProperty value. When a number of Tasks are created using the same template, the Tasks differ by the InitProperty value. Use the Iterator property to specify the InitProperty value.

InitProperties: a collection of items related to LocalProperties. Elements (items) of the InitProperties collection are  automatically generated for each LocalProperty in the Template. The item of the InitProperties collection sets the initial value of the LocalProperty property of the new Task.

The item in the InitProperties collection exposes following properties:

• CurrentProperty: specifies one property of the current Task. The InitProperty property will be set to the CurrentProperty value. The СurrentProperty has higher priority than the Expression.
• Expression: specifies the expression for calculation of the InitProperty value.
• NeedUserAcceptance: a boolean value indicating whether or not the user must confirm the value when the document is created.
• PropertyInNewObject: specifies the local template property, for which it is possible to set a value.

Task – Create Linked Document

The Create Linked Document Task creates a subordinate document. The node exposes four specific properties:

• AllowDuplicates: a boolean value, the True value means that a number of subordinate documents can be created using the same Schema.
• LinkedDocument: specifies the Schema for the created document.
• Iterator:  specifies the InitProperty. It is used when creating a number of documents based on one Schema. Such documents will differ by the value of the InitProperty property. Use the Iterator property to specify the InitProperty property.
• InitProperties: a collection of items related to LocalProperties. The elements of the collection set the starting values for LocalProperties of the new document.

Task – Business Operation

The Business Operation task launches a business operation. The node exposes two specific properties:

• BusinessOperation: specifies the business operation to be started.
• InitProperties: it is a collection of associations between the Schema properties and parameters of the business operation. An InitProperties item is automatically generated for each parameter of the business operation.  Each InitProperties item sets the start value for the respective business operation parameter. After completion of the business operation the output parameters are sent to the Schema. 

Signatures

Signatures is an important special case of the Task. In practice, the life cycle of any document includes a number of audits, consents, approvals, etc., which are confirmed by a signature. The Task executor can grant or deny the signature. Depending on whether the signature is granted or denied, the Schema will execute different scenarios.

There are different types of Signatures supplied by the Xafari Docflow. All of them are described below. The Signature node exposes the following properties:

• CancelIfNo: a boolean value. The True value means that the entire current Task Group will be canceled if the Signature is deined.
• CancelIfYes: a boolean value. The True value means that the entire current Task Group will be canceled if the Signature is granted.
• YesStep: specifies the step within the sequential Task Group, that will be performed by the Schema after the Signature is granted.
• NoStep: specifies the step withing the sequential Task Group, that will be performed by the Schema after the Signature is denied.
• ResultingProperty: specifies the Schema property in which the Signature result will be recorded. The value will be assigned to the closest LocalProperty. You can only specify properties of the System.Boolean type.
• UseAndOperatorForPropertyValue: a boolean value, specifies the logical operator to use to determine the final Signature result. You can put the Signature result into a boolean property of the Schema using the ResultingProperty property. Thus, we have a pair of logical values: the old value and the new value which is the Signature result. If you set the UseAndOperatorForPropertyValue property to True, then the final value will be determined using the AND operator: final value = (old value)  AND (new value). Otherwise the OR operator will be used.

The section below describes the four types of Signature available in the Xafari Docflow and their specific properties:

Automatic Signature

The value of the Automatic Signature is obtained as a result of a Business Operation. The node exposes three specific properties:

• BusinessOperation: specifies the Business Operation.
• ResultingSignatureProperty: specifies the Business Operation output parameter that determines the Signature state.
• InitProperties: it is a collection of associations between the Schema properties and parameters of the Business Operation. An InitProperties item is automatically generated for each parameter of the Business Operation.  Each InitProperties item sets the start value for the respective Business Operation parameter. After completion of the Business Operation, the output parameters are sent to the Schema.

Wait Signature

The state of the Wait Signature depends on the state of another document. The node exposes three specific properties:

• Document: specifies the type of document that determines the state of the Signature.
• Schema: specifies the Schema of the document that determines the state of the Signature.
• UseAndForSignatures: boolean value, the True value means that receiving all Signatures is required for the document.

Condition Signature

The state of the condition Signature depends on whether certain condition is satisfied. The node exposes one specific property:

• Condition: specifies the condition that determines the Signature state. Use expression to specify the condition.

Approval Signature

The state of the Approval Signature depends on the user. The user can grant or deny the Signature directly. The Signature node exposes two specific properties:

• NoActionCaption: specifies the display caption for the button granting the Signature.
• YesActionCaption: specifies the display caption for the button denying the Signature.