Implementing and Managing Intelligent Services (Part 1)
Vasanth Kumar G S
SAP SuccessFactors Employee Central Core and Time Management Certified | SAP SuccessFactors EC & Time Off Consultant | IIMK Alumni
Intelligent Services simplifies the user experience for employees, managers, and business partners by integrating into a single experience the individual transactions in a multi-step HR process that cross the traditional boundaries of HCM applications and organizational departments. Intelligent Services links with external systems that allow seamless integration with third-party applications.
With Intelligent Services, changes publish as events such as Employee Hire, Change in Manager, Employee Time Off, and more. You can publish events from any SAP SuccessFactors application, and subscribe to these events using SAP SuccessFactors or third-party applications.
In summary, Intelligent Services:
What is an Event?
Events are changes that occur within the SAP SuccessFactors HXM Suite; such as change of manager, employee department, new hires, and terminations.
What is a Publisher?
A publisher is the SAP SuccessFactors application where job or employee changes are being initiated such as Employee Central, or SAP SuccessFactors Recruiting.
Publishers can trigger, or raise events whenever a job or employee change occurs.
What are Subscribers?
A subscriber can either be an SAP SuccessFactors or a third-party application to receive notifications for events.
Notifications:
Notifications are calls to action to individual users of the SAP SuccessFactors HXM Suite that are triggered by events or transactions in the system.
There are several different notification types, the most common of which are:
Intelligent Services Center:
The Intelligent Services Center enables you to easily set up and monitor Intelligent Services.
Publisher and subscriber activities are referred to as Flows. In general, you can only turn preconfigured activities on or off, but activities that run on the Intelligent Services Center framework can be configured using business rules and timing options.
You can configure, customize, and monitor Intelligent Services events that include:
Implementing Intelligent Services:
Enabling Intelligent Services and Retrieving SuccessStore Rules with Upgrade Center:
Import prepackaged Intelligent Services business rules using the Upgrade Center.
Prerequisites:
Procedure:
Note: There are no role-based permissions for Intelligent Services. However, there is required role-based permissions when using Intelligent Services Center.
Enabling Intelligent Services:
Enable Intelligent Services and download prepackaged Employee Central business rules from the SuccessStore, using the Upgrade Center.
Procedure:
Verifying Your SuccessStore Download:
You can verify your SuccessStore download using the Monitor Job tool.
Publishing for Intelligent Services:
Standard Event Framework:
Most Intelligent Services publishers use the Standard Event Framework, to publish events to SAP and outside of SAP.
Intelligent Services uses existing OData APIs to fetch additional information about the event and comprises records of the same type.
Some events only publish to other internal SAP SuccessFactors subscribers, or to external third-party applications, or both.
Service Event Bus:
The Service Event Bus Architecture allows the event message to flow from publisher to subscribers. The Service Event Bus utilizes OData database tables that contain connected entities that allow internal SAP SuccessFactors applications to receive notifications from publishers. This architecture framework allows external third-party applications to subscribe to Intelligent Services.
Most Intelligent Services events publish to subscribers using the Service Event Bus.
Business Rules:
Business Rules are used for most Intelligent Services events. Most Employee Central business rules packaged as part of SuccessStore.
There are two Employee Central events that require manual creation:
Reporting in Intelligent Services:
Employee Central customers can report on Intelligent Services events from a new reporting schema.
Intelligent Services is available in:
Creating a Rule from the New Hire Event in Employee Central:
Configure the rule for a New Hire event.
Procedure:
1.?Log into the application.
2.?Go to Admin Tools > Configure Business Rules.
3.?Create a new rule.
4.?Select the Basic Option.
5.?Fill the Rule details such as Rule Name and Rule ID.
6.?Select Base Object as Job Information.
7.?Click Save.
Configuring a Rule for the New Hire Event in Employee Central:
Configure the rule in Succession Data Model.
Prerequisites:
You have access to Provisioning.
Procedure:
1.?Log in to Provisioning.
2.?Go to the company and click Import/Export Data Model link.
3.?Select the export option and download the data model.
4.?Open the Data model search for the Job Info HRIS element.
5.?Configure the rule in job info HRIS element.
6.?After configuring the rule, select the import option and import the Data Model.
Note: Once the rule is created, user needs to do the new hire event either through UI or through imports to trigger the rule which will show up in reporting.
Creating a Cross Domain Report (CDR):
Create a CDR between Intelligent Services and Person and Employment Info sub-domain schema (SDS).
Procedure:
1.?Navigate to Analytics > Reports > Ad Hoc Reports.
2.?Click Create New Report.
3.?Select the Intelligent Services as the driving SDS.
For CDR between Intelligent Services and any SDS, Intelligent Services has to be the driving SDS.
4.?Fill out the details under General Info tab.
5.?Click Add Domain to add Person and Employment Info Domain.
6.?Fill out People tab.
7.?Click Intelligent Service Selector tab and select the Intelligent Service.
In this example, we have selected Hire as Intelligent Service.
8.?Select Columns for both SDS: Intelligent Service.
9.?Select Columns for both SDS: Person & Employment Info.
10.?Select Columns for both SDS.
11.?Select Filters to apply criteria to the report.
Filter from both the SDS (Intelligent Services and Person and Employment Info) to get the desired result.
12.?Define Relationship between the two SDS
a.?Select columns from both SDS which should be joined with one another.
b.?Select the join type.
13.?Preview the Report.
14.?Click Save.
15.?Run the Report.
a.?Click Run Report from drop down next to the report name in the report listing page.
b.?Select Run Online and click Generate Report.
External Event Notifications:
You can configure your external third-party application to subscribe to Intelligent Services events.
Some Intelligent Services events can publish externally to your third-party application, which you can configure as subscribers.
The Event Notification Subscription is used to configure your third-party subscriptions for Intelligent Services, and the Event Notification Audit Log to monitor your external notifications.
Event Architecture:
SAP SuccessFactors does the following:
You can use the Event Center to view and monitor events within SAP SuccessFactors HCM Suite.
You can use the Event Notification Subscription tool to configure subscriptions to events. Events are sent as SOAP messages to configure endpoints. The Event Notification Audit Log is used to monitor external notifications.
Adding an External Third-Party Subscriber:
Add an external third-party application as a subscriber so that you can subscribe it to an event.
Prerequisites:
Procedure:
Subscriber Configuration Fields:
Configuring Trust for Outbound Requests:
Use the Outbound Trust Manager page to establish trust for all outbound request servers.
The Outbound Trust Manager allows you to bypass the security check for HTTPS URL endpoint authentication, for third-party subscribers that use HTTPS URL such as Boomi.
Prerequisites:
You have Manage Integration Tools > Access to Outbound Trust Manager permission.
Procedure:
Configuring the Subscribers for a Specific Event:
Configure an external third-party application to receive a notification when a particular event occurs.
Prerequisites:
Procedure:
1.?Go to Admin Center > Event Notification Subscription > SEB External Event.
2.?Choose Add Topic and select the event you want the third-party application to subscribe to.
3.?Choose Add Subscription to begin configuring a subscription to the event.
4.?Configure the event notification subscription by completing all of the required fields.
a.?In the Subscriber field, select the third-party application you want to subscribe. You can select from the subscribers you have configured on the Subscribers tab.
b.?After you have chosen a subscriber, enter the Endpoint URL and Protocol settings.
c.?Choose Authentication settings.
You can select from the following Authentication options.
5.?Choose Save.
6.?If desired, you can take any of the optional steps:
a.?To add more subscribers to the same event, repeat steps 3 and 4.
b.?To add subscriptions to a different event, repeat steps 2 to 4.
c.?To edit an existing subscription, select the Edit button.
d.?To delete an existing subscription, select the Delete checkbox and select Save.
Fields in the SEB External Events Configuration:
Event Notification Audit Log:
You can use the Event Notification Audit Log tool to monitor the status of your external event notifications and view details about each notification.
To access the log, go to Admin Center > Event Notification Audit Log. You can view the status of each individual event notification, to verify that it was sent properly to the configured subscriber or to view event details to help you troubleshoot errors.
Viewing Payload Information in an Event Notification:
View payload details for the SOAP request and response in the Event Notification Audit Log.
Prerequisites:
Procedure:
Event Notification Audit Log Filtering Options:
Event Notification Audit Log Column Headers:
Retriggering a Failed Event Notification:
Retrigger a failed event notification to a third-party subscriber.
When an event that is configured for a third-party application fails, the system attempts to retrigger the event automatically once every three hours. When the system has retriggered the event at least 10 times, you see the Retrigger action in the Event Notification Audit Log so you can retrigger it manually as well.
Prerequisites:
Procedure:
1.?Go to Admin Center > Event Notification Audit Log.
2.?Find the event with FAILED status that you want to retrigger.
3.?Choose the Retrigger action.
API Information for Intelligent Services:
SOAP Request for Employee Hire Event:
All communications between the publishing application and third-party application will always have a response for HTTP requests. The code within the responses will indicate whether the request was successful or not. SOAP is an XML-based protocol that allows you to exchange information over a specific protocol (HTTP or SMTP) between applications.
Web Services Description Language (WSDL):
The Web Service Description Language or WSDL is hierarchical structured XML document that is used to describe the functionality offered by a web service. The WSDL file provides a machine-readable description includes: how the service is called, expected parameters and what data structure that the outbound call returns.
Event Structure and Payload for Employee Central:
What is an Entity?
Employee Central stores data in table structures, which are known as entities. Entities comprise of records of the same type. Employee Central entities let you create and manipulate employee data. Navigation in an entity represent associations between entities.
Each entity can have the following properties:
Employee Hire:
This event publishes when a new worker is created with a specified start date.
Employee Rehire:
This event publishes when a terminated or retired worker is rehired with a new specified start date.
First Time Manager:
The First Time Manager event publishes when a job information change for a worker who is assigned a new direct report that has never been a manager before the effective start date.
Change in Manager:
This event publishes after a job information change for an employee that is assigned a new manager.
Individual Contributor to Manager:
This event is publishes after a job information change for an individual contributor that is now a manager with direct reports.
Manager to Individual Contributor:
This event publishes when a manager becomes an individual contributor and no longer have direct reports after a specific effective start date.
Change in Employee Department:
This event publishes after a job information change for an employee that moved to a new department.
Change in Employee Location:
This event publishes after a job information change for a worker that moved to a new location.
Change in Employee Division:
This event publishes after a job information change for an employee that moved to a new division.
Change in Business Unit:
This event publishes after a job information change for an employee that moved to a new business unit.
Job Transfer:
The Job Transfer event publishes after an employee is transferred to a new job starting after a specified effective start date.
Change in Job Title:
This event publishes after a job information change for a worker that is being assigned a new job title.
Change in Job Classification:
This event publishes after a job information change for an employee moved to a new job classification.
Add Global Assignment:
This event publishes after a new global assignment created for an employee after the effective start date.
End Global Assignment:
This event publishes when a global assignment has ended for an employee.
领英推荐
Create Concurrent Employment:
This event publishes when an employee starts is assigned a new concurrent assignment after the effective date.
Start Probation:
This event publishes when an employee is put on probation after a specified date.
Employee Time Off:
This event publishes for an employee for any type of absence.
Employee Short Term Disability:
This event publishes when an absence is determined by the configured business rules to meet the criteria of a short-term disability.
Employee Long Term Disability:
This event publishes when an absence is determined by the configured business rules to meet the criteria of a long-term disability.
Expiration of Work Order:
This event publishes when a work order is going to expire for a contingent worker.
Employee Termination:
This event publishes when a notification of an employee termination.
Integrating DocuSign With SAP SuccessFactors Intelligent Services:
Integration of DocuSign with SAP SuccessFactors Intelligent Services allows you to trigger electronic signatures when an intelligent services event is raised in SAP SuccessFactors.
The DocuSign tool has an envelope that sends parameters to generate a document using the document template to initiate e-Signature. The envelope also contains information about the sender, security, authentication information, and more.
After documents are signed electronically:
The DocuSign integration is supported for the following events: Change in Name, New Work Order and Employment Termination.
Configuring DocuSign Account in SAP SuccessFactors:
Adding DocuSign account in SAP SuccessFactors to integrate with the DocuSign tool and allow users to sign their documents electronically.
Prerequisites:
Procedure:
Setting Up Integration for DocuSign With SAP SuccessFactors Intelligent Services:
You want to configure and integrate DocuSign with SAP SuccessFactors Intelligent Services, which facilitates electronic exchange of contracts and signed documents.
Prerequisites:
To configure and integrate DocuSign with SAP SuccessFactors Intelligent Services, you must have established the following prerequisites in your system:
Procedure:
Configuring Events in Intelligent Service Center:
Intelligent Service Center publishes information that includes which SAP SuccessFactors application published the event, event description, and the event publishing rule. Here, you must configure the action when the event is fired. This action is defined at the event level in Intelligent Service Center.
Procedure:
This page lists the available events.
Business Scenario: DocusignEnvelope Status Update:
The DocusignEnvelope Status Update business scenario is a preconfigured template that captures the DocuSign Envelope Status details in the SAP SuccessFactors EmpJob entity once the documents are signed and completed by the recipient. The status details are captured when events are triggered in the Intelligent Services Center, when a user electronically signs a document or a set of documents. The signed documents are saved in the Document Management Repository.
The Business Scenario is supported for the following events: Change in Name, New Work Order and Employment Termination.
Activate the Business Scenario in Admin Center > Business Scenarios. On activation, you are redirected to Integration Center, to configure your integration. Configuring this integration allows you to set up your required field transformation and necessary filters that can help you generate a customized output.
Once you save your configuration, complete your setup in Intelligent Services Center by adding the configured integration to the event flow.
Setting Up the DocuSign Envelope Status Update Business Scenario:
Enable and configure the DocuSignEnvelope Status Update business scenario to monitor the status of Docusign envelopes for the SAP SuccessFactors EmpJob entity.
Prerequisites:
Procedure:
1.?Go to Admin Center > Business Scenario.
2.?Find DocuSignEnvelope Status Update and move the slider to On in the Active column to activate the business scenario.
3.?Click OK on the Confirm dialog.
You are redirected to the Integration Center's Options tab that displays prepopulated integration information.
4.?Click Next.
You are in the Configure Fields tab. In this tab, you can view and edit the layout and field transformations.
5.?Select the Field Mapping View icon to edit field transformations.
6.?Click Next in the Configure Fields tab.
You are in the Filter tab. This tab allows you to add a filter to your source fields.
7.?Click Next in the Filter tab.
You are in the Review and Run tab. In this tab, you can view the configuration summary.
8.?Click Save to save your configuration.
9.?Optional: Click Go to ISC.
You are redirected to the Intelligent Services Center landing page. You will find the DocuSignEnvelope Status Update listed under All Events.
Next Steps:
Using Intelligent Services Center:
Use Intelligent Services Center to manage events and subscriber activities for Intelligent Services.
Enabling Intelligent Services Center:
Enable Intelligent Services Center so that you can use it to configure Intelligent Services events and subscribers.
Intelligent Services Center is the latest administration tool for configuring Intelligent Services. When you enable it, it replaces the legacy Event Center tool.
Prerequisites:
Procedure:
Refreshing OData API Metadata:
After enabling Intelligent Services Center, refresh the OData API metadata.
Prerequisites:
You have the Manage Integration Tools > Access to OData API Metadata Refresh and Export permission.
Procedure:
1.?Go to Admin Center > OData API Metadata Refresh and Export.
2.?Choose Refresh.
The refresh may take a few minutes. Wait until you see a success message, along with a date and timestamp.
Viewing a List of Intelligent Services Events:
Use Intelligent Services Center to view a list of Intelligent Services events in the system.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center.
2.?Review information about each event.
For each event, you can see:
3.?To change the period for which total events raised are calculated, use the menu to select 1 day, 7 days, or 15 days.
4.?To change the sort order of the list, use the Sort By option.
5.?To search for a specific event, use the search box.
6.?To see more information or configure activities and rules, choose the name of the event and open the Event Details page.
Viewing Details About an Event:
Use Intelligent Services Center to view details about a specific event, including publishing rules, event monitoring data, and its associated flows and activities.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center and choose the event you want to see details about.
2.?For events that are triggered by configurable business rules, go to the Publishing Rule tab to see the name of the rule. Choose the name or ?(Details View) to see details.
3.?Go to the Event Monitoring tab to see details about events, subscribers, and integration activities during a specific time range.
4.?Go to a Flows tab to see details about the flow and its associated activities.
A "flow" is a collection of subscriber activities that are triggered by an event. You can create multiple flows for each event and use flow rules to determine when each flow is triggered.
5.?To view details about a different event, use the Select Event menu at the top of the page.
Viewing Subscriber Activities for an Event:
Use Intelligent Services Center to view the subscriber activities that are associated with a specific event.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center and choose the event whose activities you want to see.
2.?Select one of the Flows tabs to view subscriber activities in that flow.
A "flow" is a collection of subscriber activities that are triggered by an event. You can create multiple flows for each event and use flow rules to determine when each flow is triggered.
3.??????Review the list of activities that are currently included in the flow, sorted by timing or subscriber name.
4.??????Review all of the available activities that can be included in the flow, sorted by type.
Configuring a Connection to a Third-Party Subscriber:
Use an Event Connector to configure a connection to a third-party subscriber using endpoint URLs.
Event notifications are sent out as a SOAP request message to a specified endpoint. An API callback can be done to get the details of the event using the metadata contained in the object. Event Connectors belong to an event and are applicable to flows associated with the event.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center and choose the event whose activities you want to see.
2.?Select one of the Flows tabs.
3.?Choose the Event Connector activity.
4.?Select one of the available Event Connectors or choose to create a new one.
5.?Configure Connector Options, including name, description, endpoint URL, external event alerts, and icon image.
6.?Choose Authentication settings.
You can select from the following Authentication options.
7.?Choose Add to save the connector.
Integrating Intelligent Services with Integration Center:
Intelligent Services in SAP SuccessFactors provide suite-wide events that occur within the SAP SuccessFactors HXM Suite. When an event occurs in one part of suite, other areas are made aware of it and can react accordingly.
Intelligent Services is now integrated with Integration Center, as Intelligent Services Center. The Intelligent Services Center will enable you to model the business processes for the Intelligent Services events within SAP SuccessFactors and other business applications.
If there is a change in event in Employee Central, the Intelligent Services Center integration is triggered.
The change in event could be any of the following types:
The Intelligent Services Center tool offers seamless integration.
When this integration is triggered, a file is generated. This file will contain information of those employees for which an event was triggered in Employee Central, which means that the file will not contain all data, rather it will contain data of employees for which the change event was triggered. SAP also support REST output for Intelligent Services based integration.
Accessing Intelligent Services Center
You can access the Intelligent Services Center tool from the Admin Center. If Intelligent Services Center is not configured, you must contact Product Support.
Using Intelligent Services Center for Integrations:
After an integration is created, it is linked to an event in the Integration Center and is added as a configurable action. You can define a rule and timing options. When the event is triggered, the integration is called automatically. SAP SuccessFactors Integration Center supports REST and SFTP File Transfer.
Using Integration Tab:
There are two options available when you use Integrations tab in Intelligent Services Center:
a.?My Integrations
b.?Create New Integrations
Note: If no integrations have been created for a specific event, an alert appears that state: There is no integration defined for this event, please create a new integration.
Selecting an Existing Integration in Intelligent Services Center:
You can set up an already existing integration for your event, from the Intelligent Services Center Integration tab.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center.
2.?Go to Activities > Custom Activities > Integration.
The Select Integration dialog box opens that contains a list of integrations under the My Integrations tab.
3.?Select the Integration package you want to use from the My Integrations tab.
4.?Select Add Integration to finish.
Creating a New Integration in Intelligent Services Center:
You can create new integrations from Intelligent Services Center that links with Integration Center.
Prerequisites:
You have the Intelligent Services Tools > Intelligent Services Center (ISC) permission.
Procedure:
1.?Go to Admin Center > Intelligent Services Center.
2.?Go to Activities > Custom Activities > Integration.
3.?Select OK until the alert dialog box disappears.
You now see the Select Integration dialog box.
4.?Select Create Integration.
The Choose Integration Type dialog box opens.
5.?Go to Destination Type to select any of the two destination types:
6.?Go to Format to select the format you want.
7.?Select Create.
You're now in the Integration Center view.
8.?Configure the following in each tab:
9.?Select Next until you reach the Review and Run page.
10.?Select Save button to save your Intelligent Services integration.
When you save your Intelligent Services, the Success dialog box appears.
11.?To finish, you can do either of the following:
Note: There's a difference in number of records processed for bulk events and for standard events. For bulk events, multiple records can be processed, but standard events, only one record is processed.
Creating a New Flow for Intelligent Services:
Create a new flow for an Intelligent Services event so that you can use flow rules to trigger different subscriber activities in different scenarios.
A "flow" is a collection of subscriber activities that are triggered by an event. You can create multiple flows for each event and use flow rules to determine when each flow is triggered. It isn't necessary to create multiple flows. Every Intelligent Services event has one flow by default and many customers find that is enough.
Prerequisites:
Procedure:
1.?Go to Admin Center > Intelligent Services Center and choose the event you want to create a flow for.
2.?Create a new flow in one of two ways.
By default, the name of the new flow is numbered based on the existing flows.
3.?Edit the name of the new flow, if you want to.
4.?Open the ?Actions menu at the top of the page and choose Save Flow.
Creating a Flow Rule for Intelligent Services:
Create a flow rule to determine when a flow that's associated with an Intelligent Services event is triggered.
You can define business rules that determine when a flow is triggered. When the If condition in a flow role is true, all activities in the flow are triggered.
Prerequisites:
Procedure:
1.?Go to Admin Center > Intelligent Services Center.
2.?Select the event you want to create a flow rule for.
3.?Choose how you want to create the rule.
4.?If you chose New Rule or Copy of Existing Rule, configure the rule. Otherwise, skip this step.
a.??????Edit Business Information and enter the following information.
b.?Configure the If statement of the rule.
c.?Save the rule.
5.?Go to Actions > Save Flow to save all changes to the flow.
Tracking Errors and Viewing Execution Details:
Find and troubleshoot errors or confirm the successful execution of Intelligent Services events, subscriber activities, and third-party integrations during the last 180 days.
Prerequisites:
You have the following permissions:
Procedure:
1.?Go to Admin Center > Intelligent Services Center and choose the event you want to monitor.
2.?Go to the Event Monitoring tab.
3.?Review the graph of Events Raised, showing how many times the event occurred daily, during a specified time range.
4.?Review the table below the graph, showing each specific occurrence of the event.
You can see:
5.??If there are many events listed, filter the table to find the one you're interested in.
6.?To view information about each subscriber activity for a specific occurrence, select an event in the table.
A popup displays information about subscriber activities triggered by the event.
You can see:
7.?For activities with an external third-party subscriber, you can view more details. Choose ?(more actions) and then Show Details to go to the Execution Manager page and view more payload details or download an event log.
You can see:
Retrying a Failed Third-Party Subscriber Activity:
If you find subscriber activity that failed to execute in an external, third-party subscriber, you can retry it.
Prerequisites:
You have the following permissions:
Procedure: