Start Workflow for an Entry

Plugin

pluginCmWorkflow

Specifies which plugin is used.

Config

Type: JSON formatted string

Please read on for a list of standard workflow templates, how to import them and detailed Config examples.

....

There are numerous general keys, which can be used to customize this top menu item. Please see Top Menu and Plugin Configuration in CM for an extensive list of keys.

Headline

The header of the dialogue box that appears when the menu item is clicked. A dialogue box will only appear if the 'headline', 'label' or 'options' key is defined.

Workflow

The workflow template name which is executed. See how to import workflow templates in the chapter above.

Arguments

Arguments are used to asign values required by a workflow via a user dialogue. They are listed in key/value pairs like "Key1": "Value1", "Key2": {"SubKey2": "SubValue 2"}

In the example below, the key “mailto” has value definition { "label": "To", "input": "text", "value": "david" }

• "label": name of the input label in the dialog (like "To:" in the Email example)

• "input": defines the input type according to the HTML <input> type Attributes. Supported input fields are “text”, “email”, select (drop down menu), "textarea"

• "value": default value of dropdown or input field.

For input = "select":

• "options": options in the drop-down menu (like "Huber" or "david" in the second Send Email example)

For input = "table-select": Select a table from dynamically filled drop-down menu

• "rights": only displays tables as options if the user has the listed rights to them (Naming scheme according to DPE server)

• "targets": list of possible tables to be selected from.

• Example:

  JS

  {
  	"Headline": "Example",
  	"Workflow": "ExampleWorkflow",
  	"Arguments": {
  		"TargetTableId": { 
  			"label": "Target Table:", 
  			"input": "table-select", 
  			"value": "DigaSystem\\Music",
  			"rights": [ "Create" ] 
  		}
      }
  }

For input = "entry-select": Select an entry from dynamically filled drop-down menu

• "tableId": specifies the table from which entries should be displayed, e.g. "MyServer\MyTable"

• "xmlFilter": specifies which entries of a table are displayed in the drop down, also see XmlFilter Syntax And Examples. The XML inside the JSON must be escaped according to JSON escaping rules. If you do not know the rules you can use an online helper like https://www.freeformatter.com/json-escape.html.

For input = "textarea":

• "rows": specifies the number of rows in textarea, default is 2.

VisibleForClasses

{
	"Headline": "Send selected media files as email to:",
	"Workflow": "ExampleWorkflow",
	"Arguments": [
		"mailto", { "label": "To", "input": "text", "value": "david" },
		"cc", "",
		"bcc", "",
		"subject", { "label": "Title", "input": "", "value": ""} ],
	"VisibleForClasses": ["Video", "Audio", "VideoProject"]
}

The menu item is only visible for entries, which belong to a specific class. (e.g. Video Projects)

MultiSelection

If set to 1, the menu is visible even if multiple entries are selected.

ManyToOne

If set to 0: N workflows are created for N items

0 is the default

if set to 1: one workflow is created for N items

In this case the workflow arguments are different

Arg_TableIds = comma-separated string of tabled ids

Arg_EntryIds  = comma-separated string of entry ids 

AlwaysDisplayDialog

If set to 1, the dialog to start a workflow will be displayed even if no configuration needs to be entered by the user

Priority

Optional. Sets the priority (1..100) for the workflow started. Default: 50.