Table 56. State Class (clsState)
| API Call | Methods/Properties/Oject Reference | Description |
|---|---|---|
| AppID | Property | Returns the Application ID for the LoadID |
| bstMaintenanceMgr | Object Reference | Reference to the clsMaintenanceMgr class |
| bstSQLMgr | Object Reference | Reference to the clsSQLMgr class |
| CatKey | Property | Returns the Category Key for the LoadID. |
| CatName | Property | Returns the Category Name for the LoadID. |
| DataValue | Property | Returns the DataValue assigned to the Location for the LoadID. |
| dstConnection | Object Reference | Reference to the clsConnection class |
| dstDataAccess | Object Reference | Reference to the clsDataAccess class |
| dstDataManipulation | Object Reference | Reference to the clsDataManipulation class |
| dstDBTools | Object Reference | Reference to the clsDBTools class |
| dstSQL | Object Reference | Reference to the clsSQL class |
| dstUtilities | Object Reference | Reference to the clsUtilities class |
| EndPeriodKey | Property | Returns the End Period for the LoadID. |
| ExportFlag | Property | Returns Y or N. If the Data Rule is executed with Export checked, this property returns Y. |
| ExportMode | Property | Returns Y or N. f ExportFlag is Y, this property returns the selected mode for Export (Replace or Append). Otherwise, it returns an empty string. |
| FileDir | Property | Returns the FILE_PATH field from the AIF_BAL_RULE_LOADS table. Note: The FileDir defaults to the property you specify in the Directory field on the data load rule. If the file is in root folder, you do not need to specify anything for this field. In this case, FILEDIR returns null. |
| FileName | Property | Returns a string containing the name of the file that was imported. |
| GstrDateMask | Property | Returns the date mask. |
| ImportFlag | Property | Returns the IMPORT_FROM_SOURCE_FLAG from the AIF_BAL_RULE_LOADS table. If LoadID initiates the Import Process, this flag is set to Y. Otherwise it is set to F. |
| ImportFormat | Property | Returns the Import Format used for the Load ID being processed. |
| ImportMode | Property | Returns REPLACE or APPEND based on the LoadID. This property returns null when the LoadID did not Import data (that is, Validate only), |
| LoadID | Property | Returns the Load ID. |
| LocKey | Property | Returns the Location Key for the Location being processed for the LoadID. |
| LocName | Property | Returns the Location Name for the location being processed for the LoadID. |
| MultiPeriodLoad | Property | Returns True or False. This property is True when multiple periods are being processed. Otherwise, returns False. |
| PeriodKey | Property | Returns the Period Key for the LoadID. |
| RuleID | Property | Returns the Rule ID for the Data Rule being processed. |
| RuleName | Property | Returns the Rule Name for the Data Rule being processed. |
| SourceName | Property | Returns the SOURCE_SYSTEM_NAME for the data rule. |
| SourceType | Property | Returns the SOURCE_SYSTEM_TYPE for the data rule. |
| TargetAppDB | Property | Returns "NA" for HFM. If the target application type is HPL then this property will return the PLAN_TYPE. If the target application type is ESSBASE this property will return the ESSBASE_DB_NAME. |
| TargetAppName | Property | Returns the APPLICATION_NAME for the target system. |