STANDARD DATA DICTIONARY #19.1 -- SECURITY KEY FILE 3/24/25 PAGE 1
STORED IN ^DIC(19.1, (603 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file holds the names of security keys that are used to lock options. To lock an option, the name of the key is entered in the
Lock field of the Option File. To permit a user to unlock the option, the user's name is entered in the Holder field of this file.
It is cross-referenced by name and holder.
DD ACCESS: #
RD ACCESS: #
WR ACCESS: #
DEL ACCESS: #
LAYGO ACCESS: #
APPLICATION GROUP(S): XU, XQ
POINTED TO BY: SUBORDINATE KEY field (#.01) of the SUBORDINATE KEY sub-field (#19.13) of the SECURITY KEY File (#19.1)
MUTUALLY EXCLUSIVE KEYS field (#.01) of the MUTUALLY EXCLUSIVE KEYS sub-field (#19.15) of the SECURITY KEY File
(#19.1)
USER ACCESS AUTHORIZATION field (#.9) of the ACCESSION File (#68)
USER ACCESS AUTHORIZATION field (#51) of the LOAD/WORK LIST File (#68.2)
USER KEY NEEDED field (#4) of the EXAMINATION STATUS File (#72)
SECURITY KEY field (#.01) of the SECURITY KEY sub-field (#100.985) of the DISPLAY GROUP File (#100.98)
ACCESS field (#.01) of the ACCESS sub-field (#101.03) of the PROTOCOL File (#101)
KEY field (#.01) of the KEYS sub-field (#200.051) of the NEW PERSON File (#200)
DELEGATED KEY field (#.01) of the DELEGATED KEYS sub-field (#200.052) of the NEW PERSON File (#200)
KEY field (#6) of the RECALL REMINDERS PROVIDERS File (#403.54)
A PRIVILEGE field (#8) of the MH TESTS AND SURVEYS File (#601.71)
SECURITY KEY field (#.01) of the SECURITY KEY sub-field (#991.112) of the CIRN HL7 EXCEPTION TYPE File (#991.11)
SECURITY KEYS field (#.01) of the SECURITY KEYS sub-field (#2006.1665) of the BP MAIL MESSAGE sub-field (#2006.166)
of the IMAGING SITE PARAMETERS File (#2006.1)
CROSS
REFERENCED BY: NAME(AC), NAME(B), DESCRIPTIVE NAME(E)
19.1,.01 NAME 0;1 FREE TEXT (Required)
This is the name of the key, beginning with the package prefix
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) D CHKNAME^XQ5 K:$L(X)>27!($L(X)<3)!'(X'?1P.E)!(X'?.ANP) X
LAST EDITED: JAN 22, 1992
HELP-PROMPT: Enter the name of the key, prefixed with the package code
DESCRIPTION: Each entry in this File is the name of a key that defines some characteristic or capability for
individual specified users. The capability might be access to some OPTION (file 19) which is
permited with the authorization. Other functionalities (such as allowing scheduling overbook)
might also be allowed only if the key is held.
Keys are named with the standard package prefix formats; a 2-4 character package prefix for
standard names or Z.
DELETE TEST: 200,0)= I $D(^VA(200,"AB",DA)) W " Can't delete"
UNEDITABLE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 19.1^B
1)= S ^DIC(19.1,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19.1,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 19.1^AC^MUMPS
1)= Q
2)= K ^XUSEC(X),^VA(200,"AK."_X)
3)= Cleanup
This X-ref will clean-up the XUSEC global if a key is removed by an app calling DIK directly. If
the UNEDITABLE flag was removed and the KEY name changed it would clean-up the old name from XUSEC
BUT would not set in the new name. to do that the MUMPS X-ref on the KEY sub-file of the NEW
PERSON file. will need to be re-indexed.
19.1,.02 DESCRIPTIVE NAME 0;2 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>30!($L(X)<2) X
LAST EDITED: SEP 29, 1989
HELP-PROMPT: Answer must be 2-30 characters in length.
DESCRIPTION:
This is a more descriptive name for the KEY than allowed in the namespaced name field.
CROSS-REFERENCE: 19.1^E^MUMPS
1)= S %X=X X "F %=1:1:$L(%X) I $E(%X,%)?1L S %X=$E(%X,1,%-1)_$C($A(%X,%)-32)_$E(%X,%+1,99)" S ^DIC(
19.1,"E",%X,DA)=""
2)= S %X=X X "F %=1:1:$L(%X) I $E(%X,%)?1L S %X=$E(%X,1,%-1)_$C($A(%X,%)-32)_$E(%X,%+1,99)" K ^DIC(
19.1,"E",%X,DA)
3)= This is a uppercase only X-ref of the field.
This is a normal X-ref that has the special code to see that the X-ref is in all uppercase for easy
lookup.
19.1,.03 PERSON LOOKUP 0;3 SET
'l' FOR LOOKUP;
LAST EDITED: SEP 27, 1989
HELP-PROMPT: Should a X-ref of holders of this key be made for person lookup.
DESCRIPTION: This field when set to 'lookup' will build a X-ref on the NEW PERSON file of all holders of the
key. This will be under a X-ref of 'AK.'_ so that a package can lookup members of a
group.
There is a standard SECURITY KEY that will be sent out of 'PROVIDER' with the lookup flag set. Then
a package can do a lookup of PROVIDER's with the following code: S
DIC="^VA(200,",D="AK.PROVIDER",DIC(0)="AEQ" D IX^DIC
19.1,.04 KEEP AT TERMINATE 0;4 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: SEP 24, 1991
HELP-PROMPT: Does the user need to keep this key when terminated.
DESCRIPTION: If this field is set to YES (1) then this key will not be removed from a user in the New Person
file when they are terminated.
One example is the 'PROVIDER' key.
19.1,.05 SEND TO J2EE 0;5 SET
'0' FOR No;
'1' FOR Yes;
LAST EDITED: FEB 22, 2005
DESCRIPTION: This field controls if this is a Security Key that should be sent to the J2EE application server
for temporary role assignment.
If this field is set to 'Yes' then this Security Key can be sent to the application server.
19.1,1 DESCRIPTION 1;0 WORD-PROCESSING #19.11
DESCRIPTION: This is a short description of the security key, indicating what the key locks out, and what class
of users should be assigned the key.
This is a description of the privileges accorded holders of this key
HELP-PROMPT: Enter a description of what privileges the key gives
19.1,3 SUBORDINATE KEY 3;0 POINTER Multiple #19.13
DESCRIPTION: Subordinate authorization are "given" when the "master" authorization is given. This allows easier
and more efficient delegation of authorizations.
19.13,.01 SUBORDINATE KEY 0;1 POINTER TO SECURITY KEY FILE (#19.1) (Multiply asked)
INPUT TRANSFORM:S DIC("S")="I $D(^XUSEC(""XUMGR"",DUZ))!$S($D(^VA(200,DUZ,52,+Y,0)):$P(^(0),U,4),1:0)" D ^DIC K DIC
S DIC=DIE,X=+Y K:Y<0 X
LAST EDITED: SEP 30, 1992
HELP-PROMPT: A cluster of keys to allow easier key assignment.
DESCRIPTION: Subordinate authorization is "given" at the same time the "master" authorization is "given". This
permits more efficient and easier delegation of authority.
SCREEN: S DIC("S")="I $D(^XUSEC(""XUMGR"",DUZ))!$S($D(^VA(200,DUZ,52,+Y,0)):$P(^(0),U,4),1:0)"
EXPLANATION: The person clustering authorizations must have the authority not only to delegate but also the auth
ority to give others the authority to delegate.
CROSS-REFERENCE:19.13^B
1)= S ^DIC(19.1,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19.1,DA(1),3,"B",$E(X,1,30),DA)
19.1,4 GRANTING CONDITION 4;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: SEP 27, 1989
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION:
This is MUMPS code that set $T true if its OK for the person to be granted this key.
WRITE AUTHORITY: @
19.1,5 MUTUALLY EXCLUSIVE KEYS 5;0 POINTER Multiple #19.15
19.15,.01 MUTUALLY EXCLUSIVE KEYS 0;1 POINTER TO SECURITY KEY FILE (#19.1) (Multiply asked)
LAST EDITED: MAY 20, 1994
HELP-PROMPT: Enter the name of a key that may not be held jointly with this one.
CROSS-REFERENCE: 19.15^B
1)= S ^DIC(19.1,DA(1),5,"B",$E(X,1,30),DA)=""
2)= K ^DIC(19.1,DA(1),5,"B",$E(X,1,30),DA)
FILES POINTED TO FIELDS
SECURITY KEY (#19.1) SUBORDINATE KEY:SUBORDINATE KEY (#.01)
MUTUALLY EXCLUSIVE KEYS:MUTUALLY EXCLUSIVE KEYS (#.01)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):