Skip to main content

[en] Allocate Metainfo Tool Icon Allocate Metainfo Tool

[en] Use Allocate MetaInfo to return pertinent information about installed Allocate Datasets.

[en] Configure the Tool

  1. [en] From the Configuration Properties, choose an Allocate dataset from the dropdown menu. You can specify the default dataset from User Settings. Go to Options > User Settings > EditUser Settings and open the Dataset Defaults tab.

  2. [en] Select the MetaInfo to return. Choices include:

    • [en] Datasets: Returns all of the installed Allocate datasets and the following information on those datasets:

      • [en] Short Name: Internal name of the dataset references the registry key of the installed dataset.

      • [en] Long Name: Verbose dataset name visible in the Alteryx GUI from Choose Dataset.

    • [en] Geography Levels: Returns all of the installed Geography Levels for the selected dataset. VGFs are also visible here. This information is returned:

      • [en] Short Name: Short name of the installed geography.

      • [en] Long Name: Verbose descriptive name of the installed geography.

      • [en] Alias Short Name: Alias short name used internally by Alteryx.

      • [en] Is Intermediate: True or False indicates if this geography level

    • [en] Index Base Files: Returns a list of the Index Base Files a user has created with the specified dataset.

      • [en] Name: Include any and all *.ibs files created by the user and saved to the install directory of the specified dataset:

        [en] Program files\Alteryx\Portfolioxx\Data\DataSetNameVintage\IndexBases

    • [en] Reports: Returns a list of all the installed *.rptx files saved to the report directory of the specified dataset:

      [en] Program files\Alteryx\Portfolioxx\Data\DataSetNameVintage\Reports

      [en] This information is returned:

      • [en] Name: Name of the report.

      • [en] Type: Type of the report: Summary, Comparison, or Rank.

    • [en] Variables: Returns information on every variable included in the specified dataset. This information is returned:

      • [en] Name: The field name that is returned from all Allocate tools.

      • [en] Name_Long: The verbose field name. Field is blank.

      • [en] Description: Field description from the Allocate variable tree. This is the most descriptive level of the field categorizations ("Age 25 to 34").

      • [en] Category: Top-level categorization of the Allocate variable tree ("Population").

      • [en] SubCategory: Further categorization appearing in the Allocate variable tree ("Male by Age").

      • [en] Units: The units of the returned values (Population, households, dollars, percent, etc.).

      • [en] Vintage: The specific source or style of the data. In other words, Current Year Estimates, Five Year Projections, US Census 2000, etc.

      • [en] Year: The data vintage of the returned variable.

      • [en] Action: The mathematical method the value was derived from (Sum, Average, etc.).

      • [en] Weight: Returns how values were weighted that have been summarized. In other words, “Population”, “Households.

      • [en] Is Licensed: Boolean value that indicates whether or not the variable is licensed. True if licensed, False if not licensed.

      • [en] Data Table: Returns the internal name of the file (Demo File, VVF, etc) that the variable resides in.

    • [en] Version: Returns the Allocate engine version number for the selected dataset.

: