Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide

Transcription

1 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 2018 Dassault Systèmes. Apriso, 3DEXPERIENCE, the Compass logo and the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3D VIA, BIOVIA, NETVIBES, and 3DXCITE are commercial trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the U.S. and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval.

2 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 2 Contents 1 Introduction Definitions Third-Party Software 6 2 Business Integrator Flows Inbound Flows Web Service Flow Process Inbound Document Synchronously HTTP Flow Process Inbound Document Asynchronously Alternate flow Process Inbound Document Asynchronously Inbound Message Processor Flow Process External XML Document Inbound Message Processor Flow Process Flat File Message Inbound Message Processor Flow Process DELMIA Apriso XML Document Outbound Flows Basic Outbound Flow Alternate Flow Process Job Action Type 10 Transaction Data Router Outbound Flow Process Job Action Type 9 SAP Business Connector Adaptor Outbound Flow Job Action Type 12 Web Methods Adapter Outbound Flow Job Action Type 7 Flat File Processor Outbound Flow Job Action Type 11 Transaction History Processor Outbound Sub Flow Transform Internal XML to External XML Outbound Sub Flow Transform Internal to External Flat File Outbound Flow Job Action Type 6 Batch Transaction Persister Outbound Flow Job Action Type 13 Batch Transaction Composer Batch Outbound XML Overview (Enhanced in 9.4 SP1) Assign Batch Mode to XML Message Populate Grouping Criteria Fields Batch Scenarios Trigger a Create Batch XML Event Creation of Batched Message with Aggregated Quantities 22 3 Standard Business Integrator Job Actions Message Processor Job Action Type Transaction Data Router Job Action Type 10 (Changed in 9.3 SP3) Transaction History Processor Job Action Type SAP Business Connector Adapter Job Action Type Web Methods Adapter Job Action Type Batch Transaction Persister Job Action Type Batch Transaction Composer Job Action Type Flat File Processor Job Action Type MSMQ Adapter Job Action Type Apriso Internal Adapter Job Action Type SAP PI Adapter Job Action Type BizTalk Adapter Job Action Type MQ Series Adapter Job Action Type 35 28

3 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide FTP Adapter Job Action Type HTTP Adapter Job Action Type REST Adapter Job Action Type Job Maintenance & Monitoring Screen XML Messages Feature Summary XML Message Editor Suggested Profiles/Filters Synchronization Queues Synchronization Queue Status Screen Manually Disabling a Synchronization Queue Currently Executed Jobs Screen Removing the Top Failure Job Actions in the Synchronization Queue Viewing Unprocessed Job Actions in a Disabled Synchronization Queue Immediate Jobs Immediate Jobs History Feature Summary Suggested Profiles/Filters 37 5 Other Configurations DELMIA Apriso Central Configuration Configuration File Paths Limitation of UNC and HTTP Path Usage SessionContext.PropertyBag Structures Routing Configuration Job Alert Routing Configuration Disable XML Generation Synchronization Queues Synchronization Queue Definition and Job Pools for Inbound Messages Allow Resubmission of Job Action Types Mapping Configuration External System Configuration SAP Business Connector Adapter Web Methods Adapter SAP PI Adapter MSMQ Adapter BizTalk Adapter Flat File Related Settings BI FTP Adapter MQ Series Adapters RFC Adapters BI HTTP Adapter Lync Server Connection REST Adapter Batch Transaction Configuration Incoming Message Monitor Application Configuration 61

4 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 4 6 Schema Repository Schema Repository Documentation 64 7 Extensibility Extension Points for the External Adapter Custom Schemas and Mappings Apriso Schemas Mappings Flat File Mappings Custom Job Action Type 68 8 Configuration Scenarios Conditional Routing Definition Define the Audit Trail for Modified XML Messages Archive of Business Integrator Jobs Invocation of BAPI/RFCs from DELMIA Apriso BAPI/RFC Interface Flow Configure the BAPI/RFC Invocation by Example Routing to a Standard Operation for MQ Series Adapter GetMessageOptions.Routing MSMQ Queue Settings 77 9 Documentation Limitations Frequently Asked Questions Configuration FAQ Job Scheduler FAQ Job Executor FAQ References 87 Figures Figure 1 Synchronous inbound flow diagram 8 Figure 2 Asynchronous inbound flow diagram 10 Figure 3 Outbound flow diagram 13 Figure 4 Batch outbound XML flow 17 Figure 5 Using the Aggregate Sum function in MapForce Figure 6 An aggregated XML with the PropertyBagV2 populated and aggregated quantity 23 Figure 7 Job Scheduler Monitoring and Maintenance screen XML Messages screen 31 Figure 8 The Job Scheduler Monitoring and Maintenance screen XML Message Editor 32 Figure 9 View/Maintain Synchronization Queue 34 Figure 10 Manual disabling of a Synchronization Queue 35 Figure 11 A job action in the Waiting status when the Synchronization Queue is disabled 35 Figure 12 Immediate Jobs screen feature summary 36 Figure 13 Immediate Jobs History screen 37 Figure 14 Business Integrator configurations in DEMIA Apriso Central Configuration 39

5 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 5 Figure 15 Routing configuration XML 45 Figure 16 DELMIA Apriso Configuration Manager Job Alert 46 Figure 17 DELMIA Apriso Configuration Manager Routing Configurations Editor 48 Figure 18 DELMIA Apriso Configuration Manager Disable XML Generation 49 Figure 19 DELMIA Apriso Configuration Manager Synchronization Queue Definitions 51 Figure 20 DELMIA Apriso Configuration Manager Synchronization Queue and Job Pools for Inbound Messages 53 Figure 21 Mapping Configuration XML 54 Figure 22 DELMIA Apriso Configuration Manager Mapping Configuration 56 Figure 23 External system configuration XML 57 Figure 24 Batch transaction configuration XML 61 Figure 25 DELMIA Apriso XML Schema Repository Documentation 65 Figure 26 Private queue settings 78 Figure 27 MSMQ queue properties General tab 79 Figure 28 MSMQ queue properties Security tab 80 Figure 29 Schema documentation options screen 81

6 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 6 1 Introduction The objective of this document is to gather all of the information required to configure DELMIA Apriso Business Integrator. The knowledge included in this document should allow the Integrator to modify the standard installed DELMIA Apriso configuration to custom configuration requirements. The scope of this document includes DELMIA Apriso Business Integrator architecture diagrams, configurations, and limitations. 1.1 Definitions DELMIA Apriso XML document XML documents that contain the DELMIA Apriso processing attributes that are used by the DELMIA Apriso XML Parser to persist data to the DELMIA Apriso database. DELMIA Apriso Internal XML document XML documents produced by Apriso Business Components. External System XML document XML documents produced by external systems (e.g., SAP produces SAP IDOC XML documents). LTM xmllinguist Translation Mapping (LTM) is created by xmllinguist, which is used to translate flat file strings to XML and vice versa. XSLT Extensible Stylesheet Language Transformations (XSLT) is a markup language used to describe how to process a source XML to result in a new document that can be either XML or HTML. 1.2 Third-Party Software SysOnyx xmllinguist a tool for describing the translation of CSV, a fixed-length flat file stream, to an XML and vice versa For product information, refer to: Altova Mapforce a visual data mapper that can auto-generate custom mapping code in XSLT 1.0/2.0, XQuery, Java, C++ and C# For product information, refer to: Even though Mapforce has flat file mapping, it is not supported by Business Integrator. Altova XML Spy an XML development environment for modeling, editing, debugging, and transforming For product information, refer to:

7 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 7 2 Business Integrator Flows As of FlexNet 9.4, Business Integrator has been upgraded to use Job Executor instead of Job Scheduler as the new background job execution engine. This change will not affect the existing functionality of Business Integrator job actions. Job Executor greatly improves execution throughput, which leads to better performance. For more details on Job Executor, refer to the Background Job Processing Technical Guide. Job action 13 Batch Transaction Composer still requires the use of Job Scheduler. See Outbound Flow Job Action Type 13 Batch Transaction Composer. 2.1 Inbound Flows These are the ways to get external data into DELMIA Apriso using Business Integrator: Web Service the default Web Service URL is To secure the above Web Service, the web.config file should be configured according to the Windows Communication Foundation (WCF) documentation. The IIS security settings can also be used to protect the Web folder containing the Web Service. The user can use SvcConfigEditor.exe (WCF Service Configuration Editor) to update the Message Processor Web.Config. BasicHttpBinding is defined by default. The standard configuration file allows 5MB messages to be downloaded via the Web Service. If the customer wants to increase the message size, reviewing and assessing whether the change affects performance and memory usage is highly recommended. Keep in mind that when both the flat file translation and XSLT mapping are required, a message will be processed in memory and all of the database operations will be done in one database transaction. The processing can also include invoking a Standard Operation synchronously. There are the following methods for Web Service: ProcessMessage method processes the incoming flat file message or XML message and then creates a finished job with the Processed status This finished job records the outcome from processing the XML document It returns True if the process and creation of the finished job are successful

8 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 8 ProcessMessageASync method creates a job with the job action Message Processor for asynchronous processing and returns True if the job is created successfully ProcessMessage_v2 method has the same functionality as ProcessMessage, but it returns a SOAP fault exception when an error is encountered instead of returning a bool response with an error in the payload ProcessMessageASync_v2 method has the same functionality as ProcessMessageASync, but it returns a SOAP fault exception when an error is encountered instead of returning a bool response with an error in the payload DELMIA Apriso Adapter 2:Invokes 12 :Creates <<Job Type>> Business Integrator DELMIA Apriso Message Processor Web Service DELMIA Apriso XML Document Flat File Document External System Document 1: Invokes XmlTransformer40 Inbound Message Processor 3 :Invokes 4 :Invokes InternalXMLParser Mapping Configuration xml 5 : Invokes <<Job Action>> Message Processor 1. Job Status = Finished 2. Job Action History with Outcome returned by InternalXMLParser Integration Broker 7 : Submits Event 10 : Invokes 0:Initiates Background Job Processing WorkFlowProcessor.SubmitMessage DAC 6 : Persists DELMIA Apriso Operational Database 8 : Publishes Event 11 : Creates Invoke Standard Operation Sync ERP System Space Server 9 :Subscribes Event <<Job Type>> Business Integrator Asynchronous (Separate DB Transaction) Process Determination Agent... Another Interested Agent <<Job Action>> Invoke Standard Operation Figure 1 Synchronous inbound flow diagram HTTP The default http URL is: When this URL is invoked, the message is read through the HTTP request stream and a new job with the job action Message Processor is created for the message The IIS security settings can also be used to protect the ReceiveXML Web folder. MSMQ Apriso Incoming Message Monitor is a Windows service that can be configured to poll messages from a local inbound MSMQ A new job with the job action Message Processor is created for each message taken out of the queue This service is developed for backward compatibility with previous versions of DELMIA Apriso For configuration information, refer to MSMQ Adapter and 5.6 Incoming Message Monitor Application Configuration

9 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 9 File directory Apriso Incoming Message Monitor is a Windows service that can be configured to poll messages from a local file system directory A new job with the job action Message Processor is created for each message taken from the file directory Refer to Flat File Related Settings and 5.6 Incoming Message Monitor Application Configuration for configuration information MQ Series Incoming Message Monitor is a Windows service that can be configured to poll messages from a MQ series download queue. A new job with the job action Message Processor is created for each message taken out of the queue. For configuration information, refer to MQ Series Adapters and 5.6 Incoming Message Monitor Application Configuration. The DELMIA Apriso applications for HTTP, MSMQ, and file can optionally be enabled for synchronous processing, which means that the message is processed first by one of these applications and then a finished job is created for history. This feature is designed to control the amount of jobs created by XML Manager and to provide a mechanism for sharing the loads with Job Executor. The drawback is that these applications are single-threaded, which means only one message is processed at a time. For HTTP, use this new URL: To avoid a timeout error, the HTTP timeout setting from the Integration Broker application, which invokes the above URL, should be increased to provide sufficient time for processing the message. With SAP Business Connector, the default value for the timeout parameter is 300 sec, but this can be increased further if required. The timeout value is set in SAP Business Connector (go to the SAP Business Connector Administration UI and then: Settings Resources Edit Resource Settings Outbound HTTP Settings Timeout). For MSMQ and file, synchronous processing is configurable through the application configuration file (<application Name>.exe.config).

10 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide MSMQ Incoming Message Monitor (HF2) 3. File Incoming Message Monitor (HF5) DELMIA Apriso XML Document Flat File Document External System Document DELMIA Apriso Asych Adapter 1: Invokes 3 :Commits BC Transaction 2b : Invokes Flag to switch between Sync and Async processing (HF5) 5 :Invokes 2 :Creates Mapping Configuration xml Inbound Message Processor 6 :Invokes <<Job Type>> Business Integrator 4 :Invokes <<Job Action>> Message Processor XmlTransformer40 InternalXMLParser 7 : Invokes Integration Broker 9 :Submits Event External System XML Document 0:Initiates Background Job Processing WorkFlowProcessor.SubmitMessage 13 :Creates 12 :Invokes DAC 8 : Persists DELMIA Apriso Operational Database 10 : Publishes Event Invoke Standard Operation Sync ERP System Process Determination Agent Space Server 11 :Subscribes Event... Another Interested Agent Figure 2 Asynchronous inbound flow diagram <<Job Type>> Business Integrator Asynchronous (Separate DB Transaction) <<Job Action>> Invoke Standard Operation File directory (development application) FlexNet Process Explosion Emulator as a Windows service was retired as of FlexNet 9.3. As a replacement, use the Incoming Message Monitor Service Web Service Flow Process Inbound Document Synchronously 1 The external system via the Integration Broker invokes the DELMIA Apriso Web Service with a flat file document or an XML document (steps 0 1). 2 The system persists the message and the outcome returned by the Inbound Message Processor by creating a finished job (Figure 1, step 12). 3 The system invokes the Business Integrator Inbound Message Processor (described in Inbound Message Processor Flow Process External XML Document through Inbound Message Processor Flow Process DELMIA Apriso XML Document) in order to process the document (Figure 1, steps 3 11). 4 The system returns a Success acknowledgment to the caller HTTP Flow Process Inbound Document Asynchronously 1 The external system via the Integration Broker invokes FlexNet Receive.aspx (Figure 2, steps 0 1). 2 The system persists the message and creates a new job with job action type 8 Message Processor (Figure 1, step 2 3). 3 The system returns a Success acknowledgment to the caller.

