{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21583,"path":"integrate-applications/integration-hub/setup-successfactors-v3.md","title":"Set up the SuccessFactors spoke v3.x.x","bundle":null,"doc_type":null,"release":"australia","body":"\n# Set up the SuccessFactors spoke v3.x.x\n\nIntegrate the ServiceNow instance with your SuccessFactors spoke instance using basic credentials.\n\n## Before you begin\n\n- Request an Integration Hub subscription.\n- Activate the SuccessFactors spoke.\n- Enable these system properties:\n - **glide.pf.rest.response\\_payload\\_max\\_size**: The maximum value is, `10240`.\n - **com.snc.process\\_flow.reporting.serialized.val\\_size\\_limit**: The maximum value is, `16384`.\n - **com.glide.transform.json.max-partial-length**: The maximum value is, `65536`.\n- Role required: admin.\n\n**Note:** SuccessFactors will be deprecating basic authentication by Nov 2026 and hence, everyone must use OAuth SAML, which SuccessFactors spoke v4.12.0 supports.\n\n- If you are installing the SuccessFactors spoke for the first time, install SuccessFactors spoke v4.12.0. For more information about setting up SuccessFactors spoke v4.12.0, [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- If you are using an earlier version of the SuccessFactors spoke, migrate to SuccessFactors spoke v4.12.0. For more information, see [Migrate to SuccessFactors spoke v4.12.0](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/migrate-successfactors.md).\n\n## Create Credential record for the OData API\n\nCreate Credential record for the OData APIs in SuccessFactors. The SuccessFactors spoke connection and credential alias uses these credentials to authorize actions using the OData API.\n\n### Procedure\n\n1. Navigate to **Connections & Credentials** > **Credentials**.\n\n2. Click **New**.\n\n The system displays the message **What type of Credentials would you like to create?**.\n\n3. Select **Basic Auth Credentials**.\n\n A blank Basic Auth Credentials form displays.\n\n4. On the form, fill these values.\n\n |Field|Value required|\n |-----|--------------|\n |Name|Name to uniquely identify the record. For example, enter `SAPSF OData Credentials`.|\n |User name|User name with the OData API permission in this format: `@`.|\n |Password|Associated password.|\n |Active|Option to actively use the credential record.|\n |Order|Order to apply this credential. For example, enter `100`.|\n\n5. Click **Submit**.\n\n\n### Result\n\nThe credential record to authorize actions using the OData API is created.\n\n## Create Credential record for the SOAP API\n\nCreate Credential record for the SOAP APIs in SuccessFactors. The SuccessFactors spoke connection and credential alias uses these credentials to authorize actions using the SOAP APIs.\n\n### Procedure\n\n1. Navigate to **Connections & Credentials** > **Credentials**.\n\n2. Click **New**.\n\n The system displays the message **What type of Credentials would you like to create?**.\n\n3. Select **SuccessFactors SOAP Credentials**.\n\n A blank SuccessFactors SOAP Credentials form displays.\n\n4. On the form, fill these values.\n\n |Field|Value required|\n |-----|--------------|\n |Name|Name to uniquely identify the record. For example, enter `SAPSF Comp Emp Credentials`.|\n |User name|User name with the SOAP API permission.|\n |Password|Associated password.|\n |Active|Option to actively use the credential record.|\n |Order|Order to apply this credential. For example, enter `100`.|\n\n5. Click **Submit**.\n\n\n### Result\n\nThe credential record to authorize actions using the SOAP API is created.\n\n## Create Connection record for the OData API\n\nCreate a Connection record for the OData API in SuccessFactors. The SuccessFactors spoke connection and credential alias uses these connections to perform actions in SuccessFactors.\n\n### Procedure\n\n1. Navigate to **Connections & Credentials** > **Connection & Credential Aliases**.\n\n2. Open for the record for **SuccessFactors OData API**, for example, **SuccessFactors\\_Odata**.\n\n3. From the **Connections** tab, click **New**.\n\n The system displays a blank HTTP\\(s\\) Connection form.\n\n4. On the form, fill these values.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nName\n\n\n\nName to uniquely identify the record. For example, `SF_REST`.\n\n
\n\nCredential\n\n\n\nCredential record you created for the OData API. For example, `SAPSF OData Credentials`.\n\n
\n\nConnection URL\n\n\n\nSuccessFactors service root URL. For example, `https://apisalesdemo4.successfactors.com/odata/v2`.**Note:** If you are using an SAP Cloud account, see [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/93f95815070049ebaaff042d8322d518/af2b8d5437494b12be88fe374eba75b6.html) in [SAP Help Portal](https://help.sap.com/docs/) to select the correct endpoint that is needed to target the API server.\n\n
\n\nActive\n\n\n\nOption to actively use the connection record.\n\n
5. Click **Submit**.\n\n\n### Result\n\nThe connection record for the OData API in SuccessFactors is created.\n\n## Create Connection record for the SOAP API\n\nCreate a Connection record for the SOAP API in SuccessFactors. The SuccessFactors spoke connection and credential alias uses these connections to perform actions in SuccessFactors.\n\n### Procedure\n\n1. Navigate to **Connections & Credentials** > **Connection & Credential Aliases**.\n\n2. Open for the record for **SuccessFactors SOAP API**, for example, **SuccessFactors\\_Comp\\_Emp**.\n\n3. From the **Connections** tab, click **New**.\n\n The system displays a blank HTTP\\(s\\) Connection form.\n\n4. On the form, fill these values.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nName\n\n\n\nName to uniquely identify the record. For example, `SF_REST`.\n\n
\n\nCredential\n\n\n\nCredential record you created for the SOAP API. For example, `SAPSF Comp Emp Credentials`.\n\n
\n\nConnection URL\n\n\n\nSuccessFactors connection URL. For example, `https://salesdemo4.successfactors.com/sfapi/v1/soap`.**Note:** If you are using an SAP Cloud account, see [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/93f95815070049ebaaff042d8322d518/af2b8d5437494b12be88fe374eba75b6.html) in [SAP Help Portal](https://help.sap.com/docs/) to select the correct endpoint that is needed to target the API server.\n\n
\n\nActive\n\n\n\nOption to actively use the connection record.\n\n
5. In the **Attributes** tab, provide these fields.\n\n |Field|Description|\n |-----|-----------|\n |Company Id|Immutable Company ID of your SuccessFactors instance.|\n |Flow Timeout \\(seconds\\)|Maximum time in seconds up to which data can be received from SuccessFactors during the flow execution. If the time taken to retrieve data from SuccessFactors exceeds the timeout duration, the flow or subflow is cancelled. Default value is, `30`.|\n\n6. Click **Submit**.\n\n\n### Result\n\nThe connection record for the SOAP API in SuccessFactors is created.\n\n## Synchronize data between SuccessFactors and ServiceNow\n\nCustomise the sample flows as per your requirement to synchronize data between your SuccessFactors and ServiceNow instances.\n\n### Todo entity\n\nThe SuccessFactors spoke provides sample flows to synchronize data bi-directionally for the todo entity. The sample flow, Run SuccessFactors Integration Flow can customised to retrieve data from SuccessFactors, while the Create Todo and Update Todo flows creates or updates the todo records in SuccessFactors when events occur in ServiceNow. While customising the sample flows, ensure that you provide appropriate triggers to retrieve and save future updates using transform maps.\n\n### Other default entities\n\nFor these entities, the sample flow, Run SuccessFactors Integration Flow, can be customised to retrieve data from SuccessFactors:\n\n- Department\n- Location\n- Job Profile\n- Workers Profile\n- Effective Workers Profile\n- Job History Including Secondary Assignments\n\nTo create or update records in SuccessFactors for these entities when events occur in ServiceNow:\n\n- Create flows or subflows as per your choice or customise the sample flows and subflows.\n- Use Metadata Retrieval and Record Management actions in your flows.\n- Ensure that you provide appropriate triggers to retrieve and save future updates using transform maps.\n\n### Other SuccessFactors entities\n\nDepending on the SuccessFactors permissions and configurations, you can also synchronize data of other entities as per your requirement.\n\n"}}