From 8d9ebaf8b4e4ec1fcc3cee554d8742a277a76ccb Mon Sep 17 00:00:00 2001 From: "Infineon\\Ouellette" Date: Tue, 14 Jan 2025 17:53:40 -0700 Subject: [PATCH] Commiting what I have so far. GET API is set up --- LSL2/STPROC/RDS_SERVICES.txt | 35 +++++- LSL2/STPROC/RETURNTOFAB_API.txt | 156 +++++++++++++++++++++++++ LSL2/STPROC/RETURN_TO_FAB_SERVICES.txt | 61 +++++++++- LSL2/STPROC/WM_OUT_SERVICES.txt | 27 ++++- 4 files changed, 269 insertions(+), 10 deletions(-) create mode 100644 LSL2/STPROC/RETURNTOFAB_API.txt diff --git a/LSL2/STPROC/RDS_SERVICES.txt b/LSL2/STPROC/RDS_SERVICES.txt index b37384c..4203b10 100644 --- a/LSL2/STPROC/RDS_SERVICES.txt +++ b/LSL2/STPROC/RDS_SERVICES.txt @@ -82,6 +82,7 @@ $Insert POPUP_EQUATES $Insert NOTIFICATION_EQUATES $Insert DICT_EQUATES $Insert COMPANY_EQUATES +$Insert RETURN_TO_FAB_LOTS_EQUATES EQU COL$LSID TO 1 EQU COL$RECIPE TO 2 @@ -118,7 +119,7 @@ Declare function Work_Order_Services, SRP_JSON, Logging_Services, Environment Declare function Memberof, Obj_WO_Mat, Obj_WO_Mat_Log, SRP_Array, DateTime, Dialog_Box, obj_Prod_Spec Declare function RDS_Services, RTI_DistinctList, GetTickCount, Clean_Insp_Services, WO_Mat_QA_Services Declare function PSN_Services, Rds_Layer_Services, SRP_Rotate_Array, Qa_Services, SRP_Date, SRP_Time, SRP_Datetime -Declare function Reactor_Services, Signature_Services, obj_rds, Test_Run_Services +Declare function Reactor_Services, Signature_Services, obj_rds, Test_Run_Services, Return_To_Fab_Services LogPath = Environment_Services('GetApplicationRootPath') : '\LogFiles\RDS' LogDate = Oconv(Date(), 'D4/') @@ -1074,7 +1075,6 @@ end service Service ConvertRecordToJSON(KeyID, Record, itemURL) - jsonRecord = '' If KeyID NE '' then @@ -1125,12 +1125,12 @@ Service ConvertRecordToJSON(KeyID, Record, itemURL) If CustReshipNo NE '' then CustNo = CustReshipNo end - CustName = Database_Services('ReadDataColumn', 'COMPANY', CustNo, COMPANY_CO_NAME$, True$, 0, False$) - CustAbbrev = Database_Services('ReadDataColumn', 'COMPANY', CustNo, COMPANY_ABBREV$, True$, 0, False$) + CustName = Database_Services('ReadDataColumn', 'COMPANY', CustNo, COMPANY_CO_NAME$, True$, 0, False$) + CustAbbrev = Database_Services('ReadDataColumn', 'COMPANY', CustNo, COMPANY_ABBREV$, True$, 0, False$) SRP_JSON(objRDS, 'SetValue', 'CustNo', CustNo) SRP_JSON(objRDS, 'SetValue', 'CustName', CustName) SRP_JSON(objRDS, 'SetValue', 'CustAbbrev', CustAbbrev) - + // Save system variables AtID = @ID AtRecord = @Record @@ -1224,7 +1224,29 @@ Service ConvertRecordToJSON(KeyID, Record, itemURL) SRP_JSON(objRDS, 'Set', 'rdsLayers', objRDSLayerArray) SRP_JSON(objRDSLayerArray, 'Release') end - + AllRTFRecords = Return_To_Fab_Services('GetReturnToFabRecordIdByCassId', KeyID) + If AllRTFRecords NE '' then + objRTFRecords = '' + If SRP_JSON(objRTFRecords, 'New', 'Array') then + For each RTFRecordId in AllRTFRecords using @VM setting vPos + objRTF = '' + If SRP_JSON(objRTF, 'New', 'Object') then + RTFRecord = Database_Services('ReadDataRow', 'RETURN_TO_FAB_LOTS', RTFRecordId, True$, 0, False$) + SRP_JSON(objRTF, 'SetValue', 'ReturnToFabLotsId', RTFRecordId) + SRP_JSON(objRTF, 'SetValue', 'StartDtm', OConv(RTFRecord, 'DT')) + SRP_JSON(objRTF, 'SetValue', 'Completed', RTFRecord, 'Boolean') + SRP_JSON(objRTFRecords, 'Set', 'ReturnToFabRecord', objRTF) + SRP_JSON(objRTFRecords, 'Add', objRTF) + SRP_JSON(objRTF, 'Release') + end + Next RTFRecordId + + SRP_JSON(objRDS, 'Set', 'ReturnToFabRecords', objRTFRecords) + SRP_JSON(objRTFRecords, 'Release') + end + end else + SRP_JSON(objRDS, 'SetValue', 'ReturnToFabRecords', '') + end SRP_JSON(objJSON, 'Set', 'rds', objRDS) SRP_JSON(objRDS, 'Release') end @@ -1673,3 +1695,4 @@ return + diff --git a/LSL2/STPROC/RETURNTOFAB_API.txt b/LSL2/STPROC/RETURNTOFAB_API.txt new file mode 100644 index 0000000..e709d5c --- /dev/null +++ b/LSL2/STPROC/RETURNTOFAB_API.txt @@ -0,0 +1,156 @@ +Function Returntofab_API(@API) +/*********************************************************************************************************************** + + This program is proprietary and is not to be used by or disclosed to others, nor is it to be copied without written + permission from SRP Computer Solutions, Inc. + + Name : Returntofab_API + + Description : API logic for the Returntofab resource. + + Notes : All web APIs should include the API_SETUP insert. This will provide several useful variables: + + HTTPMethod - The HTTP Method (Verb) submitted by the client (e.g., GET, POST, etc.) + APIURL - The URL for the API entry point (e.g., api.mysite.com/v1). + FullEndpointURL - The URL submitted by the client, including query params. + FullEndpointURLNoQuery - The URL submitted by the client, excluding query params. + EndpointSegment - The URL endpoint segment. + ParentURL - The URL path preceeding the current endpoint. + CurrentAPI - The name of this stored procedure. + + Parameters : + API [in] -- Web API to process. Format is [APIPattern].[HTTPMethod]: + - APIPattern must follow this structure Returntofab[.ID.[]] + - HTTPMethod can be any valid HTTP method, e.g., GET, POST, PUT, DELETE, etc. + Examples: + - Returntofab.POST + - Returntofab.ID.PUT + - Returntofab.ID.firstName.GET + Response [out] -- Response to be sent back to the Controller (HTTP_MCP) or requesting procedure. Web API + services do not rely upon anything being returned in the response. This is what the + various services like SetResponseBody and SetResponseStatus services are for. A response + value is only helpful if the developers want to use it for debug purposes. + + History : (Date, Initials, Notes) + 01/14/25 xxx Original programmer. + +***********************************************************************************************************************/ + +#pragma precomp SRP_PreCompiler + +Declare function OI_Wizard_Services, Return_To_Fab_Services + +$insert APP_INSERTS +$insert API_SETUP +$insert HTTP_INSERTS + +GoToAPI else + // The specific resource endpoint doesn't have a API handler yet. + HTTP_Services('SetResponseStatus', 204, 'This is a valid endpoint but a web API handler has not yet been created.') +end + +Return Response OR '' + + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// Endpoint Handlers +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + + +API returntofab.POST + OIWizardID = '' + Cookies = HTTP_Services('GetHTTPCookie') + For each Cookie in Cookies using ';' + Key = Field(Cookie, '=', 1) + If Key EQ 'sessionID' then + OIWizardID = Field(Cookie, '=', 2) + end + Next Cookie + + ValidSession = OI_Wizard_Services('ValidateSession', OIWizardID) + + If ValidSession then + Body = HTTP_Services('GetHTTPPostString') + If Body NE '' then + RTFCreateJson = HTTP_Services('DecodePercentString', Body) + ParseResponse = SRP_JSON(hRTFCreateJson, 'PARSE', RTFCreateJson) + If (ParseResponse EQ '') then + UserId = Xlate('OI_WIZARD', OIWizardID, 'EMPLOYEE_ID', 'X') + CassId = SRP_JSON(hRTFCreateJson, 'GetValue', 'cassId') + SRP_JSON(hRTFCreateJson, 'Release') + NewRTFId = Return_To_Fab_Services('CreateReturnToFabRecord', CassId, UserId) + If Error_Services('NoError') AND NewRTFId NE '' then + RTFJson = Return_To_Fab_Services('ConvertReturnToFabRecordToJSON', NewRTFId) + If Error_Services('NoError') then + HTTP_Services('SetResponseHeaderField', 'Content-Location', FullEndpointURL) + HTTP_Services('SetResponseBody', RTFJson, False$, 'application/hal+json') + If Assigned(Message) then + HTTP_Services('SetResponseStatus', 201, Message) + end else + HTTP_Services('SetResponseStatus', 201) + end + end else + + end + + end else + HTTP_Services('SetResponseStatus', 400, Error_Services('GetMessage')) + end + end else + // Error parsing JSON + HTTP_Services('SetResponseStatus', 400, 'Unable to parse the JSON data from the request.') + end + end else + HTTP_Services('SetResponseStatus', 400, 'JSON object is missing in the body of the request.') + end + end else + HTTP_Services('SetResponseStatus', 401, 'Invalid session. Reauthentication required.') + end + +end api + + +API returntofab.ID.HEAD +API returntofab.ID.GET + OIWizardID = '' + Cookies = HTTP_Services('GetHTTPCookie') + For each Cookie in Cookies using ';' + Key = Field(Cookie, '=', 1) + If Key EQ 'sessionID' then + OIWizardID = Field(Cookie, '=', 2) + end + Next Cookie + + ValidSession = OI_Wizard_Services('ValidateSession', OIWizardID) + + If ValidSession then + UserId = Xlate('OI_WIZARD', OIWizardID, 'EMPLOYEE_ID', 'X') + RTFId = EndpointSegment + If Error_Services('NoError') AND RTFId NE '' then + RTFJson = Return_To_Fab_Services('ConvertReturnToFabRecordToJSON', RTFId) + If Error_Services('NoError') then + HTTP_Services('SetResponseHeaderField', 'Content-Location', FullEndpointURL) + HTTP_Services('SetResponseBody', RTFJson, False$, 'application/hal+json') + If Assigned(Message) then + HTTP_Services('SetResponseStatus', 201, Message) + end else + HTTP_Services('SetResponseStatus', 201) + end + end else + + end + + end else + HTTP_Services('SetResponseStatus', 400, Error_Services('GetMessage')) + end + end else + HTTP_Services('SetResponseStatus', 401, 'Invalid session. Reauthentication required.') + end +end api + + +API returntofab.ID.PATCH + + HTTP_Resource_Services('LoremIpsum') + +end api diff --git a/LSL2/STPROC/RETURN_TO_FAB_SERVICES.txt b/LSL2/STPROC/RETURN_TO_FAB_SERVICES.txt index 5d8c4d5..f800372 100644 --- a/LSL2/STPROC/RETURN_TO_FAB_SERVICES.txt +++ b/LSL2/STPROC/RETURN_TO_FAB_SERVICES.txt @@ -1,10 +1,10 @@ Compile function RETURN_TO_FAB_Services(@Service, @Params) #pragma precomp SRP_PreCompiler -Declare subroutine Error_Services, Database_Services, Btree.Extract, Logging_Services +Declare subroutine Error_Services, Database_Services, Btree.Extract, Logging_Services, SRP_JSON Declare function Rti_Createguid, Database_Services, Return_To_Fab_Services, Datetime, Error_Services -Declare function Logging_Services, Environment_Services +Declare function Logging_Services, Environment_Services, SRP_JSON $insert LOGICAL $Insert APP_INSERTS @@ -165,7 +165,61 @@ Service GetReturnToFabRecordById(RTFId) end service Service ConvertReturnToFabRecordToJSON(RTFId) - + ErrorMessage = '' + JsonString = '' + If RowExists('RETURN_TO_FAB_LOTS', RTFId) then + objJSON = '' + If SRP_JSON(objJSON, 'New', 'Object') then + RTFRecord = Database_Services('ReadDataRow', 'RETURN_TO_FAB_LOTS', RTFId, True$, 0, False$) + If Error_Services('NoError') AND RTFRecord NE '' then + If SRP_JSON(objRTF, 'New', 'Object') then + SRP_JSON(objRTF, 'SetValue', 'ReturnToFabLotsId', RTFId) + SRP_JSON(objRTF, 'SetValue', 'CassId', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'LotType', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'RequestorUserId', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'StartDtm', OConv(RTFRecord, 'DT')) + SRP_JSON(objRTF, 'SetValue', 'MHInitUserId', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'MHInitDtm', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'EvalUserId', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'EvalResultId', RTFRecord, 'Number') + SRP_JSON(objRTF, 'SetValue', 'EvalDtm', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'FinalCompleteUserId', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'FinalCompleteDtm', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'Completed', RTFRecord, 'Boolean') + SRP_JSON(objRTF, 'SetValue', 'CompletedDtm', RTFRecord) + SRP_JSON(objRTF, 'SetValue', 'Reason', RTFRecord) + Notes = RTFRecord + NotesUser = RTFRecord + If Notes NE '' then + objNotes = '' + If SRP_JSON(objNotes, 'New', 'Array') then + For each Note in Notes using @VM setting vPos + SRP_JSON(objNotes, 'AddValue', Notes<1,vPos>) + SRP_JSON(objNotes, 'AddValue', NotesUser<1,vPos>) + Next Note + SRP_JSON(objRTF, 'Set', 'Notes', objNotes) + SRP_JSON(objNotes, 'Release') + end + end else + SRP_JSON(objRTF, 'SetValue', 'Notes', '') + end + SRP_JSON(objJSON, 'Set', 'ReturnToFab', objRTF) + SRP_JSON(objRTF, 'Release') + end else + ErrorMessage = 'Error creating new Json Object' + end + end else + ErrorMessage = 'Error reading RTFRecord from database...' + end + JsonString = SRP_JSON(objJSON, 'Stringify', 'Styled') + SRP_JSON(objJSON, 'Release') + end else + ErrorMessage = 'Error creating new Json Object' + end + end else + ErrorMessage = 'Error Converting RTF record to JSON. RTFId not found in database.' + end + Response = JsonString end service Service GetReturnToFabRecordIdByCassId(CassId) @@ -487,3 +541,4 @@ Service AddMiscNote(RTFId, Note, UserId) end service + diff --git a/LSL2/STPROC/WM_OUT_SERVICES.txt b/LSL2/STPROC/WM_OUT_SERVICES.txt index c15a91a..d896eb2 100644 --- a/LSL2/STPROC/WM_OUT_SERVICES.txt +++ b/LSL2/STPROC/WM_OUT_SERVICES.txt @@ -56,9 +56,10 @@ $Insert WM_OUT_EQUATES $Insert WO_MAT_EQUATES $Insert WO_LOG_EQUATES $Insert COMPANY_EQUATES +$Insert RETURN_TO_FAB_LOTS_EQUATES Declare function Database_Services, SRP_JSON, Error_Services, Clean_Insp_Services, WO_Mat_QA_Services -Declare function PSN_Services, SRP_Rotate_Array, Datetime +Declare function PSN_Services, SRP_Rotate_Array, Datetime, Return_To_Fab_Services Declare subroutine Database_Services, SRP_JSON, Error_Services, Extract_Si_Keys GoToService @@ -170,6 +171,29 @@ Service ConvertRecordToJSON(KeyID, Record, ItemURL) SRP_JSON(objWMOut, 'SetValue', 'postEpiSigDtm', OConv({POST_EPI_SIG_DTM}, 'DT/^1HS')) SRP_JSON(objWMOut, 'SetValue', 'supVerSig', {SUP_VER_SIG}) SRP_JSON(objWMOut, 'SetValue', 'supVerSigDtm', OConv({SUP_VER_SIG_DTM}, 'DT/^1HS')) + AllRTFRecords = Return_To_Fab_Services('GetReturnToFabRecordIdByCassId', KeyID) + If AllRTFRecords NE '' then + objRTFRecords = '' + If SRP_JSON(objRTFRecords, 'New', 'Array') then + For each RTFRecordId in AllRTFRecords using @VM setting vPos + objRTF = '' + If SRP_JSON(objRTF, 'New', 'Object') then + RTFRecord = Database_Services('ReadDataRow', 'RETURN_TO_FAB_LOTS', RTFRecordId, True$, 0, False$) + SRP_JSON(objRTF, 'SetValue', 'ReturnToFabLotsId', RTFRecordId) + SRP_JSON(objRTF, 'SetValue', 'StartDtm', OConv(RTFRecord, 'DT')) + SRP_JSON(objRTF, 'SetValue', 'Completed', RTFRecord, 'Boolean') + SRP_JSON(objRTFRecords, 'Set', 'ReturnToFabRecord', objRTF) + SRP_JSON(objRTFRecords, 'Add', objRTF) + SRP_JSON(objRTF, 'Release') + end + Next RTFRecordId + + SRP_JSON(objWMOut, 'Set', 'ReturnToFabRecords', objRTFRecords) + SRP_JSON(objRTFRecords, 'Release') + end + end else + SRP_JSON(objWMOut, 'SetValue', 'ReturnToFabRecords', '') + end CINos = {EPO_CI_NO} // Add a PSN object ProdSpecJSON = PSN_Services('ConvertRecordToJSON', {PS_NO}) @@ -374,3 +398,4 @@ Service GetWaferMap(WMOKey) end service +