11 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Alternate flow Process Inbound Document Asynchronously 1 Continues from HTTP Flow Process Inbound Document Asynchronously, step 2. 2 The Job Executor invokes job action type 8 Message Processor, which invokes the Inbound Message Processor (described in Inbound Message Processor Flow Process External XML Document through Inbound Message Processor Flow Process DELMIA Apriso XML Document) in order to process the document (Figure 2, steps 5 13). 3 The Job Executor records the outcome returned by the Inbound Message Processor. 4 The Job Executor updates the job status to Finished Inbound Message Processor Flow Process External XML Document 1 Continues from: a Web Service Flow Process Inbound Document Synchronously, step 1. b Alternate flow Process Inbound Document Asynchronously, step 2. 2 The Inbound Message Processor determines that the input data is an XML document and extracts the name of the root node from the XML document as the From Schema Name. 3 The Inbound Message Processor retrieves the mapping definition defined for the From Schema Name in the mapping configuration. a The required mapping definition includes FromSchema, XsltFileName, and ToSchema. 4 The Inbound Message Processor determines that the XML document is not a DELMIA Apriso XML document and transforms the external XML message to a DELMIA Apriso XML using the XSLT file defined in the mapping definition (Figure 1, step 3 or Figure 2, step 5). 5 The Inbound Message Processor invokes the Internal XML Parser to persist the DELMIA Apriso XML to the DELMIA Apriso database by invoking the DELMIA Apriso DAL in order to invoke the Standard Operation synchronously and/or the Standard Operation asynchronously by the created job (Figure 1, steps 4 11 or Figure 2, steps 6 13). 6 The Inbound Message Processor returns a Success outcome Inbound Message Processor Flow Process Flat File Message 1 Continues from: a Web Service Flow Process Inbound Document Synchronously, step 1. b Alternate flow Process Inbound Document Asynchronously, step 2. 2 The Inbound Message Processor determines that the input data is not an XML message and extracts the first 10 characters of the flat file string as the From Schema Name. 3 The Inbound Message Processor retrieves the mapping definition defined for the From Schema Name in the mapping configuration. a The required mapping definition includes FromSchema, LTMTranslationFile, LTMDirection, LTMOutputSchema, XsltFileName, and ToSchema. 4 The Inbound Message Processor translates the flat file formatted data to XML using the LTM file defined in the mapping definition.

12 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 12 5 The Inbound Message Processor transforms the flat file XML to a DELMIA Apriso XML using the XSLT file defined in the mapping definition (Figure 1, step 3 or step 5). 6 The Inbound Message Processor invokes the Internal XML Parser to persist the DELMIA Apriso XML to the DELMIA Apriso database by invoking the DELMIA Apriso DAL in order to submit event(s) to the Work Flow Manager as well as to invoke the Standard Operation synchronously and/or the Standard Operation asynchronously by the created job (Figure 1, steps 4 11 or Figure 2, steps 6 13). 7 The Inbound Message Processor returns a Success outcome Inbound Message Processor Flow Process DELMIA Apriso XML Document 1 Continues from: a Web Service Flow Process Inbound Document Synchronously, step 1. b Alternate flow Process Inbound Document Asynchronously, step 2. 2 The Inbound Message Processor determines that the input data is a DELMIA Apriso XML and extracts the first 10 characters of the flat file string as the From Schema Name. 3 The Inbound Message Processor retrieves mapping definition defined for the From Schema Name in the mapping configuration. a The required mapping definition includes ToSchema. 4 The Inbound Message Processor invokes the Internal XML Parser to persist the DELMIA Apriso XML to the DELMIA Apriso database using the DELMIA Apriso DAL to submit event(s) to the Work Flow Manager in order to invoke the Standard Operation synchronously and/or the Standard Operation asynchronously by the created a Job (Figure 1, steps 4 11 or Figure 2, steps 6 13). 5 The Inbound Message Processor returns a Success outcome. 2.2 Outbound Flows The outbound flows are always triggered by invoking Apriso Business Components (BC). The internal XML is generated by the BC and the content of the XML is determined by the BC. For version 9.2, there are two significant enhancements that ease efforts in extending and creating a custom internal XML. They are: The Generate Generic XML section from extra input parameters (for more information, see 7 Extensibility) The generic BC that creates a generic internal XML (for more information, see 7 Extensibility) For version 9.2 HotFix 1 and HotFix 2, the following features were added to improve the performance by reducing the volume of jobs created by Business Integrator: Disable XML generation The user can configure which transactions to be disabled in the generation of an internal XML In the routing configuration, list one or more fully qualified Business Facade method names (e.g., FlexNet.BusinessFacade.Common.Tasks) to be disabled Disable all Business Component XML validation

13 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 13 This feature disables XML validation for all internal XMLs DELMIA Apriso User ERP System 0:Initiates DELMIA Apriso Portal Application Server 1 : Invokes A DELMIA Apriso Business Component TransactionData.Composer AF1-1 : Aborts/Rollback Transaction AF2-1 : Aborts/Rollback Transaction 2 : Gets Unique Transaction Sequence Number SequenceNumberProvider DELMIA Apriso Internal XML Document Routing Configuration xml 3b : Creates 3a : Inserts 9b : Create Job Sends To External System Integration Broker Synchronous Invocation of Web Service 5e : Send 5d : Send <<Job Type>> Business Integrator HF4 enhancement <<Job Action>> TransactionHistoryProcessor <<Job Action>> BatchTransactionPersister <<FIFO Job Action>> WebMethodAdapter 6: Inserts 7: Inserts 8 : Reads Transaction_Data_Queue Transaction_History Tables Transaction_Data_Batch_Process DELMIA Apriso Operational Database 9a : Inserts Reads 5f : Send <<FIFO Job Action>> BizTalkAdapter <<Job Type>> Business Integrator Recurring Job Reads File System Synchronous Communication via HTTP 5c : Send <<FIFO Job Action>> SAPBCAdapter <<FIFO Job Action>> FlatFileProcessor 4 : Creates <<FIFO Job Action>> BatchTranactionComposer <<Job Type>> Business Integrator 9b : Creates MSMQ 5g : Send <<FIFO Job Action>> MSMQ Adapter <<Job Action>> TransactionDataRouter Routing Configuration xml Figure 3 Outbound flow diagram Basic Outbound Flow 1 The user invokes a DELMIA Apriso Business Component (BC) (Figure 3, step 0). 2 The DELMIA Apriso BC performs the business logic functionality. 3 The DELMIA Apriso BC invokes the Transaction Data Composer (Figure 3, step 1): a Gets a unique sequence number from the Sequence Provider (Figure 3, step 2). b Generates an internal XML and validates it against the XSD schema. 4 The DELMIA Apriso BC persists the internal XML and creates a new job with one or more job action types as defined in the Routing Configuration XML (Figure 3, steps 3a 3b). 5 The DELMIA Apriso BC returns a Success outcome to the caller Alternate Flow Process Job Action Type 10 Transaction Data Router 1 Continues from Outbound Flow Job Action Type 13 Batch Transaction Composer, step 3. 2 The Job Executor invokes job action type 10 Transaction Data Router. 3 The Transaction Data Router retrieves the route definition for the internal XML from the routing configuration.

14 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 14 a The required route definition includes RouteTo. 4 The Transaction Data Router creates one or more jobs. Each job corresponds to a target destination specified in the RouteTo (described in Outbound Flow Process Job Action Type 9 SAP Business Connector Adaptor through Outbound Flow Job Action Type 7 Flat File Processor). 5 The Job Executor records the outcome returned by the Transaction Data Router. 6 The Job Executor updates the job status to Finished Outbound Flow Process Job Action Type 9 SAP Business Connector Adaptor 1 The Job Executor invokes job action type 9 SAP Business Connector Adaptor. 2 The SAP Business Connector Adapter transforms an internal XML into an external XML (described in Outbound Sub Flow Transform Internal XML to External XML). 3 The SAP Business Connector Adapter retrieves a new TID from the SAP Business Connector and persists the TID with the corresponding unique transaction number from the internal XML to the DELMIA Apriso TID table. 4 The SAP Business Connector Adapter sends the external XML to the SAP Business Connector. 5 The SAP Business Connector Adapter receives a Success acknowledgement. 6 The SAP Business Connector Adapter confirms the TID against the SAP Business Connector. 7 The SAP Business Connector Adapter receives a Success acknowledgment and updates the DELMIA Apriso TID record with the same TID to confirm the status. 8 The Job Executor records the outcome returned by the SAP Business Connector Adapter. 9 The Job Executor updates the job status to Finished Outbound Flow Job Action Type 12 Web Methods Adapter 1 The Job Executor invokes job action type 12 Web Methods Adaptor. 2 The Web Methods Adaptor transforms an internal XML to an external XML (described in Outbound Sub Flow Transform Internal XML to External XML). 3 The Web Methods Adaptor invokes Web service with the external XML. 4 The Web Methods Adapter receives a Success acknowledgement. 5 The Job Executor records the outcome returned by the Web Methods Adapter. 6 The Job Executor updates the job status to Finished Outbound Flow Job Action Type 7 Flat File Processor 1 The Job Executor starts a new transaction and invokes job action type 12 Web Methods Adaptor. 2 The Flat File Processor invokes the transformed internal XML to the external flat file (described in Outbound Sub Flow Transform Internal to External Flat File). 3 The Flat File Processor generates a new unique file name using the Sequence Provider. 4 The Flat File Processor retrieves the mapping definition from the mapping configuration.

15 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 15 a The required mapping definition includes TargetDirectories. 5 The Flat File Processor writes the flat file message with new file name to the target directories. 6 The Job Executor records the outcome returned by the Flat File Processor Adaptor. 7 The Job Executor updates the job status to Finished Outbound Flow Job Action Type 11 Transaction History Processor 1 The Job Executor invokes job action type 11 Transaction History Processor. 2 The Transaction History Processor extracts the name of the root node from the XML document as the transaction name. 3 The Transaction History Processor retrieves the mapping definition using the transaction name. The transaction history mapping definitions are not defined in the configuration file. Instead, they have the following naming patterns: FromSchemaName = transaction name FlexNet.BusinessFacade XsltFileName = TH/map_" + transaction name + "_TH.xslt ToSchema = TH/FlexNet_TransactionHistory.xsd 4 The Transaction History Processor transforms the internal XML into a DELMIA Apriso Transaction History XML using the XSLT specified by XsltFileName. 5 The Transaction History Processor persists the DELMIA Apriso Transaction History XML to the DELMIA Apriso database by invoking the DELMIA Apriso DAL. 6 The Job Executor records the outcome returned by the Transaction History Processor. 7 The Job Executor updates the job status to Finished Outbound Sub Flow Transform Internal XML to External XML 1 The system extracts the name of the root node from the internal XML as the From Schema Name. 2 The system retrieves the mapping definition defined for the From Schema Name from the mapping configuration. 3 The required mapping definition includes FromSchema, XsltFileName, and ToSchema. 4 The system transforms the internal XML into an external XML using the XSLT specified by XsltFileName. 5 The system returns the external XML to the caller Outbound Sub Flow Transform Internal to External Flat File 1 The system extracts the name of the root node from the internal XML as the From Schema Name. 2 The system retrieves the mapping definition defined for the From Schema Name from the mapping configuration. 3 The required mapping definition includes FromSchema, LTMTranslationFile, LTMDirection, LTMOutputSchema, XsltFileName, and ToSchema. 4 The system transforms the internal XML into an external flat file XML using the XSLT specified by XsltFileName.

16 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 16 5 The system translates the external flat file XML to an external flat file using the translation file specified by LTMTranslationFile. 6 The system returns the external flat file to the caller Outbound Flow Job Action Type 6 Batch Transaction Persister 1 The Job Executor invokes job action type 6 Batch Transaction Persister. 2 The Batch Transaction Persister maps and inserts the data in the XML and a copy of the original XML into the TRANSACTION_DATA_BATCH_PROCESS table according to the batch transaction configuration XML. 3 The Batch Transaction Persister returns a Success acknowledgement to Job Scheduler. 4 The Job Executor records the outcome returned. 5 The Job Executor updates the job status to Finished Outbound Flow Job Action Type 13 Batch Transaction Composer 1 The Job Scheduler invokes the Batch Composer recurring job with job action type 13 Batch Transaction Composer. 2 The Batch Transaction Composer retrieves records with similar criteria such as same Transaction Name, Transaction Code, WipOrderNo, and ProductNo from the TRANSACTION_DATA_BATCH_PROCESS table and composes a new batched XML with the original XMLs as child elements. 3 The Batch Transaction Composer persists the batched XML and creates a new job with job action type 10 Transaction Data Router (Figure 3, steps 9a 9b). 4 The Batch Transaction Composer returns a Success acknowledgement to Job Scheduler. 5 Job Scheduler records the outcome returned. 6 Job Scheduler updates the job status to Finished.

17 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Batch Outbound XML Overview (Enhanced in 9.4 SP1) Batching Step 2 Compose Batch Transaction BC generates Internal XML Need Batching Yes Transaction_Data_Batch_Process Select XML(s) with same criteria and generate one batched XML Batched XML Aggregate XMLs to one XML using XSLT Optional step to Aggregated XML Batching Step 1 Persist Batch Transaction Aggregated XML Figure 4 Batch outbound XML flow Batching outbound XML messages is achieved in two steps. 1 Determine what XML messages require batching and store the XML messages that need batching in the staging table called TRANSACTION_DATA_BATCH_PROCESS. A new record is created in the staging table for each message. These records will have a copy of the original XML, which will be added to the batched XML, and other information extracted from the XML into a set of predefined fields such as WipOrderNo and ProductNo as well as up to ten GroupingCriteria fields. This information will be used to determine which messages can be grouped together in same batched XML. 2 Select one or more records from the staging table that have the same batching criteria and create one new batched XML with the original XMLs from the selected records. The new batched XML is given a new root node, and the root node name is the transaction name plus the suffix _Batch. As a child to this new node, a new SessionContext section is added with the current time stamp and a new unique sequence number called TransactionGUID. Under the SessionContext section, one or more internal XMLs stored in the OriginalMessage field in the TRANSACTION_DATA_BATCH_PROCESS with the same batching criteria are added in sequence. Then a new JE job with job action 10 Transaction Data Router is created for the batched XML. The Transaction Data Router is to route this batched XML to another job action that delivers it to the external system. Also, in this step, an aggregated XML can be created by applying mapping that can transform the batched XML to a single aggregated XML Assign Batch Mode to XML Message Each message added to the TRANSACTION_DATA_BATCH_PROCESS staging table is assigned a batch mode. This will determine the strategy to be used to batch messages.

18 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 18 Batch Mode 1 Dependent and Sequential Batching Assigned to messages that must be batched in the same sequence as they occurred Batch Mode 2 Same Transaction Batching Order of Transactions Do Not Matter Assigned to messages that can be matched by similar grouping criteria Populate Grouping Criteria Fields Besides the batch mode, other predefined and grouping criteria fields in the staging table are populated depending on the configuration defined in XMLManager_BatchTransactionConfiguration.xml. In this configuration file, the user can specify the XPath to extract the value from the XML and persist it in a field in the staging table. For more information, refer to REST Adapter Use the REST Adapter section in the DELMIA Apriso Configuration Manager to define the settings for the REST Adapter (job action type 39). For more information on the BI-REST Adapter tab, refer to the Configuration Manager Online Help. Batch Transaction Configuration Batch Scenarios The following sections describe the possible batch scenarios that are currently supported. As part of the second step of batching, these scenarios describe how to select messages from the staging table in order to create the desire batched XML. In all of the batch scenarios, messages can only by batched if they have the same Transaction Name and Transaction Code. Batch Mode 1 Dependent and Sequential Batching 1 Select records from the staging table that have a batch mode of 1 or null, then order these records by ascending ID so that they will be in the sequence in which they were created. 2 Create a new batch XML with a root node equal to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and finally, add the first message to it. 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: The same TransactionName and TransactionCode and one of the following is true: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if WipOrderNo is not specified Both ProductNo and WipOrderNo are not specified 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until the next record has one of the following criteria: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if ProductNo is specified 7 Delete all of the records from the staging table that had been batched.

