Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2025-05-16
Set Up Integration System for Custom Attributes in Peakon

Set Up Integration System for Custom Attributes in Peakon

  • Security: These domains in the
    Integration
     functional area:
    • Integration Build.
    • Integration Configure.
  • Administrator access in Peakon, if you need to create custom attributes.
You can specify field overrides for the integration system and create custom fields to map to existing Worker fields. Overrides enable you to transfer employee data specific to your organization.
  1. Create Integration System by selecting
    Core Connector: Worker
     from the
    New using Template
     prompt.
    The integration system will never launch or run.
  2. Configure Integration Attributes
    .
    1. As a related action on your integration, select
      Integration System
      Configure Integration Attributes
      .
    2. On the
      Version
       row, select the
      Add Row
       icon, and select the latest version number in the
      Value
       field.
      The choice of version number doesn't impact the integration, because it's a pull model integration.
  3. Attach the
    Integration System User
     to the integration system.
    1. From the related actions menu on the integration system, select
      Workday Account
      Edit
      .
    2. Enter the ISU as the
      Workday Account
       and click
      OK
      .
  4. Set up integration field overrides for the
    Integration System
    .
    1. As a related action on the connector, select
      Integration System
      Configure Integration Services
      .
    2. Add a row to the
      Custom Integration Services
       grid.
    3. Select an
      Integration Field Override Service
       from the
      Integration Service
       prompt.
    4. Name your new
      Integration Field Override Service
      . Then, select
      Worker
       as the
      Business Object
      .
    5. Add rows for each Peakon custom attribute that needs overriding, entering the name and description. Example:
      Nationality
       and
      The nationality of the worker
      .
      • The override name must be an exact case sensitive match to the name of the custom attribute in Peakon.
      • Peakon employee type attributes need an "employee:" prefix. Example: If the Peakon attribute name is
        HR Partner
        , the field override name in Workday must be
        employee:HR Partner
        . See Reference: Attribute Types to learn about Peakon attribute types.
      • You can use the override
        phoneNumber:Phone Number
         to override all existing phone settings and configure custom overrides for the Phone Number field. If the custom override fails to find a value, the sync resorts to standard mappings based on the phone number integration settings. If the custom override is set and returns a value, it ignores configuration settings.
  5. Configure Integration Field Overrides
     and test the ISU security access to the fields.
    1. As a related action on the connector, select
      Integration System
      Configure Integration Field Overrides
      .
    2. Scroll down to the
      Field Configuration
       grid for the
      Integration Field Override Service
      .
      The integration does not respect the standard field
      Eligibility Criterion
      .
    3. For each field, select a corresponding report field from the
      Override External Field
       prompt.
      Field types must match. Example: Number type fields in Workday must correspond to number type attributes in Peakon.
      For
      Employee
       type attributes (overrides prefixed with
      employee:
      ), select a
      Workday ID
       as the
      Field Detail
       value.
    4. To test user access to the report fields, select
      Integration Field Override
      Test Security
       as a related action on the integration system.
You can configure worker eligibility to control the employee records that should sync from Workday to Peakon by using the
PEAKON_INCLUDED
 feature in combination with a Workday calculated field. Example: Only sync workers who have successfully completed their probation period or exclude seasonal workers from the sync.
See Concept: Worker Eligibility for use cases and recommendations.
  1. In Peakon, go to
    Administrations
    Attributes
    .
  2. Click
    Add attribute
    .
  3. Name it
    PEAKON_INCLUDED
    . The uppercase is mandatory for the functionality to work.
  4. Set
    Attribute Type
     as
    Option
    .
  5. Click
    Save changes
    .
  6. In Workday, Create Integration System by selecting
    Core Connector: Worker
     from the
    New using Template
     prompt.
    If you’ve already done this step as part of the custom overrides setup, use the existing Integration System instead.
    Note: The integration system will never launch or run.
  7. Configure Integration Attributes
    .
    1. As a related action on your integration, select
      Integration System
      Configure Integration Attributes
      .
    2. On the
      Version
       row, select the
      Add Row
       icon, and select the latest version number in the
      Value
       field.
      The choice of version number doesn't impact the integration, because it's a pull model integration.
  8. Attach the
    Integration System User
     to the integration system.
    1. From the related actions menu on the integration system, select
      Workday Account
      Edit
      .
    2. Enter the ISU as the
      Workday Account
       and click
      OK
      .
  9. Set up integration field overrides for the
    Integration System
    .
    1. As a related action on the connector, select
      Integration System
      Configure Integration Services
      .
    2. Add a row to the
      Custom Integration Services
       grid.
    3. Select an
      Integration Field Override Service
       from the
      Integration Service
       prompt.
    4. Name your new
      Integration Field Override Service
      . Then, select
      Worker
       as the
      Business Object
      .
    5. Add a row for the
      PEAKON_INCLUDED
       custom attribute that you created in steps 1-5, and enter
      PEAKON_INCLUDED
       as its name.
  10. Configure Integration Field Overrides
     and test the ISU security access to the fields.
    1. As a related action on the connector, select
      Integration System
      Configure Integration Field Overrides
      .
    2. Scroll down to the
      Field Configuration
       grid for the
      Integration Field Override Service
      .
      The integration does not respect the standard field
      Eligibility Criterion
      .
    3. For the
      PEAKON_INCLUDED
       field, the field type should be a True/False condition.
    4. To test user access to the report fields, select
      Integration Field Override
      Test Security
       as a related action on the integration system.
  11. In Peakon, go to
    Administration
    Integrations
    Workday
    .
  12. Click
    Sync all
    .
Run Workday Reports as the Peakon Integration System User