Note: This proprietary format for submitting electronic orders is provided for the use of laboratories licensed to use Rx-Universe only. It cannot be shared with outside companies or sources without prior, written consent from Optical Laboratory Software Solutions.
Overview:
The Remote Order Entry process allows a third-party program to create an ASCII file for Rx-Universe, containing information necessary to order an Rx from the lab. This file uses the VCA convention for data transfers, with additional labels defined by Rx-Universe for fields not directly supported by the VCA device standard. These additional labels will have a suffix of an underscore “_”; for example “_FIRSTNAME”.
Rx-Universe can also create a status file which the third-party software can retrieve to obtain the status of each of the site’s job in the lab. The lab would need the Rx-Tracker module installed to accomplish this task. Figure I-1 shows this process.
Rx-Universe can also add external information to an order by using a VCA file.
This document will explain what codes you need to send to Rx-Universe, the format in which the request/orders will need to be sent to Rx-Universe and how to interpret the information that Rx-Universe sends back.
Figure 1-1
Rx-Universe Inbox (for incoming orders into the lab)
Information (RAW files) coming from the retail site will be stored in a folder determined by the lab which is located on the lab’s server. The most common method of file transfer from a retail site to the lab is via ftp, where the default folder for the ftp transfer will point to the appropriate folder. By default the folder is “OMICSTX” a subfolder of the “RXUNIVERSE” folder on the lab’s server. For example “C:\RXUNIVERSE\OMICSTX”.
Rx-Universe
...
LMS Inbox (for
...
incoming optional order information)
Some devices require external information to be available. The remote processor program will look for files in a folder based on the "Directory for incoming orders" in the Remote Parameters settings. For example “C:\RXUNIVERSE\OMICSTX\OMICSRX”LMS”.. Under this folder there is a folder for each customer created by Rx-Universe automatically, the folder name will be the account number, this is where the retail site will have to pick up the status files.
- For example “C:\RXUNIVERSE\OMICSRX\account_number”:
- “C:\RXUNIVERSE\OMICSRX\1” (status files for account 1)
- “C:\RXUNIVERSE\OMICSRX\0025” (status files for account 0025)
- “C:\RXUNIVERSE\OMICSRX\1234” (status files for account 1234)
Naming Conventions
There are naming conventions that are used for every document Rx-Universe either sends or receives and the directories they are stored in. Each of these naming conventions will be explained as we get into detail about each document.
Sending Orders To Rx-Universe
File Name:
The naming convention that is used for the order file is very important. The retailer will need to get their account number from the lab and store it somewhere in their system, since it is used in the flat file (RAW File) name.
The format of the file name is Account Number.V + sequence number (2 to 4 digits)
Example:
If the account number is “002” and this is the first order that they are sending, the text file name would be “002.V01” or “002.V0001”
The second file would be “002.V02” or “002.V0002” ... and so on. Once the sequence number reaches its upper limit, the sequence number should restart from the beginning; for example, after “002.V9999” it should be “002.V0001”.
Steps in sending an Order to the lab:
Generate ASCII text file (RAW File) for every order that has not been sent.
Send the ASCII text file(s) (RAW File) to the lab.
File Format
Each line in the ASCII file must have at least two parameters, the first parameter being the field name (label), the second parameter the field value. These parameters must be separated by an equal sign “=”. Each field must go on a different line. Field names with no underscore “_” at the beginning of its name are VCA Labels. For more detail information on VCA Labels, reference the VCA Data Communication Standard documentation.
Some fields you have to send a right value and a left value, separated by a semi-colon. These fields are indicated by the "chiral" column. Here is an example:
FIELDNAME=RightData;LeftData
SPH=-1.25;-0.75
If you are only sending Left eye information, you still have to include the semi-colon before the field value:
FIELDNAME=;LeftData
SPH=;-0.75
A complete order file will consists of many fields, with corresponding values. A list of fields is given; following the list is an example of a complete order submission.
General Information
Required column - O=optional, R=required
Chiral column - N=non-chiral (one value per label); Y=chiral (value is right, semi-colon, left - ie 2.50;1.25)
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
_CUSTNO | O | N | String | 09 | Account Number |
|
JOB | R | N | String | 21 | Job number from retail | This information is saved in the “PO#” field. |
_INV | O | N | String | 08 | Invoice number | Use this field if you want to keep the same Invoice Number as |
_OMICS_TRAY_NUM | O | N | String | 06 | Tray Number | Use this field if you want to keep the same Tray Number as
|
_JTYPE | R | N | String | 01 | Job Type | Valid Values: |
PATIENT | R | N | String | 21 | Patient Name | This field is not needed if you are using the “_FIRSTNAME” and |
_FIRSTNAME | R | N | String | 21 | First name of patient | Use either PATIENT or combination of first and last name |
_LASTNAME | R | N | String | 21 | Last name of patient | Use either PATIENT or combination of first and last name |
_RDATE | O | N | String | 08 | Date Ordered | YYYYMMDD |
_WDATE | O | N | String | 08 | Date Wanted | YYYYMMDD |
_OPT_WDATE | O | N | String | 8 | Optional date wanted | YYYYMMDD |
REF | O | N | String | 18 | Release Number |
|
SHIPTO | O | N | String | 10 | Ship to Number | Each part separated by a comma. |
REM | O | N | String | 30 | Remarks or Special Instructions.
| Can have up to 11 comment lines. |
_CALLFST
| O | N | String | 01 | Call first before processing. | Valid Entries are: |
_REMAKECODE | O | N | String | 04 | Remake code | An entry in this field sets the REDO flag on the order and |
_RUSH_JOB | O | N | String | 01 | Set Rush indicator on order | Valid Entries are: |
_DOCTOR_ID | O | N | String | 30 | Doctor’s name | |
_ORD-ORIG_INVOICE | O | N | String | 08 | Used to send the original invoice number when sending a remake job | |
_REMAKE_CAT | O | N | String | 04 | Used to send the remake category | |
_PRLIST | O | N | String | 03 | Price list number. | Specify to force pricing to a certain lab price list. |
_TRAY_COLOR | O | N | String | 03 | Used to override the tray color that would normally be associated |
|
_LAYOUT | O | N | String | 01 | Indicates whether frame measurements should be considered exact, | Valid Entries are: |
_UNCUTDIAM | O | Y | Numeric | 05 | Diameter to use for thickness for uncut job | Value >= 0 and <= 99.9 |
_USER_DEF_JF | C | N | String | 10 | User Define Job Flow Labels. |
|
Rx And Lens Information
...
DO
or
_EYE
...
R
...
String
...
01
...
Which eye
...
Valid Values:
“R” = Right
“L” = Left
“B” = Both
...
_LSTYLE
See Appendix 2
...
C
...
String
...
06
...
If _LCODE not specified, this field specifies the lab code for the lens style being ordered
...
...
_MATERIAL
See Appendix 2
...
C
...
String
...
02
...
If _LCODE not specified, this field specifies the lab code for the lens material being ordered
...
...
_TREAT
See Appendix 2
...
C
...
String
...
03
...
If _LCODE not specified, this field specifies the lab code for the treatment of the lens
being ordered (if any)
...
This is the Pretreatment that comes already on the lens from the manufacturer.
...
_TINT
See Appendix 2
...
C
...
String
...
03
...
If _LCODE not specified, this field specifies the lab code for the tint of the lens
being ordered (if any)
...
This is the Tint (Color) that comes already on the lens from the manufacturer
...
_LCODE
See Appendix 1
...
C
...
String
String
String
String
...
02
06
03
03
...
Lens Material
Lens Style
Lens Treatment
Lens Tint
Required if you are ordering lenses.
...
Refer to catalogue reference, under the lens section. This is the code from the catalogue
which specifies the lens product to order.
NOTE: you may use _LSTYLE, _MATERIAL, _TINT and _TREAT in lieu of the _LCODE
In our experience, it is easier to use the other labels than using _LCODE.
...
SPH +/-
...
R
...
Numeric
...
05
...
Rx Sphere Power
...
99.99
Range from -39.0 to +49.0 and must be a multiple of 0.125, rounded to 2
decimal places (ie. 0.12, 0.25, 0.37, etc.)
...
CYL +/-
...
O
...
Numeric
...
05
...
Rx Cylinder Power
...
99.99
Valid values range from-19.75 to +19.75, in increments of 0.125, rounded to
the nearest 2 decimal places.
...
AX
...
C
...
Integer
...
03
...
Prescribed Cylinder Axis.
This field is required if the “CYL” field is specified for the eye.
...
999
Valid values range from 1 to 180.
...
IPD
...
R
...
Numeric
...
03
...
Far PD: The far interpupillary distance for Multifocals and can be entered as
monocular or binocular PD.
or
This can also be the Horizontal Decentration.
...
Valid range values:
For monocular: 17mm to 38mm.
For Ex: IPD=30.0;30.5
For binocular: 39mm and over.
For Ex: IPD=60.0;61.0
16 or less indicates decentration. This value may be negative, indicating “out” decentration.
...
NPD
...
C
...
Numeric
...
03
...
Near PD or Vertical Decentration:
This is the near interpupillary distance for Multifocals and can be entered as
monocular or binocular PD.
or
This can also be the Vertical Decentration for Single Vision lenses.
...
Valid range values:
For monocular: 17mm to 38mm.
For Ex: IPD=30.0;30.5
For binocular: 39mm and over.
For Ex: IPD=60.0;61.0
For SV-Style lenses, this field represents the distance above or below the datum of the OC.
If the value is positive, it’s above the datum and if the value is negative, it’s below the datum.
...
OCHT
...
O
...
Numeric
...
04
...
Vertical O.C. height measured from the lower boxes tangent of the frame.
...
...
ADD
...
C
...
Numeric
...
04
...
The add power of the multifocal segment
Required for multifocal lenses
...
99.99
...
ADD2
...
C
...
Numeric
...
04
...
The add power of the upper segment in an occupational lens
...
99.99
...
SEGHT
or
SGHT
...
C
...
Numeric
...
03
...
Segment Height
Required for multifocal lenses – this is the height of the segment from the bottom of the frame.
Valid range of values is from +10.0mm to +40.0mm, in increments of 0.5mm.
...
Ex: SEGHT=19;19
...
PRVM +/-
...
O
...
Numeric
...
04
...
Rx Prism in diopters
Can specify up to 2 Rx Prisms per eye.
...
99.99
Ex:
PRVM=1.50;3.00
PRVM=0.50;0.75
...
PRVA
...
C
...
String
...
03
...
Rx Prism direction
Required if PRVM has been populated
Prism direction is the axis of the prism base, from 1 to 360 degrees
You are allowed to specify as many PRVAs as PRVMs
...
Ex:
PRVA=090;090
PRVA=000;180
...
ELLH
...
O
...
Numeric
...
02
...
Elliptical Cribbing
...
Ex: ELLH=62;62
...
_SUPELLH
...
O
...
String
...
01
...
Suppress Elliptical Cribbing
Suppress means do not do Elliptical Cribbing
...
Valid Values are:
“Y” – Do suppress
"N” or blank – Do not suppress
...
THNP
...
O
...
Numeric
...
03
...
Requested Thickness
Edge Thickness for a plus lens
Center thickness for a minus
For Uncuts with no frame: The thickness at the Crib edge
...
Ex: THNP=1.5;1.5
...
_PRTHIN
...
O
...
String
...
01
...
Prism Thinning
If you activate this option, OMICS will use the Prism Thinning value assigned to this account.
...
Valid Entries Are:
“Y” – Yes, perform Prism Thinning
“N” – No, Do Not, perform Prism Thinning
...
_ADDON
...
O
...
String
...
06
...
Add-on Codes
Can have up to 15 add-ons
...
Codes specified by receiving lab or from catalogue.
...
CLASS
...
O
...
String
String
...
03
03
...
To force Finished (Stock) or Semi-Finish lenses per eye
CLASS=FIN;SFN
...
Valid Values
“FIN” = Finished Job
“SFN” = Semi-Finished Job
This works the same way as _FORCESF_F
...
_FORCESF_F
...
O
...
String
...
01
...
To force Semi-Finish or Finished (Stock) lenses on your job
...
Valid Values:
“2” = force finished lenses
“3” = force semi-fin lenses
This works the same way as “CLASS”.
...
_RFRONT
or
MBASE
...
O
...
String
...
04
...
Requested Nominal Front Curve
...
Ex: _RFRONT=0400;0400
or
MBASE=0400;0400
...
_RDIA
...
O
...
Numeric
...
02
...
Requested Blank (Lens) Diameter
...
Ex: _RDIA=76;76
...
_LMFRID
or
LMFR
...
O
...
String
...
04
...
Lens Manufacturer
...
If you want to force Rx-Universe to select a lens from a certain manufacturer
...
OPC
...
O
...
Numeric
...
10
...
Lens OPC Code
...
Select lenses by OPC codes
...
SWIDTH
...
C
...
Numeric
...
02
...
Segment Width
Required only for certain Bifocal lenses.
This is not needed when the Lens Style selected already specify the Segment Width.
...
Ex:_SWIDTH=28;28
...
SDEPTH
...
C
...
Numeric
...
02
...
Segment Depth of the Intermediate Segment. Required only for Trifocal lenses
This is not needed when the Lens Style selected already specify the Segment Depth
...
Ex:SDEPTH=08;08
...
LNAM
...
O
...
String
...
23
...
VCA Label Translation
...
...
LTYP
...
O
...
String
...
23
...
VCA Label Translation
...
...
LMATTYPE
...
O
...
String
...
23
...
VCA Label Translation
...
...
HBOX
...
C
...
Numeric
...
03
...
Horizontal box lens size of the frame. This is the “A” measurement
This field is required if there is no pattern sent
...
Valid range of values is from 30.0 to 80.0 mm
...
VBOX
...
C
...
Numeric
...
03
...
Vertical boxes lens size of the frame. This is the “B” measurement.
This field is required if there is no pattern sent or if the HBOX measurement exists.
...
Valid range of values is from 15.0 to 60.0 mm
...
_EDBOX
...
C
...
Numeric
...
03
...
“ED” measurement of the box measurement system. The widest possible
diameter of the Frame
This field is required if there was no pattern sent and the brow, cheek,
and temple are not supplied.
...
Valid range of values is from 30.0 to 80.0 mm
...
DBL
...
R
...
Numeric
...
03
...
Distance Between Lenses
...
Valid range of values is from 7.0 to 30.0 mm
...
ETYP
...
O
...
String
...
01
...
Type of edge to cut on lens.
...
Valid Entries are:
1 – Bevel
2 – Rimless
3 – Groove
...
SFTHK
...
O
...
String
...
01
...
This field needs to be placed after the “ETYP” field
...
Y = Safety Thickness
...
FTYP
...
O
...
String
...
01
...
Frame Type
...
Valid Entries are:
1 – Zyl (Z)
2 – Metal (M)
...
_TRACE
See Appendix 3
...
O
...
String
...
12
...
Trace Number
...
Rx-Universe will look into the Pattern Database for a Frame Name matching
the value of “_TRACE”, with the Manufacturer of “DATA”, the Nominal A Size
field being blank and the Nominal Bridge field being blank.
...
_CCIRC
or
CIRC
...
O
...
Numeric
...
04
...
You can specify the actual circumference of the customer’s frame.
This will only work if a trace has been attached to the job by sending the frame trace data
or by selecting a pattern or frame with tracing information from the Rx-Universe Tracing
Database. For example, with the use of _TRACE label.
...
Ex: CIRC=138.4
...
_WRAP
...
O
...
String
...
01
...
To take advantage of the Wrap Frame Calculation.
Required: FrameWorks V2.0 (or higher) to be installed on the processing computer.
If the processing computer is connected to the server through thin client, then it has
to be installed on the server.
...
Valid Entries are:
“Y” – Yes
“N” or blank – No
...
ZTILT
...
O
...
Numeric
...
03
...
Panoramic (Wrap) Angle
Required:
_WRAP to be valid
...
Valid range of values is from 0 to 30.0 degrees
...
PANTO
...
O
...
Numeric
...
03
...
Pantoscopic (Angle) Tilt
Required:
_WRAP to be valid.
...
Valid range of values is from 0 to 30.0 degrees
...
BVD
or
_VERT_FITTING
...
O
...
Numeric
...
03
...
Vertex Fitting. Back vertex distance, as worn (mm)
Required:
_WRAP to be valid
...
Valid range of values is from 5 to 30 mm
...
RVD
...
O
...
Numeric
...
03
...
Refracted Vertex Distance - Back vertex distance, as refracted (mm)
Required:
_WRAP to be valid
...
Valid range of values is from 5 to 30 mm
...
TRCFMT
...
O
...
Numeric
...
01
...
Format of frame trace data
For more detail information, reference the VCA Data Communication
Standard documentation.
...
Valid Entries are:
0 – No Trace sent.
1, 3, 4 – supported by Rx-Universe and specified in VCA standard
2 – NOT supported by Rx-Universe
5..100 – are reserved for future standards.
...
...
...
Number
...
04
...
Number of radii in the trace
...
...
...
...
String
...
01
...
Radius mode identifier
...
Valid Entries are:
“E” – the radii are evenly spaced
“U” – the radii are unevenly spaced
...
...
...
String
...
01
...
Which eyes are included
...
Valid Entries are:
“R” – Right
“L” – Left
“B” – Both
...
ZFMT
...
O
...
Numeric
...
01
...
Format of vertical height frame trace data
For more detail information, reference the VCA Data Communication
Standard documentation.
...
Valid Entries are:
0 – No Trace sent
1, 3, 4 – supported by Rx-Universe and specified in VCA standard
2 – NOT supported by Rx-Universe
5..100 – are reserved for future standards
...
...
...
Number
...
04
...
Number of radii in the trace
...
...
...
...
String
...
01
...
Radius mode identifier
...
E – the radii are evenly spaced
U – the radii are unevenly spaced
...
...
...
String
...
01
...
Which eyes are included
...
R – Right
L – Left
B – Both
...
R
...
C
...
Numeric
...
05
...
Radius Data
For more detail information, reference the VCA Data Communication
Standard documentation.
...
Separate values for this field by a semi-colon “;” such as:
R=2479;2583;2605;2527;…
All of the records follow the 80-character line limit rule; therefore there may (in fact, will likely)
be multiple R records for each tracing. Radius is expressed in hundredths of a degree with an
implied decimal point.
...
A
...
C
...
Numeric
...
05
...
Angle data for radius data (angular locations of trace radii expressed
in R record(s))
For more detail information, reference the VCA Data Communication
Standard documentation.
...
Separate values for this field by a semi-colon “;” such as:
A=010;015;020;025;…
...
Z
...
C
...
Numeric
...
05
...
Radius Data
For more detail information, reference the VCA Data Communication
Standard documentation.
...
The files placed in this folder must be names as follows, "order#.LMS". The information in these files will be stored on the specified order in the VCA overrides data.
An example of file contents would be:
ANS=LMS
STATUS=0;
JOB=13000423
LDDRSPH=5.00;5.30
LDDRCYL=-0.52;-0.50
LDDRAX=90;71
LDDADD=2.43;2.40
LDDPRVM=1.25;1.25
LDDPRVA=270;270
When the Remote processor has reviewed the file, it will be moved to a subfolder called "PROCESSED", if there was an error with the file, it will be placed in a subfolder called "ERRORS". The number of LMS files processed and the number of errors encountered can be seen on the main Remote processor window.
If you need to troubleshoot the files in the "ERRORS" folder, you can turn on the "HOYA LMS log" in the "Remote Parameters" settings screen, then move the files from the "ERRORS" folder to the "LMS" folder for reprocessing. A log file called "HOYALMS.LOG" will be created in the RxUniverse folder. Remember to turn the log fill off when you are done troubleshooting.
Rx-Universe Outbox (for outgoing status results)
Information that is sent back from Rx-Universe will be located in this directory, which is usually called “OMICSRX” – this is usually a subfolder below the default “RXUNIVERSE” folder on the lab’s server. For example “C:\RXUNIVERSE\OMICSRX”. Under this folder there is a folder for each customer created by Rx-Universe automatically, the folder name will be the account number, this is where the retail site will have to pick up the status files.
- For example “C:\RXUNIVERSE\OMICSRX\account_number”:
- “C:\RXUNIVERSE\OMICSRX\1” (status files for account 1)
- “C:\RXUNIVERSE\OMICSRX\0025” (status files for account 0025)
- “C:\RXUNIVERSE\OMICSRX\1234” (status files for account 1234)
Naming Conventions
There are naming conventions that are used for every document Rx-Universe either sends or receives and the directories they are stored in. Each of these naming conventions will be explained as we get into detail about each document.
Sending Orders To Rx-Universe
File Name:
The naming convention that is used for the order file is very important. The retailer will need to get their account number from the lab and store it somewhere in their system, since it is used in the flat file (RAW File) name.
The format of the file name is Account Number.V + sequence number (2 to 4 digits)
Example:
If the account number is “002” and this is the first order that they are sending, the text file name would be “002.V01” or “002.V0001”
The second file would be “002.V02” or “002.V0002” ... and so on. Once the sequence number reaches its upper limit, the sequence number should restart from the beginning; for example, after “002.V9999” it should be “002.V0001”.
Steps in sending an Order to the lab:
Generate ASCII text file (RAW File) for every order that has not been sent.
Send the ASCII text file(s) (RAW File) to the lab.
File Format
Each line in the ASCII file must have at least two parameters, the first parameter being the field name (label), the second parameter the field value. These parameters must be separated by an equal sign “=”. Each field must go on a different line. Field names with no underscore “_” at the beginning of its name are VCA Labels. For more detail information on VCA Labels, reference the VCA Data Communication Standard documentation.
Some fields you have to send a right value and a left value, separated by a semi-colon. These fields are indicated by the "chiral" column. Here is an example:
FIELDNAME=RightData;LeftData
SPH=-1.25;-0.75
If you are only sending Left eye information, you still have to include the semi-colon before the field value:
FIELDNAME=;LeftData
SPH=;-0.75
A complete order file will consists of many fields, with corresponding values. A list of fields is given; following the list is an example of a complete order submission.
General Information
Required column - O=optional, R=required, C=conditional (dependent on other tags)
Chiral column - N=non-chiral (one value per label); Y=chiral (value is right, semi-colon, left - ie 2.50;1.25)
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
_CUSTNO | O | N | String | 09 | Account Number | |
JOB | R | N | String | 20 | Job number from retail | This information is saved in the “PO#” field. |
_INV | O | N | String | 08 | Invoice number | Use this field if you want to keep the same Invoice Number as |
_OMICS_TRAY_NUM | O | N | String | 06 | Tray Number | Use this field if you want to keep the same Tray Number as |
_JTYPE | R | N | String | 01 | Job Type | Valid Values: |
PATIENT | C | N | String | 21 | Patient Name | This field is not needed if you are using the “_FIRSTNAME” and |
_FIRSTNAME | C | N | String | 21 | First name of patient | Use either PATIENT or combination of first and last name |
_LASTNAME | C | N | String | 21 | Last name of patient | Use either PATIENT or combination of first and last name |
_RDATE | O | N | String | 08 | Date Ordered | YYYYMMDD |
_WDATE | O | N | String | 08 | Date Wanted | YYYYMMDD |
_OPT_WDATE | O | N | String | 8 | Optional date wanted | YYYYMMDD |
REF | O | N | String | 18 | Release Number | |
SHIPTO | O | N | String | 10 | Ship to Number | Each part separated by a comma. |
_SHIPMETHOD or _SHIPMETH | O | N | String | 04 | Shipping Method Code | |
REM | O | N | String | 30 | Remarks or Special Instructions. | Can have up to 11 comment lines. |
_CALLFST
| O | N | String | 01 | Call first before processing. | Valid Entries are: |
_REMAKECODE | O | N | String | 04 | Remake code | An entry in this field sets the REDO flag on the order and |
_RUSH_JOB | O | N | String | 01 | Set Rush indicator on order | Valid Entries are: |
_DOCTOR_ID | O | N | String | 30 | Doctor’s name | |
_ORD_ORIG_INVOICE | O | N | String | 08 | Used to send the original invoice number when sending a remake job | |
_REMAKE_CAT | O | N | String | 04 | Used to send the remake category | |
_PRLIST | O | N | String | 03 | Price list number. | Specify to force pricing to a certain lab price list. |
_TRAY_COLOR | O | N | String | 03 | Used to override the tray color that would normally be associated | |
_LAYOUT | O | N | String | 01 | Indicates whether frame measurements should be considered exact, | Valid Entries are: |
_UNCUTDIAM | O | Y | Numeric | 05 | Diameter to use for thickness for uncut job | Value >= 0 and <= 99.9 |
_USER_DEF_JF | C | N | String | 10 | User Define Job Flow Labels. | |
_FSTATUS | O | N | String | 01 | Frame status for the order | Valid Entries are: "1" or "S"- Supply frame "2" or "F" - Frame to follow "3" or "O" - Other "4" or "E" - Frame enclosed "5" or "L" - Lenses only "6" OR "N" - Supply frame at no charge |
_ROUTE | O | N | String | 04 | Work ticket routing for work ticket | LPT1, LPT2, up to LPT9 If used, this directs the work ticket to be printed to the specified printer routing. If left blank, normal routing rules will be used when the order is processed. |
_BALANCE | O | N | String | 01 | Indicates one eye is a balance lens | Valid entries are R, L or blank _BALANCE=R (introduced in version 7.52) |
_HOLDORDER | O | N | String | 01 | Makes the order processor place an order on hold | Valid entries are Y N or blank |
_REMOTE_USER_NAME | O | N | String | 20 | Name of the user entering the remote order | Introduced in version 7.73 |
Rx And Lens Information
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
DO | R | Y | String | 01 | Which eye | Valid Values: |
_LSTYLE | C | Y | String | 06 | If _LCODE and UPC are not specified, this field specifies the lab code for the lens style being ordered | |
_MATERIAL | C | Y | String | 02 | If _LCODE and UPC are not specified, this field specifies the lab code for the lens material being ordered | |
_TREAT | C | Y | String | 03 | If _LCODE and UPC are not specified, this field specifies the lab code for the treatment of the lens | This is the Pretreatment that comes already on the lens from the manufacturer. |
_TINT | C | Y | String | 03 | If _LCODE and UPC are not specified, this field specifies the lab code for the tint of the lens | This is the Tint (Color) that comes already on the lens from the manufacturer |
_LCODE | C | Y | String | 02 | Lens Material | Refer to catalogue reference, under the lens section. This is the code from the catalogue You may also use UPC with the UPC translation table to specify materials, lens styles, |
SPH +/- | R | Y | Numeric | 05 | Rx Sphere Power | Range from -39.0 to +49.0 and must be a multiple of 0.125, rounded to 2 |
CYL +/- | O | Y | Numeric | 05 | Rx Cylinder Power | Valid values range from-19.75 to +19.75, in increments of 0.125, rounded to |
AX | C | Y | Integer | 03 | Prescribed Cylinder Axis. | Valid values range from 0 to 180. |
IPD | R | Y | Numeric | 03 | Far PD: The far interpupillary distance for Multifocals and can be entered as | Valid range values: |
NPD | C | Y | Numeric | 03 | Near PD or Vertical Decentration: | Valid range values: For SV-Style lenses, this field represents the distance above or below the datum of the OC. |
OCHT | O | Y | Numeric | 04 | Vertical O.C. height measured from the lower boxes tangent of the frame. | |
ADD | C | Y | Numeric | 04 | The add power of the multifocal segment; required for multifocal lenses | 99.99 |
ADD2 | C | Y | Numeric | 04 | The add power of the upper segment in an occupational lens | 99.99 |
SEGHT | C | Y | Numeric | 03 | Segment Height | Ex: SEGHT=19;19 |
SEGDHT | O | Y | Numeric | 04 | The field contains the length in millimeters from the top of the segment or fitting cross (if progressive type lens) or the vertical decentration point of a single vision lens, to the point where the vertical line would cross the frame. The position of the line would be vertically from the distance power location (see diagram).
When the SEGDHT is supplied, the value is used along with a trace pattern, to calculate the value of SEGHT of a multi-focal lens or the vertical decentration of a single vision lens.. | Ex: SEGDHT=10.2;10.2 |
PRVM +/- | O | Y | Numeric | 04 | Rx Prism in diopters | Ex: |
PRVA | C | Y | String | 03 | Rx Prism direction | Ex: |
ELLH | O | Y | Numeric | 02 | Elliptical Cribbing | Ex: ELLH=62;62 |
_SUPELLH | O | Y | String | 01 | Suppress Elliptical Cribbing | Valid Values are: |
THNP | O | Y | Numeric | 03 | Requested edge thickness at the thinnest edge | Ex: THNP=1.5;1.5 |
_PRTHIN | O | N | String | 01 | Prism Thinning | Valid Entries Are: |
_ADDON | O | N | String | 06 | Add-on Codes | Codes specified by receiving lab or from catalogue. As of version 7.59.02, _ADDON can also be specified as: |
CLASS | O | Y | String String | 03 03 | To force Finished (Stock) or Semi-Finish lenses per eye | Valid Values |
_FORCESF_F | O | Y | String | 01 | To force Semi-Finish or Finished (Stock) lenses on your job | Valid Values: |
_RFRONT | O | Y | String | 04 | Requested Nominal Front Curve | Ex: _RFRONT=0400;0400 |
_RDIA | O | Y | Numeric | 02 | Requested Blank (Lens) Diameter | Ex: _RDIA=76;76 |
_LMFRID | O | Y | String | 04 | Lens Manufacturer | If you want to force Rx-Universe to select a lens from a certain manufacturer |
OPC | O | Y | Numeric | 10 | Lens OPC Code | Select lenses by OPC codes |
SWIDTH | C | Y | Numeric | 02 | Segment Width | Ex:_SWIDTH=28;28 |
SDEPTH | C | Y | Numeric | 02 | Segment Depth of the Intermediate Segment. Required only for Trifocal lenses | Ex:SDEPTH=08;08 |
LNAM | O | Y | String | 23 | VCA Label Translation | |
LTYP | O | Y | String | 23 | VCA Label Translation | |
HBOX | C | O | Numeric | 03 | Horizontal box lens size of the frame. This is the “A” measurement | Valid range of values is from 30.0 to 80.0 mm |
VBOX | C | O | Numeric | 03 | Vertical boxes lens size of the frame. This is the “B” measurement. | Valid range of values is from 15.0 to 60.0 mm |
_EDBOX | C | O | Numeric | 03 | “ED” measurement of the box measurement system. The widest possible | Valid range of values is from 30.0 to 80.0 mm |
FED | C | N | Numeric | 03 | FED or ED measurement of the frame - same as _EDBOX | Valid range is from 30.0 to 80.0 mm |
DBL | C | N | Numeric | 03 | Distance Between Lenses | Valid range of values is from 7.0 to 30.0 mm |
ETYP | O | N | String | 01 | Type of edge to cut on lens. | Valid Entries are: |
SFTHK | O | N | String | 01 | This field needs to be placed after the “ETYP” field | Y = Safety Thickness |
FTYP | O | N | Numeric | 01 | Frame Type | Valid Entries are: |
_SHAPE | O | N | String | Stored trace in RxUniverse that are saved as shapes (SHAP) names | Rx-Universe will look into the Trace Database for a Frame Name matching the value of “_SHAPE”, with the Manufacturer of “SHAP”. The VBOX and HBOX fields are checked against the stored shape's values and the _SHAPE trace will be resized accordingly and an INV# trace will be created using the order number as the trace name with the resized trace information and this will be attached to the received order. If no VBOX or HBOX values were supplied in the remote order file, then the _SHAPE name is stored as the trace information name on the order with no adjustments made to the trace. Note the _SHAPE traces are for calculations only and cannot be used on an edging machine. | |
_TRACE | O | N | String | 12 | Trace Number | Rx-Universe will look into the Pattern Database for a Frame Name matching the value of “_TRACE”, with a Manufacturer of “DATA”, the Nominal A Size field being blank and the Nominal Bridge field being blank. The VBOX and HBOX fields are checked against the stored trace's values and the _TRACE data points will be resized accordingly and an INV# trace will be created using the order number as the trace name and the resized trace information, this INV# trace will be attached to the received order. If no VBOX or HBOX values were supplied in the remote order file, then the _TRACE name is stored as the trace information name on the order with no adjustments made to the trace. |
_CCIRC | O | N | Numeric | 04 | You can specify the actual circumference of the customer’s frame. | Ex: CIRC=138.4 |
_SLAB | O | N | String | 01 | Slab-Off | Valid Entries are: "Y" - Yes "N", "?", spaces or ":" - No "R" - Reverse |
_WRAP | O | N | String | 01 | To take advantage of the Wrap Frame Calculation. | Valid Entries are: |
ZTILT | O | N | Numeric | 03 | Panoramic (Wrap) Angle | Valid range of values is from 0 to 30.0 degrees |
PANTO | O | N | Numeric | 03 | Pantoscopic (Angle) Tilt | Valid range of values is from 0 to 30.0 degrees |
BVD | O | N | Numeric | 03 | Vertex Fitting. Back vertex distance, as worn (mm) | Valid range of values is from 5 to 30 mm |
RVD | O | N | Numeric | 03 | Refracted Vertex Distance - Back vertex distance, as refracted (mm) | Valid range of values is from 5 to 30 mm
|
TRCFMT | O | N | Numeric | 01 | Format of frame trace data | Valid Entries are: |
Number | 04 | Number of radii in the trace | ||||
String | 01 | Radius mode identifier | Valid Entries are: | |||
String | 01 | Which eyes are included | Valid Entries are: | |||
ZFMT | O | N | Numeric | 01 | Format of vertical height frame trace data | Valid Entries are: |
Number | 04 | Number of radii in the trace | ||||
String | 01 | Radius mode identifier | E – the radii are evenly spaced | |||
String | 01 | Which eyes are included | R – Right | |||
R | C | N | Numeric | 05 | Radius Data | Separate values for this field by a semi-colon “;” such as: |
A | C | N | Numeric | 05 | Angle data for radius data (angular locations of trace radii expressed | Separate values for this field by a semi-colon “;” such as: |
Z | C | N | Numeric | 05 | Radius Data | Separate values for this field by a semi-colon “;” such as: |
CTHICK | O | Y | Numeric | 05 | Center thickness - used only if a specific center thickness is desired for the lens. This can | CTHICK=2.3;2.3 |
UPC | O | Y | Numeric | 12 | This is a translation code that can be used with the UPC translation file to specify either lens style, material, tint and treatment, or an addon code. This allows a third party system to send one code that can be translated on the Rx-Universe side into the lab's codes for the lens product. |
Frame and Miscellaneous Inventory Items
If the lab uses the Rx-Universe Frame Inventory module, then frames, fronts, temples, bridges, side shields and miscellaneous items can be specified in the remote order. (added in version 7.35.00 of Rx-Universe)
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
_FRMID | O | N | String | 80 | This field can be used to specify the frame (or front or bridge) in three ways:
| Required if "S"upply frame, and lab is using the frame inventory module. Examples:
|
_FRPID | O | N | String | 12 | Internal ID number or UPC of a temple (only valid if first field referred to a frame front) A temple can also be specified using the same formats as #2 and #3 for _FRMID | Required if "S"upply frame, and the frame was just a front piece |
_FRSID | O | N | String | 12 | Internal ID number or UPC of a side-shield A side shield can also be specified using the same formats as #2 and #3 for _FRMID | Required if "S"upply frame, and the frame was just a front piece. It is optional if the frame was a full frame |
_FSTATUS | O | N | String | 01 | Valid Entries are: "1" or "S"- Supply frame "2" or "F" - Frame to follow "3" or "O" - Other "4" or "E" - Frame enclosed "5" or "L" - Lenses only "6" OR "N" - Supply frame at no charge | |
FUPC | O | N | Numeric | 12 | This is the UPC number corresponding to the frame; it can be up to 12 numeric digits | ex. FUPC=112233445566 |
_MISC | O | N | String | 50 | This is an identifier for a miscellaneous item, such as a frame case, cleaning cloth, etc.
In the second format, the name and manufacturer should be separated by commas, and both values must match exactly with how the item is stored in Rx-Universe frame inventory. | ex. _MISC=123456789012 _MISC=RED CASE,SAFILO |
Optional Fields
Optional fields are parameters that are not required for all Rx's, but might be required for specific lens designs. For example, the Varilux S 4D lens style requires head-eye coefficient to be specified by the dispenser.
If sent, the values will be used if applicable for the lens design ordered.
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
CLINIT |
N | String |
Wearer’s Initials | up to 4 alphanumeric characters | ||
CLHT |
N | Numeric |
Client Height in meters |
HEADK |
N | Numeric |
Head Eye Coefficient | Measured by Visi-Office | ||
HEADS |
N | Numeric |
Stability Coefficient | Measured by Visi-Office | ||
_NVI |
Y | Numeric |
Near Vision Inset | Inset of the near vision segment relative | ||
NWD |
N | Numeric |
Near Working Distance | Working object distance at near viewing | ||
ERCD |
Y | Numeric |
Eye Rotation Center Distance | Measured by Visi-Office | ||
CAPE |
Y | Numeric |
Cape Head Angle | Measured by Visi-Office |
_LP
Progression Length (corridor length)
Valid values vary by design
Typically 13, 14, 15, etc., in 1/10 increments
DMNTEYE
Dominant Eye
R-right, L-left, or N-none
_CLLAT
or
CLHLAT
Laterality (Dominant Hand)
Valid Entries are:
“R” – Right
“L” – Left
"N" - none
NOD
Numeric
Refracted object distance at near viewing point (meters)
Valid values 0.20 to 0.60 m
...
-10 to +10 | ||||||
_LP | Y | Progression Length (corridor length) | Valid values vary by design | |||
DMNTEYE | N | Dominant Eye | R-right, L-left, or N-none | |||
_CLLAT | N | Laterality (Dominant Hand) | Valid Entries are: | |||
NOD | Y | Numeric | Refracted object distance at near viewing point (meters) | Valid values 0.20 to 0.60 m | ||
CLNVB | N | String | 7 | Near Vision Behaviour, used for Essilor Varilux X designs | Must be 7 alphanumeric characters; for example CLNVB=HCN7DEV( | |
CCBLND or _LTLVL | O | Y | Numeric | 2 | Digital Lenticular Blending | A value between 0 and 10 depending on the digital type. 0-2 for "Essilor", "Crossbows", "Rx-Me", "Rx-PRO" and "A2Vision". 0-10 for all other digital vendors. |
CCBOWL or _LTDIA | O | Y | Numeric | 2 | Digital Lenticular Bowl | A value between 30 and 90 |
CLLIFE | O | N | String | CLLIFE option for specified digital design(s) | Valid values are "Static" or "Active" |
This ASCII text file will be generated at the retail site and be sent to the lab from which they are placing their order. The following is an example of items you can find in an order file (RAW file):
PATIENT="JOHNNY WISHBONE"
_RDATE=20150120
_WDATE=20150125JOB="7430004"
_INVJOB="7430004"
REM="PLEASE SHIP UPS"
DO=B
_JTYPE=1
_LSTYLE=SV;SV
_MATERIAL=P;P
SPH=+01.00;+02.25
CYL=-01.00;-01.00
AX=88;159
IPD=30.0;29.0
HBOX=62.5
VBOX=39.4
DBL=16.0
FTYP=2
ETYP=1
TRCFMT=1;400;E;R;F
R=2559;2567;2575;2584;2593;2601;2611;2620;2628;2638;2646;2655;2664;2672;2681
R=2690;2699;2707;2715;2723;2730;2736;2743;2747;2751;2753;2755;2756;2755;2755
R=2754;2753;2750;2746;2741;2737;2732;2726;2718;2711;2703;2694;2685;2675;2666
R=2656;2645;2634;2623;2611;2599;2587;2575;2563;2552;2539;2527;2514;2502;2490
R=2479;2468;2455;2443;2431;2419;2408;2396;2386;2375;2365;2355;2345;2336;2329
R=2321;2312;2304;2297;2292;2285;2279;2274;2269;2264;2260;2257;2253;2250;2247
R=2245;2243;2242;2241;2240;2240;2239;2239;2239;2241;2243;2245;2248;2251;2255
R=2258;2263;2268;2273;2278;2284;2290;2296;2303;2311;2318;2326;2334;2343;2353
R=2363;2374;2384;2395;2405;2417;2429;2441;2454;2468;2480;2493;2506;2516;2526
R=2547;2556;2571;2585;2598;2611;2625;2637;2650;2662;2671;2684;2693;2703;2711
R=2720;2726;2732;2735;2739;2741;2745;2746;2749;2750;2750;2750;2750;2749;2746
R=2743;2739;2734;2729;2723;2719;2712;2706;2701;2697;2692;2688;2682;2676;2671
R=2666;2660;2656;2652;2648;2644;2642;2639;2637;2635;2633;2630;2628;2626;2624
R=2622;2620;2619;2618;2617;2617;2617;2617;2618;2618;2619;2621;2622;2625;2627
R=2629;2632;2636;2639;2643;2646;2650;2654;2658;2661;2665;2668;2672;2675;2678
R=2680;2682;2683;2684;2686;2690;2693;2696;2698;2700;2701;2701;2701;2702;2702
R=2700;2697;2694;2690;2686;2682;2677;2671;2666;2659;2652;2644;2635;2625;2615
R=2605;2595;2583;2572;2561;2549;2539;2528;2516;2503;2491;2481;2471;2458;2447
R=2436;2425;2414;2405;2395;2386;2378;2370;2362;2355;2347;2340;2331;2324;2317
R=2310;2303;2298;2293;2288;2283;2278;2274;2269;2265;2262;2260;2257;2254;2251
R=2248;2245;2243;2242;2240;2239;2238;2238;2237;2237;2237;2237;2237;2237;2237
R=2237;2237;2238;2238;2239;2239;2240;2242;2243;2244;2246;2249;2251;2253;2255
R=2258;2260;2263;2265;2268;2271;2273;2276;2278;2281;2283;2284;2286;2288;2291
R=2292;2295;2296;2299;2300;2302;2304;2305;2307;2310;2312;2313;2315;2317;2319
R=2321;2324;2325;2328;2331;2335;2337;2340;2343;2347;2350;2355;2359;2363;2370
R=2375;2379;2385;2391;2397;2403;2409;2414;2421;2429;2435;2443;2449;2457;2464
R=2472;2481;2489;2498;2506;2516;2525;2533;2542;2550
TRCFMT=1;400;E;L;F
R=2547;2547;2548;2548;2549;2550;2550;2551;2552;2553;2553;2554;2556;2557;2557
R=2559;2560;2561;2562;2564;2565;2566;2567;2569;2570;2572;2574;2576;2578;2580
R=2582;2584;2586;2588;2590;2591;2593;2595;2597;2599;2602;2604;2606;2608;2610
R=2612;2614;2616;2618;2619;2620;2623;2625;2628;2631;2634;2637;2639;2637;2630
R=2619;2605;2590;2575;2558;2543;2530;2517;2503;2489;2475;2462;2447;2435;2424
R=2410;2399;2386;2375;2363;2352;2342;2333;2323;2314;2307;2299;2291;2284;2277
R=2272;2266;2261;2255;2250;2246;2242;2239;2236;2233;2233;2230;2229;2229;2229
R=2229;2229;2231;2232;2234;2236;2238;2242;2246;2249;2254;2259;2264;2269;2274
R=2280;2286;2292;2299;2307;2315;2323;2332;2342;2351;2361;2369;2379;2388;2398
R=2408;2417;2428;2439;2450;2460;2471;2482;2493;2505;2516;2527;2538;2549;2560
R=2570;2580;2591;2601;2610;2619;2627;2636;2644;2651;2658;2665;2672;2679;2684
R=2689;2692;2695;2697;2697;2698;2697;2696;2695;2692;2689;2685;2680;2674;2668
R=2660;2653;2643;2635;2627;2618;2610;2601;2593;2584;2575;2566;2557;2546;2537
R=2528;2518;2509;2499;2490;2480;2471;2462;2452;2444;2435;2426;2417;2409;2400
R=2392;2384;2377;2370;2363;2357;2351;2345;2340;2336;2331;2326;2322;2316;2312
R=2306;2302;2297;2293;2290;2286;2283;2280;2277;2274;2272;2268;2266;2263;2261
R=2258;2256;2253;2250;2248;2246;2243;2242;2240;2237;2236;2233;2232;2230;2227
R=2226;2224;2222;2221;2219;2217;2215;2215;2214;2212;2212;2210;2208;2207;2205
R=2205;2203;2201;2200;2198;2196;2194;2194;2192;2191;2191;2190;2191;2190;2191
R=2191;2191;2193;2194;2195;2197;2198;2198;2202;2204;2208;2209;2213;2215;2218
R=2222;2226;2230;2235;2239;2244;2249;2254;2260;2266;2272;2277;2284;2291;2298
R=2306;2314;2323;2332;2340;2348;2357;2368;2377;2387;2394;2405;2414;2424;2434
R=2444;2456;2468;2477;2490;2501;2511;2525;2536;2548;2559;2569;2580;2593;2603
R=2614;2617;2615;2611;2607;2604;2602;2599;2597;2594;2592;2590;2588;2586;2584
R=2581;2579;2578;2576;2574;2572;2570;2568;2566;2564;2562;2561;2560;2558;2557
R=2556;2555;2554;2553;2552;2551;2550;2549;2548;2548;2547;2547;2547;2546;2546
R=2546;2545;2545;2546;2545;2545;2546;2546;2546;2547
EOJ=END OF JOB
...
Sending Status Requests / Other
(See Appendix 4)
You can make requests from the lab through Rx-Universe; the types of requests that you can make are as follows:
Request quote (Rx-Invoice and Rx-Connect Modules Required at the Lab)
Request order status (Rx-Tracker and Rx-Connect Modules Required at the Lab)
Request to cancel the order
Request to hold the order
Request to ship the order
To do this, you basically have to send the ASCII order file again, with only these fields:
JOB=12345
_ACTION=3
Field Name | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|
JOB | String | 07 | The original Job or PO number of the job that you are inquiring about. |
_ACTION | Numeric | 01 | The type of request you are making. | Valid Entries are: |
Receiving Order Status
(See Appendix 4)
Order Status are received after an order is sent or the user can specifically make an order request. The retail system will have to pick the order status up from the lab. After an order is processed it creates a file in a folder that is specified in the Rx-Universe Remote Order Processing Options screen + “\” + Retail Account Number. The file name will consist of the “Job Number”.STA
...
ACCN="1234"
JOB="35"
_STATUS=7
_LABSTAT="In lab"
_ESTCOMP=20090929
_ESTCOST= 137.89
_INVNO=356186
...
Field Name | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|
_LABID | String | 12 | The lab number |
ACCN | String | 08 | The retailer’s account number with the lab |
JOB | String | 21 | Job or PO number |
_STATUS | Numeric | 02 | Order Status Code | Valid Entries are: |
_LABSTAT | String | 60 | Order Status Description | (see above field) |
_LABREM | String | 30 | Lab Remarks | Can occur multiple times |
_ESTCOMP | Date | 08 | Estimated Completion Date | YYYYMMDD |
_ESTCOST | Numeric | 10 | Estimated Cost | 99999999.99 |
_INVNO | Numeric | 08 | Invoice Number | 99999999 |
Appendix 1:
_LCODE:
RAW File:
DO=B
_LCODE=C IMAGE TR7BN3;C IMAGE TR7BN3
O/E Rx Screen:
...
Appendix 2:
_LSTYLE, _MATERIAL, _TINT and _TREAT:
...
DO=B
_LSTYLE=IMAGE;IMAGE
_MATERIAL=C;C
_TREAT=TR7;TR7
_TINT=BN3;BN3
O/E Rx Screen:
...
Appendix 3:
_TRACE:
RAW File:
_TRACE="FRAME-1
...
"
O/E Rx Screen:
...
In the Frame Traces:
...
Appendix 4 - Sending and Receiving Order Status:
Lab’s Rx-Universe requirements:
...
VBOX=35
_EDBOX=55
EOJ=END OF JOB
...
File 1.V0055: This is an example of a Status Request file that the 3rd party software would send to the “\RXUNIVERSE\OMICSTX” folder on the lab’s server. You need to send one Status Request file for each individual order you want status information. Once in the “OMICSTX” folder, the Remote Processor (Rx-Connect) will process the file (request). More information in the “Sending Status Requests / Other” section.
JOB="20001"
_ACTION=3
...
File 20001.STA: This is an example of a Status Result file that will be created in the “\RXUNIVERSE\OMICSRX\account_number” folder after Rx-Universe Remote Processor (Rx-Connect) processes the “1.V0055” Status Request file.
- For example: “C:\RXUNIVERSE\OMICSRX\1\”.
- This folder is setup in the “Remote Order Processing Options:
...
...
- Then the 3rd party software (system) would have to retrieve this file and import it into their system. More information in the “Receiving Order Status” section.
...
File 20001.STA:
ACCN="1 "
...
_ESTCOST= 330.00
_INVNO=206128
...