19 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 19 Job action type 13 Batch Transaction Composer is implemented with this scenario. The following is an example of batching with Batch Mode 1 Dependent and Sequential Batching. Given the following data with batch mode 1 in the staging table: Msg OriginalXML TransactionName TransactionCode WipOrderNo WipOrderType 1 <Move> Move INVMOVE MyOrder 1 2 <Move> Move INVMOVE MyOrder 1 3 <Adjust> Adjust INVDEC MyOrder 1 4 <Move> Move INVMOVE MyOrder 1 Batch results: Batch XML with Msg 1 and 2 Batch XML with Msg 3 Batch XML with Msg 4 Batch Mode 1 with BatchedMessageID 1 Select records from the staging table with a user-specified BatchedMessageID and a batch mode of 1 or null, then order these records by ascending ID so that they will be in the sequence in which they were created. 2 Create a new batch XML with a root node equal to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and finally, add the first message to it. 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: The same TransactionName and TransactionCode and one of the following is true: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if WipOrderNo is not specified Both ProductNo and WipOrderNo are not specified 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until the next record has one of the following criteria: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if ProductNo is specified 7 Delete all of the records from the staging table that had been batched. Batch Mode 1 with TransactionName and TransactionCode 1 Select records from the staging table with a user-specified Transaction Name and Transaction Code as well as a batch mode of 1 or null, then order these records by ascending ID so that they will be in the sequence in which they were created. 2 Create a new batch XML with a root node equal to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and finally, add the first message to it.

20 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 20 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: Same TransactionName and TransactionCode and one of the following is true: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if WipOrderNo is not specified Both ProductNo and WipOrderNo are not specified 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until the next record has one of the following criteria: Same WipOrderNo and Same WipOrderType only if WipOrderNo is specified Same ProductNo only if ProductNo is specified 7 Delete all of the records from the staging table that had been batched. Batch Mode 2 Same Transaction Batching Order of Transactions Do Not Matter 1 Select records from the staging table that have a batch mode of 2, then order the records by TransactionName, TransactionCode, and all of the GroupingCriteria fields so that they are grouped by similar criteria. 2 Creates a new batch XML with root node equals to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and finally, add the first message to it. 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: Same TransactionName and TransactionCode and all Grouping Criteria fields 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until a mismatch occurs. 7 Delete all of the records from the staging table that had been batched. The following is an example of batching with Batch Mode 2 Same Transaction Batching. Given the following data with Batch Mode 2 in the staging table: Msg OriginalXML TransactionName TransactionCode GroupingCriteria1 GroupingCriteria2 1 <Move> Move INVMOVE MyOrder 1 2 <Move> Move INVMOVE MyOrder 1 3 <Adjust> Adjust INVDEC MyOrder 1 4 <Move> Move INVMOVE MyOrder 1 Batch Results: Batch XML with Msg 1, 2, and 4 Batch XML with Msg 3

21 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 21 Batch Mode 2 for a Specified BatchedMessageID 1 Select records from the staging table with a user-specified BatchedMessageID and a batch mode of 2, then order the records by TransactionName, TransactionCode, and all of the GroupingCriteria fields so that they are grouped by similar criteria. 2 Create a new batch XML with a root node equal to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and add the first message to it. 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: Same TransactionName and TransactionCode and all Grouping Criteria fields 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until a mismatch occurs. 7 Delete all of the records from the staging table that had been batched. Batch Mode 2 for a Specified TransactionName and TransactionCode 1 Select records from the staging table with a user-specified TransactionName and TransactionCode and a batch mode of 2, then order the records by TransactionName, TransactionCode, and all of the GroupingCriteria fields so that they are grouped by similar criteria. 2 Create a new batch XML with a root node equal to TransactionName + _Batch, add a new session context with a new Transaction Date and TransactionGUID, and add the first message to it. 3 Read the subsequent message and determine if it matches the first message with the following criteria, and if it does, append the message to the batch XML: Same TransactionName and TransactionCode and all Grouping Criteria fields 4 Repeat step 3 until it cannot match the next record with the same criteria. 5 Create a new job for the batch XML. 6 Repeat steps 2 5 until a mismatch occurs. 7 Delete all of the records from the staging table that had been batched Trigger a Create Batch XML Event There are two ways to trigger a create batch XML event: 1 Batching can occur on a recurring schedule. For example, batch the available messages in the staging table every 5 minutes. This is achieved by creating a recurring Job Scheduler job with a job schedule to execute every 5 minutes. The following are the job actions that can be used to trigger the create batch XML event: For Batch Mode 1 use job action 13 Compose Batch Transaction Otherwise, use job action 15 Invoke Business Component, which invokes the CreateBatchXML Business Facade method with various combinations of input parameters For details, refer to the Business Components Documentation (Common Utility).

22 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 22 2 Batching on demand. For example, the create batch XML event is triggered at the end of the Standard Operation. This is achieved by calling the CreateBatchXML Business Facade method from the Standard Operation. For details, refer to the Business Components Documentation (Common Utility) Creation of Batched Message with Aggregated Quantities The main technique is to map the batched XML back to a single XML by copying the data from the first original XML in the batch except for the quantity field, which will contain the aggregated sum of all of the quantities. For this reason, the batched XML message must contain the original XMLs that have common entities. For example, you want to send one message to an external system with one aggregated received quantity for a container that is for the same order number, order type, and product. If you have a batch XML with different products and the aggregated XML only reflects the first product, the quantity will be incorrect. The single XML can be the original XML schema before batching or it can be a new XML schema. The benefit for using the original XML schema is that there is no new schema to maintain. In an initial effort to show how this works, the aggregated XML mappings had been created to map: FlexNet.BusinessFacade.Inventory.InventoryMoveController.Move_Batch (Move_Batch) to FlexNet.BusinessFacade.Inventory.InventoryMoveController.Move (Move), and FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust_Batch (Adjust_Batch) to FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust (Adjust Refer to the Mapforce project map_inventory_adjust_batch_adjust_aggr.mfd and map_inventory_move_batch_move_aggr.mfd, which can be found in SchemaRepository\Designs\Mapforce\External. The Aggregated Sum function is available from Mapforce 2008.

23 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 23 Figure 5 Using the Aggregate Sum function in MapForce 2008 Best Practice for Mapping to an Aggregated XML Figure 6 An aggregated XML with the PropertyBagV2 populated and aggregated quantity

24 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 24 1 Add the constant value Aggregated in the PropertyBag with the name Aggregated to identify that this is an aggregated message. This is useful for distinguishing between a single message and an aggregated message that uses the same XML schema. 2 For traceability, map all original TransactionGUID to the PropertyBag with the name TransactionGUID so that you can trace back the original XML in the batch. 3 Also for traceability, map all of the data that will be lost after the aggregation to the PropertyBag. For example, Move, Adjust, and all of the containers and in-containers are mapped to the PropertyBag.

25 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 25 3 Standard Business Integrator Job Actions The following sections list the job actions used by Business Integrator and describes the functionality and responsibility of each Message Processor Job Action Type 8 Message Processor is designed for inbound traffic. The Message Processor can process messages that are external system XML, DELMIA Apriso XML, and flat file documents. The source document along with the mapping definition in the mapping configuration, as discussed in 5.3 Mapping Configuration, dictates the actions to be performed. If the mapping definition is not found, the Message Processor treats the inbound XML as a DELMIA Apriso XML and tries to persist it to the DELMIA Apriso database. If no operation is performed, an error message is returned Transaction Data Router Job Action Type 10 (Changed in 9.3 SP3) The Transaction Data Router is responsible for routing an internal XML to various destinations. When the Transaction Data Router is invoked, it reads the binary message from the DELMIA Apriso TRANSACTION_DATA_QUEUE table and serializes the binary message into a XML message. The XML message is persisted and the binary message is deleted in the TRANSACTION_DATA_QUEUE table. Then the XML message is validated against its schema. Finally, the message is routed by creating one job with one or more job actions. Each job action is a destination and is configured based on the routing definition in the routing configuration discussed in SessionContext.PropertyBag Structures. When a route is not defined, a new job will not be created Transaction History Processor Job Action Type 11 The Transaction History Processor is responsible for transforming an internal XML into a transaction history (TH) XML and persisting the TH XML to the DELMIA Apriso TH tables. A mapping definition for the TH is not required. The default TH mapping name, TH schema, and schema repository location are used. The naming convention for TH mapping is: map_<transaction Name without prefix FlexNet.BusinessFacade >_TH.xslt SAP Business Connector Adapter Job Action Type 9 The SAP Business Connector is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via the SAP Business Connector Integration Broker. The mapping configuration defines the mapping information required for this transformation. The SAP Business Connector Adapter also handles the TID management required by the SAP interface to guarantee that a message is sent only once. The TID number, generated by

26 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 26 SAP and TransactionGUID, is a unique number assigned to the internal XML and stored in the TID table with the Delivery status. When the message is successfully sent to the SAP Business Connector, the status in the TID is updated to Confirm. With the Confirm status, the internal XML with the same TransactionGUID cannot be sent again. This adapter must use Synchronization Queues, which tell Job Scheduler to process these messages one at a time in the FIFO sequence. The SAP Business Connector Adapter provides an extension point for altering the standard communication mechanism with the SAP Business Connector (for details, see 7 Extensibility). From FlexNet 9.3 SP3, the SAP BC Adapter has been enhanced to support invocation of BAPI and RFC. For details, see 8.4 Invocation of BAPI/RFCs from DELMIA Apriso) Web Methods Adapter Job Action Type 12 The Web Method Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via Web Service to the Web Methods Integration Broker. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The Web Method Adapter provides an extension point for altering the standard communication mechanism with the Web Method (for details, see 7 Extensibility) Batch Transaction Persister Job Action Type 6 Due to external system limitations such as SAP, the Batch Transaction Persister and Batch Transaction Composer are developed to group multiple internal XMLs together as one batched XML. This batching method reduces the database-locking problem encountered in SAP when similar information is processed by SAP. The routing configuration needs to be modified to identify which internal XML required batching. The default routings for Inventory Move and Inventory Adjust, which required batching, can be loaded by clicking the Load Default Route for SAP Business Connector button in DELMIA Apriso Configuration Manager (for details, see SessionContext.PropertyBag Structures). The Batch Transaction Persister is the first part of the two-step batching process. The Batch Transaction Persister stores the internal XML and the field values from the interval XML that are to be used for grouping in the DELMIA Apriso TRANSACTION_DATA_BATCH_PROCESS table. The Xpath to the fields in the internal XML are defined in the batch transaction configuration (for details, see 5.5 Batch Transaction Configuration) Batch Transaction Composer Job Action Type 13 The Batch Transaction Composer is the second part of the two-step batching process. A user job with job action 13 Batch Transaction Composer is to be defined using the Job Scheduler M&M screen. This job should be configured to run at the desired interval at which the batch process will occur.

27 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 27 When the Batch Transaction Composer job action is invoked, it reads the records from the TRANSACTION_DATA_BATCH_PROCESS table in sequence and groups them by matching the same criteria. The following section explains the batching criteria by matching the field values stored in TRANSACTION_DATA_BATCH_PROCESS consecutive records are batched if: 1 TransactionName and TransactionCode are the same and one of the following is true: a Same WipOrderNo only if WipOrderNo is specified. b Same ProductNo only if WipOrderNo is not specified. c Both ProductNo and WipOrderNo are not specified. 2 Step 1 is repeated until it cannot match the next record with the same criteria. 3 A new batch will start by repeating step 1 unless the next record has one of the following criteria a Same WipOrderNo only if WipOrderNo is specified. b Same ProductNo only if ProductNo is specified. The new batched XML is given a new root node, and the root node name is the transaction name plus the suffix _Batch. As a child to this new node, a new SessionContext section is added with the current time stamp, and a new unique sequence number called TransactionGUID. Underneath the SessionContext section, one or more internal XMLs stored in the OriginalMessage field in the TRANSACTION_DATA_BATCH_PROCESS table with the same batching criteria are added in sequence. Then the batched XML document is inserted into the DELMIA Apriso TRANSACTION_DATA_QUEUE table and a new job is created with job action 10 Transaction Data Router. The Transaction Data Router is to route this batched XML to another job action that delivers it to the external system Flat File Processor Job Action Type 7 The Flat File Processor is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via file directories. The mapping configuration file defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead. The mapping configuration also defines the target directories to which the new file will be written. The file name is generated using the FlexNet Sequence Provider with a sequence definition for the sequence name FILE_NAME. The file extension is defined as the suffix of the sequence definition. The Flat File Processor provides an extension point for altering the standard write-to-file method (for details, see 7 Extensibility) MSMQ Adapter Job Action Type 19 The MSMQ Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via MSMQ. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead. The external system configuration defines the outbound MSMQ path in which the message will be sent.

28 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Apriso Internal Adapter Job Action Type 29 This adapter is a Web Service client that invokes the Message Processor Web Service. The Apriso Internal Adapter is designed for data transfers between one or more DELMIA Apriso systems as part of the effort for Center of Excellence (COE). For more information, see COE Data Replication Using Data Extractor BC Technical Guide. In case of a data transfer between FlexNet 9.5 and FlexNet 9.6, the CLIENT table s MessageProcessorURL value should use either the FlexNetMessageProcessor.asmx or FlexNetMessageProcessorInternal.svc URL. The FlexNetMessageProcessor.svc URL should not be used SAP PI Adapter Job Action Type 30 The SAP PI Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to SAP PI via Web Service. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead and transformation is to be performed in the SAP PI. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The SAP PI Adapter provides an extension point for altering the standard communication mechanism with SAP PI (for details, see 7 Extensibility) BizTalk Adapter Job Action Type 31 The BizTalk Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via HTTP to a BizTalk Server. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead and transformation is performed in BizTalk server. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The BizTalk Adapter provides an extension point for altering the standard communication mechanism with BizTalk (for details, see 7 Extensibility) MQ Series Adapter Job Action Type 35 The MQ Series Adapter is responsible for delivering an internal XML to an IBM MQ Series Server. The queue configuration defines the connection properties to the server. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The MQ Series Adapter provides an extension point for altering the standard communication mechanism with MQ Series (for details, see 7 Extensibility).

