Generate Document

The Generate Document task generates a document based on a Word template.

Generate Document Task

Attributes

Group Attribute Description

General

Name

The name of the element. This is the name displayed in the diagram. If no run-time name is specified, this name is also used in the running case.

Description

The description attribute additionally adds a description to the component.

Documentation

Documentation intended to explain concepts of its use for future reference.

Details

Asynchronous

When enabled, the activity is started as an asynchronous job. The process state is persisted before this element is executed. Then, the process execution is resumed asynchronously.

Template key

The key referencing the key of the template in the template engine.

Document name

The human-readable name of the generated document.

Document type

The type of the generated document: either a word or pdf document.

Output variable

The variable name that stores a reference to the generated document (as a content item in the content engine).

Context object

The name of the context variable in template expressions such as <<[context.value("${name}")]>>. By default 'context'.

Required

Select this option to mark the element as required (exclamation mark decorator).

Required plan items must either be in the state COMPLETED, TERMINATED or DISABLED for their parent stage to complete.

Repetition

Select this option to mark the element as repeatable (number sign decorator).

By default, only one instance of a plan item is created at runtime. Repeatable plan items do not have that limitation.

The combination of this property, Manual activation, and no entry sentry has a special meaning called Automatic repetition: As a previous instance of the plan item completes, a new instance is automatically created and set into state Enabled.

Completion neutral

Completion neutral influences the plan item’s parent stage completes.

Plan items in the state AVAILABLE may prevent the parent stage (or case) from automatically completing. By checking this property, the plan item behaves neutrally with respect to the completion of the parent container.

Activation

Manual activation

Select this option to mark the element to have Manual activation (right arrow 'play' decorator).

Plan items with Manual activation move from state AVAILABLE to state ENABLED once they trigger. A plan item in state ENABLED exposes an action button that allows the user to manually start the plan item.

More

Lifecycle listeners

Allows you to define lifecycle listeners for a plan item. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when a plan item transitions from one state to another.

Visual

Font weight

The font weight of the element in the diagram.

Font size

The font size of the element in the diagram.

Font color

The font color of the element in the diagram.

Font style

The font style of the element in the diagram.

Background color

The background color of the element in the diagram.

Border color

The border color of the element in the diagram.