source: cprs/branches/tmg-cprs/Server_KIDS/TMG-CPRS-TEXTOBJ-FMFLD-1.0-1.TXT@ 737

Last change on this file since 737 was 737, checked in by Kevin Toppenberg, 14 years ago

Fixed Text Object Parameters
File size: 9.3 KB
Line 
1$TXT Created by TOPPENBERG,KEVIN at FAMILY PHYSICANS OF GREENEVILLE (KIDS) on Sunday, April 18, 2010
2============================================================================
3Run Date: APR 18,2010 Designation: TMG-CPRS-TEXTOBJ-FMFLD*1.0*1
4Package : TMG - FAMILY PHYSICANS OF GREENEVILLE Priority: Optional
5Version : 1 SEQ #1 Status: Released
6============================================================================
7
8Associated patches: None
9
10Subject: Patch to support custom lookups in CPRS (does not require TMG-CPRS)
11
12Category:
13 - Routine
14
15Dependancies:
16============
17
18 TMG-CPRS-TEXTOBJ-PARAM*1.0*1 is required for the installation of this patch.
19
20License:
21============
22 This patch is copyright 04/18/2010. GNU Lessor General Public License (LGPL) applies.
23
24Authors:
25============
26 Kevin Toppenberg, Greeneville Family Physicians, PC
27
28Description:
29============
30
31 This patch provides a TIU TEXT object that can be included
32on templates in CPRS. This object will allow fetching the
33value of any field from the PATIENT file.
34
35Usage
36 |TMG PATIENT FLD{Field(s)^Flags^FormatString}
37
38 Field(s) -- required. Options for input:
39 - A single field number or name
40 - A list of field numbers (or names), separated by semicolons
41 - A range of field numbers (or names), in the form M:N,
42 where M and N are the end points of the inclusive range.
43 All field numbers within this range are retrieved.
44 - A '*' for all fields at the top level (no sub-multiple record).
45 - A '**' for all fields including all fields and data in sub-multiple fields.
46 - Field number (or name) of a multiple followed by an * to indicate all
47 fields and records in the sub-multiple for that field.
48 Invalid field names will be ignored
49 Flags -- Optional.
50 - 'F' -- include field name in results with value. e.g. "AGE: 43" instead of just "43"
51 - This flag is ignored if a FormatString is provided (see below)
52 - 'S' -- Keep all data values on a single line, separated by ';'.
53 - If flag not provided, and multiple data fields are requested,
54 - then the default is that each data value will be separated by a
55 - CRLF [$C(13)_$C(10)]
56 - This flag is ignored if a FormatString is provided (see below)
57 - 'R' -- Resolve fields to NAMES, even if a field NUMBER was used for input request
58 - Note: this will affect the sorting order of the output (see FormatString info below). I.e. if R not specified, and field NUMBERS are used for input, then results will be returned in numerical field number order by default.
59 - If R is specified, then field numbers are converted to field NAMES, and that is used to determine the order of output.
60 - 'N' -- Don't return values for empty fields. This is helpful if ALL fields
61 - were requested via '*'
62 FormatString -- A string to determine how results are passed back....
63 NOTE: without a format string, results will be passed back in the order returned by fileman. I.e. if user requested fields "SEX;.01;AGE", then Fileman will place results into an array, which MUMPS will sort alphabetically, e.g. .01, then AGE, then SEX. If "*" fields are requested, it would be even more complex. A format string will allow the user to specify ORDER.
64 Format: e.g. "Any arbitrary text %FieldNameOrNum% more text
65 %FieldNameOrNum%..."
66 (The goal was to follow the method used by printf in the c language.)
67 - Any arbitrary text can be included.
68 - Field numbers or names should be enclosed by the '%' character
69 These will be replaced with actual data values.
70 - '\n' can be included to specify line breaks
71 - '%%' will be used to show a '%' in the output text
72 - Invalid, or non-matching, field names/numbers will be ignored.
73
74Results: returns a string that will be sent back to CPRS, to be included in a text note
75
76
77 The code has been developed on a GT.M mumps system. Every attempt was made to use coding
78 techniques that would be cross-platform to Cache'. But the patch has NOT been tested on 'Cache'.
79
80 INSTALLATION INSTRUCTIONS:
81 ==========================
82 This patch should cause minimal impact on live systems, as it provides only 1 routine,
83 Installation will take less than 1 minute. Users may remain on the system in roll-and-
84 scroll mode.
85
86 NOTE HOWEVER: All CPRS applications should be exited before installing the patch. Otherwise
87 CPRS users will find that the RPC call has been redirected to a routine that does not yet
88 exist in their instance. In GT.M, recompilation of routines etc only occurrs with a client
89 first connects to the server. We are not sure if this behavior applies to Cache' systems. But
90 the safest approach would be to have all users of CPRS exit their applications, and restart after application of the patch.
91
92 Note: the follow instructions were copied from another KIDS install and modified. There may be
93 some discrepancies.
94
95 The following are instructions for those using the Packman method:
96 ------------------------------------------------------------------
97 1. Use the INSTALL/CHECK MESSAGE option on the PackMan menu.
98
99 2. Review your mapped set. If any of the routines listed in the
100 ROUTINE SUMMARY section are mapped, they should be removed
101 from the mapped set at this time.
102
103 3. From the Kernel Installation and Distribution System Menu, select
104 the Installation menu.
105
106 4. From this menu, you may elect to use the following options
107 (when prompted for INSTALL NAME, enter TMG-CPRS-TEXTOBJ-FMFLD*1.0*1:
108 a. Backup a Transport Global
109 b. Compare Transport Global to Current System
110 c. Verify Checksums in Transport Global
111
112 5. Use the Install Package(s) option and select the package TMG-CPRS-TEXTOBJ-FMFLD*1.0*1
113
114 6. When prompted 'Want KIDS to INHIBIT LOGONs during the install? YES//'
115 respond NO.
116
117 7. When prompted 'Want to DISABLE Scheduled Options, Menu Options, and
118 Protocols? YES//', respond NO.
119
120 8. If routines were unmapped as part of step 2, they should be returned
121 to the mapped set once the installation has run to completion.
122
123 9. (See step 9 below)
124
125 The following are instructions for those loading the patch via Host File System:
126 ---------------------------------------------------------------------------------
127 1. Navigate the menu option path to reach the Kernel Installation and Distribution
128 System Menu. Or, the menu option XPD MAIN may be entered directly.
129
130 2. Next, at the menu displaying:
131 Edits and Distribution ...
132 Utilities ...
133 Installation ... <---------- pick this one.
134
135 3. Next, at the menu displaying the options as below, choose each of the options
136 in a step-by-step fashion, in numerical order (i.e. 1, 2, 3 etc.) Step #1 will
137 prompt the user to enter the file path on the host file system where the source
138 file is stored. The filename to enter is TMG-CPRS-TEXTOBJ-FMFLD*1.0*1.KIDS, but add the
139 appropriate path. E.g. /tmp/TMG-CPRS-TEXTOBJ-FMFLD*1.0*1.KIDS
140
141 1 Load a Distribution
142 2 Verify Checksums in Transport Global
143 3 Print Transport Global
144 4 Compare Transport Global to Current System
145 5 Backup a Transport Global
146 6 Install Package(s)
147 Restart Install of Package(s)
148 Unload a Distribution
149
150 4. From this menu, you may elect to use the following options
151 (when prompted for INSTALL NAME, enter TMG-CPRS-TEXTOBJ-FMFLD*1.0*1
152 a. Backup a Transport Global
153 b. Compare Transport Global to Current System
154 c. Verify Checksums in Transport Global
155
156 5. Use the Install Package(s) option and select the package TMG-CPRS-TEXTOBJ-FMFLD*1.0*1
157
158 6. When prompted 'Want KIDS to INHIBIT LOGONs during the install? YES//'
159 respond NO.
160
161 7. When prompted 'Want to DISABLE Scheduled Options, Menu Options, and
162 Protocols? YES//', respond NO.
163
164 8. If routines were unmapped as part of step 2, they should be returned
165 to the mapped set once the installation has run to completion.
166
167
168=============================================================================
169User Information:
170Entered By : TOPPENBERG,KEVIN Date Entered : Apr 18,2010
171Completed By: TOPPENBERG,KEVIN Date Completed: Apr 18,2010
172Released By : TOPPENBERG,KEVIN Date Released : Apr 18,2010
173=============================================================================
174
175Packman Mail Message:
176=====================
177
178$END TXT
Note: See TracBrowser for help on using the repository browser.