29 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide FTP Adapter Job Action Type 36 The FTP Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via File Transport Protocol (FTP). The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is written instead. The mapping configuration also defines the subdirectories if required as the target directory. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The FTP Adapter provides an extension point for altering the standard communication mechanism with SAP PI (for details, see 7 Extensibility) HTTP Adapter Job Action Type 37 The HTTP Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system via HTTP Post. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is defined, the internal XML is sent instead and transformation is performed in the external system. The HTTP Adapter can be configured to send the same message to multiple URL destinations. For more information, see Routing Configuration. If delivery of the XML to the external system needs to occur in sequence, the Synchronization Queue should be used. The HTTP Adapter provides an Extension Point for altering the standard communication mechanism (for details, see 7 Extensibility) REST Adapter Job Action Type 39 The REST Adapter is responsible for transforming an internal XML into an external system XML and delivering the external XML to the external system or other Apriso Systems via REST Post. The mapping configuration defines the mapping information required for this transformation. If no mapping definition is specified, the internal XML is sent instead and transformation is performed in the external system. The REST method can be customized by setting the following Business Component Context variables: RELATIVEURI this value will be appended to the REST Client URL URIPARAMETERS this value will be appended at the end of the URL, preceded by "?" For example: REST Client URL: RELATIVEURI: /Customer/Order URIPARAMETERS: Orderid=123 Final URL: You can configure the REST Adapter to send the same message to multiple URL destinations. For more information, see Routing Configuration.

30 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 30 If the delivery of the XML to the external system needs to occur in a sequence, the Synchronization Queue should be used. The REST Adapter provides an Extension Point for altering the standard communication mechanism (for details, see 7 Extensibility).

31 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 31 4 Job Maintenance & Monitoring Screen Since Business Integrator is tightly coupled with jobs, the Business Integrator user interface is part of the Job Monitoring and Maintenance screens. For more information, refer to the Background Job Processing Technical Guide. 4.1 XML Messages * In the Portal, navigate to Job Scheduler and follow the XML Messages link to view and manage the Business Integrator-related messages that have been processed by Job Scheduler. Figure 7 Job Scheduler Monitoring and Maintenance screen XML Messages screen Feature Summary Developed using the Monitoring and Maintenance screen framework, which means that this screen inherits all of the standard Monitoring and Maintenance screen features such as the paging grid, personalization, filters, and many more View and manage all of the messages processed by Business Integrator Change from the 2 Failure to 3 Closed status for one or more grid selections Resubmit one or more grid selections Resubmit the modified XML messages from the detail child screen Count the number of records that meet the filter criteria Resubmit all of the records that meet the filter criteria For definitions of the buttons on the XML Messages list, please refer to: Background Job Processing Technical Guide. * This is only used by Job Scheduler and only exists for backward compatibility reasons.

32 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide XML Message Editor XML Message Editor is used to display XML messages where the user can easily view the messages, inspect the messages in order to determine the root causes of failure, and alter the messages for reprocessing. This editor can display an XML message in different views, such as text view and tree view. In the text view, the pretty-print feature reformats the message with the correct indents and line breaks so that the hierarchical structure of the XML can easily be viewed. In the tree view, the XML message is displayed in a graphical interface that presents a hierarchical view of the nodes. The user can expand and collapse the nodes to better visualize the overall structure of the XML. This control also allow the user to edit the XML and ensure that the edited XML is well-formed so that it can be processed by Business Integrator. This control is available in the Job Execution Detail, Immediate Job, and Immediate Job History screens for Business Integrator jobs where an XML message is part of the job. Figure 8 The Job Scheduler Monitoring and Maintenance screen XML Message Editor The XML Message Editor button definitions: Button Icon Button Name Save to File Reload XML Message Pretty-Print XML Description The XML message in the editor is saved to a file. A dialog box prompts for the file location. Reloads the original XML message without any changes in text view. Formats the XML message by inserting a carriage return at the end of each node and adding a space indentation based on the nested level at the beginning of each node.

33 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 33 Text View Displays the XML message in the text view. Tree View Displays the XML message in the graphical tree view. This button is enabled only if the XML message is validated by clicking the Validate button or if it is checked for correctness by clicking the Check if Well-formed button. Check if Well-formed Verifies the XML correctness. Validate Add Node Delete Selected Node Expand All Nodes Collapse All Nodes Validates the XML. Only available in the tree view. Adds a new node. A dialog is displayed prompting the user for information of the new node. Deletes the selected node (only available in the tree view). Expands all of the nodes in the tree view. Collapses all of the nodes in the tree view. To edit a node name or node value in the tree view, select the desire nodes, and the value will be displayed in the edit box in the bottom of the editor. Click on any node in the tree view to reflect the changes made in the edit box Suggested Profiles/Filters Filter Name All Failures Filter Details Set Last Action Result=2 and sort by the ID column. All Failures for Today Set Last Action Result=2 and CreatedOn >= Begin of Today macro, and sort by the ID column. Outbound Messages Failures Inbound Messages Failures Transaction History Failures Batching Failures 4.2 Synchronization Queues Set Action Type IN (7,9,12,30,31) and Last Action Result=2, and sort by the ID Column. Set Action Type=8 and Last Action Result=2, and sort by the ID Column. Set Action Type=11 and Last Action Result=2, and sort by the ID Column. Set Action Type=6, 13 and Last Action Result=2, and sort by ID Column. The combination of the Synchronization Queue Status, Jobs Currently Executed, and Xml Messages List screens are used to view and maintain the Synchronization Queues. The Synchronization Queue feature is designed to ensure that messages are processed in sequence. Out-of-order processing can cause failures in the external system.

34 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Synchronization Queue Status Screen This screen shows all of the Synchronization Queues that are currently disabled. Figure 9 View/Maintain Synchronization Queue For definitions of the buttons on the Synchronization Queue Status screen, please refer to the Background Job Processing Technical Guide Manually Disabling a Synchronization Queue To manually disable a synchronization queue: 1 Click (Add) on the Synchronization Queues Status screen. 2 Enter the name of the queue to be disabled in the Synchronization Queue field. 3 Enter the date and time at which the queue is to be disabled in the Disable On field. 4 Enter the date and time at which the queue is to be enabled in the Disable Until field, then click Save. This feature should be used when, for example, you know in advance that the target system will be down. Accordingly, you can disable the processing of all messages to this target system for a given duration.

35 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 35 Figure 10 Manual disabling of a Synchronization Queue Currently Executed Jobs Screen This screen shows the jobs that are queued for execution. If the Synchronization Queue is disabled, the job actions for the queue are displayed here with the 0 Waiting status. Until the Synchronization Queue is enabled, the job actions for this same Synchronization Queue will not be executed. Figure 11 A job action in the Waiting status when the Synchronization Queue is disabled For definitions of the buttons on the Jobs Currently Executed screen, please refer to the Background Job Processing Technical Guide Removing the Top Failure Job Actions in the Synchronization Queue When a Synchronization Queue is backed up because of a job action that is failing continuously for some reason, you can remove the failing job action by selection the job action on the Jobs Currently Executed Jobs screen and clicking (Remove) to delete the job action in the Synchronization Queue. This action does not remove the existing history and

36 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 36 status, as it simply removes the job action from execution. You can reprocess this job action on the XML Messages screen Viewing Unprocessed Job Actions in a Disabled Synchronization Queue When a Synchronization Queue is disabled because of a job action that is failing continuously, you can view the list of job actions that have not been executed on the Xml Message List screen by setting the filters for Action Type and Active Result so that they are not equal to 1 (Success) and 3 (Closed). The job action records that have not been executed will have 0 Not Executed as the Action Result, and the Start Time, End Time, and Info Fields will be blank. If you have removed the top failed job from the Synchronization Queue (as documented in Removing the Top Failure Job Actions in the Synchronization Queue), by refreshing the grid with the same filters you should see the number of entries with 0 Not Executed as the Action Result decreased. 4.3 Immediate Jobs In the Portal, navigate to Job Scheduler and follow the Immediate Jobs link to view and manage the Business Integrator-related messages that are to be executed by Job Executor. Figure 12 Immediate Jobs screen feature summary Developed using the Monitoring and Maintenance screen framework, which means that this screen inherits all of the standard Monitoring and Maintenance screen features such as paging grid, personalization, filters, and many more View and manage all of the messages processed by Business Integrator Add and remove an immediate job 4.4 Immediate Jobs History In the Portal, navigate to Job Scheduler and follow the Immediate Jobs History link to view and manage the Business Integrator-related messages that had already been executed by Job Executor.

37 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Feature Summary Figure 13 Immediate Jobs History screen Developed using the Monitoring and Maintenance screen framework, which means that this screen inherits all of the standard Monitoring and Maintenance screen features such as paging grid, personalization, filters, and many more View and manage all of the messages processed by Business Integrator Resubmit one or more grid selections Resubmit or modify XML message from the detail child screen Resubmit all of the records that meet the filter criteria View the related jobs that had been reprocessed Suggested Profiles/Filters Filter Name BI Failed Messages BI Failed Messages Today BI Failed Outbound Messages BI Failed Inbound Messages Custom Filter JQH.result = 2 and JQH.id in (select max(id) from the job_queue_history group by resubmitgroup). JQH.result = 2 and JQH.id in (select max(id) from the job_queue_history group by resubmitgroup) and (JQH.CREATEDDATE >= {BeginOfToday}). JQH.result = 2 and JQH.id in (select max(id) from the job_queue_history group by resubmitgroup) and JQH.ActionTypeID in (7,9,10,12,19,29,30,31). JQH.result = 2 and JQH.id in (select max(id) from the job_queue_history group by resubmitgroup) and JQH.ActionTypeID = 8.

38 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 38 BI Failed Transaction History BI Messages with last result JQH.result = 2 and JQH.id in (select max(id) from the job_queue_history group by resubmitgroup) and JQH.ActionTypeID = 11. JQH.id in (select max(id) from the job_queue_history group by resubmitgroup).

39 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 39 5 Other Configurations Configurations are external settings that affect the overall functionality of the DELMIA Apriso system. A standard installation can only provide default settings. Changes to the standard configuration are required to suit the customer s needs. 5.1 DELMIA Apriso Central Configuration In the Central Configuration file (<drive>\program Files\Dassault Systemes\DELMIA Apriso 2018\WebSite\CentralConfiguration), the <FlexNet.XmlManager> tag denotes the configuration section used by Business Integrator. Like <appsettings>, each add node is a new entry. The key attribute is the name of the entry, and value is the value for the name in the key attribute. The standard installation provides the default settings in the following Central Configuration XML fragment: <FlexNet.XmlManager> <add key="schemarepositoryservername" value="${webrooturl}/" /> <add key="xmlserializerobjectcacheinterval" value="600" /> <add key="mappingconfiguration" value="${websitepath}centralconfiguration\xmlmanager_mappingconfiguration.xm l" /> <add key="routingconfiguration" value="${websitepath}centralconfiguration\xmlmanager_routingconfiguration.xm l" /> <add key="batchtransactionconfiguration" value="${websitepath}centralconfiguration\xmlmanager_batchtransactionconfigu ration.xml" /> <add key="externalsystemconfiguration" value="${websitepath}centralconfiguration\xmlmanager_externalsystemconfigura tion.xml" /> <add key="mqseriesconfiguration" value="${websitepath}centralconfiguration\xmlmanager_mqseriesconfiguration.x ml" /> <add key="httpconfiguration" value="${websitepath}centralconfiguration\xmlmanager_httpconfiguration.xml" /> <add key="jobactiontimeoutfordownloadinseconds" value="300" /> <add key="externalsystemtimezoneid" value="0" /> <add key="externalsystemdefaultlcid" value="0" /> <add key="disableallbusinesscomponentxmlvalidation" value="false" /> <add key="enablepropertybagv2" value="true" /> <add key="enablepropertybagv3" value="false" /> <add key="enablebcxmlserialization" value="false" /> <add key="enablevalidateflatfilexml" value="true" /> </FlexNet.XmlManager> Figure 14 Business Integrator configurations in DEMIA Apriso Central Configuration The following are descriptions of the Business Integrator configuration:

40 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 40 SchemaRepositoryServerName specifies the URL of the Schema Repository server. The value must start with name>/. The installation will update the URL to the name of the DELMIA Apriso server. XmlSerializerObjectCacheInterval the value is the number of minutes that an XmlSerializer object can live in the cache. MappingConfiguration the file location of the mapping configuration file. Supports the UNC and HTTP paths. RoutingConfiguration the file location of the routing configuration file. Supports the UNC and HTTP path. BatchTransactionConfiguration the file location of the batch transaction configuration file. Supports the UNC and HTTP path. ExternalSystemConfiguration the file location of the external system configuration file. Supports the UNC and HTTP path. MqSeriesConfiguration the file location of the MQ series configuration file. HTTPConfiguration the file location of the HTTP configuration file. JobActionTimeOutforUploadinSeconds the job action TimeOut for an upload in seconds. If not specified, the default is 1 minute. It is valid for job actions 6 Batch Transaction Persister, 7 Flat File Processor, 9 SAP BC Adapter, 10 Transaction Data Router, 11 Transaction History Processor, and 12 Web Method Adapter. 19 MSMQ Adapter, 29 FlexNet Internal Adapter, 30 SAP PI 3.0 Adapter, and 31 BizTalk Adapter. JobActionTimeOutforDownloadinSeconds the job action TimeOut for a download in seconds. If not specified, the default is 5 minutes. It is valid for job action 8 Message Processor. ExternalSystemTimeZoneID the external system TimeZoneID. Defaults to 0. If 0, no UTC conversion will be performed. If specified, all date time fields will be converted to UTC on inbound and converted to the local time of the external system on outbound. ExternalSystemDefaultLCID the external system default LCID. Defaults to 0. If 0, the system locale is to be used. If specified, the language ID will be used for all text fields. DisableAllBusinessComponentXMLValidation disables all of Business Component XML validation. Defaults to false. If true, no XML validations will be performed. EnablePropertyBagV2 enables the PropertyBagV2 structure under SessionContext. When set to true, all BC will create PropertyBag data in the PropertyBagV2 structure. When set to false or omitted, all the BCs will create PropertyBag data in the PropertyBag structure. EnablePropertyBagV3 enables the population of PropertyBagV3 with a new EnablePropertyBagV3 attribute. If set to true, PropertyBagV3 will be populated with correlated values that match values of the same index in the array type values. The user can choose to enable either PropertyBagV2 or PropertyBagV3 or both if required. If both are disabled, the first version of PropertyBag will be populated. EnableBCXMLSerialization if set to true, enables Business Component XML serialization instead of binary serialization.

