Skip to main content

AGR Data Interface

Updated over a week ago

Overview

The AGR data interface (ADI) documentation is your comprehensive guide to understanding how AGR processes data. It outlines the specific format and structure your data needs to adhere to for seamless integration with AGR.

Your data can originate from various sources, but it must be mapped according to the guidelines provided in this documentation before it is pulled into AGR. The staging and mapping of your data to the AGR data interface can be owned and maintained by

  • your internal IT team

  • a third party IT or integration partner

  • AGR integrations team

Supporting documentation

Find our data model below.


Inside this link you will find a menu to the left with each of the ADI tables as you can see depicted in the next image.

When you click in one of the tables it opens the table details. The table details include:

  • Table description - a brief description of how this table is used in AGR. In the image below you can see that the LOCATION table is used to store "All locations that hold stock".

  • Table references - a small diagram with all connections this table has with the other tables of the ADI layer.

  • List of fields - a list of all the table columns.

    For each field it also includes the following:

    • Name - field name.

    • Type - defines the data type for the field.

    • Settings

      • displays a badge saying "PK" if this field is included in the Primary Key of the table.

      • Displays a badge with the text "not_null" if the field can't be NULL.

    • References - lists all tables that use this field as a reference.

    • Default Value & Notes - brief description of the field.



Did this answer your question?