Skip to content

API Workflow Signoff

DeclanBuckley edited this page Dec 8, 2023 · 18 revisions

Home / API / Workflow Signoff

Create.

Creates a Workflow Signoff. On approval, a Notification is sent to the Group and Power Users of the release. On rejection, a Notification is sent to the Group of the release and all Power Users.

Rules for Workflow Signoff:

 The actions will depend on (a) the Request type and (b) the current status of the Release.
 
 Request type PUBLISH.
 - Release must be Work In Progress (WIP).
 - The Create action sets the Date time From of the release to the Workflow Request Date time
 - Updates the Emergency flag, Reservation flag, Archive flag, Alert flag values of the 
 release to the corresponding values of the Workflow Request. 
 - If there is a previous release for that Matrix Code, it sets the Date time To to the 
 Workflow Request Date time.
 - There must be a live Product associated with the Release before it can be published.

 
 Request type FLAG.
 - Release must either be Live Now or Live Next.
 - The create action updates the Emergency flag, Reservation flag, Archive flag and Alert flag values of the release to the corresponding values of the Workflow Request.
 
 Request type DELETE (not to be confused with Rollback - see below).
 - Release must either be Live Now or Live Next or WIP.
 - If the requested release is Live Next, the API sets the corresponding Live Now release 
 Date time To to NOW. Then soft delete the Live Next release.
 - Alternatively, if the requested release is Live Now, it sets the corresponding 
 Live Now release Date time To to NOW.
 - Alternatively, if the requested release is WIP, it deletes the WIP release.
 - If the request release is any other status, output an error.
 
 Request type ROLLBACK.
 - Release must either be Live Now or Live Next.
 - If the requested release is Live Next, the API deletes the Live Next release. 
 Then set the corresponding Live Now release Date time To to null.
 - If the requested release is Live Now, it finds the Live Previous and deletes 
 the Live Now release. Then it sets the Date time To of Live Previous to null. 
 - If no Live Previous is found then return an error.
 - If the request release is any other status, output an error.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.Workflow.WorkflowSignoff_API.Create

Parameters:

Name Type Default Description
RlsCode Int Release Code
SgnCode String Signoff Code
CmmValue String Comment for Signoff
CcnUsername String System User System User

Return: String with value of success or error.

Clone this wiki locally