The Apteryx Imaging applications support multiple command line options for opening patients from the standard application command line. The XrayVision executable filename is "XVAssistant.exe" or "XrayVision.exe" while the XVLite executable filename is "XVLite.EXE".
Example: XVAssistant.exe -n"Doe, John"
Select a topic below or scroll down for complete information:
The installation locations of the XrayVision or XVLite versions on the network can be found under the HKEY_LOCAL_MACHINE\SOFTWARE\Apteryx\ApplicationLocations registry key. The XrayVision installation path (if it exists) can be found under the "XVa3" registry value while the XVLite installation path (if it exists) can be found under the "XVLite" registry value. Please note that these locations are target paths for the various programs and may potentially be an OEM version of the program. For more information on OEM versions, please refer to the OEM section of this documentation.
While all derivations of both XrayVision and XVLite utilize the same registry keys, the specific executable filename may vary depending on what OEM version of the application has been installed. In other words, while Apteryx distributes these applications under the XVAssistant, XrayVision and XVLite names, other companies may distribute the same basic program with a different label. The following lists outline the possible EXE filenames for the different OEMs of Apteryx products.
XrayVision: "XrayVision.exe"; "XVAssistant.exe"; "CliniView.exe"; "CliniViewXV.exe"; "CliniViewCP.exe"; "Ximage.exe"; "ProfSuni.exe"; "ImageDDS.exe"; "ImageXL.exe".
XVLite: "XVLite.exe"; "DrSuni.exe"; "CliniTouch.exe"; "Lightyear.exe".
When a patient is created in XV or XVLite, the patient's folder generated behind the scenes is created using the following patient information:
Example: "DOEJANE_999999999_28"
If any of the above strings are greater than 9 characters, it will be truncated to 9 characters when the folder is created.
Command line flags are preceded by either a '-' or a '/' and indicate that the specified type of data is to follow the flag.
Example: XVAssistant.exe -n "name"
Example: XVAssistant.exe /n "name"
Example: XVAssistant.exe /i"id _number"
Command line arguments that are not preceded by a command line flag are interpreted as filenames. Any files specified on the command line will automatically be opened by the application.
Example: XVAssistant.exe c:\temp\filename.ext
The XVa3 application can handle more than one set of command line parameters at a time.
Example: XVAssistant.exe c:\temp\filename.ext -n"Doe, John" -i 11223344
Spaces may appear between the flag and the value.
Example: XVAssistant.exe /n"name"
Example: XVAssistant.exe /n "name"
Flags such as the 'P' flag require the specification of multiple sets of data. Usually, this data is separated by one or more delimiters (e.g. "::"). Flags that contain multiple sets of data should be placed within double quotes.
Example: XVAssistant.exe /p"name::ss_number::id_number"
Example: XVAssistant.exe /p"name::::id_number"
a -or- A (Acquire Image)
This option can be used to invoke an image acquisition. This option requires a parameter and can be one of the following keys: "Any" - prompts the user to select which imaging device should be used; "Sensor" - prompts the user to select which sensor system should be used; "Layout" - prompts the user to select what layout should be used; "DirectVideo" - automatically starts acqusition from direct video; XrayVision extension filename - a specific name of an imaging extension to the imaging software (without the path specified). This can be any of the imaging extensions to the imaging application including SEDs, IDDLLs and DCDLLs.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /a "Any"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /a "Sensor"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /a "Layout"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /a "Test.SED"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /a "ADF Scanner.IDDLL"
b -or- B (Patient Image Bar)
This command is identical to the p command with the added functionality of automatically bringing up the image bar for the specified patient. Using this parameter does not bring the XVa3 application to the foreground (if the XVa3 application is not currently running it is started and immediately minimized). This command can be used to display the images for the specified patient without having to display the XVa3 application.
When the specified patient does NOT exist, the '/b' and '/B' options perform differently. If the patient does not exist and the '/B' option was specified, the patient is NOT created and nothing is displayed. If the patient does not exist and the '/b' option was specified, the user is prompted if the patient should be created.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /b"lastname, firstname::123-45-6789::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /b"lastname, firstname::::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /b"lastname, firstname::123-45-6789::::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /b"lastname, firstname::123-45-6789::123456"c -or- C (Convert Image File)
This option instructs XrayVision to convert the specified file into JPEG. The parameter has the following format: /t"source_filename;target_filename;error_msg_filename;event_name". Please note that only v3.9 b116 and higher support this command line parameter. The source_filename does not have to be located in an XrayVision patient directory. The converted image will be saved in the JPEG format to the file specified by target_filename. This conversion works for all files types supported by XrayVision and will convert layouts into single images. If an error occurs the error message will be saved into the file specified by error_msg_filename (upon successful operation, this file will contain the text "Success"). Upon success or error, the event specified by event_name will be signaled.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /c"C:\Program Files\Apteryx\Patients\SomePatientDirectory\SomeFilename.Auto;C:\ConvertedImage.JPG;C:\ConvertedMessage.TXT;MyEvent"
d -or- D (Data Tag Specification)
This option can be used to specify auto data tags that will be associated with images that are acquired from the particular computer running the software. These data tags are automatically associated with each image when it is acquired. The parameter has the following format: /d"field_name::value". Note that more than one of these attributes can be specified on the command line. Note that these data tags remain in place until they are replaced by a new command line defined data tag with the same field name, the /r parameter is specified or the application is restarted.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /d"SampleField:: Sample Value"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /d"SampleField:: Sample Value" /d"SampleField2:: Sample Value2" /d"SampleField3:: Sample Value3"
e -or- E (Get Patient Image Information)
This option instructs XrayVision to saving patient related information to a specified file. This information includes the patient's directory name as well as the number of images associated with each tooth. The parameter has the following format: /e"patient_name::ss_number::id_number::date_of_birth;event_name;target_filename". Please note that only v3.9 b16 and higher support this command line parameter. The patient identifying information is the same as the other parameters (i.e. /p). The event_name is a named event that is signaled when XrayVision is done with the operation (whether successful or failed). If the patient does not exist, the patient is NOT created, nothing is displayed, nothing is done with the target file and the event is triggered. The target_filename is the file where the image data will be stored and is stored in binary format and is of the form:
unsigned long cbSize; Size of the complete data set (includes the 4 bytes for this field) - used when reading to check for newer versions of data. char szPatientDirectoryName[1024]; Fully qualified patient directory name. unsigned long arAdultToothImages[32]; Number of images assoicated with each adult tooth. Index entry 0 corresponds to tooth number 1. unsigned long arDeciduousToothImages[20]; Number of images associated with each deciduous tooth. Index entry 0 corresponds to tooth letter A. unsigned long uUnassociatedImages; Number of images not associated with any teeth.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /e"lastname, firstname::123-45-6789::123456::5/1/1970;MyEvent;C:\ImageInfo.DAT"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /e"lastname, firstname::::123456::5/1/1970;MyEvent;C:\ImageInfo.DAT"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /e"lastname, firstname::123-45-6789::::5/1/1970;MyEvent;C:\ImageInfo.DAT"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /e"lastname, firstname::123-45-6789::123456;MyEvent;C:\ImageInfo.DAT"
f -or- F (Patient Specification File)
A file containing the patient specification. The format of the file is fist_name, last_name, ss_number, id_number, date_of_birth, sex where each item is separated by a new-line. Any of the patient items can be left blank.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /f"C:\PatientSpecification.TXT"
h -or- H (Hide Splash Screen)
This option will supress the splash screen when XrayVision starts..
Example: "C:\Program Files\Apteryx\XrayVision.exe" /h /p"lastname, firstname::123-45-6789::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /h /m
i -or- I (Patient ID Number)
The patient id number that should be surrounded by quotations (but they are not necessary).
Example: "C:\Program Files\Apteryx\XrayVision.exe" /i"123456"
l -or- L (Close All Patients)
This option will close all patient entries that are currently opened in the software. If the software is not already opened, calling this flag will simply open it. Note that patient entries may not close if they are currently locked in a critical process (e.g. image capture, saving).
Example: "C:\Program Files\Apteryx\XrayVision.exe" /l
m -or- M (Start Minimized)
This option will start and immediately minimize the XVa3 application. If the XVa3 application is currently running, then this parameter has no effect.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /m /p"lastname, firstname::123-45-6789::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /m
n -or- N (Patient Name)
The patient name can be in any of the following forms and should be surrounded by quotations (but they are not necessary). Note that patient names are not case sensitive.
"lastname, firstname" (This is the recommended format)
"firstname lastname"
"firstnamelastname" (This type of name specification is not recommended due to the fact that more than one patient may match the string.)
"lastnamefirstname" (This type of name specification is not recommended due to the fact that more than one patient may match the string.)Example: "C:\Program Files\Apteryx\XrayVision.exe" /n"lastname, firstname"
p -or- P (Patient Specification)
An entire patient specification. Each item in the patient specification is separated by a set of double colons "::". The format of the specification is "patient_name::ss_number::id_number::date_of_birth::sex". The patient name is required, but the ss_number, id_number, date_of_birth or sex can be left blank (e.g. "patient_name::::id_number", "patient_name::ss_number::", "patient_name::ss_number::::5/23/99"). The date_of_birth is a string format of the date and may be specified in any form (e.g. "5/23/99", "5-23-99","May 23, 1999", "23 May 1999"). The sex is a string format and may be specified in any form (e.g. "M", "Male").
Example: "C:\Program Files\Apteryx\XrayVision.exe" /p"lastname, firstname::123-45-6789::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /p"lastname, firstname::::123456::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /p"lastname, firstname::123-45-6789::::5/1/1970::M"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /p"lastname, firstname::123-45-6789::123456"
r -or- R (Reset Data Tags Specifications)
This option can be used to remove any previously specified auto data tag values that were defined on a prior command line (this setting will not remove auto-data tag values specified in the Auto Data Tag options). This parameter can be used to clear any previous command line specified data tags from a prior session. The parameter is a stand-alone application flag and can be used alone on the command line or used to reset prior auto data tags before defining new ones.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /r
Example: "C:\Program Files\Apteryx\XrayVision.exe" /r /d"SampleField:: Sample Value" /d"SampleField2:: Sample Value2" /d"SampleField3:: Sample Value3"
s -or- S (Patient SS Number)
The patient social security, CERT, CID, etc. number that should be surrounded by quotations (but they are not necessary).
Example: "C:\Program Files\Apteryx\XrayVision.exe" /s"123-45-6789"
t -or- T (Get Tooth Information)
This option instructs XrayVision to saving patient and tooth related information to a specified file. The parameter has the following format: /t"patient_name::ss_number::id_number::date_of_birth;event_name;target_filename;specification_type;specification_data". The patient identifying information is the same as the other parameters (i.e. /p). Please note that only v3.9 b70 and higher support this command line parameter. The patient identifying information is the same as the other parameters (i.e. /p). The specification_type indicates what information is being supplied to identify which images to retrieve: TEETH; DTEETH; UNASSOCIATED; or ALL. TEETH indicates that specification_data is a hexadecimal value indicating the adult teeth where the least-significant-bit refers to tooth #1. DTEETH indicates that specification_data is a hexadecimal value indicating the deciduous teeth where the least-significant-bit refers to tooth letter A. UNASSOCIATED indicates that images with no associated teeth should be returned (specification_data is ignored). ALL indicates that images for all teeth should be returned. If the patient does not exist, the patient is NOT created, nothing is displayed, nothing is done with the target file and the event is triggered. The target_filename is the file where the image data will be stored and is stored in text format of the form:
Prior to XrayVision version 3.9 build 88:
Fully qualified patient directory name\n
specification_type;specification_data\n
Number of file to follow\n
filename1;TEETH(xxxxx);DTEETH(yyyyy)
filename2;TEETH(xxxxx);DTEETH(yyyyy)
...XrayVision version 3.9 build 88 and later:
Fully qualified patient directory name\n
specification_type;specification_data\n
Number of file to follow\n
filename1;TEETH(xxxxx);DTEETH(yyyyy);TAKEN(YYYYMMDD)
filename2;TEETH(xxxxx);DTEETH(yyyyy);TAKEN(YYYYMMDD)
...Following is an example of an output file:
S:\Path\Patients\Patients_actual_directory
TEETH;00000FFF
14
DICOMTest.JPG;TEETH(00000007);DTEETH(00000000);TAKEN(20051201)
DigX_04212005_085345.Auto;TEETH(E0000007);DTEETH(00000000);TAKEN(20051201)
DigX_07212004_103233.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
DigX_09292004_100350.Auto;TEETH(E0000007);DTEETH(00000000);TAKEN(20051201)
DigX_09292004_100520.Auto;TEETH(E0000007);DTEETH(00000000);TAKEN(20051201)
DigX_11112004_090240.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
FGrp_06012004_161823.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
FGrp_06142005_144158.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
FGrp_06142005_153452.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
FGrp_06142005_154136.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
Misc_09292004_100028.Auto;TEETH(E0000007);DTEETH(00000000);TAKEN(20051201)
FGrp_06142005_154227.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
FGrp_06142005_155552.Auto;TEETH(FFFFFFFF);DTEETH(00000000);TAKEN(20051201)
DigX_07292005_085402.Auto;TEETH(00000180);DTEETH(00000000);TAKEN(20051201)
Example: "C:\Program Files\Apteryx\XrayVision.exe" /t"lastname, firstname::123-45-6789::123456::5/1/1970;MyEvent;C:\ImageInfo.DAT;TEETH;00012AB3"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /t"lastname, firstname::::123456::5/1/1970;MyEvent;C:\ImageInfo.DAT;DTEETH;00001111"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /t"lastname, firstname::123-45-6789::::5/1/1970;MyEvent;C:\ImageInfo.DAT;ALL;0"
v -or- V (Open Patient Images)
This command is utilized to indicate that XrayVision should open an image or a set of images for the specified patient. The parameter has the following format: /v"patient_name::ss_number::id_number::date_of_birth;specification_type;specification_data". The patient identifying information is the same as the other parameters (i.e. /p). Please note that only v3.9 b16 and higher support this command line parameter. The patient identifying information is the same as the other parameters (i.e. /p). The specification_type indicates what information is being supplied to identify which images to open: TEETH; DTEETH; or FILENAME. TEETH indicates that specification_data is a hexadecimal value indicating the adult teeth where the least-significant-bit refers to tooth #1. DTEETH indicates that specification_data is a hexadecimal value indicating the deciduous teeth where the least-significant-bit refers to tooth letter A. FILENAME indicates that specification_data is a filename without the path of a patient file to open.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /v"lastname, firstname::123-45-6789::123456::5/1/1970;TEETH;00012AB3"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /v"lastname, firstname::::123456::5/1/1970;DTEETH;00001111"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /v"lastname, firstname::123-45-6789::::5/1/1970;FILENAME;DigX_01132004_151809.Auto"
w -or- W (Notify On Image Acquistion)
This option can be used specify a named windows event that should be signaled anytime a new image is acquired or imported. This is not a synchronous call but instead specifies a named windows event that is signaled each time an image is acquired or imported.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /w "MyEvent"
x -or- X (Patient Unformatted SS Number)
The patient unformatted social security, CERT, CID, etc. number that should be surrounded by quotations (but they are not necessary). The unformatted number does not have dashes, dots, etc..
Example: "C:\Program Files\Apteryx\XrayVision.exe" /x"123456789"
y -or- Y (Remote Xray Activation)
This command is utilized by the XrayVisionLink.DLL to invoke an x-ray capture from another application and wait until the user cancels the operation or an image is acquired (this command can be used directly by another application however). The parameter has the following format: /y"patient_name::ss_number::id_number::date_of_birth;event_name;target_JPEG_filename". The patient identifying information is the same as the other parameters (i.e. /p). The event_name is a named event that is signaled when XrayVision is done with the image capture operation (whether successful or failed). The target_JPEG_filename is the file where the image will be stored if one was captured. Please note that only v3.5 b30 and higher support this command line parameter.
Example: "C:\Program Files\Apteryx\XrayVision.exe" /y"lastname, firstname::123-45-6789::123456::5/1/1970;MyEvent;C:\Storage.JPEG"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /y"lastname, firstname::::123456::5/1/1970;MyEvent;C:\Storage.JPEG"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /y"lastname, firstname::123-45-6789::::5/1/1970;MyEvent;C:\Storage.JPEG"
Example: "C:\Program Files\Apteryx\XrayVision.exe" /y"lastname, firstname::123-45-6789::123456;MyEvent;C:\Storage.JPEG"
<program name> { filename | ('-'|'/')op[space]value }
op: n | N | i | I | s |
S | x | X | p | P | f | F | y | Y | v | V | e | E | t | T | c | C | d | D |
r | R | a | A | w | W
space: ' '
value: "string" | string
Logging support, added in XrayVision version 3.12 build 38, gives users the capability to see the exact command that is sent to the program by the XrayVisionLink DLL. Log files are useful in determining if the remote program is passing information correctly to XrayVision.
To enable logging, simply create a text file called "TraceCommandlines.TXT" in the XrayVision install directory. Generated log files will be stored in the local /Temp/ directory.
XrayVision supports all command line options above, however, XVLite DOES NOT support the following:
Y – remote x-ray activation
E – get patient image information
V – open patient images
H – hide splash screen
T – get tooth information
C – convert image file
D – data tag specification
R – reset data tags specifications
A – acquire image
W – notify on image acquisition
L – close all patients