Running automations from a command line

Automations are normally run from Transfer Desk, but you can also run them from the command line. For example, select Start > Run in Windows to specify the command at the command prompt. You can use the same command line syntax to set up a scheduler program such as NT Scheduler to run the automation on a scheduled basis. The command can also be used in a SunSystems shortcut, to run an automation from SunSystems.

The syntax to run an automation, or a profile, from a command line is: <SunSystems_installation_folder\ssc\bin\AutomationDesk.exe -p profile> -a <automation_profile_name> -n -s -u user_ID -x user_password

where:

  • SunSystems_installation_folder is the full path to your installation of SunSystems.
  • profile is the name of the profile defined in Transfer Desk.
  • automation_profile_name is the name of the automation defined in Transfer Desk.
  • user_ID is your SunSystems user ID.
  • user_password is the password for your SunSystems user ID.
Note: You can use the command line to run either a profile or an automation, but not both in the same command.

The parameter letters must be entered with a leading hyphen:

  • p to run a profile. You must specify the file name and business unit in the profile before using this option. Alternatively, use -s profile to display the profile in Transfer Desk. This option enables users to set or reset any profile parameters, including the file name and business unit. The profile can then be run manually from Transfer Desk, if required.
  • a to run an automation.
  • n to run without displaying the Transfer Desk user interface. This might be useful, for example, if running automations using a scheduler.
  • s to run in single mode. This runs a single profile, in the Transfer Desk interface.
  • u to specify a user ID. This is required to ensure that the profile it is always run by the appropriate user ID.
    Note: The user ID must be a member of one of the SunSystems Connect groups.
  • x to specify the password. This is only necessary if you specify a user ID.

Example

The command line for an example automation might be as follows:

C:\program files\SunSystems\ssc\bin\AutomationDesk.exe -a Export2 -n -u NIC -x MyPa55w0rd

where:

  • Export2 is the automation name as defined in Transfer Desk
  • NIC is a user Id that has been enabled to use SunSystems Connect
  • MyPa55w0rd is the password for user ID NIC.
Related topics