Workflows

Workflows and steps

A workflow consists of various so-called "steps". A single step has a precisely defined task. Usually, docuteam feeder uses the steps of docuteam actions. You can also create and execute your own steps.

The tab "Workflows" shows all defined ingest workflows that can be applied to a concrete SIP.

Execute workflow

A workflow is started with a click on start. In a second step, the SIP to be processed is selected. For this there are three possibilities:

• Dropdown list for SIP, which are stored in the folder defined as "Inbox folder for packages".
• Dropdown list for SIP, which were uploaded as depositions.
• Manual entry of a SIP name (if feature manual_input is activated).

The dropdown for SIPs is populated from the "inbox folder for packages" specified for the respective workflow.

Create or edit workflow

If you have the appropriate permissions, you can edit existing workflows by clicking on "edit". A workflow is always a linear process: The SIP is sent into a pipeline in which one step after the other is processed. In case of an error the execution stops and omits any subsequent steps.

The steps selected here in the left column are documented at docuteam actions. The right column contains the parameters that are given to the selected step when it is called. SIP can be referenced with the following variables:

Variable	Explanation	Example
${SIP}	Name of the SIP (path included)	C:\docuteam\workbench\1_inbox\example.zip
${SIPBASE}	Name of the SIP without file extension	example
${SIPEXT}	File extension of the SIP	zip
${SIPNAME}	Name of the SIP with file extension	example.zip
${SIPPATH}	Path to the folder containing the SIP	C:\docuteam\workbench\1_inbox
${SAFESIPNAME}	Name of the SIP with special characters normalized	example.zip
${DEPOSITIONID}	Numeric ID of the deposition	123

If the SIP was uploaded using a deposition, ${SIPBASE} and ${SIPNAME} contain the internal ID of the deposition (e.g. CmLdaZVcjpncG57G7jjf7SjX). Additionaly ${DEPOSITIONID} contains the numeric ID of the deposition. ${SIPEXT} is empty in this case, as the deposition is stored without a file extension. Additionally ${SAFESIPNAME} is empty, as the deposition ID does not contain special characters.

Additionally the following variables exist:

Variable	Explanation	Example
${ORGID}	ID of the organization the current workflow execution belongs to	2
${CREATOR_EMAIL}	email address of the user that created the workflow execution	user@example.com
${LAST_MODIFIER_EMAIL}	email address of the user that last updated the workflow execution	user@example.com
${LAST_EXECUTION_CREATION_DATE}	Date and time of the last execution of the workflow	1970-01-01T00:00:00.000Z
${CURRENT_EXECUTION_CREATION_DATE}	Date and time of the current workflow execution	2040-01-01T00:00:00.000Z
${WEID}	ID of the current workflow execution	12451
${EXECBYWEID}	ID of the workflow execution that did launch the current workflow execution	23421

And, last but not least, the following pattern allows to use environment variables (both on Windows and Linux): ${ENV:...}.

Besides editing an existing workflow, it is also possible to create a completely new workflow.

The field "Step prefix" must contain the a console command to switch to the actions_home_dir folder of the organisation, which is executed before each step (e.g. cd "${ENV:ACTIONS_HOME_999}"). The optional field "Inbox folder for packages" contains a path to a folder of the workbench where feeder looks for SIPs when starting a workflow. In both fields you can enter Windows or Linux environment variables using the following syntax: ${ENV:ACTIONS_HOME_999}. The same syntax is also support in the step parameters and step commands.

In the "Parameter type" dropdown, you must specify which type of manually passed parameter feeder accepts when starting the workflow (either when starting a workflow manually in the "Manual entry" field or when starting a workflow via API or event handler. If the parameter passed does not correspond to the type defined here, the workflow will not be executed. The following values are available for selection:

• File or Folder: Path to a file or folder located in the input folder of the respective workflow.
• ID: Accepts only numbers
• OAI-PMH identifier: ID of an OAI-PMH record (oai:{server address}:{identifier})
• PID: PID of an object in docuteam box
• PUID: Pronom file format ID (e.g. fmt/40 or x-fmt/430).
• No parameter: Passing of a parameter not allowed, field "Manual entry" is hidden

A workflow can be configured to be run automatically and repeatedly based on a schedule.

Using Event handlers, workflow executions can be linked to each other, so that a follow-up workflow is started automatically if a workflow finishes with success and/or an error.

Create or edit step

Like workflows, existing steps can be edited or new steps can be created with the appropriate authorization, for example to integrate further migration tools or to extend the ingest process with additional functionalities.