PowerSchool ERP System Administration

Workflow Administration

Use the Workflow Administration option to monitor workflows for your organization. In addition, you can suspend, resume, restart and cancel workflows that have not completed.

From the System Administration menu, select Workflow. From the Workflow menu, select Workflow Administration.

Review a Workflow

  1. Open the Workflow Administration page.

  2. In the Search Criteria section, enter criteria identifying the records to list, and then click Load Records.

  3. In the Search Results section, select the workflow to display the Workflow Administration Details page and review the workflow.

Restart a Workflow

The Restart function can only be performed with Workflow Instance IDs with a status of: In Progress, Failed, Expired or Suspended.

  1. Open the Workflow Administration page.

  2. In the Search Criteria section, enter criteria identifying the records to list, and then click Load Records.

  3. In the Search Results section, select the workflow to display the Workflow Administration Details page.

  4. Click Restart.

  5. In the Confirmation dialog, click Yes to restart the workflow.

The restart of a workflow will flag the current Instance ID as "Restarted" and create a new queue record for the workflow engine to process. The user in the Workflow Administration page will need to wait for the queue to be processed. Once processed and refreshed, a new Instance ID will be created and can be viewed on the original Instance ID under the Instance History. The new Instance ID will have a new Reminder Date and Expiration Date which is based on when the Restart was initiated.

Suspend a Workflow

The Suspend function can only be performed on Workflow Instance IDs with an In Progress status.

  1. Open the Workflow Administration page.

  2. In the Search Criteria section, enter criteria identifying the records to list, and then click Load Records.

  3. In the Search Results section, select the workflow to display the Workflow Administration Details page.

  4. Click Suspend.

  5. In the Confirmation dialog, click Yes to suspend the workflow.

Resume a Workflow

The Resume function can only be performed on workflows with a status of: In Progress, Failed, Expired or Suspended

  1. Open the Workflow Administration page.

  2. In the Search Criteria section, enter criteria identifying the records to list, and then click Load Records.

  3. In the Search Results section, select the workflow to display the Workflow Administration Details page.

  4. Click Resume.

  5. In the Confirmation dialog, click Yes to resume the workflow.

Resuming a workflow will flag the current Instance ID as "Resumed" and create a new queue record for the workflow engine to The Resume or a workflow will temporarily update the Current Instance ID Status to Trigger Even Received. The user in the Workflow Administration page will need to wait for the queue to be processed. The Instance ID will have a new Reminder Date and Expiration Date which is based on when the Resume was initiated.

Cancel a Workflow

The Cancel function can only be performed on workflows with a status of: In Progress, Failed, Expired or Suspended

  1. Open the Workflow Administration page.

  2. In the Search Criteria section, enter criteria identifying the records to list, and then click Load Records.

  3. In the Search Results section, select the workflow to display the Workflow Administration Details page.

  4. Click Cancel.

  5. In the Confirmation dialog, click Yes to cancel the workflow.

A canceled workflow cannot be restarted or resumed. If the cancel was done in error, the requester needs to resubmit the leave request.

Fields and Descriptions

General Information section

Field

Description

Instance ID

Unique identifier for the workflow instance. Display only.

Status

Status for the workflow instance. Display only.

Possible statuses are:

  • In Progress

  • Succeeded

  • Failed

  • Rejected

  • Canceled

  • Expired

  • Needs Correction

  • Corrected

  • Restarted

  • Suspended

  • User Action Received

  • Trigger Event Received

Requester ID

Employee number of the person that initiated the workflow. Display only.

Requester

Full name of the person that initiated the workflow. Display only.

Workflow

Title of the workflow associated with the instance. Display only.

Data Set

Type of data for the workflow. Display only.

Description

Errors triggered by the workflow process for the workflow instance. Display only.

Data Set Instance ID

GUID that serves as a unique ID for the workflow data set. Display only.

Initiated By

Type of process that initiated the workflow. The only type for this release is e-Form. Display only.

Created Date

Date and time the workflow was initiated. Display only.

Reminder Date

Date and time the reminder notification for the workflow will be sent. Display only.

Expiration Date

Date and time the workflow will expire if not completed. Display only.

Completed Date

Date and time the workflow was completed. Display only.

Instance Information section

Field Label

Field Value

Leave Type

Type of leave, as defined in the Check Title field of the Pay Code table. If your organization uses Employee Timesheets and the Pay Title Description is set to A-Alternate Code Description, then the leave type displays from the Pay Code Maintenance Alternate Description.

Start Date

Starting date for the requested leave.

End Date

Ending date for the requested leave.

Units

Number of units, hours or days for the requested leave.

Notes

Any notes that may have been entered by the employee when the leave request was submitted.

Leave Code

The leave code on the employee that is affected by the requested leave.

Event History section

Field

Description

Action Date/Time

Date and time when the action was completed. Display only.

Status

Status of the action. Display only.

Possible statuses are:

  • Pending

  • Success

  • Rejected

  • Delegate

  • Needs Correction

  • Restart

  • Suspend

  • Resume

  • Canceled

Activity Description

Title for the workflow approval level.

Role Description

Title of the approval role associated with the instance.

Approver

Name of the primary approver for the role associated with the instance. If there is no role in the Role Description field, but a name in this field, this would be the name of the administrator who performed the Restart, Suspend, Resume or Canceled action from the Workflow Administrator option.

Delegate

Name of the user who was defined as the delegate for this workflow task during the approver's absence.

Comments

Any comments that have been entered by the approver or delegate when processing the approvals for the workflow instance. In the event that the leave request was canceled, this will display Employee Canceled or Administrator Canceled, based on who canceled it.

Instance History section

Field

Description

Instance ID

Unique identifier for the workflow instance. Display only.

Status

Status for the workflow instance. Display only.

Possible statuses are:

  • In Progress

  • Succeeded

  • Failed

  • Rejected

  • Canceled

  • Expired

  • Needs Correction

  • Corrected

  • Restarted

  • Suspended

  • User Action Received

  • Trigger Event Received

Created Date

Date and time the workflow instance was initiated. Display only.