The CARIS Batch utility runs command-line processes on feature objects and marine products generated from CARIS applications.
CARIS Batch is installed in the \Bin folder of a CARIS application.
The basic syntax is:
carisbatch -r <process_name> <parameters> <input> <output>
The -r or --Run parameter is required to run a process.
Processes are bound by the following rules:
• Parameters are identified either by character keys or parameter names. Keys use a single-hyphen prefix (-h) and parameter names use a double-hyphen prefix (--Help).
• Values are separated from parameters by a space (for example, -n 6).
• Parameter values with spaces must be enclosed in quotation marks (for example, -c “New DSID Comment”).
• Process names are not case-sensitive, but parameter names are. Be careful when entering parameters.
These common parameters are available:
Long | Key | Description |
|---|---|---|
|
| Display help, including available options. Example: |
|
| Display a list of available processes. |
| -r | Run a process. |
| -u | Run the process on all files that match the input description in any subfolders. |
| -v | Print verbose messages. |
| N/A | Display executable version and copyright information, including version of modules. |
Some parameters are repeatable. These can be included multiple times in the same process but with different values. For example,
carisbatch -r process_name repeat_parameter <value1> repeat_parameter <value2> repeat_parameter <value3> <input> <output>
Input can be a file or a URI-based data store. Output can also be to a file or database.
File paths with spaces must be enclosed in quotation marks. For example, "C:\Directory Name\Sample File". File paths and names without spaces can be entered without quotation marks. For example, C:\DirectoryName\SampleFile.
A Universal Resource Identifier (URI) is required to access a database. If an HPD chart, project, or product is stored in a database, the URI is in the following format:
hpd://username:password@database:port/db?Param1=Value1;Param2=Value2 |
where:
• hpd:// identifies an HPD schema
• username:password is the connection string
• @database is the database name
• :port is the port number (optional)
• db specifies that a database is being accessed
• ? indicates the start of a list of parameters and their values. Parameters are separated by semi-colons (;).
Run CARIS Batch
CARIS Batch is run from a command prompt.
1. Open the Command Prompt window.
2. Navigate to the Bin folder of a CARIS application.
3. Type carisbatch followed by the process and parameters.
4. Press <Enter>
The selected process is run.
Process Designer can also be used to graphically build a workflow from CARIS Batch processes and save it to a process model file, which can be reused as necessary.
A process model file is a sequence of processes and their associated configurations connected in a logical sequence. It has the extension .processmodel. Refer to the Process Designer help for more information.