Modify User Accounts from a Flat File

Use the EQCmd.exe utility to add, delete, modify and query user, department and billing code accounts from a flat file. You can also assign users and departments to billing codes. This method is a one-time import and does not synchronize data beyond the import.

Equitrac installs this utility on the accounting server in the Program Files\Nuance\Equitrac\Tools folder.

The command-line utility accepts commands in the following format:

EQCmd -s<Server> <Action> <Obj_type> <Obj_ID>|All [<Options>] 

Execute the command with a batch file:

EQCmd -s<Server> -f<BatchFile>

Command-line parameters enclosed in parentheses < > are mandatory and require a specified value. Parameters within square brackets [ ] are optional entries and do not need to have a specified value if they will not be included in the command. Optional parameters that will be in the command, do require a specified value.

Equitrac accepts CSV files as batch files. Batch operation allows all the command actions except for the “query” command. Use the table below to fill in the parameters.

Parameter Variables
Server Specify the name or IP address of CAS.
Action Specify the action to take on the account. Use one of:
  • add - Add user, department and billing code.
  • assign - Assign a billing code to a user or a department.
  • modify - Modify an object attribute.
  • addormodify - Add or modify a user, department or billing code imported into Equitrac.
  • delete - Delete user, department or billing code. It does not use <details> parameter.
  • remove - Remove the association between billing code and user or department.
  • query - Query database. Output differs based on <Obj_type>.
  • adjust - Adjust the balance for user, department and billing code; set a new balance to a object type or set a balance no less than a certain amount.
  • lock/unlock - Lock or unlock a user, department or billing code.
  • quota - sets the color pages quota to a set amount for a single user or all users within a department.
Obj_type Use one of:
  • ur - user
  • dp - department
  • bc - billing code
Obj_ID Applies <action> only to the specified object ID. Use double quotes around object IDs that have a space, for example human resources. To apply <Action> to all accounts of <Obj_type>, use All.
Note: You can use “All” for “Assign”, “Remove”, “Query”, “Adjust” actions. You cannot use it for “Add”, “Delete”, “Modify”, “Lock” and “Unlock” actions.
Options for Action Command Specify additional values.
  • <init_bal> - Initial account balance
  • <min_bal> - Minimum account balance
  • <desc> - Description
  • <user_id> - User ID
  • <user_name> - Full user name
  • <dept_name> - Department name
  • <bc_name> - Billing code name
  • <email> - User email
  • <amount> - Amount of balance value. The value can be both positive (+) and negative (-)
  • <quota> - User color quota
  • <primaryPIN> - User Primary PIN
  • <secondaryPIN> - User Secondary PIN and Confirm Secondary PIN
  • <alternatePIN> - Alternate to user Primary PIN
  • <home_server> - DRE print server
  • <locked> - User account is locked
  • <location> - Location of the user
  • <delegate_id> - Delegate user ID
  • <default_bc> - Default billing code
  • <additional_info> - Additional information about the user
  • <home_folder> - User home scan folder as a full network location (UNC path). It is used as a destination folder for scan processing