Command Line

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help Convert-HL7-to-XML

** Convert-HL7-To-XML **

e.g. Convert-HL7-To-XML C:\first-document.hl7 D:\second-document.hl7 [-cp  -ConformanceProfile "C:\
HL7Reference\HL7 v2.5.1.cxp"] [-r  -Results "D:\results\"] [-lp  -LogsFilePath "C:\logs.txt"]

Source files : The documents to Convert (can also be folders).
-cp [required] : Conformance Profile file path. The value has to be a .cxp path.
-r [optional] : Result folder path. The value has to be a folder [default: .\Results].
-lp [optional] : Logs file path.

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help Convert-XML-to-HL7

** Convert-XML-To-HL7 **

e.g. Convert-XML-To-HL7 C:\first-document.xml D:\second-document.xml [-r  -Results "D:\results\"] [-rt  
-ResultType "MessageCount 100"] [-lp  -LogsFilePath "C:\logs.txt"]

Source files : The documents to Convert (can also be folders).
-r [optional] : Result file path. The value has to be a file by default. [default: .\result.txt].
-rt [optional] : Result format type: 'InitialFileStructure' to reflect the initial file structure (-r is 
required for InitialFileStructure. The -r value has to be a folder)
'CustomizedSize' to split by file size, in MB, followed by the size amount (The -r value has to be a file)
'MessageCount' to split by message count, followed by the amount (The -r value has to be a file)
'NoSplit' to save the result to a single file (default value) (The -r value has to be a file)
-lp [optional] : Logs file path.

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help De-Identify-HL7

** De-Identify-HL7 **

e.g. De-Identify-HL7 C:\first-document.hl7 D:\second-document.hl7 -de  -DeIdentificationRules "C:\My DeId
entification settings.cxd" [-cp  -ConformanceProfile "C:\HL7Reference\HL7 v2.5.1.cxp"] [-pi  -PersistentId
entities "D:\persistence-xml.dic"] [-r  -Results "D:\results.hl7"] [-rt MessageCount 100] [-opt  -Options 
GenerateValueOnEmptyField|IgnoreQuote] [-mbd  -MessageBeginningDelimiter "regex"] [-med  -MessageEndingDel
imiter "regex"] [-sed  -SegmentEndingDelimiter "regex"] [-lp  -LogsFilePath "C:\logs.txt"]

Source files : The documents to De-Identify (can also be folders).
-de required : De-identification settings file path.
-cp [optional] : Conformance Profile file path. Required if your de-identification file contains data-type 
settings, or if any de-identification settings have a precondition.
-pi [optional] : Persisted identities file path (if the file already exists, the context will be loaded fr
om it).
-r [optional] : Result file path. [default: .\results.txt].
-rt [optional] : Result format type: 'InitialFileStructure' to reflect the initial file structure (-r is r
equired for InitialFileStructure. The -r value has to be a folder)
'CustomizedSize' to split by file size, in MB, followed by the size amount (The -r value has to be a file)
'MessageCount' to split by message count, followed by the amount (The -r value has to be a file)
'NoSplit' to save the result to a single file (default value) (The -r value has to be a file)
-opt [optional] : Set de-identification options: 'ConsiderIdAsNumeric' to consider 001234 and 1234 as equi
valent
'GenerateValueOnEmptyField' to populate empty field with generated values if applicable
'IgnoreQuote' to consider '1234', "1234" and 1234 as equivalent
remark: GenerateValueOnEmptyField|IgnoreQuote will enable both options.
-mbd [optional] : Message beginning delimiter (in regex format)
-med [optional] : Message ending delimiter (in regex format)
-sed [optional] : Segment ending delimiter (in regex format)
-lp [optional] : Logs file path.

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help De-Identify-XML

** De-Identify-Xml **

