Configure the HCM Unified Alerts Metadata Release

HCM Unified Alerts Metadata Release

This topic describes how to configure this integration.

This integration pack imports alerts and notifications from Dimensions HCM so that these notifications are available in the Control Center.

Before you start

HCM Unified Alerts Metadata Release
  1. Deploy the Dimensions HCM Unified Alerts Metadata Release integration pack; see Deploy Integration Packs to your Atom.
  2. In order for the HCM Unified Alerts integration to function it must be enabled in HCM. On Company Information in HCM, Unified Alerts must be selected; see the Unified HCM Integrations Feature Configuration Guide for more information.

Configure the integration

How to configure this integration.

Select the environment

How to select the environment for the integration.

  1. Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

    Note: If prompted, enter your Username and Password. Click Tap Log in.
  2. Select the Manage tab > Atom Management.
  3. Select your environment.

Select environment extensions

HCM Unified Alerts Metadata Release
  1. In Administration, click tap Environment Extensions.
  2. In Process Filter, click tap the magnifying glass
    Search button
    .
  3. Scroll to and select the integration pack: Dimensions HCM Unified Alerts Metadata Release > _hcm.unifiedalerts.metadata.discovery.

Configure connection settings

HCM Unified Alerts Metadata Release
  1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure:

    Connection Settings

    Connection Settings for the HCM Unified Alerts Metadata Release

    Setting

    Required

    Actions

    APIGatewayServer

    Required

    To change the default API gateway server:

    1. Clear Use Default.
    2. Enter the URL to the server.

      Example: <tenantURL>/api

    SFTPServer

    Required

    The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.

    To change the default SFTP server parameters:

    1. For each field, clear Use Default.
    2. Enter the following values:

      • Enter the name of the internal Host.

      • Enter the number of the Port for the internal SFTP account.

      • In User, enter the username for the internal SFTP account.

      • In Password, select <Encrypted>. Enter the new password for the internal SFTP account.

      • Click Tap Apply.

    APIGatewayServer

    Required
    1. Clear Use Default.
    2. In URL, enter the URL or API.

    HCMAuthenticationServer

    Required
    1. Clear Use Default.
    2. In URL, enter the URL for the HCM server.

Configure process properties

HCM Unified Alerts Metadata Release
  1. Select Process Properties.
  2. Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

    Only while you test or design integration templates, should you edit the properties to connect to the authentication server and get the access token to execute APIs.

    1. From the Process Property dropdown list, select AuthenticationProperties.
    2. In GatewayDefaultPort, clear Use Default. Enter the path to the port for the API gateway.
    3. Note: You no longer need an AppKey to call API operations. If one is defined, it is ignored.
  3. From the Process Property dropdown list, select _hcm.unifiedalerts.metadata_External_HCMAuthenticationProperties to set process properties that must be configured before the integration can run. Clear Use Default? for each of the fields.

    Process Properties

    Process Properties for the HCM Unified Alerts Metadata Release

    Property

    Required

    Actions

    HCM REST username

    Required

    Enter the REST username.

    password

    Required

    Enter the REST user's password.

    HCM Company Short Name

    Required

    Enter the HCM Tenant Short Name.

    HCM Company ID

    Required

    Enter the HCM Tenant ID.

    HCM Company API Key

    Required

    Enter the HCM Company API Key.

    Note: The system event which executes the integration is scheduled to run at UTC 12:10 am and then again every 12 hours.

Update Control Center Profiles

Control center profiles define what notification categories are included on the Control Center page.

  1. Main Menu Administration > Application Setup > Control Center Setup > Control Center Profile.
  2. Select a control center profile and click Edit.
  3. Select the following categories to include in the profile:
    1. HCM Notifications
    2. HCM todos
      Note: Included categories are indicated by a check mark .
  4. Click Save.

Update Notification Profiles

Notification Profiles define what kind of notifications a user receives based on the notification's priority level.

Note: All notifications imported from HCM are automatically assigned a low priority. The priority level can be changed on the control center mapping page. See the Control Center Notification Mapping topic.
  1. Main Menu Administration > Application Setup > System Configuration > Notification Profile.
  2. Select a notification profile and click Edit
  3. For the Low Priority level, move the E-mail and Control Center destinations to the Selected column.
  4. Click Save.