added LSL2 stored procedures
This commit is contained in:
123
LSL2/STPROC/WM_IN_SERVICES.txt
Normal file
123
LSL2/STPROC/WM_IN_SERVICES.txt
Normal file
@ -0,0 +1,123 @@
|
||||
Compile function WM_IN_Services(@Service, @Params)
|
||||
/***********************************************************************************************************************
|
||||
|
||||
Name : WM_IN_Services
|
||||
|
||||
Description : Handler program for all WM_IN services.
|
||||
|
||||
Notes : Application errors should be logged using the Error Services module. There are a few methodological
|
||||
assumptions built into way errors are managed which are important to understand in order to properly
|
||||
work with Error Services:
|
||||
|
||||
- The term 'top' refers to the originating procedure of a call stack and the term 'bottom' refers to
|
||||
the last routine (or the current routine) within a call stack. Within the OpenInsight Debugger
|
||||
this will appear backwards since the originating procedure always appears at the bottom of the
|
||||
list and the current routine appears at the top of the list. We are using this orientation because
|
||||
it is common to refer to the process of calling other procedures as 'drilling down'.
|
||||
|
||||
- The reason for defining the orientation of the call stack is because Error_Services allows for
|
||||
multiple error conditions to be appended to an original error. In most cases this will happen when
|
||||
a procedure at the bottom of the stack generates an error condition and then returns to its
|
||||
calling procedure. This higher level procedure can optionally add more information relevant to
|
||||
itself. This continues as the call stack 'bubbles' its way back to the top to where the
|
||||
originating procedure is waiting.
|
||||
|
||||
- Native OpenInsight commands that handle errors (e.g., Set_Status, Set_FSError, Set_EventStatus)
|
||||
preserve their error state until explicitly cleared. This can hinder the normal execution of code
|
||||
since subsequent procedures (usually SSPs) will fail if a pre-existing error condition exists.
|
||||
Our philosophy is that error conditions should automatically be cleared before a new procedure
|
||||
is executed to avoid this problem. However, the nature of Basic+ does not make this easy to
|
||||
automate for any given stored procedure. Therefore, if a stored procedure wants to conform to our
|
||||
philosophy then it should include a call into the 'Clear' service request at the top of the
|
||||
program. Alternatively this can be done through a common insert (see SERVICE_SETUP for example.)
|
||||
|
||||
- Service modules will use the SERVICE_SETUP insert and therefore automatically clear out any
|
||||
error conditions that were set before.
|
||||
|
||||
Parameters :
|
||||
Service [in] -- Name of the service being requested
|
||||
Param1-10 [in/out] -- Additional request parameter holders
|
||||
Response [out] -- Response to be sent back to the Controller (MCP) or requesting procedure
|
||||
|
||||
Metadata :
|
||||
|
||||
History : (Date, Initials, Notes)
|
||||
9/5/23 djm Original programmer.
|
||||
|
||||
***********************************************************************************************************************/
|
||||
#pragma precomp SRP_PreCompiler
|
||||
$insert LOGICAL
|
||||
$Insert SERVICE_SETUP
|
||||
|
||||
$Insert MSG_EQUATES
|
||||
$Insert DICT_EQUATES
|
||||
$Insert WM_IN_EQUATES
|
||||
|
||||
Declare function Database_Services
|
||||
Declare function PSN_Services, SRP_Rotate_Array, Datetime
|
||||
Declare subroutine Database_Services,
|
||||
|
||||
GoToService
|
||||
|
||||
Return Response or ""
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// SERVICES
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
|
||||
//----------------------------------------------------------------------------------------------------------------------
|
||||
// GetComments
|
||||
//
|
||||
// WMINNo - [Required]
|
||||
//
|
||||
// Returns a delimited array of all EPP_COMMENT_NOTE, EPP_COMMENT_USER, and EPP_COMMENT_DATE
|
||||
// associated with a WM_IN record. Note: Dates are returned Oconv'd.
|
||||
//----------------------------------------------------------------------------------------------------------------------
|
||||
Service GetComments(WMINNo)
|
||||
|
||||
CommentArray = ''
|
||||
WMInRow = Database_Services('ReadDataRow', 'WM_IN', WMInNo)
|
||||
|
||||
CommentDates = Oconv(WMInRow<WM_IN_EPP_COMMENT_DATE$>, 'DT')
|
||||
CommentUsers = WMInRow<WM_IN_EPP_COMMENT_USER$>
|
||||
Comments = WMInRow<WM_IN_EPP_COMMENT_NOTE$>
|
||||
|
||||
CommentList = CommentDates :@FM: CommentUsers :@FM: Comments
|
||||
CommentArray = SRP_Rotate_Array(CommentList)
|
||||
Response = CommentArray
|
||||
|
||||
End Service
|
||||
|
||||
|
||||
//----------------------------------------------------------------------------------------------------------------------
|
||||
// AddComment
|
||||
//
|
||||
// WMInNo - [Required]
|
||||
// Comment - [Required]
|
||||
//
|
||||
// Adds an EPP_COMMENT_NOTE, EPP_COMMENT_USER, and EPP_COMMENT_DATE
|
||||
// to a WM_In record.
|
||||
//----------------------------------------------------------------------------------------------------------------------
|
||||
Service AddComment(WMInNo, Comment)
|
||||
|
||||
WMInRow = Database_Services('ReadDataRow', 'WM_IN', WMInNo)
|
||||
UserName = @USER4
|
||||
CommentTime = Datetime()
|
||||
|
||||
OldDates = WMInRow<WM_IN_EPP_COMMENT_DATE$>
|
||||
OldUsers = WMInRow<WM_IN_EPP_COMMENT_USER$>
|
||||
OldComments = WMInRow<WM_IN_EPP_COMMENT_NOTE$>
|
||||
If (OldDates EQ '' AND OldUsers EQ '' AND OldComments EQ '') then
|
||||
WMInRow<WM_IN_EPP_COMMENT_DATE$> = CommentTime
|
||||
WMInRow<WM_IN_EPP_COMMENT_USER$> = UserName
|
||||
WMInRow<WM_IN_EPP_COMMENT_NOTE$> = Comment
|
||||
end else
|
||||
WMInRow<WM_IN_EPP_COMMENT_DATE$> = CommentTime :@VM: OldDates
|
||||
WMInRow<WM_IN_EPP_COMMENT_USER$> = UserName :@VM: OldUsers
|
||||
WMInRow<WM_IN_EPP_COMMENT_NOTE$> = Comment :@VM: OldComments
|
||||
end
|
||||
Database_Services('WriteDataRow', 'WM_IN', WMInNo, WMInRow, 1, 0, 0)
|
||||
|
||||
End Service
|
||||
|
Reference in New Issue
Block a user