Custom Attributes for Windows Rugged

Custom attributes in Workspace ONE UEM enable you to extract specific values from a managed device (for example, IMEI, location, among many others) and use it as assignment criteria for products. You can also configure a 3rd party application to create custom attributes and display them on the launcher.

What Is A Custom Attribute?

A custom attribute is a placeholder for additional device information collected by Workspace ONE Intelligent Hub or by a third party application. This placeholder can be used in many different ways.

• It can be used to assign content such as provisioned products.
  • ...for example, you can provision product XYZ to only devices that are checked out and in the field.
• It can provide information to the admin on the UEM console or to the end user on the device.
  • ...for example, a delivery driver can view an in-house developed app to determine their next stop, furnished by a custom attribute that collects the location of the device.
• It can be used to move newly enrolled devices to a specific organization group.
  • ...for example, you can move all newly enrolled devices whose model number equals Zebra VC80 to an organization group that is designed to serve that specific model.

Note:

Custom attributes (and the rules generator) are only configurable and useable at Customer-level organization groups.

For details about available options regarding device assignment rules based on custom attributes, see Enable Device Assignments.

There are many ways to generate custom attributes, both within the UEM console and on the device itself.

How Do You Create a Custom Attribute and Assign it to a Single Device

Create a custom attribute and values to push to a device in Workspace ONE UEM. You can create assignment rules for products to provision based on these attributes and their values.

1. If you are not already in a customer type organization group (OG), move to one now. You cannot create custom attributes in any other kind of OG. For more information, see Organization Group Type Functions.
2. Navigate to Devices > Provisioning > Custom Attributes.
3. Select Add and then select Add Attribute.
4. Under the Settings tab, enter an Attribute Name.
5. Enter the optional Description of what the attribute identifies.
6. Enter the name of the Application that gathers the attribute. The application can be a third-party app or Workspace ONE Intelligent Hub.

   If you are not using a third-party app to generate the custom attribute, then use any name with an XML extension. For example, TruckRegCA.xml

7. Select Collect Value for Rule Generator to make the values of the attribute available in the drop-down menu of the rule generator.
8. Select Use in Rule Generator if you want to use the attribute in the rule generator.
9. Select Persist to prevent the removal of the custom attribute from the Workspace ONE UEM console unless an Admin or an API call explicitly removes it.

   Otherwise, the attribute is removed as normal. If you delete a custom attribute reported from a device to the UEM console, a persisted custom attribute remains in the UEM console. Custom attribute persistence is only available to Android and Windows Rugged devices.

10. Select Use as Lookup Value to use the custom attribute as a lookup value anywhere in the UEM console.

    This option is important if you want the custom attribute to be available to Launcher or other tools.

11. Select the Values tab.
12. Select Add Value to add values to the custom attribute.

    You do not need to enter all possible values of the attribute. The list of attributes entered here is not a requirement or constraint on what values the device can report. Instead, enter only expected values used to pre-define organization group assignment rules.

13. Select Save.
14. Navigate to Devices > List View, search for the device you want to assign the custom attribute to, and select its Friendly Name to display Details View.
15. Select the tab, then select Custom Attributes, followed by the Add button.

    The Custom Attributes screen displays.

16. Select the Add button on the Custom Attributes screen.
17. In the Application column drop-down, select the application name you entered in step 6. Then select the Attributes and Value in their respective drop-downs.

    

18. Select Save.

You can now use this custom attribute in the UEM console and in Launcher, in the following form.

{{CustomAttributeName::ApplicationName}}

Continuing the example from this task, the custom attribute looks like this in the Launcher config.

{{TruckRegValue::TruckRegCA.xml}}

For more information, see the section in this topic entitled Display Custom Attributes in Launcher.

How Do You Import Custom Attributes and Assign Them to Specific Devices

The custom attribute batch import feature in Workspace ONE UEM allows you to load custom attributes and corresponding values into the system in bulk. In the templates provided, each column corresponds to one custom attribute and each row corresponds to their different values or devices.

With the templates, you can import custom attributes in different ways and with different information.

Caution: The syntax of the first column of each template must be replicated exactly. Failure to use the proper syntax can cause database issues and result in loss of data.

To import custom attributes and assign them to specific devices, you must import two different CSV files, 1) one that defines the custom attributes and 2) another that defines the value of the custom attribute and assigns it to devices.

1. Navigate to Devices > Provisioning > Custom Attributes and select the Add button followed by Batch Import.

   The Batch Import screen displays.

2. Scroll down to where the template links can be seen and select two of the provided links to download both templates and save them to your device.
   • Custom Attributes – Download template for this batch type
   • Device Custom Attribute Values – Download template for this batch type

   You can either leave the Batch Import screen displayed while you complete the process of filling out the templates OR you can select the Cancel button, complete the templates, and return to the console later.

