Print Page as PDF
MTLU LOOKUPS/FILE MANAGEMENT ICR (10153)

MTLU LOOKUPS/FILE MANAGEMENT    ICR (10153)

Name Value
NUMBER 10153
IA # 10153
DATE CREATED 1995/01/11
CUSTODIAL PACKAGE TOOLKIT
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XTLKMGR
NAME MTLU LOOKUPS/FILE MANAGEMENT
GENERAL DESCRIPTION
Procedure calls for MTLU.
STATUS Active
DURATION Till Otherwise Agreed
ID XTLKMGR
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SY(xtlk1,xtlk2,xtlk3)
Add terms and synonyms to the Local Synonym
file(8984.3).
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
Associated file
XTLK2 Input
term
XTLK3 Input
Synonym (or optional array for multiple synonymns per
term).  For example: SYN(1)=<first synonym>, SYN(2)=<2nd synonym>
XTLKER(1,filename) Output
File not defined in the Local Lookup file (8984.4)
XTLKER(2,term) Output
The term could not be added.
XTLKER(3,synonym) Output
Synonym could not be added.
K(xtlk1,xtlk2,xltk3)
Add keywords to the LOCAL KEYWORD file (8984.1).
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
Associated file
XTLK2 Input
code in associated file
XLTK3 Input
keyword
XTLKER(1,filename) Output
File not defined in the LOCAL LOOKUP file (8984.4)
XTLKER(2,code) Output
the code is not in the associated file.
XTLKER(3,synonym) Output
The keyword could not be added.
L(xtlk1,xtlk2,xtlk3,xtlk4)
Define a file in the LOCAL LOOKUP file (8984.4).
Adding the target file here does not automatically place the special look-up
routine, ^XTLKDICL, in the file's Data Dictionary. since use of this routine
is at the discretion of the developer, it should be manually added via the
Edit File option under VA Fileman's Utilities Menu.
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
filename or number
XTLK2 Input
application-specific display protocol (optional)
XLTK3 Input
MTLU index to use for look-ups
XTLK4 Input
variable pointer prefix
XTLKER(1,filename) Output
file could not be added
DSH(xtlk1,xtlk2)
Delete shortcuts from the LOCAL SHORTCUT file
(8984.2)
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
filename
XTLK2 Input
leave undefined to delete all shortcuts for a given
target file or pass in an array for selected shortcuts.
DSY(xtlk1,xtlk2)
Delete synonyms from the LOCAL SYNONYM file (8984.3)
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
filename
XTLK2 Input
Leave undefined to delete all synonyms for a given
target file or pass in an array for selected synonyms.
DK(xtlk1,xtlk2)
Delete keywords from the LOCAL KEYWORD file (8984.1)
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
filename
XTLK2 Input
Leave undefined to delete all keywords for a given
target file or pass in an array for selected keywords.
DLL(xtlk1)
Delete an entry from the LOCAL LOOKUP FILE (8984.4)
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
associated filename or number
XTLKER(1,filename) Output
file is not in the LOCAL LOOKUP file (8984.4)
XTLKER(2) Output
Entries exist for keywords, shortcuts or synonyms for
the associated file.  These must be deleted first.
LKUP(fil,xtlkx,xtlksay,xtlkhlp,xtlkmore)
This is a general lookup facility for MTLU. The
target file must be defined in the LOCAL LOOKUP file, but the routine
^XTLKDICL does not have to be defined in the target file's DD.
VARIABLES TYPE VARIABLES DESCRIPTION
FIL Input
target file (must be defined in the LOCAL LOOKUP
file, 8984.4)
XTLKX Input
word or phrase to use in the look-up
XTLKSAY Input
<OPTIONAL>set to -1, 0 or 1 (default). 0=minimal
display, -1=NO screen writes are performed, 1 or null=normal display. The
purpose of XTLKSAY is to control the degree of output to the screen, not the
amount of file information displayed. If screen displays are turned off, MTLU
matches can be processed by checking the count in ^TMP("XTLKHITS",$J).
^TMP("XTLKHITS",$J,x)=IEN of the entry in the target file. Remember to kill
this node after processing.
XTLKHLP Input
<OPTIONAL>executable M code to display
application-specific help
XTLKMORE Input
<OPTIONAL>if set to '1' and there are no MTLU
matches, the search will continue using all available Fileman
cross-references. At this point, it will be a simple FileMan look-up and
display (default=1).

NOTE: If XTLKSAY=-1, then XTLKMORE is ignored.
SH(xtlk1,xtlk2,xtlk3)
Populate the MTLU Shortcuts file (8984.2).
VARIABLES TYPE VARIABLES DESCRIPTION
XTLK1 Input
Associated file
XTLK2 Input
code in associated file
XTLK3 Input
shortcut
XTLKER(2,xtlk2) Output
error-code in associated file did not exist.
XTLKER(3,xtlk3) Output
error-shortcut could not be added.