CreateFlowDef2 API¶

Creates a new workflow definition on the specified domain/library with an optional on-end destination folder and an optional supervisor. The workflow is created in inactive state.

Supervisor is optional and is honoured. A name that is given is attached to the new definition and comes back under <Supervisors> as <User id="..." />; a name nobody has is refused with 4041. An empty one is accepted and leaves the definition without a supervisor.

This extends CreateFlowDef1 by adding the Supervisor parameter. For the full parameter set see CreateFlowDef3.

Endpoint¶

/srv.asmx/CreateFlowDef2

Methods¶

• GET /srv.asmx/CreateFlowDef2?authenticationTicket=...&DomainName=...&FlowName=...&ActiveFolderPath=...&OnEndMoveToPath=...&Supervisor=...
• POST /srv.asmx/CreateFlowDef2 (form data)
• SOAP Action: http://tempuri.org/CreateFlowDef2

Parameters¶

Response¶

Success Response¶

<response success="true">
  <FlowDef
    FlowDefID="125"
    FlowName="ContractApproval"
    DomainId="45"
    DomainName="Corporate"
    ActiveFolderPath="/Corporate/Contracts"
    RequiresStartUpPlayers="false"
    Active="false"
    OnEndMoveToPath="/Corporate/Archive"
    OnEndEventUrl=""
    Hide="False">
    <Supervisors>
      <User id="7" />
    </Supervisors>
  </FlowDef>
</response>

See CreateFlowDef for a full description of all response attributes.

Error Response¶

<response success="false" error="Session expired or invalid ticket" errorCode="4010" />

Required Permissions¶

The calling user must be a domain/library manager or a system administrator.

Example¶

GET Request¶

GET /srv.asmx/CreateFlowDef2
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainName=Corporate
    &FlowName=ContractApproval
    &ActiveFolderPath=/Corporate/Contracts
    &OnEndMoveToPath=/Corporate/Archive
    &Supervisor=john.smith
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/CreateFlowDef2 HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&DomainName=Corporate&FlowName=ContractApproval&ActiveFolderPath=/Corporate/Contracts&OnEndMoveToPath=/Corporate/Archive&Supervisor=john.smith

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Creates a workflow definition and names a supervisor. The supervisor is attached; an empty value is accepted.

const root = await call('CreateFlowDef2', {
  authenticationTicket: ticket,
  DomainName: 'Public',
  FlowName: 'Invoice approval',
  ActiveFolderPath: '/Public/Invoices',
  OnEndMoveToPath: '',
  Supervisor: 'jsmith'
});

const flowDefId = root.querySelector('FlowDef').getAttribute('FlowDefID');
console.log(flowDefId);   // pass this to SubmitDocumentToFlow later

Notes¶

• Supervisor is a login name (username), not a display name or user ID.
• The supervisor user must exist in the infoRouter system. An invalid username returns an error.
• Pass an empty string for Supervisor to create the workflow without a supervisor.
• OnEndMoveToPath must refer to an existing folder if non-empty. An invalid path returns an error.
• The OnEndEventUrl and Hide fields are fixed at "" and false respectively. Use CreateFlowDef3 to configure those.
• The workflow is created in inactive state. Activate with ActivateFlowDef after adding steps and tasks.

Related APIs¶

• CreateFlowDef -" Minimal variant.
• CreateFlowDef1 -" Adds OnEndMoveToPath only.
• CreateFlowDef3 -" Full variant with all options including event URL and hidden flag.
• AddFlowStepDef -" Add steps after creation.
• ActivateFlowDef -" Activate the workflow definition.

Error Codes¶

The errorCode values this operation returns, checked against a running server: