Skip to main content

HelloID

Target mappings
Target_Systems_AD_Fields_UI.png

Mappings in PowerShell v2 target systems connect fields in your persons to fields in target user accounts, such as the sAMAccountName, userPrincipalName, and cn. Target mappings are applied during enforcement.

To get started, Map fields.

The main differences in mappings in PowerShell v1 systems vs. PowerShell v2 systems are:

  • A graphical interface, instead of PowerShell scripting

  • Ability to map the same field differently per account lifecycle stage. For example, if you want to enter a department name as the account description in most cases, but "Disabled by HelloID" when it's disabled.

Table 1. Fields tab

#

Name

Description

1

Search Fields

Filter the grid based on mapping Names.

2

filter.png Filter

Filter the grid based on account lifecycle stage and/or status of Use In Notifications and Store In Account Data toggles.

3

refresh.png Refresh

Refresh the grid.

4

Import mapping

Import previous saved mapping

5

Export mapping

Export mapping to import it at another target system like Active Directory or PowershellV2 for ease of setup

6

Delete all

Delete all mapped fields (WARNING: use with extreme caution). After deleting all fields, click Default Fields to restore default mappings.

7

Add Field

Add a new mapped field.

8

Preview

Update the Preview Value column, using the currently selected person and lifecycle stage. (Before previewing, you must select a person in gear_settings.png Settings.)

9

gear_settings.png Settings

Select a person and lifecycle stage to preview mappings for (after selecting these, click the Preview button).

10

Name column

The name of the mapped field.

11

Configured Actions column

The lifecycle stages that the mapping is active for:

12

Options column

  • Icon_Email.png: Use In Notifications toggle is enabled.

  • 2023-11-07_14-46-21.png: Store In Account Data toggle is enabled.

13

Preview Value column

The current value of the mapped field.

14

wrench.png Edit

Edit the mapped field (see "Individual mappings", below).

15

Number of fields

The total number of mapped fields.



Target_Systems_PS2_Fields_ConfigureFields_UI.png
Table 2. Individual mappings

#

Name

Description

1

trashcan_delete.png Delete

Delete this mapped field.

2

x_close.png Close

Stop editing this mapped field and return to the grid. Any changes you made are automatically saved.

3

Name

The name of this mapped field.

4

Type

The type of this mapped field:

  • Text: A string.

  • Array: An array of strings.

5

Description

An optional description of this mapped field, for internal (admin) reference only.

6

plus_add.png Add

Add a new configuration to this mapped field. Configurations let you vary a field's mapping depending on the account lifecycle stage (using the Actions checkboxes).

7

Actions

Specify which account lifecycle stage(s) the current configuration should be active for. Each stage can only be used in a single configuration.

8

trashcan_delete.png Delete

Delete this configuration.

9

Use In Notifications

Make this mapped field available to use as a condition in Notifications (including conditional notifications).

10

Store In Account Data

See Share account fields between target systems. (Replaces ExportData in PowerShell v1.)

11

Mapping type

  • Fixed: A constant string value (specified by you). All accounts in this target system will receive the same fixed value for this field.

  • Field: A direct mapping of a field from the Person schema, without any further transformations applied.

  • Complex: A string built in JavaScript. See Complex mappings.

  • None: The field's value is not set in the field configuration. Instead, it must be filled with the actual value of a property in the target system, in an account script. Depending on the field configuration, it can then be used in notifications and/or stored in the account data. This is sometimes needed in conditional notifications.

    Fields with mapping type None are not included in $actionContext.Data.

12

Person field

The field from the Person schema that will be used as the basis for this mapped field.



Field types

Each mapped field must be one of the following Types:

  • Text (string)

  • Array (array of strings) — only compatible with Complex mappings). The maximum size of an array is approximately 25,000 characters total. Array-type fields are not currently supported in conditional notifications. Array-type fields become ArrayLists in PowerShell, which means you can't use the Add method. Instead, use the += operator to add items to an array. For example: $outputContext.Data.ProxyAddresses += "test".

Field names cannot begin with a number. All field names are case-insensitive. Any non-string data assigned to a field will be converted into a string. There is no limit to the number of fields you can create.

Note

You can make any field a property of an object instead of a standalone string or array, by using a dot in its Name (.). For example, Department.Code. Then, in your PowerShell scripts, Code will be a property of a PSObject named Department.

Limitations include:

  • An object cannot have the same name as a standalone field

  • Nested objects are not supported

  • Arrays of objects are not supported

In this section: