Workflow (Request) Transactions

Limited Support/End of Life Capabilities

The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact Alemba Support

ASM has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common ASM transactions. This section of the documentation deals with the Classic API.

Workflow transactions are used to create, update, retrieve, forward, authorize and complete Requests. These transactions use a prefix of Workflow instead of Request, as Request is a special term used by the web service.

Requests created through the API must be created from existing workflow templates. However, workflow templates can not be created through the API.

Availability transactions are available to find linked outages as well as create new ones.

The Classic API has transactions which enable you to send an email to Users, analysts and stakeholders. See Message Transactions for more information.

WorkflowCreate Transaction

The WorkflowCreate transaction can be used to create a request from a workflow template.

Input Parameters: WorkflowCreateRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Ignored	-	Ignored on create
lTemplateRef	Lookup Field	Yes	-	Reference of the workflow template to use to create the Request
sRequestRef	String	No	“”	Request Ref
sTitle	String	No	“”	Request title
lCustomer	Lookup Field	No	0	Request User
lFwdOfficer	Lookup Field	No	0	Analyst to whom to forward the Request
lLocation	Lookup Field	No	0	Request Location
lOrganization	Lookup Field	No	0	Request Organization
lPriority	Lookup Field	No	0	Request Priority
lRisk	Lookup Field	No	0	Request Risk
lType	Lookup Field	No	0	Request Type
dImpEnd	Date/Time	No	Now	Request Implementation End Date
dImpStart	Date/Time	No	Now	Request Implementation Start Date
dTargetDate	Date/Time	No	Now	Request Target Date
lFwdGroup	Lookup Field	No	0	Group to which to forward the Request
sDescription	String	No	“”	Request Description
lActionType	Lookup Field	No	0	Request Action & Solution Action Type
yPortal	Yes/No	No	N	Flag whether this Action & Solution is visible on the Self Service Portal. Values: Y = Action & Solution is visible on the Self Service Portal N = Action & Solution is not visible on the Self Service Portal
sActionDescription	String	No	“”	Action & Solution description
lRequestPhase	Lookup Field	No	0	Request Phase
lRequestStatus	Lookup Field	No	0	Request Completion Status
lSecurityProfile	Lookup Field	No	0	Security Profile to apply to the Action & Solution
sReason	String	No	“”	Audit reason
bSendEmail	Boolean	No	False	Flag whether to send an email to the assigned analyst/group. Values: True = send email to the assigned analyst/group False = do not send email to the assigned analyst/group
bSendPager	Boolean	No	False	Flag whether to send a pager message to the assigned analyst/group. Values: True = send pager message to the assigned analyst/group False = do not send pager message to the assigned analyst/group
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values:WorkflowResponse

Argument	Type	Description
nEntityRef	Integer	New Request Number
sMessage	String	Error/Warning Message
Ret	APIReturn	Error/Warning Number

WorkflowUpdate Transaction

The WorkflowUpdate transaction can be used to update and defer existing request.

Input Parameters: WorkflowUpdateRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request to update
lTemplateRef	Lookup Field	Ignored	-	Ignored on update
sRequestRef	String	No	(As is)	Request Ref
sTitle	String	No	(As is)	Request Title
lCustomer	Lookup Field	No	(As is)	Request User
lFwdOfficer	Lookup Field	No	(As is)	Analyst to whom to forward the Request
lLocation	Lookup Field	No	(As is)	Request Location
lOrganization	Lookup Field	No	(As is)	Request Organization
lPriority	Lookup Field	No	(As is)	Request Priority
lRisk	Lookup Field	No	(As is)	Request Risk
lType	Lookup Field	No	(As is)	Request Type
dImpEnd	Date/Time	No	(As is)	Request Implementation End Date
dImpStart	Date/Time	No	(As is)	Request Implementation Start Date
dTargetDate	Date/Time	No	(As is)	Request Target Date
lFwdGroup	Lookup Field	No	(As is)	Group to which to forward the Request
sDescription	String	No	(As is)	Request Description
lActionType	Lookup Field	No	0	Request Action & Solution Action Type
yPortal	Yes/No	No	N	Flag whether this Action & Solution is visible on the Self Service Portal. Values: Y = Action & Solution is visible on the Self Service Portal N = Action & Solution is not visible on the Self Service Portal
sActionDescription	String	No	“”	Action & Solution description
lRequestPhase	Lookup Field	No	(As is)	Request Phase
lRequestStatus	Lookup Field	No	(As is)	Request Completion Status
lSecurityProfile	Lookup Field	No	0	Security Profile to apply to the Action & Solution
sReason	String	No	“”	Audit reason
bSendEmail	Boolean	No	False	Flag whether to send an email to the assigned analyst/group. Values: True = send email to the assigned analyst/group False = do not send email to the assigned analyst/group
bSendPager	Boolean	No	False	Flag whether to send a pager message to the assigned analyst/group. Values: True = send pager message to the assigned analyst/group False = do not send pager message to the assigned analyst/group
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowRetrieve Transaction

