Altair
®
Monarch
®
v2024
COMMAND LINE USER GUIDE
© 2024 Altair Engineering, Inc. All Rights Reserved. / Nasdaq:ALTR / altair.com
2024.0/2024.07.12
TABLE OF CONTENTS
[1] Overview ................................................................................................................................................... 1
[2] Classic Command Line Parameters ....................................................................................................... 2
Input Options ................................................................................................................................................... 2
Input Database Options .................................................................................................................................. 2
Input Report Options ....................................................................................................................................... 3
View Options ................................................................................................................................................... 3
Export Options ................................................................................................................................................ 3
Command Line Examples ............................................................................................................................... 4
[2] Launching Quick Help ............................................................................................................................. 6
[3] Using Classic Command Lines to Export Data ..................................................................................... 7
[4] Data Prep Studio Command Line Interface ........................................................................................... 8
Input Options ................................................................................................................................................... 8
Input Path Options ........................................................................................................................................ 13
Export Options .............................................................................................................................................. 15
[5] Installation Command Line Parameters............................................................................................... 19
Usage ............................................................................................................................................................ 19
License File ................................................................................................................................................... 20
Monarch License Server ............................................................................................................................... 20
Altair License Server ..................................................................................................................................... 20
Command Line Examples ............................................................................................................................. 20
Altair Monarch 2024 Command Line User Guide 1
[1] OVERVIEW
Monarch Complete supports a number of command line parameters that you can use to open files when you start a
Monarch session or automate an entire session and produce an export file.
The syntax for a simple Monarch command line is:
Monarch.exe /rpt:[Report File] /mod:[Model File] /exp:[Export File] /[View]
To open password-protected PDF files, the following syntax is used:
Monarch.exe /rpt:[Report File@password] /mod:[Model File] /exp:[Export File]
/[View]
NOTE
For example, to open a report and Model and then export from Table View:
Monarch.exe /rpt:"C:\Users\Public\Documents\Altair
Monarch\Reports\classic.prn" /mod:"C:\Users\Public\Documents\Altair
Monarch\Models\lesson9.dmod" /exp:"C:\Users\Public\Documents\Altair
Monarch\Export\classic.xls" /T
To open multiple reports, set a runtime field called "Test" to "True," and export from Summary View:
Monarch.exe /rpt:"C:\Users\Public\Documents\Altair
Monarch\Reports\classic.prn" /rpt:"C:\Users\Public\Documents\Altair
Monarch\Reports\classfeb.prn" /mod:"C:\Users\Public\Documents\Altair
Monarch\Models\runtime.dmod" /set:"Test"="True"
/exp:"C:\Users\Public\Documents\Altair Monarch\Export\classic.xls" /S
Altair Monarch 2024 Command Line User Guide 2
[2] CLASSIC COMMAND LINE
PARAMETERS
The tables below present a list and descriptions of the Monarch Classic command line parameters.
INPUT OPTIONS
PARAMETER
DESCRIPTION
/prj:[Project File]
Specifies the Project file to use in the Monarch session.
When the /prj and /rpt switches are used in tandem, the reports specified in the
command line override any report indicated in the Project, i.e., if the Project
already contains a report list, it is discarded.
/mod:[Model File]
Specifies the Model file to use in the Monarch session.
Note: Omit this parameter if you specified a Project file as the first parameter.
/set:[Field Name]=
[Field Value]
Sets a runtime parameter named [Field Name] to the value [Field Value] from
the command line, instead of typing the values into a dialog box.
If all runtime parameters are fulfilled from the command line, the corresponding
dialog is suppressed upon program startup.
INPUT DATABASE OPTIONS
PARAMETER
DESCRIPTION
/datasource:[name]=
connection_string
Specifies the connection string for a named data source, where name is either
maindb (for the main database) or the name of an external lookup.
For example, /datasource:Lookup2=“c:\test\MyData.mdb" sets
"c:\test\MyData.mdb" as the source for the external lookup named "Lookup2"
and overrides whatever source was specified in the model.
If the maindb is to be opened, the syntax
“/datasource:maindb=[name]=connection_string” must be explicitly used.
/table:[name=]
tablename
Specifies the table to open for the named data source, where name is either
maindb (for the main database) or the name of an external lookup. If "name="
part is omitted, maindb is implied.
For example, "/table:Lookup2=Employees" sets "Employees" as the table for
the external lookup named "Lookup2" and overrides whatever table was
specified in the model.
/pwd:[name=]password
Specifies the password to use for the named data source, where name is either
maindb (for the main database) or the name of an external lookup. If "name="
part is omitted, maindb is implied. For example, "/pwd:fred" sets "fred" as the
password to be used for the main import table.
Altair Monarch 2024 Command Line User Guide 3
INPUT REPORT OPTIONS
PARAMETER
DESCRIPTION
/rpt:[Report File]
Specifies the report file to use in the Monarch session.
You can specify /rpt: more than once to open multiple reports.
If you specified a Project file and that Project has existing reports, the reports
specified in the command line override any report indicated in the Project, i.e., if
the Project already contains a report list, it is discarded.
VIEW OPTIONS
PARAMETER
DESCRIPTION
/R
Sets the current view to Report View
/T
Sets the current view to Table View
/S
Sets the current view to Summary View
EXPORT OPTIONS
PARAMETER
DESCRIPTION
/exp:[Export Path and
File]
Specifies the name of an export file to create. Include this parameter if you want
to automate a Monarch session.
The export file extension determines the file type produced. Valid extensions are:
DBF, MDB, ACCDB, TXT, PDF, XLS, XLSX, HTM, HTML, XML or any other
extension to create a delimited text file.
/expfileopt:[option]
Sets the file option for the command line export. Possible values are:
❑ Overwrite – create table, overwrite if the table already exists
❑ Add – add (or append) data to an existing table. Create the table first if it
does not exist.
❑ Skip – create the table only if it does not exist.
/exptable:[Tablename]
Sets the name of the table to be used for the command line export
/exptableopt:[option]
Sets the table option for the command line export. Possible values are overwrite,
append, and skip.
/px:[jobname]
Runs a Project export jobname if it exists. Multiple jobs may be run using multiple
/px switches
/pxall
Specifies that all exports defined within the Project should be executed.
Altair Monarch 2024 Command Line User Guide 4
These switches may appear in any order and may appear multiple times (with different name portions).
NOTE
While these switches are primarily used to override values from a Project or Model file, they can be used to specify a
main import table even in the absence of an associated database Project.
For example:
Monarch.exe /datasource:”c:\Data\June.mdb” /table:Sales /pwd:xyz
/mod:”c:\Models\Sales.dmod” /exp:”c:\Exports\JuneSales.xls” /S
This command launches Monarch using data from table "Sales" in the Access database "c:\Data\June.mdb" (which
requires password "xyz").
The data is loaded and interpreted via Model "c:\Models\Sales.dmod.". The current summary (notice the "/S" switch)
is then exported to "c:\Exports\JuneSales.xls."
COMMAND LINE EXAMPLES
The following commands assume that you installed Monarch to the following folder:
c:\Program Files\Altair Monarch 2024\Monarch\
The following command launches Monarch and appends data to an existing file named classic.txt from Summary
View:
"c:\Program Files\Altair Monarch 2024\Monarch.exe"
/rpt:"C:\Users\Public\Documents\Altair Monarch\Reports\classic.prn"
/mod:"C:\Users\Public\Documents\Altair Monarch\Models\lesson11.dmod"
/expfileopt:add /exp:"C:\Users\Public\Documents\Altair
Monarch\Export\classic.txt" /S
The following command launches Monarch and exports classic.xls from Table View, overwriting an existing file:
"c:\Program Files\Altair Monarch 2024\Monarch.exe"
/rpt:"C:\Users\Public\Documents\Altair Monarch\Reports\classic.prn"
/mod:"C:\Users\Public\Documents\Altair Monarch\Models\lesson11.dmod"
/expfileopt:overwrite /exp:"C:\Users\Public\Documents\Altair
Monarch\Export\classic.xls" /T
Altair Monarch 2024 Command Line User Guide 5
The following command launches Monarch and appends data from Table View to an existing named range or sheet
called “Test” within an existing file called classic.xls.
"c:\Program Files\Altair Monarch 2024\Monarch.exe"
/rpt:"C:\Users\Public\Documents\Altair Monarch\Reports\classic.prn"
/mod:"C:\Users\Public\Documents\Altair Monarch\Models\lesson11.dmod"
/expfileopt:add /exptableopt:append /exptable: "Test"
/exp:"C:\Users\Public\Documents\Altair Monarch\Export\classic.xls" /T
The following command launches Monarch and export data from Table View, overwriting an existing named range or
sheet called “Test” within an existing file called classic.xls.
"c:\Program Files\Altair Monarch 2024\Monarch.exe"
/rpt:"C:\Users\Public\Documents\Altair Monarch\Reports\classic.prn"
/mod:"C:\Users\Public\Documents\Altair Monarch\Models\lesson11.dmod"
/expfileopt:add /exptableopt:overwrite /exptable:"Test"
/exp:"C:\Users\Public\Documents\Altair Monarch\Export\classic.xls" /T
The following command launches Monarch, opens the password-protected file data.pdf and exports data.xls from
Table View.
"c:\Program Files\Altair Monarch 2024\Monarch.exe"
/rpt:"C:\Users\Public\Documents\Altair Monarch\Reports\data.pdf@password"
/mod:"C:\Users\Public\Documents\Altair Monarch\Models\modelFile.dmod"
/exp:"C:\Users\Public\Documents\Altair Monarch\Export\data.xls" /T
You may use any of the following methods to pass a command line to Monarch:
❑ Select Start > Run, type the command line in the Open box, and then choose OK. Use this method if you will
need to use the command line only once.
❑ Create an icon that includes the command line. Use this method if you want to run the same Monarch session in
the future, such as when you receive a new instance of a report file.
❑ Enter one or more command lines into a batch file (.bat or .cmd) and execute the batch file.
Altair Monarch 2024 Command Line User Guide 6
[2] LAUNCHING QUICK HELP
You can run quick help from the command line to view the available arguments.
To view quick help, run the following from the command line: monarch.exe /?
NOTE
Invoking quick help displays several usage options on screen:
Altair Monarch 2024 Command Line User Guide 7
[3] USING CLASSIC COMMAND
LINES TO EXPORT DATA
Once you have created a Model file for a Monarch session, you can use a Monarch command line to by-pass the
Monarch menus and automatically launch a Monarch session and export data to any supported file format. By
creating an icon that includes the command line, you can easily run the same Monarch session in the future. The
command line syntax for exporting Monarch data is:
Monarch.exe /rpt:[Report File] /mod:[Model File] /exp:[Export File]
where [Export File] is the path of the export file you want to create.
For password-protected PDF files, the following syntax is used:
Monarch.exe /rpt:[Report File@Password] /mod:[Model File] /exp:[Export File]
NOTE
Example:
The following command line loads the Classic.prn report and the Lesson6.dmod Model file and then creates a text file
(Classic.txt) from the data in Table View:
Monarch.exe /rpt:"C:\Users\Public\Documents\Altair
Monarch\Reports\classic.prn" /mod:"C:\Users\Public\Documents\Altair
Monarch\Models\lesson6.dmod" /exp:"classic.txt" /T
The command above assumes, for simplicity, that your report and Model folders are located in
C:\Users\Public\Documents\Altair Monarch\Reports\ and
C:\Users\Public\Documents\Altair Monarch\Models\, respectively.
In most practical cases, your report and Model files will likely be located elsewhere.
Altair Monarch 2024 Command Line User Guide 8
[4] DATA PREP STUDIO COMMAND
LINE INTERFACE
The Command Line Interface in Data Prep Studio is of two types:
❑ Interactive
• Can execute via the main executable file
• Launches an instance of the application
• No additional license required
❑ Non-interactive
• Requires a separate executable file to run
• Does not launch the application; runs silently from the command line
• Additional license required
The tables below describe the command line parameters available in Data Prep Studio.
INPUT OPTIONS
PARAMETER
DESCRIPTION
TYPE
/rpt:<File Path[:p=password]>
Brings up an interactive session in Report
Design with the list of report files (text or
PDF) being modeled together.
Can be set multiple times.
Optional parameter:
:p
Interactive only
/delim:<File Path>
Opens a new delimited text load plan using
the file path provided.
Can be set multiple times.
Both
/excel:<File
Path[:t=table][:p=password]>
Opens a new Excel load plan using the file
path provided.
If the table is not specified and only one
table is available, this table will be loaded.
If the table is not specified and multiple
tables are available, the table explorer will
be launched.
The table and password can be specified in
any order.
Can be set multiple times.
Both*
Altair Monarch 2024 Command Line User Guide 9
PARAMETER
DESCRIPTION
TYPE
Optional parameters:
:t, :p
:t is required in the non-interactive type.
/access:<File
Path[:t=table][:p=password]>
Opens a new Access load plan using the file
path provided.
If the table is not specified and only one
table is available, this table will be loaded.
If the table is not specified and multiple
tables are available, the table explorer will
be launched.
The table and password can be specified in
any order.
Can be set multiple times.
Optional parameters:
:t, :p
:t is required in the non-interactive type.
Both*
/html<File Path[:t=table]>
Opens a new html file load plan using the file
path provided.
If the table is not specified and multiple
tables are available, the table explorer will
be launched.
Can be set multiple times.
Optional parameter:
:t is required in the non-interactive type.
Both
/ftp:<URL>
[:u=username][:p=password]
Opens a table from an FTP source using the
file path provided.
/http:<URL>
[:u=username][:p=password]
Opens a table from an HTTP source using
the file path provided.
/sastransportv5:<File Path>
Opens a new SAS Transport V5 file load
plan using the file path provided.
Can be set multiple times.
Both
/awss3:<URL
[:t=table][:p=password]>
[:akid=accessKeyId]
[:skid=secretKey]
Opens a new file-based load plan using the
URL to file on an AWS S3 instance. This
URL must begin with "awss3://" in order
to be recognized as a valid S3 input.
In non-interactive mode, only delimited
text, Excel, Access, HTML, and SAS
Transport V5 files are currently supported
through this method. The import method is
defined by the file extension in the URL.
These sources follow identical optional
parameters to their corresponding input
commands (/delim, /excel, /access,
/sastransportv5).
Both*
Altair Monarch 2024 Command Line User Guide 10
PARAMETER
DESCRIPTION
TYPE
:akid – the Access Key ID for the Amazon
S3 account/instance being exported to.
:skid – the account-specific Amazon S3
secret key.
If :akid and :skid are not provided, registry-
stored credential use will be attempted.
Similar parameter requirements to source file
type import function.
Can be set multiple times.
/adl:<URL
[:t=table][:p=password]>
[:an=accountName]
[:ak=accountKey]
Opens a new file-based load plan using the
URL to file on an Azure Data Lake Gen2
instance. This URL must begin with
"adl://" in order to be recognized as a
valid Azure Data Lake Gen2 input.
In non-interactive mode, only delimited
text, Excel, Access, HTML, and SAS
Transport V5 files are currently supported
through this method. The import method is
defined by the file extension in the URL.
These sources follow identical optional
parameters to their corresponding input
commands (/delim, /excel, /access,
/sastransportv5).
:an – the account name for the Azure Data
Lake Gen2 instance being exported to.
:ak – the (secret) account key for the
corresponding account provided by ":an".
If :an and :ak are not provided, registry-
stored credential use will be attempted.
Similar parameter requirements to source file
type import function.
Can be set multiple times.
Both*
/abs:<URL
[:t=table][:p=password]>
[:an=accountName]
[:ak=accountKey]
Opens a new file-based load plan using the
URL to file on an Azure Blob Storage
instance. This URL must begin with
"abs://" in order to be recognized as a
valid Azure Blob Storage input.
In non-interactive mode, only delimited
text, Excel, Access, HTML, and SAS
Transport V5 files are currently supported
through this method. The import method is
defined by the file extension in the URL.
These sources follow identical optional
parameters to their corresponding input
commands (/delim, /excel, /access,
/sastransportv5).
:an – the account name for the Azure Blob
Storage instance being exported to.
Both*
Altair Monarch 2024 Command Line User Guide 11
PARAMETER
DESCRIPTION
TYPE
:ak – the (secret) account key for the
corresponding account provided by ":an".
If :an and :ak are not provided, registry-
stored credential use will be attempted.
Similar parameter requirements to source file
type import function.
Can be set multiple times.
/oci:<URL
[:t=table][:p=password]>
[:akid=accessKeyId]
[:skid=secretKey]
Opens a new file-based load plan using the
URL to file on an Oracle Cloud Infrastructure
(OCI) instance. This URL must begin with
"oci://" in order to be recognized as a
valid OCI input.
In non-interactive mode, only delimited
text, Excel, Access, HTML, and SAS
Transport V5 files are currently supported
through this method. The import method is
defined by the file extension in the URL.
These sources follow identical optional
parameters to their corresponding input
commands (/delim, /excel, /access,
/sastransportv5).
:akid – the Access Key ID for the OCI
account/instance being exported to.
:skid – the account-specific OCI secret key.
If :akid and :skid are not provided, registry-
stored credential use will be attempted.
Similar parameter requirements to source file
type import function.
Can be set multiple times.
Both*
/gcs:<URL
[:t=table][:p=password]>
[:akid=accessKeyId]
[:skid=secretKey]
Opens a new file-based load plan using the
URL to file on a Google Cloud Storage
(GCS) instance. This URL must begin with
"gcs://" in order to be recognized as a
valid GCS input.
In non-interactive mode, only delimited
text, Excel, Access, HTML, and SAS
Transport V5 files are currently supported
through this method. The import method is
defined by the file extension in the URL.
These sources follow identical optional
parameters to their corresponding input
commands (/delim, /excel, /access,
/sastransportv5).
:akid – the Access Key ID for the GCS
account/instance being exported to.
:skid – the individual account or domain-
specific GCS secret key.
If :akid and :skid are not provided, registry-
stored credential use will be attempted.
Both*
Altair Monarch 2024 Command Line User Guide 12
PARAMETER
DESCRIPTION
TYPE
Similar parameter requirements to source file
type import function.
Can be set multiple times.
/append:[:type=Type]
[:t=tableName]
Appends the list of input tables.
Type can be: {name, order}.
Only one append is allowed as part of the
command string; any that are seen after the
first will be discarded.
This flag will append any eligible tables that
were part of the command: delimited tables
and Excel/Access with a single table or table
specified.
The desired name for the append table
produced can be supplied with the “:t=”
option AFTER a type is applied, if any.
If no table name is specified the default
name 'Append' is used and disambiguated
accordingly.
Can be set only once.
Optional parameters:
:type, :t
Both
/dpwx:<File Path[:p=password]>
Opens the specified Workspace file.
If this flag is used, any files that are opened
with the other flags will be opened in the
context of this Workspace.
A password can be entered in the case of
encrypted Workspaces.
Can be set only once.
Optional parameter:
:p
Both
/setrtp:<Field Name>=<Field
Value>[:scope=Scope][:type=Type]
Sets a runtime parameter named [Field
Name] to the value [Field Value] from the
command line, instead of typing the values
into a dialog box.
If all runtime parameters are fulfilled from the
command line, the corresponding dialog is
suppressed upon program startup.
[:Scope] {a, application, w, workspace} for
application and workspace settings.
Scope is optional; if it is not specified, then
duplicates will be resolved in the usage of
the application version of the parameter.
Type {t, text, n, numeric, d, date} is
optional and only necessary in the presence
of RTP values of the same scope with the
same name and different types (DPS allows
this scenario, unlike Classic).
Both
Altair Monarch 2024 Command Line User Guide 13
PARAMETER
DESCRIPTION
TYPE
If this type of duplication is present and Type
is not specified, the first type found is set.
Can be set multiple times.
Optional parameters:
:s, :type
Both* – In non-interactive mode, the /excel and /access flags are not valid unless a :t= modifier is present.
INPUT PATH OPTIONS
PARAMETER
DESCRIPTION
TYPE
/src: <File Path or
URL[:p=password][:cloud=cloud
service][:an=azure account
name][:ak=azure account
key][:akid=S3/S3 compatible
access key id][:skid=S3/S3
compatible secret key
id]<:t=table>>
Sets the path for the indicated file-based
load plan.
Setting this property will overwrite the path
previously specified in the Workspace.
A password can be set if required, but can
be omitted if not.
:t – the table to be re-pathed.
To access child tables, delimit with the @
character. If a table name is using the @
character, the @ in the command can be
“escaped” by adding an additional @. If
two sub-tables have the same name in the
path, an error is returned.
Can be set multiple times for a multi-file
load plan.
May accept URLs to cloud sources as well
as https, http, and ftp URLs.
Optional parameters:
:p, :cloud
Cloud service values are: gcs, oci,
awss3, abs, and adl, corresponding to
Google Cloud Storage, Oracle Cloud
Infrastructure, Amazon S3, Azure Blob
Storage, and Azure Data Lake Gen 2,
respectively.
Account Key and Account Name can
ONLY be validly used for Azure sources.
Non-interactive
only
Altair Monarch 2024 Command Line User Guide 14
PARAMETER
DESCRIPTION
TYPE
Access Key ID and Secret Key ID can
ONLY be validly used for S3, OCI, and
GCS.
Altair Monarch 2024 Command Line User Guide 15
EXPORT OPTIONS
PARAMETER
DESCRIPTION
TYPE
/exp:<File Path<:t=table>
<:fo=fileOption>
[:to=tableOption]
[:tn=exportTableName]>
Executes an export of the specified target
table to the specified path.
:t – the table to be exported.
To access child tables, delimit with the @
character. If a table name uses the @
character, the @ in the command can be
“escaped” by adding an additional @. If two
sub-tables have the same name in the
path, an error is returned.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extension will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (required for Excel and Access), :tn
Non-interactive
only
/expawss3:<URL
<:t=table><:fo=fileOption>
[:to=tableOption]
[:tn=exportTableName]>
[:akid=accessKeyId]
[:sk=secretKey]
Executes an export of the specified table
(:t) to the provided S3 url. This url must
begin with "awss3://" in order to be
recognized as a valid S3 export.
:t – the table to be exported.
:akid – the Access Key ID for the Amazon
S3 account/instance being exported to.
:sk – the account-specific Amazon S3
secret key.
If :akid and :sk are not provided, registry-
stored credential use will be attempted.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extensions will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (Required for Access and Excel), :tn
Non-interactive
only
/expadl:<URL <:t=table>
<:fo=fileOption>
Executes an export of the specified table
(:t) to the provided Azure Data Lake Gen2
Non-interactive
only
Altair Monarch 2024 Command Line User Guide 16
PARAMETER
DESCRIPTION
TYPE
[:to=tableOption]
[:tn=exportTableName]>
[:an=accountName]
[:ak=accountKey]
URL. This URL must begin with
"https://" in order to be recognized as a
valid Azure Data Lake Gen2 export.
:t – the table to be exported.
:an – the account name for the Azure Data
Lake Gen2 instance being exported to.
:ak – the (secret) account key for the
corresponding account provided by ":an".
If :an and :ak are not provided, registry-
stored credential use will be attempted.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extension will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (Required for Access and Excel), :tn
/expabs:<URL
<:t=table><:fo=fileOption>
[:to=tableOption]
[:tn=exportTableName]>
[:an=accountName]
[:ak=accountKey]
Executes an export of the specified table
(:t) to the provided Azure Blob Storage
URL. This URL must begin with
"https://" in order to be recognized as a
valid Azure Blob Storage export.
:t – the table to be exported.
:an – the account name for the Azure Blog
Storage instance being exported to.
:ak – the (secret) account key for the
corresponding account provided by ":an".
If :an and :ak are not provided, registry-
stored credential use will be attempted.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extension will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (Required for Access and Excel), :tn
Non-interactive
only
/expoci:<URL <:t=table>
<:fo=fileOption>
[:to=tableOption]
[:tn=exportTableName]>
Executes an export of the specified table
(:t) to the provided OCI URL. This URL
must begin with "https://" in order to be
recognized as a valid OCI export.
Non-interactive
only
Altair Monarch 2024 Command Line User Guide 17
PARAMETER
DESCRIPTION
TYPE
[:akid=accessKeyId]
[:skid=secretKey]
:t – the table to be exported.
:akid – the Access Key ID for the OCI
account/instance being exported to.
:skid – the account-specific OCI secret
key.
If :akid and :skid are not provided,
registry-stored credential use will be
attempted.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extension will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (Required for Access and Excel), :tn
/expgcs:<URL <:t=table>
<:fo=fileOption>
[:to=tableOption]
[:tn=exportTableName]>
[:akid=accessKeyId]
[:skid=secretKey]
Executes an export of the specified table
(:t) to the provided GCS URL. This URL
must begin with "https://" in order to be
recognized as a valid GCS export.
:t – the table to be exported.
:akid – the Access Key ID for the GCS
account/instance being exported to.
:skid – the account-specific GCS secret
key.
If :akid and :skid are not provided,
registry-stored credential use will be
attempted.
The export file extension determines the
file type produced. Valid extensions are:
XLS, XLSX, ACCDB, MDB, CSV, TSV,
TAB, JSON, XML, XPT, KDD, TDE, and
QVX. Any unrecognized extension will
result in a delimited text export.
Can be set multiple times for a multi-file
load plan.
Optional parameters:
:to (Required for Access and Excel), :tn
Non-interactive
only
:fo=fileOption
Sets the file option for the command line
export. Possible values are:
❑ Overwrite – create table, overwrite if
the table already exists
Non-interactive
only
Altair Monarch 2024 Command Line User Guide 18
PARAMETER
DESCRIPTION
TYPE
❑ Add – add (or append) data to an
existing table. Create the table first if it
does not exist.
❑ Skip – create the table only if it does
not exist.
Note: Parameter for the /exp flag family
:to=tableOption
Sets the table option for the command line
export. Possible values:
❑ Overwrite – create table, overwrite if
the table already exists
❑ Add – add (or append) data to an
existing table. Create the table first if it
does not exist.
❑ Skip – create the table only if it does
not exist.
:to is required for Access and Excel. The
export will fail if not specified
Note: Parameter for the /exp flag family
Non-interactive
only
:tn=exportTableName
Sets the name of the table to be used for
the command line export.
If :tn is not set, "Untitled" will be used.
Note: Parameter for the /exp flag family
Non-interactive
only
/expnamed:[export name] or
/px:[jobname]
Runs a named export if it exists.
Multiple exports may be run using multiple
/expnamed switches.
Can be set multiple times.
Non-interactive
only
/expall or
/pxall
Runs all exports defined within the
workspace
Can be set only once (subsequent flags
seen will be discarded after the first flag is
successfully performed without failing)
Non-interactive
only
The /px export commands are included to aid users of the Classic CLI. These switches may appear in any order and
may appear multiple times (with different name portions).
Behavior in the event of failures for non-interactive CLI
If any flag is malformed or fails to execute due to an incorrect path or otherwise, the entire command will immediately
fail and output error text to the command window. Note that this includes exports, but if an export fails, previous
exports that completed successfully cannot be undone.
Altair Monarch 2024 Command Line User Guide 19
[5] INSTALLATION COMMAND LINE
PARAMETERS
The tables below present a list and descriptions of command line parameters for Monarch installation.
USAGE
PARAMETER
DESCRIPTION
-quiet
Quiet mode
-passive
Unattended mode (this installation shows only a progress bar)
-n, -productName
Product Name
-uiCulture
License Manager UI Culture
-log
Log file location
-deactivation
Deactivate flag
-installFolder
Install folder location
-sampleFiles
Install folder location for sample files (for quiet mode only)
-noSampleFiles
Do not install samples files (for quiet mode only)
-noAlmUtils
Do not install ALM Utils (for quiet mode only)
-noADE
Do not install Access Database Engine 2010 prerequisite
-sqlLocalDbVersion
Version of SQL Server LocalDB to use for the Windows cache (e.g., “11.0,”
“13.0;” the default setting is “11.0”)
-excelDefaultImport
Engine
Default Excel engine to use when creating new projects and models
(Modern or Legacy)
-excelConvertMetadata
ToModern
Convert existing projects and models to use the Modern Excel engine
-uninstall
Uninstall the application
-repair
Repair the application
-activationType
Activation type (licenseServer, licenseFile, or altairLicenseServer)
-displayLegacyLicensing
Show legacy licensing methods (Volume License Key File)
-x86
Force 32-bit installation (may affect MS Access import/export)
-x64
Force 64-bit installation (may affect MS Access import/export)
-help, /?
Display this help screen
Altair Monarch 2024 Command Line User Guide 20
LICENSE FILE
PARAMETER
DESCRIPTION
-licenseFilePath
License File location
MONARCH LICENSE SERVER
PARAMETER
DESCRIPTION
-licenseServer
Monarch License Server location
-instanceName
Monarch License Server instance name
-userName
Monarch License Server user
-password
Monarch License Server user password
-domain
Monarch License Server domain name
-authentication
Monarch License Server authentication type (basic or Windows)
-isSecuredHttp
Monarch License Server secured http
ALTAIR LICENSE SERVER
PARAMETER
DESCRIPTION
-licenseServer
Altair License Server location
-licenseFilePath
Altair License File location
-activationKey
Altair License activation key
-alasStore
Specifies where on your machine the license file will be stored. The options
are user and system. If unspecified, the default setting is user.
-overwrite
Overwrites an existing license with the same activation key in the license
store if it already exists.
-licenseDataOutput
FilePath
Export current license data to specified file
COMMAND LINE EXAMPLES
Altair Monarch 2024 Command Line User Guide 21
The following commands assume that the installer is located in:
c:\Program Files\Altair Monarch 2024\LicenseManager\
License File Activation
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --activationType=licenseFile --
licenseFilePath="C:\Licenses\license.lic"
Monarch License Server Activation
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --activationType=licenseServer --licenseServer=localhost:51111 --
instanceName="lsInstance"
Altair License Server Activation
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --activationType=altairLicenseServer --
licenseServer=6200@localhost
Altair License File Activation
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --activationType=altairLicenseServer --
licenseFilePath="C:\Licenses\alf.dat"
Altair License Key activation (ALAS)
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --activationType=altairLicenseServer --activationKey="LXXXX-
XXXXX-XXXXX-XXXXX" --alasStore=[user|system] --overwrite
Altair License Key Deactivation (ALAS)
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --productName="Datawatch
Monarch 24" --deactivation --activationKey="LXXXX-XXXXX-XXXXX-XXXXX" --
alasStore=user
Current ‘License Data’ Export
"C:\Program Files\Altair Monarch
2024\LicenseManager\Datawatch.Licensing.Manager.exe" --licenseDataOutput