41 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 41 EnableValidateFlatFileXML enables validation of a flat file XML against a flat file schema configured in the mapping configuration. The default value is false Configuration File Paths The file paths of the Business Integrator configuration files can be local, UNC, or HTTP. Additionally, an update of the Business Integrator configuration files does not require the restart of ASP.Net, Job Scheduler, and IncomingMonitorService. This functionality is valid only if UNC paths or local paths are used. If UNC paths are used, the <drive>\program Files\Dassault Systemes\DELMIA Apriso 2018\WebSite\CentralConfiguration directory on the DELMIA Apriso server must be shared with read access. When HTTP paths are used, ASP.Net, Job Scheduler, and IncomingMonitorService must be restarted in order for the changes to take effect. By default, local paths are used in CentralConfiguration.xml. The changes of the Business Integrator configuration paths in Central Configuration require restart in order for the changes to take effect. The following are examples with HTTP paths: <add key="mappingconfiguration" value=" MLManager_MappingConfiguration.xml" /> <add key="routingconfiguration" value=" MLManager_RoutingConfiguration.xml" /> <add key="batchtransactionconfiguration" value=" MLManager_BatchTransactionConfiguration.xml" /> <add key="externalsystemconfiguration" value=" MLManager_ExternalSystemConfiguration.xml" /> <add key="mqseriesconfiguration" value= MLManager_MQSeriesConfiguration.xml" /> <add key="httpconfiguration" value= ConfigurationService.svc?file=XMLManager_HTTPConfiguration.xml" /> The following are examples with UNC paths: <add key="mappingconfiguration" value="\\servername\centralconfiguration\xmlmanager_mappingconfiguration.xml " /> <add key="routingconfiguration" value="\\servername\centralconfiguration\xmlmanager_routingconfiguration.xml " /> <add key="batchtransactionconfiguration" value="\\servername\centralconfiguration\xmlmanager_batchtransactionconfigur ation.xml" /> <add key="externalsystemconfiguration" value="\\servername\centralconfiguration\xmlmanager_externalsystemconfigurat ion.xml" /> <add key="mqseriesconfiguration" value="\\servername\centralconfiguration\xmlmanager_mqseriesconfiguration.xm l" /> <add key="httpconfiguration" value="\\servername\centralconfiguration\xmlmanager_httpconfiguration.xml" />

42 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Limitation of UNC and HTTP Path Usage When UNC and HTTP paths are used to describe the locations of Business Integrator configuration files, DELMIA Apriso Configuration Manager will not be able to save changes. To resolve this, duplicate the configuration file path entries under the XMLManager section from CentralConfiguration.xml to FlexNet.ConfigurationManager.exe.config and change the configuration file paths to local paths. Since the application configuration has precedent over CentralConfiguration, the local paths in FlexNet.ConfigurationManager.exe.config will be used instead of the HTTP path in CentralConfiguration.xml. The following are snippets of the Business Integrator configuration paths in FlexNet.ConfigurationManager.exe.config: <configsections> <section name="flexnet.xmlmanager" type="system.configuration.namevaluesectionhandler,system, Version= , Culture=neutral, PublicKeyToken=b77a5c561934e089, Custom=null" /> </configsections> <FlexNet.XmlManager> <add key="mappingconfiguration" value="${websitepath}centralconfiguration\xmlmanager_mappingconfiguration.xm l" /> <add key="routingconfiguration" value="${websitepath}centralconfiguration\xmlmanager_routingconfiguration.xm l" /> <add key="batchtransactionconfiguration" value="${websitepath}centralconfiguration\xmlmanager_batchtransactionconfigu ration.xml" /> <add key="externalsystemconfiguration" value="${websitepath}centralconfiguration\xmlmanager_externalsystemconfigura tion.xml" /> <add key="mqseriesconfiguration" value="${websitepath}centralconfiguration\xmlmanager_mqseriesconfiguration.x ml" /> <add key="httpconfiguration" value="${websitepath}centralconfiguration\xmlmanager_httpconfiguration.xml" /> </FlexNet.XmlManager> SessionContext.PropertyBag Structures All the XML messages generated by Apriso Business Components have a common Session Context section. Within the Session Context section, different versions of the PropertyBag sections were introduced to allow additional values to be added to the XML without changing the interface of the Business Component and without invalidating the Business Component XML schema. There are three versions of PropertyBag structures. The original PropertyBag writes an array of values by concatenating the values into one comma-separated string into one element. In 9.3 SP3, PropertyBagV2 was introduced, which writes the array of values individually in its own element. In 9.6, PropertyBagV3 was introduced, which correlates the arrays of values and matches values of the same index into a CorrelatedValueSet element. All non-array data type values are written as a name-value item element. The following are samples of the PropertyBag structures: The following is a sample of PropertyBag structure:

43 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 43 <PropertyBag> <Item Name="OrderNo" Value="{OrderNo123}" /> <Item Name="TotalQuantity" Value="{100}" /> <Item Name="OrderLineNo" Value="{1, 2, 3}" /> <Item Name="GoodsQuantity" Value="{50, 25, 25}" /> <Item Name="UOMCode" Value="{EA, EA, EA}" /> </PropertyBag> The following is a sample of PropertyBagV2 structure: <PropertyBagV2> <Item Name="OrderNo"> <ValueList> <Value>OrderNo123</Value> </ValueList> </Item> <Item Name="TotalQuantity"> <ValueList> <Value>100</Value> </ValueList> </Item> <Item Name="OrderLineNo"> <ValueList> <Value>1</Value> <Value>2</Value> <Value>3</Value> </ValueList> </Item> <Item Name="GoodsQuantity"> <ValueList> <Value>50</Value> <Value>25</Value> <Value>25</Value> </ValueList> </Item> <Item Name="UOMCode"> <ValueList> <Value>EA</Value> <Value>EA</Value> <Value>EA</Value> </ValueList> </Item> </PropertyBagV2> The following is a sample of PropertyBagV3 structure: <PropertyBagV3> <Item Name="OrderNo" Value="Order123" /> <Item Name="TotalQuantity" Value="100" /> <CorrelatedValueSet index="1"> <Item Name="OrderLineNo" Value="1" /> <Item Name="GoodsQuantity" Value="50" /> <Item Name="UOMCode" Value="EA" /> </CorrelatedValueSet> <CorrelatedValueSet index="2"> <Item Name="OrderLineNo" Value="2" /> <Item Name="GoodsQuantity" Value="25" /> <Item Name="UOMCode" Value="EA" /> </CorrelatedValueSet> <CorrelatedValueSet index="3"> <Item Name="OrderLineNo" Value="3" /> <Item Name="GoodsQuantity" Value="25" /> <Item Name="UOMCode" Value="EA" /> </CorrelatedValueSet> </PropertyBagV3>

44 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 44 The user can configure which PropertyBag structures to populate. Reference the following table: PropertyBag Structure to Be Populated PropertyBag PropertyBagV2 PropertyBagV3 PropertyBagV2 and PropertyBagV3 5.2 Routing Configuration Attribute(s) to Set EnablePropertyBagV2 = false EnablePropertyBagV3 = false EnablePropertyBagV2 = true EnablePropertyBagV3 = false EnablePropertyBagV2 = false EnablePropertyBagV3 = true EnablePropertyBagV2 = true EnablePropertyBagV3 = true The routing configuration controls the routing of all DELMIA Apriso transactions (outbound only). The configuration file path and name are configurable in Central Configuration. The routing configuration from the standard installation configures all the transactions to be routed to TransactionHistoryProcessor only. Standard routing configurations for SAP integration are loaded by clicking the Load Default Routings for SAP Business Connector button in the DELMIA Apriso Configuration Manager. The following is a sample routing configuration XML: <RoutingConfigurations DefaultRouteTo="TransactionHistoryProcessor" DefaultAlertName="" DefaultBatchMode="2"> <Route FromSchema="FlexNet.BusinessFacade.Labor.LaborMarshall.ReportProduction RouteTo="TransactionHistoryProcessor;SAPBCAdapter"/> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryMoveController.Move" RouteTo="11;6" AlertName="" BatchMode="1" /> <DisableXMLGeneration DisableMode="DisableAll"> <Exceptions> <TransactionName>FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.Wri tetransactionhistory</transactionname> </Exceptions> </DisableXMLGeneration> <SynchronizationQueues DefaultNumberofExecutionAttempts="3" DefaultAttemptSleepDuration="3000"> <QueueDefinition Name="UploadQueue" NumberofExecutionAttempts="5" AttemptSleepDuration="35000" /> </SynchronizationQueues> <NamespaceConversion enable="false" prefix="" /> <InboundMessageQueues DefaultQueueAssignment="DownloadQueue" DefaultNumberofExecutionAttempts="3" DefaultAttemptSleepDuration="300000"> <QueueAssignment FromSchema="FlexNet_TestFIInvocation" SynchronizationQueueName="BOM" NumberofExecutionAttempts="3" AttemptSleepDuration="300000" /> <QueueAssignment FromSchema="MATMAS04" SynchronizationQueueName="Product" NumberofExecutionAttempts="3" AttemptSleepDuration="3000" /> </InboundMessageQueues> <JobAlerts> <AlertDefinition AlertName="OutboundAlert" />

45 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 45 <AlertDefinition AlertName="InboundAlert" /> </JobAlerts> <InboundJobAlerts DefaultInboundAlert=""> <JobAlertAssignment FromSchema="MATMAT04" AlertName="InboundAlert" /> </InboundJobAlerts> </RoutingConfigurations> Job Alert Figure 15 Routing configuration XML Job Executor does not have the same Job Alert functionality as Job Scheduler. As an alternative, the Logging framework with SMTP Appender can be configured to send depending on the type of error message logged. For more information, refer to the Configuration Manager Online Help. See the following example and note that the StringToMatch value specifies the alert name. One or more SMTP appender can be added to be able to send to different recipients. <appender name="broadcasterror appender" type="flexnet.systemservices.logging.appender.smtpappender"> <param name="threshold" value="error" /> <param name="to" value="first.last@companyname.com" /> <param name="from" value="support@companyname.com" /> <param name="subject" value="broadcast Message Failure." /> <param name="smtphost" value="my_servername" /> <buffersize value="1" /> <lossy value="false" /> <layout type="flexnet.systemservices.logging.layout.patternlayout"> <param name="conversionpattern" value="%n%n[%d] Error occured while processing the Broadcast Message%n%n%m%n%n" /> </layout> <filter type="flexnet.systemservices.logging.filter.stringmatchfilter"> <param name="stringtomatch" value="[alertname]:outboundalert" /> </filter> <filter type="flexnet.systemservices.logging.filter.denyallfilter" /> </appender>

46 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide Routing Configuration Figure 16 DELMIA Apriso Configuration Manager Job Alert Use the Routing Configurations section in the DELMIA Apriso Configuration Manager to configure the routings and default routings. The valid job action types are listed in the RouteTo drop-down. For custom job action type, manually type in the job action type number. For more information, refer to the Configuration Manager Online Help. Definitions of nodes and attributes used in routing configuration: DefaultRouteTo Specifies one or more default Job Action Types separated by semicolon. DefaultRouteTo is used when the routing information is not defined for the encountered XML in child Route elements. Attributes: Route To Select or enter a Job action type Synchronization Queue Name of synchronous queue JobPool - Name of the Job pool to be used along with default route. DefaultAlertName Select or enter the default alert name. DefaultBatchMode Select from the drop-down the default batch mode. Default Outbound Job Pool - The default job pool to be used for outbound messages that does not have Job Pool Assignment. Drop-down consisted of all available job pools is currently configured. Route Each Route element defines one routing for one unique XML. Attributes:

47 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 47 FromSchema The value is compared against the root name of the encountered XML. AlertName Select or enter alert name. RouteTo Defined one or more destination aliases separated by semi-colon. When the encountered XML matches the value in FromSchema, the XML is to be routed to all destinations defined from this field. SynchrounousQueue Select or enter synchronous queue name. BatchMode Batch mode use for action type 6 Persist Batch Transaction. JobPool - Name of the Job Pool to be used for the defined route. Node: TestValues (optional) This section contains all conditions that the source XML must satisfy in order to use the Map entry. Node: Value Each Value element defined one test condition. value This value is to be match against value specified in Query attribute Query Specify the XPATH query of the encountered XML. The value is to be used to compare with the value specified by the Value attribute.

48 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 48 Figure 17 DELMIA Apriso Configuration Manager Routing Configurations Editor Disable XML Generation Use the Disable XML Generation section in the DELMIA Apriso Configuration Manager to define a list of DELMIA Apriso transactions that need or do not need XML generation to provide transaction history and external system integration. For more information, refer to the Configuration Manager Online Help. DisableXMLGeneration Specifies 0 or more transactions so that Internal XML will not be generated. DisableMode this attribute specifies whether to disable or enable all XML generation. Possible values are DisableAll, DisableListed or blank. TransactionName Each TransactionName Node contains valid Schema Names that correspond to the business component. Repeat for each transaction.

49 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 49 The following sample shows a scenario that enables all XML generation exception for one DELMIA Apriso Transaction. <DisableXMLGeneration DisableMode="DisableListed"> <TransactionName>FlexNet.BusinessFacade.Common.Tasks</TransactionName> </DisableXMLGeneration> The following sample shows a scenario that disables all XML generation exception for one DELMIA Apriso Transaction. <DisableXMLGeneration DisableMode="DisableAll"> <Exceptions> <TransactionName>FlexNet.BusinessFacade.Utility.TransactionHistoryWriter. WriteTransactionHistory</TransactionName> </Exceptions> </DisableXMLGeneration> Figure 18 DELMIA Apriso Configuration Manager Disable XML Generation Synchronization Queues Use the Synchronization Queues Definitions section in the DELMIA Apriso Configuration Manager to define the default Synchronization Queue setting and the Synchronization Queue that will be used for Outbound Routing. For more information, refer to the Configuration Manager Online Help. For details on how a Synchronization Queue is used in Job Executor, please refer to Background Job Processing Technical Guide.

50 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 50 SynchronizationQueues This section is used to definition settings for Synchronization Queues. Attribute: DefaultDisableDuration * The default disabled duration for synchronization queue that does not have queue definition. DefaultDisableOnFailure * Boolean value that specified whether to disable queue on failure. True to disable on failure, otherwise false. DefaultNumberofExecutionAttempts number of execution attempt on failure DefaultAttemptSleepDuration Value in millisecond to sleep duration between retry attempts Node: QueueDefinition specifies one or more queue definitions. Attributes: Name Name of the synchronization queue DisableOnFailure * Boolean value that specified whether to disable queue on failure. True to disable on failure, otherwise false. DisableDuration * Value in millisecond to disable queue before retrying. NumberofExecutionAttempts number of execution attempts on failure. Enter 0 to specify infinite amount of execution attempts. AttemptSleepDuration Value in millisecond of sleep duration between retry attempts. Business Integrator sets NumberOfExecutionAttempts to 3 and AttemptSleepDuration to 30 seconds when it cannot determine their values from configuration definition. Details are described below. Determining the values for NumberOfExecutionAttempts and AttemptSleepDuration: If a synchronization queue is assigned to message type (root node of the xml), the NumberOfExecutionAttempts and AttemptSleepDuration for the synchronization queue are used. If no synchronization queue is defined for the route, the default Number of Attempts and Sleep Duration between Attempts in BI Sync Queues Definitions tab is used. Action type 10 (Route message) is a special action type. If a synchronization queue is assigned to message type (root node of the xml), the NumberOfExecutionAttempts and AttemptSleepDuration for the synchronization queue are used and synchronization queue name is hardcoded to RoutingQueue. If no synchronization queue is defined, default values are used (NumberOfExecutionAttempts is 3 seconds and default AttemptSleepDuration is 30 seconds). * This is only use by Job Scheduler and only exists for backward compatibility reasons only.

