Introduction

HelloID Provisioning gives you a robust set of fields to work with in regards to storing Person and Contract data from your source systems. 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 to Persons or Contracts.

Add a custom field to a Person or Contract

To get started, navigate to the Source Systems Overview.

1. Click on the wrench icon next to Custom Fields, as seen below.
   
2. On the next screen click on the plus sign button to add a new custom field.
   
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 prefixed 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.
      
   4. When you are finished adding custom fields, click Save to commit your changes.

Map source system 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 Contract tab. This will correspond to the Type of field that you added in previous steps.
3. Select your custom field using the Map additional field tool and select the Add button.
   
4. Map the value of the field accordingly, either as a Fixed, Field, or Complex value. Learn more about complex mappings here.
   
5. When you are finished mapping data onto your custom fields, select the Apply button. 
6. To apply these changes to your current Persons, manually create a new snapshot or perform a manual import.

If you are working with multiple similar source systems, learn how to clone mappings here.

View custom field data

After a system with custom fields has been imported, you can see each Person's custom fields in the Persons Overview. Once there, select a Person record. Custom fields are located under the Information tab. In the screenshot below, we can see that John Doe prefers pepperoni pizza.

Map custom fields onto target system users

The final step is to map your custom field from the Person object to users in the target system.

On-premises AD and Azure AD target systems

On the target system's Account tab, select the Configure button to edit its mappings:

Add a new attribute, in this case, Favorite Pizza. Select the Field mapping type and select Custom.favoritePizza in the drop down menu.

Select the Apply button to confirm.

PowerShell target systems

You can also 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