Mapped Extraction Service

The Mapped Extraction service saves data that is generated within Sterling B2B Integrator processing in a Visibility Services fact repository.

The following table provides an overview of the Mapped Extraction service:

Category Description
System Name Mapped Extraction Service
Graphical Process Modeler (GPM) categories) All Services
Description Use the Mapped Extraction service in a business process to specify a fact model and a mapped extraction name. You enter the name of the map in the mapped extraction element in the fact model itself. See Extracting Data for more information.
Business usage This service enables you to save data generated within Sterling B2B Integrator processing in a Visibility Services fact repository
Usage example Business data that is generated during Sterling B2B Integrator processing can be specified as having a particular use for gathering business intelligence.
Preconfigured? Yes. There is a configuration of the service called MappedExtractionService that is installed with Sterling B2B Integrator.
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services Straight Through Extraction service
Application requirements The Visibility Services fact model referenced by this service (and the translation map, if used), must be checked in to Sterling B2B Integrator before running the business process.
Initiates business processes? Cannot initiate a business process.
Invocation From a business process
Business process context considerations You must supply the name of the fact model and the mapped extraction element.
Returned status values Returned status values:
  • Success – The service gets the required parameters and sends event successfully.
  • Error – Failed to process the data, the required parameters do not exist.
Restrictions None
Testing considerations Ensure that the Visibility Services listeners are running. See About Event Listeners for more information.

How the Mapped Extraction Service Works

  1. At run time, the Mapped Extraction service fires a mapped extraction event (Event Schema key: “BI.Event.Mapped”), using the specified mapped extraction name and fact model name.
  2. The primary document object ID is sent in the same event.
  3. The Visibility Services mapped extraction event listener picks up the event, translates the primary document, and puts data into the fact repository.

Using Pass Through Mode

If you are not translating the data as part of the extraction, you can specify “passThrough” as the mapped extraction name in the fact model. Your data must comply with the format of the fact model schema (factmodelname.xsd). See Extracting Data for more information about using passThrough.

Implementing the Mapped Extraction Service

Use the supplied configuration of the service, MappedExtractionService, in your business processes.

The only configuration required for the service is specifying the fact model and mapped extraction to be used for your business process. You specify these parameters in the GPM.

Field Description
Config Select the name of the service configuration from the list. You can use the supplied configuration, MappedExtractionService.
factmodel Enter the name of the fact model that contains the mapped extraction element from the previous field. Required. Case sensitive. The name must be entered exactly as it appears in the fact model.
mappedextraction Enter the name of the Mapped Extraction element that should be referred to by this business process. Required. Case sensitive. The name must be entered exactly as it appears in the fact model. This is the mapped extraction element that contains the name of the translation map, if using a map in this extraction.

Business Process Example

The following example calls the predefined service MappedExtraction with mapped extraction name and fact model name:

<process name="demoMappedExtraction"> 
 <sequence name="main seq"> 
    <operation name="MappedExtraction"> 
      <participant name="MappedExtraction"/> 
      <output message="MappedExtractionInputMessage"> 
       <assign to="mappedextraction">demoBIMappedExtraction</assign> 
       <assign to="factmodel">BankFactModel</assign> 
       <assign to="." from="*"></assign> 
      <input message="inmsg"> 
       <assign to="." from="*"></assign>