51 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 51 Figure 19 DELMIA Apriso Configuration Manager Synchronization Queue Definitions Synchronization Queue Definition and Job Pools for Inbound Messages Use the Synchronization Queue Definition and Job Pools for Inbound Messages screens to define the Synchronization Queue and the job pools for inbound messages. These queue and job pool definitions are used for all inbound messages, regardless of which application (e.g., Web Service, MSMQ, or file) is used. For more information, refer to the Configuration Manager Online Help. For details on how a Synchronization Queue is used in Job Executor, please refer to the Background Job Processing Technical Guide. InboundMessageQueues This section is used to define settings for Synchronization Queues. Attributes: DefaultQueueAssignment * Name of the default Synchronization Queue Name. To specify no default, use (empty string). * This is only used by Job Scheduler and only exists for backward compatibility reasons only.

52 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 52 DefaultDisableOnFailure * The default Boolean value to indicate whether to disable queue on Failure. DefaultDisableDuration * The default Integer value in millisecond to indicate how long to disable queue. DefaultNumberofExecutionAttempts number of execution attempt on failure. DefaultAttemptSleepDuration Value in millisecond to sleep duration between retry attempts. Node: QueueAssignment Specify one or more Queue Assignment definitions. Attributes: FromSchema Name of the Message. QueueName Name of the Synchronization Queue DisableOnFailure * Boolean value to indicate whether to disable queue on Failure. DisableDuration * Integer value in millisecond to indicate how long to disable queue. NumberofExecutionAttempts number of execution attempt on failure. Enter 0 to specify infinite amount of execution attempt. AttemptSleepDuration Value in millisecond to sleep duration between retry attempts. Default Inbound Job Pool The default Job Pool to be used for inbound messages that does not have Job Pool Assignment. Drop-down list consisted of all available Job Pools is currently configured. Node: Job Pool Specify one or more Job Pool Assignment definitions. Attributes: FromSchema Name of the message. Job Pool Name of the Job Pool to be used for messages specified in From Schema. Business Integrator sets NumberOfExecutionAttempts to 3 and AttemptSleepDuration to 30 seconds when it cannot determine their values from configuration definition. Details are described below. Determining the values for NumberOfExecutionAttempts and AttemptSleepDuration: If a synchronization queue is assigned to message type (root node of the xml), the NumberOfExecutionAttempts and AttemptSleepDuration for the synchronization queue are used If no synchronization queue is defined for the incoming message, the default NumberOfExecutionAttempts and AttemptSleepDuration in BI Sync Queues and Job pools for Inbound message tab are used.

53 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 53 Figure 20 DELMIA Apriso Configuration Manager Synchronization Queue and Job Pools for Inbound Messages Allow Resubmission of Job Action Types Use the Permit Resubmission by Job Action Type section in the DELMIA Apriso Configuration Manager to configure which job action type is allowed to be reprocessed regardless of the last processing status. For more information, refer to the Configuration Manager Online Help. 5.3 Mapping Configuration The mapping configuration defines the location of schemas and XSLT transformation files in the Schema Repository to be used by Business Integrator. Mapping configurations for transaction history are not required, because the default location and default XSLT name are used. Features/changes introduced in 9.2: 1 New attributes in the mapping configuration that define the translation files to translate flat files to XML files and vice versa. 2 Must provide the subdirectory from for XSLT files or for XML schemas.

54 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 54 3 The transaction history XSLT file name changed from map_<transaction Namespace>_TransactionHistory.xml to map_<transaction Namespace without prefix FlexNet_BusinessFacade >_TH.xslt. 4 Mapping the file name under has an *.xslt file extension where previously it had an *.xml file extension. Use the Mapping Configurations section in the DELMIA Apriso Configuration Manager to define the mappings for all the incoming and outgoing transactions. For more information, refer to the Configuration Manager Online Help. The following is a sample mapping configuration XML: <MappingConfigurations> <Map FromSchema="ZOIPRO01" XsltFileName="map_ZOIPRO01_ProductionOrders_component.xml" ToSchema="ProductionOrders.xsd"/> <Map FromSchema="FlexNet.BusinessFacade.Labor.LaborMarshall.ReportProduction" XsltFileName="map_ReportLaborQty_CONF32.xml" ToSchema="CONF32.xsd"> <!-- List all AND conditions --> <TestValues> <Value value="2" Query="/FlexNet.BusinessFacade.Labor.LaborMarshall.ReportProduction/ FlexNet.BusinessRules.Controller.Labor.LaborController.ReportProduction/ WipOrderType"/> </TestValues> </Map> <Map FromSchema="MMPRDMST" LTMTranslationFile="FlatFile/map_MMPRDMSTs_FixedLength.ltm" LTMDirection="ToXML" LTMOutputSchema="FlatFile/MMPRDMSTs.xsd" XsltFileName="FlatFile/map_MMPRDMSTs_FlexNetProducts.xslt" ToSchema="FlexNet/FlexNet_Products.xsd" /> </MappingConfigurations> Figure 21 Mapping Configuration XML Definitions of nodes and attributes used in Mapping Configuration: Map Each Map element defines one mapping configuration. Attributes: FromSchema This value is compared against the root name of the encountered XML. XsltFileName Name of the XSLT mapping file that transforms the encountered XML that validates against FromSchema to a new XML that validates against the ToSchema. ToSchema Name of the schema that validates against the result XML after XSLT transformation LTMTranslationFile Name of the translation file name use to translate File Flat to XML and vice versa. This is optional and only use if flat file translation is required. As of Apriso 9.5 instead of physical location of the ltm file, you can now enter the subdirectory path to the ltm file from Maps directory in Schema Repository i.e. "FlatFile/map_MMPRDMSTs_FixedLength.ltm".

55 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 55 LTMOutputSchema Name of the Output schema only if LTMDirection is ToXML. This is optional and only use if flat file translate is required. LTMDirection Use keyword ToXML to convert Flat file to XML or ToText to convert XML to Flat file. This is optional and only use if flat file translate is required. TargetDirectories Full directory path(s) separate by ;. This is optional and only use for 7-Flat File Processor. Node: TestValues (optional) This section contains all conditions that the source XML must satisfy in order to use the Map entry. Node: Value Each Value element defined one test condition. Nodes: Value This value is to be match against value specified in Query attribute. Query Specify the XPATH query of the encountered XML. The value is to be used to compare with the value specified by the Value attribute. BAPIRFCCallMode The two valid call modes are CallSynchronous or CallAsynchronous. CallSynchronous enables synchronous invocation of BAPI or RFC whereas CallAsynchronous enables asynchronous invocation. CallSynchronous is used by default and only use CallAsynchronous mode when the BAPI or RFC does not return a respond such as confirmation transaction. BAPIRFCRespondMode The two valid respond modes are CreateNewJobForResponse or NoNewJobForResponse. CreateNewJobForResponse is used by default and NoNewJobForResponse is used when BAPI or RFC returns ResponseXML that does not need to be transformed to DELMIA Apriso XML that persists into the DELMIA Apriso Database.

56 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 56 Figure 22 DELMIA Apriso Configuration Manager Mapping Configuration 5.4 External System Configuration The standard DELMIA Apriso installation will no longer prompt the user for the Business Integrator configuration for the SAP external system. To modify external system entries, use DELMIA Apriso Configuration Manager from the startup menu. The following is a sample XML structure of the external system configuration XML file: <ExternalSystemConfigurations xmlns=" <SAPBusinessConnector> <SAPApplicationName>SAPApplicationName</SAPApplicationName> <SAP_LOGSYS>SAPLOG</SAP_LOGSYS> <SAPBC_LOGSYS>FLEXNET</SAPBC_LOGSYS> <BCURL> <BCUser>BCUser</BCUser> <BCPassword>BCPassword</BCPassword> <CONTENT_TYPE_IDOC>application/x-sap.idoc</CONTENT_TYPE_IDOC> <CONTENT_TYPE_BAPI>application/x-sap.busdoc</CONTENT_TYPE_BAPI>

57 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 57 <CONTENT_TYPE_RFC>application/x-sap.busdoc</CONTENT_TYPE_RFC> <POST_IDOC>/invoke/pub.sap.transport.ALE:InboundProcess</POST_IDOC> <POST_BAPI>/invoke/pub.sap.transport.BAPI:InboundProcess</POST_BAPI> <POST_RFC>/invoke/pub.sap.transport.RFC:InboundProcess</POST_RFC> <GET_TID>/invoke/pub.sap.client:createTID</GET_TID> <CONFIRM_TID>/invoke/pub.sap.client:confirmTID</CONFIRM_TID> <CLNT>100</CLNT> <RCVPOR>SAPC64</RCVPOR> <RCVPRN>SAPLOG</RCVPRN> <RCVPRT>LS</RCVPRT> <SNDPOR>A </SNDPOR> <SNDPRN>FLEXNET</SNDPRN> <SNDPRT>LS</SNDPRT> <HTTPTimeOut>60000</HTTPTimeOut> <!-- 60 seconds --> </SAPBusinessConnector> <WebMethods> <TimeOut>5000</TimeOut> <!-- Milliseconds --> <WebServiceURL> WebServiceURL> </WebMethods> <MSMQ> <TimeOut>200</TimeOut> <!-- Milliseconds --> <SleepValue>100</SleepValue> <!-- Milliseconds --> <MessageFormatter>0</MessageFormatter> <!-- 0 for Binary 1 for Active -- > <InboundQueue>.\private$\InboundQueue</InboundQueue> <OutboundQueue>.\private$\OutboundQueue</OutboundQueue> </MSMQ> <FileMonitors> <FileMonitor FileMonitoringDirectoryPath="C:\FlexNet\PickUp" FileFilter="*.txt" OptionalArchivePath="" /> </FileMonitors> <FlexNetInternalAdapter> <WebServiceTimeOut>60000</WebServiceTimeOut> </FlexNetInternalAdapter> <BizTalk> <BTSHTTPReceiveURL> TSHTTPReceiveURL> <BTSHTTPTimeOut>60000</BTSHTTPTimeOut> <!-- 60 seconds --> </BizTalk> <SAPXI> <XIWebServiceURL></XIWebServiceURL> <XITimeOut>60000</XITimeOut> <!-- 60 seconds --> </SAPXI> </ExternalSystemConfigurations> Figure 23 External system configuration XML New CONTENT_TYPE_BAPI, CONTENT_TYPE_RFC, POST_BAPI, and POST_RFC elements are added to the ExternalSystemConfigurations SAPBusinessConnector section in the external system configuration as presented in Figure SAP Business Connector Adapter Use the SAP Business Connector Adapter section in DELMIA Apriso Configuration Manager to enter the settings required to successfully integrate with SAP Business Connector.

58 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 58 When there is more than one external integration adapter to be used and the mapping configuration definition cannot be defined in the main Mapping Configuration section, the mapping configuration for the SAP Business Adapter section can be used to specify the mappings to be used only for the SAP BC Adapter. For more information, refer to the Configuration Manager Online Help. SAPBusinessConnector This section stores information for SAP Business Connector Adapter (Job Action type 9). Nodes: SAPApplicationName SAP Application Server Name SAP_LOGSYS SAP Logical System Name defined in SAP SAPBC_LOGSYS SAP Business Connector Logical System Name defined in SAP BCURL Business Connector URL BCUser Business Connector User ID BCPassword Business Connector User Password. If password saved thru Configuration Manager, the password will be encrypted. CONTENT_TYPE_IDOC Value should be constant. HTTP Content type for IDOC. CONTENT_TYPE_BAPI Value should be constant. HTTP Content type for BAPI. (NEW V9.3 SP3) CONTENT_TYPE_RFC Value should be constant. HTTP Content type for RFC. (NEW V9.3 SP3) POST_IDOC Value should be constant. HTTP sub-path to Post IDOC Function. POST_BAPI Value should be constant. HTTP sub-path to Post BAPI Function. (NEW V9.3 SP3) POST_RFC Value should be constant. HTTP sub-path to Post RFC Function. (NEW V9.3 SP3) GET_TID Value should be constant. HTTP sub-path to get the TID Function. CLNT SAP Client RCVPOR Receive Port RCVPRN Receive Partner RCVPRT Receive Partner type. SNDPOR Send Port SNDPRN Send Partner SNDPRT Send Partner Type. HTTPTimeOut HTTP time out value in milliseconds Web Methods Adapter Use the Web Methods Adapter section in DELMIA Apriso Configuration Manager to define the settings for the Web Methods Adapter (job action type 12). When there is more than one external integration adapter to be used and mapping the configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the Web Methods Adapter section can be used to specify the mappings to be used only for the Web Methods Adapter. For more information on the Web Methods Adapter tab, refer to the Configuration Manager Online Help.

59 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide SAP PI Adapter Use the SAP PI Adapter section in the DELMIA Apriso Configuration Manager to define the settings for SAP PI. When there is more than one external integration adapter to be used and the mapping configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the SAP PI Adapter section can be used to specify the mappings to be used only for the SAP PI Adapter. Business Integrator SAP PI Adapter tab stores information for SAP PI Adapter (Job action type 30). For more information on the SAP PI Adapter tab, refer to the Configuration Manager Online Help MSMQ Adapter Use the MSMQ Adapter section in the DELMIA Apriso Configuration Manager to define the settings for the MSMQ integration. When there is more than one external integration adapter to be used and mapping the configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the MSMQ Adapter section can be used to specify the mappings to be used only for the MSMQ Adapter. For more details on the MSMQ Adapter tab, see Configuration Manager Online Help BizTalk Adapter Use the BizTalk section in the DELMIA Apriso Configuration Manager to define the settings for BizTalk integration. When there is more than one external integration adapter to be used and mapping the configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the BizTalk section can be used to specify the mappings to be used only for the BizTalk Adapter. For more information on the BizTalk Adapter tab, refer to the Configuration Manager Online Help Flat File Related Settings Use the Flat File Related Settings section in the DELMIA Apriso Configuration Manager to define the settings for the File Incoming Message. When there is more than one external integration adapter to be used and mapping the configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the Flat File Adapter section can be used to specify the mappings to be used only for the Flat File Adapter. For more information on the Flat File Related Settings tab, refer to the Configuration Manager Online Help BI FTP Adapter Use the FTP Adapter tab in the DELMIA Apriso Configuration Manager to define the FTP server settings for FTP integration. When there is more than one external integration adapter to be used and mapping the configuration definition cannot be defined in the main Mapping Configurations section, the mapping configuration for the FTP Adapter section can be used to specify the mappings to be

