{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21636,"path":"integrate-applications/integration-hub/successfactors-spoke.md","title":"SuccessFactors Spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# SuccessFactors Spoke\n\nThe SuccessFactors spoke is built by Bristlecone, Inc. Manage data and entities in SuccessFactors from your ServiceNow instance.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html). Starting on March 1st 2022, all SAP spokes will be available only on the Store.\n\n## IntegrationHub subscription\n\nThis spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf).\n\n## Spoke version\n\nSuccessFactors spoke v4.12.0 is the latest version. For version history of the spoke, see [SuccessFactors spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-integrationhub-rn-successfactors.html).\n\n## Supported versions\n\nThis spoke was built for SuccessFactors v2.0, but may be compatible with later versions.\n\n## Spoke dependencies\n\nIf you’re having trouble installing the app, ensure that these dependent plugins are installed:\n\n-   Complex Object \\(com.glide.cobject\\)\n-   ServiceNow IntegrationHub Runtime \\(com.glide.hub.integration.runtime\\)\n-   ServiceNow Flow Designer - Dynamic Inputs \\(com.glide.hub.dynamic\\_inputs\\)\n-   ServiceNow IntegrationHub Action Step - REST \\(com.glide.hub.action\\_step.rest\\)\n-   ServiceNow IntegrationHub Action Step - SOAP \\(com.glide.hub.action\\_step.soap\\)\n-   ServiceNow IntegrationHub Action Template - Data Stream \\(com.glide.hub.action\\_type.datastream\\)\n-   ServiceNow IntegrationHub Action Step - XML Parser \\(com.glide.hub.action\\_step.xmlparser\\)\n-   ServiceNow Flow Designer - Dynamic Outputs \\(com.glide.hub.dynamic\\_outputs\\)\n-   Remote Tables \\(com.glide.script.vtable\\)\n\n**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.\n\n## Spoke flows\n\nThe 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:\n\n<table id=\"table_jrx_pjp_5lb\"><thead><tr><th>\n\nFlow\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nCreate Todo\n\n</td><td>\n\nCreates a to-do record in SuccessFactors.\n\n</td></tr><tr><td>\n\nUpdate Todo\n\n</td><td>\n\nUpdates details of the specified to-do record in SuccessFactors.\n\n</td></tr><tr><td>\n\nRun SuccessFactors Integration Flow\n\n</td><td>\n\nRetrieves 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\n-   Location\n-   Job Profile\n-   Workers Profile\n-   Effective Workers Profile\n-   Job History Including Secondary Assignments\n-   Todo\n\n</td></tr></tbody>\n</table>**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.\n\n## Spoke subflows\n\nThe 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:\n\n<table id=\"table_bd5_ckp_5lb\"><thead><tr><th>\n\nSubflow\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nLook up Departments\n\n</td><td>\n\nRetrieves the department data from SuccessFactors and stores it in SuccessFactors Departments Staging Table.\n\n</td></tr><tr><td>\n\nLook Up Employee Compensation Using Personal Authentication\n\n</td><td>\n\nRetrieves an employee’s compensation details based on their Personal External ID.\n\n</td></tr><tr><td>\n\nRetrieve Effective Worker Profiles\n\n</td><td>\n\nRetrieves the Effective Worker Profiles data from SuccessFactors and stores it in SuccessFactors Worker Profiles Staging Table.\n\n</td></tr><tr><td>\n\nRetrieve Job History Including Secondary Assignments\n\n</td><td>\n\nRetrieves all primary and secondary job history data from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Job Profiles\n\n</td><td>\n\nRetrieves the job profile data from SuccessFactors and stores it in SuccessFactors Job Profile Staging Table.\n\n</td></tr><tr><td>\n\nRetrieve Locations\n\n</td><td>\n\nRetrieves the location data from SuccessFactors and stores it in SuccessFactors Locations Staging Table.\n\n</td></tr><tr><td>\n\nRetrieve Todos\n\n</td><td>\n\nRetrieves the to-do data from SuccessFactors and stores it in SuccessFactors Inbound Todos Staging Table.\n\n</td></tr><tr><td>\n\nRetrieve Worker Profiles\n\n</td><td>\n\nRetrieves the Worker Profiles data from SuccessFactors and stores it in SuccessFactors Worker Profiles Staging Table.\n\n</td></tr><tr><td>\n\nRun SuccessFactors Service\n\n</td><td>\n\nRetrieves entire data or only updates made from the last successful runtime, for the selected entities.\n\n</td></tr><tr><td>\n\nProcess SuccessFactors Webhooks\n\n</td><td>\n\nProcesses the SAP SuccessFactors webhook event. For more information about setting up the webhooks, see [Set up webhook for the SuccessFactors spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-sapsf-webhooks.md).\n\n</td></tr><tr><td>\n\nRetrieve Worker Profile by Company Territory Code\n\n</td><td>\n\nRetrieves 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.\n\n</td></tr></tbody>\n</table>## Spoke actions\n\nThe 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:\n\n**Note:**\n\n-   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](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1281664) knowledge base article on [NOW Support](https://support.servicenow.com/now).\n-   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.\n\n<table id=\"table_ymm_ql1_zmb\"><thead><tr><th>\n\nCategory\n\n</th><th>\n\nAction\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td rowspan=\"25\">\n\nEmployee Management\n\n</td><td>\n\nEmployee Address Information\n\n</td><td>\n\nRetrieves the address information of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Annual Compensation\n\n</td><td>\n\nRetrieves the annual compensation details of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Compensation Details\n\n</td><td>\n\nRetrieves compensation details of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Documents\n\n</td><td>\n\nRetrieves all the viewable documents of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Payment Method Details\n\n</td><td>\n\nRetrieves the details about payment method of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Time Off\n\n</td><td>\n\nRetrieves the time offs taken by the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Time Off Balances\n\n</td><td>\n\nRetrieves the time off-balance details of the specified employee.\n\n</td></tr><tr><td>\n\nMy TimeCard Details\n\n</td><td>\n\nRetrieves the time sheet details of the specified employee.\n\n</td></tr><tr><td>\n\nChange User Roles\n\n</td><td>\n\nAdds user to the given permission group.\n\n</td></tr><tr><td>\n\nEmployee All Payment Methods Details\n\n</td><td>\n\nRetrieves details of all the payment methods of the specified employee.\n\n</td></tr><tr><td>\n\nEmployee Recurring Compensations\n\n</td><td>\n\nManages the recurring component of a specified employee's compensation.\n\n</td></tr><tr><td>\n\nLook up Employee Benefit Enrollments by User ID\n\n</td><td>\n\nRetrieves details of the benefit enrollments of the specified employee during a specific time period.\n\n</td></tr><tr><td>\n\nOffboard an Employee\n\n</td><td>\n\nTriggers the termination process of the specified employee.\n\n</td></tr><tr><td>\n\nOrg Change\n\n</td><td>\n\nChanges the organization related information of the specified employee.\n\n</td></tr><tr><td>\n\nReport No Shows\n\n</td><td>\n\nReports no show for the specified employee.\n\n</td></tr><tr><td>\n\nReporting Structure\n\n</td><td>\n\nRetrieves the reporting structure of the specified employee.\n\n</td></tr><tr><td>\n\nRequest Time Off\n\n</td><td>\n\nApplies a time off request for the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Address\n\n</td><td>\n\nUpdates the address of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Recurring Compensations\n\n</td><td>\n\nUpdates the recurring component of a specified employee's compensation.\n\n</td></tr><tr><td>\n\nUpdate Employee DOB\n\n</td><td>\n\nUpdates the date of birth of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Email\n\n</td><td>\n\nUpdates the details of the email of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Phone\n\n</td><td>\n\nUpdates the phone details of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Personal Information\n\n</td><td>\n\nUpdates the personal information of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Personal Information - Global\n\n</td><td>\n\nUpdates the global information of the specified employee.\n\n</td></tr><tr><td>\n\nUpdate Employee Start Dates\n\n</td><td>\n\nUpdates the start date of employment of the specified employee.\n\n</td></tr><tr><td rowspan=\"20\">\n\nHR Foundational Data\n\n</td><td>\n\nLogin into SuccessFactors\n\n</td><td>\n\nLogs in to SuccessFactors and retrieves the Session ID.\n\n</td></tr><tr><td>\n\nRetrieve Current Employment Information\n\n</td><td>\n\nRetrieves the current employment information from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Departments\n\n</td><td>\n\nRetrieves the department data from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Addresses Stream\n\n</td><td>\n\nRetrieves address information from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Emails Stream\n\n</td><td>\n\nRetrieves emails information.\n\n</td></tr><tr><td>\n\nLook up Person Biographical Stream\n\n</td><td>\n\nRetrieves person biographical information.\n\n</td></tr><tr><td>\n\nLook up Personal Detailed Information Stream\n\n</td><td>\n\nRetrieves personal detailed information.\n\n</td></tr><tr><td>\n\nLook up Employment Information Stream\n\n</td><td>\n\nRetrieves the employment information from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Phone Stream\n\n</td><td>\n\nRetrieves phone information from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Employee Global Assignments Stream\n\n</td><td>\n\nRetrieves all global assignment details from SAP SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Secondary Assignments Stream\n\n</td><td>\n\nRetrieves all secondary assignments from SAP SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Full Job History Including Secondary Assignments\n\n</td><td>\n\nRetrieves the complete job history data including secondary assignments from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Effective Worker IDs\n\n</td><td>\n\nRetrieves the effective Worker Profiles ID from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Profiles by Person ID\n\n</td><td>\n\nRetrieves the Worker Profiles data by Person ID from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Effective Worker Profiles\n\n</td><td>\n\nRetrieves the Effective Worker Profiles data from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Job History Including Secondary Assignments \\(Deprecated\\)\n\n</td><td>\n\nRetrieves the job history data including secondary assignments from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Job Profiles\n\n</td><td>\n\nRetrieves the job profile data from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Locations\n\n</td><td>\n\nRetrieves the location data from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Worker Profiles\n\n</td><td>\n\nRetrieves the Worker Profiles data from SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Holiday Calendar\n\n</td><td>\n\nRetrieves holiday calendar for a country.\n\n</td></tr><tr><td rowspan=\"28\">\n\nMetadata Retrieval**Note:** 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`.\n\n</td><td>\n\nGet Dynamic Output Fields\n\n</td><td>\n\nCreates a dynamic output structure for mapping of fields in response for the given entity.\n\n</td></tr><tr><td>\n\nGet Entities - Creatable\n\n</td><td>\n\nRetrieves the entities for which the create operation is supported.\n\n</td></tr><tr><td>\n\nGet Entities - Deletable\n\n</td><td>\n\nRetrieves the entities for which the delete operation is supported.\n\n</td></tr><tr><td>\n\nGet Entities - Updatable\n\n</td><td>\n\nRetrieves entities for which the update operation is supported.\n\n</td></tr><tr><td>\n\nGet Entities List\n\n</td><td>\n\nRetrieves the list of all entities.\n\n</td></tr><tr><td>\n\nGet Fields - Creatable\n\n</td><td>\n\nRetrieves all the creatable non-navigation properties in an entity.\n\n</td></tr><tr><td>\n\nGet Fields - Updatable\n\n</td><td>\n\nRetrieves all the updatable non-navigation fields in an entity.\n\n</td></tr><tr><td>\n\nGet Key Fields\n\n</td><td>\n\nRetrieves all the key fields in the specified entity.\n\n</td></tr><tr><td>\n\nGet Required Fields - Creatable\n\n</td><td>\n\nRetrieves all the required insertable fields in the specified entity.\n\n</td></tr><tr><td>\n\nGet Updatable Todo Fields\n\n</td><td>\n\nRetrieves the list of updatable fields in the Outbound Todos Staging Table.\n\n</td></tr><tr><td>\n\nGet Available Positions\n\n</td><td>\n\nRetrieves all the available positions for given company and location code.\n\n</td></tr><tr><td>\n\nGet Business Units\n\n</td><td>\n\nRetrieves all the available business units in SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Companies\n\n</td><td>\n\nRetrieves all the available active companies in SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Countries\n\n</td><td>\n\nRetrieves all the available countries in SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Country Code\n\n</td><td>\n\nRetrieves country code of a country.\n\n</td></tr><tr><td>\n\nGet Dynamic Permission Groups\n\n</td><td>\n\nRetrieves all the available dynamic permission groups.\n\n</td></tr><tr><td>\n\nGet Event Reasons By Event ID\n\n</td><td>\n\nRetrieves all the event reasons for the specified Event ID.\n\n</td></tr><tr><td>\n\nGet Global Information By Entity\n\n</td><td>\n\nRetrieves metadata of the entity specified to fetch the global information.\n\n</td></tr><tr><td>\n\nGet Global Personal Information Supported Countries\n\n</td><td>\n\nRetrieves details of the countries that support the creation and modification of the personal global information.\n\n</td></tr><tr><td>\n\nGet Locations By Company Code\n\n</td><td>\n\nRetrieves all the active locations from SuccessFactors for the specified company code.\n\n</td></tr><tr><td>\n\nGet People Pools By Group ID\n\n</td><td>\n\nRetrieves all people pools with only user name category for the specified group.\n\n</td></tr><tr><td>\n\nGet Pick List Options\n\n</td><td>\n\nRetrieves all the available pick list options for the specified pick list ID.\n\n</td></tr><tr><td>\n\nGet Pick List Options By Country\n\n</td><td>\n\nRetrieves the pick list options of the specified country.\n\n</td></tr><tr><td>\n\nGet Recurring Pay Components Defined for Employee\n\n</td><td>\n\nRetrieves recurring pay components and relevant information for the specified employee.\n\n</td></tr><tr><td>\n\nGet Required Fields - Creatable\n\n</td><td>\n\nRetrieves all the required insertable fields in the specified entity.\n\n</td></tr><tr><td>\n\nGet Time Types By User ID\n\n</td><td>\n\nRetrieves all the available time types of the specified employee in SAP SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Updatable Todo Fields\n\n</td><td>\n\nRetrieves the list of updatable fields in the SuccessFactors Outbound Todos Staging table.\n\n</td></tr><tr><td>\n\nLook up Company Territory Code\n\n</td><td>\n\nRetrieves all available company territory codes from SAP SuccessFactors.\n\n</td></tr><tr><td rowspan=\"5\">\n\nRecord Management\n\n</td><td>\n\nCreate Record\n\n</td><td>\n\nCreates a record in SuccessFactors.**Note:** The Create Record action displays non-navigable fields only in the creatable fields list.\n\n</td></tr><tr><td>\n\nDelete Record\n\n</td><td>\n\nDeletes the specified record in SuccessFactors.\n\n</td></tr><tr><td>\n\nExecute Entity By URL\n\n</td><td>\n\nTakes navigation URL as input and provides the response for that navigation URL.\n\n</td></tr><tr><td>\n\nGet Record\n\n</td><td>\n\nRetrieves the record for the selected entity and for the given key fields.\n\n</td></tr><tr><td>\n\nUpdate Record\n\n</td><td>\n\nUpdates details of the specified record.\n\n</td></tr><tr><td rowspan=\"4\">\n\nTodos\n\n</td><td>\n\nCreate Todo\n\n</td><td>\n\nCreate a to-do record in SuccessFactors.\n\n</td></tr><tr><td>\n\nGet Todo By ID\n\n</td><td>\n\nGet details of a to-do from SuccessFactors.\n\n</td></tr><tr><td>\n\nRetrieve Todos\n\n</td><td>\n\nRetrieves the to-do data from SuccessFactors, except those with Category ID as 57.\n\n</td></tr><tr><td>\n\nUpdate Todo\n\n</td><td>\n\nUpdates details of the specified to-do record.\n\n</td></tr><tr><td rowspan=\"6\">\n\nUser Management\n\n</td><td>\n\nLook up User Activity\n\n</td><td>\n\nRetrieves the last activity time of your SAP SuccessFactors users.\n\n</td></tr><tr><td>\n\nLook up User Activity SFTP\n\n</td><td>\n\nRetrieves the last activity time of your SAP SuccessFactors users by fetching the report published on an SSH File Transfer Protocol \\(SFTP\\) location.\n\n</td></tr><tr><td>\n\nLook up Users\n\n</td><td>\n\nRetrieves the list of SAP SuccessFactors users.\n\n</td></tr><tr><td>\n\nLook up User by User ID\n\n</td><td>\n\nRetrieves the worker details of the SuccessFactors user.\n\n</td></tr><tr><td>\n\nLook up User Personal Details\n\n</td><td>\n\nRetrieves user personal details of the specified employee.\n\n</td></tr><tr><td>\n\nSuspend User\n\n</td><td>\n\nSuspends a user account.\n\n</td></tr><tr><td rowspan=\"5\">\n\nUtility Category\n\n</td><td>\n\nCall A SuccessFactors Subflow\n\n</td><td>\n\nExecutes the specified SuccessFactors spoke subflow synchronously.\n\n</td></tr><tr><td>\n\nCall Run SuccessFactors Service Subflow\n\n</td><td>\n\nExecutes the Run SuccessFactors Service subflow asynchronously.\n\n</td></tr><tr><td>\n\nCheck Flow Status\n\n</td><td>\n\nChecks if the context of flow is running.\n\n</td></tr><tr><td>\n\nGet Last Run Date\n\n</td><td>\n\nRetrieves the last run date and time of the flow.\n\n</td></tr><tr><td>\n\nUpdate Record In Outbound Todos Staging Table\n\n</td><td>\n\nUpdates details of the specified to-do record in SuccessFactors Outbound Todos Staging Table.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nGoal Management\n\n</td><td>\n\nLook up Goals by User ID\n\n</td><td>\n\nRetrieves goals information from SuccessFactors for the specified user ID.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nPayroll Management\n\n</td><td>\n\nLook up Employee Payrolls\n\n</td><td>\n\nRetrieves payroll details of the specified employee.\n\n</td></tr><tr><td rowspan=\"3\">\n\nSkill Management\n\n</td><td>\n\nCreate or Update Skill Profile\n\n</td><td>\n\nCreates or updates skill profile and profile skill mappings for a particular employee.\n\n</td></tr><tr><td>\n\nLook up Employee Skills Stream\n\n</td><td>\n\nRetrieves the skill information of required employee.\n\n</td></tr><tr><td>\n\nLook up Skills Stream\n\n</td><td>\n\nRetrieves the skill information.\n\n</td></tr><tr><td rowspan=\"8\">\n\nJob Management\n\n</td><td>\n\nLook up Attachment by ID\n\n</td><td>\n\nRetrieves attachment content and stores it in the SuccessFactors Attachments data source for the specified attachment ID.To access the attachments, navigate to **All** &gt; **System Import Sets** &gt; **Administration** &gt; **Data Sources** and open the record **SuccessFactors Attachments**. The required files are attached to this data source record.\n\n**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Candidate by ID\n\n</td><td>\n\nRetrieves candidate information from SuccessFactors for the specified candidate ID.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Job Applications Stream\n\n</td><td>\n\nRetrieves job application information from SuccessFactors.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Job Codes Stream\n\n</td><td>\n\nRetrieves job level, employment type, and job type information from SuccessFactors.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Job Requisition by ID\n\n</td><td>\n\nRetrieves job requisition details for the specified requisition ID.**Note:**\n\n-   Create a copy of the Lookup Job Requisition by ID action, if the API attribute of Job Level ID and Employment Type ID is configured with other custom attributes except customString3 and customString4, and modify the post-processing script with the expected API attribute path.\n-   Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Job Requisition Postings Stream\n\n</td><td>\n\nRetrieves job posting information from SuccessFactors.**Note:** Only an admin user can run this action.\n\n</td></tr><tr><td>\n\nLook up Employee Jobs Stream\n\n</td><td>\n\nRetrieves All Employee Jobs information from SuccessFactors.\n\n</td></tr><tr><td>\n\nLook up Job Profiles Stream\n\n</td><td>\n\nRetrieves job profiles information from SuccessFactors.\n\n</td></tr></tbody>\n</table>**Note:** If a spoke action requires date or time as an input, ensure that you provide the value in GMT time zone only.\n\n## Available AI agents\n\nInstall Now Assist for Integration Hub and start using the available AI agents. For more information, see [ServiceNow Otto for Integration Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/now-assist-spokes.md).\n\nThis spoke provides standalone AI agents that mimic human-like intelligence to perform tasks in your ServiceNow instance.\n\n-   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 [Create an agentic workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/configure-use-case-ai-agents.md) for information about adding AI agents to create agentic workflows as per your requirement and provide the required trigger.\n\n    You can also search for other available AI agents and add them to your agentic workflow. See [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md) for more information.\n\n-   You can create a clone of the required spoke AI agent and customize it as per your requirement. See [Duplicate an AI agent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/clone-ai-agent.md) for more information about creating a clone.\n-   See [AI Agent Studio \\(legacy\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/na-ai-agents.md) for information about AI agents.\n\n|AI agent|Description|\n|--------|-----------|\n|SuccessFactors payroll management AI agent|Retrieves and manages payroll related information.|\n|SuccessFactors user management AI agent|Retrieve detailed personal information of users.|\n|SuccessFactors todos AI agent|Synchronizes, retrieves, manages, and creates todos.|\n|SuccessFactors hr foundational data AI agent|Retrieves the holiday calendar.|\n|SuccessFactors jobs management AI agent|Retrieves candidate information based on the ID.|\n|SuccessFactors employee management AI agent|Retrieves and manages employee-related information such as, benefit information and time off details.|\n\nThere might be AI agents installed on your instance that are not used in agentic workflows. To learn how to see all agents that are available to you, see [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md).\n\n**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.\n\n## Available sample agentic workflows\n\nInstall 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/now-assist-spokes.md).\n\nIn 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 [Modify an agentic workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/modify-aia-use-case.md).\n\n<table id=\"table_jm1_mlv_c3c\"><thead><tr><th>\n\nSample agentic workflow\n\n</th><th>\n\nDescription\n\n</th><th>\n\nAI agents used\n\n</th><th>\n\nAlways ON by default?\n\n</th></tr></thead><tbody><tr><td>\n\nFetch User Details and Time‑Off Balance and Time‑Off Details\n\n</td><td>\n\nRetrieves 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.\n\n</td><td>\n\n-   SuccessFactors Employee Management AI Agent\n-   SuccessFactors User Management AI Agent\n\n</td><td>\n\nNo**Note:** To activate the workflow, see [Activate an agentic workflow template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/activate-aia-use-case.md).\n\n</td></tr><tr><td>\n\nFetch Employee Payrolls and Benefit Enrollments\n\n</td><td>\n\nRetrieves 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.\n\n</td><td>\n\n-   SuccessFactors Payroll Management AI Agent\n-   SuccessFactors Employee Management AI Agent\n\n</td><td>\n\nNo**Note:** To activate the workflow, see [Activate an agentic workflow template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/activate-aia-use-case.md).\n\n</td></tr></tbody>\n</table>## Spoke modules\n\nThe 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:\n\n<table id=\"table_qbq_m4n_5lb\"><thead><tr><th>\n\nModule\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nDepartment Staging Table\n\n</td><td>\n\nDisplays the department data retrieved from SuccessFactors.\n\n</td></tr><tr><td>\n\nLocations Staging Table\n\n</td><td>\n\nDisplays the location data retrieved from SuccessFactors.\n\n</td></tr><tr><td>\n\nJob Profile Staging Table\n\n</td><td>\n\nDisplays the job profile data retrieved from SuccessFactors.\n\n</td></tr><tr><td>\n\nWorker Profiles Staging Table\n\n</td><td>\n\nDisplays the worker profile data retrieved from SuccessFactors.\n\n</td></tr><tr><td>\n\nInbound Todos Staging Table\n\n</td><td>\n\nDisplays the to-do records retrieved from SuccessFactors.\n\n</td></tr><tr><td>\n\nOutbound Todos Staging Table\n\n</td><td>\n\nDisplays 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.\n\n</td></tr><tr><td>\n\nEmployee Job Information And History\n\n</td><td>\n\nDisplays the job information and job history of all users.\n\n</td></tr><tr><td>\n\nView My Time Off Balance\n\n</td><td>\n\nDisplays the time off balance of the logged-in user.\n\n</td></tr><tr><td>\n\nView My Time Off Details\n\n</td><td>\n\nDisplays details of the time off requests of the logged-in user.\n\n</td></tr><tr><td>\n\nWebhook Registry\n\n</td><td>\n\nDisplays the list of webhook registries. Admin must create webhook registry here. For more information, see [Set up webhook for the SuccessFactors spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-sapsf-webhooks.md).\n\n</td></tr><tr><td>\n\nView My Time Card Details For Past 1 Month\n\n</td><td>\n\nDisplays time card details of the previous one month for the logged-in user.\n\n</td></tr><tr><td>\n\nView My Worker Profile\n\n</td><td>\n\nDisplays the worker profile details of the logged-in user.\n\n</td></tr><tr><td>\n\nView My Holiday Calendar\n\n</td><td>\n\nDisplays the holiday calendar applicable to the logged-in user.\n\n</td></tr><tr><td>\n\nView My Reporting Structure\n\n</td><td>\n\nDisplays the reporting structure details of the logged-in user.\n\n</td></tr><tr><td>\n\nView My Direct Deposit Information\n\n</td><td>\n\nDisplays the direct deposit details of the logged-in user.\n\n</td></tr><tr><td>\n\nView My Total Rewards\n\n</td><td>\n\nDisplays the total rewards of the logged-in user.\n\n</td></tr></tbody>\n</table>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.\n\n## Spoke transform maps\n\nThe 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.\n\nFor more information, see [Transform maps](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/system-import-sets/c_CreatingNewTransformMaps.md).\n\n## Spoke user roles\n\nThese user roles are available along with the spoke:\n\n-   SuccessFactors Admin \\(sn\\_successfactors.SuccessFactors Admin\\): If you have this role, you can access all spoke modules and tables.\n-   SuccessFactors Private Data \\(sn\\_successfactors.SuccessFactors Private Data\\): If you have this role, you can access to data in these spoke modules:\n    -   View My Direct Deposit Information\n    -   View My Total Rewards\n-   SuccessFactors Public Data \\(sn\\_successfactors.SuccessFactors Public Data\\): If you have this role, you can access to data in these spoke modules:\n    -   View My Time Off Balance\n    -   View My Time Off Details\n    -   View My Time Card Details For Past 1 Month\n    -   View My Worker Profile\n    -   View My Holiday Calendar\n    -   View My Reporting Structure\n\n## Connection and credential alias requirements\n\nIntegration 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/r-credentials.md).\n\nTwo connection and credential aliases are available with the SuccessFactors spoke. One for the SOAP API and the other for the OData API.\n\nFor information about setting up the spoke, see [Set up the SuccessFactors spoke v4.x.x](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-successfactors.md).\n\n"}}