The WorkflowRetrieve transaction can be used to search for and retrieve the details of a request.

Input Parameters: WorkflowRetrieveRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request to retrieve
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values:WorkflowRetrieveResponse

Argument	Type	Description
Ret	APIReturn	Error/Warning Number
sMessage	String	Error/Warning Message
RS	InfraEnterpriseAPI .Recordset	Infra Recordset object containing request’s details

WorkflowComplete Transaction

The WorkflowComplete transaction can be used to complete an existing request.

Input Parameters: WorkflowCompleteRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request to complete
lImpState	Lookup Field	No	0	Request Implementation State
lImpProfile	Lookup Field	No	0	Request Implementation Profile
dImpReviewDate	Date/Time	No	(null)	Request Implementation Review Date
lStatus	Lookup Field	No	0	Request completion status
sDetail	String	No	“”	Request Implementation details – description associated with the implementation.
bEmailOwner	Boolean	No	False	Flag whether to email the owner of any linked calls/requests. Values: True = email owners of linked calls/ requests False = do not email owners of linked calls/requests
bEmailRequestor	Boolean	No	False	Flag whether to email the Request User. Values: True = email User of request completion False = do not email User of request completion
bPagerOwner	Boolean	No	False	Flag whether to send a pager message to the owner of any linked calls/requests. Values: True = send a pager message to linked call/request owner False = do not send a pager message to linked call/request owner
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowAuthorize Transaction

The WorkflowAuthorize transaction can be used to authorize an existing request.

Input Parameters: WorkflowAuthorizeRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request to authorize
lStatus	Lookup Field	No	0	Request Completion Status
sPassword	String	Yes	-	Authorizer’s password
sComments	String	No	“”	Authorizer’s comments
bEmailRequestor	Boolean	No	False	Flag whether to email the Request User. Values: True = email the Request User False = do not email the Request User
sActionDesc	String	No	“”	Action & Solution history description
yAuthorized	Yes/No	Yes	-	Flag whether to authorize the Request. Values: Y = authorize the Request N = do not authorize the Request
lActionType	Lookup Field	No	0	Action & Solution action type
lAuthorizeStatus	Lookup Field	No	0	Authorize Status
sReason	String	No	“”	Audit reason
bSendEmail	Boolean	No	False	Flag whether to send an email to the assigned task analysts/groups. Values: True = send an email to assigned task owners False = do not send an email to assigned task owners
bSendPager	Boolean	No	False	Flag whether to send a pager message to the assigned task analysts/groups. Values: True = send a pager message to assigned task owners False = do not send an email to assigned task owners
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowForwardInternal Transaction

The WorkflowForwardInternal transaction can be used to open and forward an existing request.

Input Parameters: WorkflowInternalRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request to forward
lFwdOfficer	Lookup Field	No	0	Analyst to whom to forward the Request
lFwdGroup	Lookup Field	No	0	Group to which to forward the Request
bSendEmail	Boolean	No	False	Flag whether to send an email to the assigned analyst/group. Values: True = send email to assigned analyst/group False = do not send email to assigned analyst/group
bSendPager	Boolean	No	False	Flag whether to send a pager message to the assigned analyst/group. Values: True = send pager message to assigned analyst/group False = do not send pager message to assigned analyst/group
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowCreateOutage Transaction

The WorkflowCreateOutage transaction can be used to create an outage against an item linked to a request.

Input Parameters: WorkflowCreateOutageRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request against which to create an outage
lCMDBItem	Lookup Field	Yes	-	Linked CMDB item against which to create an outage
lOutageType	Lookup Field	No	Unspecified Planned	Outage type. This must be a planned outage type.
dOutageEnd	Date/Time	No	Now	Outage end date. This must be after the Outage start date. This value cannot be null.
dOutageStart	Date/Time	No	Now	Outage start date.
sOutageDesc	String	No	“”	Outage description
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Define Custom Parameters.

Return Values: WorkflowResponse

See WorkflowResponse for more information.

WorkflowFindLinkedOutage Transaction

The WorkflowFindLinkedOutages transaction can be used to find outages linked to a request.

Input Parameters: WorkflowFindLinkedOutageRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the Request in which to find linked outages.
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: WorkflowRetrieveResponse

See WorkflowRetrieveResponse for more information.