60 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 60 used only for the FTP Adapter. For more information on the BI FTP Adapter tab, refer to the Configuration Manager Online Help MQ Series Adapters Use the MQ Series Adapters section in the DELMIA Apriso Configuration Manager to define the connection and transaction settings for interfacing with an MQ Series server. The configuration screen allows for the creation, modification, and deletion of queue configurations in the XMLManager_MQSeriesConfiguration.xml file. For more information on the MQ Series Adapters tab, refer to the Configuration Manager Online Help RFC Adapters Use the RFC Adapters section in the DELMIA Apriso Configuration Manager to create, modify, and delete the connection settings to SAP and other third-party systems that support remote function calls. For more information on the RFC Adapters tab, refer to the Configuration Manager Online Help BI HTTP Adapter Use the HTTP Adapter section in the DELMIA Apriso Configuration Manager to define the settings for the HTTP Adapter (job action type 37). For more information on the BI-HTTP Adapter tab, refer to the Configuration Manager Online Help Lync Server Connection Use the Lync Server Connection section to set the user credentials used to log in to the Lync server as well as to configure the cache properties and the refresh rate of the Lync Business Control. For more information on the Lync tab, refer to the Configuration Manager Online Help REST Adapter Use the REST Adapter section in the DELMIA Apriso Configuration Manager to define the settings for the REST Adapter (job action type 39). For more information on the BI-REST Adapter tab, refer to the Configuration Manager Online Help. 5.5 Batch Transaction Configuration Standard installation provides batch configuration for Inventory Adjust and Inventory Move. This configuration does not have a section in the DELMIA Apriso Configuration Manager. This configuration should not require changes if you are using Batch Mode 1 for batching. The following is a sample XML structure of the batch transaction configuration XML file: <BatchTransactionConfiguration> <DataMaps TransactionName="All"> <DataMap ToField="StepSequenceNo" FromXpath="//SessionContext/StepSequenceNo" /> <DataMap ToField="TaskID" FromXpath="//SessionContext/TaskID" /> <DataMap ToField="TransactionName" FromXpath="root" />

61 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 61 <DataMap ToField="TransactionTime" FromXpath="//SessionContext/TransactionTime" /> </DataMaps> <DataMaps TransactionName="FlexNet.BusinessFacade.Inventory.InventoryAdjustController. Adjust"> <DataMap ToField="WipOrderNo" FromXpath="//WipOrderNo[1]" /> <DataMap ToField="WipOrderType" FromXpath="//WipOrderType[1]" /> <DataMap ToField="OprSequenceNo" FromXpath="//OprSequenceNo[1]" /> <DataMap ToField="ProductNo" FromXpath="//ProductNo[1]" /> <DataMap ToField="TransactionCode" FromXpath="//TransactionCode[1]" /> <DataMap ToField="SerialNo" FromXpath="//SerialNo[1]" /> <DataMap ToField="LotNo" FromXpath="//LotNo[1]" /> </DataMaps> <DataMaps TransactionName="FlexNet.BusinessFacade.Inventory.InventoryMoveController.Mo ve"> <DataMap ToField="WipOrderNo" FromXpath="//WipOrderNo[1]" /> <DataMap ToField="WipOrderType" FromXpath="//WipOrderType[1]" /> <DataMap ToField="OprSequenceNo" FromXpath="//OprSequenceNo[1]" /> <DataMap ToField="ProductNo" FromXpath="//ProductNo[1]" /> <DataMap ToField="TransactionCode" FromXpath="//TransactionCode[1]" /> <DataMap ToField="SerialNo" FromXpath="//SerialNo[1]" /> <DataMap ToField="LotNo" FromXpath="//LotNo[1]" /> </DataMaps> </BatchTransactionConfiguration> Figure 24 Batch transaction configuration XML These are the definitions of the nodes and attributes used in the batch transaction configuration: DataMaps stores information for the Batch Transaction Persister (job action type 6). The attribute: Transaction Name the name of the transaction name or keyword ALL If the transaction name is specified, only that transaction will use the DataMap definition When ALL is specified, all transactions will use the DataMap definition The node: DataMap defines one map data The nodes: ToField specifies the column name in TRANSACTION_DATA_BATCH_PROCESS for storing the value extracted from the XML using Xpath FromXpath the Xpath of the value to be extracted 5.6 Incoming Message Monitor Application Configuration If MonitorMQSeries is enabled in the app.config file, then in order to make the Incoming Message Monitor work correctly, installing the IBM MQ client ( version) on the DELMIA Apriso server is required.

62 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 62 If MonitorMQSeries is enabled in the app.config file but IBM MQ client ( version) is not installed, then the system skips monitoring the MQ series (but this does not prevent the incoming message monitor from running as a whole). The default installation path which is executable for the Incoming Message Monitor Window service is: <drive>\program Files\Dassault Systemes\DELMIA Apriso 2018\Services\Incoming Message Monitor Service\FlexNetIncomingMessageMonitor.exe. This window service combined the functionalities from FlexNetMSMQIncomingmessageMonitor.exe and FlexNetFileIncomingmessageMonitor.exe. The application configuration file for this monitor service is FlexNetIncomingMessageMonitor.exe.config. It has the following AppSettings entries: <configuration> <appsettings> <add key="centralconfigurationfile" value="c:\program Files\Dassault Systemes\DELMIA Apriso 2018\WebSite\CentralConfiguration\CentralConfiguration.xml" /> <add key="monitorfile" value="true" /> <add key="fileprocessandcreatefinishedjob" value="false" /> <add key="fileinactivitysleepvalue" value="1000" /> <add key="monitormsmq" value="false" /> <add key="msmqprocessandcreatefinishedjob" value="false" /> <add key="monitormqseries" value="false" /> <add key="monitorppr" value="false" /> <add key="exportcompleteindicatorfilename" value="complete.txt" /> <add key="exportcompleteindicatorwaittimeinseconds" value="30" /> </appsettings> </configuration> The entries are: AppSettings key CentralConfigurationFile MonitorFile FileProcessAndCreateFinished Job FileInactivitySleepValue MonitorMSMQ MSMQProcessAndCreateFinis hedjob Value and Description Set the value with the file path to the Central Configuration file. Set the Boolean value to true in order to enable a file monitor; otherwise, false. Set the Boolean value to true if processing is done by this Incoming Message Monitor Service and a finished job is created for history. Set to false if processing is done by Job Scheduler. Set the sleep value in milliseconds when no file is to be processed. Set the Boolean value to true to enable an MSMQ monitor; otherwise, false. Set the Boolean value to true if the processing is done by this Incoming Message Monitor Service and a finished job is created for history. Set to false if processing is done by Job Scheduler.

63 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 63 MonitorMQSeries MonitorPPR ExportCompleteIndicatorFileN ame ExportCompleteIndicatorWaitT imeinseconds Set the Boolean value for MonitorMQSeries to true to monitor MQ Series for incoming messages. Set Boolean Value to true to enable Directory Monitoring. By default, the Export Complete Indicator File Name is set to complete.txt. This value does not need to be modified unless the exporting application is changed. Specifies the wait time in seconds between checks for Export Complete Indicator File. If MonitorMSMQ is set to true, Microsoft Message Queuing must be installed before the service can start successfully.

64 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 64 6 Schema Repository The standard installation deploys the Schema Repository to <drive>\program Files\Dassault Systemes\DELMIA Apriso 2018\WebSite\SchemaRepository. The Schema Repository has the following directory structure: Schema Repository the root of the Schema Repository Designs contains all of the design files and is further categorized by design tools Mapforce contains all the Mapforce project files and is further categorized by the following: External the external system mapping design files FlatFile the flat file mapping design files FlexNet the FlexNet mapping design files TH the transaction history design files SchemaBuilder the FlexNet schema Builder project files, which are further categorized by target destinations Flexnet the FlexNet schema design files TH the transaction history schema design files Maps contains all of the XSLT mapping files and is further categorized by destination External external system mappings FlatFile flat file mappings FlexNet FlexNet mappings TH transaction history WSDL contains all of the WSDL used in Business Integrator FlexNetMessageProcessor Web Service contains FlexNetMessageProcessor.wsdl, which is to be used by the external systems who will invoke the FlexNetMessageProcessor Web Service SAPPIAdapter contains MiOaFlexnetWebService.wsdl, which is used for SAPPIAdapter - SAP PI should have a Web Service that matches this WDSL file in order eliminate changes to his adapter WebMethodsAdapter contains WebMethodMessageProcessor.wsdl, which is used for WebMethodsAdapter - Web Methods should have a Web Service that matches this WDSL file in order eliminate changes to this adapter XMLSchemas contains all the schema, which are further categorized by classification External external system schemas FlatFile flat file schemas FlexNet FlexNet XML schemas Internal internal XML schemas TH transaction history schema 6.1 Schema Repository Documentation Mapping and schema documentation is available from the DELMIA Apriso Start page. Login is required to view the documents.. The mappings and schemas are grouped by category, similar to the Schema Repository structure.

65 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 65 Figure 25 DELMIA Apriso XML Schema Repository Documentation

66 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 66 7 Extensibility 7.1 Extension Points for the External Adapter There are nine job actions that provide extension points. They are: Job Action 9 SAP Business Connector Adapter The interface name is ISAPBCAdapterSend Job Action 12 Web Methods Adapter The interface name is IWebMethodAdapterSend Job Action 7 Flat File Processor The interface name is IFlatFileProcessorSend The interface name is IFlatFileProcessorExtendFileName The interface name is IFlatFileProcessorSendv2 This extension point allows customization of the file name created by the Sequence Provider For example, if the customer requires the file name to be prefixed with the date and time, this extension point can be used to implement the date time prefix and append it with the file name created by Sequence Provider Job Action 29 Apriso Internal Adapter The interface name is IFlexNetInternalAdapterSend Job Action 30 SAP PI Adapter The interface name is ISAPPIAdapterSend Job Action 31 BizTalk Adapter The interface name is IBiztalkAdapterSend Job Action 35 MQ Series Adapters The interface name for MQ Series is IMqSeriesAdapterSend Job Action 37 HTTP Adapter The interface name is IHTTPAdapterSend Job Action 36 FTP Adapter The interface name is IFTPProcessorSend, IFTPProcessorSendv2 Job Action 39 REST Adapter The interface names are: IRESTAdapterURLBuilder Use this interface to change how the URL is composed using RELATIVEURI and URIPARAMETERS variables IRESTAdapterTokenRetriever Use this interface to change how tokens are requested IRESTAdapterSend Use this interface to change how this adapter sends the message

67 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 67 The above extension points allow for the customization of the delivery mechanism. They do not alter the functionality of how an internal XML is transformed into an external XML. These extension points are to be implemented in the same manner as extending Apriso Business Components using extension points, and they are to be done by DELMIA Apriso Services or partners. 7.2 Custom Schemas and Mappings Apriso Schemas All standard Apriso schemas are created using DELMIA Apriso XML Schema Builder. This tool is available at 3DS Support at Please refer to the XML Schema Builder Online Help for information on how to use this tool Mappings All standard mappings are done in Mapforce. Since Mapforce uses the full path to reference the schemas, the following setup instructions are to be followed before opening the Mapforce project: 1 Copy the current version of Schema Repository to the local machine. The default Schema Repository directory location is <drive>\program Files\Dassault Systemes\DELMIA Apriso 2018\WebSite\SchemaRepository. 2 Map the S drive to the parent directory of the Schema Repository folder. Verify by locating the Mapforce projects in S:\SchemaRepository\Designs\Mapforce\. 3 If S drive is mapped correctly, the Mapforce project will open without errors. The Mapforce project is not an XSLT file. Mapforce is a graphic tool that defines the relationship between source and target schema. Mapping can be tested within Mapforce by providing a source sample XML that matches the source schema. After testing and reaching a satisfactory mapping result, an XSLT is then generated and saved to file. This XSLT file requires manual editing. Mapforce generates the XSLT with the full path to any external file. For example, <xsl:include href="s:\schemarepository\maps\apriso_functions.xsl" /> needs to be changed to use a relative path: <xsl:include href="..\apriso_functions.xsl" />. To deploy the XSLT file, copy the new XSLT to Schema Repository on the DELMIA Apriso server and restart ASP.net Flat File Mappings In addition to the custom schema and mapping discussed in the previous section, there is one more step to take for flat file integration: to map the flat file (delimited files) to XML and vice versa. To support flat file integration, a third-party software called XmlLinguist by SysOnyx is used. The main task for XmlLinguist is to translate flat files to the XML structure where the XML transforms into the target XML structure and translates the XML structure to flat files. It is important to understand that XmlLinguist is a flat file/xml translation tool. The relationship between a flat file and an XML is one-to-one. The flat file and the flat file XML must contain all of the fields.

68 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 68 After defining the required schema and map files, the mapping configuration needs to be updated to reflect which LTM settings are to be used during runtime. The flat file to DELMIA Apriso XML flow: 1 The external system sends the source flat file document to DELMIA Apriso. 2 Business Integrator invokes XmlLinguist to translate from flat file to XML. 3 Business Integrator transforms the resulting flat file XML into a DELMIA Apriso XML using XSLT (Mapforce). 4 Business Integrator processes the DELMIA Apriso XML and persists the data to the DELMIA Apriso database. For this flow, reference the MMPRDMST flat file to the FlexNet_Products Apriso XML sample, and the related files are: map_mmprdmsts_fixedlength.ltm MMPRDMSTs.xsd map_mmprdmsts_flexnetproducts.mfd map_mmprdmsts_flexnetproducts.xslt FlexNet_Products.xsd The DELMIA Apriso to external flow: 1 DELMIA Apriso generates an internal BC XML. 2 Business Integrator transforms the internal BC XML into a flat file XML using XSLT (Mapforce). 3 Business Integrator invokes XmlLinguist to translate from XML to flat file. 4 Business Integrator sends the flat file to the target system using the standard Job Action Adapter. For this flow, reference the ReportOrder internal BC XML to the FMTRAN flat file sample, and the related files are: map_fmtrans_fixedlength.ltm FMTRANs.xsd map_reportorder_fmtrans.mfd map_reportorder_fmtrans.xslt FlexNet.BusinessFacade.Manufacturing.OrderReporter.ReportOrder.xsd The sample files are in Schema Repository in their respective directories. The summary is as following: SchemaRepository\Designs\Mapforce\FlatFile contains the Mapforce projects that map between the flat file XML and the FlexNet/BC XML SchemaRepository\Maps\FlatFile the LTM and XSLT files SchemaRepository\XMLSchemas\FlatFile the flat file XSD 7.3 Custom Job Action Type The following is a brief guideline for implementing a custom job action:

69 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 69 1 Create a new C# class that implements the IActionExecutor interface. See this custom job action class code snippet and generate the new GUIDs for the JobActionType, Facade, and ComponentRepositoryMethodVisible attributes: using FlexNet.SystemServices.Scheduling; namespace FlexNet.SystemServices.CustomAction [ RequiresTransaction ] [ ComponentRepositoryComponentType(ComponentType.JobActionType, "09CA580A- 190A-433a-9E98-863FA0DF9E21") ] [ ComponentRepositoryComponentType(ComponentType.Facade, "5F8855CA c E8C8030") ] public class MyAction : IActionExecutor { [ComponentRepositoryMethodVisible("71AF75EA-6BE0-450d-A81B-1199B958AA93")] public Outcome Execute( ExecutionArgs args ) { return Outcome.Success( ; } } 2 Compile a new assembly for the C# class created in step 1. 3 Add the new job action in the Business Components Repository using DELMIA Apriso Process Builder. 4 Manually add the new job action type record to the JOB_ACTION_TYPE table with a value for ImplementationBCID, which is generated from step 3 in the Business Component table, and ConfigurationBCID, which can be null or the same as the other Business Integrator job action if this custom job action is for Business Integrator. 5 Update the routing configuration to use this custom job action type by using the ID value generated in step 4 in the JOB_ACTION_TYPE table.

