STANDARD DATA DICTIONARY #2100.1 -- GENERIC CODE SHEET STACK FILE 3/24/25 PAGE 1
STORED IN ^GECS(2100.1, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 2.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file stores the FMS documents for the batch type FINANCIAL MANAGEMENT.
This file is used to manage the transmission of the FMS code sheets between DHCP and FMS. When FMS code sheets are created
manually or automatically, the code sheets are queued for transmission or transmitted immediately from this file.
This file is used internally by the Generic Code Sheet System and should not be edit through VA FileMan.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
CROSS
REFERENCED BY: TRANSMITTED MAIL MESSAGES(AM1), OLD TRANSMITTED MAIL MESSAGES(AM2), STATUS(AS), DOCUMENT IDENTIFIER(B),
DOCUMENT IDENTIFIER(BID), DOCUMENT LOOKUP KEY(KEY)
2100.1,.01 DOCUMENT IDENTIFIER 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: JUN 27, 1994
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: This field is used to store the FMS document identifier. The form of the document identifier is
tt-sta123456 -sta789 where:
tt - is the 2 alpha transaction type (ex: IV);
sta - is the three digit station number (ex: 460);
123456 - is the FMS obligation/reference number (ex: I40001);
789 - is the FMS batch number (ex: 001).
CROSS-REFERENCE: 2100.1^B
1)= S ^GECS(2100.1,"B",$E(X,1,30),DA)=""
2)= K ^GECS(2100.1,"B",$E(X,1,30),DA)
This is a standard VA FileMan "B" cross reference.
CROSS-REFERENCE: 2100.1^BID^MUMPS
1)= N % S %=$E($P(X,"-",2),4,9) I $L(%) S ^GECS(2100.1,"BID",%,DA)=""
2)= N % S %=$E($P(X,"-",2),4,9) I $L(%) K ^GECS(2100.1,"BID",%,DA)
This cross-reference is used to lookup the stack entry by the IFCAP obligation number.
2100.1,1 SYSTEM 0;2 SET
'F' FOR FMS;
LAST EDITED: NOV 24, 1993
DESCRIPTION: This field is used to store the system which created the code sheet. Currently the only system
which interfaces to the stack file is the FMS code sheets.
2100.1,2 DATE@TIME CREATED 0;3 DATE
INPUT TRANSFORM: S %DT="ESTR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: NOV 24, 1993
DESCRIPTION: This field is used to store the date and time the code sheet was entered into the stack file for
transmission.
2100.1,3 STATUS 0;4 SET
'Q' FOR QUEUED FOR TRANSMISSION;
'M' FOR MARKED FOR IMMEDIATE TRANSMISSION BY EVENT;
'T' FOR TRANSMITTED;
'E' FOR ERROR DURING TRANSMISSION;
'A' FOR ACCEPTED BY FMS;
'R' FOR REJECTED BY FMS;
'F' FOR FINAL - NO FURTHER ACTIVITY ALLOWED;
LAST EDITED: SEP 28, 1998
DESCRIPTION: This is the status of the stack file entry. Status's range from:
Q: queued for transmission
M: marked for immediate transmission
T: transmitted to Austin
E: error in transmission
A: accepted by FMS
R: rejected by FMS
F: final - no further activity allowed
WRITE AUTHORITY: @
CROSS-REFERENCE: 2100.1^AS
1)= S ^GECS(2100.1,"AS",$E(X,1,30),DA)=""
2)= K ^GECS(2100.1,"AS",$E(X,1,30),DA)
This cross-reference is used to lookup the status of code sheets in the stack file.
2100.1,4 DESCRIPTION OF EVENT 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>79!($L(X)<1) X
LAST EDITED: DEC 08, 1993
HELP-PROMPT: Answer must be 1-79 characters in length.
DESCRIPTION: This field is used to store the description of the event which caused the code sheet to be created.
The description is for informational purposes and will appear on the Stack Status Report.
2100.1,4.1 USER COMMENTS 1;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>69!($L(X)<1) X
LAST EDITED: SEP 27, 1994
HELP-PROMPT: Answer must be 1-69 characters in length.
DESCRIPTION: This field is used to store free text comments which can be entered by the user and will appear on
the Stack Status Report.
2100.1,5 SEGMENT (ENTRY IN FILE 2101.2) 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<2) X
LAST EDITED: DEC 09, 1993
HELP-PROMPT: Answer must be 2-6 characters in length.
DESCRIPTION: This field is used to store the free text segment entry from file 2101.2 which was used to create
the code sheet.
2100.1,6 ERRORS 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>79!($L(X)<1) X
LAST EDITED: DEC 09, 1993
HELP-PROMPT: Answer must be 1-79 characters in length.
DESCRIPTION: This field is used to store any errors which occurred during the transmission of the code sheet.
If an error occurs the stack status will be set to 'E'rror and the ERRORS field will store the
description of the error. The user can use the Stack Status Report to display code sheets which
resulted in errors during transmission. Examples of errors would be no code sheets to transmit,
unable to create a mailman message, etc.
2100.1,7 MANUAL OR AUTOMATIC 0;6 SET
'M' FOR MANUAL;
'A' FOR AUTOMATIC;
LAST EDITED: JUN 28, 1994
DESCRIPTION: This field is used to indicate if the stack file code sheet was manually created or automatically
created. For the accept/reject processing, only code sheets which have been automatically created
and rejected should be regenerated and retransmitted by the event code.
2100.1,8 DOCUMENT LOOKUP KEY 0;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: JAN 29, 2001
HELP-PROMPT: Enter the optional document lookup key that can be used to find a document. Answer must be 1-15
characters in length.
DESCRIPTION: This field stores an option document lookup key that can be used to find a specific document in
generic code sheets. For example, if a package sends a monthly code sheet, it could enter the key
as SV-3001200 for SV documents sent for the month 12/2000.
CROSS-REFERENCE: 2100.1^KEY
1)= S ^GECS(2100.1,"KEY",$E(X,1,30),DA)=""
2)= K ^GECS(2100.1,"KEY",$E(X,1,30),DA)
This cross reference allows packages to lookup documents by a specified key.
2100.1,10 CODE SHEET 10;0 WORD-PROCESSING #2100.11
DESCRIPTION:
This field is used to store the actual code sheet which will be transmitted.
LAST EDITED: DEC 08, 1993
DESCRIPTION:
This field is used to store the actual code sheet which will be transmitted.
2100.1,11 SIZE OF CODE SHEET 11;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAY 03, 1994
HELP-PROMPT: Enter the size of the code sheet from 0 to 9999999.
DESCRIPTION: This field is used to store the size of the code sheet. The field is used internally by the
Generic Code Sheet Package during transmission. When the code sheets are transmitted from the
stack file, the code sheets are grouped into mail messages depending on the size of the code sheet.
2100.1,11.2 CHECKSUM 11;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JUN 27, 1995
HELP-PROMPT: Type a Number between 0 and 999999999, 0 Decimal Digits
DESCRIPTION:
This field is used to store the checksum of the automatically created code sheet.
UNEDITABLE
2100.1,11.3 HOLD DATE 11;3 DATE
INPUT TRANSFORM: S %DT="E" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUN 27, 1995
DESCRIPTION:
This field stores the date the code sheet will be transmitted on.
UNEDITABLE
2100.1,20 TRANSMITTED MAIL MESSAGES 20;0 Multiple #2100.12
DESCRIPTION: This field is used to store the mail message number which was used for the transmission of the code
sheet. This field is multiple for large code sheets (greater then 30K) which require more than one
mail message for transmission.
2100.12,.01 TRANSMITTED MAIL MESSAGES 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999999999999)!(X<1)!(X?.E1"."1N.N) X I $D(X) S DINUM=X
LAST EDITED: DEC 22, 1993
HELP-PROMPT: Type a Number between 1 and 999999999999, 0 Decimal Digits
DESCRIPTION: This field is used to store the mail message number which was used for the transmission of the
code sheet. This field is multiple for large code sheets (greater than 30K) which require more
than one mail message for transmission.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 2100.1^AM1^MUMPS
1)= S ^GECS(2100.1,"AM",X,DA(1))=""
2)= K ^GECS(2100.1,"AM",X,DA(1))
This cross reference allows the mailman message number to be easily looked up for processing
confirmation messages.
2100.12,1 CONFIRMATION NUMBER 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: DEC 22, 1993
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: This field is used to store the confirmation number returned by the destination system to
acknowledge the receipt of the mail message.
2100.1,21 OLD TRANSMITTED MAIL MESSAGES 21;0 Multiple #2100.121
DESCRIPTION: This field is used to store the old mail messages which were used to transmit the stack file entry.
When the stack entry is retransmitted, this field is used to keep a history of previous mail
messages used for transmission.
2100.121,.01 OLD TRANSMITTED MAIL MESSAGES 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999999999999)!(X<0)!(X?.E1"."1N.N) X I $D(X) S DINUM=X
LAST EDITED: DEC 22, 1993
HELP-PROMPT: Type a Number between 0 and 999999999999, 0 Decimal Digits
DESCRIPTION: This field is used to store the old mail messages which were used to transmit the stack file
entry. When the stack entry is retransmitted, this field is used to keep a history of previous
mail messages used for transmission.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 2100.1^AM2^MUMPS
1)= S ^GECS(2100.1,"AM",X,DA(1))=""
2)= K ^GECS(2100.1,"AM",X,DA(1))
This cross reference allows the mailman message number to be easily looked up for processing
confirmation messages.
2100.121,1 CONFRIMATION NUMBER 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: DEC 22, 1993
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: This field is used to store the confirmation number returned by the destination system to
acknowledge the receipt of the mail message.
2100.1,25 EVENT ACCEPT/REJECT CODE 25;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: JUN 28, 1994
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This field stores the mumps code which is executed when processing accept or reject messages. This
field is not editable through VA FileMan. It is set in the routine GECSSDCT.
WRITE AUTHORITY: @
UNEDITABLE
2100.1,26 SPECIAL PARAMETERS 26;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<1) X
LAST EDITED: JUN 15, 1994
HELP-PROMPT: Answer must be 1-200 characters in length.
DESCRIPTION:
This field is used to store any special parameters required to rebuild the code sheet.
UNEDITABLE
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):