STANDARD DATA DICTIONARY #727.1 -- EXTRACT DEFINITIONS FILE 3/24/25 PAGE 1
STORED IN ^ECX(727.1, (24 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file provides a mechanism for sites to tailor the running of package extracts by defining the frequency (daily, weekly, or
monthly) with which the extracts will run and the number of days in the past for which data will be extracted. The EXTRACT NAME
field (#.01) and the FILE NUMBER field (#1) are national standard entries, exported with the file, and should not be edited
locally.
CROSS
REFERENCED BY: TYPE(AC), FILE NUMBER(AF), EXTRACT NAME(B), HEADER CODE(C)
727.1,.01 EXTRACT NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: APR 21, 1995
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
The name of the extract.
UNEDITABLE
CROSS-REFERENCE: 727.1^B
1)= S ^ECX(727.1,"B",$E(X,1,30),DA)=""
2)= K ^ECX(727.1,"B",$E(X,1,30),DA)
727.1,1 FILE NUMBER 0;2 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>728)!(X<727)!(X?.E1"."4N.N) X
LAST EDITED: APR 28, 1994
HELP-PROMPT: Type a Number between 727 and 728, 3 Decimal Digits
DESCRIPTION:
The number of the file into which this extract places data.
TECHNICAL DESCR: The AF cross reference on this file is used by the extract routines, using the variable ECFILE, to
determine the frequency with which the extract is run and, from the frequency, the starting and
ending days for the extract.
UNEDITABLE
CROSS-REFERENCE: 727.1^AF
1)= S ^ECX(727.1,"AF",$E(X,1,30),DA)=""
2)= K ^ECX(727.1,"AF",$E(X,1,30),DA)
3)= DO NOT DELETE
This cross reference is essential for determing the frequency and date range for package extracts.
Do not delete.
727.1,2 FREQUENCY 0;3 SET
'D' FOR DAILY;
'W' FOR WEEKLY;
'M' FOR MONTHLY;
LAST EDITED: FEB 25, 1994
DESCRIPTION: This field determines the frequency with which this extract will be run. Daily extracts are run
for a single day, T-X, where X is the number entered in the DAYS AGO field in this file. Weekly
extracts are run for the week ending on T-X. Monthly extracts are run for the previous month.
TECHNICAL DESCR: This field is used by the extract routines to determine the starting and ending dates for the
extract.
727.1,3 DAYS AGO 0;4 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>30)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JAN 29, 1993
HELP-PROMPT: Type a Number between 1 and 30, 0 Decimal Digits
DESCRIPTION: This field is used for daily and weekly extracts to determine how many days ago the extract should
look for data. For daily extracts, the date would be T-X, for weekly extracts, the date range
would be from T-X-7 to T-X.
TECHNICAL DESCR: Used by the extract routines to determine the date for a daily extract or the date range for a
weekly extract.
727.1,4 ROUTINE ROU;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1)!'(X?1"ECX".UN) X
LAST EDITED: MAR 24, 1994
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION: The name of the routine which performs this extract. Data is loaded into this field at creation
time as should not be edited in the field
TECHNICAL DESCR: Data in this field is used to queue the initial extract. Once the extract manager specifies the
frequency, days offset, start date (which is not a data element in this file), the extract setup
calls %ZTLOAD to queue QUE^routine at the proper time.
UNEDITABLE
727.1,5 OFFSET 0;5 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>60)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: AUG 27, 1993
HELP-PROMPT: The offset, in days, for the daily local extract
DESCRIPTION:
This field is used by the local daily extract to determine how many days back to look for data
727.1,6 QUEUED 0;6 SET
'1' FOR YES;
LAST EDITED: MAR 24, 1994
DESCRIPTION: This field is set by the software when the extract is queued to run. Once this field is set, other
data elements should be changed only with extreme care. Changing either the frequency or the days
ago field could result in a date range being missed and not extracted for trasmission to TSI.
UNEDITABLE
727.1,7 TYPE 0;7 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUL 06, 1998
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: This is the print name for the extract. It has an important use in supplying a data element to the
TYPE field (#2) of the DSS EXTRACT LOG file (#727).
TECHNICAL DESCR: A free text field; only 1st character is capitalized. Used as print name for the extract.
This data element is also hard-coded into the SETUP code unit of each extract routine using
variable ECPACK.
CROSS-REFERENCE: 727.1^AC
1)= S ^ECX(727.1,"AC",$E(X,1,30),DA)=""
2)= K ^ECX(727.1,"AC",$E(X,1,30),DA)
727.1,8 HEADER CODE 0;8 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: SEP 25, 1997
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION: The unique 3-letter identifier code for the extract type. Needed for the header record in each
extract transmission.
TECHNICAL DESCR: A 3-character identifying code; each character is an uppercase alpha.
This data element is also hard-coded into the SETUP code unit of each extract routine using
variable ECHEAD.
CROSS-REFERENCE: 727.1^C
1)= S ^ECX(727.1,"C",$E(X,1,30),DA)=""
2)= K ^ECX(727.1,"C",$E(X,1,30),DA)
3)= Do not delete this cross-reference.
This cross-reference will be used by all the extract audit report routines to obtain defining
information on the extract.
727.1,9 GROUP 0;9 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>5!($L(X)<2) X
LAST EDITED: SEP 25, 1997
HELP-PROMPT: Answer must be 2-5 characters in length.
DESCRIPTION:
This code identifies the data group to which the extract belongs.
TECHNICAL DESCR: A 2-5 character identifying code; each character is an uppercase alpha.
This data element is also hard-coded into the SETUP code unit of each extract routine using
variable ECGRP.
727.1,10 AUDIT DESCRIPTION 1;0 WORD-PROCESSING #727.11 (NOWRAP)
LAST EDITED: OCT 30, 1997
DESCRIPTION: The information contained here provides user instructions on the recommended method for verifying
the extract audit report.
727.1,11 RUNNING PIECE 0;10 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JUL 06, 1998
HELP-PROMPT: Type a Number between 1 and 99, 0 Decimal Digits
DESCRIPTION: This numeric provides the position of the data element which indicates whether an extract of this
type is currently running or is queued to run.
TECHNICAL DESCR: The piece of the ^ECX(728,1,7.1) node indicated in this field will contain an "R", if the extract
is currently running or queued to run.
727.1,12 MAX. LINES PER MESSAGE 0;11 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>500)!(X<2)!(X?.E1"."1N.N) X
LAST EDITED: MAR 27, 1999
HELP-PROMPT: Type a Number between 2 and 500, 0 Decimal Digits
DESCRIPTION: This number is the maximum number of lines per transmission message allowed for this extract type.
A default value of 200 is usually acceptable for most extracts. However, for some (e.g., CLI, ADM)
lower values are recommended.
It may be possible in some cases to set a value greater than 200, thus reducing the total number of
transmission messages needed for the extract. However, if the transmission message becomes larger
than 32 Kbytes, it will be rejected by AAC.
727.1,13 INACTIVE 0;12 SET
'1' FOR YES;
'0' FOR NO;
LAST EDITED: JUL 10, 2003
HELP-PROMPT: Enter YES if this extract is inactive
DESCRIPTION:
Denotes whether or not this extract is considered inactive.
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):