Get a Quote

Articles in this section

See more

How to create and manage custom fields

  • Updated:

Introduction

HelloID Provisioning gives you a robust set of fields to work with in regards to storing personnel and contract data from your source system. However, not every use case can be accounted for. In the event that you need to store more data, or you have data that doesn't match the default fields (e.g., there's no "favorite pizza" field), you can add your own custom fields. 

Add a Custom Field

To get started, navigate to the Source Systems Overview.

  1. Click on the wrench icon next to Custom Fields, as seen below.
    mceclip0.png
  2. On the next screen click on the plus sign button to add a new custom field.
    mceclip0.png
  3. A new field will be added, and its configuration will appear on the right side of the screen. Adjust the following fields as you see fit.
    1. Display Name: Provide a short, but descriptive name for the new field. For example, "Favorite Pizza".
    2. Type: Select the object to which this field will be added. Demographic data should be associated to the Person object, and contract/employment data should be associated to the Contract object.
    3. Name: This is the name by which HelloID will reference the field in its scripts and processes. Whatever you put here will be prefaced with "custom." in scripts and mappings. Using our "Favorite Pizza" example, we could type "favoritePizza" in this field. The field would then be referred to by "custom.favoritePizza" in scripts and mappings.
      mceclip1.png
    4. When you are finished adding custom fields, click Save to commit your changes.

mceclip2.png

Map Data onto Custom Fields

After you've added one or more custom fields, they will be available for mapping in your source system configuration.

  1. Edit the source system for which you want to map a custom field.
  2. Go to the Person or Conract tab. This will correspond to the Type of field that you added in previous steps.
  3. Select your custom field from the dropdown at the bottom of the field list and click Add.
    mceclip3.png
  4. Map the value of the field accordingly, either as a Fixed, Field, or Complex value.
    mceclip4.png
  5. When you are finished mapping data onto your custom fields, save the system to apply your changes.

View Custom Field Data

After a system has been imported that has custom fields, you can see each person's data in their custom fields by going to the Persons Overview. Once there, select a person record. Custom fields are given their own section under the Information tab for each person. In the screenshot below, we can see that John Doe prefers pepperoni pizza.

mceclip5.png

Access Custom Fields in Scripts

You can use data from custom fields in your scripts for the PowerShell target connector. The script for each lifecycle stage has access to the $person object. Once converted into a PowerShell object using the ConvertFrom-Json cmdlet, you can access the custom fields by their Name values.

$person_object = $person | ConvertFrom-Json

# Assign the person's favorite pizza to its own variable
$favorite_pizza = $person_object.custom.favoritePizza