Ensemble XML Virtual Document Development Guide
Configuration Steps
[Back] [Next]
   
Server:docs1
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes the configuration steps needed to use XML virtual documents in a production. It discusses the following topics:

For information on settings not described here, see Reference for Settings.”
Later chapters describe how to create items to use in the production: data transformations, rule sets, and search tables.
Loading XML Schemas into Ensemble
For XML virtual documents, it is useful, but not required, to load the corresponding XML schemas into Ensemble. If the schemas are available in Ensemble, then Ensemble can validate the documents, and you can use the schema-dependent virtual property paths (rather than only the DOM-style paths). Also, the DTL editor and the Business Rule Editor provide assistance with the document structure.
To load an XML schema into Ensemble, use the XML Schema Structures page, described in the chapter Available Tools.”
Adding a Business Service to Handle Inbound XML as Virtual Documents
To add a business service to handle inbound XML documents as Ensemble virtual documents, do the following:
  1. To your production, add a business service that is based on the class EnsLib.EDI.XML.Service.FileService or EnsLib.EDI.XML.Service.FTPService.
  2. Specify where this business service will find the inbound XML documents.
    For example, for EnsLib.EDI.XML.Service.FileService, specify the File Path setting, which is the directory that the business service will check for new files.
  3. Optionally specify other settings as needed. In particular, you might want to specify the following:
  4. Specify where to send the XML documents. To do so, specify a comma-separated list of values for the Target Config Names setting. Each value should be the name of either a business process or a business operation.
Adding a Business Process to Handle XML Virtual Documents
To add a business process to handle XML virtual documents, do the following:
  1. To your production, add a business process that is based on the class EnsLib.MsgRouter.VDocRoutingEngine.
  2. For this business process, specify the Business Rule Name setting. Choose the appropriate business rule set that acts on XML virtual documents.
    For information on defining these, see the chapter Defining Rule Sets for XML Virtual Documents.”
  3. Optionally specify other settings as needed.
  4. Configure the appropriate business host or hosts in the same production to send XML virtual documents to this business process:
Adding a Business Operation to Handle XML Virtual Documents
To add a business operation to send XML virtual documents to destinations outside of an Ensemble production, do the following:
  1. To your production, add a business operation that is based on the class EnsLib.EDI.XML.Operation.FileOperation or EnsLib.EDI.XML.Operation.FTPOperation.
  2. Specify settings of this business operation as needed.
    For example, for EnsLib.EDI.XML.Operation.FileOperation, specify the File Path setting, which is the directory to which the business operation will write the files. The directory must exist and must be accessible.
  3. Optionally specify the Search Table Class setting. See the chapter Defining Search Tables for XML Virtual Documents.”
    Make sure that this search table class is consistent with the kinds of messages received by this business host. For example, if the business host receives messages whose root element is <Transaction>, it would not be appropriate to use a search table class that referred to an <Employee> element.
  4. Configure the appropriate business host or hosts in the same production to send XML virtual documents to this business operation:
You might also want to add business operations to handle bad messages (for background, see Business Processes for Virtual Documents in Ensemble Virtual Documents).