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

CheckOut Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The CheckOut() method checks out a process for a user to edit.

Syntax

'Declaration
 
Public Shared Sub CheckOut( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal processId As String, _
   ByRef modId As String _
) 
'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim processId As String
Dim modId As String
 
Process.CheckOut(sessionId, userId, processId, modId)
public static void CheckOut( 
   int sessionId,
   string userId,
   string processId,
   out string modId
)

Parameters

sessionId
Required. Holds the session ID and thus the user who is making this method call.
userId
Required. Holds the user ID of the user who is checking out the process.
processId
Required. Holds the ID of the process that is being checked out.
modId

Required. Holds the modification ID assigned the last time this record was added or updated, for optimistic concurrency control. The passed value must match the record's modId value for the record to be updated.

Output. Holds the new modification ID to identify this update of this record.

Remarks

The user checks out a process to modify or delete the process. This restricts access of the selected process to the user who has it checked out. Only this user will be able to edit the process until it has been checked back in. Checking out a process is an indication that a user is editing the process, but the Middleware does not prevent other users from editing the process. The enforcement of the check out must be provided by the client-side.

Note that the following must be true for the method to succeed:

  • The supplied user has the appropriate permission/privilege to edit a process.
  • The process is not currently checked out by any other user.
  • The process is not a certified process.
  • Valid values are passed in the processId and userId parameters.

If the method succeeds, the supplied user ID is written to the checked_out_by column of the process record.

The process will remain checked out, even after the current user logs off, until it is explicitly checked in.

See Also

Reference

Process Class
Process Members

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