Manage Parameter Files

You can customize and import parameter XML files for devices. This type of file differs from the free-form XML entered in the General Settings template because it is not associated with a device configuration profile. A parameter file must be imported into the database before it can be downloaded to devices.

Note: Two XML files are installed in the database by default: TrxLoggingOff.xml and TrxLoggingOn.xml

Updating device parameter XML files is a two-step process in the Universal Device Manager:

A stored parameter file is selected and imported into the database.
A manual Load Parameter File action or scheduled Load Parameter File event is initiated to download the firmware to the device.

Create a custom parameter file

Some device configuration data is specific to your system and, in some cases, to a single device. To retrieve the device configuration data from devices for home employees, labor levels, maintenance mode password, or supervisor password; create a custom parameter file. Begin the file name with get and begin the XML code with a <get> or a <getAll> command.

Note: The Universal Device Manager does not support the getAll command for home employees or labor levels.

Sample parameter files

The following sample XML files contain default values. To generate a custom file, replace the default value as appropriate.

Create a file to upload data from a device (for a specific home employee)

Create a text file named getemployeename. xml that contains the following text:
<get><List><HomeEmployee> <Record id="1"></Record> </HomeEmployee></List></get>
Where the value for the id attribute is the employee’s badge number (up to 18 digits). The default value is 1.
Import the file as described in Import parameter XML files. After you import a file, the file name appears in the drop-down list of the Retrieve Device Configuration File workspace. See Retrieve device configuration data.

Create a file to upload a single labor level assignment

Create a text file named get laborlevel .xml that contains the following text:
<get><List><LaborLevel> <Record llid="1" value="100"></Record> </LaborLevel></List></get>
Where the llid attribute is the labor level number (1–7) and the value is the labor level entry. The default values are 1 and 100.
Import the file as described in Import parameter XML files. After you import a file, the file name appears in the drop-down list of the Retrieve Device Configuration File workspace. See Retrieve device configuration data.

Create a file to upload the maintenance mode password

Create a text file named get maintenancepw .xml that contains the following text:
<get><List><Password> <Record type="M" userId="99" > </Record> </Password></List></get>
Where the userId attribute is the ID for the maintenance mode badge. The default value is 99.
Import the file as described in Import parameter XML files. After you import a file, the file name appears in the drop-down list of the Retrieve Device Configuration File workspace. See Retrieve device configuration data.

Create a file to upload a supervisor password

Create a text file named getsuperpw .xml that contains the following text:
<get><List><Password> <Record type="S" userId="0" > </Record> </Password></List></get>
Where the userId attribute is the ID for the supervisor badge. The default value is 0.
Import the file as described in Import parameter XML files. After you import a file, the file name appears in the drop-down list of the Retrieve Device Configuration File workspace. See Retrieve device configuration data.

Import parameter XML files

Cloud Services may load parameter files to a Global area. Files posted in this area are visible to all tenants in the Universal Device Manager. Tenant administrators can load files to the Tenant area only for tenants that they are permitted to access. Global and Tenant tabs in the Manage Parameter Files page list the files residing in each area.

To import a parameter XML file:

From the Devices menu, select Manage Imports > Parameter Files.
Select the Tenant tab. (The listings in the Global tab are read-only and for informational purposes only.)
Select the Device Type for the parameter file that you wish to load.
Click Tap Choose File.
Choose a file and click tap Open.
Click Tap Import File.

Note: The XML file cannot be larger than 30K.

The XML file is imported into the database. A new row, which includes the file name and the date and time when the file was imported, is added to the list table.

To download the contents of a parameter file to the Desktop, select the name of the file in the grid and tap click Download File.

To delete a file from the database, select the appropriate file, and click tap Delete. You can select multiple parameter files to delete.

Set up and schedule a Load Parameter File event

First set up a Load Parameter File event and its schedule:

Select Configuration > Events from the Devices main menu.
Click Tap New . The Event Editor workspace appears.
In the Event Details tab, select an Event Type of Load Parameter File and specify a name for the event.
Select the desired firmware file from the drop-down list
Select either All, InTouch DX, InTouch or 4500 as the device type, as appropriate.
Define a schedule for the event by selecting a type (Once, Minutes, Hourly, Daily, or Monthly and Time Zone). The Schedule Type determines the remaining parameters which you must complete. By default, the Forever check box is selected. Deselect it to specify and End Date and End Time.
Click Tap Create when you are done.

Next, assign the Load Parameter File event to one or more devices or device groups within the Devices or Groups views in the Dashboard. You can also assign the event to a single device from its Device Details page.

If you are using the Devices view in the Dashboard, select one or more devices. If you are using the Groups view , select one or more device groups. Skip this step if you are using the Device Details page.
Select Actions > Assign Events.
Select an event.
Click Tap Assign.