Framework Object

The framework object contains the following data:

Data	Description	Data Type
Name	Framework name	String
Framework	Code for the framework	Structure
Filter	Whether the framework has a filter	Boolean
FilterSQL	Filter definition	String
Models	Models included in framework	Structure
Lang	Language in which framework is defined	String
directory	Where the framework resides	String

The Models structure within the Framework object contains the following:

Data	Description	Data Type
Name	Model name	String
Model	Code for the model	Structure
Filter	Whether the model has a filter	Boolean
FilterSQL	Filter definition	String
Type	Type of model	String
From	Where to start in transition matrix	String
To	Where to end in transition matrix	String
Value	Value of constant	Float
ParmValues	Model parameters	Structure
directory	Where the model resides	String

A list of frameworks of a specific kind in a particular run and the models attached can be retrieved by passing the framework kind (String) and the unique numeric run identifier to the ReadFramework or ReadFrameworkSAS functions in Golang or the ReadFramework function in Python.

Please note that the functions will return frameworks and models defined in the language of the function used. The functions will return both shared and local frameworks.

The ReadFramework functions provide framework and model transparency and enable the rerunning of framework logic in batch.

For more information about frameworks and models in VOR Stream, please refer to...

Read Framework Objects, Golang Example

To return frameworks defined in Golang:

frameworkList, err := u.ReadFramework(Kind)
if err != nil {
    log.Fatal(err)
}

To return frameworks defined in SAS:

frameworkCode, err := sdkClient.ReadFramework(Kind,RunID)
if err != nil {
    log.Fatal(err)
}

Read Framework Objects, Python Example

from sdk import sdk

myfameworklist = sdk.ReadFramework(kind, runID)