VPSPARAM ;WOIFO/BT - Update VPS PARAMETER file ;11/14/12 15:30
Source file <VPSPARAM.m>
| action | A | extended action | Ea | event driver | Ed | subscriber | Su | protocol | O | limited protocol | LP | run routine | RR | broker | B | edit | E | server | Se | P | screenman | SM | inquire | I |
| Name | Comments | DBIA/ICR reference |
|---|---|---|
| WRITE(RESULT,PARAMTYP,PARAMNAM,PARAM) | ; RPC: VPS WRITE KIOSK PARAMETERS
; Many facets of MRAR behavior are dictated by a set of business parameters defined and ; entered by the healthcare facility administrator. ; For statistical purposes, VetLink will call this RPC to store these configuration changes. ; There are two ways to store the configuration changes, by KioskGroup and by Clinic. ; ; INPUT ; RESULT : the results of processing and passed in by reference (required by RPC Broker) ; PARAMTYP : type of configuration changes, By KIOSK GROUP (K) or by Clinic (C). ; PARAMNAM : KIOSK GROUP or CLINIC IEN depend on the PARMTYP. ; PARAM : array representing the configuration parameters changed made in Vetlinks passed in by reference ; PARAM(0..n) = FIELD NAME^FIELD VALUE ; n is an incremental number; ; FIELD NAME represents the field that was changed in VetLink ; FIELD VALUE is the actual data that was updated in VetLink and to be stored in File 853. ; ; OUTPUT ; RESULT : array that returns the results of each updated field per array data element. ; SUCCESS RESULT: ; RESULT(n) = FIELD NAME^FIELD VALUE^1 ; '1' at the end of the result string indicates successful update to the database of the specific field declared at field label. ; ; FAILED RESULT : ; RESULT(n)="FIELD NAME^FIELD VALUE^99^exception message" ; '99^exception message' at the end of the result string indicates an exception and no update was made to the database for that specific field and exception message describes the error. |
|
| UPDPARAM(PARAMTYP,PARAMNAM,PARAM,RESULT) | ;Store input parameters
; INPUT ; PARAMTYP : type of configuration changes, By KIOSK GROUP (K) or by Clinic (C). ; PARAMNAM : KIOSK GROUP or CLINIC IEN depend on the PARMTYP. ; PARAM : array representing the configuration parameters changed made in Vetlinks passed in by reference ; PARAM(0..n) = FIELD NAME^FIELD VALUE ; n is an incremental number; ; FIELD NAME represents the field that was changed in VetLink ; FIELD VALUE is the actual data that was updated in VetLink and to be stored in File 853. ; ; INPUT/OUTPUT ; RESULT : array that returns the results of each updated field per array data element. ; SUCCESS RESULT: ; RESULT(n) = FIELD NAME^FIELD VALUE^1 ; '1' at the end of the result string indicates successful update to the database of the specific field declared at field label. ; ; FAILED RESULT : ; RESULT(n)="FIELD NAME^FIELD VALUE^99^exception message" ; '99^exception message' at the end of the result string indicates an exception and no update was made to the database for that specific field and exception message describes the error. |
|
| STRMULT(RESULT,PARAMIEN,TRNDT,FLDDEF,MULT) | ; Store multiple fields
; INPUT/OUTPUT ; RESULT : array that returns the results of each updated field per array data element. ; INPUT ; TRNDT : Transaction Date/Time - this field is also used as SUB IEN for this Transaction Level ; PARAMIEN : PARAMETER IEN for file 853 ; FLDDEF : array of field name definition ; MULT : array of multiple field entries ; RSNTYP : array of Incomplete Reason Types |
|
| ISVALID(PARAMTYP,PARAMNAM,PARAM) | ;validate RPC input parameters
; INPUT ; PARAMTYP : type of configuration changes, (eg, By KIOSK GROUP (K) or by Clinic (C)). ; PARAMNAM : Value of Parameter, (eg, KIOSK GROUP or CLINIC IEN depend on the PARMTYP.) ; PARAM : local array representing the configuration parameters changed made in Vetlinks passed in by reference ; OUTPUT ; SUCCESS : Empty String ; FAILED : FIELD NAME^FIELD VALUE^99^exception |
|
| CRPARAM(PARAMTYP,PARAMNAM) | ; Create PARAM entry in root level of file #853
; INPUT ; PARAMTYP : type of configuration changes, (eg, By KIOSK GROUP (K) or by Clinic (C)). ; PARAMNAM : Value of Parameter, (eg, KIOSK GROUP or CLINIC IEN depend on the PARMTYP.) ; OUTPUT ; SUCCESS : Empty String ; FAILED : FIELD NAME^FIELD VALUE^99^exception |
|
| GPARMIEN(PARAMTYP,PARAMNAM) | ; Get PARAM IEN for FILE 853
; INPUT ; PARAMTYP : type of configuration changes, (eg, By KIOSK GROUP (K) or by Clinic (C)). ; PARAMNAM : Value of Parameter name, (eg, KIOSK GROUP or CLINIC name depend on the PARMTYP.) ; OUTPUT ; SUCCESS : PARAMETER IEN for FILE 843 ; FAILED : Empty string |
|
| STRFIL(TRNDT,PARAMIEN,UPDFLD,FLDNAM,FLDVAL) | ; Store the modified field value
; INPUT ; TRNDT : Transaction Date/Time - this field is also used as SUB IEN for this Transaction Level ; PARAMIEN : PARAMETER IEN for file 853 ; UPDFLD : field info (File Number^Field Number^input type) ; FLDNAM : field name to update ; FLDVAL : field value to update ; OUTPUT ; SUCCESS : FIELD NAME^FIELD VALUE^1 ; FAILED : FIELD NAME^FIELD VALUE^99^exception message ; ; create entry in Transaction Date/Time level |
|
| ADDTRXN(TRNDT,PARAMIEN) | ; create an entry in Transaction Date/Time level
; INPUT ; TRNDT : Transaction Date/Time - this field is also used as SUB IEN for this Transaction Level ; PARAMIEN : PARAMETER IEN for file 853 ; RETURN ; SUCCESS : empty string ; FAILED : FIELD NAME^FIELD VALUE^99^exception message |
|
| UPDTRXN(PARAMIEN,TRNDT,UPDFLD,FLDNAM,FLDVAL) | ; update fields in transaction level
; INPUT ; PARAMIEN : PARAMETER IEN for file 853 ; TRNDT : Transaction Date/Time - this field is also used as SUB IEN for this Transaction Level ; UPDFLD : field info (File Number^Field Number^input type^Admin level Field Number^Admin level Field name) ; FLDNAM : field name to update ; FLDVAL : field value to update ; OUTPUT ; SUCCESS : FIELD NAME^FIELD VALUE^1 ; FAILED : FIELD NAME^FIELD VALUE^99^exception message ; |
|
| ADDMULT(FIL,PARAMIEN,TRNDT,RSNSUB,RSNTYP,ERR) | ; Add field .01 for Multiple fields if doesn't exist
; INPUT ; FIL : File number (853.011, 853.012, 853.013) ; PARAMIEN : PARAMETER IEN for file 853 ; TRNDT : Transaction Date/Time - this field is also used as SUB IEN for this Transaction Level ; RSNSUB : This is the literal subscript for the sub file (eq: ARREASON, MRREASON, AMRREASON) ; RSNTYP : field value of Incomplete Reason Type ; OUTPUT ; ERR : FileMan Error array ; RETURN ; Multiple SUBS IEN ; |
|
| ERROR(FDAERR,FLDNAME,FLDVAL) | ; Return error string that VetLink can recognize
; INPUT ; FDAERR : error array that was created when attempting to file the changes ; FLDNAME: the field that has invalid value ; FLDVAL : the invalid value ; RETURN ; Field Name^Field Value^99^error |
|
| RESULT(STATCODE,FLDNAME,FLDVAL,ERRMSG) | ;return result in the structure that VetLink expects
; INPUT ; STATCODE : status code (1 = successfull, 99 = error) ; FLDNAME : field name ; FLDVAL : field value ; ERRMSG : (OPTIONAL) error message to send back to RPC caller ; RETURN ; FLDNAME^FLDVAL^STATCODE^ERMSG |
|
| TABLE(FLDDEF) | ;build array of valid fields defined to VPS PARAMETER (#853)
; INPUT/OUTPUT ; FLDDEF : array by field names ; FLDDEF(field name)=file number^field number^input type^root field number ; type : I(nternal) or E(xternal) ; root field number : optional field. this field contains the current field value of the field being updated ; ex: FLDDEF("PDO INVOCABLE PDO")="853.01^1^I^.02" |
|
| PARMFLDS | ; list of Configuration Parameter Statistics fields defined in VPS PARAMETER file (#853)
|
| RPC Name | Call Tags |
|---|---|
| VPS WRITE KIOSK PARAMETERS | WRITE |
| Name | Line Occurrences (* Changed, ! Killed) |
|---|---|
| ^VPS(853 - [#853] | WRITE+32, WRITE+35, WRITE+40, GPARMIEN+9, GPARMIEN+10, STRFIL+12, ADDMULT+13 |
| Name | Line Occurrences |
|---|---|
| $$ADDMULT | UPDTRXN+22 |
| $$ADDTRXN | STRFIL+13 |
| $$CRPARAM | WRITE+35 |
| $$ERROR | CRPARAM+15, ADDTRXN+13, UPDTRXN+23, UPDTRXN+27 |
| $$GPARMIEN | UPDPARAM+21 |
| $$ISVALID | WRITE+27 |
| $$RESULT | WRITE+32, UPDPARAM+22, UPDPARAM+34, UPDPARAM+36, UPDPARAM+47, ISVALID+11, ISVALID+12, ISVALID+15, ISVALID+16, ISVALID+17 , ISVALID+19, UPDTRXN+28, ERROR+13, ERROR+14 |
| $$STRFIL | UPDPARAM+40, STRMULT+19 |
| $$UPDTRXN | STRFIL+17 |
| STRMULT | UPDPARAM+50 |
| TABLE | UPDPARAM+28 |
| UPDPARAM | WRITE+38 |
| >> | Not killed explicitly |
| * | Changed |
| ! | Killed |
| ~ | Newed |
| Name | Field # of Occurrence |
|---|---|
| ERR | CRPARAM+14~*, CRPARAM+15*, CRPARAM+16*, CRPARAM+17, STRFIL+13*, STRFIL+14, ADDTRXN+12~*, ADDTRXN+13*, ADDTRXN+14, UPDTRXN+21~ , UPDTRXN+22, UPDTRXN+23, UPDTRXN+27, ADDMULT~, ADDMULT+12! |
| ERRMSG | RESULT~, RESULT+9*, RESULT+10 |
| ERRNUM | ERROR+9~*, ERROR+10*, ERROR+11 |
| ERRTXT | ERROR+11~*, ERROR+12, ERROR+14 |
| EXIST | STRFIL+12~*, STRFIL+13, ADDMULT+13~*, ADDMULT+14, ERROR+12~*, ERROR+13, ERROR+14 |
| FDA | CRPARAM+8~, ADDTRXN+8~, UPDTRXN+25~, ADDMULT+16~ |
| FDA( | ADDTRXN+9*, UPDTRXN+25*, ADDMULT+16* |
| FDA(853 | CRPARAM+10*, CRPARAM+11* |
| FDAERR | ERROR~ |
| FDAERR("DIERR" | ERROR+10, ERROR+11 |
| FIL | UPDPARAM+42~*, UPDPARAM+46, STRMULT+10~*, STRMULT+11*, STRMULT+13, STRMULT+15, STRMULT+16, UPDTRXN+11~*, UPDTRXN+22, UPDTRXN+25 , ADDMULT~, ADDMULT+16 |
| FLD | UPDPARAM+43~*, CRPARAM+9~*, CRPARAM+11, UPDTRXN+12~*, UPDTRXN+25 |
| FLDDEF | UPDPARAM+28~, UPDPARAM+50, STRMULT~, TABLE~, TABLE+7! |
| FLDDEF( | UPDPARAM+36, UPDPARAM+37, UPDPARAM+39, UPDPARAM+40, UPDPARAM+42, UPDPARAM+43, STRMULT+19, TABLE+10* |
| FLDNAM | UPDPARAM+32~*, UPDPARAM+34, UPDPARAM+35, UPDPARAM+36, UPDPARAM+37, UPDPARAM+39, UPDPARAM+40, UPDPARAM+42, UPDPARAM+43, UPDPARAM+46 , UPDPARAM+47, STRMULT+12~*, STRMULT+13*, STRMULT+15, STRMULT+16, STRMULT+19, STRFIL~, STRFIL+17, UPDTRXN~, UPDTRXN+23 , UPDTRXN+27, UPDTRXN+28 |
| FLDNAME | ERROR~, ERROR+13, ERROR+14, RESULT~, RESULT+10 |
| FLDVAL | UPDPARAM+33~*, UPDPARAM+34, UPDPARAM+36, UPDPARAM+38~*, UPDPARAM+40, UPDPARAM+44, UPDPARAM+46, UPDPARAM+47, STRMULT+18~*, STRMULT+19 , STRFIL~, STRFIL+17, UPDTRXN~, UPDTRXN+15, UPDTRXN+23, UPDTRXN+25, UPDTRXN+27, UPDTRXN+28, ERROR~, ERROR+13 , ERROR+14, RESULT~, RESULT+10 |
| IENS | CRPARAM+8~, ADDTRXN+7~, ADDMULT+15~ |
| IENS(1 | ADDTRXN+7*, ADDMULT+15* |
| ISMULT | UPDPARAM+39~*, UPDPARAM+40, UPDPARAM+41 |
| LINE | TABLE+8~, TABLE+9* |
| LN | TABLE+8~, TABLE+9* |
| MULT | UPDPARAM+26~, UPDPARAM+50, STRMULT~, UPDTRXN+17~*, UPDTRXN+22, UPDTRXN+25 |
| MULT( | UPDPARAM+46*, STRMULT+11, STRMULT+13, STRMULT+15, STRMULT+16 |
| PARAM | WRITE~, WRITE+27, WRITE+38, UPDPARAM~, ISVALID~, ISVALID+19 |
| PARAM( | UPDPARAM+31, UPDPARAM+32, UPDPARAM+33, UPDPARAM+38 |
| PARAMIEN | UPDPARAM+21~*, UPDPARAM+22, UPDPARAM+40, UPDPARAM+50, STRMULT~, STRMULT+19, GPARMIEN+8~*, GPARMIEN+9*, GPARMIEN+10*, GPARMIEN+11 , STRFIL~, STRFIL+12, STRFIL+13, STRFIL+17, ADDTRXN~, ADDTRXN+9, UPDTRXN~, UPDTRXN+18, UPDTRXN+22, ADDMULT~ , ADDMULT+13, ADDMULT+16, ADDMULT+18 |
| PARAMNAM | WRITE~, WRITE+27, WRITE+32, WRITE+35, WRITE+38, WRITE+40, UPDPARAM~, UPDPARAM+21, UPDPARAM+22, ISVALID~ , ISVALID+9, ISVALID+14*, ISVALID+15, ISVALID+16, ISVALID+17, CRPARAM~, CRPARAM+11, CRPARAM+15, GPARMIEN~, GPARMIEN+9 , GPARMIEN+10 |
| PARAMTYP | WRITE~, WRITE+27, WRITE+31, WRITE+32, WRITE+35, WRITE+38, UPDPARAM~, UPDPARAM+21, UPDPARAM+22, ISVALID~ , ISVALID+9, ISVALID+10*, ISVALID+11, ISVALID+12, ISVALID+17, CRPARAM~, CRPARAM+9, CRPARAM+10, CRPARAM+15, GPARMIEN~ , GPARMIEN+9, GPARMIEN+10 |
| PARAMVAL | ISVALID+9~*, ISVALID+11, ISVALID+12, ISVALID+15, ISVALID+16, ISVALID+17, ISVALID+19 |
| REC | STRMULT+16~*, STRMULT+17, STRMULT+18 |
| RESULT | WRITE~, WRITE+26!, WRITE+38, UPDPARAM~, UPDPARAM+25!, UPDPARAM+50, STRMULT~, STRFIL+17~*, STRFIL+18, ERROR+8~ , ERROR+13*, ERROR+14*, ERROR+15 |
| RESULT( | UPDPARAM+34*, UPDPARAM+36*, UPDPARAM+40*, UPDPARAM+47*, STRMULT+19* |
| RESULT(0 | WRITE+27*, WRITE+28, WRITE+32*, WRITE+35*, WRITE+38, UPDPARAM+22* |
| RSNSUB | UPDTRXN+14~*, UPDTRXN+17, UPDTRXN+22, ADDMULT~, ADDMULT+13 |
| RSNTYP | UPDPARAM+26~, UPDPARAM+44~*, UPDPARAM+45, UPDPARAM+46, STRMULT+14~*, STRMULT+15*, STRMULT+16, UPDTRXN+15~*, UPDTRXN+22, ADDMULT~ , ADDMULT+13, ADDMULT+15, ADDMULT+16, ADDMULT+18 |
| STATCODE | RESULT~, RESULT+10 |
| STRING | TABLE+8~, TABLE+9*, TABLE+10 |
| SUB | UPDPARAM+29~*, UPDPARAM+31*, UPDPARAM+32, UPDPARAM+33, UPDPARAM+34, UPDPARAM+36, UPDPARAM+38, UPDPARAM+40, UPDPARAM+46, UPDPARAM+47 , STRMULT+17~*, STRMULT+19 |
| SUBS | UPDTRXN+18~*, UPDTRXN+22*, UPDTRXN+25 |
| TRNDT | UPDPARAM+27~*, UPDPARAM+40, UPDPARAM+50, STRMULT~, STRMULT+19, STRFIL~, STRFIL+12, STRFIL+13, STRFIL+17, ADDTRXN~ , ADDTRXN+7, ADDTRXN+9, ADDTRXN+13, UPDTRXN~, UPDTRXN+18, UPDTRXN+22, ADDMULT~, ADDMULT+13, ADDMULT+16, ADDMULT+18 |
| TYP | UPDTRXN+13~*, UPDTRXN+16*, UPDTRXN+26 |
| U | UPDPARAM+32, UPDPARAM+33, UPDPARAM+38, UPDPARAM+39, UPDPARAM+42, UPDPARAM+43, UPDPARAM+46, STRMULT+17, STRMULT+18, CRPARAM+16 , UPDTRXN+11, UPDTRXN+12, UPDTRXN+13, UPDTRXN+14, RESULT+9, RESULT+10, TABLE+10 |
| UPDERR | CRPARAM+8~, CRPARAM+15, ADDTRXN+8~, ADDTRXN+13 |
| UPDFLD | STRFIL~, STRFIL+17, UPDTRXN~, UPDTRXN+11, UPDTRXN+12, UPDTRXN+13, UPDTRXN+14 |
| VALID | UPDPARAM+45~*, UPDPARAM+46, UPDPARAM+47 |
| XREF | WRITE+31~*, WRITE+32, WRITE+35, WRITE+40 |
| Name | Field # of Occurrence |
|---|---|
| $T(PARMFLDS+LN | TABLE+9 |
