Home Package List Routine Alphabetical List Global Alphabetical List FileMan Files List FileMan Sub-Files List Package Component Lists Package-Namespace Mapping

Info | Desc | Directly Accessed By Routines | Pointer To FileMan Files | Fields | Found Entries | External References | Global Variables Directly Accessed | Naked Globals | All

Print Page as PDF

Global: ^XLM(8993

Package: Kernel

Global: ^XLM(8993

Information

FileMan FileNo	FileMan Filename	Package
8993	XULM LOCK DICTIONARY	Kernel

Description

This file contains descriptions and specifications for locks held by various applications. The Lock Manager uses it to provide information and guidance to the user about locks found in the lock table.

Directly Accessed By Routines, Total: 11

Package	Total	Routines
Kernel	11	ARRAY SUBSCRIPTS COMPUTABLE FILE REFERENCES XPDANLYZ3 XPDIA3 XU8P608 XULM1 XULMLD XULMOUT XULMU XULMUI1 ^XLM(8993

Pointer To FileMan Files, Total: 2

Package	Total	FileMan Files
Kernel	1	PACKAGE(#9.4)[1.01]
VA FileMan	1	FILE(#1)[#8993.03(.01)]

Fields, Total: 7

Field #	Name	Loc	Type	Details
.01	LOCK TEMPLATE	0;E1,245	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:'$$SNTXLOCK^XULM1(.X) X I $E($G(X),1,2)["^" S X=$P(X,"^",2,999)` OUTPUT TRANSFORM: `S:$G(DA) Y=$S($P($G(^XLM(8993,DA,1)),"^",2):"^",1:"")_Y` LAST EDITED: `AUG 29, 2012` HELP-PROMPT: `Answer must be 1-245 characters in length with valid syntax. For global locks, enter one space before the '^'.` DESCRIPTION: `Enter the locked data structure as set in the LOCK command, except:` `1) If the lock is on a global data structure, enter a space before` `the '^'.` `2) If an array subscript is a variable, enter a legal variable name.` `In examples 2-4, note that a space is necessary before the '^' of the global reference.` `Example 1:` `If the lock is on the local variable 'DPT', enter 'DPT'.` `Example 2:` `If the lock is on the entire ^DPT global, enter ' ^DPT'.` `Example 3:` `If the lock is on the 0 node of a record in the patient file then the` `record number must be represented by a variable. Select a variable,` `lets say DFN. So if the lock is on '^DPT(,0)',` `the lock template may be entered as ' ^DPT(DFN,0)'.` `Example 4:` `The same as example 3, except that the ""POV"" node is locked. Enter` `the lock template as ' ^DPT(DFN,"POV")'.` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER` CROSS-REFERENCE: `8993^B` `1)= S ^XLM(8993,"B",$E(X,1,30),DA)=""` `2)= K ^XLM(8993,"B",$E(X,1,30),DA)` FIELD INDEX: `C (#1553) REGULAR IR LOOKUP & SORTING` `Unique for: Key A (#138), File #8993` `Short Descr: Uniqueness Index for Key 'A' of File #8993` `Set Logic: S ^XLM(8993,"C",X,DA)=""` `Kill Logic: K ^XLM(8993,"C",X,DA)` `Whole Kill: K ^XLM(8993,"C")` `X(1): LOCK TEMPLATE (8993,.01) (Subscr 1)` RECORD INDEXES: `AC (#1548), E (#1554)`
1.01	PACKAGE	1;1	POINTER TO PACKAGE FILE (#9.4)	PACKAGE(#9.4) LAST EDITED: `JUL 18, 2012` HELP-PROMPT: `Select the package that owns this entry in the lock dictionary.` DESCRIPTION: `This is the package for which the lock is set. Locks usually are used to control access to a package's data.`
1.02	GLOBAL LOCK?	1;2	SET	**********************REQUIRED FIELD********************** '0' FOR NO; '1' FOR YES; LAST EDITED: `AUG 29, 2012` HELP-PROMPT: `Is this lock on a global?` DESCRIPTION: `Both local and global variables maybe locked. This field explicitly identifies which type of variable the lock applies to. Global variables start with '^'.` RECORD INDEXES: `AC (#1548), E (#1554)`
1.03	PARTIAL MATCH ALLOWED?	1;3	SET	'0' FOR NO; '1' FOR YES; LAST EDITED: `AUG 29, 2012` HELP-PROMPT: `Should a lock that has additional subscripts be counted as a match to this template?` DESCRIPTION: `If this field is set to YES, then a lock that has additional subscripts will be considered a match to this template as long as the first parts match. A partial match will be allowed only if no full match exists.` `For example, for the input template ^DPT(DFN), the lock on ^DPT(,0) will be considered a match if this field is set to YES.`
2	ARRAY SUBSCRIPTS	2;0	Multiple #8993.02	8993.02 LAST EDITED: `MAY 09, 2012` DESCRIPTION: `This multiple has an entry for each subscript in the locked data structure.` `For example, a lock on ^DPT(,0) has two subscripts so should have two entries in this multiple.` TECHNICAL DESCR: IDENTIFIED BY: `SUBSCRIPT(#.02)[R]`
3	COMPUTABLE FILE REFERENCES	3;0	POINTER Multiple #8993.03	8993.03 DESCRIPTION: `This multiple provides information about the VistA files referenced by the locked data structure.` PRIMARY KEY: `A (#139)` `Uniqueness Index: C (#1555)` `File, Field: 1) FILE (8993.03,.01)` INDEXED BY: `FILE (C)`
4	USAGE	4;0	WORD-PROCESSING #8993.04	DESCRIPTION: `This field should describe how the lock is used and what its purpose is.` `What is the purpose of this lock?` LAST EDITED: `JUL 13, 2012` HELP-PROMPT: `Enter a brief description of what file the lock is on, it is used and its purpose. Limit each line to 75 characters.`

External References

Name	Field # of Occurrence
$$SNTXLOCK^XULM1	.01+1

Global Variables Directly Accessed

Name	Line Occurrences (* Changed, ! Killed)
^XLM(8993 - [#8993]	IXACSL+1, IXACKL+1!, IXACKEIC+1!, IXCSL+1, IXCKL+1!, IXCKEIC+1!, IXESL+1*, IXEKL+1!, IXEKEIC+1!, .01OT+1 , .01(XREF 1S), .01(XREF 1K)

Naked Globals

Name	Field # of Occurrence
^(0	IDWRITE+1
^(1	IDWRITE+1

Info | Desc | Directly Accessed By Routines | Pointer To FileMan Files | Fields | Found Entries | External References | Global Variables Directly Accessed | Naked Globals | All