SAP Knowledge Base Article - Public

3460200 - Onboarding stopped extracting documents via API - Onboarding 1.0

Symptom

  • There is a custom Boomi-based integration that extracts new hires’ documents of two types:
    • Uploaded forms by the candidate
    • Generated forms from Onboarding
  • The API of ONB 1.0 does not return documents that were uploaded manually by candidates on panels (while the filled-in forms are extracted fine).
  • Instead of pdf, the API returns an html code with no document content.

Environment

SAP SuccessFactors Onboarding 1.0

Reproducing the Issue

Prerequisites:

  1. Authenticate to ONB API calling
    [ONBOARDING URL/api.ashx/authenticate?format=json
    with message body (password is hidden for security)
    {
    "AccountName": "[ONBOARDING ACCOUNT NAME]",
    "UserName": "[WEBSERVICE USERNAME",
    "Password": "[WEBSERVCICE PW]"
    }
  2. Using returned cookie, perform API call
    [Onboarding URL]/GetDocument.aspx?id=[Document ID&AccountName=[Onboarding account name]
  3. Where id is document id obtained by calling

Cause

For fetching the forms which were generated by the system, customer is using:

  • "GetForm.aspx?Id=<DocId>&AccountName=<AccountName>"

But for fetching the uploaded docs, the customer is using:

  • "GetDocument.aspx?Id=<DocId>&AccountName=<AccountName>"

Resolution

Instead, please ensure you use GetForm as mentioned below.

  • "GetForm.aspx?Id=<DocId>&AccountName=<AccountName>&ActivityType=Uploaded"

You will get to know from the WorkQueue call, whether the given document is uploaded one or not. There is a flag.

With that you should be able to add this parameter to download the uploaded documents.

Keywords

API, Extract Uploaded documents, Download document via API, Boomi, DocCenterExportFeature, Integration, API Call, Onboarding documents, download document from workqueue, workqueue, upload, form, OBD, Onboarding 1.0 , KBA , LOD-SF-OBD-API , Webservices & API's , Problem

Product

SAP SuccessFactors Onboarding 2311