SuccessFactors Spoke
The SuccessFactors spoke is built by Bristlecone, Inc. Manage data and entities in SuccessFactors from your ServiceNow instance.
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes. Starting on March 1st 2022, all SAP spokes will be available only on the Store.
IntegrationHub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
SuccessFactors spoke v4.11.0 is the latest version.
Supported versions
This spoke was built for SuccessFactors v2.0, but may be compatible with later versions.
Spoke dependencies
If you’re having trouble installing the app, ensure that these dependent plugins are installed:
- Complex Object (com.glide.cobject)
- ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
- ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
- ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
- ServiceNow IntegrationHub Action Step - SOAP (com.glide.hub.action_step.soap)
- ServiceNow IntegrationHub Action Template - Data Stream (com.glide.hub.action_type.datastream)
- ServiceNow IntegrationHub Action Step - XML Parser (com.glide.hub.action_step.xmlparser)
- ServiceNow Flow Designer - Dynamic Outputs (com.glide.hub.dynamic_outputs)
- Remote Tables (com.glide.script.vtable)
Note: Some of these plugins are licensable features and require an appropriate license if used outside the spoke implementation. For information on licenses, contact your account manager.
Spoke flows
The SuccessFactors spoke provides sample flows in the draft state to demonstrate automating the SuccessFactors tasks. To customize a sample flow, copy it to a new application scope. Available sample flows include:
| Flow | Description |
|---|---|
| Create Todo | Creates a to-do record in SuccessFactors. |
| Update Todo | Updates details of the specified to-do record in SuccessFactors. |
| Run SuccessFactors Integration Flow | Retrieves entire data or only updates made after the last refresh, for the selected entities, from SuccessFactors to your ServiceNow instance. By default, you can retrieves data from these entities in SuccessFactors:- Department - Location - Job Profile - Workers Profile - Effective Workers Profile - Job History Including Secondary Assignments - Todo |
Note: The Create Todo and Update Todo flows demonstrate the to-do record management when events occur in ServiceNow. You can customize these flows according to your requirement to manage records of other entities from your ServiceNow instance.
Spoke subflows
The SuccessFactors spoke provides sample subflows in the draft state to demonstrate automating the SuccessFactors tasks. To customize a sample subflow, copy the sample subflow to a new application scope. Available sample subflows include:
| Subflow | Description |
|---|---|
| Look up Departments | Retrieves the department data from SuccessFactors and stores it in SuccessFactors Departments Staging Table. |
| Retrieve Effective Worker Profiles | Retrieves the Effective Worker Profiles data from SuccessFactors and stores it in SuccessFactors Worker Profiles Staging Table. |
| Retrieve Full Job History Including Secondary Assignments | Retrieves all primary and secondary job history data from SuccessFactors. |
| Retrieve Job Profiles | Retrieves the job profile data from SuccessFactors and stores it in SuccessFactors Job Profile Staging Table. |
| Retrieve Locations | Retrieves the location data from SuccessFactors and stores it in SuccessFactors Locations Staging Table. |
| Retrieve Todos | Retrieves the to-do data from SuccessFactors and stores it in SuccessFactors Inbound Todos Staging Table. |
| Retrieve Worker Profiles | Retrieves the Worker Profiles data from SuccessFactors and stores it in SuccessFactors Worker Profiles Staging Table. |
| Run SuccessFactors Service | Retrieves entire data or only updates made from the last successful runtime, for the selected entities. |
| Process SuccessFactors Webhooks | Processes the SAP SuccessFactors webhook event. For more information about setting up the webhooks, see Set up webhook for the SuccessFactors spoke. |
| Retrieve Worker Profile by Company Territory Code | Retrieves the data of worker profile from SAP SuccessFactors based on company territory code, and stores it in the 'SuccessFactors Worker Profiles Staging Table'.Note: Worker profiles without employment or job information will not be retrieved, as the subflow fetches data based on the company territory code, which is assigned only after employment is assigned to the worker. |
Spoke actions
The SuccessFactors spoke provides sample actions in the draft state to demonstrate automating the SuccessFactors tasks when events occur in ServiceNow. To customize a sample action, copy it to a new application scope. Available sample actions include:
Note:
- To help prevent unauthorized users from accessing the sensitive data, the hasRole functionality has been implemented for the sensitive actions of the SuccessFactors spoke. As a result, users without the System Administrator role won’t be able to run successfully the actions if they don't have the SuccessFactors Spoke Admin role. This rule is applicable from SuccessFactors spoke v3.1.5 and v4.0.3 of the spoke respectively. For more information, see the SuccessFactors Spoke hasRole fix details knowledge base article on NOW Support.
- To help prevent unauthorized users from generating reports for SuccessFactors spoke tables, report_view ACLs are incorporated with the spoke admin role. Thus, you must have the SuccessFactors Spoke’s Admin role to generate a report.
| Category | Action | Description |
|---|---|---|
| Employee Management | Employee Address Information | Retrieves the address information of the specified employee. |
| Employee Annual Compensation | Retrieves the annual compensation details of the specified employee. | |
| Employee Compensation Details | Retrieves compensation details of the specified employee. | |
| Employee Documents | Retrieves all the viewable documents of the specified employee. | |
| Employee Payment Method Details | Retrieves the details about payment method of the specified employee. | |
| Employee Time Off | Retrieves the time offs taken by the specified employee. | |
| Employee Time Off Balances | Retrieves the time off-balance details of the specified employee. | |
| My TimeCard Details | Retrieves the time sheet details of the specified employee. | |
| Change User Roles | Adds user to the given permission group. | |
| Employee All Payment Methods Details | Retrieves details of all the payment methods of the specified employee. | |
| Employee Recurring Compensations | Manages the recurring component of a specified employee's compensation. | |
| Get Employee Benefit Enrollments | Retrieves details of the benefit enrollments of the specified employee during a specific time period. | |
| Offboard an Employee | Triggers the termination process of the specified employee. | |
| Org Change | Changes the organization related information of the specified employee. | |
| Report No Shows | Reports no show for the specified employee. | |
| Reporting Structure | Retrieves the reporting structure of the specified employee. | |
| Request Time Off | Applies a time off request for the specified employee. | |
| Update Employee Address | Updates the address of the specified employee. | |
| Update Employee DOB | Updates the date of birth of the specified employee. | |
| Update Employee Email | Updates the details of the email of the specified employee. | |
| Update Employee Phone | Updates the phone details of the specified employee. | |
| Update Employee Personal Information | Updates the personal information of the specified employee. | |
| Update Employee Personal Information - Global | Updates the global information of the specified employee. | |
| Update Employee Start Dates | Updates the start date of employment of the specified employee. | |
| HR Foundational Data | Login into SuccessFactors | Logs in to SuccessFactors and retrieves the Session ID. |
| Retrieve Current Employment Information | Retrieves the current employment information from SuccessFactors. | |
| Look up Departments | Retrieves the department data from SuccessFactors. | |
| Look up Addresses Stream | Retrieves address information from SuccessFactors. | |
| Look up Emails Stream | Retrieves emails information. | |
| Look up Person Biographical Stream | Retrieves person biographical information. | |
| Look up Personal Detailed Information Stream | Retrieves personal detailed information. | |
| Look up Employment Information Stream | Retrieves the employment information from SuccessFactors. | |
| Look up Phone Stream | Retrieves phone information from SuccessFactors. | |
| Look up Employee Global Assignments Stream | Retrieves all global assignment details from SAP SuccessFactors. | |
| Look up Secondary Assignments Stream | Retrieves all secondary assignments from SAP SuccessFactors. | |
| Retrieve Full Job History Including Secondary Assignments | Retrieves the complete job history data including secondary assignments from SuccessFactors. | |
| Retrieve Effective Worker IDs | Retrieves the effective Worker Profiles ID from SuccessFactors. | |
| Retrieve Profiles by Person ID | Retrieves the Worker Profiles data by Person ID from SuccessFactors. | |
| Retrieve Effective Worker Profiles | Retrieves the Effective Worker Profiles data from SuccessFactors. | |
| Retrieve Job History Including Secondary Assignments \(Deprecated\) | Retrieves the job history data including secondary assignments from SuccessFactors. | |
| Retrieve Job Profiles | Retrieves the job profile data from SuccessFactors. | |
| Retrieve Locations | Retrieves the location data from SuccessFactors. | |
| Retrieve Worker Profiles | Retrieves the Worker Profiles data from SuccessFactors. | |
| Get Holiday Calendar | Retrieves holiday calendar for a country. | |
Metadata RetrievalNote: To execute the creatable, deletable, updatable, and list metadata actions, create a system property with Name as com.glide.attachment.max_get_size in the Global scope and set its Value to 20000000. | Get Dynamic Output Fields | Creates a dynamic output structure for mapping of fields in response for the given entity. |
| Get Entities - Creatable | Retrieves the entities for which the create operation is supported. | |
| Get Entities - Deletable | Retrieves the entities for which the delete operation is supported. | |
| Get Entities - Updatable | Retrieves entities for which the update operation is supported. | |
| Get Entities List | Retrieves the list of all entities. | |
| Get Fields - Creatable | Retrieves all the creatable non-navigation properties in an entity. | |
| Get Fields - Updatable | Retrieves all the updatable non-navigation fields in an entity. | |
| Get Key Fields | Retrieves all the key fields in the specified entity. | |
| Get Required Fields - Creatable | Retrieves all the required insertable fields in the specified entity. | |
| Get Updatable Todo Fields | Retrieves the list of updatable fields in the Outbound Todos Staging Table. | |
| Get Available Positions | Retrieves all the available positions for given company and location code. | |
| Get Business Units | Retrieves all the available business units in SuccessFactors. | |
| Get Companies | Retrieves all the available active companies in SuccessFactors. | |
| Get Countries | Retrieves all the available countries in SuccessFactors. | |
| Get Country Code | Retrieves country code of a country. | |
| Get Dynamic Permission Groups | Retrieves all the available dynamic permission groups. | |
| Get Event Reasons By Event ID | Retrieves all the event reasons for the specified Event ID. | |
| Get Global Information By Entity | Retrieves metadata of the entity specified to fetch the global information. | |
| Get Global Personal Information Supported Countries | Retrieves details of the countries that support the creation and modification of the personal global information. | |
| Get Locations By Company Code | Retrieves all the active locations from SuccessFactors for the specified company code. | |
| Get People Pools By Group ID | Retrieves all people pools with only user name category for the specified group. | |
| Get Pick List Options | Retrieves all the available pick list options for the specified pick list ID. | |
| Get Pick List Options By Country | Retrieves the pick list options of the specified country. | |
| Get Recurring Pay Components Defined for Employee | Retrieves recurring pay components and relevant information for the specified employee. | |
| Get Required Fields - Creatable | Retrieves all the required insertable fields in the specified entity. | |
| Get Time Types By User ID | Retrieves all the available time types of the specified employee in SAP SuccessFactors. | |
| Get Updatable Todo Fields | Retrieves the list of updatable fields in the SuccessFactors Outbound Todos Staging table. | |
| Look up Company Territory Code | Retrieves all available company territory codes from SAP SuccessFactors. | |
| Record Management | Create Record | Creates a record in SuccessFactors.Note: The Create Record action displays non-navigable fields only in the creatable fields list. |
| Delete Record | Deletes the specified record in SuccessFactors. | |
| Execute Entity By URL | Takes navigation URL as input and provides the response for that navigation URL. | |
| Get Record | Retrieves the record for the selected entity and for the given key fields. | |
| Update Record | Updates details of the specified record. | |
| Todos | Create Todo | Create a to-do record in SuccessFactors. |
| Get Todo By ID | Get details of a to-do from SuccessFactors. | |
| Retrieve Todos | Retrieves the to-do data from SuccessFactors, except those with Category ID as 57. | |
| Update Todo | Updates details of the specified to-do record. | |
| User Management | Look up User Activity | Retrieves the last activity time of your SAP SuccessFactors users. |
| Look up User Activity SFTP | Retrieves the last activity time of your SAP SuccessFactors users by fetching the report published on an SSH File Transfer Protocol \(SFTP\) location. | |
| Look up Users | Retrieves the list of SAP SuccessFactors users. | |
| Look up User by User ID | Retrieves the worker details of the SuccessFactors user. | |
| Look up User Personal Details | Retrieves user personal details of the specified employee. | |
| Suspend User | Suspends a user account. | |
| Utility Category | Call A SuccessFactors Subflow | Executes the specified SuccessFactors spoke subflow synchronously. |
| Call Run SuccessFactors Service Subflow | Executes the Run SuccessFactors Service subflow asynchronously. | |
| Check Flow Status | Checks if the context of flow is running. | |
| Get Last Run Date | Retrieves the last run date and time of the flow. | |
| Update Record In Outbound Todos Staging Table | Updates details of the specified to-do record in SuccessFactors Outbound Todos Staging Table.Note: Only an admin user can run this action. | |
| Goal Management | Look up Goals by User ID | Retrieves goals information from SuccessFactors for the specified user ID.Note: Only an admin user can run this action. |
| Payroll Management | Look up Employee Payrolls | Retrieves payroll details of the specified employee. |
| Skill Management | Create or Update Skill Profile | Creates or updates skill profile and profile skill mappings for a particular employee. |
| Look up Employee Skills Stream | Retrieves the skill information of required employee. | |
| Look up Skills Stream | Retrieves the skill information. | |
| Job Management | Look up Attachment by ID | Retrieves attachment content and stores it in the SuccessFactors Attachments data source for the specified attachment ID.To access the attachments, navigate to All > System Import Sets > Administration > Data Sources and open the record SuccessFactors Attachments. The required files are attached to this data source record. Note: Only an admin user can run this action. |
| Look up Candidate by ID | Retrieves candidate information from SuccessFactors for the specified candidate ID.Note: Only an admin user can run this action. | |
| Look up Job Applications Stream | Retrieves job application information from SuccessFactors.Note: Only an admin user can run this action. | |
| Look up Job Codes Stream | Retrieves job level, employment type, and job type information from SuccessFactors.Note: Only an admin user can run this action. | |
| Look up Job Requisition by ID | Retrieves job requisition details for the specified requisition ID.Note:
| |
| Look up Job Requisition Postings Stream | Retrieves job posting information from SuccessFactors.Note: Only an admin user can run this action. | |
| Look up Employee Jobs Stream | Retrieves All Employee Jobs information from SuccessFactors. | |
| Look up Job Profiles Stream | Retrieves job profiles information from SuccessFactors. |
Note: If a spoke action requires date or time as an input, ensure that you provide the value in GMT time zone only.
Available AI agents
Install Now Assist for Integration Hub and start using the available AI agents. For more information, see ServiceNow Otto for Integration Hub.
This spoke provides standalone AI agents that mimic human-like intelligence to perform tasks in your ServiceNow instance.
In the ServiceNow agentic system, you can create an agentic workflow that comprises of a set of large language model (LLM) instructions along with one or more standalone AI agents to execute an objective. See for information about adding AI agents to create agentic workflows as per your requirement and provide the required trigger.
You can also search for other available AI agents and add them to your agentic workflow. See Find AI agents for more information.
You can create a clone of the required spoke AI agent and customize it as per your requirement. See for more information about creating a clone.
- See for information about AI agents.
| AI agent | Description |
|---|---|
| SuccessFactors payroll management AI agent | Retrieves and manages payroll related information. |
| SuccessFactors user management AI agent | Retrieve detailed personal information of users. |
| SuccessFactors todos AI agent | Synchronizes, retrieves, manages, and creates todos. |
| SuccessFactors hr foundational data AI agent | Retrieves the holiday calendar. |
| SuccessFactors jobs management AI agent | Retrieves candidate information based on the ID. |
| SuccessFactors employee management AI agent | Retrieves and manages employee-related information such as, benefit information and time off details. |
There might be AI agents installed with the Now Assist application that are not used in agentic workflows. To learn how to see all agents that are available to you, see Find AI agents.
Note: Ensure that the user running an AI agent has the required roles and permissions to access data or perform operations on data in the table that is associated with the AI agent.
Available sample agentic workflows
Install Now Assist for Integration Hub and start using the available sample agentic workflows and AI agents. For more information, see ServiceNow Otto for Integration Hub.
In the ServiceNow agentic system, you can create an agentic workflow that comprises of a set of large language model (LLM) instructions along with one or more standalone AI agents to execute an objective. Use the available sample agentic workflow in AI Agent Studio so that AI agents can coordinate to solve complex problems. To modify the available sample agentic workflow as per your requirement, see .
| Sample agentic workflow | Description | AI agents used | Always ON by default? |
|---|---|---|---|
| Fetch User Details and Time‑Off Balance and Time‑Off Details | Retrieves a worker’s profile information along with their time‑off balance and time‑off details for a specified date. It is designed to help downstream processes access accurate HR and time‑management data from SuccessFactors. | - SuccessFactors Employee Management AI Agent - SuccessFactors User Management AI Agent | NoNote: To activate the workflow, see . |
| Fetch Employee Payrolls and Benefit Enrollments | Retrieves an employee’s payroll information and benefit enrollment details from SuccessFactors. It is intended for use cases requiring payroll validation, compensation planning, and benefits‑related decision support. | - SuccessFactors Payroll Management AI Agent - SuccessFactors Employee Management AI Agent | NoNote: To activate the workflow, see . |
Spoke modules
The SuccessFactors spoke provides sample modules in the draft state to demonstrate automating the SuccessFactors tasks when events occur in ServiceNow. To customize a module, copy it to a new application scope. Available sample modules include:
| Module | Description |
|---|---|
| Department Staging Table | Displays the department data retrieved from SuccessFactors. |
| Locations Staging Table | Displays the location data retrieved from SuccessFactors. |
| Job Profile Staging Table | Displays the job profile data retrieved from SuccessFactors. |
| Worker Profiles Staging Table | Displays the worker profile data retrieved from SuccessFactors. |
| Inbound Todos Staging Table | Displays the to-do records retrieved from SuccessFactors. |
| Outbound Todos Staging Table | Displays the todo records created in ServiceNow. When a todo record is created or updated in ServiceNow, the Create Todo or Update Todo flow is triggered and the same record is created or updated in SuccessFactors. All the associated record details, are retrieved from SuccessFactors and saved in this staging table. If the flow fails to create or update record in SuccessFactors, the associated record or updates in ServiceNow is also deleted. |
| Employee Job Information And History | Displays the job information and job history of all users. |
| View My Time Off Balance | Displays the time off balance of the logged-in user. |
| View My Time Off Details | Displays details of the time off requests of the logged-in user. |
| Webhook Registry | Displays the list of webhook registries. Admin must create webhook registry here. For more information, see Set up webhook for the SuccessFactors spoke. |
| View My Time Card Details For Past 1 Month | Displays time card details of the previous one month for the logged-in user. |
| View My Worker Profile | Displays the worker profile details of the logged-in user. |
| View My Holiday Calendar | Displays the holiday calendar applicable to the logged-in user. |
| View My Reporting Structure | Displays the reporting structure details of the logged-in user. |
| View My Direct Deposit Information | Displays the direct deposit details of the logged-in user. |
| View My Total Rewards | Displays the total rewards of the logged-in user. |
To retrieve the data, run Run SuccessFactors Integration Flow. The data in the staging tables is available for seven days. During this time period, you must use transform maps to save this data in the required target ServiceNow tables according to your requirement.
Spoke transform maps
The SuccessFactors spoke provides sample transform maps in inactive state and associated sample target tables to demonstrate using transform maps to save SuccessFactors data in your ServiceNow tables. You can use these sample transform maps and target tables as reference to create transform maps according to your requirement.
For more information, see Transform maps.
Spoke user roles
These user roles are available along with the spoke:
- SuccessFactors Admin (sn_successfactors.SuccessFactors Admin): If you have this role, you can access all spoke modules and tables.
- SuccessFactors Private Data (sn_successfactors.SuccessFactors Private Data): If you have this role, you can access to data in these spoke modules:
- View My Direct Deposit Information
- View My Total Rewards
- SuccessFactors Public Data (sn_successfactors.SuccessFactors Public Data): If you have this role, you can access to data in these spoke modules:
- View My Time Off Balance
- View My Time Off Details
- View My Time Card Details For Past 1 Month
- View My Worker Profile
- View My Holiday Calendar
- View My Reporting Structure
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see Connections and Credentials.
Two connection and credential aliases are available with the SuccessFactors spoke. One for the SOAP API and the other for the OData API.
For information about setting up the spoke, see Set up the SuccessFactors spoke v4.x.x.