CreateFlowDef3 API¶

Creates a new workflow definition on the specified domain/library with the full set of configuration options: on-end destination folder, supervisor, webhook event URL, and visibility. 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 is the most complete variant of the CreateFlowDef family. Use it when you need to configure OnEndEventUrl or Hide.

Endpoint¶

/srv.asmx/CreateFlowDef3

Methods¶

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

Parameters¶

Response¶

Success Response¶

<response success="true">
  <FlowDef
    FlowDefID="126"
    FlowName="ContractApproval"
    DomainId="45"
    DomainName="Corporate"
    ActiveFolderPath="/Corporate/Contracts"
    RequiresStartUpPlayers="false"
    Active="false"
    OnEndMoveToPath="/Corporate/Archive"
    OnEndEventUrl="https://erp.example.com/workflow-complete"
    Hide="True">
    <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/CreateFlowDef3
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainName=Corporate
    &FlowName=ContractApproval
    &ActiveFolderPath=/Corporate/Contracts
    &OnEndMoveToPath=/Corporate/Archive
    &Supervisor=john.smith
    &OnEndEventUrl=https://erp.example.com/workflow-complete
    &Hide=false
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/CreateFlowDef3 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&OnEndEventUrl=https%3A%2F%2Ferp.example.com%2Fworkflow-complete&Hide=false

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;
}

The overload to use: it takes the supervisor, the end-of-workflow URL and the hidden flag. The supervisor is attached; an empty value is accepted.

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

const flowDef = root.querySelector('FlowDef');
console.log(flowDef.getAttribute('FlowDefID'),
            flowDef.getAttribute('Active'),   // "false" - a new definition starts off
            flowDef.getAttribute('Hide'));    // "False" - this one is capitalised

Notes¶

• Supervisor is a login name (username), not a display name or user ID. The user must exist in the infoRouter system.
• 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.
• OnEndEventUrl is a plain URL string stored against the workflow. When the workflow ends (completed, rejected, or stopped) the server POSTs JSON {WorkflowId, WorkflowDefId, FinishDate, FinishStatus, DocumentId, FinishedWithTaskId} with Content-Type: application/json; FinishStatus is Approved, Rejected, NoResult or Stop. Only HTTP 200 counts as success; failures are written to the server error log and not retried. The call is synchronous, with the default 100-second timeout. The URL in force when the document was submitted is used. Pass an empty string to disable the webhook.
• Hide=true marks the workflow hidden. The server does not enforce Hide: GetFolderFlows, GetDomainFlows and GetWorkflowDefinitions return hidden definitions to any caller, and SubmitDocumentToFlow accepts them. Clients are expected to leave hidden workflows out of their submit lists.
• FlowName must be alphanumeric, maximum 32 characters, and unique within the domain/library.
• ActiveFolderPath must refer to an existing infoRouter folder and cannot be empty.
• The workflow is created in inactive state. The typical build sequence is: CreateFlowDef3 -' AddFlowStepDef -' AddFlowTaskDef -' ActivateFlowDef.

Related APIs¶

• CreateFlowDef -" Minimal variant with only the three required parameters.
• CreateFlowDef1 -" Adds OnEndMoveToPath.
• CreateFlowDef2 -" Adds OnEndMoveToPath and Supervisor.
• AddFlowStepDef -" Add steps to the workflow after creation.
• AddFlowTaskDef -" Add task definitions to workflow steps.
• ActivateFlowDef -" Activate the workflow so documents can be submitted to it.
• GetFlowDef -" Retrieve the full definition of a workflow.
• DeactivateFlowDef -" Deactivate a workflow to modify it.
• DeleteWorkflow -" Permanently delete a workflow definition.

Error Codes¶

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