Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

MES Stateless API

TABLE OF CONTENTS

CertStartAllowed Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The CertStartAllowed() method returns the status of whether a job or a job step may be started by a specific user based on the user’s certifications and any of the required certification(s) linked to the operation, step, or item.

Syntax

'Declaration
 
Public Shared Function CertStartAllowed( _
   ByVal userId As String, _
   ByVal processId As String, _
   ByVal operId As String, _
   ByVal stepNo As Nullable(Of Integer), _
   ByVal itemId As String _
) As Boolean
'Usage
 
Dim userId As String
Dim processId As String
Dim operId As String
Dim stepNo As Nullable(Of Integer)
Dim itemId As String
Dim value As Boolean
 
value = JobExec.CertStartAllowed(userId, processId, operId, stepNo, itemId)
public static bool CertStartAllowed( 
   string userId,
   string processId,
   string operId,
   Nullable<int> stepNo,
   string itemId
)

Parameters

userId
Required. Holds the ID of the user who is signing off on this certification.
processId
Optional. Holds a process ID.
operId
Required. Holds the process' operation.
stepNo
Optional. Holds the operation step number.
itemId
Required. Holds the ID of the item.

Return Value

Returns true if the user has valid certification; otherwise, it returns false.

Remarks

There may be any number of certifications defined at each of the operation, step, and item levels, including none. Any defined certifications are ANDed together before allowing the specified user to perform the operation.

If the audit property (cert_type.audit) for a certification is turned off, this method verifies whether the user has a valid certification to start a job (cert_oper_link, cert_item_link) or job step (cert_oper_step_link).

This method returns true if any of the conditions below are true:

  • There are no certifications attached to the supplied operation/operation step and/or item with audit type turned off (cert_type.audit = false)
  • The supplied user has all the certifications for a job/job step that require certifications.

For the method to succeed, the following must be true:

  • The supplied user has a valid certification.
  • The user’s certification level is greater or at least equal to the required certification level.
  • The user’s certification has not expired.

See Also

Reference

JobExec Class
JobExec Members

In This Topic
TitleResults for “How to create a CRG?”Also Available in