Administration > Administration tools > Using the command line tool
 

Previous Topic

Next Topic

Using the command line tool

Rival WingSpan also offers a command line executable program for communicating with the DataExchange web service in the installation directory for the Rival WingSpan Admin Tools. The executable name is DataExchangeCmdLine.exe and this option is typically run from a command prompt by someone familiar with DOS commands. An automated process using this method can be created by calling this executable and passing the command string via a batch file process or scheduled task.

The command line tool requires parameters that are passed to the tool in the form of a string of text. The following variables are required to pass data via string into the command line tool:

  • Site
  • Username
  • Password
  • Datatype
  • Commandtype

Here is an explanation of the data required for each string variable:

/site:<string>

Site to process (https://humanasset.net/YourCompanyName) or (https://YourCompanyName-ws.silkroad.com/CustomerName) (short form /s)

/username:<string>

username (short form /u)

/password:<string>

password (short form /p)

Note

Username and password must belong to an account with administrative privileges.

/datatype:{Employees|Relationships}

Data type to process (short form /d)

/commandtype:{ExportSchema|ExportData|ImportValidate|ImportDryRun|ImportLoad}

Command type to process (short form /c)

Command Type

Function

ExportSchema

Save the XML schema for the given data type to a file named <filename>

ExportData

Save the data to a file named <filename>

ImportValidate

Check the data file <filename> for compliance with the XML schema

ImportDryRun

Test loading data from the file named <filename> to the system

ImportLoad

Load data from the file named <filename> to the system

/chunksize:<int>

Chunk size to send on the import commands Default value:'10' (short form /z)

Note

Sending large files in multiple chunks provides for better feedback and easier troubleshooting.

/continueonerror[+|-]

Continue if error is detected Default value:'-' (short form /e)

/filename:<string>

File name to process (input for import, output for export (short form /f)

/logfile:<string>

Log file name to create/append (short form /l)

Note

Appends data if the file already exists.

@<file>

Read response file for more options