How to: Add new Workflows

To create a new workflow or edit an existing workflow, follow the steps below.

Step 1

• Navigate to the WORKFLOWS page

Step 2

• Click CREATE WORKFLOW

• Enter the required fields

Field	Details
App	The FarEarth application ID where the workflow will be created
Display Name	The actual name of the workflow displayed within the application
Description	A short description of the workflow
ID	A unique ID for the workflow

• Click CREATE

Step 3

• After creating the workflow, FarEarth will automatically add additional fields to the workflow

Field	Details
Enabled	Controls whether the workflow is enabled or not
File Name	The JSON filename of the workflow as stored on disk
Shareable	Controls whether the workflow may be shared with other subscriptions
Exclusive	Limits the workflow to be shareable with only one subscription

• The new workflow will appear in the list
• The workflow is pre-populated with a template that requires further editing

note

See more in the workflow details section below

Edit workflow

To edit the workflow, follow the step below.

• Click FILE NAME in the workflow list

{
    "id": "farearth.test",
    "displayName": "test",
    "description": "A test workflow",
    "steps": [
        {
            "id": "step-xyz",
            "description": "Step XYZ",
            "executorId": "farearth.xyz",
            "parameters": {
            }
        }
    ]
}

note

The example above shows the workflow template created

Expected outcome

• Outcome #1

Related links

• Related links #1
• Related links #2