3. Browse your device and locate the two CSV files. Open the one titled Template - CustomAttributes.csv and fill in the fields that correspond to the headers.
4. Leave the Value column blank.
5. For the ApplicationName column, if you are not using an actual app on the device to generate the custom attribute, just enter any name with an XML extension, for example, SampleAppName.xml
6. The ShowOnDevicesGrid column corresponds to the Use As Lookup Value option. If you plan to display these custom attributes on the Launcher screen, the records for each attribute must be 1 in this column to enable the option.
7. Save the CSV file as SampleCustomAttributes.CSV.
8. Open the other template you downloaded in step 2, titled Template - CustomAttributeValuesXref.csv.
9. You must customize this template differently than the first template. The value entered in column A, XRefType, defines for the console how you want to identify devices, according to the following list.

   1. DeviceID

   2. Serial Number

   3. UDID

   4. MAC Address

   5. IMEI Number

10. In column B, XRefValue, supplies the value that corresponds to column A.

    For example, if you enter 2 for each row in the XRefType column A, then you must enter the serial number for each device that accepts a custom attribute in the XRefValue column B.

11. For column C, change the header using the format ApplicationName||CustomAttributeName, according to your actual custom attribute designations. When you fill out the values in column C, you are assigning values to the custom attribute that is specific to the device identified in column B.
12. Add subsequent columns for each custom attribute you want to assign to devices. Here is a sample completed Device Custom Attribute Values template. The text colored red are the portions you must customize.

    

    Note the different device identifiers in column A and how column B changes with it. You are free to use a single device identifier for the entire template. This is just an example that demonstrates the relationships.

13. Save the CSV file as SampleCustomAttributeValues.CSV.
14. Navigate back to Devices > Provisioning > Custom Attributes and select the Add button followed by Batch Import.
15. Enter Batch Name, Description, Batch Type as 'Custom Attributes', then select the Choose File button.
16. Locate your previously saved SampleCustomAttributes.CSV file (from step 7) and select it to upload.
17. Select Save to complete the batch import process.
18. Navigate to Devices > Provisioning > Custom Attributes and review all the newly imported custom attributes.
19. If you want to use these custom attributes in Launcher, select the pencil edit icon () for each custom attribute and enable the Use As Lookup Value check box.
20. Repeat steps 14 through 17 for the other CSV file (SampleCustomAttributeValues.CSV) you saved in step 13.

Note: Custom Attribute values cannot return the following special characters: / \ " * : ; < > ? |. If a script returns a value which contains these characters, the value is not reported on the console. Trim these characters from the script's output.

How Do You Assign Organization Groups Using Custom Attributes

Configure rules that control how devices are assigned to organization groups following enrollment in Workspace ONE UEM. You are limited to one custom attribute assignment rule per organization group (OG).

1. Ensure that you are currently in a customer type organization group.
2. Navigate to Groups & Settings > All Settings > Devices & Users > General > Advanced.
3. Set Device Assignment Rules to Enabled.
4. Set the Type to Organization Group by Custom Attribute.

   For more information about device assignment rules, see Enable Device Assignments.

5. Select Save.
6. Navigate to Devices > Provisioning > Custom Attributes > Add > Add Attribute and create a custom attribute if you have not already done so.

   See the section on this page entitled Create a Custom Attribute.

7. Navigate to Devices > Provisioning > Custom Attributes > Custom Attributes Assignment Rules > Add Rule.
8. Select the Organization Group to which the rule assigns devices.
9. Select Add Rule to configure the logic of the rule.

   Setting	Description
   Attribute/ Application	This custom attribute determines device assignment. Select from among Device Model, Serial Number, and any custom attribute or XML file that is available in the customer OG you are in.
   Operator	This operator compares the Attribute to the Value to determine if the device qualifies for the product. When using more than one Operator in a rule, you must include a Logical Operator between each Operator. Note: When making an assignment rule, comparisons using the less than (<) and greater than (>) operators (and their variants), and the Between operator, can only be used to compare numerical values including integers. The exception is when you are comparing OEM build versions, you can apply < and > operators on non-numerical ASCII strings. An example is when an OEM update filename includes hyphens, periods, and other characters together with numbers. Such assignment rules must identify a device manufacturer in the rule logic and that comparison is deemed accurate when the format on the device matches the one specified on the server.
   Value	All values from all applicable devices are listed here for the Attribute selected for the rule.
   Add Logical Operator	Select to display a drop-down menu of logical operators such as AND, OR, NOT, and parentheses. Allows for more complex rules.

10. Select Save after configuring the logic of the rule.

Results: When a device enrolls with an assigned attribute, the rule assigns the device to the configured organization group.

Custom Attributes Database

Custom attributes are stored as XML files and in the Workspace ONE Intelligent Hub database, each stored on the device. When using the database, custom attributes are sent as samples to Workspace ONE UEM periodically for asset tracking of key/value pairs.

If a record in the device database is configured with 'Create Attribute' = TRUE, then the Workspace ONE Intelligent Hub automatically retrieves the Name and Value sent with the custom attributes sample. The key/value pair displays in the Device Details page for the device in the Custom Attributes tab.