Custom device fields extend the information available to be stored for devices, beyond the general system fields. You will first need to add a custom device field group, as a higher-level category, then add custom fields to the corresponding group in which they belong.

Access the Custom Device Fields Page

1. From the Ubersmith Dashboard, click Settings.
   
   The Ubersmith Settings page appears.
2. From the Devices section, click Custom Device Fields.
   
   The Custom Device Fields page appears.

Complete the Add Custom Field Group Page

A custom device field group is a higher-level category that contains associated custom fields to be applied to devices.

1. From the Custom Device Fields page, click Add New Custom Device Field Group.
   The Add Custom Field Group page appears.
    
2. In the Name field, enter the name of the group you want to display on the Custom Device Fields page.
3. In the API Variable Name field, click edit and enter the corresponding API name for the custom device field group, if you want the API variable name to be different from the system-generated name.
4. Click Save or Save & New.
    

Complete the Add Custom Field Page

Once a custom field group has been created, individual custom fields can be created in order to assign them to associated devices. This page provides the means for custom fields to display on the Adding Device Types page.

1. From the Custom Device Fields  page, click add custom field.
    
   The Add Custom Field page appears. 

Complete the Details tab

Note: The fields in this tab change based on the selected value in the Type field.

1. In the Label field, enter the name to display to the user for the custom field.

2. In the Type field, select the type of expected input information for the custom field; either a select box, multiple select box, text area, check box, or date.
    

   Text Input In the Field Size field, enter the number of digits to define the size of the custom field. In the Default Value field, enter the default value to display in the custom field. In the Regular Expression Match field, enter the rule for the data that will get entered in the custom field. In the Regular Express Help Text field, enter the message that will be shown to the user about the regular expression match. Select Box In the Enter possible values on separate lines field, enter the available selection choices. In the Default Value field, enter the default value to display in the custom field. Multiple Select Box In the Enter possible values on separate lines field, enter the available selection choices. In the Default Value field, enter the default values to display in the custom field. Text Area In the Rows field, enter the number of rows the text area should contain. In the Columns field, enter enter the number of columns the text area should contain. In the Default Value field, enter the default value to display in the custom field. Check Box In the Default Value field, either select or leave blank to have the custom field be checked or blank. Date In the Default Value field, enter the date to display in the custom field.

3. In the API Variable Name field, enter the name to be used as the API variable name. Clicking edit enables the field to be change.
4. In the Group field, select the associated custom device field group for this field.

5. In the Client Access field, select either none, view, or edit to configure the level of access the client will have from the Client Portal.

   The Client Access field enables you to configure your client's access for a device, although almost no device types provide edit privileges.

6. In the Required field, select this field if the custom field will be required to be completed.
7. In the Unique field, select this field if the custom field should be unique across all custom field values of this type.
8. In the Show In Lists field, select either No or Position 1 through Position 5, to configure where the field will display in the device list in the Device Manager or the client’s devices in the Client Manager.
    

Complete the Applicable tab

The Applicable tab lists all your existing device groups and their corresponding devices so you can assign the custom field to any associated device. You will first determine if the custom field belongs in a device group, and then how it relates to each individual device inside the device group.

1. Click on the Applicable tab.
2. For each device group, select either Yes, Required, or No.
3. For each related device under a device group, select either Inherit, Yes, Required, or No.
4. Click Save or Save & New.
    

Related Topics 

Managing Custom Device Fields

Adding Device Group and Device Type Modules

Managing Device Group and Device Type Modules

Adding Device Types

Managing Device Types Groups and Device Types

Ubersmith Device Module Examples