Constructing a Flat Files Schema – Practical example
For this project we will use the BizTalk Server 2010 and Visual Studio 2010, and explain step by step what needs to be developed. Briefly these are the steps we have to perform:
- Creating an instance of the text file that will serve as a test file for the project;
- Creating the Schema which will recognize the text file;
- Creating the Pipeline that will be responsible for processing and transforming the text file;
- Deploy the BizTalk Server solution;
- Configuring the BizTalk application;
- Run the solution;
The solution of this example, as well all the code, is available on MSDN Code Gallery: http://code.msdn.microsoft.com/BizTalk-Server-Transformar-0abe5767
We begin then by launching Visual Studio 2010 and create a new BizTalk project:
- “File –> New –> Project”, on BizTalk Projects, select the option “Empty BizTalk Server Project”;
- Insert the project name, physical location on the disk and the name of the solution.
Creating an instance of the text file that will serve as a test file for the project
Before we begin our development we need to create an instance, or sample of the text file that will serve as a model for the creation of the Flat File Schema. Therefore we will create the following text file on our file system that will be used in our solution:
- Create a folder “<solution>\TESTFILES” where we will create/put the messages we want to transform. In this article we will use a text file delimited by symbols which will be composed of several lines with the following content:
Sandro;Pereira;1978-04-04;Crestuma;4415 Crestuma Lígia;Tavares;1982-01-21;Seixo-Alvo;451 Seixo-Alvo José;Silva;1970-09-19;Crestuma;4415 Crestuma Rui;Barbosa;1975-09-19;Lever;4415 Lever
Each line consists of the following structure: Name (Nome), Surname (Apelido), Birthdate (Data Nascimento), Address (Morada) and Zip Code (Código Postal);
Note: in () is the equivalent in Portuguese found in pictures. The file “PESSOAS.txt” that we use for testing is available in the directory “<solution >\TESTFILES”.
- We will also create two folders that we will configure in the BizTalk Administration Console in order to test the solution.
- Create a folder “<solution >\PORTS\IN” which will serve as the place of entry of Flat File files for conversion;
- Create a folder “<solution >\PORTS\OUT” which will serve as the output location of the files after they have been converted.
Creating the Schema which will recognize the text file
To create the schema which will recognize the text file, we need to go to the BizTalk solution created in Visual Studio and perform the following steps:
- Press the right button on top of the project in Solution Explorer, and select the option “Add –> New Item…”.
- On “Installed Templates” menu in the window “Add New Item”, select the option “Schema Files”, and then select the option “Flat File Schema Wizard”, then provide the name you want to give the scheme in this example: “TXT_to_XML.xsd”
- By selecting this option, we will be guided automatically by the tool “BizTalk Flat File Schema Wizard” that will help us to create a Flat File Schema and define its data structure (records, elements, attributes …) based on the text file specified. Select “Next” to continue.
- In the window “Flat File Schema Information” we will have to:
- Select an instance of the text file that will serve as the model of the structure that we want to transform;
- Although it is not necessary, it is good practice to rename the Record name “Root”. In this case we will rename it to “People” (Pessoas)
- And finally, assign a “Target namespace” to the scheme and define the encoding of the input file
- The wizard will load the text file so that we can begin to split it and map it into the desired structure. In this step we need to define how the records or rows are differentiated. The structure of the example is:
Name;Surname;Birthdate;Address;Zip Code{CR}{LF}
(Nome;Apelido; Data Nascimento;Morada;Codigo Postal{CR}{LF})
Since each record “Person” (Pessoa) that we want to create is defined and contained in a line, in the “Select Document Data” we will select all the data portion of the document that will set the record, i.e. the whole first line.
- In the window “Select Record Format” we will define whether we are dealing with a Flat File Delimited by symbols or is positional, in our case we will select the “By delimiter symbol” which is delimited by a return Carriage Return/Line Feed.
- In the window “Delimited Record” we will provide the record delimiter, in this case as we want to define the structure of person (Pessoa), i.e. each row is a person, our limiter is {CR}{LF} (Carriage Return/Line Feed)
- In the window “Child Elements” we will define what kind of element we want to assign to the registry. As we are defining the Person structure and the file contains multiple people, we have to select the “Element Type” as “Repeating record.” If we do not perform this step, we will not have the ability to split the record into multiple elements / attributes individual.
- At this stage we successfully created the record Person (Pessoa), i.e. we have just map that each line of the text file corresponds to a record Person. In the “Schema View” select “Next” to continue processing the message
- At this stage the wizard restarts the whole process described above, but if you noticed, the wizard no longer selects all information contained in the text file, but only what was selected to define the record Person. What we will do now is split the information of record “Person” in different elements, for that, we will select only the information required leaving out the Carriage Return/Line Feed.
- Once again our structure is delimited by symbols (;), then we will select the option “By delimiter symbol”
- As we can analyze all the elements are separated by the semicolon (;) that is our delimiter, then in the window “Delimited Record” we must change the value of the “Child delimiter” option to “;”.
- In this window “Child Elements”, we will define the different elements/attributes of the structure of the record person. This operation is very similar to any XSD, where we can define the different names and data types. Adjust the values according to the image:
- Finally the wizard will show the equivalent XML structure that your text file document will have. Once you select the option “Finish”, the scheme will be available for you to use in your BizTalk solution.
After we finalize the creation of the Flat File Schema which will contain the transformation rules of the text file, we can easily test our transformation, without having to get out of our development tool (Visual Studio) and without having to publish our solution.
If we select the Flat File Schema that we just created and access to its properties, we can see that by default all properties are preconfigured so that we can perform tests to our message transformation: the input instance file is configured with the file which was used to create the schema; and the correct input (Validate Instance Input Type: Native) and output (Generate Instance Output Type: XML) formats.
To test, you simply select the schema and with the right mouse button select the option “Validate Instance”:
This option will use the configured file and validate all transformation rules defined and subsequently present the final result or occurring errors:
Creating the Pipeline that will be responsible for processing and transforming the text file
To create the Receive Pipeline that will be responsible for processing and transforming the text file, we need to go to the BizTalk solution created in Visual Studio and perform the following steps:
- Press the right button on top of the project in Solution Explorer, and select the option “Add –> New Item…”.
- On “Installed Templates” menu in the window “Add New Item”, select the option “Pipeline Files”, and then select the option “Receive Pipeline”, then provide the name you want to give the pipeline in this example: “ReceivePipelineCustomPessoas.btp”
- By selecting the option “Add”, the pipeline editor (BizTalk Pipeline Designer) will appear and that will let you view and add components to all the steps associated with receive pipeline: Decode, Disassemble, Validate and ResolveParty. In this case, the pipeline that we will create, will be responsible for receiving a text file through a receive location and convert it to XML. For that, we will use the “Flat File Disassembler” component which is available in the Visual Studio Toolbox window (Ctrl+W, X). Drag it into the Pipeline in step “Disassemble”.
- Finally, select the component “Flat file disassembler”, go to its properties and on the “Document Schema” option: select the schema created earlier, in case the “TXT_to_XML.”.
Note: If you want to create a send pipeline in order to transform an XML document into Flat File, we would follow the same steps, the difference is that we would have to drag the component “Flat File Assembler” on stage “Assemble”.
Deploy the BizTalk Server solution
All artifacts created yet must be installed on BizTalk Server 2010. However before we can deploy the solution there are some settings we need to do or guarantee:
- Before deploy the Visual Studio solution into a BizTalk application is necessary that all project assemblies are signed with a strong name key, since they must be installed in the global assembly cache (GAC). For this we need:
- In Visual Studio Solution Explorer, right-click on the project name and select “Properties” option
- Select the “Signing” tab and choose “New” in the drop down box “Choose a strong name key file”
- Assign a name, for example “TXTtoXML.snk”
- Likewise, before deploy the Visual Studio solution into a BizTalk application, we need to first define the BizTalk deployment properties, especially the properties of the “BizTalk Group”. If the Visual Studio solution contains multiple projects, we need to set the properties for each project separately.
- In Visual Studio Solution Explorer, right-click on the project name and select “Properties” option
- Select the “Deployment” tab and configure the name you we want to assign to the BizTalk application in the property “Application Name”: in our example “TransfFlatFilesEmXML Demo”. The remaining properties may stay with the default values.
- To learn more about these properties go to http://msdn.microsoft.com/en-us/library/aa577824.aspx
Finally we can Build and Deploy the project so that it is published as an BizTalk application inside BizTalk Server:
However in order to publish a BizTalk solution, you must be a member of the group “BizTalk Server Administrators”. If the option “Install to Global Assembly Cache” is enabled, on the “Deployment” properties, then you also need permissions to read/write on GAC.
Related links
- BizTalk Server: Transform text files (Flat Files) into XML – Introduction (Part 1)
- BizTalk Server: Transform text files (Flat Files) into XML – Necessary tools and artifacts (Part 2)
- BizTalk Server: Transform text files (Flat Files) into XML – Conclusion (Part 4)
