Workflow Files

Assigning Files in General

images/download/attachments/78255563/Workflow_files_EN-version-1-modificationdate-1634700479925-api-v2.png

Files can be assigned to a workflow job in state forms. These files are always assigned to the workflow job as a whole and not to the respective states.

Files can also be assigned via functions (see below).

Files in State Form


images/download/attachments/78255563/cc6-version-1-modificationdate-1645073440336-api-v2.png

(1) Switch to this tab in the opened form.

(2) This button opens dialogue (3). Alternatively, you can use the context menu for this purpose.

(3) Select a file with the button or just drop it.

(4) You can find an uploaded file in this list.

(5) Each file has the following default file attributes : Filename , File size , Date , User and optionally a file description and the constraint Read only , see (6). In addition, user-defined file attributes can be assigned with function attach file to workflow(a,b,c,d,[e]). These are not displayed in the GUI, but can be read with function get content of attached file of workflow(a,b,[c]).

Context menu of a file entry


images/download/attachments/78255563/cc7-version-1-modificationdate-1645073449823-api-v2.png

(6) Via the context menu of a file entry you can delete or download the file and add further files. In addition, you can specify a file description in another dialogue and set the constraint Read only , see (7).


images/download/attachments/78255563/cc8-version-2-modificationdate-1645087035046-api-v2.png


(7) If this checkbox is set, this file cannot be deleted and the description cannot be changed once the form has been closed, not even by the user who added the file. The file can then only be downloaded and the description only viewed. See also section Rights for Workflow Files below.

Functions for Workflow Job Files


Here is an overview of all available functions for handling workflow job files. Note: No rights (see following section) are required for these functions.


Rights for Workflow Job Files


There are several places where the rights to be able to work with files in a workflow are set.


Place

Effect

(a) Module Workflow Workflow DesignerMain settingsCheckbox Attachment allowed

Files may be assigned to forms of this workflow in general. However, you need to allow attachments in specific forms as well. See (b) and (c).

(b) Module Workflow Workflow DesignerForm settings → Checkbox View/add attachments

Requirement: (a).

Files may be assigned in this form of the workflow.

(c) Module Workflow Workflow DesignerForm settings → Selection DataCockpit role attachments

Requirements: (a), (b).

Files may be assigned in this form of the workflow if it is opened in the add-on module DataCockpit and the DataCockpit user has the role selected here.

(d) In an open form of a workflow job by the uploading user → File/description read only (see items (6) and (7) above).

Requirements: (a), (b) and possibly (c).

The file cannot be deleted.

The file description cannot be changed.

Both constraints apply once the form has been closed, even to the user who added the file.

Blacklists and Whitelists for File Extensions


See section Blacklist and Whitelists for File Extensions.