70 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 70 8 Configuration Scenarios 8.1 Conditional Routing Definition The routing configuration is interpreted from top down, which means that the route definition encounter will first be considered. If it is not satisfactory, the next route definition will be considered, and so on. The given sample below has one route definition with multiple test conditions. Both values for HostIndicator1 at the two different Xpaths specified by the query attribute must equal NOUPLOAD in order for this route definition to be selected. All the test conditions defined by <Value> under <TestValues> are of the AND condition. <RoutingConfigurations DefaultRouteTo="TransactionHistoryProcessor"> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t" RouteTo="TransactionHistoryProcessor "> <TestValues> <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/inventories/hostindic ator1" /> <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/containers/inventorie s/hostindicator1" /> </TestValues> </Route> </RoutingConfigurations> With the above sample, we are to change the test condition from AND to OR. The given sample below has duplicated the same route definition and removed the second value definition from the first route definition and removed the first value definition from the second route definition. As a result, there are two route definitions for the same FromSchema that have different value definitions. Since both of the route definitions have the same RouteTo information, when one of the two test conditions is satisfied, the route definition is used. <RoutingConfigurations DefaultRouteTo="TransactionHistoryProcessor"> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t" RouteTo="TransactionHistoryProcessor "> <TestValues> <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/inventories/hostindic ator1" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t RouteTo="TransactionHistoryProcessor "> <TestValues>

71 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 71 <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/containers/inventorie s/hostindicator1" /> </TestValues> </Route> </RoutingConfigurations> To perform an additional step on the above sample, we are to add a default route definition when both the test conditions for HostIndicator1 are not met. Note that, because the route configuration is interpreted from top down, the default route definition appears after all the route definitions with the same FromSchema with the test condition. See below for how the default route definition is defined. <RoutingConfigurations DefaultRouteTo="TransactionHistoryProcessor"> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t" RouteTo="TransactionHistoryProcessor "> <TestValues> <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/inventories/hostindic ator1" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t RouteTo="TransactionHistoryProcessor "> <TestValues> <Value value="noupload" Query="/FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjust/Fl exnet.businessrules.inventory.inventoryadjuster.adjust/containers/inventorie s/hostindicator1" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Inventory.InventoryAdjustController.Adjus t RouteTo="TransactionHistoryProcessor;BatchTransactionPersister"> </RoutingConfigurations> 8.2 Define the Audit Trail for Modified XML Messages Please follow the AuditTrail_TechGuide.doc to configure auditing with the following parameters: In Employee Roles: Link to the user role that will be changing the XML message in the Job Scheduler Monitoring and Maintenance screen In Audited Table Properties: Select the TRANSACTION_DATA_QUEUE table In Audited Field Properties: Select the Message field and select Change triggers Audit Select the ID field

72 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 72 Select the Label field In Audit Conditions: Select Update and Delete Additionally, make sure that the Audit is enabled in Central Configuration. If Central Configuration has been modified, be sure to restart IIS, Framework services, and Maintenance services in order to ensure the changes take effect. 8.3 Archive of Business Integrator Jobs There is no special setup for archiving Business Integrator jobs. The same archive set up for jobs will also archive Business Integrator jobs. 8.4 Invocation of BAPI/RFCs from DELMIA Apriso With existing Business Integrator architecture, DELMIA Apriso can invoke any BAPI/RFC via the SAP Business Connector asynchronously. Since Business Integrator depends on the Job Scheduler engine, a background application for execution, it is not possible to invoke BAPI/RFCs synchronously from the user's perspective, even though BAPI/RFCs can be invoked synchronously. Each BAPI/RFC call involves two XMLs: the send/query XML and the response XML. The send/query XML containing the input parameters used to invoke the BAPI/RFCs is generated by the caller. The response XML containing the outputs returned by the BAPI/RFCs is returned to the caller. The schemas for the send/query XML and the response XML can be downloaded from the SAP Interface Repository at For the response XML schema, the xmlns and targetnamespace attribute in the <xsd:schema> element must be removed in order for the validation to work properly. Before: <xsd:schema xmlns:xsd=" xmlns="urn:sap-com:document:sap:business" targetnamespace="urn:sapcom:document:sap:business" version="1.0"> After: <xsd:schema xmlns:xsd=" version="1.0"> BAPI/RFC Interface Flow This is the recommended flow for invoking BAPI/RFCs from DELMIA Apriso: 1 The user initiates invocation of a BAPI by running a Standard Operation that invokes the Apriso BC that creates the internal XML. a Without introducing a new Business Component, the WriteTransactionHistory BC is the perfect component for gathering the input parameters for the BAPI/RFCs from the user. For each BAPI/RFC, assign a unique name to the Transaction Name parameter for the WriteTransactionHistory BC. The unique Transaction Name will be used to configure the routing and mapping. 2 Business Integrator transforms the internal XML into a BAPI/RFC Query XML. 3 Business Integrator sends the query XML to SAP via the SAP Business Connector.

73 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 73 4 Business Integrator receives the response XML from the SAP Business Connector. 5 Business Integrator creates a new job to process the response XML. 6 Job Scheduler transforms the response XML into a DELMIA Apriso XML, which is processed and persisted to the DELMIA Apriso database. a If the BAPI response does not return values such as a confirmation transaction, it can be configuration to ignore the response XML Configure the BAPI/RFC Invocation by Example These five Quality Inspection Lot BAPIs were added to the collection of the DELMIA Apriso standard interface: BAPI_INSPLOT_GETLIST BAPI_INSPLOT_GETOPERATIONS BAPI_INSPOPER_GETCHAR BAPI_INSPCHAR_GETREQUIREMENTS BAPI_INSPOPER_RECORDRESULTS The following steps configure the BAPI/RFC invocation from DELMIA Apriso. This documentation also serves as an outline for configuring and developing other BAPI/RFCs. 1 Download the BAPI schemas from SAP Interface Repository and add them to the Schema Repository under XMLSchemas\External. The following are Inspection Lot BAPI send/query and response XSDs: a BAPI_INSPLOT_GETLIST i InspectionLot.GetList.query.xsd ii InspectionLot.GetList.Response.xsd b BAPI_INSPLOT_GETOPERATIONS i InspectionLot.GetOperations.query.xsd ii InspectionLot.GetOperations.Response.xsd c BAPI_INSPOPER_GETCHAR i InspectionLotOperation.GetCharacteristics.query.xsd ii InspectionLotOperation.GetCharacteristics.Response.xsd d BAPI_INSPCHAR_GETREQUIREMENTS i InspLotCharacter.GetRequirements.query.xsd ii InspLotCharacter.GetRequirements.Response.xsd 2 Determine the required inputs for the BAPI query and design a Standard Operation or Process to use the WriteTransactionHistory BC to gather those required inputs. 3 Perform mappings from the WriteTransactionHistory BC XML to the BAPI query XML. 4 Determine where the required output will persist in the DELMIA Apriso database and create DELMIA Apriso schema for it. 5 Perform mappings from the BAPI response XML to the DELMIA Apriso schema. 6 Deploy the mappings to the Schema Repository. 7 Add new route entries to the Routing Configurations for the BAPI query. Each routing has a test condition against the Transaction Name. The following is the XML snippet of the routing configuration:

74 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 74 <Route FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" RouteTo="9:SAP_QualityInspectionLotQuery" AlertName=""> <TestValues> <Value value="insplot_getlist" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" RouteTo="9:SAP_QualityInspectionLotQuery" AlertName=""> <TestValues> <Value value="insplot_getoper" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" RouteTo="9:SAP_QualityInspectionLotQuery" AlertName=""> <TestValues> <Value value="insplotoper_getchar" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Route> <Route FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" RouteTo="9:SAP_QualityInspectionLotQuery" AlertName=""> <TestValues> <Value value="inspchar_getreq" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Route> <Route FromSchema=" FlexNet.BusinessFacade.Quality.DispositionTestStatusManager.CompleteDisposit iontest" RouteTo="11;9:SAPBCAdapter_Shipping" AlertName="" /> 8 Add new map entries to the mapping configuration for each BAPI query and response. Each BAPI query has a test condition against the Transaction Name. The following is the XML snippet of the mapping configuration: <Map FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" XsltFileName="External/map_WriteTransactionHistory_InspLot.GetList.query_BAP I.xslt" ToSchema="External/InspectionLot.GetList.query.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName=""> <TestValues> <Value value="insplot_getlist" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Map>

75 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 75 <Map FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" XsltFileName="External/map_WriteTransactionHistory_InspLot.GetOper.query_BAP I.xslt" ToSchema="External/InspectionLot.GetOperations.query.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName=""> <TestValues> <Value value="insplot_getoper" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Map> <Map FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" XsltFileName="External/map_WriteTransactionHistory_InspLotOper.GetChar.query _BAPI.xslt" ToSchema="External/InspectionLotOperation.GetCharacteristics.query.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName=""> <TestValues> <Value value="insplotoper_getchar" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Map> <Map FromSchema="FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTra nsactionhistory" XsltFileName="External/map_WriteTransactionHistory_InspChar_GetReq.query_BAP I.xslt" ToSchema="External/InspLotCharacter.GetRequirements.query.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName=""> <TestValues> <Value value="inspchar_getreq" Query="/FlexNet.BusinessFacade.Utility.TransactionHistoryWriter.WriteTransac tionhistory/flexnet.businessfacade.utility.transactionhistorywriter.transact ionname/transactionname" /> </TestValues> </Map> <Map FromSchema="FlexNet.BusinessFacade.Quality.DispositionTestStatusManager.Comp letedispositiontest" XsltFileName="External/map_CompleteDispositionTest_InspOperRecordResults.xsl t" ToSchema="External/InspectionLotOperation.RecordResults.Query.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName="" BAPIRFCSendMode="2" BAPIRFCRespondMode="2" /> <Map FromSchema="InspectionLot.GetList.Response" XsltFileName="External/map_InspLotGetListResp_FlexNetInspLot.xslt" ToSchema="FlexNet/FlexNet_InspLot.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName="" /> <Map FromSchema="InspectionLot.GetOperations.Response" XsltFileName="External/map_InspLotGetOperResp_FlexNetInspLotOper.xslt" ToSchema="FlexNet/FlexNet_InspLotOper.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName="" /> <Map FromSchema="InspLotOperation.GetChar.Response" XsltFileName="External/map_InspLotOperGetCharResponse_InspOperChar.xslt" ToSchema="FlexNet/FlexNet_InspOperChar.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName="" /> <Map FromSchema="InspLotCharacter.GetRequirements.Response" XsltFileName="External/map_InspLotOperCharReqResponse_InspOperCharReq.xslt"

76 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 76 ToSchema="FlexNet/FlexNet_InspOperCharReq.xsd" LTMTranslationFile="" LTMDirection="" LTMOutputSchema="" AlertName="" /> 8.5 Routing to a Standard Operation for MQ Series Adapter The Queue Configuration section is required for each MQ Series queue to which DELMIA Apriso should publish data. The queue configuration is extensive, but each subsection is also annotated inside the configuration file. It is suggested that the MQ Series Server Administrator helps provide details for this section. Some configuration options are explained in greater detail below GetMessageOptions.Routing The routing property is not a setting for the MQ Series server, but rather for the Message Processor. If the Message Processor was not installed, this configuration can be skipped. Once the Message Processor retrieves data from the MQ Series server, it needs to pass it on to another DELMIA Apriso system. There are two options for this: Job Executor and Process Builder. With Job Executor, the message is sent as a new inbound job with the name of the root node as the transaction name, the message ID as the label, and the entire body of the message as the message for Job Executor to process. The structure of the message must conform to the assigned XSLT for the transaction name. With Process Builder, the message is pre-processed to determine the Standard Operation that should be run as well as the inputs it receives. Like the Job Executor option, the name of the root node is the name of the Standard Operation that is to be run. The message has a specific structure that must be followed for the data to be properly sent to the Standard Operation. The root node specifies the name of the Standard Operation. It also has two optional attributes for selecting a specific revision of the Standard Operation. <APR_MQ.ProcessMessage revision="2.0" fuid="1d60d7fe-f358-11e0-9ca5-03cf b"> If the revision is specified, the routing engine searches for the Standard Operation with that specific revision identifier. If the FUID is specified, the Standard Operation with that FUID is selected. This attribute overrides the revision and the name. If neither attribute is specified, the named Standard Operation with the default revision is selected. The inputs for the Standard Operation are children elements from the root node. The name of the child node corresponds to the name of the input. Input nodes have one optional attribute that defines the type of the input. The valid types correspond to the types in Process Builder: String, Integer, Decimal, DateTime, and Boolean. <APR_MQ.ProcessMessage> <ProductID type="integer">55</productid> <Name>Some Product</Name>

77 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 77 </APR_MQ.ProcessMessage> In this example, there are two data inputs: a ProductID and Name. The ProductID will be passed as an integer. Because the type is not specified, the name is passed as a String. An array of values can be passed as an input if the input node has child nodes of its own. For example: <APR_MQ.ProcessMessage> <ProductID type="integer"> <value>55</value> <value>26</value> <value>31</value> </ProductID> </APR_MQ.ProcessMessage> In this case, the ProductID is passed as an array of three values: 55, 26, and 31. Regardless of the input values, the message ID of the MQ Series message is always passed as the first input, named MessageID. This input is of the String type. Any user-defined input named MessageID will be ignored. An exception will occur if the specified Standard Operation cannot be found or if it cannot be run successfully. 8.6 MSMQ Queue Settings DELMIA Apriso Business Integrator requires MSMQ queue with the following settings: Private queue (add a queue to a private folder) Set a transactional queue

78 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 78 Not authenticated Figure 26 Private queue settings

79 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 79 Figure 27 MSMQ queue properties General tab Configure the security for the queue Ensure that the applications that write and read to/from the queue have sufficient permissions to receive and send messages On the DELMIA Apriso server, Job Executor executes Business Integrator's MSMQ Adapter, which writes to the queue, and the Apriso Incoming Message Monitor reads the message from the queue Both application services use LOCAL SERVICE as Logon As Configure LOCAL SERVICE with Full Control

80 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 80 Figure 28 MSMQ queue properties Security tab On the customer side, determine the applications used to read and write from the queue. Then ensure the user has Full Control

81 Business Integrator - Configuration Guidelines DELMIA Apriso 2018 Technical Guide 81 9 Documentation The XML schemas and mappings documentation is available and accessible from the DELMIA Apriso Start page. Login is required to view the documents. For information on building XML schemas, refer to XML Schema Builder Online Help. How Mapping and Schema Documentation Is Generated Mapforce documentation is created using a custom application that reads the Mapforce project file with the file extension MFD and creates an HTML file that documents each mapping SAP IDOC schema documentation is downloaded from SAP SAP BAPI schema documentation is created using XML Spy Schema documentation is generated by a custom application that reads the DELMIA Apriso Schema Builder-generated XML files The XML Spy Setting for Generating Schema Documentation In XML Spy, select the Schema Design Generate Documentation menu, and the Schema documentation pop-up displays. These settings (as shown in Figure 29 below) are used in creating all of the schema documentation. Figure 29 Schema documentation options screen