Workflow Definition

In Stratumn, a workflow is defined as an object that groups together its name, the organization it belongs to, its members, and its core configuration.

Workflow Example

Here is a high-level view of what a workflow definition looks like:

export const myWorkflow: BetterWorkflowDef = {
  name: '🗺️ My Process',
  id: 'my-workflow-id',
  description: 'A brief description of the process',
  account: myOrganization,
  config: {
    // Core workflow logic
    pdfTemplate: {
      // PDF and document templates configuration
    },
    actions: {
      // List of available actions
    },
    initState: {
      // Initial data of the trace
    },
    initActions: {
      // Actions available at the start for each group
    },
    // ... other configuration properties
  },
  groups: {
    // User groups involved in the workflow
  },
  members: {
    // Members associated with the workflow
  },
  settings: {
    // Optional workflow-level toggles, see Settings below
  },
};

Settings

The optional settings object holds workflow-level toggles that don’t belong in config. All fields are optional; an absent field keeps the previous default behavior.

string

Overrides the abbreviation used to prefix this workflow’s log lines when trace-generator builds/pushes it (e.g. ALL instead of an abbreviation auto-derived from the workflow name). Build-time only — has no effect at runtime.

boolean

default:"false"

When true, sends a notification to a group when one of its members has a priority action left to do on a trace (a todo action with a non-zero responsibility).

boolean

default:"false"

When true, disables the “always notify” subscription mechanism for this workflow: users who subscribed to be notified on every action of a given type stop receiving those notifications.

boolean

default:"false"

When true, disables trace state history for this workflow: new links stop writing a state snapshot, existing snapshots stop being served (both take effect immediately, no reprocessing needed), and the “Show data diff” button is hidden in Trace’s UI. Useful for workflows that shouldn’t keep this kind of history (e.g. for compliance reasons).

Settings Example

settings: {
  disableStateHistory: true
}

PDF & Document Templates

The pdfTemplate section in the config object is where you define templates used for generating documents like PDF, DOCX, PPTX, or Excel files. Each template is identified by a unique key and contains the following properties:

string

required

The path to the template file (e.g., src/assets/pdfTemplate/example.pdf).

object[]

required

A list of fields that can be filled in the template.

Show Field Properties

string

required

The type of the field (e.g., 'text', 'checkbox', 'dropdown').

string

required

The exact name of the field as defined in the template file.

boolean

required

Whether this field must be filled for document generation.

Configuration Example

config: {
  pdfTemplate: {
    // A simple PDF template example
    invoiceTemplate: {
      file: 'src/assets/pdfTemplate/invoice.pdf',
      availableFields: [
        {
          type: 'text',
          fieldName: 'Customer Name',
          mandatory: true
        },
        {
          type: 'text',
          fieldName: 'Amount',
          mandatory: true
        }
      ]
    },
    // A complex PPTX template for candidate presentations
    candidatePresentation: {
      file: 'src/assets/pdfTemplate/presentation_template.pptx',
      availableFields: [
        {
          type: 'text',
          fieldName: 'candidateName',
          mandatory: true
        }
      ]
    }
  },
  // ... rest of the config
}

These templates can then be used in your effects using the generatePdf external function.

​Workflow Example

​Settings

​Settings Example

​PDF & Document Templates

​Configuration Example

Workflow Example

Settings

Settings Example

PDF & Document Templates

Configuration Example