Riva CLI Tool: --connection Command

Riva CLI commands --connection

--connection has several subcommands to create a Riva CRM or email connection or perform various operations on a connection.

Using the --connection command without a subcommand has the same effect as using it with its --help subcommand.

Subcommands:

--help
--create
--delete
--update
--verify
--test
--refresh

--help

Produces a connection-specific help output that includes descriptions of connection subcommands and examples.

Syntax:

RivaCli.exe --connection –-help

--create

Creates a connection for a user.

Syntax:

RivaCli.exe --connection --create 
[[email="user's-email-address"] [endpoint="URL"] [password="user's-password"]]
[Either [--configBase="path-string"] OR [--path=”path-string”]]

Parameters:

--email (string)

Optional. The email address of the user to create a connection for.

If the --email parameter is not provided on the command line, Riva CLI prompts for the user's email address.

--endpoint (string)

Optional. In most cases, this is the URL that the connection connects to.

If the --endpoint parameter is not provided on the command line, Riva CLI prompts for the endpoint.

--password (string)

Optional. The password for the user's connection that is being created. It is not displayed on the command line.

If the --password parameter is not provided on the command line, Riva CLI prompts for the password and a confirmation of the password.

--configBase (string)

Optional. The complete path of the Riva installation folder that contains Riva.exe.

Either --configBase or --path can be used with the --create subcommand, but not both.

If neither --configBase nor --path is specified, Riva CLI looks for the folder that contains Riva.exe.

--path (string)

Optional. The complete path of the folder where the connection is created.

Either --path or --configBase can be used with the --create subcommand, but not both.

If neither --path nor --configBase is specified, Riva CLI looks for the folder that contains Riva.exe.

Example:

RivaCli.exe --connection --create --path=”C:\Riva\Connections\”

Result: A connection is created in the C:\Riva\Connections folder.

--delete

Deletes a user's connection.

Syntax:

RivaCli.exe --connection --delete 
[--connectionId="connection-name"]
[Either [[--configBase="path-string"] [--subFolder="subfolder's-name"]] OR [--path=”path-and-connection-name”]]

Parameters:

--connectionId (string)

Optional. The connection's complete name, not its user-friendly display name.

Example of a connection's complete name:

admin-01@your-email-domain.com<>www.your-CRM.com

--configBase (string)

Optional. The complete path of the folder that contains Riva.exe.

If you use --configBase on a command line, you can also use --subFolder but not --path.

If neither --configBase nor --path is specified, Riva CLI looks for the installation folder that contains Riva.exe.

--subFolder (string)

Optional. The installation folder where Riva.exe resides contains a folder named Configuration. The --subFolder parameter indicates the ONLY subfolder of Configuration where Riva CLI will look for the connection.

If you use --subFolder on a command line, you can also use --configBase but not --path.

--path (string)

Optional. The complete path of the connection file, including the connection file name.

If you use --path on a command line, you cannot use --configBase or --subFolder on the same line.

If neither --path nor --configBase is specified, Riva CLI looks for the installation folder that contains Riva.exe.

Example:

RivaCli.exe --connection --delete --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: Because neither --configBase nor --path is specified, Riva CLI looks for the folder that contains Riva.exe. Recursing, it finds the connection named admin-01@your-email-domain.com<>www.your-CRM.com and deletes it.

--update

Updates the password of an existing connection.

Limitation: --update does not support connections created in Riva 2.4.42 or earlier.

The password is processed as a SecureString as much as possible.

Syntax:

