Add users from a flat file import

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 install 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> [-o<OutputFile>]

The OutputFile parameter is an optional parameter which specifies where to output a trace file. If not specified, then EQCmd will attempt to write the output file to the same folder where the batch file exists, using the same name as the batch file, but adding the .log extension. If the trace file cannot be opened, the utility will log a warning to the console screen and proceed with the batch file, writing all messages to the console.

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

Parameters enclosed in parentheses < > are mandatory; parameters within square brackets [ ] are optional.

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.
  • 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>.
  • modify - Modify an object attribute.
  • adjust - Adjust the balance for user, department and billing code; set a new balance to an object type or set a balance no less than a certain amount.
  • lock/unlock - Lock or unlock a user, department or billing code.
Obj_type Use one of the following:
  • 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. Use All to apply <Action> to all accounts of <Obj_type>.
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. Use double quotes around detail values that have spaces or for empty values. Specify amounts with a period for the decimal separator. For the modify action, place “!” for required fields that you don't wish to change.
  • <init_bal> - Initial balance
  • <min_bal> - Minimum account balance
  • <desc> - Description
  • <user_id> - User ID
  • <user_name> - User name
  • <dept_name> - Department name
  • <bc_name> - Billing code name
  • <email> - User email
  • <amount> - Amount of balance value

For a complete list of Action parameters, see Modifying User Accounts from a Flat File.