Unica Campaign Server Manager commands (unica_svradm)

You can use any of the following commands with the Unica Campaign Server Manager (unica_svradm) utility. The commands are not case-sensitive but the parameters are. The command-line prompt indicates the server and port of the listener machine to which you are connected.

Note: When you run unica_svradm in a clustered listener environment, the default connection is to the master listener. When you are connected to the master listener, the following commands affect all of the nodes in the cluster: Loglevel, Refresh, Shutdown, Status, Version. Use the Connect command if you want to connect to a specific node.

Cap (Unica Collaborate)

Cap

The Cap command prevents additional Unica Collaborate flowcharts from starting, while allowing flowcharts that are currently running to complete. Unset with the uncap command.

Changeowner

Changeowner -o <olduserid> -n <newuserid> -p <policyid>

The Changeowner command allows you to change the owner of a user's campaigns objects. For example, use this command if you are deleting or disabling a user and you want to re-assign ownership of that user's campaigns objects to a new user.To run the command Change object/folder permission is required.

Option Description
-o <olduserid> User ID of the current owner of the campaign objects.
-n <newuserid> User ID of the new owner that you will assign to the campaign objects.
-p <policyid> Policy ID of the security policy to apply to the campaign objects.

Connect

Connect [-f] [-s server] [-p port][-S]]

When you run unica_svradm, the command-line prompt indicates the server and port of the listener to which you are connected. Use the connect command if you want to connect to a different listener. You can connect to only one server at a time.

The following information pertains only to clustered listener environments:

  • When you run unica_svradm in a clustered listener environment, the default connection is to the master listener.
  • When you are connected to the master listener, the following commands affect all of the nodes in the cluster: Loglevel, Refresh, Shutdown, Status, Version. For example, the Status command displays the status of all nodes in the cluster.
  • To affect only a single listener, use Connect -s to connect to a specific node, then run the desired command.
  • If you are connected to the master listener and you run Connect -s against the master listener, you are reconnected in non-master listener mode. Any subsequent commands will affect only that node. To return to master listener mode, use the disconnect command.

Option

Description
-s Identifies the server to connect to. In a single-node (unclustered) environment, -s must be followed by -p.
-p In a single-node (unclustered) environment, -s and -p are required to identify the listener that you want to connect to.

In a clustered listener environment, -p is not necessary. Use -s to indicate the host, and the connection will be made based on the serverPort that is specified for Campaign|unicaACListener|node[n]|.

-S If you use -p to specify a port, you may also include -S to establish an SSL connection.
-f A common use for -f is when you are transitioning from a test environment to a production environment.

In a single-node (unclustered) environment: Use -f to force a connection to a listener that is not configured. The -s and -p options are required to identify the listener that you want to connect to.

In a clustered listener environment: -f is never required to connect to a clustered listener node. However, you can use -f to force a connection to a listener that is not in the cluster. The -s and -p options are required.

Disconnect

Disconnect

The Disconnect command disconnects from the server. This command is available only if you are connected to a server.

In a single-node environment, you can use this command to disconnect, then use the connect command to connect to another server. Or you can run connect with the -f parameter, instead of disconnecting first.

Note: In a clustered listener environment, when you run unica_svradm, the default connection is to the master listener. If you disconnect from the master listener, unica_svradm is no longer connected to any listener. If you disconnect from a non-master listener, you automatically connect to the master listener. The command-line prompt indicates the server and port where you are connected. To force a connection to a different listener, use connect with the -f parameter.

Exit

Exit

The Exit command logs you out of the Unica Campaign Server Manager.

Help

Help

The Help command displays the available commands.

Kill

Kill -p pid [-h hostname]

Use this command to end run-away processes associated with a listener. The Kill command issues a "kill-p" to the specified process ID. The Windows NT™ equivalent is issued on Windows NT™. If you need to obtain the process ID (PID), use the Status command.

In a single-node (unclustered environment), you do not need to specify the hostname. Just run Kill -p pid

In a clustered listener environment:

  • The kill command only affects a single listener node (it never propagates to all nodes in the cluster).
  • If you are connected to a non-master listener, you can omit the hostname. The command affects only that node.
  • If you are connected to the master listener, you must specify the name of the server that is running the master listener. For example: kill -p 1234 -h HostABC

Loglevel

Loglevel [high | low | medium | all]

To display the listener logging level, enter the loglevel command without any argument.

To set the listener logging level, enter the loglevel command followed by the desired logging level. All is the most detailed level and should be avoided except in troubleshooting situations.

Note: In a clustered environment, run the loglevel command when you are connected to the master listener to affect all clustered listener nodes. For example, loglevel low sets all listener nodes to the same logging level. If you are connected to a non-master listener, the command affects the current node only.

The change takes effect immediately, so there is no need to restart or refresh the listener after entering this command.

Quit

Quit

