Handling BusinessObjects Data Services

Once you have BusinessObjects Data Integrator jobs, a special syntax allows you to add parameters and variables. Note that this can also be achieved by duplicating the SAP_BObj_DataServicesJobRun Process Definition.

You specify standard parameters as follows:

  • DS_JP_AUDITING - Enable auditing (true or false).
  • DS_JP_DISTRIBUTION_LEVEL - distribution_level
  • DS_JP_JOB_SERVER - Job Server or Server Group.
  • DS_JP_JOB_SYSTEM_PROFILE - System profile used to run the job.
  • DS_JP_RECOVERY - Enable recovery (true or false).
  • DS_JP_SAMPLING_RATE - Monitor sample rate (# of rows).
  • DS_JP_TRACING_TYPE - tracing, accepts the following values:
    • job_trace_all
    • job_trace_row
    • job_trace_session
    • job_trace_workflow
    • job_trace_dataflow
    • job_trace_transform
    • job_trace_usertransform
    • job_trace_userfunction
    • job_trace_abapquery
    • job_trace_sqlfunctions
    • job_trace_sqlreaders
    • job_trace_sqlloaders
    • job_trace_optimized_dataflow
    • job_trace_table
    • job_trace_script
    • job_trace_ascomm
    • job_trace_rfc_function
    • job_trace_table_reader
    • job_trace_idoc_file
    • job_trace_adapter
    • job_trace_communication
    • job_trace_parallel_execution
    • job_trace_audit

Custom parameters and global variables are set with the following syntax:

  • PAR_<parameter name> - Data Integrator custom parameter name
  • VAR_<variable name> - Data Integrator variable name

When you specify global variables and parameters:

  • Don't omit the leading $ sign(s)
  • Preserve the case

This allows you to further customize imported Process Definitions or create your own.

Example

Global variable $GroupNo becomes VAR_$GroupNo

Substitution parameter $$ReportsGeocoder becomes PAR_$$ReportsGeocoder

Using the SOAP Interface to Interact with Data Services

The following section describes how to use the SOAP interface of Data Services.

Logging on, Retrieving all Batch Job Names, Logging out

The URL to interact with the Data Services Web Service is usually <BO_System>/DataServices/servlet/webservices, such as https://bo4.example.com:8080/DataServices/servlet/webservices; this URL will be referred to as <BO_URL> in this procedure. The CMS name is usually the host name of the Data Services system, such as bo4.example.com, for example.

  1. Create a SOAP Process Definition for retrieving the session ID:
    1. Navigate to Definitions > Processes, choose New Process Definition, select SOAP.
    2. Fill DS_GetSessionID in the Name field, see DS_GetSessionID Source below for the source.
    3. On the Parameters tab:
    4. In the SOAP_URL parameter, fill <BO_URL>.
    5. In the SOAP_Action parameter, fill function=Logon.
    6. Add a parameter named Username.
    7. Add a parameter named Password, select Password in the Parameter Options to hide the password in the user interface.
    8. Add a parameter named AuthType.
    9. Add a parameter named CMS_System, fill in the host name of the Data Services system.
    10. Add a parameter named SessionID with DirectionOut; this parameter will contain the SAP session ID.
    11. Click Save & Close.
  2. Create a SOAP Process Definition for retrieving the names of Batch jobs:
    1. Navigate to Definitions > Processes, choose New Process Definition, select SOAP.
    2. Fill DS_GetBatchJobs in the Name field, see DS_GetBatchJobs Source below for the source.
    3. On the Parameters tab:
    4. In the SOAP_URL field, fill <BO_URL>.
    5. In the SOAP_Action, fill GET.
    6. Add a parameter named Repo with the default value DS_REPO.
    7. Add a parameter named SessionID.
    8. Add a parameter named AllBatchJobs.
    9. On the Options tab, select PortableDocumentFormat in the Default Output Format field.
    10. Click Save & Close.
  3. Create a SOAP Process Definition for logging out:
    1. Navigate to Definitions > Processes, choose New Process Definition, select SOAP.
    2. Fill DS_Logoff in the Name field, see DS_Logoff Source below for the source.
    3. On the Parameters tab:
    4. In the SOAP_URL parameter, fill <BO_URL>.
    5. In the SOAP_Action parameter, fill function=Logout.
    6. Add a parameter named SessionID.
    7. Click Save & Close.
  4. Create the Chain Definition:
  5. Navigate to Definitions > Chains, choose New Chain Definition.
  6. In the Name field, fill JC_DS_BatchJobs.
  7. On the Parameters tab:
    1. Add a parameter named URL, fill <BO_URL> into the Default Value.
    2. Add a parameter named Username.
    3. Add a parameter named Password, select Password in the Parameter Options to hide the password in the user interface.
    4. Add a parameter named AuthType, select List in the Simple Constraint Type field, fill secEnterprise,secLDAP,secWinAD,secSAPR3 into the Simple Constraint Data field.
    5. Add a parameter named CMS_System, fill in the host name of the Data Services system.
    6. Add a parameter named Repo with the default value DS_REPO.
    7. Add a parameter named AllBatchJobs, select List in the Simple Constraint Type field, fill true,false into the Simple Constraint Data field.
  8. On the Diagram tab:
    1. Under Step 1, choose the first process and fill DS_GetSessionID into the Process Definition field.
    2. Map parameters URL, Username, Password, AuthType, CMS_System to their respective Chain parameters.
    3. Add another Step by choosing the [+] to the right of Step 1.
    4. Fill DS_GetBatchJobs into the Process Definition field of process 1 of Step 2.
    5. Map parameter SessionID to parameter SessionID of DS_GetSessionID in the first Step.
    6. Map parameter SOAP_URL to parameter URL on the Chain.
    7. Map parameter AllBatchJobs to the respective parameter on the Chain.
    8. Add another Step by choosing the [+] to the right of Step 2.
    9. Fill DS_Logoff into the Process Definition field of process 2 of Step 2.
    10. Map parameter SOAP_URL to parameter URL on the Chain.
    11. Map parameter SessionID to parameter SessionID of DS_GetSessionID in the first Step.
  9. Click Save & Close.

DS_GetSessionID Source

Copy 
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ser="http://www.businessobjects.com/DataServices/ServerX.xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:LogonRequest>
         <username>${Username}</username>
         <password>${Password}</password>
         <cms_system>${CMS_System}</cms_system>
         <cms_authentication>AuthType</cms_authentication>
      </ser:LogonRequest>
   </soapenv:Body>
</soapenv:Envelope>

DS_GetBatchJobs Source

Copy 
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ser="http://www.businessobjects.com/DataServices/ServerX.xsd">
   <soapenv:Header>
      <ser:SessionID>${SessionID}</ser:SessionID>
   </soapenv:Header>
   <soapenv:Body>
      <ser:GetListOfBatchJobsRequest>
         <repoName>${Repo}</repoName>
         <allBatchJobs>${allBatchJobs}</allBatchJobs>
      </ser:GetListOfBatchJobsRequest>
   </soapenv:Body>
</soapenv:Envelope>

DS_Logoff Source

Copy 
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ser="http://www.businessobjects.com/DataServices/ServerX.xsd">
   <soapenv:Header>
      <ser:SessionID>${SessionID}</ser:SessionID>
   </soapenv:Header>
   <soapenv:Body/>
</soapenv:Envelope>

See Also

Scheduling SAP BusinessObjects Reports