Link Handlers
Link Handlers are reusable lookup definitions that let a connector find related data in other systems or in Activate itself. They are often used by Change Handlers to resolve users, managers, roles, or tickets.
AD Link Handler
The AD Link Handler looks up Active Directory entries based on connector data.
Example
Attributes
Path | Required | Example | Description |
|---|---|---|---|
scope | Optional | =//Roles/System Roles/Users | Sets the AD search scope. Defaults to Global Catalog if not set. |
match | ✅ | (samAccountName=%=//Current/domainName%) | LDAP filter or field reference to use for lookup. |
when | Optional | employeeNumber | Expression or field name controlling when to run that match. |
Supported match formats
Format | Description |
|---|---|
(filter=...) | LDAP filter string searched in the current scope. |
DOMAIN\\user | Domain + username combination (bypasses scope). |
GUID | Direct GUID lookup in AD (bypasses scope). |
Role Link Handler
The Role Link Handler finds or creates Activate Roles based on connector fields. It’s the basis of most RoleChangeHandlers.
Example
Search Options
Path | Required | Example | Description |
|---|---|---|---|
root | ✅ | =//Roles/Departments | Root role where searches begin. |
key | ✅ | DepartmentCode | Field used to search roles (ID, Name, Path, or Parameter). |
field | ✅ | departmentCode | Field from connector data used as lookup value. |
rootKey | Optional | 12345 | Value in connector data considered the hierarchy root. |
Role Creation Options
Path | Required | Example | Description |
|---|---|---|---|
name | ✅ | =/department | Name for the role; used for creation and rename. |
parent | ✅ | parentCode | Parent role — may be field, handler name, or expression. |
description | Optional | =/department | Role description. |
parameters/* | Optional | <param name="DepartmentCode" ...> | Parameter values to set on created/updated roles. |
Service Desk Ticket Link Handler
The ServiceDeskTicketLinkHandler matches connector rows to Activate service desk tickets.
Example
Options
Path | Required | Example | Description |
|---|---|---|---|
field | ✅ | ticketNumber | Ticket field to check (ticketID, ticketNumber, JobID, or custom). |
regex | Optional | \\[Activate Job#(?'JobID'(\\d*))\\] | Regex for extracting IDs from text fields. |
Parent Role Resolution
Role parents can be set via:
- Handler reference — e.g., parent>region</parent> to chain multiple levels.
- Field reference — e.g., parent>parentCode</parent> for recursive structures.
- Expression — e.g., parent>=//Roles/Departments</parent> to fix a known parent role.