Product Builder Scope Functions

The ProductBuilder attribute scope contains functions that allow users to interact with the ODTK Static Product Builder.

DataProduct FindByName(string productName)

Use this to search by name for a specific data product in the Product Builder.

Parameters

productName string Enter the string name of the product in the Product Builder to search for.

Return Value

DataProduct This contains a string that is the name of the product along with a reference to the product's scope, which you can use to access the product's properties.

Example Python:

Copy 
product = ODTK.ProductBuilder.DataProducts.FindByName("SampleProductName")

bool GenerateAllProducts()

Use this to generate reports from all Data Products in the Data Product list.

Return Value

bool

Always true

Example VBS:

Copy 
ODTK.ProductBuilder.GenerateAllProducts()

bool GenerateProduct(string productName)

Use this to generate a report or graph using a single Data Product name, where the name is specified in the list of Products in the static product builder.

Parameters

productName string The string name of the product in the Product Builder to generate

Return Value

bool

A Boolean that is false if product generation failed for a known reason

Example VBS:

Copy 
bResult = odtk.productbuilder.generateProduct("Range Residuals")

bool LoadDataProductList(string filename)

Use this to load a Data Product List from a saved file.

Parameters

filename string The path to the file from which you are loading the list

Return Value

bool

A Boolean that is true if the file is loaded

Example VBS:

Copy 
f = "C:\od_6.0\Styles\AER.dpl"
bResult = odtk.productbuilder.LoadDataProductList(f)

bool SaveDataProductList(string filename)

Use this to save a Data Product List to a file.

Parameters

filename string The path to the file to which you are saving the list

Return Value

bool

Always true

Example VBS:

Copy 
f = "C:\od_6.0\Styles\AER.dpl"
bResult = odtk.productbuilder.SaveDataProductList(f)