e.g. De-Identify-Xml C:\first-document.xml D:\second-document.xml -de <or> -DeIdentificationR
ules "C:\My DeIdentification rules.cxdx" [-cp <or> -ConformanceProfile "C:\HL7Reference\CCD (
Continuity of Care).cxpx"] [-pi <or> -PersistentIdentities "D:\persistence-xml.dic"] [-r <or>
 -Results "D:\results\"] [-lp <or> -LogsFilePath "C:\logs.txt"]

Source files : The documents to De-Identify (can also be folders).
-de required : DeIdentification rules file path.
-cp [optional] : Conformance Profile file path.
-pi [optional] : Persisted identities file path (if the file already exists, the context will
 be loaded from it).
-r [optional] : Result folder path. The value has to be a folder [default: .\Results].
-lp [optional] : Logs file path.

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help Execute-Test

** Execute-Test **

e.g. Execute-Test C:\myScenarioSuite.cxs [-r <or> -ReportingEnabled y] [-rp <or> -ReportPath C:\resultingR
eport.xlsx] [-e <or> -LogExecutionEnabled y] [-ep <or> -LogExecutionPath "C:\ProgramData\Caristix\Caristix 
Test\Execution logs\"] [-run <or> -PathsToRun "scenario 1/action 1" "scenario 2/Action 1/task 1"] [-skip <
or> -PathsToSkip "scenario 1/action 1" "scenario 2/Action 1/task 1"] [-lp <or> -LogsFilePath "C:\customLog
Path.log"] [ -var <or> -EditVariables "${MyVariable}[0].LimitationMax=5" ] [ -env <or> -Environments "MyEn
vironment" ]

Source file : The ScenarioSuite file to execute
-r [optional] : Output an Excel report file or not (y or n, default is n)
-rp [optional] : Excel report file path (default is '.\report.xlsx')
-er [optional] : Include extended report details. (y or n, default is y)
-e [optional] : Save execution result (y or n, default is n)
-ep [optional] : Execution result path (default is '.\result.xml')
-run [optional] : List of scenarios, actions and tasks to run in the scenario suite (cannot be used with 
-skip)
-skip[optional] : List of scenarios, actions and tasks to skip in the scenario suite (cannot be used with 
-run)
-skip "scenario 1" should skip the scenario 1
-skip "scenario 1/action 2" should skip the action 2 in scenario 1
-skip "scenario 1/action 2/task 1" should skip the task 1 in scenario 1/action 2
-lp [optional] : Logs file path (default is 'TestConsole.log')
-var [optional] : List of scenario suite variables to edit while running the suite.
-env [optional] : Active environment name (default is the environment active set in the scenario suite)

C:\Program Files (x86)\Caristix\Caristix Workgroup>WorkgroupConsole.exe help Search-And-Filter-HL7

** Search-And-Filter-HL7 **

e.g. Search-And-Filter-HL7 C:\first-document.hl7 D:\second-document.hl7 -sfr  -SearchAndFilterRules
 "C:\MySearchAndFilterRules.cxf" [-cp  -ConformanceProfile "C:\HL7Reference\HL7 v2.5.1.cxp"] [-r  -R
esults "D:\results.hl7"] [-rt  -ResultType "MessageCount 100"] [-lp  -LogsFilePath "C:\logs.txt"]

Source files     : The documents to Search And Filter (can also be folders).
-sfr [required]  : Search-and-filter rules file path.
-cp  [optional]  : Conformance Profile file path. Required if SearchAndFilterRules need reference to
                   the spec.
-r   [optional]  : Result file path.   efault: .\result.txt].
-rt  [optional]  : Result format type: 'InitialFileStructure' to reflect the initial file structure 
                   (-r is required for InitialFileStructure. The -r value has to be a folder)
                                       'CustomizedSize' to split by file size, in MB, followed by 
                   the size amount (The -r value has to be a file)
                                       'MessageCount' to split by message count, followed by the 
                   amount (The -r value has to be a file)
                                       'NoSplit' to save the result to a single file (default value) 
                   (The -r value has to be a file)
-lp  [optional]  : Logs file path.