Edit

Template Element (WorkflowConfig)

  • Article

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Contains the information necessary for a declarative rules-based, code-free workflow editor, such as Microsoft SharePoint Designer 2010, to generate a workflow template in SharePoint Foundation.

Definition

<Template
  BaseID="Text"
  DocLibID="Text"
  XomlID="Text" | "Integer"
  XomlHref="Text"
  XomlVersion="Text"
  RulesID="Text" | "Integer"
  RulesHref="Text"
  RulesVersion="Text"
>
</Template>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

**DocLibID**

Required **Text**. Specifies the GUID of the document library that contains the workflow markup (.xoml) file and, if necessary, the rules markup (xoml.rules) file.

**BaseID**

Required **Text**. Specifies the GUID used to uniquely identify this workflow. The BaseID is the same for all versions of the workflow.

**XomlID**

Optional **Integer**. An optional way to uniquely identify the workflow markup file. This attribute must equal the ID property of the item in the document library.

If present, this attribute is used, rather than the **XomlHref** attribute.

**XomlVersion**

Required **Text**. Specifies the version of the workflow markup file to use when creating an instance of this workflow.

**XomlHref**

Required **Text**. Specifies the path to the workflow markup file. The path specified must be relative to the location of the workflow configuration file.

**RulesID**

Optional **Integer**. An optional way to uniquely identify the workflow rules file. This attribute must equal the ID property of the item in the document library.

If present, this attribute is used, rather than the **RulesHref** attribute.

**RulesVersion**

Required **Text**. Specifies the version of the workflow rules file, in there is one, to use when creating an instance of this workflow.

**RulesHref**

Required **Text**. Specifies the path to the workflow rules markup file. The path specified must be relative to the location of the workflow configuration file.

Child elements

None.

Parent elements

Element
WWorkflowConfig Element](workflowconfig-element.md)

Remarks

Applications created to work as a declarative rules-based, code-free workflow editor can use the AssociateWorkflowMarkup(String, String) method of the websvcWebPartPages Web Service to create a workflow template and associate it to a SharePoint list specifying a workflow markup file, a workflow configuration file, and optionally, a workflow rules markup file.

For more information about creating an application that can act as a declarative rules-based, code-free workflow editor, see Creating Declarative, No-Code Workflow Editors.

Example

The following example shows a Template element for a workflow configuration.

    <Template
        BaseID="{68B99644-EDCE-4988-9D11-7FD5CCAE09CC}"
        DocLibID="{74FAE22C-0176-46DF-AA12-988CE79C8889}"
        XomlHref="Workflows/Notify Me/Notify Me.xoml"
        XomlVersion="V3.0"
        RulesHref="Workflows/Notify Me/Notify Me.xoml.rules"
        RulesVersion="V3.0"
    >

See also