Creating an activity

This guide walks you through the steps required to configure, define, and launch a new Activity Template from scratch.

Creating a new Activity Template

On Settings > Activity Template > Activity Template

1

Click Create.

The Activity Template creation window guides you through 3 setup steps before you can add Activity Items.

2

Firstly fill in the Basic information fields required.

3

Then fill Where this activity will be available.

4

Lastly fill in When this activity will be triggered

5

Click Save and close (or Save and open) to finalise.

Fields

Name	Description
Activity name *	this is the text name of the activity
Activity Key *	this is the key name that the system will use in linking the items. The name should be unique (no spaces or special characters allowed).
Activity Description	this is the description of the activity.
Activity Class	classes can be used to group activities, making it easier to maintain them
Article	Articles allow you to provide documentation with an activity. Use this section to choose which of your articles to attach.
Expiry In	sets the expiry time of the created activity. This will set the activity status to expire once the expiry setting is reached.
Priority	sets the priority of the activity (default is "Low")
Display Order	sets the order where the activity will be displayed in the list.
Color	Sets the color indicator displayed on the left border of the activity card, helping operators quickly identify or categorize activities visually
Comments Required	controls when operators must enter a comment on submission: On Fail — required only when the activity result is a failure; Always — required on every submission; Never — optional and never enforced
Claimable by	Defines the user groups or roles permitted to manually claim and take ownership of this activity
Auto-claimable by	Defines the user groups or roles for which the system will automatically assign and claim the activity upon creation or trigger
Startable by	the user groups that will have permission to start/create the activity from the 'Start Activity' button. This is different to User Groups field as that defines who can perform an activity
Skippable By	Defines the user groups or roles allowed to skip or bypass the execution of this activity when active
On Order Complete	define what should happen to an active activity when the order it is attached to is completed
On Order Suspend	define what should happen to an active activity when the order it is attached to is suspended
On Shift End	define what should happen to an active activity when the shift it is attached ends
Trigger Retest	Select whether a retest workflow is required in the event that the activity fails.
Required Before Order Action	Blocks specific order action(s) (e.g. Start, Complete) until the activity has been submitted. The order action is not blocked if the activity is in an Expired or Skipped state.