The Quit command logs you out of the Unica Campaign Server Manager.

Refresh

Refresh

The Refresh command is for use with a clustered listener configuration. If you have a single-node listener, the command has no effect.

The Refresh command informs the master listener of configuration changes and refreshes the configuration data on the master listener node. This avoids the need to reboot and provides a way to control when a refresh event occurs.

You must run the Refresh command in the following situations:

  • After you adjust Campaign|unicaACListener|node[n]|serverPort.
  • After you adjust Campaign|unicaACListener|node[n]|masterListenerPriority.
  • After you adjust Campaign|unicaACListener|node[n]|loadBalanceWeight.
  • After you add or remove a listener node at Campaign|unicaACListener|node[n].
    Important: Before you remove a listener node from the configuration, you must use the svrstop utility on each clustered listener node. In other words, you must stop all nodes, remove a node, then refresh. Otherwise, any existing sessions on the removed listener will continue to run but the master listener will not be able to contact the removed listener. This can cause unexpected results.

The Refresh command does not update the web application server. In most cases, it is sufficient to update the master listener only, but in certain cases you may also need to restart the web server.

Resume

Resume {-s flowchart_name |-p pid |-a} [-h hostname]

The Resume command resumes running one or more suspended flowcharts.

  • Use -s to resume a flowchart by name. All flowcharts with that name, in all campaigns and sessions, are affected. Therefore, it is best to use a relative flowchart path when you specify the flowchart name.
  • Use -p to resume the specified process ID. (Use the Status command to obtain the PID.)
  • Use -a to resume all suspended flowcharts.

In a single-node (unclustered) listener environment, you can omit the hostname.

In a clustered listener environment, if you are connected to the master listener, the listener host name is required. For example: Resume -a -h Hostname. If you are connected to a non-master listener, you can omit the hostname.

Run

Run -p relative-path-from-partition-root -u MarketingPlatform_user_name [-h partition] [-c catalogFile] [-s] [-m]

The Run command opens and runs a flowchart file, as specified by the relative flowchart path and file name, partition, catalog file, and user name.

Use the following syntax:

[-S dataSource -U db_User -P db_Password]*

Note: On Unix platforms, flowcharts are run by the Unix account specified as the username's alternate login. On Windows NT™, flowcharts are run as the administrator's user login.

The Run command takes the following options.

Option Description
-h Specifies the partition name.
-l Indicates an alternate location to store the flowchart log file. Follow this option with a path that is relative to the Unica Campaign installation, as in \partition1\logs. Do not specify a file name because the file name is assigned automatically.
Note: To use this option, AllowCustomLogPath must be enabled in Campaign|partitions|partition [n]|server|logging.
-m Specifies that you are running multiple flowcharts. This option is not supported for batch flowcharts.
-p Specifies the relative path from the partition root.
-P Specifies the data source password.
-s Specifies a synchronous run.
-S Specifies the data source.
-u Specifies the Unica user name.
-U Specifies the data source user name.
-v Specifies the user variable values for a flowchart directly in the command, using this syntax:

[-v "varname=[']value[']"]*

-x Specifies the user variable values for a flowchart in an XML file, using this syntax:

[-x xml-filename]

Example of an XML file for the -x argument:

This sample XML file sets the user variable named UVAcctType to the value Gold.

Note: Unica Campaign sets the user variable's value exactly as written in this file. Do not enclose the value in quotation marks if the value should not contain quotation marks.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
		                      <UserVariables>
	                        	 <UserVar Name="UVAcctType">
									 <Values>
										 <Option>Gold<Option>
	                    			</Values> 
	                             </UserVar>
	                          </UserVariables>

Save

Save {-s flowchart_name|-p pid|-a}-h hostname

The Save command saves the current state of an active flowchart. In a clustered listener environment -h hostname is required, otherwise this can be ignored.

Option Description
-s Saves the flowchart that you identify by its flowchart_name. All flowcharts with that name, in all campaigns and sessions, will be saved. Therefore, it is best to use a relative flowchart path when you specify the flowchart name.
-p Saves a flowchart defined by the process ID (pid). Use the Status command to obtain the PID.
-a Saves all running flowcharts.
-h In a clustered listener environment, if you are connected to the master listener, the listener host name is required. For example:save -a -h Hostname. If you are connected to a non-master listener, you can omit the hostname

Set

Set [variable[=value]]

The Set command displays and sets environment variables. Omit the value to view the current value and provide it to set the specified variable.

Shutdown

Shutdown [-f]

The Shutdown command shuts down the listener.

The system checks for any running flowchart. If running flowcharts are found, a warning message asks for confirmation of shutdown.

To override and force shutdown, use -f.

Note: In a clustered listener environment, if you issue the shutdown command to a master listener, all clustered listener nodes are shut down. To shut down an individual node in a clustered configuration, connect to that listener and then run the shutdown command.

Status

