Skip to content
View as markdown Ask ChatGPT Ask Claude

Create Business Workflow#

🔒 Business Workflow.Create

🔒 Business Workflow.CreateTemplate

🔒 Business Workflow.CreateFromTemplate

Overview#

This operation is used to create a Business Workflow.

Setup#

No specific setup is required other than to meet the preconditions of the transaction.

Preconditions#

  • The Business Workflow does not currently exist in the system.

Sequence of Steps#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

  • Entity - in the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information, see Creating Entity Objects.
  • Revision - if you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
  • Version - if you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Step 1: Change Set#

  1. Choose an existing Change Set or select Create to create a new Change Set. If configured to support implicit Change Sets, it is also possible to check the Use Automatic Change Set option.
  2. Optionally, select an Approval Role.
  3. Optionally, set the Make Change Set Items Effective on Approval to true so that the Change Set items become effective when the Change Set is approved.

Info

For more information, see Create Change Set.

Screenshot showing a business workflow creation step with "Create Business Phrase" label.

Step 2: General Data#

  1. Provide a name for the Business Workflow.
  2. Optionally, provide a description of the Business Workflow.
  3. Select a Folder for the Business Workflow.
  4. Select the Type for the Business Workflow:
    • Business Workflow Event - the workflow runs automatically whenever the selected Business Event occurs.
    • Standalone - the workflow runs on demand instead of reacting to an event, and defines its own Inputs and Outputs so it can be started elsewhere, for example from a dashboard, a button on a UI Page, or another GUI command.
  5. If the Type is Business Workflow Event, select the Business Event to which the Business Workflow should respond to.
  6. If the Type is Standalone, continue to Step 3 to define its Inputs and Outputs. Otherwise, select Create to finish the process.

Screenshot showing a business workflow creation step with fields labeled "eevee" and "4".

Step 3: Inputs#

This step only applies when the Type is Standalone.

For each input the Standalone Business Workflow should accept when executed, select the add action and provide:

  • Name - identifier used to reference the input; must begin with a letter and cannot contain whitespace.
  • Display Name - optional, human-readable label.
  • Data Type - the input's data type.
  • Default Value - optional value used when the input is not provided at execution time.
  • Required - whether the input must be provided at execution time.

Step 4: Outputs#

This step only applies when the Type is Standalone.

For each value the Standalone Business Workflow should return, select the add action and provide a Name, an optional Display Name, and a Data Type.

Select Create to finish the process.