A report model is a file created used to define where regions of specific text can be found in the report file. It contains the extraction logic as well as settings to control how data should be exported from the related report file. This model establishes what needs to be extracted from the report file by using specified patterns. This model can be reused and applied to multiple files.
A report model consists of 3 main components:
Data fields belonging to those regions.
Patterns to define the data regions
A data region is an area of data captured within your report. This can encompass any number of lines within your report. There are different types of data regions. These can include data region, header region, footer region, and append region.
Data Region: This is the most common type of region. This is the area specified by the pattern.
Header: This is the area of data located at the very top of the page. You would add this region if you are trying to extract header information that may repeat on each page.
Footer: This is the block of data located at the very bottom of the report.
Append: This type of region can be used to append additional data to your model. (See Append Regions for more details).
A field is an area of data inside a region. This area is the data that needs to be extracted. An example of these data fields within a region can be seen in the below images. For example: Item, Quantity, Description, Item Code, Price, and Total. These are all the fields that will be extracted. In the image below, the fields have been selected (highlighted) and added to the model.
A pattern identifies the records that you need to extract from the report document. ReportMiner looks for the specified pattern and will capture each line of text that matches this pattern. It is important to be specific with your pattern, to ensure you are capturing the correct lines and only these lines.
To create a new report model, go to File -> New and select Report Model.
The “Report Options” window will pop up. This is where you will select the file you will be extracting from. Select your file and click OK.
Your report will open in the report editor window. The next step is to add your data regions.
Go to the Model Layout and right click on the “Record” node and select “Add Data Region”.
Once you add your first data region, the pattern box will appear. This is where you will type in your pattern that will specify your data region. In this example, you can use the "match any digit" symbol. Once you specify the pattern, this area is highlighted.
Now you can go in and add your data fields. Highlight the data field area, right click and select “Add Data Field”. These are highlighted once you add each field.
This is what your model layout looks like once you add your data region and fields.
- Make sure to change your data region and field names to something relevant. Names cannot contain spaces or special characters.
Click the Magnify glass “Preview” button to preview your data and make sure everything is extracting correctly. Once you do this, you are ready to export.