RivaCli.exe --connection --update 
[--connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"]
[--newPassword=["new-password"]]
[Either [[--configBase="path-string"] [--subFolder="subfolder's-name"]] OR [--path=”path-and-connection-name”]]

Parameters:

--connectionId (string)

Optional. The connection's complete name, not its user-friendly display name.

Example of a connection's complete name:

admin-01@your-email-domain.com<>www.your-CRM.com

--newPassword (string)

Optional. The text string of the new password. It is not displayed on the command line.

If no string is provided, Riva CLI prompts for the new password and a confirmation of the password.

--configBase (string)

Optional. The complete path of the folder that contains Riva.exe.

If you use --configBase on a command line, you can also use --subFolder but not --path.

If neither --configBase nor --path is specified, Riva CLI looks for the installation folder that contains Riva.exe.

--subFolder (string)

Optional. The installation folder where Riva.exe resides contains a folder named Configuration. The --subFolder parameter indicates the ONLY subfolder of Configuration where Riva CLI will look for the connection.

If you use --subFolder on a command line, you can also use --configBase but not --path.

--path (string)

Optional. The complete path of the connection file, including the connection file name.

If you use --path on a command line, you cannot use --configBase or --subFolder on the same line.

If neither --path nor --configBase is specified, Riva CLI looks for the installation folder that contains Riva.exe.

Example #1:

RivaCli.exe --connection --update --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com" --newPassword=”Aa1!Bb2@Cc3#"

Result: Because neither --configBase nor --path is specified, Riva CLI looks for the folder that contains Riva.exe. Recursing, it finds the connection named admin-01@your-email-domain.com<>www.your-CRM.com . Then the password is changed to Aa1!Bb2@Cc3# .

Example #2:

RivaCli.exe --connection --update --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com" --newPassword

Result: Because neither --configBase nor --path is specified, Riva CLI looks for the folder that contains Riva.exe. Recursing, it finds the connection named admin-01@your-email-domain.com<>www.your-CRM.com . Because no value was entered for the --newPassword parameter, Riva CLI prompts for the new password and a confirmation.

--verify

Validates the connection that has the specified name or is at the provided path. Upon success, the connection is decrypted.

Syntax:

RivaCli.exe --connection --verify
[--connectionID="connection's-complete-name"]
[Either [[--configBase="path-string"] [--subFolder="subfolder's-name"]] OR [--path=”path-and-connection-name”]]

Parameters:

--connectionId (string)

Optional. The connection's complete name, not its user-friendly display name.

Example of a connection's complete name:

admin-01@your-email-domain.com<>www.your-CRM.com

--configBase (string)

Optional. The complete path of the folder that contains Riva.exe.

If you use --configBase on a command line, you can also use --subFolder but not --path.

If neither --configBase nor --path is specified, Riva CLI looks for the installation folder that contains Riva.exe.

--subFolder (string)

Optional. The installation folder where Riva.exe resides contains a folder named Configuration. The --subFolder parameter indicates the ONLY subfolder of Configuration where Riva CLI will look for the connection.

If you use --subFolder on a command line, you can also use --configBase but not --path.

--path (string)

Optional. The complete path of the connection file, including the connection file name.

If you use --path on a command line, you cannot use --configBase or --subFolder on the same line.

If neither --path nor --configBase is specified, Riva CLI looks for the installation folder that contains Riva.exe.

Example #1:

RivaCli.exe --connection --verify --path="C:\Riva\Configuration\salesforceTest.connection"

Result: Riva CLI validates the connection that has the specified name at the provided path. Upon success, the connection is decrypted.

Example #2:

RivaCli.exe --connection --verify --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: Riva CLI looks in the RivaCli app.config file for the configBase key and goes to the location of the folder that contains Riva.exe. If the key is absent, Riva CLI looks for the folder that contains Riva.exe. From there, Riva CLI recurses until it finds the admin-01@your-email-domain.com<>www.your-CRM.com connection. Then it validates the connection, and if that operation is successful, the connection is decrypted.

Example #3:

RivaCli.exe --connection --verify --configBase="C:\Riva\RivaSync" --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: Because --subFolder was not specified, Riva CLI looks for the admin-01@your-email-domain.com<>www.your-CRM.com connection in C:\Riva\RivaSync\Configuration. Riva CLI validates connection, and if that operation is successful, the connection is decrypted.

Example #4:

RivaCli.exe --connection --verify --configBase="C:\Riva\RivaSync" --subFolder="Production" --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: Riva CLI looks for the admin-01@your-email-domain.com<>www.your-CRM.com connection in C:\Riva\RivaSync\Configuration\Production and validates it. If the operation is successful, the connection is decrypted.

--test

Executes a simple connection test of the specified connection.

Syntax:

RivaCli.exe --connection --test 
[--connectionID="connection's-complete-name"]
[Either [[--configBase="path-string"] [--subFolder="subfolder's-name"]] OR [--path=”path-and-connection-name”]]

Parameters:

--connectionId (string)

Optional. The connection's complete name, not its user-friendly display name.

Example of a connection's complete name:

admin-01@your-email-domain.com<>www.your-CRM.com

--configBase (string)

Optional. The complete path of the folder that contains Riva.exe.

If you use --configBase on a command line, you can also use --subFolder but not --path.

If neither --configBase nor --path is specified, Riva CLI looks for the installation folder that contains Riva.exe.

--subFolder (string)

Optional. The installation folder where Riva.exe resides contains a folder named Configuration. The --subFolder parameter indicates the ONLY subfolder of Configuration where Riva CLI will look for the connection.

If you use --subFolder on a command line, you can also use --configBase but not --path.

--path (string)

Optional. The complete path of the connection file, including the connection file name.

If you use --path on a command line, you cannot use --configBase or --subFolder on the same line.

If neither --path nor --configBase is specified, Riva CLI looks for the installation folder that contains Riva.exe.

Example:

RivaCli.exe --connection --test --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: Because --configBase, --subFolder, and --path were not specified, Riva CLI looks for the admin-01@your-email-domain.com<>www.your-CRM.com connection in the Configuration subfolder of the folder where Riva.exe resides. Riva CLI tests the connection.

--refresh

Available only for OAuth connections.

Opens the CRM login page for the specified OAuth connection. As a result, if there are no errors, the OAuth token is refreshed.

Syntax:

RivaCli.exe --connection --refresh 
[--connectionId="connection's-complete-name"]
[Either [[--configBase="path-string"] [--subFolder="subfolder's-name"]] OR [--path=”path-and-connection-name”]]

Parameters:

--connectionId (string)

Optional. The connection's complete name, not its user-friendly display name.

Example of a connection's complete name:

admin-01@your-email-domain.com<>www.your-CRM.com

--configBase (string)

Optional. The complete path of the folder that contains Riva.exe.

If you use --configBase on a command line, you can also use --subFolder but not --path.

If neither --configBase nor --path is specified, Riva CLI looks for the installation folder that contains Riva.exe.

--subFolder (string)

Optional. The installation folder where Riva.exe resides contains a folder named Configuration. The --subFolder parameter indicates the ONLY subfolder of Configuration where Riva CLI will look for the connection.

If you use --subFolder on a command line, you can also use --configBase but not --path.

--path (string)

Optional. The complete path of the connection file, including the connection file name.

If you use --path on a command line, you cannot use --configBase or --subFolder on the same line.

If neither --path nor --configBase is specified, Riva CLI looks for the installation folder that contains Riva.exe.

Example:

RivaCli.exe --connection --refresh --connectionId="admin-01@your-email-domain.com<>www.your-CRM.com"

Result: If the admin-01@your-email-domain.com<>www.your-CRM.com connection is an OAuth connection, your company's Riva admin is prompted with the CRM login page. Logging in refreshes the token.