Skip to end of banner
Go to start of banner

Acumatica Generic Inquiry (GI) Standards for DataSelf Enterprise

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Current »

GIs for DataSelf Enterprise

GI Header

  • Inquiry Title (GI Name):
    • DS_XX_TableName  where XX is the module code and TableName is the full SQL table name (which may or may not start with the module code). 
    • TableName is the same as in Acumatica (including upper/lower case).
    • If TableName looks cryptic, please add _FriendlyName. Ex.: DS_AM_WC becomes DS_AM_WC_WorkCenter. 
  • Site Map Location: By default, we set it Primary Lists (under the Hidden tree)
  • Screen ID:  DSEMMXXX
    DSE is DataSelf Enterprise (DS is the official prefix designated by Acumatica for DataSelf GI's.)
    MM is the module code.
    XXX are the first three letters of the table name, or other abbreviation in case of duplicates. 
  • Expose via OData: enable it
  • Other GI header parameters are optional.

GI Tabs

  • Tables: One Acumatica table per GI
  • Conditions: 
    • Create a condition on this tab when only part of the data is needed for BI purposes. This will improve the data extraction process, and reduce load to Acumatica's database.
    • On the other hand, there's usually no value in creating separate GIs from the same table (ex.: a GI for each document type from a transaction table). The best place to do data prep is in the data warehouse and the BI platform. 
  • Results Grid: See section below. 
  • Relations / Parameters / Grouping / Sort Order / Entry Point / Navigation: Leave them all blank.

Results Grid Tab

  • All fields have Captions (enable Captions with the icon on the top-left corner of the list of fields ).
  • Only import fields that should be used for BI purposes. Bringing unnecessary fields will negatively affect long-term maintenance: additional adjustments especially when upgrading Acumatica, performance hits in Acumatica and data warehouse, additional disk space, and backup procedures. 
  • The first segment of the caption is the source field name (from the Data Field column, including upper/lower case). No spaces in the Captions.
  • All key fields use a formula, to ensure that the GI returns the surrogate key, not the business key. Ex.: =[InventoryItem.InventoryID]. See table below for their caption. 
  • Many fields (like transaction types) return a business description, but the transaction code when using a formula (ex.: GLTranR.TranType returns a description, and =[GLTranR.TranType] returns the transaction type code). In the Results Grid tab, have one line for the description and one for the formula. Both are usually needed for BI purposes. See table below.
  • The Results Grid Tab should have NO yellow exclamation marks. Some of fields with exclamation marks should be replaced with their formulas (key fields). The other fields should be removed from the GI (they can be linked in the data warehouse). 
  • Some captions will have explanatory suffixes, as follows:
Field TypeSuffixNote
Primary Key_PKEx.: InventoryID_PK
Foreign Key_FKEx.: InventoryID_FK
Double-use fields _PKIf the code is used to link tables, add _PK or _FK as its suffix. Ex.: =[GLTranR.TranType] becomes TranType_PK
Double-use fields Desc_Desc

Ex.: GLTranR.TranType becomes TranType_Desc

LastModifedDateTime_LMDTThis field will be used, in conjunction with the _PK field(s), to refresh the DataSelf data warehouse data with only new or newly-modified records. This type of refresh is called an "Update" refresh.
Non-obvious field names_FriendlyNameEx.: Vendor.AcctCD becomes AcctCD_VendorID

Examples:

For this Results Grid:

View Inquiry displays as:

Results Grid with examples of Friendly Name Suffixes:

View Inquiry displays as:

This article


In this section


Related Content

There are no related labels.


  • No labels