VistApedia - User contributions [en]

Fancy ZSTEP GTM

2025-01-08T21:54:05Z

Shabiel: Added detection of a write to the screen.

General procedure:
# Put a breakpoint on the code you want to debug: ZB UPDATE^DIE
# Set special ZSTEP
# Execute the code you want to debug: S FDA(3.1,"?+1,",.01)="BOO" D UPDATE^DIE(,$NA(FDA))
# Once you hit the breakpoint, type ZSTEP INTO to activate stepping. The entire routine execution will be shown.

Regular ZSTEP (save dev and restore dev after each line)
<pre>
n oldio s oldio=$i u 0 w $t(@$zpos),! b u oldio
</pre>

Detect if a variable has changed (in this case, $data of DIC(0)):
<pre>
b:($g(olddic)'=$d(DIC(0))) s olddic=$d(DIC(0)) zstep into
</pre>

Detect if a write is made ($X changes):
<pre>
set $zstep="b:$g(oldx)'=$x s oldx=$x zstep into"
</pre>

Print source code while executing
<pre>
S $ZSTEP="W $ZPOS,?20,$T(@$ZPOS),! ZSTEP INTO"
</pre>

You can combine these together, for example, to print all executed lines and stop when a variable changes. Here's how I did that:

<pre>
n oldio s oldio=$i u 0 b:($g(olddic)'=$d(DIC(0))) s olddic=$d(DIC(0)) zp @$zpos u oldio zstep into
</pre>

Patient Merge

2019-05-23T17:42:41Z

Shabiel: /* Patient Merge Use Issues with FOIA (as of February 2019) */

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Patient Merge Use Issues with FOIA (as of February 2019) ===
* Two packages have custom routines that affect record merge: CLINICAL INFO RESOURCE NETWORK (RG) and NDBI (A7R). The first one tries to talk to the MPI; and second one references a routine that doesn't exist. You need to go to the package file and remove the patient file merge from field 20 for each of those entries. Here's a screenscrape:
<pre>
OSEHRA>D P^DI

VA FileMan 22.2

Identity = MANAGER,SYSTEM SM

Select OPTION: ENTER OR EDIT FILE ENTRIES

Input to what File: PACKAGE
1 PACKAGE (144 entries)
2 PACKAGE INTERFACE (122 entries)
3 PACKAGE SIZE (5310 entries)
4 PACKAGE TYPE (530 entries)
CHOOSE 1-4: 1 PACKAGE (144 entries)
EDIT WHICH FIELD: ALL// 20 AFFECTS RECORD MERGE (multiple)
EDIT WHICH AFFECTS RECORD MERGE SUB-FIELD: ALL// .01 FILE AFFECTED
THEN EDIT AFFECTS RECORD MERGE SUB-FIELD:
THEN EDIT FIELD:

Select PACKAGE NAME: RG
1 RG CLINICAL INFO RESOURCE NETWORK RG
2 RGUT RUN TIME LIBRARY RGUT
CHOOSE 1-2: 1 CLINICAL INFO RESOURCE NETWORK RG
Select FILE AFFECTED: PATIENT// @
SURE YOU WANT TO DELETE THE ENTIRE FILE AFFECTED? Y (Yes)
Select FILE AFFECTED:

Select PACKAGE NAME: A7R NDBI A7R
Select FILE AFFECTED: PATIENT// @
SURE YOU WANT TO DELETE THE ENTIRE FILE AFFECTED? Y (Yes)
Select FILE AFFECTED:

Select PACKAGE NAME:
</pre>
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. You do not need to use this to use the package, but it makes finding the potential duplicate patients much easier. To undo this, in routine XDRDCOMP, change:
<pre>
S XDRFL=$$FILE^XDRDPICK(1) Q:XDRFL'>0
</pre>
to
<pre>
S XDRFL=$$FILE^XDRDPICK(0) Q:XDRFL'>0
</pre>

And in routine XDRDQUE, comment out this line:
<pre>
N XDRNOPT S XDRNOPT=1
</pre>

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed. I traced it, and it usually means that it's running through the package routines that do the merge (field 20 in the package file), and one of them decided to abort. Check to see which package that is, and you may have to debug to see why it decided to reject the merge.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Patient Merge

2019-05-23T17:20:40Z

Shabiel: /* Patient Merge Use on VISTA (Quick and Dirty) */

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Patient Merge Use Issues with FOIA (as of February 2019) ===
* Two packages have custom routines that affect record merge: CLINICAL INFO RESOURCE NETWORK (RG) and NDBI (A7R). The first one tries to talk to the MPI; and second one references a routine that doesn't exist. You need to go to the package file and remove the patient file merge from field 20 for each of those entries.
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. You do not need to use this to use the package, but it makes finding the potential duplicate patients much easier. To undo this, in routine XDRDCOMP, change:
<pre>
S XDRFL=$$FILE^XDRDPICK(1) Q:XDRFL'>0
</pre>
to
<pre>
S XDRFL=$$FILE^XDRDPICK(0) Q:XDRFL'>0
</pre>

And in routine XDRDQUE, comment out this line:
<pre>
N XDRNOPT S XDRNOPT=1
</pre>

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed. I traced it, and it usually means that it's running through the package routines that do the merge (field 20 in the package file), and one of them decided to abort. Check to see which package that is, and you may have to debug to see why it decided to reject the merge.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Patient Merge

2019-05-23T17:17:12Z

Shabiel: /* Patient Merge Use Issues with FOIA (as of February 2019) */

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Patient Merge Use Issues with FOIA (as of February 2019) ===
* Two packages have custom routines that affect record merge: CLINICAL INFO RESOURCE NETWORK (RG) and NDBI (A7R). The first one tries to talk to the MPI; and second one references a routine that doesn't exist. You need to go to the package file and remove the patient file merge from field 20 for each of those entries.
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. You do not need to use this to use the package, but it makes finding the potential duplicate patients much easier. To undo this, in routine XDRDCOMP, change:
<pre>
S XDRFL=$$FILE^XDRDPICK(1) Q:XDRFL'>0
</pre>
to
<pre>
S XDRFL=$$FILE^XDRDPICK(0) Q:XDRFL'>0
</pre>

And in routine XDRDQUE, comment out this line:
<pre>
N XDRNOPT S XDRNOPT=1
</pre>

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Patient Merge

2019-05-23T17:11:34Z

Shabiel: /* Patient Merge Use Issues with WV */

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [https://foia-vista.osehra.org/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Patient Merge Use Issues with FOIA (as of February 2019) ===
* Two packages have custom routines that affect record merge: CLINICAL INFO RESOURCE NETWORK (RG) and NDBI (A7R). The first one tries to talk to the MPI; and second one references a routine that doesn't exist. You need to go to the package file and remove the patient file merge from field 20.

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Patient Merge

2019-05-23T16:15:36Z

Shabiel:

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [http://mirrors.medsphere.org/pub/downloads.va.gov/files/FOIA/Software/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Patient Merge Use Issues with FOIA (as of February 2019) ===
* Two packages have custom routines that affect record merge: CLINICAL INFO RESOURCE NETWORK (RG) and NDBI (A7R). The first one tries to talk to the MPI; and second one references a routine that doesn't exist. You need to go to the package file and remove the patient file merge from field 20.

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Patient Merge

2019-05-23T15:59:55Z

Shabiel:

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [http://mirrors.medsphere.org/pub/downloads.va.gov/files/FOIA/Software/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.txt]]
* Kids: [[:File:JJIH_PT_MERGE_SOFTWARE_UPDATES_0110.kids.txt]]

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

File:JJIH PT MERGE SOFTWARE UPDATES 0110.kids.txt

2019-05-23T15:56:33Z

Shabiel:

File:JJIH PT MERGE SOFTWARE UPDATES 0110.txt

2019-05-23T15:55:14Z

Shabiel:

Patient Merge

2019-05-23T15:29:15Z

Shabiel: /* Prerequisite Set-up Before Using Patient Merge */

Written by Sam Habiel. Questions? http://groups.google.com/group/hardhats.

=== Intro ===
Patient Merge is a complex piece of software. Be sure to read the [http://www.va.gov/vdl/application.asp?appid=2 manual]. This will provide an overview of how to use it with WV. I still get errors here and there due to the way WV has some fields that point to routines that don't exist. I get unexpected behavior here and there; the point is that it looks like it will need more work in the future.

=== Patient Merge Use Issues with WV ===
There are few WV-related issues with Patient Merge that first need to be resolved.
* Due to various issues on how the MPI Parameters and the Local Site are set-up, the software may try to contact the MPI to resolve a merge, and fail to merge as a result. The actual issue should be present in any WV installation that uses the site number of 050; as the MPI thinks when comparing ICN's that start with 50 (from 050) that they are national since 050 isn't the same 50. An MPI bug to be sure, but why bother?
* Patch [http://mirrors.medsphere.org/pub/downloads.va.gov/files/FOIA/Software/Patches_By_Application/XT-KERNEL%20TOOLKIT/XT-7P3_SEQ-94_PAT-113.TXT XT*7.3*113] takes away the ability for the local site to search the patient file for duplicates, and relegates that ability only to the Central MPI. It looks like it has affected several places; so I need to fix all these different places. For now, I fixed only one routine which matters to me: Potential Duplicate Patient Search.
* X-ref ALK3 in file 15 on the Merge Status field has a bug in it. A completed merge (Merge Status = Merged) does not delete the ALK index entry. Thus, the IHS patient lookup routine erroneously says that the patient is a potential duplicate patient even though the patient has been merged already. I am not sure where the bug lies (IHS patient lookup or the Patient Merge software), but the ALK x-ref documentation says it's supposed to be deleted when it's merged.

I created a patch to resolve these issues and you can find it here. This patch depends XT*7.3*113, as it fixes a change in that patch.
* Description: [http://bazaar.launchpad.net/~sam-habiel/astronaut-vista-server/enhancements/download/sam.habiel%40gmail.com-20110825211457-zvgppwvs0tgbsip9/jjih_pt_merge_softwa-20110825211406-sj7iowsxtttd0sa3-2/JJIH_PT_MERGE_SOFTWARE_UPDATES_0100.txt JJIH_PT_MERGE_SOFTWARE_UPDATES_0100.txt]
* Kids: [http://bazaar.launchpad.net/~sam-habiel/astronaut-vista-server/enhancements/download/sam.habiel%40gmail.com-20110825211457-zvgppwvs0tgbsip9/jjih_pt_merge_softwa-20110825211406-sj7iowsxtttd0sa3-1/JJIH_PT_MERGE_SOFTWARE_UPDATES_0100.kids JJIH_PT_MERGE_SOFTWARE_UPDATES_0100.kids]

=== Prerequisite Set-up Before Using Patient Merge ===
Your user has to have access to the '''XDR MAIN MENU''' Menu.

Your user has to have the following keys:
* '''XDR''' (for day to day use of Patient Merge)
* '''XDRMGR''' (for Manager Operations: doing the actual merge, Site Parameters)
* '''DG ELIGIBILITY''' (ditto)

=== Patient Merge Set-Up on VISTA ===
You need to set-up your site parameters first. If you want to be able to merge patients immediately, you need to set <tt>DAYS BEFORE FINAL VERIFY</tt> and <tt>DAYS BETWEEN VERIFY AND MERGE</tt> to zero, otherwise you will have to wait before being able to merge patients. This is done as a precaution. Once patients are merged, there is no way to unmerge them.

<code>XDR MAIN MENU > Manager Utilities > Edit Site Parameters</code>

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Select Manager Utilities Option: edt Edit Site Parameters

Select DUPLICATE RESOLUTION FILE TO BE CHECKED: PATIENT
...OK? Yes// (Yes)
</pre>
[[Image:PtMergeSiteParam.png]]

=== Patient Merge Use on VISTA (Quick and Dirty)===
If you have a couple of duplicate patients and are sure about them, you can do a quick merge as follows. This is not the preferred scenario.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
XDRO Operations ...
XDRU Utilities ...
XDRM Manager Utilities ...

Select Duplicate Resolution System Option: XDRU Utilities
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)^M
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates^M
DSS Display Search Status^M
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]^M
FIND Find Potential Duplicates for an Entry in a File^M
VAL Identify Potential Merge Problems^M
PRNT Print List of File Duplicates^M
SCAN Scan Possible Duplicates^M
TSF Tally STATUS and MERGE STATUS Fields^M
VIEW View Duplicate [[Record~|Record]] Entries^M

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5:
6 ZZ PATIENT,TEST TWO <A> M 12-25-1957 2
7 ZZ WRONG,PATIENT F 01-01-2001
456552077
<Unresolved potential duplicate>
8 ZZ,WRONG M 06-06-1961 458414058
458414058
45841405
8
9 ZZANDERSON,BRANDON M 04-09-1988 468992445
468992445
<Unresolved potential duplicate>
10 ZZBARNES,ZZJUSTON M 01-01-2001 016996491
016996491
ENTER '^' TO STOP, OR
CHOOSE 1-10: ^
Select PATIENT:

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: ADD Add Verified Duplicate Pair
Add entries from which File: PATIENT

* No potential duplicate threshold % check will be calculated for PATIENTS
Select PATIENT: ZZ
1 ZZ LAB,TEST M 11-04-1970 749110470P
10000001
2 ZZ LAB,TESTTHREE F 03-03-1950 749030350P
10000033
3 ZZ LAB,TESTTWO M 11-04-1988 749110488P
10000011
4 ZZ PATIENT,TEST ONE <A> F 01-24-1945 000003322 1
5 ZZ PATIENT,TEST THREE <CA> M 01-15-1968 3
ENTER '^' TO STOP, OR
CHOOSE 1-5: 1
ZZ LAB,TEST M 11-04-1970 749110470P
10000001
Another PATIENT:
ZZ PATIENT,TEST THREE
<CA> M 01-15-1968 3

You will be adding the following pair of [[record~|Record]]s to the duplicate [[record~|Record]] file:

[[RECORD~|Record]]1: ZZ PATIENT,TEST THREE
[[RECORD~|Record]]2: ZZ LAB,TEST

Type <Enter> to continue or '^' to exit: Ok, continuing, hold on ...

[[RECORD~|Record]]1 contains fewer data elements, usually this would indicate
that this [[record~|Record]] would be merged INTO the other.

Determine if these entries ARE or ARE NOT duplicates.

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** NAME "ZZ LAB,TEST" "ZZ PATIENT,TEST THR
EE"

SEX MALE MALE

**** DATE OF BIRTH 11/04/1970 01/15/1968

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

MARITAL STATUS UNKNOWN

OCCUPATION "UNEMPLOYED"

CHECK FOR DUPLICATE YES YES

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

SOCIAL SECURITY NUMB "749110470P"
ER

PSEUDO SSN REASON NO SSN ASSIGNED

REMARKS "[PATIENT DIED ON 07
/14/11]"

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PLACE OF BIRTH [CITY "MIAMI"
]

PLACE OF BIRTH [STAT FLORIDA
E]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

WHO ENTERED PATIENT ADMINISTRATOR,SYSTEM

DATE ENTERED INTO FI 3/25/11
LE

STREET ADDRESS [LINE "123 ANYWHERE"
1]

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP+4 46123

CITY "AVON"

STATE INDIANA

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ZIP CODE "46123"

COUNTY 063

ADDRESS CHANGE DT/TM 7/24/05 17:37:52

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE SOURC VAMC
E

ADDRESS CHANGE SITE BAD POINTER VALUE IN
FILE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

ADDRESS CHANGE USER STARTUP,SYSTEM

K-NAME OF PRIMARY NO "CLAUSE,SANTA"
K

K-RELATIONSHIP TO PA "FRIEND"
TIENT

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-ADDRESS SAME AS PA NO
TIENT'S?

MOTHER'S MAIDEN NAME "NITWIT,"

SERVICE CONNECTED? NO NO

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

EMPLOYMENT STATUS UNKNOWN

COVERED BY HEALTH IN NO
SURANCE?

PERIOD OF SERVICE OTHER REIMBURS. (NON
-VET)

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH 7/14/11 17:28:14

DEATH ENTERED BY WHITLOW,LACHERYL

SOURCE OF NOTIFICATI INPATIENT AT VAMC
ON

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

DATE OF DEATH LAST U 7/14/11 17:28:14
PDATED

LAST EDITED BY WHITLOW,LACHERYL

**** PRIMARY ELIGIBILITY EHR PATIENT REIMBURSABLE INSURAN
CODE CE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

**** PRIMARY LONG ID "10000001" "--"

PRIMARY SHORT ID "0001"

NAME COMPONENTS 2 2

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

K-NAME COMPONENTS 2

**** LABORATORY REFERENCE 8 3

TYPE VISTA OFFICE EHR VISTA OFFICE EHR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

INTEGRATION CONTROL 500004122 500000002
NUMBER

ICN CHECKSUM "432992" "140241"

**** COORDINATING MASTER INTRACARE HOSPITAL S OFFICE OF INFORMATIO
OF [[RECORD~|Record]] YSTEM N SRV CNTR

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

LOCALLY ASSIGNED ICN YES YES

**** CMOR ACTIVITY SCORE 310 110

SCORE CALCULATION DA 8/27/11 8/27/11
TE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

VETERAN (Y/N)? NO NO

**** KEENE PERSONAL ACCT "123456" "343234"

[[RECORD~|Record]]1 [#33747] Record~|RECORD]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

PATIENT ELIGIBILITIES 1 entry 1 entry

DISPOSITION LOG-IN DATE/T 1 entry 1 entry

KEENE ADMISSION ACCOUNT N 1 entry ---

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THRE
E
CMOR SCORE = 310 CMOR SCORE = 110
----------------------------------------------------------------------------

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#33747] [[RECORD~|Record]]2 [#3]
ZZ LAB,TEST ZZ PATIENT,TEST THREE

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which [[record~|Record]] (1 or 2) should be MERGED INTO the other [[record~|Record]]: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

Do you want to ADD another pair (Y/N)? NO
</pre>

After you add a verified duplicate, then you approve it for merge in the Operations Menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">

Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZWRONG,PATIENT -- [26877]
ZZ WRONG,PATIENT -- [4949]

Select entries to approve them for merging: (1-1): 1
</pre>

After you approve the merge, then you schedule a job to merge it from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SCH Schedule Process to Merge Verified Duplica
tes

1 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? YES

Name for Merge Process: MERGE 20110827
START DATE/TIME: NOW (AUG 27, 2011@12:06:54)

Merge process 'MERGE 20110827' for Verified Duplicates in File 2 scheduled
as task 400609.
</pre>
To see whether the merge process completed or not, here is how you do it.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Utilities Menu

ADD Add Verified Duplicate Pair
CMP Check Merge Process Status (reverse order)
CHCK Check Pair of [[Record~|Record]]s to see if Duplicates
DSS Display Search Status
EDIT Edit the Status Field of a Duplicate [[Record~|Record]]
FIND Find Potential Duplicates for an Entry in a File
VAL Identify Potential Merge Problems
PRNT Print List of File Duplicates
SCAN Scan Possible Duplicates
TSF Tally STATUS and MERGE STATUS Fields
VIEW View Duplicate [[Record~|Record]] Entries

Select Utilities Option: CMP

Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827 08/27 12:06 C 08/27 12:07
DATA CHECKING 08/27 12:06 C 08/27 12:06
LAB SERVICE 08/27 12:06 C 08/27 12:06
INTEGRATED BILL 08/27 12:06 C 08/27 12:06
ACCOUNTS RECEIV 08/27 12:06 C 08/27 12:06
FEE BASIS 08/27 12:06 C 08/27 12:06
ICR - IMMUNOLOG 08/27 12:06 C 08/27 12:06
NDBI 08/27 12:06 C 08/27 12:06
ENROLLMENT APPL 08/27 12:06 C 08/27 12:06
PATIENT FILE 08/27 12:06 C 08/27 12:06
THREAD 2 08/27 12:06 C 08/27 12:06
THREAD 3 08/27 12:06 C 08/27 12:07
</pre>

If you ever see <tt>NO PAIRS LEFT</tt> and then <tt>** STOPPED **</tt>, it means that your patient merge failed.

=== Patient Merge on VISTA (The Proper Way) ===
First, scan the patient file for possible duplicates. You do that from the Manager's menu.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: SRCH Start/Halt Duplicate Search
Select file to be checked for duplicates: PATIENT

Duplicate PATIENT Search

Search Type Date Completed Status hours:min # [[Record~|Record]]s Checked
----------- -------------- ------ -------------- -----------------

BASIC AUG 27,2011@12:48 COMPLETED 0:00 34939/34939 100.0%

0 Potential Duplicate pairs added to the DUPLICATE [[RECORD~|Record]] FILE (#15)

Do You wish to RUN a search (Y/N)? YES
Which type of Search do you wish to run ? (BASIC/NEW) BASIC// BASIC
This process will take a **LONG** time (known to exceed 100 hours),
but you CAN stop and restart the process when you want using
the options OK? YES
Requested Start Time: NOW// (AUG 27, 2011@13:16:58)
</pre>
After you do that, you go to the Operations Menu, to Verify Potential Duplicates, then Approve them for Merging.
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Resolution Operations Menu

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: vpd Verify Potential Duplicates

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT: zz
There are 77 choices.

...

Select one of the following:

V VERIFIED DUPLICATE
N VERIFIED, NOT A DUPLICATE
U UNABLE TO DETERMINE
H HEALTH SUMMARY
R REVIEW DATA AGAIN
S SELECT/REVIEW OVERWRITES

Select [[Action~|Action]]: HEALTH SUMMARY// v VERIFIED DUPLICATE

[[RECORD~|Record]]1 [#338] [[RECORD~|Record]]2 [#333]
ZZFAKE,PATIENT ZZFAKE,PATIENT

Select one of the following:

1 [[RECORD~|Record]]1 INTO [[RECORD~|Record]]2
2 [[RECORD~|Record]]2 INTO [[RECORD~|Record]]1

Which record (1 or 2) should be MERGED INTO the other record: [[RECORD~|Record]]1 INTO [[RECOR
D~|Record]]2//

At the following [[prompt~|Prompt]] select a POTENTIAL DUPLICATE ENTRY. If a selection
is not made, you will be given a chance to select from a list if you
want to. Otherwise, you will be returned to the menu system.

Select PATIENT:
Do you want to select from a list of potential duplicates? YES// n NO

APP Approve verified duplicates for merging
VPD Verify Potential Duplicates
ADR Ancillary Data Review

Select Operations Option: app Approve verified duplicates for merging

1 Entries are awaiting approval for merging Return to continue...

1 ZZFAKE,PATIENT 111-19-8541 [338]
ZZFAKE,PATIENT 111-18-8541 [333]

Select entries to approve them for merging: (1-1): 1
</pre>
Then you schedule the Merge through the Manager's Menu as before:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Duplicate Manager Utilities Menu

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

Select Manager Utilities Option: sch Schedule Process to Merge Verified Duplica
tes

2 Entries Ready to be included in merge
This process will take a **LONG** time (usually over 15 hours, and sometimes
considerably longer), but you CAN stop and restart the process when you
want using the options. OK? y YES

Name for Merge Process: MERGE 20110827-02
START DATE/TIME: NOW (AUG 27, 2011@13:50:13)

Merge process 'MERGE 20110827-02' for Verified Duplicates in File 2 scheduled
as task 400650.

EDT Edit Site Parameters
LIST List File Entries Identified in Preliminary Scan
SCN Preliminary Scan of File for Errors
PRGM Purge Merge Process File
RES Restart a Merge Process
SCH Schedule Process to Merge Verified Duplicates
SRCH Start/Halt Duplicate Search
STOP STOP an Active Merge Process

---
</pre>
Checking the Status (CMP) in the Utilities Menu, we see that it's done:
<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
Current Current
Merge Set Start Stat Last Chk Phase File Entry

MERGE 20110827-02 08/27 13:50 C 08/27 13:50
DATA CHECKING 08/27 13:50 C 08/27 13:50
LAB SERVICE 08/27 13:50 C 08/27 13:50
INTEGRATED BILL 08/27 13:50 C 08/27 13:50
ACCOUNTS RECEIV 08/27 13:50 C 08/27 13:50
FEE BASIS 08/27 13:50 C 08/27 13:50
ICR - IMMUNOLOG 08/27 13:50 C 08/27 13:50
NDBI 08/27 13:50 C 08/27 13:50
ENROLLMENT APPL 08/27 13:50 C 08/27 13:50
PATIENT FILE 08/27 13:50 C 08/27 13:50
THREAD 2 08/27 13:50 C 08/27 13:50
THREAD 3 08/27 13:50 C 08/27 13:50

</pre>

=== Sample workflow for a Production System ===
Theokli Hotzoglou posted the menu that they made at Lutheran to make the steps more straightforward for the HIMS dept. Thanks Theokli!

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
CH Check Pair of [[Record~|Record]]s to see if Duplicates
VAL Identify Potential Merge Problems
ADD Add Verified Duplicate Pair
ADR Ancillary Data Review
APP Approve verified duplicates for merging
HS Health Summary Coordinator's Menu ...
SCH Schedule Process to Merge Verified Duplicates
TSF Tally STATUS and MERGE STATUS Fields
CMP Check Merge Process Status (reverse order)
MAIL MailMan Menu ...
</pre>

Fancy ZSTEP GTM

2019-01-28T17:18:35Z

Shabiel: Created page with "General procedure: # Put a breakpoint on the code you want to debug: ZB UPDATE^DIE # Set special ZSTEP # Execute the code you want to debug: S FDA(3.1,"?+1,",.01)="BOO" D UPDA..."

General procedure:
# Put a breakpoint on the code you want to debug: ZB UPDATE^DIE
# Set special ZSTEP
# Execute the code you want to debug: S FDA(3.1,"?+1,",.01)="BOO" D UPDATE^DIE(,$NA(FDA))
# Once you hit the breakpoint, type ZSTEP INTO to activate stepping. The entire routine execution will be shown.

Regular ZSTEP (save dev and restore dev after each line)
<pre>
n oldio s oldio=$i u 0 w $t(@$zpos),! b u oldio
</pre>

Detect if a variable has changed (in this case, $data of DIC(0)):
<pre>
b:($g(olddic)'=$d(DIC(0))) s olddic=$d(DIC(0)) zstep into
</pre>

Print source code while executing
<pre>
S $ZSTEP="W $ZPOS,?20,$T(@$ZPOS),! ZSTEP INTO"
</pre>

You can combine these together, for example, to print all executed lines and stop when a variable changes. Here's how I did that:

<pre>
n oldio s oldio=$i u 0 b:($g(olddic)'=$d(DIC(0))) s olddic=$d(DIC(0)) zp @$zpos u oldio zstep into
</pre>

SHabiel Pages

2019-01-28T17:08:43Z

Shabiel: /* Other */

{|
|
== RPMS ==
[[RPMS_Installation|RPMS Installation on Cache]]

[[RPMS_PortInstallation_to_GTM|RPMS Port and Installation on GT.M]]

== Pharmacy ==
[[Pharmacy_Inpatient_Setup| Pharmacy: Inpatient Pharmacy Set-up]]

[[Pharmacy_AR/WS_Setup| Pharamcy: Ward Stock Set-up]]

[[Pharmacy_CS_Setup| Pharmacy: Controlled Substances Package Set-up]]

[[KIDS_Drug_File| Pharmacy: KIDS Drug File]]

[[Enter_A_Drug| Pharmacy: How to enter a drug in VISTA]]

[[NDC_Rules| Pharmacy: NDC Rules etc.]]

== Taskman ==
[[Taskman_Recurring_Tasks|Taskman Tasks]]

[[Debugging_Taskman_Tasks|Debugging Taskman Tasks]]

[[Taskman_Internals|Taskman Internals]]

== Sys Admin ==
[[Adding_Users|Adding new Users to VISTA]]

[[Transplant_Cleanup| Cleaning up a Transplanted RPMS or VISTA system]]

[[Setting_up_a_VISTA_Printer|Setting up a VISTA Printer]]

[[Setting_Up_Mailman_For_External_Email| Setting up Mailman for External Email]]

[[Basic_GTM_Journaling|Basic GT.M Journaling Instructions]]

[[VISTA_Auto_Signon|VISTA Automatic Sign-on]]

[[VISTA_Set-up_Outline| VISTA Set-up starting from scratch]]

[[VISTA_XWB_Broker_Troubleshooting| VISTA XWB Broker Troubleshooting]]

[[VISTA_System_Management_Daily_or_Weekly_Tasks | VISTA System Management Daily or Weekly Tasks]]

[[Set-up_Fileman_Browser_Device | Set up the Fileman Browser]]

== Lab ==
[[Lab_Brief_Setup|Sam tries to set up Lab]]

== CPRS ==
[[CPRS_Config:_Order_Checks| CPRS Configuration: Order Checks]]

[[CPRS_Config:_Notifications| CPRS Configuration: Notifications]]

[[CPRS_Config:_Turn_Off_HDR| Turn off Remote Data Order Checking]]

[[CPRS_on_Wine| Running CPRS on Linux via Wine]]

== Other ==
[[Patient_Merge|Patient Merge Set-up and Use in VISTA]]

[[TLS_Enable_VISTA_Service| TLS Enable a VISTA Service]]

[[Fileman_Internals| Fileman Internals]]

[[Dev_Copy| Copying devices from another environment]]

[[MFS_list| Master File Server controlled files]]

[[Terminal_Emulators | List of known issues with modern Terminal Emulators and VISTA]]

[[Bulk_rename_routines | Bulk of rename of Routines using Command Line tools]]

[[GNUParallel_load_and_compile_to_GTM | Use GNU Parallel to load and import a new database to GT.M]]

[[Fancy_ZSTEP_GTM | Enhanced ZSTEP to detect variable changes or print code ]]

[[VistA_Event_Drivers | Events Drivers in VistA]]

== Mumps Classes ==
* [[Mumps_Class_1|Class 1]] (Intro, History and Features of M)
* [[Mumps_Class_2|Class 2]] (Structure of Language, variables, etc)
* [[Mumps_Class_3|Class 3]] (Operators)
* [[Mumps_Class_4|Class 4]] (Strings and String Functions ($A, $C, $TR, $L, $P, $E, $F)
* [[Mumps_Class_5|Class 5]] (String pattern matching operator (?), Read, Write Set)
* [[Mumps_Class_6|Class 6]] (Read, Write, Set, Kill)
* [[Mumps_Class_7|Class 7]] (Do, If, $Test)
* [[Mumps_Class_8|Class 8]] (For loop)
* [[Mumps_Class_9|Class 9]] (Routine Walkthrough; debugging with native GT.M and TMGIDE)
* [[Mumps_Class_10|Class 10]] (Routine Walkthrough; $Reference and naked global references
* [[Mumps_Class_11|Class 11]] (Stack, Symbol Table, effect of Do and Goto; New)
* [[Mumps_Class_12|Class 12]] (Extrinsic Functions; passing parameters)
* [[Mumps_Class_13|Class 13]] ($Order and $Data)
* [[Mumps_Class_14|Class 14]] ($Query, $QS and $QL)
* [[Mumps_Class_15|Class 15]] (Indirection, Xecute, $Get, $Text)
* [[Mumps_Class_16|Class 16]] ($Text, $Name, $Random, $Reverse etc)
* [[Mumps_Class_17|Class 17]] (Locks)
* [[Mumps_Class_18|Class 18]] (Devices: Files, Null, Terminal, TCP)
* [[Mumps_Class_19|Class 19]] (Devices: Pipe; using ^%ZIS)
* [[Mumps_Class_20|Class 20]] (Job command; Transactions in Mumps)
* [[Mumps_Class_21|Class 21]] (Error Processing in Mumps)

== Fileman API Classes ==
* [[Fileman_API_Class_1|Class 1]] (Intro, ^DIR, ^DIC, ^%DT, ^%DTC, ^XLFDT)
* [[Fileman_API_Class_2|Class 2]] (EN^DDIOL, %RCR, EN1^DIP, ^DIE, ^DIK)

== Student Projects ==
* [[VISTA_Class_Student_Projects | Projects suitable for students learning VISTA]]

SHabiel Pages

2019-01-28T17:08:26Z

Shabiel: /* Other */

{|
|
== RPMS ==
[[RPMS_Installation|RPMS Installation on Cache]]

[[RPMS_PortInstallation_to_GTM|RPMS Port and Installation on GT.M]]

== Pharmacy ==
[[Pharmacy_Inpatient_Setup| Pharmacy: Inpatient Pharmacy Set-up]]

[[Pharmacy_AR/WS_Setup| Pharamcy: Ward Stock Set-up]]

[[Pharmacy_CS_Setup| Pharmacy: Controlled Substances Package Set-up]]

[[KIDS_Drug_File| Pharmacy: KIDS Drug File]]

[[Enter_A_Drug| Pharmacy: How to enter a drug in VISTA]]

[[NDC_Rules| Pharmacy: NDC Rules etc.]]

== Taskman ==
[[Taskman_Recurring_Tasks|Taskman Tasks]]

[[Debugging_Taskman_Tasks|Debugging Taskman Tasks]]

[[Taskman_Internals|Taskman Internals]]

== Sys Admin ==
[[Adding_Users|Adding new Users to VISTA]]

[[Transplant_Cleanup| Cleaning up a Transplanted RPMS or VISTA system]]

[[Setting_up_a_VISTA_Printer|Setting up a VISTA Printer]]

[[Setting_Up_Mailman_For_External_Email| Setting up Mailman for External Email]]

[[Basic_GTM_Journaling|Basic GT.M Journaling Instructions]]

[[VISTA_Auto_Signon|VISTA Automatic Sign-on]]

[[VISTA_Set-up_Outline| VISTA Set-up starting from scratch]]

[[VISTA_XWB_Broker_Troubleshooting| VISTA XWB Broker Troubleshooting]]

[[VISTA_System_Management_Daily_or_Weekly_Tasks | VISTA System Management Daily or Weekly Tasks]]

[[Set-up_Fileman_Browser_Device | Set up the Fileman Browser]]

== Lab ==
[[Lab_Brief_Setup|Sam tries to set up Lab]]

== CPRS ==
[[CPRS_Config:_Order_Checks| CPRS Configuration: Order Checks]]

[[CPRS_Config:_Notifications| CPRS Configuration: Notifications]]

[[CPRS_Config:_Turn_Off_HDR| Turn off Remote Data Order Checking]]

[[CPRS_on_Wine| Running CPRS on Linux via Wine]]

== Other ==
[[Patient_Merge|Patient Merge Set-up and Use in VISTA]]

[[TLS_Enable_VISTA_Service| TLS Enable a VISTA Service]]

[[Fileman_Internals| Fileman Internals]]

[[Dev_Copy| Copying devices from another environment]]

[[MFS_list| Master File Server controlled files]]

[[Terminal_Emulators | List of known issues with modern Terminal Emulators and VISTA]]

[[Bulk_rename_routines | Bulk of rename of Routines using Command Line tools]]

[[GNUParallel_load_and_compile_to_GTM | Use GNU Parallel to load and import a new database to GT.M]]

[[Fancy_ZSTEP_GTM | Enhanced ZSTEP to detect variable changes or print code ]

[[VistA_Event_Drivers | Events Drivers in VistA]]

== Mumps Classes ==
* [[Mumps_Class_1|Class 1]] (Intro, History and Features of M)
* [[Mumps_Class_2|Class 2]] (Structure of Language, variables, etc)
* [[Mumps_Class_3|Class 3]] (Operators)
* [[Mumps_Class_4|Class 4]] (Strings and String Functions ($A, $C, $TR, $L, $P, $E, $F)
* [[Mumps_Class_5|Class 5]] (String pattern matching operator (?), Read, Write Set)
* [[Mumps_Class_6|Class 6]] (Read, Write, Set, Kill)
* [[Mumps_Class_7|Class 7]] (Do, If, $Test)
* [[Mumps_Class_8|Class 8]] (For loop)
* [[Mumps_Class_9|Class 9]] (Routine Walkthrough; debugging with native GT.M and TMGIDE)
* [[Mumps_Class_10|Class 10]] (Routine Walkthrough; $Reference and naked global references
* [[Mumps_Class_11|Class 11]] (Stack, Symbol Table, effect of Do and Goto; New)
* [[Mumps_Class_12|Class 12]] (Extrinsic Functions; passing parameters)
* [[Mumps_Class_13|Class 13]] ($Order and $Data)
* [[Mumps_Class_14|Class 14]] ($Query, $QS and $QL)
* [[Mumps_Class_15|Class 15]] (Indirection, Xecute, $Get, $Text)
* [[Mumps_Class_16|Class 16]] ($Text, $Name, $Random, $Reverse etc)
* [[Mumps_Class_17|Class 17]] (Locks)
* [[Mumps_Class_18|Class 18]] (Devices: Files, Null, Terminal, TCP)
* [[Mumps_Class_19|Class 19]] (Devices: Pipe; using ^%ZIS)
* [[Mumps_Class_20|Class 20]] (Job command; Transactions in Mumps)
* [[Mumps_Class_21|Class 21]] (Error Processing in Mumps)

== Fileman API Classes ==
* [[Fileman_API_Class_1|Class 1]] (Intro, ^DIR, ^DIC, ^%DT, ^%DTC, ^XLFDT)
* [[Fileman_API_Class_2|Class 2]] (EN^DDIOL, %RCR, EN1^DIP, ^DIE, ^DIK)

== Student Projects ==
* [[VISTA_Class_Student_Projects | Projects suitable for students learning VISTA]]

VistA Event Drivers

2019-01-18T22:13:58Z

Shabiel: Created page with "{| ! PROTOCOL || Description |- | DG FIELD MONITOR || DG Field Monitor |- | DGPM MOVEMENT EVENTS || MOVEMENT EVENTS v 5.0 |- | GMPL EVENT || Problem List Update Event |- | GMR..."

{|
! PROTOCOL || Description
|-
| DG FIELD MONITOR || DG Field Monitor
|-
| DGPM MOVEMENT EVENTS || MOVEMENT EVENTS v 5.0
|-
| GMPL EVENT || Problem List Update Event
|-
| GMRA ENTERED IN ERROR || Reaction Data Entered in Error
|-
| GMRA SIGN-OFF ON DATA || Sign-off on Reaction Data
|-
| GMRC EVSEND OR || Consults event sent to OE/RR
|-
| IBCN NEW INSURANCE EVENTS || IB New Insurance Event Driver
|-
| LR7O CH EVSEND OR || LAB => OE/RR ORDER MESSAGE EVENT
|-
| OR EVSEND FH || OE/RR => DIET MESSAGE EVENT
|-
| OR EVSEND GMRC || OE/RR => CONSULTS MESSAGE EVENT
|-
| OR EVSEND LRCH || OE/RR => LAB MESSAGE EVENT
|-
| OR EVSEND ORG || OE/RR => GENERIC MESSAGE EVENT
|-
| OR EVSEND PS || OE/RR => PHARMACY MESSAGE EVENT
|-
| OR EVSEND RA || OE/RR => RAD/NM MESSAGE EVENT
|-
| OR EVSEND VPR || OE/RR => VPR MESSAGE
|-
| PS EVSEND OR || Send Pharmacy orders to CPRS.
|-
| PXK VISIT DATA EVENT || VISIT RELATED DATA
|-
| RA EVSEND OR || Radiology event sent to OE/RR
|-
| SCMC PATIENT TEAM CHANGES || PCMM Patient Team Update Event Driver
|-
| SCMC PATIENT TEAM POSITION CHANGES || PCMM Patient Team Position Update Event Driver
|-
| SDAM APPOINTMENT EVENTS || Appointment Event Driver
|}

SHabiel Pages

2019-01-18T22:00:19Z

Shabiel: /* Other */

{|
|
== RPMS ==
[[RPMS_Installation|RPMS Installation on Cache]]

[[RPMS_PortInstallation_to_GTM|RPMS Port and Installation on GT.M]]

== Pharmacy ==
[[Pharmacy_Inpatient_Setup| Pharmacy: Inpatient Pharmacy Set-up]]

[[Pharmacy_AR/WS_Setup| Pharamcy: Ward Stock Set-up]]

[[Pharmacy_CS_Setup| Pharmacy: Controlled Substances Package Set-up]]

[[KIDS_Drug_File| Pharmacy: KIDS Drug File]]

[[Enter_A_Drug| Pharmacy: How to enter a drug in VISTA]]

[[NDC_Rules| Pharmacy: NDC Rules etc.]]

== Taskman ==
[[Taskman_Recurring_Tasks|Taskman Tasks]]

[[Debugging_Taskman_Tasks|Debugging Taskman Tasks]]

[[Taskman_Internals|Taskman Internals]]

== Sys Admin ==
[[Adding_Users|Adding new Users to VISTA]]

[[Transplant_Cleanup| Cleaning up a Transplanted RPMS or VISTA system]]

[[Setting_up_a_VISTA_Printer|Setting up a VISTA Printer]]

[[Setting_Up_Mailman_For_External_Email| Setting up Mailman for External Email]]

[[Basic_GTM_Journaling|Basic GT.M Journaling Instructions]]

[[VISTA_Auto_Signon|VISTA Automatic Sign-on]]

[[VISTA_Set-up_Outline| VISTA Set-up starting from scratch]]

[[VISTA_XWB_Broker_Troubleshooting| VISTA XWB Broker Troubleshooting]]

[[VISTA_System_Management_Daily_or_Weekly_Tasks | VISTA System Management Daily or Weekly Tasks]]

[[Set-up_Fileman_Browser_Device | Set up the Fileman Browser]]

== Lab ==
[[Lab_Brief_Setup|Sam tries to set up Lab]]

== CPRS ==
[[CPRS_Config:_Order_Checks| CPRS Configuration: Order Checks]]

[[CPRS_Config:_Notifications| CPRS Configuration: Notifications]]

[[CPRS_Config:_Turn_Off_HDR| Turn off Remote Data Order Checking]]

[[CPRS_on_Wine| Running CPRS on Linux via Wine]]

== Other ==
[[Patient_Merge|Patient Merge Set-up and Use in VISTA]]

[[TLS_Enable_VISTA_Service| TLS Enable a VISTA Service]]

[[Fileman_Internals| Fileman Internals]]

[[Dev_Copy| Copying devices from another environment]]

[[MFS_list| Master File Server controlled files]]

[[Terminal_Emulators | List of known issues with modern Terminal Emulators and VISTA]]

[[Bulk_rename_routines | Bulk of rename of Routines using Command Line tools]]

[[GNUParallel_load_and_compile_to_GTM | Use GNU Parallel to load and import a new database to GT.M]]

[[VistA_Event_Drivers | Events Drivers in VistA]]

== Mumps Classes ==
* [[Mumps_Class_1|Class 1]] (Intro, History and Features of M)
* [[Mumps_Class_2|Class 2]] (Structure of Language, variables, etc)
* [[Mumps_Class_3|Class 3]] (Operators)
* [[Mumps_Class_4|Class 4]] (Strings and String Functions ($A, $C, $TR, $L, $P, $E, $F)
* [[Mumps_Class_5|Class 5]] (String pattern matching operator (?), Read, Write Set)
* [[Mumps_Class_6|Class 6]] (Read, Write, Set, Kill)
* [[Mumps_Class_7|Class 7]] (Do, If, $Test)
* [[Mumps_Class_8|Class 8]] (For loop)
* [[Mumps_Class_9|Class 9]] (Routine Walkthrough; debugging with native GT.M and TMGIDE)
* [[Mumps_Class_10|Class 10]] (Routine Walkthrough; $Reference and naked global references
* [[Mumps_Class_11|Class 11]] (Stack, Symbol Table, effect of Do and Goto; New)
* [[Mumps_Class_12|Class 12]] (Extrinsic Functions; passing parameters)
* [[Mumps_Class_13|Class 13]] ($Order and $Data)
* [[Mumps_Class_14|Class 14]] ($Query, $QS and $QL)
* [[Mumps_Class_15|Class 15]] (Indirection, Xecute, $Get, $Text)
* [[Mumps_Class_16|Class 16]] ($Text, $Name, $Random, $Reverse etc)
* [[Mumps_Class_17|Class 17]] (Locks)
* [[Mumps_Class_18|Class 18]] (Devices: Files, Null, Terminal, TCP)
* [[Mumps_Class_19|Class 19]] (Devices: Pipe; using ^%ZIS)
* [[Mumps_Class_20|Class 20]] (Job command; Transactions in Mumps)
* [[Mumps_Class_21|Class 21]] (Error Processing in Mumps)

== Fileman API Classes ==
* [[Fileman_API_Class_1|Class 1]] (Intro, ^DIR, ^DIC, ^%DT, ^%DTC, ^XLFDT)
* [[Fileman_API_Class_2|Class 2]] (EN^DDIOL, %RCR, EN1^DIP, ^DIE, ^DIK)

== Student Projects ==
* [[VISTA_Class_Student_Projects | Projects suitable for students learning VISTA]]

MFS list

2019-01-11T14:06:01Z

Shabiel:

Updated based on a spreadsheet given to us by the VA. This list is what actually gets updated, not what has MFS parameters. Several files have MFS parameters but the work to updated them via MFS did not continue.

<pre>
4.009
10.99
11.99
13.99
50.60699
66.3
71.99
95.3
100.01
100.02
120.51
120.52
120.53
120.82
120.83
355.99
920
920.1
920.2
920.3
920.4
920.5
7118.11
8925.6
8926.1
8926.2
8926.3
8926.4
8926.5
8926.6
8932.1
8985.1
9999999.04
9999999.14
9999999.28
</pre>

Adding Users

2018-05-20T01:23:33Z

Shabiel: /* Required Data Elements for a Functional User */

== What does the person adding a new user need? ==
* Access to Menu Option '''XUSERNEW'''
* Key '''XUMGR''' or delegated keys and menus.
* Key '''XUSPF200''' (optional) to not be required to enter SSNs.

Access to XUSERNEW is typically done through EVE > XUSER (User Management). If you have XUMGR, you can give any keys or menus. If not, you can only give keys and menus delegated to you (I don't cover delegation here).

== Required Data Elements for a Functional User ==
Adding a user is rather confusing due to the number of different items you can fill when most of them is optional.

(Pre-page 1)
* Name
[[File:Vista-add-user1.png]]

(Page 1)
* Primary Menu Option (or user can't log in)
* Access Code (say Y to the "Want to edit option" and you will be asked to enter it twice)
* Verify Code (ditto)
* Service/Section (any will do)
[[File:Vista-add-user2.png]]

== CPRS Users ==
You need to fill in the following for CPRS users.

(Page 1)
* Access to OR CPRS GUI CHART either through a primary option or alone as a secondary option
(Page 3)
* Person Class with Effective Date (especially for Reminders to work)
(Page 4)
* Restrict Patient Selection
* CPRS Tab Access with Effective Date

Providers get PROVIDER key as well as an ordering key (ORES or ORELSE). Physicians/other providers get ORES to be able to order meds; Nurses and Pharmacists get ORELSE to be able to act on Orders in CPRS and also to be able to place orders on behalf of ORES holding providers.

Physicians ordering Meds from CPRS need to have 'Authorized to write med orders' field 53.1 in file 200 (NEW PERSON) set to YES. To order controlled substances, provider must have either a DEA# in file 200 or a VA # in file 200 with an Institutional DEA in the Kernel System Parameters file (8989.3). VistA-Config users click on a user then the Advanced tab, go to field 53.1 and set it to YES.

For users to inherit parameters properly for CPRS, and for optional TIU functions to work, they need to to be added to a TIU User Class. This is done through the USR CLASS MANAGEMENT MENU.

== Screenshot ==
[[Image:Screenshot-poc-moh@sam-desktop-_-opt-worldvista-poc-moh.png||Adding a new user]]

File:Vista-add-user2.png

2018-05-20T01:21:40Z

Shabiel:

Adding Users

2018-05-20T01:20:46Z

Shabiel: /* Required Data Elements for a Functional User */

== What does the person adding a new user need? ==
* Access to Menu Option '''XUSERNEW'''
* Key '''XUMGR''' or delegated keys and menus.
* Key '''XUSPF200''' (optional) to not be required to enter SSNs.

Access to XUSERNEW is typically done through EVE > XUSER (User Management). If you have XUMGR, you can give any keys or menus. If not, you can only give keys and menus delegated to you (I don't cover delegation here).

== Required Data Elements for a Functional User ==
Adding a user is rather confusing due to the number of different items you can fill when most of them is optional.

(Pre-page 1)
* Name
[[File:Vista-add-user1.png]]
(Page 1)
* Primary Menu Option (or user can't log in)
* Access Code
* Verify Code
* Service/Section

== CPRS Users ==
You need to fill in the following for CPRS users.

(Page 1)
* Access to OR CPRS GUI CHART either through a primary option or alone as a secondary option
(Page 3)
* Person Class with Effective Date (especially for Reminders to work)
(Page 4)
* Restrict Patient Selection
* CPRS Tab Access with Effective Date

Providers get PROVIDER key as well as an ordering key (ORES or ORELSE). Physicians/other providers get ORES to be able to order meds; Nurses and Pharmacists get ORELSE to be able to act on Orders in CPRS and also to be able to place orders on behalf of ORES holding providers.

Physicians ordering Meds from CPRS need to have 'Authorized to write med orders' field 53.1 in file 200 (NEW PERSON) set to YES. To order controlled substances, provider must have either a DEA# in file 200 or a VA # in file 200 with an Institutional DEA in the Kernel System Parameters file (8989.3). VistA-Config users click on a user then the Advanced tab, go to field 53.1 and set it to YES.

For users to inherit parameters properly for CPRS, and for optional TIU functions to work, they need to to be added to a TIU User Class. This is done through the USR CLASS MANAGEMENT MENU.

== Screenshot ==
[[Image:Screenshot-poc-moh@sam-desktop-_-opt-worldvista-poc-moh.png||Adding a new user]]

File:Vista-add-user1.png

2018-05-20T01:16:40Z

Shabiel: VistA add User part 1

VistA add User part 1

CPRS on Wine

2017-08-30T21:19:15Z

Shabiel:

You can run CPRS on Wine.

You first need to install Wine

Then run CPRS:

<pre>
wine CPRSChart.exe s=server_address p=port_number
</pre>

GNUParallel load and compile to GTM

2017-05-25T15:51:14Z

Shabiel: Created page with "[GNU Parallel https://www.gnu.org/software/parallel/] is used in the bio-informatics world to spread processing of data over several CPUs, on the same machine, or on spread ou..."

[GNU Parallel https://www.gnu.org/software/parallel/] is used in the bio-informatics world to spread processing of data over several CPUs, on the same machine, or on spread out machines using ssh.

I am using it here to compile routines and load globals.

To load routines (I got 44s vs 58s on 8 cpu machine):
<pre>
$ cd o
$ ls ../r/*.m | parallel mumps
</pre>

To load globals (i got 60s vs 149s on 8 cpu machine):
<pre>
$ find vxVistA-M-master/ -name '*.zwr' -print0 | parallel -q --null mupip load \"{}\"
</pre>

SHabiel Pages

2017-05-25T15:44:08Z

Shabiel: /* Other */

{|
|
== RPMS ==
[[RPMS_Installation|RPMS Installation on Cache]]

[[RPMS_PortInstallation_to_GTM|RPMS Port and Installation on GT.M]]

== Pharmacy ==
[[Pharmacy_Inpatient_Setup| Pharmacy: Inpatient Pharmacy Set-up]]

[[Pharmacy_AR/WS_Setup| Pharamcy: Ward Stock Set-up]]

[[Pharmacy_CS_Setup| Pharmacy: Controlled Substances Package Set-up]]

[[KIDS_Drug_File| Pharmacy: KIDS Drug File]]

[[Enter_A_Drug| Pharmacy: How to enter a drug in VISTA]]

[[NDC_Rules| Pharmacy: NDC Rules etc.]]

== Taskman ==
[[Taskman_Recurring_Tasks|Taskman Tasks]]

[[Debugging_Taskman_Tasks|Debugging Taskman Tasks]]

[[Taskman_Internals|Taskman Internals]]

== Sys Admin ==
[[Adding_Users|Adding new Users to VISTA]]

[[Transplant_Cleanup| Cleaning up a Transplanted RPMS or VISTA system]]

[[Setting_up_a_VISTA_Printer|Setting up a VISTA Printer]]

[[Setting_Up_Mailman_For_External_Email| Setting up Mailman for External Email]]

[[Basic_GTM_Journaling|Basic GT.M Journaling Instructions]]

[[VISTA_Auto_Signon|VISTA Automatic Sign-on]]

[[VISTA_Set-up_Outline| VISTA Set-up starting from scratch]]

[[VISTA_XWB_Broker_Troubleshooting| VISTA XWB Broker Troubleshooting]]

[[VISTA_System_Management_Daily_or_Weekly_Tasks | VISTA System Management Daily or Weekly Tasks]]

[[Set-up_Fileman_Browser_Device | Set up the Fileman Browser]]

== Lab ==
[[Lab_Brief_Setup|Sam tries to set up Lab]]

== CPRS ==
[[CPRS_Config:_Order_Checks| CPRS Configuration: Order Checks]]

[[CPRS_Config:_Notifications| CPRS Configuration: Notifications]]

[[CPRS_Config:_Turn_Off_HDR| Turn off Remote Data Order Checking]]

[[CPRS_on_Wine| Running CPRS on Linux via Wine]]

== Other ==
[[Patient_Merge|Patient Merge Set-up and Use in VISTA]]

[[TLS_Enable_VISTA_Service| TLS Enable a VISTA Service]]

[[Fileman_Internals| Fileman Internals]]

[[Dev_Copy| Copying devices from another environment]]

[[MFS_list| Master File Server controlled files]]

[[Terminal_Emulators | List of known issues with modern Terminal Emulators and VISTA]]

[[Bulk_rename_routines | Bulk of rename of Routines using Command Line tools]]

[[GNUParallel_load_and_compile_to_GTM | Use GNU Parallel to load and import a new database to GT.M]]

== Mumps Classes ==
* [[Mumps_Class_1|Class 1]] (Intro, History and Features of M)
* [[Mumps_Class_2|Class 2]] (Structure of Language, variables, etc)
* [[Mumps_Class_3|Class 3]] (Operators)
* [[Mumps_Class_4|Class 4]] (Strings and String Functions ($A, $C, $TR, $L, $P, $E, $F)
* [[Mumps_Class_5|Class 5]] (String pattern matching operator (?), Read, Write Set)
* [[Mumps_Class_6|Class 6]] (Read, Write, Set, Kill)
* [[Mumps_Class_7|Class 7]] (Do, If, $Test)
* [[Mumps_Class_8|Class 8]] (For loop)
* [[Mumps_Class_9|Class 9]] (Routine Walkthrough; debugging with native GT.M and TMGIDE)
* [[Mumps_Class_10|Class 10]] (Routine Walkthrough; $Reference and naked global references
* [[Mumps_Class_11|Class 11]] (Stack, Symbol Table, effect of Do and Goto; New)
* [[Mumps_Class_12|Class 12]] (Extrinsic Functions; passing parameters)
* [[Mumps_Class_13|Class 13]] ($Order and $Data)
* [[Mumps_Class_14|Class 14]] ($Query, $QS and $QL)
* [[Mumps_Class_15|Class 15]] (Indirection, Xecute, $Get, $Text)
* [[Mumps_Class_16|Class 16]] ($Text, $Name, $Random, $Reverse etc)
* [[Mumps_Class_17|Class 17]] (Locks)
* [[Mumps_Class_18|Class 18]] (Devices: Files, Null, Terminal, TCP)
* [[Mumps_Class_19|Class 19]] (Devices: Pipe; using ^%ZIS)
* [[Mumps_Class_20|Class 20]] (Job command; Transactions in Mumps)
* [[Mumps_Class_21|Class 21]] (Error Processing in Mumps)

== Fileman API Classes ==
* [[Fileman_API_Class_1|Class 1]] (Intro, ^DIR, ^DIC, ^%DT, ^%DTC, ^XLFDT)
* [[Fileman_API_Class_2|Class 2]] (EN^DDIOL, %RCR, EN1^DIP, ^DIE, ^DIK)

== Student Projects ==
* [[VISTA_Class_Student_Projects | Projects suitable for students learning VISTA]]

Setting up a VISTA Printer

2016-12-09T18:01:21Z

Shabiel: /* Setting Up a Printer in VISTA */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting Up a Printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer, to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Caché/Windows Printing ===
When you specify a printer name in $I, Caché/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Caché/Linux Printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== Caché IP Direct ===
Some cool way to do it, bypassing the operating system and talking directly to the printer.

<pre>
NAME: ZEBRA $I: |TCP|101092252
LOCATION OF TERMINAL: XXXX
OPEN PARAMETERS: ("10.10.10.1":9100:"+Q+C"):2
SUBTYPE: P-ZEBRA TYPE: TERMINAL
</pre>

=== GT.M/Linux Printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How Does Printing from VISTA Work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically changes IOs.

=== Avoiding the Staircase Effect When Printing from GT.M/Caché on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't include a carriage return, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking CUPS to handle the formatting (lpr without the -l option), CUPS properly formats the line returns through a CUPS filter, so you don't have to do anything.

=== Advanced Printing Topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

VISTA Advanced printing topics

2016-10-27T01:36:47Z

Shabiel: /* Printing PDFs from VISTA */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei."

__TOC__

== How do Computers Communicate with Printers, Software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters." Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commercial label printers (like Zebras) always accept their own programming language.

== VISTA and What It Really Sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations," or "supported languages." What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a Printer on the Network for the First Time ==
Nothing prevents you from using a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. Consult the printer manual to find out how to print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nothing in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>

and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>

An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting Up the Printer in the Operating System ==
After confirming the connection, you need to set up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting Up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]].

== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have to go through.

If you run this on Caché, Caché steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line. For example,

<pre>
U IO W "TEST",!,"TEST",! D ^%ZISC
</pre>

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various Troubleshooting Topics -- How Fun! ==
There are various issues that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra Pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended that this be disabled. To disable the extra page, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a Single Line Prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not Aligned Horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off or restart the printer, it tries to self calibrate.

==== Label Text is Not Dark Enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label Gets Cut Off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA Printed Labels are too Small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced Troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to change for Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Margin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

An example on Cache on Linux:

<pre>
NAME: GHOSTPCL PORTRAIT
$I: /home/lxuser/bin/gpcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=/opt/HFS/shabiel/print_out.pdf -
LOCATION OF TERMINAL: PDF to /opt/HFS
OPEN COUNT: 8 OPEN PARAMETERS: "qw"
POST-CLOSE EXECUTE: N % S %=$ZF(-1,"sh -c 'mv /opt/HFS/shabiel/print_out{,`date -Iseconds | tr \: _`}.pdf'") SUBTYPE: P-HPLASER-P12
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the Ready Status of a Print Queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
Or for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-04T20:41:51Z

Shabiel: /* Setting up a printer in VISTA */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei."

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters." Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commercial label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations," or "supported languages." What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from using a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]].

== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-04T20:40:44Z

Shabiel: /* VISTA and what it really sends */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei."

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters." Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commercial label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations," or "supported languages." What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from using a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a printer in VISTA ==
See [[Setting_Up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-04T20:39:40Z

Shabiel: /* Advanced Printing Topics */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei."

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters." Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commercial label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations;" or "supported languages." What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from using a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a printer in VISTA ==
See [[Setting_Up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

Setting up a VISTA Printer

2016-10-04T20:29:51Z

Shabiel: /* Setting up a printer in VISTA */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting Up a Printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer, to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Cache/Windows printing ===
When you specify a printer name in $I, Cache/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Cache/Linux printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== GT.M/Linux printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How does printing from VISTA work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically changes IOs.

=== Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't include a carriage return, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking Cups to handle the formatting (lpr without the -l option), Cups properly formats the line returns through a Cups filter, so you don't have to do anything.

=== Advanced printing topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

Setting up a VISTA Printer

2016-10-04T20:26:53Z

Shabiel: /* Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting up a printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer, to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Cache/Windows printing ===
When you specify a printer name in $I, Cache/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Cache/Linux printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== GT.M/Linux printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How does printing from VISTA work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically changes IOs.

=== Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't include a carriage return, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking Cups to handle the formatting (lpr without the -l option), Cups properly formats the line returns through a Cups filter, so you don't have to do anything.

=== Advanced printing topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

Setting up a VISTA Printer

2016-10-04T20:23:07Z

Shabiel: /* How does printing from VISTA work? */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting up a printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer, to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Cache/Windows printing ===
When you specify a printer name in $I, Cache/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Cache/Linux printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== GT.M/Linux printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How does printing from VISTA work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically changes IOs.

=== Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't do a carriage return with it, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking cups to handle the formatting (lpr without the -l option), cups properly formats the line returns through a cups filter, so you don't have to do anything.

=== Advanced printing topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

Setting up a VISTA Printer

2016-10-04T20:21:37Z

Shabiel: /* Setting up a printer in VISTA */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting up a printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer, to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Cache/Windows printing ===
When you specify a printer name in $I, Cache/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Cache/Linux printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== GT.M/Linux printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How does printing from VISTA work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically change IOs.

=== Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't do a carriage return with it, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking cups to handle the formatting (lpr without the -l option), cups properly formats the line returns through a cups filter, so you don't have to do anything.

=== Advanced printing topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

Setting up a VISTA Printer

2016-10-04T19:29:47Z

Shabiel: /* Setting up a printer in VISTA */

Back to [[Programming VistA Issues]]
__TOC__

This is an updated page. See [[Setting_up_a_Linux_Printer_Old|this page]] for old content.

== Setting up a printer in VISTA ==
In order to set-up a printer in VISTA, there are three steps:

* Add printer to CUPS or to Windows Printer list. The printers may be on remote servers, as long as the VISTA machine can access them.
* In VISTA, you need to create an entry that represents the printer formatting characteristics in the terminal type file (#3.2)
* Then you need to create an entry in the device file (#3.5) that corresponds to the printer

In practice, you don't need to do the second step because there are only about 5 commonly used subtypes in VISTA which you reuse.

A Subtype is a file entry that contains the code to send to the printer to open the printer, reset the printer, select the page size, adjust the margins, select the font etc.

=== Subtypes ===

Information about subtypes, including the most common subtypes, is listed [[VISTA_Printing_Printer_Subtypes|here]].

=== Cache/Windows printing ===
When you specify a printer name in $I, Cache/Windows sends raw input directly to the printer, bypassing the driver. This makes setting up a printer on Windows easy:

<pre>
NAME: BROTHER $I: |PRN|\\VXQA\HL2270DW
LOCATION OF TERMINAL: QA SUBTYPE: P-HP-LASER
TYPE: TERMINAL
</pre>

As you can see, all you have to do is put the printer name after |PRN| in $I. You can specify local printers; or you can specify shared printers using a UNC path (as shown above).

=== Cache/Linux printing ===
You can use Pipes in Cache to print on Linux/Unix. Here's an operative example. Based on my experience, this is the best way to do it.

<pre>
NAME: SAM'S PHARMACY PRINTER $I: /usr/bin/lpr -PSAN_FL6 -l
OPEN PARAMETERS: "QW" SUBTYPE: P-HPLJ4SI-P12
TYPE: TERMINAL
</pre>

Please note that there is a bug in DEVOK^%ZOSV (ZOSVONT) that prevents it from checking the device properly. This will show up if you misconfigure a device and then use it in Taskman. Short of fixing this, here is how to remove the bad prints from Taskman:

<pre>
S (DEV,ZTIME,ZTSK)="" F S DEV=$O(^%ZTSCH("IO",DEV)) Q:DEV="" F S ZTIME=$O(^%ZTSCH("IO",DEV,ZTIME)) Q:'ZTIME F S ZTSK=$O(^%ZTSCH("IO",DEV,ZTIME,ZTSK)) Q:'ZTSK D DQ^%ZTLOAD
</pre>

You can also use the method developed but not adopted by the VA in patch [http://foia-vista.osehra.org/Patches_By_Application/XU-KERNEL/XU-8_SEQ-485_PAT-585.TXT XU*8.0*585]. After attempting to use this method in production, I would recommend against it, because a. CPRS and BCMA code is not configured to pick up PQ devices and b. %ZISC has issues with PQ devices. I have fixed both of these issues; but the code for this is not in VISTA yet.

Here's a sample device that uses the XU*8.0*585 method:

<pre>
NAME: PRINTER_NAME $I: PRINTER_NAME
PURGE OLD PRINT QUEUE FILES: YES LOCATION OF TERMINAL: Cups Device
SUBTYPE: P-HP-LTR-POR-C17L7-W128-NOFF TYPE: PRINT QUEUE
</pre>

=== GT.M/Linux printing ===
Pipes again; just like Cache.

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
NAME: PHAR-IP-DM $I: PHAR-IP-DM
LOCATION OF TERMINAL: Inpatient Pharmacy Dot-Matrix
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -l -P PHAR-IP-DM 2>/dev/null":WRITEONLY)::"pipe"
SUBTYPE: P-EPSON-DM-P15-5L
TYPE: TERMINAL

NAME: PHAR-IP-LS $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Landscape
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
SUBTYPE: P-HPLJ4SI-P13-LS
TYPE: TERMINAL

NAME: PHAR-IP-POR-P12 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (PL)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: PL
SUBTYPE: P-HPLJ4SI-P12 TYPE: TERMINAL

NAME: PHAR-IP-POR-P16 $I: PHAR-IP
LOCATION OF TERMINAL: Inpatient Pharmacy Portrait (MAR)
OPEN PARAMETERS: (shell="/bin/sh":comm="lpr -P PHAR-IP -l":WRITEONLY)::"pipe"
MNEMONIC: MAR
SUBTYPE: P-HPLJ2-P16 TYPE: TERMINAL
</pre>

=== How does printing from VISTA work? ===
How does this work?
The way this works is that $I becomes the IO variable. The open
parameters tells VISTA how to open the device.

Vista does this:
<pre>
S IO=[$I]
S param=[OPEN PARAMETERS]
O IO:param
U IO
Send Open Execute from Subtype
U IO(0)
Interact with user; open another job, etc...
U IO
write write write
Send Close Execute from Subtype
C IO
etc.
</pre>

No need to do pre-open and post-close executes on the device which dynamically change IOs.

=== Avoiding the Staircase effect when printing from GT.M/Cache on *Nix with Laser Printers ===
For an explanation of the Staircase effect, see this:
http://www.digitalissues.co.uk/html/os/unix/stair.html

Basically, the new line doesn't do a carriage return with it, so our output just flows off the page. So when you print a 10 line document, you may only see one line, as the rest was printed outside of the margin.

If you are sending raw output (lpr with the -l option) from VISTA to any PCL compatible printer (and VISTA by and large uses PCL for formatting plain text output), you need to add this to your open execute:

<pre style="padding:1em;border:1px dashed #2f6fab;color:black;background-color:#f9f9f9;line-height:1.1em">
W $C(27),"&k2G"
</pre>

This tells the PCL compatible printer to append a CR to each LF or FF.

On the other hand, if you are asking cups to handle the formatting (lpr without the -l option), cups properly formats the line returns through a cups filter, so you don't have to do anything.

=== Advanced printing topics ===
[[VISTA_Advanced_printing_topics|Advanced printing topics]]

VISTA Advanced printing topics

2016-10-03T23:59:16Z

Shabiel: /* Advanced Functions */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:58:52Z

Shabiel: /* Printing PDFs from VISTA */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:58:35Z

Shabiel: /* Advanced troubleshooting */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute. Please note that you need to change "NWS" to (newversion) on GT.M.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:56:31Z

Shabiel:

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

=== Advanced troubleshooting ===
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF; or ZPL II and use a Zebra emulator.

To capture an output from VISTA, you need to create a device whose type is HFS but whose destination is pre-determined. Here's an example:

<pre>
NAME: SAM-DIRECT-HFS-PRINTER $I: /tmp/op-dev6-lbl-sam.pcl
LOCATION OF TERMINAL: File
OPEN PARAMETERS: "NWS" SUBTYPE: P-HPLJ4SI-P12
TYPE: HOST FILE SERVER
</pre>

If you want to change the file for each job, so that they won't overwrite each other, you can append something to IO in the pre-open execute.

This is the emulator I use for PCL, http://www.ghostscript.com/GhostPCL.html.
This is the emulator I use for ZPL II, http://labelary.com/viewer.html

To use GhostPCL, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:45:52Z

Shabiel: /* Zebra Printer Issues */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:45:31Z

Shabiel: /* Various troubleshooting topics -- how fun! */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

==== Only a single line prints ====
You are seeing the staircase effect. See the Staircase section in [[Setting_up_a_VISTA_Printer]].

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:43:15Z

Shabiel: /* Various troubleshooting topics -- how fun! */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

=== Laser Printer Issues ===
Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

==== Extra pages ====
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

==== Wrapping ====
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

=== Zebra Printer Issues ===
From my memory, these are typically the issues you face:

* Label not aligned vertically
* Label not aligned horizontally
* Labels are not dark enough.
* Label gets cut off
* VISTA printed labels are too small

==== Label not aligned vertically ====
Zebras mostly auto calibrate printing on continuous media. Check your Zebra's manual on how to do that for the specific model.

==== Label not aligned horizontally ====
Zebras don't auto align to the width. You have to set the print width yourself. They can detect the start of the label though.

To do that, find your printer dpi setting, and multiply that by the width of your label. E.g. 202 dpi with 3.5", you need to run this command from the command line:
<pre>
^XA^PW707^XZ
</pre>

If that doesn't solve your problem, you need to look carefully at the actual feeding of the label into the zebra printer. Read the manual carefully. I have seen many people "wing it" and do it incorrectly. I have even seen a printer where the left margin guide wasn't used and a rubber band was placed there. After you turn off the restart the printer, it tries to self calibrate.

==== Label Text is not dark enough ====
There are two tunable circle things on the top of the print head that can be turned to increase the darkness. Try that. There is also a Zebra setting that can be changed to increase the darkness.

==== Label gets cut off ====
If the label gets cut off on the right hand side of the label, check your print width (see 'Label not aligned horizontally'), and if that's not the issue, check the position of the ribbon vis a vis the labels. The printer may be trying to print, but there is no ribbon at the place it's trying to print. If it is getting cut off from the left side, check that your labels are using the left hand guide and are not colliding with it. If it is getting cut off vertically, you need to calibrate the printer. If it still gets cut off, you need to capture the ZPL II that is sent by VISTA and see 1. that it's formatted correctly and 2. that there isn't too much information to print.

==== VISTA printed labels are too small ====
This means that you bought a Zebra printer with the wrong dpi. You have to return it and buy another one. VISTA wants printers with 202 DPI. If you want to use the new printer, you need to re-write some of the label code.

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:13:42Z

Shabiel: /* Testing Printers */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

If you run this on Cache, Cache steals your IO device between prompts. Therefore U IO to D ^%ZISC need to be on a single line.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

=== Extra pages ===
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

=== Wrapping ===
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:04:54Z

Shabiel: /* Testing Printers */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Setting up a Printer in VISTA ==
See [[Setting_up_a_VISTA_Printer|this page]]
== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

=== Extra pages ===
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

=== Wrapping ===
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T23:01:49Z

Shabiel: /* Communicating with a printer on the network for the first time */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>
An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Setting up the printer in the operating system ==
After confirming the connection, you need to set-up the printer in the operating system. VISTA does NOT need any drivers for the printers to be installed.

== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

=== Extra pages ===
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

=== Wrapping ===
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T22:56:28Z

Shabiel: /* Communicating with a printer on the network for the first time */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Nothing prevents you from doing a USB printer or even a parallel port printer, but in my experience, nobody uses those interfaces in production anymore.

Get the IP address first. You can usually obtain that by printing an information sheet from the printer. You have to consult the printer manual to find out where you can print that information sheet. You can also try to identify the printer from the list of connected hosts on your network.

Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

A successful connection will look like this:
<pre>
Connection to XX.XX.XX.XX 9100 port [tcp/jetdirect] succeeded!
</pre>

An unsuccessful connection will either just hang or tell you connection refused.
<pre>
nc: connect to XXXXXXXXX port 9100 (tcp) failed: Connection refused
</pre>

== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

=== Extra pages ===
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

=== Wrapping ===
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Advanced printing topics

2016-10-03T21:46:44Z

Shabiel: /* Advanced Printing Topics */

= Advanced Printing Topics =
Authored mainly by Sam Habiel, the printer "sensei".

__TOC__

== How do computers communicate with printers, software-wise? ==
This is a pretty difficult topic. Cheaper printers only accept binary data that is hardcoded by the computers; typically these printers are only supported on Windows, and thus are named "Winprinters". Higher end printers have a processor on them that can typically interpret PCL5, PCL6, and PS; and possibly PDF. These printers are easily supported in Linux. Commerical label printers (like Zebras) always accept their own programming language.

== VISTA and what it really sends ==
VISTA sends PCL5 to laser printers; or a printer specific language for label printers--most commonly ZPL II for Zebra printers. For laser printers, you need to make sure that your printer supports PCL5. All HP Printers support PCL5, no matter how cheap; other manufacturers only support it on their higher end printers (not too high end--anything that isn't the cheapest printer may support PCL5). If you need to look it up, go to the manufacturer's website and look at the technical specs sheet. The section is typically called "supported emulations"; or "supported languages". What VISTA sends is determined by the sub-type defined for the device.

== Communicating with a printer on the network for the first time ==
Whenever I set up a new printer, I tend to ensure that I can talk to it directly, with nobody in the middle. I use the netcat command ('nc') to do that, connecting to the IP address of the printer (obtained by printing the information sheet from the printer) on port 9100. Make sure to add the -v flag to netcat so that it can report whether it succeeded in connecting at all. It is very possible that you connected to a printer; but you just don't know which one.

(Aside: This can be done from VISTA using D CALL^%ZISTCP(ip_address,port,time_out)--but netcat is easier.)

Here's an example of me trying to talk to a PCL printer, so it will print the word "test"
<pre>
$ nc -v 10.10.10.128 9100 <<< "TEST"
</pre>
and here's an example printing a Datamatrix code on a Zebra printer:
<pre>
$ nc -v 10.10.10.128 9100 <<< "^XA^FO50,100^BXN,10,200^FDTESTTEST^FS^XZ
</pre>

== Testing Printers ==
To test printers in VISTA after setting it up, there are a few steps you have a to go through.

Invoke via %ZIS first.

<pre>
D ^%ZIS

DEVICE: HOME//MY PRINTER

U IO

W "TEST",!,"TEST",! D ^%ZISC
</pre>

See the output. If it's okay, you are ready to move to the next step. If you see the "staircase" effect, you need to go back and set-up the terminal type correctly [[Setting_up_a_Linux_Printer|here]].

The next menu option to try is Send Test Pattern to Terminal [XUTTEST]. If that works, then you are good to go.

== Various troubleshooting topics -- how fun! ==
There are various issue that come up regularly with VISTA.

Use this page as a reference for PCL:

http://www.pclviewer.com/resources/reference/

=== Extra pages ===
Extra pages can happen for three different reasons:

* By default, VISTA prints an extra page after each print job. This is for historical reasons; as most of the early printers were dot-matrix. Today, it's recommended to disable this. To disable this, you can do it at the device level or the terminal type level. At the device level, set <code>SUPPRESS FORM FEED AT CLOSE</code> to yes. For the terminal type, set <code>CLOSE EXECUTE</code> to <code>S IONOFF="" W $C(27)_"E"</code>
* The text doesn't fit the page and spills over to the next page. VISTA printing options must follow the IOSL value (Page Length in Terminal Type or Device--Device overrides Terminal Type). Most of the time this has to do with the fact that the text size for the report is too large; or that the margins are not appropriate. Based on visual inspection, you should decide what to do. The unlikely case is that the VISTA programmer is not obeying IOSL; but that is for you to determine.
* If both of the above fail, it's likely that VISTA sends a hard coded form feed to the printer. You need to capture the output by capturing the print to a file (use HFS;subtype) and visually examine it in a programming editor.

=== Wrapping ===
Typically this has to do with whether the printer is configured to take 132 characters or 80 characters; if not, then it has to do with the font size.

VISTA has these typical formats for printing:

* 12 cpi 8 lpi Portrait (most reports)
* 17 cpi 7 lpi Portrait (MAR)
* 14 cpi 6 lpi Landscape (132 wide reports)
* 22 cpi 12 lpi Landscape (228 wide reports)

== Typical PCL String ==
To construct a PCL in VISTA, you typically put everything in the Open Execute. The Close Execute should always be set to <code>S IONOFF="" W $C(27)_"E"</code> unless you want to do something special. The Form Feed accepts PCL as well.

The typical PCL sequence for an Open Execute is as follows:

* Reset
* Set Line Carriage mode (CR, CRLF, or LF)
* Set Orientation (Portrait or Landscape)
* Set Character Set (optional; not needed for US printing; may need to Spanish)
* Set Margins (optional; but you will probably need it at some point)
* Set Font

When constructing a string, I recommend using *27 rather than $C(27) because it's shorter, and you will type a lot of it.

An example. Note that this needs to be all in one string. It's separated here for education.
<pre>
W *27,"E" ; Reset
W *27,"&k2G" ; Set Carriage mode to LF.
W *27,"&l0O" ; Portrait; Landscape is 1O.
... ; Character Set Omitted
W *27,"&l4E" ; Top Margin 4 lines
W *27,"&a5L" ; Left Martin 5 columns
W *27,"(s0p12h0s0b4099T" ; Fixed Pitch; 12 cpi, fixed pitch for secondary font, Medium Weight, select courier font.
</pre>

== Advanced Functions ==
I won't document this in detail, but here are some advanced examples. These ones do headers.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80-HD RIGHT MARGIN: 80
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p12h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 58
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"&l4E",$C(27),"&a5
L",$C(27),"&k2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2100x,0Y",$C(27)_"(s1p16h
0s0b16602THEADER",$C(27),"(s0p12h0s0b4099T",$C(27),"&l4E",$C(27),"&f1S" S ($X,$
Y)=0 CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

<pre>
NAME: P-HP-LTR-POR-C17L7-W128-HD RIGHT MARGIN: 128
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2100x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p17h9v0s0b0T"_$C(27)_"&l4E"_$C(27)_"&l7C"_$C(27
)_"&f1S"_$P("#","") PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l4E",$C(27),"&f0S",$C(27),"&l3E",$C(2
7),"*p2100x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",*27,"&l4E",*27,"&f1S",$C(27),"
(s0p17h9v0s0b0T",*27,"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27,69)
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C22L12-W228-HD RIGHT MARGIN: 228
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p22h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p22h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

<pre>
NAME: P-HP-LTR-LAND-C14L6-W132-HD RIGHT MARGIN: 132
FORM FEED: $C(12)_$C(27)_"&f0S"_$C(27)_"&l3E"_$C(27)_"*p2750x,0Y"_$C(27)_"(s1p
16h0s0b16602THEADER"_$C(27)_"(s0p14h0s0b4099T"_$C(27)_"&l4E"_$C(27)_"&f1S"_$P("
#","") PAGE LENGTH: 46
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&a5L",$C(27),"&k
2G",$C(27),"&f0S",$C(27),"&l3E",$C(27),"*p2750x,0Y",$C(27)_"(s1p16h0s0b16602THEADER",$C(27),"(s0p14h0s0b4099T",$C(27),"&f1S",$C(27),"&l4E" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer
</pre>

and this one does a watermark:

<pre>
NAME: P-HP-PORTRAIT-C16L7-WM SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96
FORM FEED: $c(27)_"*c5760x6000Y"_$c(27)_"*p150x150Y"_$c(27)_"*c0T"_$c(27)_"%1B
IN;SP1;DI1,-1;SD2,1,4,140,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"_$c
(3,27)_"%1A"_$c(12) PAGE LENGTH: 60
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"(8U",*27,"(s0P",*27,"(s16H",*27,"(s9V",*27,"(s0S"
,*27,"(s-3B",*27,"(s0T",*27,"&l88P",*27,"&a255M",*27,"&k2S",*27,"&l7C",*27,"&s1C
",*27,"&k2G"
CLOSE EXECUTE: W *27,"*c5760x6000Y",*27,"*p150x150Y",*27,"*c0T",*27,"%1B","IN;
SP1;DI1,-1;SD1,21,2,1,4,140,5,0,6,3,7,4148;SS;PA0,7000;FT10,5;CF2,0;LO21;LBWATERMARK"
_$C(3),*27,"%1A" DESCRIPTION: HP JL4Si 12 pitch Courier
</pre>

== Advanced troubleshooting ==
If you are stuck with a particularly difficult problem, it may be useful to capture the PCL and use a PCL emulator and print to a PDF.

This is the emulator I use, http://www.ghostscript.com/GhostPCL.html.

To use it, here is a sample invocation:

<pre>
cat vista_print-0001.pcl | sed -e "s/\x1b\[H\x1b\[J/\xc/g" | C:\Users\shabiel\workspace\ghostpcl-9.15-win32\pcl6-9.15-win32.exe -dBATCH -dSAFER -dNOPAUSE -sDEVICE=pdfwrite -r600 -sOutputFile="testpdf.sam" -
</pre>

You don't need the sed part typically; I added this for interpretation of slave prints.

== Printing PDFs from VISTA ==
Using GhostPCL, you can directly print out a PDF from VISTA. Here's an example in GT.M on Linux:

<pre>
NAME: PDF WRITER $I: PDF-WRITER
LOCATION OF TERMINAL: /tmp/
OPEN PARAMETERS: (comm="pcl6 -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -SOutputFile=
/tmp/green-sheet.pdf -")::"pipe" SUBTYPE: P-HP BARCODER
TYPE: TERMINAL
</pre>

On Windows, you can add a Windows printer that automatically calls GhostPCL. You need to use this amazing piece of software:

http://sourceforge.net/projects/mfilemon/

Once you install it and configure it, you need to set the $I appropriately.

== Finding the TCP/IP address for a print queue name ==
On Linux, the lpstat command tells you details about the print queue
<pre>
$ lpstat -v

device for TEST-01: socket://192.168.10.3:9100

device for TEST-02: socket://192.168.10.4:9100
</pre>

== Finding the ready status of a print queue ==

On Linux, the lpstat command tells you all the printers and what their status is.
<pre>
$ lpstat -a

TEST-01 accepting requests since Sun 25 Dec 2005 09:54:34 AM EST

TEST-02 accepting requests since Thu 28 Nov 2013 09:56:11 AM EST

TEST-03 accepting requests since Fri 17 Mar 2017 10:03:00 AM EST
</pre>
OR for a particular printer:
<pre>
$ lpstat -p TEST-03

printer TEST-03 is idle. enabled since Fri 17 Mar 2017 08:39:00 AM EDT
Ready to print.
</pre>

VISTA Printing Printer Subtypes

2016-10-03T21:35:35Z

Shabiel: /* ZPL II Commands */

= VISTA Subtypes =
''Written by Sam Habiel''
__TOC__

== What is a Subtype ==
A subtype (stored in file #3.2 TERMINAL TYPE) is an entry associated with each device that tells the device how to handle special non-standard situations; plus some base characteristics. With printers, typically a subtype has two fields populated: Open Execute and Close Execute, in addition to Right Margin, Form Feed, Page Length, and Back Space. The Open Execute resets the printer, sets the page orientation, sets the top and left margins, and sets the font size. The close execute sets the variable IONOFF to an empty string (effectively defining it in the symbol table), and sends a reset to the printer. Right Margin and Back Space aren't used with printers; Form Feed goes into the M variable IOF, Page Length goes into the M variable IOSL ("IO Screen Length") determines how many lines are to be printed on each page before VISTA sends an IOF to go to the next page. That's important to keep in mind since the number of lines that VISTA prints needs to match how many lines are available on the page, otherwise the printer will either spit an extra page containing the extra lines or it will clip the output, depending on whether you specified how many lines are to be printed in PCL. The subtypes below don't specify how many lines to print, so the former behavior will happen with them. The solution is to decrease page length.

The reason IONOFF is needed is that by default VISTA will send an extra page following each print out; because it was developed in the days of dot-matrix printers, where the extra page separated jobs. The days of dot-matrix printing are practically over; most printers used today are inkjet or laser. Typically we don't want an extra page at the end. You may be lead to believe that IONOFF is enough; however, most reports in VISTA have hardcoded extra pages at the beginning or end. I was told there was going to be a project in the late 90's to make sure all reports relied on the device handler for printing separator pages, but that never happened.

There is a field in the device file called "SUPPRESS FORM FEED AT CLOSE". This field does the exact same thing as setting IONOFF in the Close Execute in the terminal type. In general, I recommend setting IONOFF in the terminal type rather than filling SUPPRESS FORM FEED AT CLOSE for every single printer you configure.

The same extra page issues apply to Zebra printers as well, except over there they may manifest as extra labels if IOF is configured to send a label feed command (^PH or ~PH). If IOF is configured to be a '#', it will have no effect on the Zebra printer.

== How to specify a Subtype? ==
Normally, subtypes are configured once per device. When you set up a printer in the DEVICE file, you populate the subtype in the subtype field.

However, you can override subtype selection on a job basis, by using this syntax on the Device prompt:

<pre>
DEVICE: printer_name;subtype
</pre>

If you type partial matches, the device driver (^%ZIS) is going to list for you all partial matches for you to choose form. That's pretty nice since I never remember what subtypes I have beyond them having P-HP at the beginning.

There are variations on this syntax, by the way, that don't have to do with subtypes:

<pre>
1. DEVICE: printer_name;right margin;page length
2. DEVICE: printer_name;subtype;right margin; page length
2. DEVICE: ;right margin;page length
3. DEVICE: ;;page length
</pre>

As you can see, you can specify custom margins and page lengths. You need to remember that aside from terminal emulators, margins have no effect, as VISTA does not test for them when printing. It does really care about the page length though (see discussion about IOSL above). If a printer name isn't specified, the home device is assumed.

Novice power users type ';;99999' to print a report without page breaks on the terminal emulator, without understanding what it means. The variations above should tell you: print to the home device to an infinite length. Of note, $Y on Cache wraps at the unsigned int16 limit (32767); therefore, testing if $Y is greater than IOSL when IOSL is greater than 32767 (in my last example, it's 99999) will always return false, causing page breaks to never be issued. As far as I know, GT.M does not wrap $Y, so you may have to give it gigantic page lengths; although, in practice, I don't remember having encountered that problem. It's possible there is something in ^%ZIS4 that I missed regarding that.

== Common Subtypes in VISTA ==
Here are the most common subtypes in VISTA (standardized for Unices; you will need to remove $C(27),"&k2G" on Windows Servers):

NB: CPI = Characters Per Inch; LPI = Lines Per Inch
=== PCL Subtypes ===
==== PCL5 Quick Reference ====
<pre>
*27,"E"/$C(27,69) - Reset
*27,"&l0O" - Portrait / *27,"&l1O" - Landscape
*27,"&l3E" - Top Margin is 3 lines
*27,"&a5L" - Left Margin is 5 columns
*27,"&k2G" - Line endings are LF. Default Line endings are CRLF (unless overridden in printer settings).
*27,"(s0p12h0s0b4099T" - Primary '(s' font is fixed pitch, 12 cpi, upright (not italic), not bold, and is the Courier Font (#4099).
</pre>

==== Portrait Letter 12 CPI 6 LPI ====
This is THE MOST COMMON subtype to use. Most reports in VISTA print on this one.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 56
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&
k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Landscape Letter 14 CPI 6 LPI ====
This is the second most common subtype. Any menu option that says it needs 132 characters will need to use this subtype.
<pre>
NAME: P-HP-LTR-LAND-C14L6-W132 RIGHT MARGIN: 132
FORM FEED: # PAGE LENGTH: 45
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&k
2G",*27,"(s0p14h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer

</pre>

==== Portrait Letter 17 CPI 7 LPI (MARs and BCMA Med Log) ====
This is the (theoretically) third most commonly used subtype. It's only used for specific reports. It's also known as a condensed print subtype.
<pre>
NAME: P-HP-LTR-POR-C17L7-W128 RIGHT MARGIN: 128
FORM FEED: # PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l3E",$C(27),"(s0p17h9v0s0b4099T",*27,
"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

==== Portrait Landscape Letter 22 CPI 12 LPI ====
This is the subtype that will take the most amount of text; it's ideal to print a lot of data from Fileman, for example. It's also known as the condensed landscape print subtype. It's not commonly used except by Fileman power users.
<pre>
NAME: P-HP-LTR-LAND-C22L12-W228 RIGHT MARGIN: 228
FORM FEED: # PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",*27,"(s0p22h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

==== Portrait Legal 12 CPI 6 LPI ====
This is not commonly used; I just created this because I thought it may it come in useful for some users.
<pre>
NAME: P-HP-LGL-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 74
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l3A",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&
a5L",$C(27),"&k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Greensheet ====
If you don't know what a green sheet is, then skip this. It's here for those who want it. You need to buy a barcode chip in order for the barcodes to print.

<pre>
NAME: P-HP-LTR-POR-GREENSHEET RIGHT MARGIN: 100
FORM FEED: # PAGE LENGTH: 58
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l0O",*27,"&l4H",*27,"&l1E",*27,"(s0p"
_$S($G(PSDCPI)=10:"10h14",1:"12h12")_"v0s0b6T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
10 PITCH: $C(27)_"(s10H" 12 PITCH: $C(27)_"(s12H"
DESCRIPTION: HP JL4Si 12 pitch Courier
DEFAULT LINES PER INCH: $C(27)_"&l8C"
X LINES PER INCH: $C(27)_"&l12C"
BAR CODE OFF: "*"_$C(27)_"&l0O"_$C(27)_"(8U"_$C(27)_"(s0p"_$S($G(PSDCPI)=10:"1
0h14",1:"12h12")_"v0s0b6T"
BAR CODE ON: $S($D(PSDX2):$C(27)_"*p"_(PSDX2-1*300+200)_"y*p"_(PSDX1-1*810+38)
_"X",1:"")_$C(27)_"(0Y"_$C(27)_"(s0p8.1h12v0s0b0T*"
</pre>

==== Pharmacy Outpatient Label Printer ====
This one is a bit specialized. This is normally set-up by running routines (in this sequence) ^PSOLLU2, ^PSOLLU3, ^PSOLLU4. You need to buy a barcode chip in order for the barcodes to print.
<pre>
NAME: P-HPLJ4SI-P12 SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96 FORM FEED: #
PAGE LENGTH: 57 BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"(s0p12h0s0b4099T"
W $C(27),"&k2G" S $X=0 DESCRIPTION: HP JL4Si 12 pitch Courier
NUMBER: 1 CTRL CODE ABBREVIATION: ACI
FULL NAME: ADDRESS CHANGE INITIALIZATION
CONTROL CODE: S PSOHFONT="F12",PSOX=1210,PSOY=700,PSOFY=1270
NUMBER: 2 CTRL CODE ABBREVIATION: ALI
FULL NAME: ALLERGY SECTION INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=1350,PSOYI=50,PSOYM=2700
NUMBER: 3 CTRL CODE ABBREVIATION: AWI
FULL NAME: ALLERGY WARNING INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 4 CTRL CODE ABBREVIATION: BLB
FULL NAME: BOTTLE LABEL BODY INITIALIZATION
CONTROL CODE: S PSOX=0,PSODX=275,PSOY=140,PSOYI=40,PSOYM=379,PSOFONT="F10"
NUMBER: 5 CTRL CODE ABBREVIATION: BLBC
FULL NAME: BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(s1p10.4v4,12b4,12s24670T",$C(27),"&a90P",$C(27),"*p36
50x1000Y"
NUMBER: 6 CTRL CODE ABBREVIATION: BLF
FULL NAME: BOTTLE LABEL FOOTER INITIALIZATION
CONTROL CODE: S PSODY=460,PSOX=0,PSOCX=280,PSOQY=550,PSOTY=600,PSOFONT="F10",P
SOQFONT="F8",PSODFONT="F9",PSOTFONT="F10"
NUMBER: 7 CTRL CODE ABBREVIATION: BLH
FULL NAME: BOTTLE LABEL HEADER INITIALIZATION
CONTROL CODE: S PSOX=100,PSOY=50,PSOYI=30,PSOFONT="F9"
NUMBER: 8 CTRL CODE ABBREVIATION: CDII
FULL NAME: CRITICAL DRUG INTERACTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 9 CTRL CODE ABBREVIATION: CNI
FULL NAME: COPAY NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOX=1210,PSOYM=3950,PSOFONT="F10",PSOYI=50
NUMBER: 10 CTRL CODE ABBREVIATION: EBLBC
FULL NAME: END OF BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T",$C(27),"&a0P",!
NUMBER: 11 CTRL CODE ABBREVIATION: EBT
FULL NAME: END OF BARCODE TEXT
CONTROL CODE: W $C(27),"(8U",$C(27),"(s1p8v0s0b16602T",!
NUMBER: 12 CTRL CODE ABBREVIATION: F10
FULL NAME: TEN POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T"
NUMBER: 13 CTRL CODE ABBREVIATION: F10B
FULL NAME: TEN POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s3b16602T"
NUMBER: 14 CTRL CODE ABBREVIATION: F12
FULL NAME: TWELVE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s0b16602T"
NUMBER: 15 CTRL CODE ABBREVIATION: F12B
FULL NAME: 12 POINT FONT BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s3b16602T"
NUMBER: 16 CTRL CODE ABBREVIATION: F6
FULL NAME: SIX POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s0b16602T"
NUMBER: 17 CTRL CODE ABBREVIATION: F6B
FULL NAME: SIX POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s3b16602T"
NUMBER: 18 CTRL CODE ABBREVIATION: F8
FULL NAME: EIGHT POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s0b16602T"
NUMBER: 19 CTRL CODE ABBREVIATION: F8B
FULL NAME: EIGHT POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s3b16602T"
NUMBER: 20 CTRL CODE ABBREVIATION: F9
FULL NAME: NINE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s0b16602T"
NUMBER: 21 CTRL CODE ABBREVIATION: F9B
FULL NAME: NINE POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s3b16602T"
NUMBER: 22 CTRL CODE ABBREVIATION: FDU
FULL NAME: FONT DISABLE UNDERLINE CONTROL CODE: W $C(27),"&d@"
NUMBER: 23 CTRL CODE ABBREVIATION: FWU
FULL NAME: FONT WITH UNDERLINE CONTROL CODE: W $C(27),"&d0D"
NUMBER: 24 CTRL CODE ABBREVIATION: LL
FULL NAME: LASER LABEL CONTROL CODE: Q
NUMBER: 25 CTRL CODE ABBREVIATION: LLI
FULL NAME: LASER LABEL INIT
CONTROL CODE: W $C(27),"&r1F",$C(27),"E",$C(27),"&l0O",$C(27),"&u300D",$C(27),
"&l3A",$C(27),"&l0E",!
NUMBER: 26 CTRL CODE ABBREVIATION: MLI
FULL NAME: MAILING LABEL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1680,PSOY=175,PSOYI=50
NUMBER: 27 CTRL CODE ABBREVIATION: NR
FULL NAME: NORMAL ROTATION CONTROL CODE: W $C(27),"&a0P"
NUMBER: 28 CTRL CODE ABBREVIATION: PFDI
FULL NAME: PHARMACY FILL DOCUMENT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=690,PSOYI=40,PSOYM=969
NUMBER: 29 CTRL CODE ABBREVIATION: PFDQ
FULL NAME: PHARMACY FILL DOCUMENT QUANTITY
CONTROL CODE: S PSOX=0,PSOCX=200,PSOY=970,PSOYI=50,PSOQFONT="F8",PSOFONT="F10"
NUMBER: 30 CTRL CODE ABBREVIATION: PFDT
FULL NAME: PHARMACY FILL DOCUMENT TRAILER
CONTROL CODE: S PSOY=1015,PSOYI=45,PSOX=0,PSOFONT="F10",PSOBYI=50,PSOTFONT="F9
",PSOBY=1280
NUMBER: 31 CTRL CODE ABBREVIATION: PFDW
FULL NAME: PHARMACY FILL DOCUMENT WARNING
CONTROL CODE: S PSOY=1258,PSOX=660,PSOYI=30,PSOFONT="F8",PSOYM=1329
NUMBER: 32 CTRL CODE ABBREVIATION: PFI
FULL NAME: PATIENT FILL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=710,PSOYI=45,PSOHFONT="F12",PSOBY
I=100
NUMBER: 33 CTRL CODE ABBREVIATION: PII
FULL NAME: PATIENT INSTRUCTION INITIALIZATION
CONTROL CODE: S PSOX=1210,PSOY=760,PSOFONT="F12"
NUMBER: 34 CTRL CODE ABBREVIATION: PMII
FULL NAME: PMI SECTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1350,PSOYI=50,PSOFONT="F10",PSOYM=3899
NUMBER: 35 CTRL CODE ABBREVIATION: RMI
FULL NAME: RETURN MAIL INITIALIZATION
CONTROL CODE: S PSOHFONT="F8",PSOFONT="F10",PSOX=1680,PSOY=35,PSORYI=40,PSOHYI
=40,PSOTFONT="F8",PSOTY=550
NUMBER: 36 CTRL CODE ABBREVIATION: RNI
FULL NAME: REFILL NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOFONT="F10",PSOX=0,PSOYI=50,PSOYM=3950
NUMBER: 37 CTRL CODE ABBREVIATION: RPI
FULL NAME: REFILL PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOBYI=65,PSOTYI=50,PSOLX=0,PSORX=1210,PSOY=1350
,PSOYM=3650,PSOXI=90,PSOSYI=135
NUMBER: 38 CTRL CODE ABBREVIATION: RT
FULL NAME: ROTATE TEXT CONTROL CODE: W $C(27),"&a90P"
NUMBER: 39 CTRL CODE ABBREVIATION: SBT
FULL NAME: START OF BARCODE TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y",$C(27),"(s1p14
.4v6,18b6,18s24670T"
NUMBER: 40 CTRL CODE ABBREVIATION: SPI
FULL NAME: SUSPENSE PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=1350,PSOYI=50,PSOCX=1775,PSOYM=27
00
NUMBER: 41 CTRL CODE ABBREVIATION: ST
FULL NAME: START OF TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y"
NUMBER: 42 CTRL CODE ABBREVIATION: WLI
FULL NAME: WARNING LABEL INITIALIZATION
CONTROL CODE: S PSOX=1050,PSOY=55
</pre>

=== Zebra Subtypes ===
For whatever reason, all commercial implementations I have worked on used Zebra printers for labels. One IMPORTANT aspect to note is that the existing subtypes in VISTA are written for 203 dpi Zebra printers. If you print them on 300 dpi Zebra printers, they will look shrunk. In the subtypes below, Right Margin, Page Length, and Back Space have to be filled out because they are required fields, but the software doesn't use them.

==== ZPL II Commands Cheat Sheet ====
<pre>
^XA - Start Label
^XZ - End Label
^LL - Label Length (Height)
^PW - Print Width
^CF - Set default Font
^LH - Label Home (Set a specific point to be the 0,0 coordinate for printing)
^A - Specify a font for the next ^FD (Field Definition). Resets to ^CF font after ^FD.
^CI - Change font encoding. 0 is USA-1, 28 is UTF-8, 30 is UTF-16 LE
^FR - Field Reverse Print; like reverse video for monitors
^FD - Field Data: contains what to print
^FS - Field Separator: End field data
^FB - Field Block: Allows you to print text with word wrapping
^BY - Bar Code Field Default: sets size of barcode.
^B3 - Code 39 barcode
^BC - Code 128 barcode
^BX - Datamatrix Barcode
^BQ - QR Barcode
^PH - Form Feed
</pre>

==== Lab Label ====
This is 1" x 2".
<pre>
NAME: P-ZEBRA-LAB
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW406.4^CFD,18,10^LH25,10"
CLOSE EXECUTE: W "^XZ" DESCRIPTION: Zebra Lab
</pre>

==== Pharmacy BCMA Label ====
This is 1" x 3.5".
<pre>
NAME: P-ZEBRA-PHARM-BCMA
RIGHT MARGIN: 80 FORM FEED: #
PAGE LENGTH: 10 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
NUMBER: 1 CTRL CODE ABBREVIATION: SL
FULL NAME: Start Label CONTROL CODE: W !,"^XA",!,"^LH0,0^FS"
NUMBER: 2 CTRL CODE ABBREVIATION: EL
FULL NAME: End Label CONTROL CODE: W !,"^XZ"
NUMBER: 3 CTRL CODE ABBREVIATION: EB
FULL NAME: End Barcode
CONTROL CODE: W !,"^FO20,150^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 4 CTRL CODE ABBREVIATION: SB
FULL NAME: Start Barcode
CONTROL CODE: W !,"^BY1,2.0^FO650,25^BXN,3,200^FD"_PSBBAR_"^FS"
NUMBER: 5 CTRL CODE ABBREVIATION: ST
FULL NAME: Start Text
CONTROL CODE: W !,"^FO"_PSBTYPE_"^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 6 CTRL CODE ABBREVIATION: STF
FULL NAME: Start Text Field
CONTROL CODE: S PSBTYPE=$S(PSBTLE="PSBDRUG":"20,25",PSBTLE="PSBDOSE":"20,60^FB
320,5",PSBTLE="PSBNAME":"350,60",PSBTLE="PSBWARD":"350,90",PSBTLE="PSBLOT":"350,
120",PSBTLE="PSBEXP":"350,150",PSBTLE="PSBMFG":"500,150",PSBTLE="PSBFCB":"350,18
0",1:"0,0")
</pre>

==== Pharmacy Unit Dose Label (vxVistA only) ====
VA VistA uses a dot matrix printer printing on a sheet of 1" x 3.5" x 2 columns.
vxVistA was written to use Unit Dose labels. This is 1" x 3.5" single column.

<pre>
NAME: P-ZEBRA-PHARM-UD
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
</pre>

== Support for Advanced Subtype Specifiers ==
If you look at [http://www.va.gov/vdl/documents/Infrastructure/Kernel/krn8_0sm.pdf|the kernel system management guide], you will notice that you can use a rather obtuse syntax to customize your output on a print by print basis. E.g.:
<pre>
LASER;P-LASER-LANDSCAPE;/M132L100P16BQ2
</pre>

M stands for right margin, here set to 132; L stands for page length, here 100; P stands for pitch, here 16, can only be 10, 12 or 16; B stands for Bold; and Q stands for Quality, taking in 0, 1 or 2, here set to 2.

How to set up a device to support this isn't documented anywhere in the Kernel Manuals; I figured it out eventually by reading the %ZIS source code. You need to set up these fields as follows for each subtype:

<pre>
10 PITCH: $C(27)_"(s10h" 12 PITCH: $C(27)_"(s12h"
HIGH INTENSITY (BOLD): $C(27)_"(s3b" LOW INTENSITY (UNBOLD): $C(27)_"(s-3b"
NORMAL INTENSITY (RESET): $C(27)_"(s0b"
16 PITCH: $C(27)_"(s16h" DEFAULT PITCH: $C(27)_"(s12h"
</pre>

The only thing you may have to vary between different subtypes is what is considered a default pitch. Here it is 12, but it can be different. Reading the code, I don't believe that setting the default pitch matters since the printer gets reset every single time a job is sent, discarding the last pitch sent. I don't support 'Q' in the configuration above, so it has no effect; that's because 'Q' is nonsensical when using laser printers. It had a use back in the dot-matrix days.

VISTA Printing Printer Subtypes

2016-10-03T21:19:11Z

Shabiel: /* Pharmacy Unit Dose Label (vxVistA only) */

= VISTA Subtypes =
''Written by Sam Habiel''
__TOC__

== What is a Subtype ==
A subtype (stored in file #3.2 TERMINAL TYPE) is an entry associated with each device that tells the device how to handle special non-standard situations; plus some base characteristics. With printers, typically a subtype has two fields populated: Open Execute and Close Execute, in addition to Right Margin, Form Feed, Page Length, and Back Space. The Open Execute resets the printer, sets the page orientation, sets the top and left margins, and sets the font size. The close execute sets the variable IONOFF to an empty string (effectively defining it in the symbol table), and sends a reset to the printer. Right Margin and Back Space aren't used with printers; Form Feed goes into the M variable IOF, Page Length goes into the M variable IOSL ("IO Screen Length") determines how many lines are to be printed on each page before VISTA sends an IOF to go to the next page. That's important to keep in mind since the number of lines that VISTA prints needs to match how many lines are available on the page, otherwise the printer will either spit an extra page containing the extra lines or it will clip the output, depending on whether you specified how many lines are to be printed in PCL. The subtypes below don't specify how many lines to print, so the former behavior will happen with them. The solution is to decrease page length.

The reason IONOFF is needed is that by default VISTA will send an extra page following each print out; because it was developed in the days of dot-matrix printers, where the extra page separated jobs. The days of dot-matrix printing are practically over; most printers used today are inkjet or laser. Typically we don't want an extra page at the end. You may be lead to believe that IONOFF is enough; however, most reports in VISTA have hardcoded extra pages at the beginning or end. I was told there was going to be a project in the late 90's to make sure all reports relied on the device handler for printing separator pages, but that never happened.

There is a field in the device file called "SUPPRESS FORM FEED AT CLOSE". This field does the exact same thing as setting IONOFF in the Close Execute in the terminal type. In general, I recommend setting IONOFF in the terminal type rather than filling SUPPRESS FORM FEED AT CLOSE for every single printer you configure.

The same extra page issues apply to Zebra printers as well, except over there they may manifest as extra labels if IOF is configured to send a label feed command (^PH or ~PH). If IOF is configured to be a '#', it will have no effect on the Zebra printer.

== How to specify a Subtype? ==
Normally, subtypes are configured once per device. When you set up a printer in the DEVICE file, you populate the subtype in the subtype field.

However, you can override subtype selection on a job basis, by using this syntax on the Device prompt:

<pre>
DEVICE: printer_name;subtype
</pre>

If you type partial matches, the device driver (^%ZIS) is going to list for you all partial matches for you to choose form. That's pretty nice since I never remember what subtypes I have beyond them having P-HP at the beginning.

There are variations on this syntax, by the way, that don't have to do with subtypes:

<pre>
1. DEVICE: printer_name;right margin;page length
2. DEVICE: printer_name;subtype;right margin; page length
2. DEVICE: ;right margin;page length
3. DEVICE: ;;page length
</pre>

As you can see, you can specify custom margins and page lengths. You need to remember that aside from terminal emulators, margins have no effect, as VISTA does not test for them when printing. It does really care about the page length though (see discussion about IOSL above). If a printer name isn't specified, the home device is assumed.

Novice power users type ';;99999' to print a report without page breaks on the terminal emulator, without understanding what it means. The variations above should tell you: print to the home device to an infinite length. Of note, $Y on Cache wraps at the unsigned int16 limit (32767); therefore, testing if $Y is greater than IOSL when IOSL is greater than 32767 (in my last example, it's 99999) will always return false, causing page breaks to never be issued. As far as I know, GT.M does not wrap $Y, so you may have to give it gigantic page lengths; although, in practice, I don't remember having encountered that problem. It's possible there is something in ^%ZIS4 that I missed regarding that.

== Common Subtypes in VISTA ==
Here are the most common subtypes in VISTA (standardized for Unices; you will need to remove $C(27),"&k2G" on Windows Servers):

NB: CPI = Characters Per Inch; LPI = Lines Per Inch
=== PCL Subtypes ===
==== PCL5 Quick Reference ====
<pre>
*27,"E"/$C(27,69) - Reset
*27,"&l0O" - Portrait / *27,"&l1O" - Landscape
*27,"&l3E" - Top Margin is 3 lines
*27,"&a5L" - Left Margin is 5 columns
*27,"&k2G" - Line endings are LF. Default Line endings are CRLF (unless overridden in printer settings).
*27,"(s0p12h0s0b4099T" - Primary '(s' font is fixed pitch, 12 cpi, upright (not italic), not bold, and is the Courier Font (#4099).
</pre>

==== Portrait Letter 12 CPI 6 LPI ====
This is THE MOST COMMON subtype to use. Most reports in VISTA print on this one.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 56
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&
k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Landscape Letter 14 CPI 6 LPI ====
This is the second most common subtype. Any menu option that says it needs 132 characters will need to use this subtype.
<pre>
NAME: P-HP-LTR-LAND-C14L6-W132 RIGHT MARGIN: 132
FORM FEED: # PAGE LENGTH: 45
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&k
2G",*27,"(s0p14h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer

</pre>

==== Portrait Letter 17 CPI 7 LPI (MARs and BCMA Med Log) ====
This is the (theoretically) third most commonly used subtype. It's only used for specific reports. It's also known as a condensed print subtype.
<pre>
NAME: P-HP-LTR-POR-C17L7-W128 RIGHT MARGIN: 128
FORM FEED: # PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l3E",$C(27),"(s0p17h9v0s0b4099T",*27,
"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

==== Portrait Landscape Letter 22 CPI 12 LPI ====
This is the subtype that will take the most amount of text; it's ideal to print a lot of data from Fileman, for example. It's also known as the condensed landscape print subtype. It's not commonly used except by Fileman power users.
<pre>
NAME: P-HP-LTR-LAND-C22L12-W228 RIGHT MARGIN: 228
FORM FEED: # PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",*27,"(s0p22h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

==== Portrait Legal 12 CPI 6 LPI ====
This is not commonly used; I just created this because I thought it may it come in useful for some users.
<pre>
NAME: P-HP-LGL-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 74
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l3A",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&
a5L",$C(27),"&k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Greensheet ====
If you don't know what a green sheet is, then skip this. It's here for those who want it. You need to buy a barcode chip in order for the barcodes to print.

<pre>
NAME: P-HP-LTR-POR-GREENSHEET RIGHT MARGIN: 100
FORM FEED: # PAGE LENGTH: 58
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l0O",*27,"&l4H",*27,"&l1E",*27,"(s0p"
_$S($G(PSDCPI)=10:"10h14",1:"12h12")_"v0s0b6T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
10 PITCH: $C(27)_"(s10H" 12 PITCH: $C(27)_"(s12H"
DESCRIPTION: HP JL4Si 12 pitch Courier
DEFAULT LINES PER INCH: $C(27)_"&l8C"
X LINES PER INCH: $C(27)_"&l12C"
BAR CODE OFF: "*"_$C(27)_"&l0O"_$C(27)_"(8U"_$C(27)_"(s0p"_$S($G(PSDCPI)=10:"1
0h14",1:"12h12")_"v0s0b6T"
BAR CODE ON: $S($D(PSDX2):$C(27)_"*p"_(PSDX2-1*300+200)_"y*p"_(PSDX1-1*810+38)
_"X",1:"")_$C(27)_"(0Y"_$C(27)_"(s0p8.1h12v0s0b0T*"
</pre>

==== Pharmacy Outpatient Label Printer ====
This one is a bit specialized. This is normally set-up by running routines (in this sequence) ^PSOLLU2, ^PSOLLU3, ^PSOLLU4. You need to buy a barcode chip in order for the barcodes to print.
<pre>
NAME: P-HPLJ4SI-P12 SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96 FORM FEED: #
PAGE LENGTH: 57 BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"(s0p12h0s0b4099T"
W $C(27),"&k2G" S $X=0 DESCRIPTION: HP JL4Si 12 pitch Courier
NUMBER: 1 CTRL CODE ABBREVIATION: ACI
FULL NAME: ADDRESS CHANGE INITIALIZATION
CONTROL CODE: S PSOHFONT="F12",PSOX=1210,PSOY=700,PSOFY=1270
NUMBER: 2 CTRL CODE ABBREVIATION: ALI
FULL NAME: ALLERGY SECTION INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=1350,PSOYI=50,PSOYM=2700
NUMBER: 3 CTRL CODE ABBREVIATION: AWI
FULL NAME: ALLERGY WARNING INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 4 CTRL CODE ABBREVIATION: BLB
FULL NAME: BOTTLE LABEL BODY INITIALIZATION
CONTROL CODE: S PSOX=0,PSODX=275,PSOY=140,PSOYI=40,PSOYM=379,PSOFONT="F10"
NUMBER: 5 CTRL CODE ABBREVIATION: BLBC
FULL NAME: BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(s1p10.4v4,12b4,12s24670T",$C(27),"&a90P",$C(27),"*p36
50x1000Y"
NUMBER: 6 CTRL CODE ABBREVIATION: BLF
FULL NAME: BOTTLE LABEL FOOTER INITIALIZATION
CONTROL CODE: S PSODY=460,PSOX=0,PSOCX=280,PSOQY=550,PSOTY=600,PSOFONT="F10",P
SOQFONT="F8",PSODFONT="F9",PSOTFONT="F10"
NUMBER: 7 CTRL CODE ABBREVIATION: BLH
FULL NAME: BOTTLE LABEL HEADER INITIALIZATION
CONTROL CODE: S PSOX=100,PSOY=50,PSOYI=30,PSOFONT="F9"
NUMBER: 8 CTRL CODE ABBREVIATION: CDII
FULL NAME: CRITICAL DRUG INTERACTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 9 CTRL CODE ABBREVIATION: CNI
FULL NAME: COPAY NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOX=1210,PSOYM=3950,PSOFONT="F10",PSOYI=50
NUMBER: 10 CTRL CODE ABBREVIATION: EBLBC
FULL NAME: END OF BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T",$C(27),"&a0P",!
NUMBER: 11 CTRL CODE ABBREVIATION: EBT
FULL NAME: END OF BARCODE TEXT
CONTROL CODE: W $C(27),"(8U",$C(27),"(s1p8v0s0b16602T",!
NUMBER: 12 CTRL CODE ABBREVIATION: F10
FULL NAME: TEN POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T"
NUMBER: 13 CTRL CODE ABBREVIATION: F10B
FULL NAME: TEN POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s3b16602T"
NUMBER: 14 CTRL CODE ABBREVIATION: F12
FULL NAME: TWELVE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s0b16602T"
NUMBER: 15 CTRL CODE ABBREVIATION: F12B
FULL NAME: 12 POINT FONT BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s3b16602T"
NUMBER: 16 CTRL CODE ABBREVIATION: F6
FULL NAME: SIX POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s0b16602T"
NUMBER: 17 CTRL CODE ABBREVIATION: F6B
FULL NAME: SIX POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s3b16602T"
NUMBER: 18 CTRL CODE ABBREVIATION: F8
FULL NAME: EIGHT POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s0b16602T"
NUMBER: 19 CTRL CODE ABBREVIATION: F8B
FULL NAME: EIGHT POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s3b16602T"
NUMBER: 20 CTRL CODE ABBREVIATION: F9
FULL NAME: NINE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s0b16602T"
NUMBER: 21 CTRL CODE ABBREVIATION: F9B
FULL NAME: NINE POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s3b16602T"
NUMBER: 22 CTRL CODE ABBREVIATION: FDU
FULL NAME: FONT DISABLE UNDERLINE CONTROL CODE: W $C(27),"&d@"
NUMBER: 23 CTRL CODE ABBREVIATION: FWU
FULL NAME: FONT WITH UNDERLINE CONTROL CODE: W $C(27),"&d0D"
NUMBER: 24 CTRL CODE ABBREVIATION: LL
FULL NAME: LASER LABEL CONTROL CODE: Q
NUMBER: 25 CTRL CODE ABBREVIATION: LLI
FULL NAME: LASER LABEL INIT
CONTROL CODE: W $C(27),"&r1F",$C(27),"E",$C(27),"&l0O",$C(27),"&u300D",$C(27),
"&l3A",$C(27),"&l0E",!
NUMBER: 26 CTRL CODE ABBREVIATION: MLI
FULL NAME: MAILING LABEL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1680,PSOY=175,PSOYI=50
NUMBER: 27 CTRL CODE ABBREVIATION: NR
FULL NAME: NORMAL ROTATION CONTROL CODE: W $C(27),"&a0P"
NUMBER: 28 CTRL CODE ABBREVIATION: PFDI
FULL NAME: PHARMACY FILL DOCUMENT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=690,PSOYI=40,PSOYM=969
NUMBER: 29 CTRL CODE ABBREVIATION: PFDQ
FULL NAME: PHARMACY FILL DOCUMENT QUANTITY
CONTROL CODE: S PSOX=0,PSOCX=200,PSOY=970,PSOYI=50,PSOQFONT="F8",PSOFONT="F10"
NUMBER: 30 CTRL CODE ABBREVIATION: PFDT
FULL NAME: PHARMACY FILL DOCUMENT TRAILER
CONTROL CODE: S PSOY=1015,PSOYI=45,PSOX=0,PSOFONT="F10",PSOBYI=50,PSOTFONT="F9
",PSOBY=1280
NUMBER: 31 CTRL CODE ABBREVIATION: PFDW
FULL NAME: PHARMACY FILL DOCUMENT WARNING
CONTROL CODE: S PSOY=1258,PSOX=660,PSOYI=30,PSOFONT="F8",PSOYM=1329
NUMBER: 32 CTRL CODE ABBREVIATION: PFI
FULL NAME: PATIENT FILL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=710,PSOYI=45,PSOHFONT="F12",PSOBY
I=100
NUMBER: 33 CTRL CODE ABBREVIATION: PII
FULL NAME: PATIENT INSTRUCTION INITIALIZATION
CONTROL CODE: S PSOX=1210,PSOY=760,PSOFONT="F12"
NUMBER: 34 CTRL CODE ABBREVIATION: PMII
FULL NAME: PMI SECTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1350,PSOYI=50,PSOFONT="F10",PSOYM=3899
NUMBER: 35 CTRL CODE ABBREVIATION: RMI
FULL NAME: RETURN MAIL INITIALIZATION
CONTROL CODE: S PSOHFONT="F8",PSOFONT="F10",PSOX=1680,PSOY=35,PSORYI=40,PSOHYI
=40,PSOTFONT="F8",PSOTY=550
NUMBER: 36 CTRL CODE ABBREVIATION: RNI
FULL NAME: REFILL NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOFONT="F10",PSOX=0,PSOYI=50,PSOYM=3950
NUMBER: 37 CTRL CODE ABBREVIATION: RPI
FULL NAME: REFILL PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOBYI=65,PSOTYI=50,PSOLX=0,PSORX=1210,PSOY=1350
,PSOYM=3650,PSOXI=90,PSOSYI=135
NUMBER: 38 CTRL CODE ABBREVIATION: RT
FULL NAME: ROTATE TEXT CONTROL CODE: W $C(27),"&a90P"
NUMBER: 39 CTRL CODE ABBREVIATION: SBT
FULL NAME: START OF BARCODE TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y",$C(27),"(s1p14
.4v6,18b6,18s24670T"
NUMBER: 40 CTRL CODE ABBREVIATION: SPI
FULL NAME: SUSPENSE PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=1350,PSOYI=50,PSOCX=1775,PSOYM=27
00
NUMBER: 41 CTRL CODE ABBREVIATION: ST
FULL NAME: START OF TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y"
NUMBER: 42 CTRL CODE ABBREVIATION: WLI
FULL NAME: WARNING LABEL INITIALIZATION
CONTROL CODE: S PSOX=1050,PSOY=55
</pre>

=== Zebra Subtypes ===
For whatever reason, all commercial implementations I have worked on used Zebra printers for labels. One IMPORTANT aspect to note is that the existing subtypes in VISTA are written for 203 dpi Zebra printers. If you print them on 300 dpi Zebra printers, they will look shrunk. In the subtypes below, Right Margin, Page Length, and Back Space have to be filled out because they are required fields, but the software doesn't use them.

==== ZPL II Commands ====

==== Lab Label ====
This is 1" x 2".
<pre>
NAME: P-ZEBRA-LAB
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW406.4^CFD,18,10^LH25,10"
CLOSE EXECUTE: W "^XZ" DESCRIPTION: Zebra Lab
</pre>

==== Pharmacy BCMA Label ====
This is 1" x 3.5".
<pre>
NAME: P-ZEBRA-PHARM-BCMA
RIGHT MARGIN: 80 FORM FEED: #
PAGE LENGTH: 10 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
NUMBER: 1 CTRL CODE ABBREVIATION: SL
FULL NAME: Start Label CONTROL CODE: W !,"^XA",!,"^LH0,0^FS"
NUMBER: 2 CTRL CODE ABBREVIATION: EL
FULL NAME: End Label CONTROL CODE: W !,"^XZ"
NUMBER: 3 CTRL CODE ABBREVIATION: EB
FULL NAME: End Barcode
CONTROL CODE: W !,"^FO20,150^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 4 CTRL CODE ABBREVIATION: SB
FULL NAME: Start Barcode
CONTROL CODE: W !,"^BY1,2.0^FO650,25^BXN,3,200^FD"_PSBBAR_"^FS"
NUMBER: 5 CTRL CODE ABBREVIATION: ST
FULL NAME: Start Text
CONTROL CODE: W !,"^FO"_PSBTYPE_"^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 6 CTRL CODE ABBREVIATION: STF
FULL NAME: Start Text Field
CONTROL CODE: S PSBTYPE=$S(PSBTLE="PSBDRUG":"20,25",PSBTLE="PSBDOSE":"20,60^FB
320,5",PSBTLE="PSBNAME":"350,60",PSBTLE="PSBWARD":"350,90",PSBTLE="PSBLOT":"350,
120",PSBTLE="PSBEXP":"350,150",PSBTLE="PSBMFG":"500,150",PSBTLE="PSBFCB":"350,18
0",1:"0,0")
</pre>

==== Pharmacy Unit Dose Label (vxVistA only) ====
VA VistA uses a dot matrix printer printing on a sheet of 1" x 3.5" x 2 columns.
vxVistA was written to use Unit Dose labels. This is 1" x 3.5" single column.

<pre>
NAME: P-ZEBRA-PHARM-UD
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
</pre>

== Support for Advanced Subtype Specifiers ==
If you look at [http://www.va.gov/vdl/documents/Infrastructure/Kernel/krn8_0sm.pdf|the kernel system management guide], you will notice that you can use a rather obtuse syntax to customize your output on a print by print basis. E.g.:
<pre>
LASER;P-LASER-LANDSCAPE;/M132L100P16BQ2
</pre>

M stands for right margin, here set to 132; L stands for page length, here 100; P stands for pitch, here 16, can only be 10, 12 or 16; B stands for Bold; and Q stands for Quality, taking in 0, 1 or 2, here set to 2.

How to set up a device to support this isn't documented anywhere in the Kernel Manuals; I figured it out eventually by reading the %ZIS source code. You need to set up these fields as follows for each subtype:

<pre>
10 PITCH: $C(27)_"(s10h" 12 PITCH: $C(27)_"(s12h"
HIGH INTENSITY (BOLD): $C(27)_"(s3b" LOW INTENSITY (UNBOLD): $C(27)_"(s-3b"
NORMAL INTENSITY (RESET): $C(27)_"(s0b"
16 PITCH: $C(27)_"(s16h" DEFAULT PITCH: $C(27)_"(s12h"
</pre>

The only thing you may have to vary between different subtypes is what is considered a default pitch. Here it is 12, but it can be different. Reading the code, I don't believe that setting the default pitch matters since the printer gets reset every single time a job is sent, discarding the last pitch sent. I don't support 'Q' in the configuration above, so it has no effect; that's because 'Q' is nonsensical when using laser printers. It had a use back in the dot-matrix days.

VISTA Printing Printer Subtypes

2016-10-03T21:18:36Z

Shabiel: /* VISTA Subtypes */

= VISTA Subtypes =
''Written by Sam Habiel''
__TOC__

== What is a Subtype ==
A subtype (stored in file #3.2 TERMINAL TYPE) is an entry associated with each device that tells the device how to handle special non-standard situations; plus some base characteristics. With printers, typically a subtype has two fields populated: Open Execute and Close Execute, in addition to Right Margin, Form Feed, Page Length, and Back Space. The Open Execute resets the printer, sets the page orientation, sets the top and left margins, and sets the font size. The close execute sets the variable IONOFF to an empty string (effectively defining it in the symbol table), and sends a reset to the printer. Right Margin and Back Space aren't used with printers; Form Feed goes into the M variable IOF, Page Length goes into the M variable IOSL ("IO Screen Length") determines how many lines are to be printed on each page before VISTA sends an IOF to go to the next page. That's important to keep in mind since the number of lines that VISTA prints needs to match how many lines are available on the page, otherwise the printer will either spit an extra page containing the extra lines or it will clip the output, depending on whether you specified how many lines are to be printed in PCL. The subtypes below don't specify how many lines to print, so the former behavior will happen with them. The solution is to decrease page length.

The reason IONOFF is needed is that by default VISTA will send an extra page following each print out; because it was developed in the days of dot-matrix printers, where the extra page separated jobs. The days of dot-matrix printing are practically over; most printers used today are inkjet or laser. Typically we don't want an extra page at the end. You may be lead to believe that IONOFF is enough; however, most reports in VISTA have hardcoded extra pages at the beginning or end. I was told there was going to be a project in the late 90's to make sure all reports relied on the device handler for printing separator pages, but that never happened.

There is a field in the device file called "SUPPRESS FORM FEED AT CLOSE". This field does the exact same thing as setting IONOFF in the Close Execute in the terminal type. In general, I recommend setting IONOFF in the terminal type rather than filling SUPPRESS FORM FEED AT CLOSE for every single printer you configure.

The same extra page issues apply to Zebra printers as well, except over there they may manifest as extra labels if IOF is configured to send a label feed command (^PH or ~PH). If IOF is configured to be a '#', it will have no effect on the Zebra printer.

== How to specify a Subtype? ==
Normally, subtypes are configured once per device. When you set up a printer in the DEVICE file, you populate the subtype in the subtype field.

However, you can override subtype selection on a job basis, by using this syntax on the Device prompt:

<pre>
DEVICE: printer_name;subtype
</pre>

If you type partial matches, the device driver (^%ZIS) is going to list for you all partial matches for you to choose form. That's pretty nice since I never remember what subtypes I have beyond them having P-HP at the beginning.

There are variations on this syntax, by the way, that don't have to do with subtypes:

<pre>
1. DEVICE: printer_name;right margin;page length
2. DEVICE: printer_name;subtype;right margin; page length
2. DEVICE: ;right margin;page length
3. DEVICE: ;;page length
</pre>

As you can see, you can specify custom margins and page lengths. You need to remember that aside from terminal emulators, margins have no effect, as VISTA does not test for them when printing. It does really care about the page length though (see discussion about IOSL above). If a printer name isn't specified, the home device is assumed.

Novice power users type ';;99999' to print a report without page breaks on the terminal emulator, without understanding what it means. The variations above should tell you: print to the home device to an infinite length. Of note, $Y on Cache wraps at the unsigned int16 limit (32767); therefore, testing if $Y is greater than IOSL when IOSL is greater than 32767 (in my last example, it's 99999) will always return false, causing page breaks to never be issued. As far as I know, GT.M does not wrap $Y, so you may have to give it gigantic page lengths; although, in practice, I don't remember having encountered that problem. It's possible there is something in ^%ZIS4 that I missed regarding that.

== Common Subtypes in VISTA ==
Here are the most common subtypes in VISTA (standardized for Unices; you will need to remove $C(27),"&k2G" on Windows Servers):

NB: CPI = Characters Per Inch; LPI = Lines Per Inch
=== PCL Subtypes ===
==== PCL5 Quick Reference ====
<pre>
*27,"E"/$C(27,69) - Reset
*27,"&l0O" - Portrait / *27,"&l1O" - Landscape
*27,"&l3E" - Top Margin is 3 lines
*27,"&a5L" - Left Margin is 5 columns
*27,"&k2G" - Line endings are LF. Default Line endings are CRLF (unless overridden in printer settings).
*27,"(s0p12h0s0b4099T" - Primary '(s' font is fixed pitch, 12 cpi, upright (not italic), not bold, and is the Courier Font (#4099).
</pre>

==== Portrait Letter 12 CPI 6 LPI ====
This is THE MOST COMMON subtype to use. Most reports in VISTA print on this one.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 56
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&
k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Landscape Letter 14 CPI 6 LPI ====
This is the second most common subtype. Any menu option that says it needs 132 characters will need to use this subtype.
<pre>
NAME: P-HP-LTR-LAND-C14L6-W132 RIGHT MARGIN: 132
FORM FEED: # PAGE LENGTH: 45
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&k
2G",*27,"(s0p14h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer

</pre>

==== Portrait Letter 17 CPI 7 LPI (MARs and BCMA Med Log) ====
This is the (theoretically) third most commonly used subtype. It's only used for specific reports. It's also known as a condensed print subtype.
<pre>
NAME: P-HP-LTR-POR-C17L7-W128 RIGHT MARGIN: 128
FORM FEED: # PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l3E",$C(27),"(s0p17h9v0s0b4099T",*27,
"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

==== Portrait Landscape Letter 22 CPI 12 LPI ====
This is the subtype that will take the most amount of text; it's ideal to print a lot of data from Fileman, for example. It's also known as the condensed landscape print subtype. It's not commonly used except by Fileman power users.
<pre>
NAME: P-HP-LTR-LAND-C22L12-W228 RIGHT MARGIN: 228
FORM FEED: # PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",*27,"(s0p22h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

==== Portrait Legal 12 CPI 6 LPI ====
This is not commonly used; I just created this because I thought it may it come in useful for some users.
<pre>
NAME: P-HP-LGL-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 74
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l3A",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&
a5L",$C(27),"&k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Greensheet ====
If you don't know what a green sheet is, then skip this. It's here for those who want it. You need to buy a barcode chip in order for the barcodes to print.

<pre>
NAME: P-HP-LTR-POR-GREENSHEET RIGHT MARGIN: 100
FORM FEED: # PAGE LENGTH: 58
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l0O",*27,"&l4H",*27,"&l1E",*27,"(s0p"
_$S($G(PSDCPI)=10:"10h14",1:"12h12")_"v0s0b6T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
10 PITCH: $C(27)_"(s10H" 12 PITCH: $C(27)_"(s12H"
DESCRIPTION: HP JL4Si 12 pitch Courier
DEFAULT LINES PER INCH: $C(27)_"&l8C"
X LINES PER INCH: $C(27)_"&l12C"
BAR CODE OFF: "*"_$C(27)_"&l0O"_$C(27)_"(8U"_$C(27)_"(s0p"_$S($G(PSDCPI)=10:"1
0h14",1:"12h12")_"v0s0b6T"
BAR CODE ON: $S($D(PSDX2):$C(27)_"*p"_(PSDX2-1*300+200)_"y*p"_(PSDX1-1*810+38)
_"X",1:"")_$C(27)_"(0Y"_$C(27)_"(s0p8.1h12v0s0b0T*"
</pre>

==== Pharmacy Outpatient Label Printer ====
This one is a bit specialized. This is normally set-up by running routines (in this sequence) ^PSOLLU2, ^PSOLLU3, ^PSOLLU4. You need to buy a barcode chip in order for the barcodes to print.
<pre>
NAME: P-HPLJ4SI-P12 SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96 FORM FEED: #
PAGE LENGTH: 57 BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"(s0p12h0s0b4099T"
W $C(27),"&k2G" S $X=0 DESCRIPTION: HP JL4Si 12 pitch Courier
NUMBER: 1 CTRL CODE ABBREVIATION: ACI
FULL NAME: ADDRESS CHANGE INITIALIZATION
CONTROL CODE: S PSOHFONT="F12",PSOX=1210,PSOY=700,PSOFY=1270
NUMBER: 2 CTRL CODE ABBREVIATION: ALI
FULL NAME: ALLERGY SECTION INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=1350,PSOYI=50,PSOYM=2700
NUMBER: 3 CTRL CODE ABBREVIATION: AWI
FULL NAME: ALLERGY WARNING INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 4 CTRL CODE ABBREVIATION: BLB
FULL NAME: BOTTLE LABEL BODY INITIALIZATION
CONTROL CODE: S PSOX=0,PSODX=275,PSOY=140,PSOYI=40,PSOYM=379,PSOFONT="F10"
NUMBER: 5 CTRL CODE ABBREVIATION: BLBC
FULL NAME: BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(s1p10.4v4,12b4,12s24670T",$C(27),"&a90P",$C(27),"*p36
50x1000Y"
NUMBER: 6 CTRL CODE ABBREVIATION: BLF
FULL NAME: BOTTLE LABEL FOOTER INITIALIZATION
CONTROL CODE: S PSODY=460,PSOX=0,PSOCX=280,PSOQY=550,PSOTY=600,PSOFONT="F10",P
SOQFONT="F8",PSODFONT="F9",PSOTFONT="F10"
NUMBER: 7 CTRL CODE ABBREVIATION: BLH
FULL NAME: BOTTLE LABEL HEADER INITIALIZATION
CONTROL CODE: S PSOX=100,PSOY=50,PSOYI=30,PSOFONT="F9"
NUMBER: 8 CTRL CODE ABBREVIATION: CDII
FULL NAME: CRITICAL DRUG INTERACTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 9 CTRL CODE ABBREVIATION: CNI
FULL NAME: COPAY NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOX=1210,PSOYM=3950,PSOFONT="F10",PSOYI=50
NUMBER: 10 CTRL CODE ABBREVIATION: EBLBC
FULL NAME: END OF BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T",$C(27),"&a0P",!
NUMBER: 11 CTRL CODE ABBREVIATION: EBT
FULL NAME: END OF BARCODE TEXT
CONTROL CODE: W $C(27),"(8U",$C(27),"(s1p8v0s0b16602T",!
NUMBER: 12 CTRL CODE ABBREVIATION: F10
FULL NAME: TEN POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T"
NUMBER: 13 CTRL CODE ABBREVIATION: F10B
FULL NAME: TEN POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s3b16602T"
NUMBER: 14 CTRL CODE ABBREVIATION: F12
FULL NAME: TWELVE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s0b16602T"
NUMBER: 15 CTRL CODE ABBREVIATION: F12B
FULL NAME: 12 POINT FONT BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s3b16602T"
NUMBER: 16 CTRL CODE ABBREVIATION: F6
FULL NAME: SIX POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s0b16602T"
NUMBER: 17 CTRL CODE ABBREVIATION: F6B
FULL NAME: SIX POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s3b16602T"
NUMBER: 18 CTRL CODE ABBREVIATION: F8
FULL NAME: EIGHT POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s0b16602T"
NUMBER: 19 CTRL CODE ABBREVIATION: F8B
FULL NAME: EIGHT POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s3b16602T"
NUMBER: 20 CTRL CODE ABBREVIATION: F9
FULL NAME: NINE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s0b16602T"
NUMBER: 21 CTRL CODE ABBREVIATION: F9B
FULL NAME: NINE POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s3b16602T"
NUMBER: 22 CTRL CODE ABBREVIATION: FDU
FULL NAME: FONT DISABLE UNDERLINE CONTROL CODE: W $C(27),"&d@"
NUMBER: 23 CTRL CODE ABBREVIATION: FWU
FULL NAME: FONT WITH UNDERLINE CONTROL CODE: W $C(27),"&d0D"
NUMBER: 24 CTRL CODE ABBREVIATION: LL
FULL NAME: LASER LABEL CONTROL CODE: Q
NUMBER: 25 CTRL CODE ABBREVIATION: LLI
FULL NAME: LASER LABEL INIT
CONTROL CODE: W $C(27),"&r1F",$C(27),"E",$C(27),"&l0O",$C(27),"&u300D",$C(27),
"&l3A",$C(27),"&l0E",!
NUMBER: 26 CTRL CODE ABBREVIATION: MLI
FULL NAME: MAILING LABEL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1680,PSOY=175,PSOYI=50
NUMBER: 27 CTRL CODE ABBREVIATION: NR
FULL NAME: NORMAL ROTATION CONTROL CODE: W $C(27),"&a0P"
NUMBER: 28 CTRL CODE ABBREVIATION: PFDI
FULL NAME: PHARMACY FILL DOCUMENT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=690,PSOYI=40,PSOYM=969
NUMBER: 29 CTRL CODE ABBREVIATION: PFDQ
FULL NAME: PHARMACY FILL DOCUMENT QUANTITY
CONTROL CODE: S PSOX=0,PSOCX=200,PSOY=970,PSOYI=50,PSOQFONT="F8",PSOFONT="F10"
NUMBER: 30 CTRL CODE ABBREVIATION: PFDT
FULL NAME: PHARMACY FILL DOCUMENT TRAILER
CONTROL CODE: S PSOY=1015,PSOYI=45,PSOX=0,PSOFONT="F10",PSOBYI=50,PSOTFONT="F9
",PSOBY=1280
NUMBER: 31 CTRL CODE ABBREVIATION: PFDW
FULL NAME: PHARMACY FILL DOCUMENT WARNING
CONTROL CODE: S PSOY=1258,PSOX=660,PSOYI=30,PSOFONT="F8",PSOYM=1329
NUMBER: 32 CTRL CODE ABBREVIATION: PFI
FULL NAME: PATIENT FILL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=710,PSOYI=45,PSOHFONT="F12",PSOBY
I=100
NUMBER: 33 CTRL CODE ABBREVIATION: PII
FULL NAME: PATIENT INSTRUCTION INITIALIZATION
CONTROL CODE: S PSOX=1210,PSOY=760,PSOFONT="F12"
NUMBER: 34 CTRL CODE ABBREVIATION: PMII
FULL NAME: PMI SECTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1350,PSOYI=50,PSOFONT="F10",PSOYM=3899
NUMBER: 35 CTRL CODE ABBREVIATION: RMI
FULL NAME: RETURN MAIL INITIALIZATION
CONTROL CODE: S PSOHFONT="F8",PSOFONT="F10",PSOX=1680,PSOY=35,PSORYI=40,PSOHYI
=40,PSOTFONT="F8",PSOTY=550
NUMBER: 36 CTRL CODE ABBREVIATION: RNI
FULL NAME: REFILL NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOFONT="F10",PSOX=0,PSOYI=50,PSOYM=3950
NUMBER: 37 CTRL CODE ABBREVIATION: RPI
FULL NAME: REFILL PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOBYI=65,PSOTYI=50,PSOLX=0,PSORX=1210,PSOY=1350
,PSOYM=3650,PSOXI=90,PSOSYI=135
NUMBER: 38 CTRL CODE ABBREVIATION: RT
FULL NAME: ROTATE TEXT CONTROL CODE: W $C(27),"&a90P"
NUMBER: 39 CTRL CODE ABBREVIATION: SBT
FULL NAME: START OF BARCODE TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y",$C(27),"(s1p14
.4v6,18b6,18s24670T"
NUMBER: 40 CTRL CODE ABBREVIATION: SPI
FULL NAME: SUSPENSE PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=1350,PSOYI=50,PSOCX=1775,PSOYM=27
00
NUMBER: 41 CTRL CODE ABBREVIATION: ST
FULL NAME: START OF TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y"
NUMBER: 42 CTRL CODE ABBREVIATION: WLI
FULL NAME: WARNING LABEL INITIALIZATION
CONTROL CODE: S PSOX=1050,PSOY=55
</pre>

=== Zebra Subtypes ===
For whatever reason, all commercial implementations I have worked on used Zebra printers for labels. One IMPORTANT aspect to note is that the existing subtypes in VISTA are written for 203 dpi Zebra printers. If you print them on 300 dpi Zebra printers, they will look shrunk. In the subtypes below, Right Margin, Page Length, and Back Space have to be filled out because they are required fields, but the software doesn't use them.

==== ZPL II Commands ====

==== Lab Label ====
This is 1" x 2".
<pre>
NAME: P-ZEBRA-LAB
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW406.4^CFD,18,10^LH25,10"
CLOSE EXECUTE: W "^XZ" DESCRIPTION: Zebra Lab
</pre>

==== Pharmacy BCMA Label ====
This is 1" x 3.5".
<pre>
NAME: P-ZEBRA-PHARM-BCMA
RIGHT MARGIN: 80 FORM FEED: #
PAGE LENGTH: 10 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
NUMBER: 1 CTRL CODE ABBREVIATION: SL
FULL NAME: Start Label CONTROL CODE: W !,"^XA",!,"^LH0,0^FS"
NUMBER: 2 CTRL CODE ABBREVIATION: EL
FULL NAME: End Label CONTROL CODE: W !,"^XZ"
NUMBER: 3 CTRL CODE ABBREVIATION: EB
FULL NAME: End Barcode
CONTROL CODE: W !,"^FO20,150^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 4 CTRL CODE ABBREVIATION: SB
FULL NAME: Start Barcode
CONTROL CODE: W !,"^BY1,2.0^FO650,25^BXN,3,200^FD"_PSBBAR_"^FS"
NUMBER: 5 CTRL CODE ABBREVIATION: ST
FULL NAME: Start Text
CONTROL CODE: W !,"^FO"_PSBTYPE_"^A0N,30,20^CI13^FR^FD"_TEXT_"^FS"
NUMBER: 6 CTRL CODE ABBREVIATION: STF
FULL NAME: Start Text Field
CONTROL CODE: S PSBTYPE=$S(PSBTLE="PSBDRUG":"20,25",PSBTLE="PSBDOSE":"20,60^FB
320,5",PSBTLE="PSBNAME":"350,60",PSBTLE="PSBWARD":"350,90",PSBTLE="PSBLOT":"350,
120",PSBTLE="PSBEXP":"350,150",PSBTLE="PSBMFG":"500,150",PSBTLE="PSBFCB":"350,18
0",1:"0,0")
</pre>

==== Pharmacy Unit Dose Label (vxVistA only) ====
VA VistA uses a dot matrix printer printing on a sheet of 1" x 3.5" x 2 columns.
vxVistA was written to use Unit Dose labels. This is 1" x 3.5" single column.

<pre>
NAME: P-ZEBRA-PHARM-UD
RIGHT MARGIN: 132 FORM FEED: #
PAGE LENGTH: 64 BACK SPACE: $C(8)
OPEN EXECUTE: W "^XA^LL203.2^PW711.2^CFD,18,10^LH15,25^XZ"
DESCRIPTION: ZEBRA BARCODE LABEL PRINTER
SYNONYM: ZEBRA
</pre>

== Support for Advanced Subtype Specifiers ==
If you look at [http://www.va.gov/vdl/documents/Infrastructure/Kernel/krn8_0sm.pdf|the kernel system management guide], you will notice that you can use a rather obtuse syntax to customize your output on a print by print basis. E.g.:
<pre>
LASER;P-LASER-LANDSCAPE;/M132L100P16BQ2
</pre>

M stands for right margin, here set to 132; L stands for page length, here 100; P stands for pitch, here 16, can only be 10, 12 or 16; B stands for Bold; and Q stands for Quality, taking in 0, 1 or 2, here set to 2.

How to set up a device to support this isn't documented anywhere in the Kernel Manuals; I figured it out eventually by reading the %ZIS source code. You need to set up these fields as follows for each subtype:

<pre>
10 PITCH: $C(27)_"(s10h" 12 PITCH: $C(27)_"(s12h"
HIGH INTENSITY (BOLD): $C(27)_"(s3b" LOW INTENSITY (UNBOLD): $C(27)_"(s-3b"
NORMAL INTENSITY (RESET): $C(27)_"(s0b"
16 PITCH: $C(27)_"(s16h" DEFAULT PITCH: $C(27)_"(s12h"
</pre>

The only thing you may have to vary between different subtypes is what is considered a default pitch. Here it is 12, but it can be different. Reading the code, I don't believe that setting the default pitch matters since the printer gets reset every single time a job is sent, discarding the last pitch sent. I don't support 'Q' in the configuration above, so it has no effect; that's because 'Q' is nonsensical when using laser printers. It had a use back in the dot-matrix days.

VISTA Printing Printer Subtypes

2016-10-03T21:00:56Z

Shabiel: /* Common Subtypes in VISTA */

= VISTA Subtypes =
''Written by Sam Habiel''
__TOC__

== What is a Subtype ==
A subtype (stored in file #3.2 TERMINAL TYPE) is an entry associated with each device that tells the device how to handle special non-standard situations; plus some base characteristics. With printers, typically a subtype has two fields populated: Open Execute and Close Execute, in addition to Right Margin, Form Feed, Page Length, and Back Space. The Open Execute resets the printer, sets the page orientation, sets the top and left margins, and sets the font size. The close execute sets the variable IONOFF to an empty string (effectively defining it in the symbol table), and sends a reset to the printer. Right Margin and Back Space aren't used with printers; Form Feed goes into the M variable IOF, Page Length goes into the M variable IOSL ("IO Screen Length") determines how many lines are to be printed on each page before VISTA sends an IOF to go to the next page. That's important to keep in mind since the number of lines that VISTA prints needs to match how many lines are available on the page, otherwise the printer will either spit an extra page containing the extra lines or it will clip the output, depending on whether you specified how many lines are to be printed in PCL. The subtypes below don't specify how many lines to print, so the former behavior will happen with them. The solution is to decrease page length.

The reason IONOFF is needed is that by default VISTA will send an extra page following each print out; because it was developed in the days of dot-matrix printers, where the extra page separated jobs. The days of dot-matrix printing are practically over; most printers used today are inkjet or laser. Typically we don't want an extra page at the end. You may be lead to believe that IONOFF is enough; however, most reports in VISTA have hardcoded extra pages at the beginning or end. I was told there was going to be a project in the late 90's to make sure all reports relied on the device handler for printing separator pages, but that never happened.

There is a field in the device file called "SUPPRESS FORM FEED AT CLOSE". This field does the exact same thing as setting IONOFF in the Close Execute in the terminal type. In general, I recommend setting IONOFF in the terminal type rather than filling SUPPRESS FORM FEED AT CLOSE for every single printer you configure.

The same extra page issues apply to Zebra printers as well, except over there they may manifest as extra labels if IOF is configured to send a label feed command (^PH or ~PH). If IOF is configured to be a '#', it will have no effect on the Zebra printer.

== How to specify a Subtype? ==
Normally, subtypes are configured once per device. When you set up a printer in the DEVICE file, you populate the subtype in the subtype field.

However, you can override subtype selection on a job basis, by using this syntax on the Device prompt:

<pre>
DEVICE: printer_name;subtype
</pre>

If you type partial matches, the device driver (^%ZIS) is going to list for you all partial matches for you to choose form. That's pretty nice since I never remember what subtypes I have beyond them having P-HP at the beginning.

There are variations on this syntax, by the way, that don't have to do with subtypes:

<pre>
1. DEVICE: printer_name;right margin;page length
2. DEVICE: printer_name;subtype;right margin; page length
2. DEVICE: ;right margin;page length
3. DEVICE: ;;page length
</pre>

As you can see, you can specify custom margins and page lengths. You need to remember that aside from terminal emulators, margins have no effect, as VISTA does not test for them when printing. It does really care about the page length though (see discussion about IOSL above). If a printer name isn't specified, the home device is assumed.

Novice power users type ';;99999' to print a report without page breaks on the terminal emulator, without understanding what it means. The variations above should tell you: print to the home device to an infinite length. Of note, $Y on Cache wraps at the unsigned int16 limit (32767); therefore, testing if $Y is greater than IOSL when IOSL is greater than 32767 (in my last example, it's 99999) will always return false, causing page breaks to never be issued. As far as I know, GT.M does not wrap $Y, so you may have to give it gigantic page lengths; although, in practice, I don't remember having encountered that problem. It's possible there is something in ^%ZIS4 that I missed regarding that.

== Common Subtypes in VISTA ==
Here are the most common subtypes in VISTA (standardized for Unices; you will need to remove $C(27),"&k2G" on Windows Servers):

NB: CPI = Characters Per Inch; LPI = Lines Per Inch
=== PCL Subtypes ===
==== PCL5 Quick Reference ====
<pre>
*27,"E"/$C(27,69) - Reset
*27,"&l0O" - Portrait / *27,"&l1O" - Landscape
*27,"&l3E" - Top Margin is 3 lines
*27,"&a5L" - Left Margin is 5 columns
*27,"&k2G" - Line endings are LF. Default Line endings are CRLF (unless overridden in printer settings).
*27,"(s0p12h0s0b4099T" - Primary '(s' font is fixed pitch, 12 cpi, upright (not italic), not bold, and is the Courier Font (#4099).
</pre>

==== Portrait Letter 12 CPI 6 LPI ====
This is THE MOST COMMON subtype to use. Most reports in VISTA print on this one.

<pre>
NAME: P-HP-LTR-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 56
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&
k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Landscape Letter 14 CPI 6 LPI ====
This is the second most common subtype. Any menu option that says it needs 132 characters will need to use this subtype.
<pre>
NAME: P-HP-LTR-LAND-C14L6-W132 RIGHT MARGIN: 132
FORM FEED: # PAGE LENGTH: 45
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l3E",$C(27),"&a5L",$C(27),"&k
2G",*27,"(s0p14h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 14 cpi 6 lpi width 132 landscape letter printer

</pre>

==== Portrait Letter 17 CPI 7 LPI (MARs and BCMA Med Log) ====
This is the (theoretically) third most commonly used subtype. It's only used for specific reports. It's also known as a condensed print subtype.
<pre>
NAME: P-HP-LTR-POR-C17L7-W128 RIGHT MARGIN: 128
FORM FEED: # PAGE LENGTH: 64
BACK SPACE: $C(8)
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l3E",$C(27),"(s0p17h9v0s0b4099T",*27,
"&l7C" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 17 cpi 7 lpi width 128 standard letter printer (MAR)
</pre>

==== Portrait Landscape Letter 22 CPI 12 LPI ====
This is the subtype that will take the most amount of text; it's ideal to print a lot of data from Fileman, for example. It's also known as the condensed landscape print subtype. It's not commonly used except by Fileman power users.
<pre>
NAME: P-HP-LTR-LAND-C22L12-W228 RIGHT MARGIN: 228
FORM FEED: # PAGE LENGTH: 88
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l1O",$C(27),"&l4E",$C(27),"&l0D",$C(27),"&k
2G",*27,"(s0p22h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
DESCRIPTION: 22 cpi 12 lpi width 228 landscape letter printer (condensed)
</pre>

==== Portrait Legal 12 CPI 6 LPI ====
This is not commonly used; I just created this because I thought it may it come in useful for some users.
<pre>
NAME: P-HP-LGL-POR-C12L6-W80 RIGHT MARGIN: 80
FORM FEED: # PAGE LENGTH: 74
BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27),"E",$C(27),"&l3A",$C(27),"&l0O",$C(27),"&l3E",$C(27),"&
a5L",$C(27),"&k2G",*27,"(s0p12h0s0b4099T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W *27,"E"
DESCRIPTION: 12 cpi 6 lpi width 80 standard letter printer
</pre>

==== Greensheet ====
If you don't know what a green sheet is, then skip this. It's here for those who want it. You need to buy a barcode chip in order for the barcodes to print.

<pre>
NAME: P-HP-LTR-POR-GREENSHEET RIGHT MARGIN: 100
FORM FEED: # PAGE LENGTH: 58
BACK SPACE: $C(8) *OLD XY CRT: 60
OPEN EXECUTE: W *27,"E",*27,"&k2G",*27,"&l0O",*27,"&l4H",*27,"&l1E",*27,"(s0p"
_$S($G(PSDCPI)=10:"10h14",1:"12h12")_"v0s0b6T" S ($X,$Y)=0
CLOSE EXECUTE: S IONOFF="" W $C(27)_"E"
10 PITCH: $C(27)_"(s10H" 12 PITCH: $C(27)_"(s12H"
DESCRIPTION: HP JL4Si 12 pitch Courier
DEFAULT LINES PER INCH: $C(27)_"&l8C"
X LINES PER INCH: $C(27)_"&l12C"
BAR CODE OFF: "*"_$C(27)_"&l0O"_$C(27)_"(8U"_$C(27)_"(s0p"_$S($G(PSDCPI)=10:"1
0h14",1:"12h12")_"v0s0b6T"
BAR CODE ON: $S($D(PSDX2):$C(27)_"*p"_(PSDX2-1*300+200)_"y*p"_(PSDX1-1*810+38)
_"X",1:"")_$C(27)_"(0Y"_$C(27)_"(s0p8.1h12v0s0b0T*"
</pre>

==== Pharmacy Outpatient Label Printer ====
This one is a bit specialized. This is normally set-up by running routines (in this sequence) ^PSOLLU2, ^PSOLLU3, ^PSOLLU4. You need to buy a barcode chip in order for the barcodes to print.
<pre>
NAME: P-HPLJ4SI-P12 SELECTABLE AT SIGN-ON: NO
RIGHT MARGIN: 96 FORM FEED: #
PAGE LENGTH: 57 BACK SPACE: $C(8)
OPEN EXECUTE: W $C(27,69),$C(27),"&l0O",$C(27),"(0N",$C(27),"(s0p12h0s0b4099T"
W $C(27),"&k2G" S $X=0 DESCRIPTION: HP JL4Si 12 pitch Courier
NUMBER: 1 CTRL CODE ABBREVIATION: ACI
FULL NAME: ADDRESS CHANGE INITIALIZATION
CONTROL CODE: S PSOHFONT="F12",PSOX=1210,PSOY=700,PSOFY=1270
NUMBER: 2 CTRL CODE ABBREVIATION: ALI
FULL NAME: ALLERGY SECTION INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=1350,PSOYI=50,PSOYM=2700
NUMBER: 3 CTRL CODE ABBREVIATION: AWI
FULL NAME: ALLERGY WARNING INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 4 CTRL CODE ABBREVIATION: BLB
FULL NAME: BOTTLE LABEL BODY INITIALIZATION
CONTROL CODE: S PSOX=0,PSODX=275,PSOY=140,PSOYI=40,PSOYM=379,PSOFONT="F10"
NUMBER: 5 CTRL CODE ABBREVIATION: BLBC
FULL NAME: BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(s1p10.4v4,12b4,12s24670T",$C(27),"&a90P",$C(27),"*p36
50x1000Y"
NUMBER: 6 CTRL CODE ABBREVIATION: BLF
FULL NAME: BOTTLE LABEL FOOTER INITIALIZATION
CONTROL CODE: S PSODY=460,PSOX=0,PSOCX=280,PSOQY=550,PSOTY=600,PSOFONT="F10",P
SOQFONT="F8",PSODFONT="F9",PSOTFONT="F10"
NUMBER: 7 CTRL CODE ABBREVIATION: BLH
FULL NAME: BOTTLE LABEL HEADER INITIALIZATION
CONTROL CODE: S PSOX=100,PSOY=50,PSOYI=30,PSOFONT="F9"
NUMBER: 8 CTRL CODE ABBREVIATION: CDII
FULL NAME: CRITICAL DRUG INTERACTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1400,PSOYI=50,PSOFONT="F10"
NUMBER: 9 CTRL CODE ABBREVIATION: CNI
FULL NAME: COPAY NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOX=1210,PSOYM=3950,PSOFONT="F10",PSOYI=50
NUMBER: 10 CTRL CODE ABBREVIATION: EBLBC
FULL NAME: END OF BOTTLE LABEL BARCODE
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T",$C(27),"&a0P",!
NUMBER: 11 CTRL CODE ABBREVIATION: EBT
FULL NAME: END OF BARCODE TEXT
CONTROL CODE: W $C(27),"(8U",$C(27),"(s1p8v0s0b16602T",!
NUMBER: 12 CTRL CODE ABBREVIATION: F10
FULL NAME: TEN POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s0b16602T"
NUMBER: 13 CTRL CODE ABBREVIATION: F10B
FULL NAME: TEN POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p10v0s3b16602T"
NUMBER: 14 CTRL CODE ABBREVIATION: F12
FULL NAME: TWELVE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s0b16602T"
NUMBER: 15 CTRL CODE ABBREVIATION: F12B
FULL NAME: 12 POINT FONT BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p12v0s3b16602T"
NUMBER: 16 CTRL CODE ABBREVIATION: F6
FULL NAME: SIX POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s0b16602T"
NUMBER: 17 CTRL CODE ABBREVIATION: F6B
FULL NAME: SIX POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p6v0s3b16602T"
NUMBER: 18 CTRL CODE ABBREVIATION: F8
FULL NAME: EIGHT POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s0b16602T"
NUMBER: 19 CTRL CODE ABBREVIATION: F8B
FULL NAME: EIGHT POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p8v0s3b16602T"
NUMBER: 20 CTRL CODE ABBREVIATION: F9
FULL NAME: NINE POINT FONT - NO BOLD
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s0b16602T"
NUMBER: 21 CTRL CODE ABBREVIATION: F9B
FULL NAME: NINE POINT FONT, BOLDED
CONTROL CODE: W $C(27),"(10U",$C(27),"(s1p9v0s3b16602T"
NUMBER: 22 CTRL CODE ABBREVIATION: FDU
FULL NAME: FONT DISABLE UNDERLINE CONTROL CODE: W $C(27),"&d@"
NUMBER: 23 CTRL CODE ABBREVIATION: FWU
FULL NAME: FONT WITH UNDERLINE CONTROL CODE: W $C(27),"&d0D"
NUMBER: 24 CTRL CODE ABBREVIATION: LL
FULL NAME: LASER LABEL CONTROL CODE: Q
NUMBER: 25 CTRL CODE ABBREVIATION: LLI
FULL NAME: LASER LABEL INIT
CONTROL CODE: W $C(27),"&r1F",$C(27),"E",$C(27),"&l0O",$C(27),"&u300D",$C(27),
"&l3A",$C(27),"&l0E",!
NUMBER: 26 CTRL CODE ABBREVIATION: MLI
FULL NAME: MAILING LABEL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1680,PSOY=175,PSOYI=50
NUMBER: 27 CTRL CODE ABBREVIATION: NR
FULL NAME: NORMAL ROTATION CONTROL CODE: W $C(27),"&a0P"
NUMBER: 28 CTRL CODE ABBREVIATION: PFDI
FULL NAME: PHARMACY FILL DOCUMENT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=0,PSOY=690,PSOYI=40,PSOYM=969
NUMBER: 29 CTRL CODE ABBREVIATION: PFDQ
FULL NAME: PHARMACY FILL DOCUMENT QUANTITY
CONTROL CODE: S PSOX=0,PSOCX=200,PSOY=970,PSOYI=50,PSOQFONT="F8",PSOFONT="F10"
NUMBER: 30 CTRL CODE ABBREVIATION: PFDT
FULL NAME: PHARMACY FILL DOCUMENT TRAILER
CONTROL CODE: S PSOY=1015,PSOYI=45,PSOX=0,PSOFONT="F10",PSOBYI=50,PSOTFONT="F9
",PSOBY=1280
NUMBER: 31 CTRL CODE ABBREVIATION: PFDW
FULL NAME: PHARMACY FILL DOCUMENT WARNING
CONTROL CODE: S PSOY=1258,PSOX=660,PSOYI=30,PSOFONT="F8",PSOYM=1329
NUMBER: 32 CTRL CODE ABBREVIATION: PFI
FULL NAME: PATIENT FILL INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=710,PSOYI=45,PSOHFONT="F12",PSOBY
I=100
NUMBER: 33 CTRL CODE ABBREVIATION: PII
FULL NAME: PATIENT INSTRUCTION INITIALIZATION
CONTROL CODE: S PSOX=1210,PSOY=760,PSOFONT="F12"
NUMBER: 34 CTRL CODE ABBREVIATION: PMII
FULL NAME: PMI SECTION INITIALIZATION
CONTROL CODE: S PSOX=0,PSOY=1350,PSOYI=50,PSOFONT="F10",PSOYM=3899
NUMBER: 35 CTRL CODE ABBREVIATION: RMI
FULL NAME: RETURN MAIL INITIALIZATION
CONTROL CODE: S PSOHFONT="F8",PSOFONT="F10",PSOX=1680,PSOY=35,PSORYI=40,PSOHYI
=40,PSOTFONT="F8",PSOTY=550
NUMBER: 36 CTRL CODE ABBREVIATION: RNI
FULL NAME: REFILL NARRATIVE INITIALIZATION
CONTROL CODE: S PSOY=2860,PSOFONT="F10",PSOX=0,PSOYI=50,PSOYM=3950
NUMBER: 37 CTRL CODE ABBREVIATION: RPI
FULL NAME: REFILL PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOBYI=65,PSOTYI=50,PSOLX=0,PSORX=1210,PSOY=1350
,PSOYM=3650,PSOXI=90,PSOSYI=135
NUMBER: 38 CTRL CODE ABBREVIATION: RT
FULL NAME: ROTATE TEXT CONTROL CODE: W $C(27),"&a90P"
NUMBER: 39 CTRL CODE ABBREVIATION: SBT
FULL NAME: START OF BARCODE TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y",$C(27),"(s1p14
.4v6,18b6,18s24670T"
NUMBER: 40 CTRL CODE ABBREVIATION: SPI
FULL NAME: SUSPENSE PRINT INITIALIZATION
CONTROL CODE: S PSOFONT="F10",PSOX=1210,PSOY=1350,PSOYI=50,PSOCX=1775,PSOYM=27
00
NUMBER: 41 CTRL CODE ABBREVIATION: ST
FULL NAME: START OF TEXT
CONTROL CODE: S PSOY=PSOY+PSOYI W $C(27),"*p",PSOX,"x",PSOY,"Y"
NUMBER: 42 CTRL CODE ABBREVIATION: WLI
FULL NAME: WARNING LABEL INITIALIZATION
CONTROL CODE: S PSOX=1050,PSOY=55
</pre>

== Support for Advanced Subtype Specifiers ==
If you look at [http://www.va.gov/vdl/documents/Infrastructure/Kernel/krn8_0sm.pdf|the kernel system management guide], you will notice that you can use a rather obtuse syntax to customize your output on a print by print basis. E.g.:
<pre>
LASER;P-LASER-LANDSCAPE;/M132L100P16BQ2
</pre>

M stands for right margin, here set to 132; L stands for page length, here 100; P stands for pitch, here 16, can only be 10, 12 or 16; B stands for Bold; and Q stands for Quality, taking in 0, 1 or 2, here set to 2.

How to set up a device to support this isn't documented anywhere in the Kernel Manuals; I figured it out eventually by reading the %ZIS source code. You need to set up these fields as follows for each subtype:

<pre>
10 PITCH: $C(27)_"(s10h" 12 PITCH: $C(27)_"(s12h"
HIGH INTENSITY (BOLD): $C(27)_"(s3b" LOW INTENSITY (UNBOLD): $C(27)_"(s-3b"
NORMAL INTENSITY (RESET): $C(27)_"(s0b"
16 PITCH: $C(27)_"(s16h" DEFAULT PITCH: $C(27)_"(s12h"
</pre>

The only thing you may have to vary between different subtypes is what is considered a default pitch. Here it is 12, but it can be different. Reading the code, I don't believe that setting the default pitch matters since the printer gets reset every single time a job is sent, discarding the last pitch sent. I don't support 'Q' in the configuration above, so it has no effect; that's because 'Q' is nonsensical when using laser printers. It had a use back in the dot-matrix days.

VISTA Printing Printer Subtypes

2016-10-03T20:48:11Z

Shabiel: /* VISTA Subtypes */