Workflow Download field

The Download field is used to provide a button that allows users to download a document within a workflow form.

AttributeDescriptionRequired
label

The text shown as a label in the user interface.

true

name

Unique name identifier

Two fields cannot have the same name in the same task definition. The name must be unique.

true

width

The width of the HTML element.

In the case of KCenter UI, you must use width values based on %, for example:

  • width="50%" will work
  • width="100px" will be ignored in the KCenter UI.
false
data

When present, it is an identifier used to load data.

For example, to dynamically load the uuid or path of the node to download.

false

Child elements:

Basic download example

  • Download button with a static node element.
  • The uuid must be a valid document UUID.
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE workflow-forms PUBLIC "-//OpenKM//DTD Workflow Forms 2.6//EN"
                                    "http://www.openkm.com/dtd/workflow-forms-2.6.dtd">
    <workflow-forms>
      <workflow-form task="download test">
        <download name="download" label="Download document">
          <node label="download" uuid="afb8ac33-912d-4515-e29b-1c01b693809a" />
        </download>
      </workflow-form>
    </workflow-forms>

Dynamic download example

  • The data attribute is a mapping variable used to dynamically set the UUID on the node element at runtime.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE workflow-forms PUBLIC "-//OpenKM//DTD Workflow Forms 2.6//EN"
                                "http://www.openkm.com/dtd/workflow-forms-2.6.dtd">
<workflow-forms>
  <workflow-form task="download test">
    <download name="download" label="Download document" data="dynamic">
      <node label="download"/>
    </download>
  </workflow-form>
</workflow-forms>