Example Farm

com.verticon.tracker.example Version 0.1.4

Contents

1. Example Farm
   1. Introduction [1]
   2. Project Contents
      1. about.html
      2. about.textile
      3. animalLifeDataUpLoad.txt
      4. autotype.metatype
      5. blood.gif
      6. capture.tags
      7. doc.admin
      8. doc.agri
      9. doc.kml
      10. HighWaterProcessing.premises
      11. example.premises
      12. logback-test.xml
      13. My.metatype
      14. NationalBeefPacking.premises
      15. PokyFeeders.premises
      16. RidgeButchering.premises
      17. Template.animal
   3. Dependencies
   4. Reporting Installation and Configuration
      1. Introduction
      2. Installation[2]
      3. Configuration
   5. Reports
      1. Run Premises Reports from a project in the Workspace
      2. Accessing Reports from a Browser

Introduction ¹

This project is an example of a typical Tracker Livestock project that uses Tracker model documents to record and manage animal identification, animal life data, animal event history, farm locations and contact information.

Project Contents

This project contains the following documents and files:

about.html

This about file, in HTML format.

about.textile

This about file in textile format.

animalLifeDataUpLoad.txt

This is data file that contains animal life data information. It was exported from a spreadsheet as a comma separated values text file. The
data values in the file are animal:id, animal:visualId, animal:species, and animal:comments. The species is either a 1 for beef or 2 for swine.

autotype.metatype

An example of an iRouter configuration metatype document. Metatype documents are used in several places within the Tracker Toolkit. This metatype document is an example of an iRouter configuration that specifies the embedded iRouter infrastructure services to integrate premises data with external weighing devices and Tracker Store data storage facilities. Those just starting out or not using the iRouter product can ignore this file. For details on the iRouter, see the iRouter User Guide Document.

blood.gif

An image file referenced by the My.metatype file to represent a custom event with an icon.

capture.tags

A simple text file with a list of example animal id numbers used as input to the Tracker import TagId Utilities. Right menu click on the file to see the Import TagId actions. Tracker Import TagId utilities make it easy to import lists of TagIds into the .premises documents.

doc.admin

An example Tracker Store Admin document for specifying users access and permissions. Those just starting out or not using the Tracker Store feature for archival or collaborative storage of premises data can ignore this file. For details on the Tracker Store, see the Tracker Store feature in the Tracker Desktop BI Toolkit Documentation.

doc.agri

An example Agriculture document used for identifying one or more .premises documents as part of an association. .premises documents referenced in an Agriculture Association can be used as input to the Tracker Location service for identify animal locations for all .premises documents throughout the workspace. See the Location Service documentation for more details.

doc.kml

An example Geography document used in GIS and industry standard GeoBrowswers like Google Earth.

HighWaterProcessing.premises

An example business associate premises, with premises and location information but without any animals. It is referenced in the doc.agri association element and will serve as a location in the location service.

example.premises

An example Premises document that contains example animals, animal life data, animal histories, premises details, location details, location areas and two custom events via a reference to the My.metatype document.

logback-test.xml

An example logging configuration file. Use this under the direction of Verticon technical support.

Logging Configuration

1. Modify the tracker.ini in the installed directory of the tracker to add the lines

-Dlogback.configurationFile=file:${workspace_loc}/com.verticon.tracker.example/logback-test.xml
-Dlogback.application=TrackerProduct
after the -vmargs line.

Where ${workspace_loc} is the installed directory of the tracker.

My.metatype

An example Metatype document that specifies to custom events. This document is referenced by the example.premises document to enable users to add these two custom events to animals included in the example.premsies document.

NationalBeefPacking.premises

An example business associate premises, with premises and location information but without any animals. It is referenced in the doc.agri association element and will serve as a location in the location service.

PokyFeeders.premises

An example business associate premises, with premises and location information but without any animals. It is referenced in the doc.agri association element and will serve as a location in the location service.

RidgeButchering.premises

An example business associate premises, with premises and location information but without any animals. It is referenced in the doc.agri association element and will serve as a location in the location service.

Template.animal

An example Animal document used by Tracker import utilities and RFID reader services to add new Animals and events to a .premises document.

Dependencies

This example uses:

