Difference between revisions of "Main Page"
Line 16: | Line 16: | ||
:: Device (or Tag) entity represents the physical telemetry device hardware that collects particular telemetry data. Any tracking and sensor data need to be linked to some device. | :: Device (or Tag) entity represents the physical telemetry device hardware that collects particular telemetry data. Any tracking and sensor data need to be linked to some device. | ||
− | :: Additional attributes related to the hardware ( | + | :: Additional attributes related to the hardware (brand, model, serial no., GSM no., etc.) can be stored in the device structure and viewed in [[the Device profile]]. |
:: Devices are created automatically in the system while importing a new telemetry dataset (via Import or Integration flow) or created by us in the case of Anitra devices (created as part of the device purchase process). | :: Devices are created automatically in the system while importing a new telemetry dataset (via Import or Integration flow) or created by us in the case of Anitra devices (created as part of the device purchase process). | ||
Line 144: | Line 144: | ||
Depending on the importance and complexity of a particular entity, the detail page might be rather simple (e.g. Person/User profile) or more structured and information-rich (e.g. Tracking/Animal profile). Most important entity pages are described here: | Depending on the importance and complexity of a particular entity, the detail page might be rather simple (e.g. Person/User profile) or more structured and information-rich (e.g. Tracking/Animal profile). Most important entity pages are described here: | ||
− | =={{Fa|fa-user}} Organisation/Customer | + | =={{Fa|fa-user}} Organisation/Customer== |
A section visible in the side menu (only) for users with Admin/Owner relations to Organisations listed in the system. | A section visible in the side menu (only) for users with Admin/Owner relations to Organisations listed in the system. | ||
Line 173: | Line 173: | ||
* Anitra works as private and secure storage and a visualization tool of these data only. | * Anitra works as private and secure storage and a visualization tool of these data only. | ||
− | |||
+ | =={{Fa|fa-tablet}} Device== | ||
− | = | + | * Device identification, meta info, status, overview, and admin management |
+ | * Device data visualized on the map and on the timeline | ||
+ | * Definition of tracked animal (create, edit, delete) | ||
+ | ** Removal of testing/manipulation/storage periods | ||
+ | ** Creation/split of device data into real tracked animals (situation when one logger was subsequently used for more than one animal) | ||
+ | * Last known geolocation (DateTime + country etc.) | ||
+ | * System of warnings | ||
+ | ** Incorrect/Missing Device-TrackedObject configuration | ||
+ | ** Mortality indication: red/black warning in "Last device Position" row (red = for deployed and currently tracking devices/black = tracking finished) | ||
+ | ** Missing data last X days: red warning in "Last Device Position" row (warning active just for deployed and currently tracking devices) | ||
+ | * Summary for related TO profiles including Mortality Indication symbols | ||
− | + | :[[File:Capture_3.JPG|900px]] | |
− | |||
− | |||
− | |||
+ | =={{Fa|fa-paw}} Tracking & Animal == | ||
− | = | + | * Details of tracked object (= tracking of the individual animal) |
− | + | ** Identification (code, name, ringing, tagging, etc.) | |
+ | ** Info related to particular Individual (species, sex, age, origin) | ||
+ | ** Info related to Start of tracking (including photo and file documentation) | ||
+ | ** Info related to End of tracking (~ mortality/device failure) | ||
+ | * System of warnings | ||
+ | ** Mortality indication: <span style="color:red">red</span>/black warning in "Last known Position" row (<span style="color:red">red</span> = for deployed and currently tracking devices / black = tracking finished) | ||
+ | ** Missing data last X days: <span style="color:red">red</span> warning in "Last Device Position" row (warning active just for deployed and currently tracking devices) | ||
+ | :[[File:TOP00.JPG|738x138]] | ||
− | + | * Tracked animal data visualized on the map and on the timeline <br>[[File:TOP01.JPG|900px]] | |
− | : | + | * "Share" button allows sharing Tracking to other Anitra users |
+ | * Possibility to attach photos /documents related to | ||
+ | ** Tracking start | ||
+ | ** Mortality | ||
+ | * Same photo can be shared by various Trackings <br>[[File:TOP02.JPG|900px]] | ||
− | + | = Lists, Grids= | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | ||
− | |||
− | |||
− | |||
− | |||
− | |||
==Device list== | ==Device list== | ||
Line 239: | Line 237: | ||
:[[File:Capture_2.JPG|900px]] | :[[File:Capture_2.JPG|900px]] | ||
− | == | + | ==Tracking List== |
+ | |||
+ | * List of owned Trackings (tab "my trackings") | ||
+ | * List of Trackings shared with me (tab "shared with me") | ||
+ | * Overview of all Trackings including first and last data | ||
+ | ** Click through to Tracking detail/profile | ||
+ | ** System of warnings | ||
+ | ** Mortality indication: "Tracking" followed by <span style="color:red">red</span> <span style="color:red">skull</span> symbol | ||
+ | ** Missing data last X days: "Last Data " followed by red question mark <span style="color:red">"?"</span>. Mouse-over symbol tells the last data delay. | ||
+ | * Filter functionality: allows filtering your trackings by criteria | ||
+ | ** Predefined quick filters, which cannot be modified (Mortality Warning, Last data warning only, Anitra devices only) | ||
+ | ** Customized quick filters, which filter Trackings by set criteria (e.g. Tracked Objects, Name fields, Note fields..), you can set multiple criteria at once | ||
+ | ** You can save your customized filter with the green "check" icon | ||
+ | ** "Eye" icon enables to pin the particular Quick filter into the Quick filter panel next to the Search box <br>:[[File:ksdjf.JPG|900px]] | ||
+ | ** You can turn on multiple Quick filters at once in the Quick filter panel | ||
+ | |||
+ | = Graphs= | ||
− | + | ={{Fa|fa-photo}}PHOTO GALLERY: Where do I browse all the photos? = | |
− | + | ||
− | + | * Displays a complete gallery of pictures from all the Trackings (own and shared) | |
− | + | * Filtering by main attributes <br>[[File:TO.JPG|900px]] | |
− | * | ||
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | |||
− | |||
− | = | + | = {{Fa|fa-cog}} Anitra Device Configuration = |
: ''For complete detail of all the configuration options see the configuration guide [[configuration| to the latest firmware version ]] or to [[configuration_fw2| older versions respectively]].'' | : ''For complete detail of all the configuration options see the configuration guide [[configuration| to the latest firmware version ]] or to [[configuration_fw2| older versions respectively]].'' | ||
<br> | <br> | ||
Line 273: | Line 279: | ||
: ''For complete detail of all the configuration options see the configuration guide [[configuration| to the latest firmware version ]] or to [[configuration_fw2| older versions respectively]].'' | : ''For complete detail of all the configuration options see the configuration guide [[configuration| to the latest firmware version ]] or to [[configuration_fw2| older versions respectively]].'' | ||
− | |||
− | == | + | = Filters= |
+ | |||
+ | |||
+ | = [[DATA_FLOWS | DATA FLOWS: How do I get the data IN/OUT?]] = | ||
+ | ''[[DATA_FLOWS|A detailed guide to to all the data flows here]].'' | ||
+ | |||
+ | : Anitra offers a range of data manipulation options on how to get data and metadata IN or OUT of the platform. | ||
+ | |||
+ | : This functionality area involves features such as Import, Export, Ddata Integration or API | ||
− | + | : The options range from purely manual (e.g. [[DATA_FLOWS#.28OUT.29_Manual_DATA_Export|manual data exports]] or [[DATA_FLOWS#.28IN.29_Manual_data_import|data imports]]) to fully automated (e.g. [[DATA_FLOWS#.28IN.29_Inbound_DATA_flows|inbound data flows for Ornitela, Ecotone, or Movebank]]). | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | : Some flows make sense for the particular user but most of the data management tools are meant to be configured at the level of customer/organization (hence available in customer profile) | |
− | + | : Outbound data flows | |
− | * | + | :* [[DATA_FLOWS#.28OUT.29_Manual_DATA_Export|Data Export]]<br>[[File:export_tracking_profile.JPG|900px]] |
− | * | + | :* [[DATA_FLOWS#.28OUT.29_Manual_METADATA_Export|Metadata Export]]<br>[[File: export_meta_tracking_grid.JPG|900px]] |
− | + | :* [[DATA_FLOWS#.28OUT.29_Anitra_API_data_.26_metadata_access|API (both data and metadata)]] | |
− | + | :* [[DATA_FLOWS#.28OUT.29_Anitra_to_Movebank_data_feed|Anitra to Movebank data feed]] | |
− | |||
− | |||
− | * | ||
− | :[[ | ||
− | * | + | : Inbound data flows |
+ | :* [[DATA_FLOWS#.28IN.29_Inbound_DATA_flows|Data integration of external data sources (i.e. connectors for Movebank, Ornitela, and Ecotone available)]]<br>[[File:Inbound_connection_overview.jpg|600px]] | ||
+ | :* [[DATA_FLOWS#.28IN.29_Manual_data_import|Data Import]]<br>[[File:manual_customer_import.JPG|900px]] | ||
− | + | ''[[DATA_FLOWS|A detailed guide to to all the data flows here]].'' | |
− | |||
− | |||
− | |||
− | |||
+ | = Warnings, Notifications= | ||
Line 321: | Line 317: | ||
: [[MORE_GUIDES| Tracking EndDate & Mortality warnings]] | : [[MORE_GUIDES| Tracking EndDate & Mortality warnings]] | ||
− | : [[GUIDE_2021_11_04| | + | : [[GUIDE_2021_11_04| Previus version of the guide (version before 2021-11-04)]] |
Revision as of 09:23, 4 November 2021
ABOUT
- Anitra platform is a flexible environment that allows storing, analyzing, and visualizing telemetry data. On top of actual telemetry data, a lot of additional metainformation and field information can be stored to document and visualize data in a very rich context. Anitra is primarily tailored to manage even very complex telemetry projects but similarly, a single user data can be comfortably maintained.
- The tool allows hosting data generated by transmitters of any brand however some of the more advanced features are tailored to complement the unique onboard functionality of ANITRA GPS-GSM transmitters only. Part of the core functionality serves as a device backend for Anitra tags (a functionality meant Data Owners/Admins). An elaborated sharing scheme allows granting a full range of access rights from "admin" to "view only". Data in form of the maps can be made public in a very controlled and safe way. Most of the platform functionality is free of any charge and available to anyone having some defined access rights to particular data sets. Some data-intensive areas such as data/photo storage might be possibly restricted or charged per amount of data.
- Home screen of ANITRA platform is at https://app.anitra.cz/
MAIN CONCEPTS
- Anitra data model is based on the following key concepts:
- Device
- Device (or Tag) entity represents the physical telemetry device hardware that collects particular telemetry data. Any tracking and sensor data need to be linked to some device.
- Additional attributes related to the hardware (brand, model, serial no., GSM no., etc.) can be stored in the device structure and viewed in the Device profile.
- Devices are created automatically in the system while importing a new telemetry dataset (via Import or Integration flow) or created by us in the case of Anitra devices (created as part of the device purchase process).
- Each device has its "Ownership" defined i.e. definition of which organization or individual user created it or has the master administration access to it granted (including delete rights) - see more below.
- Animal
- Animal (or Individual) entity represents a particular animal/individual
- The main attributes for an Animal are its Species, Sex, and Dates when Born and Died (~ which also defines the current age e.g.).
- Additional complex meta-information can be linked-to Animal such as origin info, relationships to other animals, ringing, tagging or trapping details, and mortality attributes
- Photos (or documents) can be attached either directly to the Animal entity or indirectly to some related entities or Events such as Tagging or Mortality.
- Tracking
- Tracking (or Deployment) entity defines the relationship between Devices and Animals primarily in terms of time.
- The date(time) interval defines when the device was physically attached to the Animal
- Note when looking at the timeline of a particular Animal, multiple telemetry devices might have been used to track it subsequently (e.g. first tag failed and removed or was shed by the animal). Similarly, when analyzing Device usage history a single device might have been possibly reused several times for Tracking various animals (e.g. one animal died, the tag was recovered and reused elsewhere).
- Besides the time aspect, some additional details such as place of tagging, place of release, tagging persons, various notes, photos, etc can be attached to Tracking Start/End.
- Tracking inherits permissions from its parent Device entity so users with device owner/admin access can create and modify the deployments as well.
- Device Data, Records, Positions
- A basic level of tracking/measurement information
- Data are accessible refering Devices, Trackings and Animals (s)
- Group, Project, Study
- Person, User, Role
- Data owners can make their data available to other users or even make their data public in a simplified and secured way using an elaborated sharing scheme. Each user can act in both modes (i.e. admin for owned or administered devices and viewer for data shared with him by others). Most of the platform functionality is free of charge and available to anyone. Only large data volumes might be possibly restricted or charged.
- Organisation, Customer
- Place, Point of Interest (POI)
- Event, Observation
FUNCTIONALITY AREAS
Contents
- 1 SIGNING IN - How do I get into the app?
- 2 MAPS
- 3 DETAIL PAGES: Where can I view and manage the full detail?
- 4 Lists, Grids
- 5 Graphs
- 6 PHOTO GALLERY: Where do I browse all the photos?
- 7 Anitra Device Configuration
- 8 Filters
- 9 DATA FLOWS: How do I get the data IN/OUT?
- 10 Warnings, Notifications
- 11 MORE GUIDES
SIGNING IN - How do I get into the app?
- Home screen of the ANITRA platform is at https://app.anitra.cz/
- New users can register in the system either using "Create new account link" or using the "SIGN IN WITH GOOGLE" button (you will not need to type user name+pass anymore)
- Note new user can also be created by other existing users sending an invitation to the new person from access granting wizards (e.g. sharing tracking, adding admins, or assigning project access) - typing a new email address launches the invite process
- Once you have your account created and active you can log in either typing user name and password or using Google sign-in feature
MAPS
MAIN MAP: How do I start viewing data?
- The functionality displays all the Tracked Individuals available to a user (both owned/administered and shared only)
- By default an overview of the last positions is shown - the color of the point categorizes data by the last data update.
- Filtering functionality below the map limits data in the map and in the right Tracking selection list by following criteria:
- "Search" (full text search across Device/TO codes/names/aliases)
- Species
- Last "X" Days (limits all the data showing specified last X days interval)
- Other: Tracking Status, Country of Tagging, Current Age
- Map functionality
- Tracking details
- Track point details in the tooltip (note that more track point tooltips can be displayed simultaneously)
- Additional Tracking detail in the right TO selection list (including "Share" button for admins)
- Click through the link to a particular Tracked Object profile
- Tracking Mortality Indicated by black/red symbols in the right Tracking side selection and in the tooltips
PUBLISHED MAPS: How do I show an overview of our study results to the public?
A detailed guide to to Published maps functionality is available here.
- A tool tailored to configure simplified and secured live telemetry maps from your full data sets.
- Configured maps are available in form of a link or in form of short HTML code which can be simply added to your web presentation or published on Facebook.
- Map output can be created:
- * on top of single organization data
- * or accross more complex ownership structure of covered by a "project"
- The functionality includes:
- animal selection
- language variants
- tracks vs. last position modes, grouping options, ordering, data filtering (e.g. track simplified to one position a day)
- security features (security delay, zoom restriction, position "rounding")
- presentation and visualization tools (a default map selection, icon/track styles, choice of icons, logos with links, foto gallery)
- samples showing some of the map features
- map with tracks and gallery: https://app.anitra.cz/share/map/5d2e379ed6f9c
- map of last positions with categories: https://app.anitra.cz/share/map/5f1a97bb13ba5
A detailed guide to to Published maps functionality is available here.
DETAIL PAGES: Where can I view and manage the full detail?
Most entities in Anitra carry a certain list of attributes and offer a range of functions and operations related to it. The place that accommodates all this is a detail or profile page of it.
Depending on the importance and complexity of a particular entity, the detail page might be rather simple (e.g. Person/User profile) or more structured and information-rich (e.g. Tracking/Animal profile). Most important entity pages are described here:
Organisation/Customer
A section visible in the side menu (only) for users with Admin/Owner relations to Organisations listed in the system.
- users not having any role in any organization do not see this section
- in case the user is active in more organizations the list of these is displayed first
Organization details such as contacts and access roles can be edited on the organization profile.
- main customer admin (owner) is assigned
- owner can make other people admins granting them "customer admin" role.
- customer owner(admins) have full access to devices belonging to a particular customer/organization account (can export data, manage trackings and animals, etc.)
Billing summary and payment history is also available in the Customer profile once any (data fees related) ivoices were booked
- note the term "customer" refers to any "organization" having some kind of (active or past) commercial agreement with Anitra company
- the cost overview is typically visible upon initial invoicing is accounted
There is a place to define and review customer published maps i.e. a creation wizard for maps construction.
Various inbound and outbound data flows from manual data export to fully automated can be managed for organization account
- (IN) Inbound data flows (connectors for Movebank, Ornitela, and Ecotone available)
- (IN) Manual data import (see the Import functionality)
- (OUT) API data access
- (OUT) Manual data export
- (OUT) Anitra to Movebank datafeed
Note, only the legal owners of original data are allowed to configure inbound data flows!
- Any data uploaded manually or synchronized automatically to Anitra are linked to a particular legal entity (Organisation / Customer) represented by its "owner" i.e. person in charge.
- The ownership of and the responsibility for all the data remain with this legal entity. This organization's owner and admins assigned by the owner retain full control over the data related to this entity.
- Anitra works as private and secure storage and a visualization tool of these data only.
Device
- Device identification, meta info, status, overview, and admin management
- Device data visualized on the map and on the timeline
- Definition of tracked animal (create, edit, delete)
- Removal of testing/manipulation/storage periods
- Creation/split of device data into real tracked animals (situation when one logger was subsequently used for more than one animal)
- Last known geolocation (DateTime + country etc.)
- System of warnings
- Incorrect/Missing Device-TrackedObject configuration
- Mortality indication: red/black warning in "Last device Position" row (red = for deployed and currently tracking devices/black = tracking finished)
- Missing data last X days: red warning in "Last Device Position" row (warning active just for deployed and currently tracking devices)
- Summary for related TO profiles including Mortality Indication symbols
Tracking & Animal
- Details of tracked object (= tracking of the individual animal)
- Identification (code, name, ringing, tagging, etc.)
- Info related to particular Individual (species, sex, age, origin)
- Info related to Start of tracking (including photo and file documentation)
- Info related to End of tracking (~ mortality/device failure)
- System of warnings
- Mortality indication: red/black warning in "Last known Position" row (red = for deployed and currently tracking devices / black = tracking finished)
- Missing data last X days: red warning in "Last Device Position" row (warning active just for deployed and currently tracking devices)
- "Share" button allows sharing Tracking to other Anitra users
- Possibility to attach photos /documents related to
- Tracking start
- Mortality
- Same photo can be shared by various Trackings
Lists, Grids
Device list
- List of owned or administered devices (= hardware)
- Click through to device details (profile)
- Available device types:
- "Anitra": used for Anitra native devices, device functionality includes remote control of active devices in the field
- "Ecotone": virtual devices for Ecotone data, the possibility of the data feed from Ecotone web (available on request)
- "Ornitela": virtual devices for Ornitela data, possibly of data feed on Ornitela web (available on request)
- "Upload/Basic": devices created through Import functionality, any other tracking data, the user who uploads become Device Owner
- Semi-automatic Device Status assignment: devices categorized into activity groups (archive, deployed, backup/stock)
- System of warning messages
- Incorrect/Missing Device-TrackedObject configuration: "Device Code" followed by the black/red exclamation mark ( "!" or "!" )
- Mortality indication: "Device Status" colored in red and followed by red skull symbol
- Missing data last X days: "Last Device Position" followed by red question mark "?". The mouse-over symbol tells the last data delay.
- Filter functionality: allows filtering your devices by criteria
- Manageable through Filter manager next to the Search box, marked with icon
- Predefined quick filters, which cannot be modified (Missing data in the last 7+ days, Anitra devices only, Powered off devices, Wrong tracking configuration, Deployed devices, Mortality indication)
- Customized quick filters that filter devices according to specified criteria (e.g. Device list, Name fields, Device notes..), you can set multiple criteria at once
: - You can save your customized filter with the green "check" icon
: - "Eye" icon enables to pin the particular Quick filter into the Quick filter panel next to the Search box
: - You can turn on multiple Quick filters at once in the Quick filter panel
- Device information (and configuration) is accessible only to owners/admins (users of shared data do not have the rights to see this data)
Tracking List
- List of owned Trackings (tab "my trackings")
- List of Trackings shared with me (tab "shared with me")
- Overview of all Trackings including first and last data
- Click through to Tracking detail/profile
- System of warnings
- Mortality indication: "Tracking" followed by red skull symbol
- Missing data last X days: "Last Data " followed by red question mark "?". Mouse-over symbol tells the last data delay.
- Filter functionality: allows filtering your trackings by criteria
- Predefined quick filters, which cannot be modified (Mortality Warning, Last data warning only, Anitra devices only)
- Customized quick filters, which filter Trackings by set criteria (e.g. Tracked Objects, Name fields, Note fields..), you can set multiple criteria at once
- You can save your customized filter with the green "check" icon
- "Eye" icon enables to pin the particular Quick filter into the Quick filter panel next to the Search box
: - You can turn on multiple Quick filters at once in the Quick filter panel
Graphs
PHOTO GALLERY: Where do I browse all the photos?
- Displays a complete gallery of pictures from all the Trackings (own and shared)
- Filtering by main attributes
Anitra Device Configuration
- For complete detail of all the configuration options see the configuration guide to the latest firmware version or to older versions respectively.
- Users with admin rights can access the configuration from the lists and profiles using cogwheel icons. Note the configuration functionality is available for Anitra devices only.
- Configuration contains three main areas
- Data collection settings
- GPS/sensor sampling time schedules
- Data collection triggered by events
- Configuration of bursting behavior
- Mortality detection adjustment
- Geofencing
- Communication schedules
- Other settings
- Data collection settings
- For complete detail of all the configuration options see the configuration guide to the latest firmware version or to older versions respectively.
Filters
DATA FLOWS: How do I get the data IN/OUT?
A detailed guide to to all the data flows here.
- Anitra offers a range of data manipulation options on how to get data and metadata IN or OUT of the platform.
- This functionality area involves features such as Import, Export, Ddata Integration or API
- The options range from purely manual (e.g. manual data exports or data imports) to fully automated (e.g. inbound data flows for Ornitela, Ecotone, or Movebank).
- Some flows make sense for the particular user but most of the data management tools are meant to be configured at the level of customer/organization (hence available in customer profile)
- Outbound data flows
- Inbound data flows
A detailed guide to to all the data flows here.