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

MES Stateless API

SetReason(Int32,String,String,String,Int32,DBString) Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
TABLE OF CONTENTS

SetReason(Int32,String,String,String,Int32,DBString) Method

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL

The SetReason() method sets the current reason code for the specified entity.

This overload of the method uses a site name and entity name to specify the entity.

Syntax

'Declaration
 
Public Overloads Shared Sub SetReason( _
   ByVal sessionId As Integer, _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal userId As String, _
   ByVal newReasCd As Integer, _
   ByVal comments As DBString _
) 
'Usage
 
Dim sessionId As Integer
Dim entName As String
Dim siteName As String
Dim userId As String
Dim newReasCd As Integer
Dim comments As DBString
 
UtilExec.SetReason(sessionId, entName, siteName, userId, newReasCd, comments)
public static void SetReason( 
   int sessionId,
   string entName,
   string siteName,
   string userId,
   int newReasCd,
   DBString comments
)

Parameters

sessionId
Required. Holds the session ID and thus the user who is making this method call.
entName
Required. Holds the name of the entity whose current reason code is being set.
siteName
Required. Holds the site name of the entity whose current reason code is being set.
userId
Required. Holds the user ID of the user who is setting the new reason on this entity.
newReasCd
Required. Holds the code for the new current reason.
comments
Optional. Holds additional information for the new reason.

Remarks

This method first reads the Util_Exec record for the specified entity to determine the reason required (reas_reqd), current state code (cur_state_cd), and the current utilization event (cur_log_id) flags. Then it reads the default labor code (util_reas.def_lab_cd) from the Util_Reas table to determine whether setting this new reason should trigger a labor transaction or not. If a non-null labor code is configured for the supplied reason code, then this labor code is applied to all users who are actively logged on to this entity, thereby closing their existing labor record and re-opening a new labor record with this default labor code.

See Also

Reference

UtilExec Class
UtilExec Members
Overload List

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