Custom Fields

You are here:

Settings > Custom Fields

Introduction

Custom Fields are used to track information that is not already in System Frontier by default.

Managing Custom Fields

In some cases you will need to have additional information available for use in System Frontier. Perhaps you have a Custom Tool that you’ve built which requires the user to select an option from a list of items. You would create a Custom Field to hold that list of items. Maybe the tool asks the user to enter the path to a specific folder or a process name. You could use a Custom Field so that the user could enter that info.

Or, maybe you need a Custom Field to capture unique information regarding computers, like a lifecycle date or a help desk ticket number.

On the Custom Fields page you can create a new or edit an existing Custom Field, sort, filter Custom Fields, and set the visible number to show per page.

The Custom Fields page

Clicking on a Custom Field Name or clicking the New button, will open the Edit Custom Field page:

Edit Custom Field page

Whether adding or editing a Custom Field, you will need to enter data into these fields:

  • Name. Only use letters, numbers, hyphens, and underscores for the name. Spaces are not allowed.
  • Description. Be concise.
  • Data type. The Data types that can be used are: Text, Number, CheckBox, ListBox, Date, MaskedText, URI, ListToCsv, FileContent, MultiSelect, Table, and HTML.
  • Validation (Regex). Uses ECMAScript compliant regular expression patterns.
  • Lookup Value(s). Enter values separated by semicolons.
  • Class mapping. This is an optional field. Selections are Computer, Container, Role, and UserAccount.
The reason for different types of fields is to ensure data is captured and used properly.

Data Types

Textstring
Numberint
CheckBoxstring[] or int[]
ListBoxstring[] or int[]
Datedatetime or string
MaskedTextstring
URIstring
ListToCsvstring[]
FileContentstring (represents the path to the temp file)
MultiSelectstring[] or int[]
Tablestring or int (represents the first column value)
HTMLstring
Text

With a Text custom field, normal text can be entered as a data type of string.

Number

In a number custom field, numbers can be entered as a data type of int.

CheckBox

The CheckBox custom field allows a selection of an item by placing a check box beside it. CheckBox has a data type of string[] or int[].

ListBox

ListBox shows a dropdown list of options from which to choose. Its data type is string[] or int[].

Date

The Date custom field accepts date format and in the form gives you a date picker pop-up as well. Its data type is datetime or string.

MaskedText

MaskedText visibly hides the entered data (like for a password field). The data type is string.

When used by Custom Tools, the value from a MaskedText field is never written to the log table or audit trail.
URI

The URI custom field allows entry of a URL that can be used to dynamically pass data to web-based applications, such as a ticketing system or a data reference site. When used with a Class Mapping value of Computer, the URI value will be represented as a link based off of the URL template entered into the Lookup value(s) field. The data type is string.

On the Settings > Custom Fields > New Custom Field page, for a URI Data type in this example, you would enter the link in the Lookup value(s) field, with {$TargetHostname} instead of specifying a computer name. This will allow the computer name to be populated dynamically in the Computer Summary tab Custom Fields in the link (see below).
From the Computer Summary tab.
An example of how a Custom Field with a URI Data type is displayed.

The JIRA Tickets link above will refer to this for the APPSRV01 server:

https://jira/tickets?hostname=APPSRV01
ListToCsv

ListToCsv will take text pasted into a textbox and transform it into CSV format for use by the Custom Tool. This can be helpful if the script used in the Custom Tool only accepts CSV-formatted data. The data type is string[].

FileContent

The FileContent custom field will take text pasted into a textbox and save it into a temporary file. It passes the file’s path reference to the Custom Tool’s command line. This can also give you the flexibility to do more complex things, if desired, by using the contents of the file to greater advantage. The data type is string.

MultiSelect

With the MultiSelect custom field a dropdown list of items is displayed which allows multiple selections. The data type is string[] or int[].

Example of a MultiSelect custom field.
Table

The Table custom field shows additional information that allows a single item to be selected. A preprocessor is required for this custom field and the first column will be the data that is passed. The data type is string or int.

Example of a Table custom field.
HTML

The HTML custom field will let you customize the Custom Tool form. HTML and JavaScript code can be used by setting it in the default value of the custom field or within preprocessor code. The data type is string.

See also this article about new custom fields, including MultiSelect, Table, and HTML: System Frontier v1-51-7286-12454

Options

Validation

Custom Fields can have regex validation as well. Place your ECMAScript compliant regular expression pattern into the Validation field and when the user runs the tool, the Custom Field in the form will require appropriate data entry.

Custom Field example with Validation. A text field requiring a properly formatted email address is shown.
Lookup Values

The ListBox and URI Data types rely on the values placed into the Lookup Value(s) field. Each value is separated by a semicolon.

An example of Lookup Value(s)

The Preprocessor Method

The Lookup Value(s) can also be pre-populated by the Preprocessor method. Custom Fields that would have Lookup Values defined, but need to have those values dynamically created instead of manually entering them one time, can use a Preprocessor. An example of this is showing a list of services on a computer in a ListBox instead of you typing some services into the ListBox Lookup Value(s) field manually. That list of services could change, so being able to have the list generated dynamically is a great option.

Default Values

Enter default value(s) if you want to ensure that a default value is passed in the event the user doesn’t provide a valid data entry for the custom field.

An Example of Default Value(s)
Class Mapping
Custom Fields Class Mapping

Currently, only the Computer value is used in Class Mapping. You normally wouldn’t select a Class Mapping if you were creating the Custom Field for use in a Custom Tool. If you select the Computer value in Class Mapping, then that Custom Field can be displayed when you view the Summary tab of a computer:

Custom Fields shown on the Summary tab of a Computer

When you click on the Edit button in the Custom Fields section of the Computer Summary tab, you will be able to enter and store the Custom Field data in System Frontier for that computer:

An example of entering Custom Field data into the Custom Fields of a computer on the Summary tab.

Adding a Custom Field

To add a Custom Field, click on the New button on the Settings > Custom Fields page. Fill in the fields with the information referenced above in the Managing Custom Fields section of this document.

Modifying a Custom Field

To edit a Custom Field, click on the Custom Field that you wish to modify and the Custom Field (Edit) page will appear. Change these fields as needed, referring back to the Managing Custom Fields section above, and click Save.

Deleting a Custom Field

To delete a Custom Field, click on the Custom Field that you wish to delete. Then, on the Custom Field (Edit) page at the bottom, click the Delete link.

To delete a Custom Field, click the Delete link

Be sure to read the User Guide for more information.

Was this article helpful?
Dislike 0