Status [-d |-i] [-u] [-v | -c]]

The status command provides information about active, suspended, and Unica Collaborate flowcharts. Information includes the flowchart owner (user name), process status, process ID, port, flowchart name, filename, and other details. Use this command to identify disconnected or orphaned processes. Also use this command to obtain the process ID for commands that accept PID as an argument.

Note: In a clustered environment, run the status command when you are connected to the master listener to see the status of all clustered listener nodes. If you are connected to a non-master listener, the command displays the status for the current node only.
Option Description
d Adds Server ID, Campaign Code, and Campaign ID to the displayed output.
i Displays the process ID (PID) only.
u Use this option when the displayed data contains non-ASCII characters.
v Verifies the existence of unica_acsvr processes before displaying output, which prevents crashed processes from being displayed in the Status list.
c Verifies the existence of unica_acsvr processes before displaying output, which prevents crashed processes from being displayed in the Status list. Option c also instructs the listener to clean up any temporary files in the partition temp directory that are associated with crashed server processes.

The Status command identifies the processes as follows:

  • c - connected (client is connected to the listener process -- may be running, may not)
  • d - disconnected (client is closed but the flowchart is running in the background)
  • o - orphaned (client is not connected to the flowchart and it is not running in the background. This is a lost process that cannot be reconnected to the listener and should be killed so people can log into it.)
Note: A value of <no writer> in the WRITER column refers to a server process that does not have a client in Edit mode, which may happen when no client is connected, and for login sessions.

Stop

Stop [-f] {-s flowchart_name |-p pid |-a} [-h hostname]

The Stop command checks for active clients, warns if any are present (you can override this with the -f force option), and stops server processes for the specified flowchart.

In a single-node (unclustered) listener environment, you can omit the hostname.

In a clustered listener environment, if you are connected to the master listener, the listener host name is required. For example: Stop -a -h Hostname. If you are connected to a non-master listener, you can omit the hostname.

Option Description
-s Stops the flowchart that you identify by its flowchart_name. All flowcharts with that name, in all campaigns and sessions, will be affected. Therefore, it is best to use a relative flowchart path when you specify the flowchart name.
-p Stops flowcharts by process ID (PID). Use the Status command to obtain the PID.
-a Stops all running flowcharts.
-f To override and force stop.

Suspend

Suspend [-f] {-s flowchart_name | -p pid |-a} [-h hostname]

The Suspend command allows you to "quiesce" a running flowchart and save the state for later restart with the matching command, Resume. The system finishes running any currently running processes and does not allow any subsequent processes to start. Flowcharts that are currently running an output process complete their data export activities. Only then is the flowchart saved in a paused state and written to the list of suspended flowcharts. This causes the least amount of work to be lost and preserves data integrity of output files.

If flowcharts must be stopped immediately, issue a Save command followed by Stop.

Note: If a flowchart is not running at the time of Suspend, it is saved but not written to the listener and cannot be started with Resume.
Note: In a clustered listener environment, the Suspend command only affects a single listener node (it never propagates to all nodes in the cluster).
Option Description
-s Suspends the flowchart that you identify by its flowchart_name. All flowcharts with that name, in all campaigns and sessions, will be affected. Therefore, it is best to use a relative flowchart path when you specify the flowchart name.
-p Suspends flowcharts specified by process ID (PID). Use the Status command to obtain the PID.
-a Suspends all running flowcharts.
-f The -f parameter allows you to force a suspend. Once suspended, the flowchart is written to the listener (the master listener, if you have a clustered configuration) as a suspended flowchart.
-h -h indicates the name of the host that is running the listener.

In a single-node (unclustered environment), you do not have to specify the hostname.

In a clustered listener environment:

  • If you are connected to a non-master listener, omit the hostname. The command affects only that node.
  • If you are connected to the master listener, the hostname is required (specify the name of the server that is running the master listener).

Uncap (Unica Collaborate)

Uncap

The Uncap command revokes the Cap (Unica Collaborate) command.

Version

Version

This command displays the version of the listener process (unica_aclsnr) and Unica Campaign Server Manager (unica_svradm). Use this command to help troubleshoot a version mismatch error. For example, if you have multiple listener nodes acting as a cluster, each listener node must be running the same version of software.

Note: In a clustered environment, run the version command when you are connected to the master listener to display the version of all clustered listener nodes. If you are connected to a non-master listener, the command shows the version for the current node only.

Here is an example of output for a non-clustered configuration, or when you are connected to a non-master listener:

unica_svradm version: 9.1.1
unica_aclsnr version: 9.1.1

Here is an example of output when you are connected to the master listener:

unica_aclsnr version at <myhost01 : 4664> is: 9.1.1
unica_aclsnr version at <myhost02 : 4664> is: 9.1.1
unica_aclsnr version at <myhost03 : 4664> is: 9.1.1
unica_svradm version: 9.1.1