en:installation_extras
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| en:installation_extras [2016/05/03 11:07] – onyxadmin | en:installation_extras [2020/11/16 15:28] (current) – removed onyxadmin | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ~~NOTOC~~ | ||
| - | ===== Extras ===== | ||
| - | ---- | ||
| - | ^ A. | [[installation_extras# | ||
| - | ^ B. | [[installation_extras# | ||
| - | |||
| - | ==== A. Silent Client Setup ==== | ||
| - | |||
| - | OnyxClientSetup supports silent mode using the following command line parameters: | ||
| - | |||
| - | ^ Parameter | ||
| - | | **-? | ||
| - | | **-Auto** | ||
| - | | **-Lang=** | ||
| - | | **-Server=** | ||
| - | | **-PORT=** | ||
| - | | **-PATH=** | ||
| - | |||
| - | * If any of the parameters is missing, OnyxClientSetup will stop at this point | ||
| - | * For **-PATH=Default** folder | ||
| - | * If not specified, subfolder Onyx3Client will be created automatically | ||
| - | * In case of empty spaces in folder name, use quotation marks: **-PATH=“C: | ||
| - | \\ | ||
| - | **Example**\\ | ||
| - | The command line below connects to the server via port 16300 and installs a client with GERMAN langage settings in the standard installation folder: | ||
| - | |||
| - | OnyxClientSetup.exe -Auto -Server=[SRV]@SRV -Lang=1 -Path=Default | ||
| - | |||
| - | The command line below connects to the server via port 16500 and installs a client with ENGLISH langage settings in folder D: | ||
| - | |||
| - | OnyxClientSetup.exe -Auto -Server=[SRV]@172.1.1.250 -Port=16500 -Lang=2 -Path=D: | ||
| - | \\ | ||
| - | |||
| - | ==== B. Command Line Interface ==== | ||
| - | |||
| - | ^Note^ | ||
| - | |For PMS integration, | ||
| - | Handing over patient data to OnyxCeph³™ is done by launching OnyxCeph.exe with specific command line parameters. There are two ways to hand over patient data: by command line parameters or by an INI text file. Tags are used in both cases. Following you will find a survey of the tags supported: | ||
| - | |||
| - | === 1. Patient Data Tags === | ||
| - | |||
| - | ^ Mandatory Parameters | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | ^ Optional Parameters | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | " | ||
| - | | " | ||
| - | | " | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | \\ | ||
| - | === 2. Image Data Tags === | ||
| - | |||
| - | In addition, image files can be handed over to OnyxCeph' | ||
| - | In order to ensure correct image-to-patient assignment, at least parameter Patient ID needs to be handed over by tag '' | ||
| - | To hand over 2D images to OnyxCeph³™, | ||
| - | |||
| - | | '' | ||
| - | | '' | ||
| - | | ::: | " | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | | '' | ||
| - | |||
| - | ¹ # will be replaced the image number starting with 1; e.g. the first entry is -PicPath=" | ||
| - | \\ | ||
| - | === 3. Transfer by Command Line Parameters === | ||
| - | |||
| - | If patient and image data is transferred via command line parameters the file OnyxCeph.exe is started with the tags and followed by the values as command line. Any value should be formatted as follows\\ | ||
| - | |||
| - | | -Tag=" | ||
| - | |||
| - | Empty space between multiple tags is required - find some examples in topic 6.\\ | ||
| - | \\ | ||
| - | |||
| - | === 4. Transfer via HTTP === | ||
| - | |||
| - | If the infoserver is active in OnyxCeph³ master data can also be transferrred to OnyxCeph³ via HTTP | ||
| - | requests.\\ | ||
| - | OnyxCeph³ operates as HTTP server and serves the configured port. | ||
| - | In case the checkbox **Only Local** is activated (Standard) only access from IP 127.0.0.1 is allowed.\\ | ||
| - | |||
| - | | Server: | ||
| - | |||
| - | If no space character is in Value the quotation marks can be omitted.\\ | ||
| - | \\ | ||
| - | |||
| - | === 5. Transfer by Text File === | ||
| - | |||
| - | For this purpose, a text file in INI format has to be provided. The file has to contain a [PatDat] section. Patient and image data can be defined under this section using the tags described above.\\ | ||
| - | In order to hand over data, OnyxCeph.exe has to be launched with parameters '' | ||
| - | \\ | ||
| - | |||
| - | === 6. Transfer via DICOM File === | ||
| - | |||
| - | A DICOM file includes patient data as well as image data. If name and path of a DICOM file is handed over after the command line parameters: | ||
| - | |||
| - | ||-DICOM=“File Name“|| | ||
| - | |||
| - | then the patient' | ||
| - | Parameter '' | ||
| - | \\ | ||
| - | All other parameters are ignored and do not have to be handed over.\\ | ||
| - | \\ | ||
| - | |||
| - | === 7. Import of .O3C-Containers === | ||
| - | |||
| - | An .O3C-container-file comprises patient data as well as image data. It may include data of several patients. | ||
| - | If the path of the container-file is transferred after the command line parameter: | ||
| - | |||
| - | ||-ContainerFile=“File Name“|| | ||
| - | |||
| - | the patient' | ||
| - | If the container was uploaded to an FTP-server the key can be transferred via command line parameter | ||
| - | ContainerFTP: | ||
| - | |||
| - | ||-ContainerFTP=“C5UW5SJNN3....B6DKHUWUQKD73“|| | ||
| - | |||
| - | The command line parameter ContainerNote allows handing over of a string that can be attached to the | ||
| - | comment of the images adopted: | ||
| - | |||
| - | ||-ContainerNote=“Auftrag # | ||
| - | |||
| - | After import OnyxCeph³ automatically opens the respective client and patient.\\ | ||
| - | All other parameters are ignored and do not have to be handed over.\\ | ||
| - | \\ | ||
| - | |||
| - | === 8. Starting Module in OnyxCeph³™ === | ||
| - | |||
| - | The parameters ActionBefore and ActionAfter allow starting of specific modules. | ||
| - | At present starting the following modules is supported (will be extended): | ||
| - | \\ | ||
| - | • **ActionBefore** ((prior to master data compariso) | ||
| - | ||Patient kopieren: -ActionBefore=“CLONEPATIENT: | ||
| - | |||
| - | • **ActionAfter** (after master data comparison or container import) | ||
| - | ||Präsentationstemplate: | ||
| - | \\ | ||
| - | |||
| - | === 9. Detecting OnyxCeph.exe === | ||
| - | |||
| - | The command line interfaces needs to address the location of the executable OnyxCeph.exe. The default location for this program file is: | ||
| - | |||
| - | < | ||
| - | |||
| - | Since this location could be changed during setup or later, it beter should be read from the local registry. Search for the following registry key: | ||
| - | |||
| - | | ||
| - | |||
| - | to find out where the executable is located.\\ | ||
| - | \\ | ||
| - | |||
| - | === 10. Examples === | ||
| - | |||
| - | __//a. Searching the Registry Key//__ | ||
| - | |||
| - | | ||
| - | |||
| - | The Value may be e.g. " | ||
| - | |||
| - | __//b. Creation of a new patient record://__ | ||
| - | |||
| - | " | ||
| - | | ||
| - | __//c. Assigning 2 images to an existing patient record://__ | ||
| - | | ||
| - | " | ||
| - | |||
| - | __//d. Transfer of two STL-files for a known patient, delete files after import://__ | ||
| - | | ||
| - | " | ||
| - | |||
| - | __//e. Performing b. and c. in one step://__ | ||
| - | |||
| - | Source files are to be deleted after images are saved to the database: | ||
| - | |||
| - | " | ||
| - | |||
| - | __//f. Opening of a patient via HTTP and updating the name://__ | ||
| - | |||
| - | Opens patient 123 and updates master data when indicate\\ | ||
| - | | ||
| - | | ||
| - | Birthday=" | ||
| - | |||
| - | __//g. Opening of a patient and presentation template via HTTP//__ | ||
| - | |||
| - | Opens patient 123 and after that the presentation template Onyx_Images_8\\ | ||
| - | | ||
| - | | ||
| - | |||
| - | __//h. Copying of a patient via HTTP//__ | ||
| - | |||
| - | Copies the patient 123 inclusive of all images. The copy gets the new patient ID 123New and is renamed to | ||
| - | „Test Patient“\\ | ||
| - | | ||
| - | | ||
| - | -Firstname=" | ||
| - | |||
| - | __//i. Using INI file://__ | ||
| - | First, the INI file has to be created (e.g. C: | ||
| - | |||
| - | MyPatientData.ini: | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | Sex=F | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | | ||
| - | |||
| - | Launch OnyxCeph³™ with the following command line parameters: | ||
| - | |||
| - | " | ||
| - | |||
| - | __//j. Transfer of patient and image via DICOM File://__ | ||
| - | |||
| - | OnyxCeph³™ is supposed to load patient and image data from the DICOM file and delete it after adoption: | ||
| - | |||
| - | " | ||
| - | |||
| - | __//k. Import of patients and images from a container:// | ||
| - | |||
| - | OnyxCeph³ is supposed to load patient and image data from a container that is located on an FTP-server. | ||
| - | The comment field of the recorded images is filled with the order number: | ||
| - | |||
| - | " | ||
| - | |||
| - | or via HTTP: | ||
| - | |||
| - | | ||
| - | |||
| - | |||
| - | |||
| - | | ||
en/installation_extras.1462266476.txt.gz · Last modified: 2016/05/03 11:07 by onyxadmin