Varicent Incentive Compensation Management Documentation

Using the CLI Tool to Upload Import Files

Use the CLI tool to upload import files to Varicent Incentive Compensation Management (ICM) on Cloud storage.

You must extract the IBM Varicent ICM Command Line Tool from the compressed folder that came with your release.

This command imports a file to Varicent ICM storage. The command should be used when there is no file in Varicent ICM storage that has the same filename. A new file is uploaded and the file is assigned a new file ID.

Note

The specified user must belong to a role that has the "Import | Files |Edit" permission enabled on the model.

  1. Open the command prompt.

  2. Navigate to the directory in which the import tool is stored.

  3. From the command-line, type this command:

    "IBM Varicent ICM Command Line Tool.exe" --host "<ICM address>" --username "<ICM login name>"
--password "<ICM login password>" --model "<name of your model>" 
--function "importupload" --name "<filename>" --filepath "<file path>"

    where, name is the name of the file as you want it to be displayed in Varicent ICM storage and filepath is the location of the file that you want to import.

    Important

    Enclose the parameters with quotation marks "<name>" to prevent errors related to spaces in names.

    You must update your passwords in the command every time you update your admin client password.

The file uploads in small batches. If the tool runs successfully, it will return an exit code of 0. If it fails, the tool will return a non-zero exit code. If there was an error, you can rerun the import command and it will resume uploading at the batch it stopped at.