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

CheckIn Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
The CheckIn() method is used to check in a process that a user has checked out.

Syntax

'Declaration
 
Public Shared Sub CheckIn( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal processId As String, _
   ByVal notes As DBString, _
   ByRef modId As String _
) 
'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim processId As String
Dim notes As DBString
Dim modId As String
 
Process.CheckIn(sessionId, userId, processId, notes, modId)
public static void CheckIn( 
   int sessionId,
   string userId,
   string processId,
   DBString notes,
   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 in the process.
processId
Required. Holds the ID of the process that is being checked in.
notes
Optional. Holds the notes about this process.
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 specified process will be checked in if the supplied user is the same user who checked out this process. If the system attribute “Require notes upon process check-in” (attr_id=327) is set to true and if a note is supplied, then the process is updated with the supplied notes when checking in the process. If this system attribute is false, then the supplied note is ignored when checking in the process. Finally, the checked_out column in the process table for this process is updated with a null value, thus enabling other users to check out this process for making edits.

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

  • Valid values are passed in the processId and userId parameters.
  • The specified process is checked out.
  • The specified user is the user who checked out this process.
  • If the system attribute for “Require notes upon process check in” is set to true, a note has been supplied.

See Also

Reference

Process Class
Process Members

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