TABLE OF CONTENTS
- What is a Cycle?
- What is a Subscription?
- Creating a Cycle
- Starting a Subscription
- Managing Subscriptions
What is a Cycle?
A cycle is a compliance process that is run on a recurring basis. These can be set to run every number of weeks, months or years.
These consist of:
- The Cycle Name used to differentiate Cycles
- The Recurrence - setting that the Cycle runs every X weeks/months/years
- Requirements - the Activity Types that are completed every time the Cycle is run
What is a Subscription?
A Subscription is the relationship between a Cycle and a Subject. These contain:
- The name of the relevant Cycle
- A start date - When the Subscription is first run
- The number of executions - how many times the Subscription is run
- State - Whether the Subscription is Active or Disabled
- Date Last Run
- Date Next Run
- Number of Executions left - How many more times the Subscription needs to run
Creating a Cycle
Create a Process and add the relevant Activity Types
Navigate to the "Cycles" tab and click "add another"
Give the Cycle a name and set how frequently you wish for it to run
Please note - this name will show when starting a Subscription, so ensure it makes sense
Press Save
Starting a Subscription
To start a Subscription, you need to create the relationship between a Cycle and a Subject. To do this:
Navigate to the Subject from the Subject List View https://app.personnelchecks.co.uk/subjects
Select the "Subscriptions" tab and click "add another"
Select the relevant Cycle
Choose the start date and executions (number of times you want it to run).
If you want the Subscription to run indefinitely, leave this as 0
Press Save to start the subscription
this Subscription will be active by default and will start on the selected date.
Registration Portals
If a Process is Subject Pays, it is possible for a Cycle to be added to a Registration Portal. To do this:
- Navigate to the Registration portal edit screen on the relevant Process
- Expand the Cycles menu
- Select the Cycle that you wish to apply to the Registration Portal
- Set the number of executions
- Select whether you want the Subscription to start automatically or not
- Press Save
This will then apply the relevant Subscriptions to the Subject when the Registration Portal is submitted.
If the Subscription is not set to start manually, this will need activating when required from the Subject View or the Subscription List View.
Managing Subscriptions
Enabling/Disabling a Subscription
There are two places where a Subscription can be enabled/disabled:
The Subject Details Screen
- Navigate to the Subject Detail Screen
- Select the "Subscriptions" tab
- From here all active Subscriptions will show
- To Activate/Deactivate, click the three dots at the top right of the card, and select the relevant option
You are also able to edit Subscriptions from this view
Subscriptions List View
Alternatively, you can see the Subscriptions List View here https://app.personnelchecks.co.uk/subscriptions
From this view you are able to navigate to the Subject list view, Activate and Disable the Subscriptions
Editing a Subscription
Note - It is only possible to edit an active Subscription.
To edit a Subscription:
Navigate to the "Subscription" tab on a Subject to view the relevant Subscription
Click the three dots at the top right of the card, and press edit
From here you will be able to edit the number of executions, and when the Subscription is next run.
Press Save to save the changes
It is also possible to get a Subscription to "Run Now" from this same menu, which will trigger the Subscription to run instantly. This will use up one of the executions.