1. The Tracker Premises Model Editor feature com.verticon.tracker.editor
2. The Tracker Location Service com.verticon.locaton
3. The Tracker Agriculture Model Editor com.verticon.agriculture.editor
4. Eclipse BIRT org.eclipse.birt
5. Tracker Premises Report Pack, com.verticon.tracker.report.pack

Reporting Installation and Configuration

Introduction

Tracker utilizes BIRT report design documents, BIRT shared resources for creating reports based on information in Tracker premises documents. With Tracker BIRT reports can be created that can be reused to report on information from different data model instances in projects.

Tracker also support the notion of report packs. These report packs are predefined sets of reports that can be installed and copied to projects or referenced in place to report on data in premises documents. When Tracker detects a report pack at startup it loads all the reports and styles into the BIRT resource library.

To get started you will need to install the Premises report pack, make some changes to the configuration, and copy the report or reference the report in place through html page.

Installation²

1. Provision and install the Tracker Premises Report Pack com.verticon.tracker.report.pack
2. If you haven’t already done so, import and copy this project into the workspace.³

Configuration

When tracker starts up, it loads all drivers and installed report packs to the BIRT resource directory. Then it starts a web server and sends it a test report.

1. Change user preferences General | WebServer to select an internal or external web server
2. Change user preferences Report Design | Preview | Preview Server to select the port number for the preview server. The reports in the reports pack use 8080 as the server port to prevent conflict with any other web servers running on the computer.
3. Modify the tracker.ini in the installed directory to add the line -Dstart.webserver=true after the -vmargs line. This will start the web server when the Report Design perspective is opened in the workspace. You must open the open the Report Design perspective in order to run a Tracker report pack report.

Reports

Tracker reports are intended to be reused with different data model instances in projects. These model documents are referenced by the report design documents as variables placed inside a reports/report.properties file.

Run Premises Reports from a project in the Workspace

1. Create a reports directory in this project.
2. Copy the report.properties file from the reports/report.properties in this example project to this directory
3. Open the file and edit the line to rp_premises_doc = platform:/resource/com.verticon.tracker.example/example.premises
4. Open the Report Design perspective. This will start the web server and send a test report to it.
5. Make sure the Resource Explorer view is showing. If not show it: Windows | Show View | Report Design | Resource Explorer.
6. Make sure that the report.properties file is opened in an editor. This will insure that the Shared Resources are showing in the Resource Explorer.
7. Copy the reports you want from the reports directory in the Resource Explorer to the reports directory of you project.
8. Optionally modify one or more of the reports for new functionality. To keep the location independent functionality use the datasets or the data sources from the premises.rptlibrary deployted to the BIRT resources directory.
9. From the Navigator View select the rptdesign file you wish to run, right click to get the popup menu and select the Report and Run Report menu item.

Accessing Reports from a Browser

Reports can also be launched from a browser with a parameterized URL that specifies the hostname of the running BIRT Web Server, the report file path and the premises document to use as a DataSource. This is a convenient way to use reports loaded from report packs.

The easiest way to run these reports is to create a HTML document that embeds these parameterized URLs. The following section is an example of how to do this. ⁴

Tracker Report Pack Reports

Reports from Tracker report packs are preloaded in the BIRT Web Server and can be launched with simple location independent paths to the reports.

• The parameter __report is a relative path to the report deployed in the BIRT Web Server.
• The parameter rp_premises_doc is a platform based url referencing the premises document in the workspace.

Reports in the Workspace⁵

To access browser based reports that are in the workspace or the file system, you will have to use absolute paths to the rptdesign file.

• The parameter __report is a absolute path to the report deployed in the file system.
• The parameter rp_premises_doc is a platform based url referencing the premises document in the workspace.

¹ This document was created with the Wikitext textile editor. If you would like to edit this document or create documents
with WikiText, see Getting Started with WikiText

² To install the software go to the menu Help | Install New Software | Tracker Release | BIRT | Tracker Premises Report Pack

³ Imported projects are not required to be copied into the workspace default locations. Use caution when working with imported but not copied projects, least they affect other user workspaces.

⁴ The links in the table will need prior configuration that is specific to your system in order to work on your local host. First, you must set the user preferences: Report Design | Preview enable use external browser and Report Design | Preview | Preview Server and set the port. Next, change the port in the links to reference the port you set. Finally, you must edit the links to reference the absolute paths to the reports. For reports to work you may need to initial the ReportViewer Servlet by launching a report from the popup menu first.

⁵ These are only examples as the URL to the report is system specific.