Modeling functions
ModelingExecuteBusinessObjectDataLoadQuery
Declaration
void ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName, bool clearData)Description
Executes a given query from a given application and loads data into the Integration table indicated by a given business object type. Optionally, the content of tables is cleared before the load. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
businessObjectType
|
Type of the Business Object for the data load.
|
applicationName
|
Unique name of the application containing the query.
|
queryName
|
Name of the query to execute.
|
clearData
|
Flag indicating whether to clear data from the corresponding Integration database table.
|
Return Value
Does not return a value.
ModelingExecuteBusinessObjectDataLoadQuery
Declaration
void ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName)Description
Executes a given query from a given application and loads data into the Integration table indicated by a given business object type. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
businessObjectType
|
Type of the Business Object for the data load.
|
applicationName
|
Unique name of the application containing the query.
|
queryName
|
Name of the query to execute.
|
Return Value
Does not return a value.
ModelingExecuteBusinessObjectDataLoadQuery
Declaration
void ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName)Description
Does not execute any query from a given application and does not load data into the Integration table indicated by a given business object type. It just clears the content of tables. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
businessObjectType
|
Type of the Business Object for the data load.
|
applicationName
|
Unique name of the application.
|
Return Value
Does not return a value.
ModelingExecuteFactDataDataLoadQuery
Declaration
void ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName, bool clearData)Description
Executes a given query from a given application and loads data into the Integration table indicated by a given data import type. Optionally, the content of tables is cleared before the load. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
integrationDataImportType
|
Type of the data import for the data load.
|
applicationName
|
Unique name of the application containing the query.
|
queryName
|
Name of the query to execute.
|
clearData
|
Flag indicating whether to clear data from the corresponding Integration database table.
|
Return Value
Does not return a value.
ModelingExecuteFactDataDataLoadQuery
Declaration
void ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName)Description
Executes a given query from a given application and loads data into the Integration table indicated by a given data import type. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
integrationDataImportType
|
Type of the data import for the data load.
|
applicationName
|
Unique name of the application containing the query.
|
queryName
|
Name of the query to execute.
|
Return Value
Does not return a value.
ModelingExecuteFactDataDataLoadQuery
Declaration
void ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName)Description
Does not execute any query from a given application and does not load data into the Integration table indicated by a given data import type. It just clears the content of tables. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
integrationDataImportType
|
Type of the data import for the data load.
|
applicationName
|
Unique name of the application.
|
Return Value
Does not return a value.
ModelingExecuteFactMapping
Declaration
void ModelingExecuteFactMapping(string applicationName, string mappingName)Description
Executes a given fact mapping in a given application. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the Infor d/EPM application.
|
mappingName
|
Unique name of the mapping.
|
Return Value
Does not return a value.
ModelingExecuteHierarchyMapping
Declaration
void ModelingExecuteHierarchyMapping(string applicationName, string mappingName)Description
Executes a given hierarchy mapping in a given application. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the Infor d/EPM application.
|
mappingName
|
Unique name of the mapping.
|
Return Value
Does not return a value.
ModelingExecuteIntegrationDataImport
Declaration
void ModelingExecuteIntegrationDataImport(IntegrationDataImportType integrationDataImportType, string cycleElement, string versionElement, string applicationName)Description
Executes import of data from the Integration table for a given data import type. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
integrationDataImportType
|
Type of the data import.
|
cycleElement
|
BPDCYCLE element to load data into.
|
versionElement
|
BPDVERSION element to load data into.
|
applicationName
|
Unique name of the Infor d/EPM application.
|
Return Value
Does not return a value.
ModelingExecuteIntegrationStructureImport
Declaration
void ModelingExecuteIntegrationStructureImport(BusinessObjectType businessObjectType, string applicationName, IntegrationImportType integrationImportType)Description
Executes import of structure from the Integration table for a given business object type. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
businessObjectType
|
Type of the business object.
|
applicationName
|
Unique name of the Infor d/EPM application.
|
integrationImportType
|
Type of the import.
|
Return Value
Does not return a value.
ModelingExecuteIntegrationStructureImport
Declaration
void ModelingExecuteIntegrationStructureImport(BusinessObjectType businessObjectType, string applicationName)Description
Executes import of structure from the Integration table for a given business object type. Type of the import is IntegrationImportTypeAddAndUpdate. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
businessObjectType
|
Type of the business object.
|
applicationName
|
Unique name of the Infor d/EPM application.
|
Return Value
Does not return a value.
ModelingExecuteTableDataLoadQuery
Declaration
void ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName, bool clearData)Description
Executes a given query from a given application and loads data into a given Staging table. Optionally, the content of tables is cleared before the load. Can also be used to execute scripts by passing an empty string to the tableName parameter and name of a script to the queryName parameter. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application containing the query.
|
tableName
|
Name of the Staging table for the data load. If empty, a script is executed.
|
queryName
|
Name of the query or script to execute.
|
clearData
|
Flag indicating whether to clear data from the corresponding Staging database table.
|
Return Value
Does not return a value.
ModelingExecuteTableDataLoadQuery
Declaration
void ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName)Description
Executes a given query from a given application and loads data into a given Staging table. Can also be used to execute scripts by passing an empty string to the tableName parameter and a name of a script to the queryName parameter. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application containing the query.
|
tableName
|
Name of the Staging table for the data load. If empty, a script is executed.
|
queryName
|
Name of the query or script to execute.
|
Return Value
Does not return a value.
ModelingExecuteTableDataLoadQuery
Declaration
void ModelingExecuteTableDataLoadQuery(string applicationName, string tableName)Description
Does not execute any query from a given application and does not load data into a given Staging table. It just clears the content of tables. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
tableName
|
Name of the Staging table.
|
Return Value
Does not return a value.
ModelingGetEntityActivityStatus
Declaration
ActivityStatus ModelingGetEntityActivityStatus(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity)Description
Gets status of given entity and activity for a period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
entityId
|
Id of the entity.
|
periodString
|
Period in string format.
|
activity
|
Entity activity.
|
Return Value
Entity activity status.
ModelingGetGlobalActivityStatus
Declaration
ActivityStatus ModelingGetGlobalActivityStatus(string applicationName, string configurationSetId, string versionId, string periodString, GlobalActivity activity)Description
Gets status of global activity for a period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
periodString
|
Period in string format.
|
activity
|
Global activity.
|
Return Value
Global activity status.
ModelingGetGroupActivityStatus
Declaration
ActivityStatus ModelingGetGroupActivityStatus(string applicationName, string configurationSetId, string versionId, string groupId, string periodString, GroupActivity activity)Description
Gets status of given group and activity for a period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
groupId
|
Id of the group.
|
periodString
|
Period in string format.
|
activity
|
Group activity.
|
Return Value
Group activity status.
ModelingGetPeriodsByEntityActivityStatus
Declaration
StringList ModelingGetPeriodsByEntityActivityStatus(string applicationName, string configurationSetId, string versionId, string entityId, ActivityStatus status, EntityActivity activity)Description
Gets all periods with specified status flags for given entity and activity. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
entityId
|
Id of the entity.
|
status
|
Activity status.
|
activity
|
Entity activity.
|
Return Value
All periods in string format that are of one of the statuses specified for the given entity.
ModelingGetPeriodsByGlobalActivityStatus
Declaration
StringList ModelingGetPeriodsByGlobalActivityStatus(string applicationName, string configurationSetId, string versionId, ActivityStatus status, GlobalActivity activity)Description
Gets all periods with specified status flags for given global activity. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
status
|
Activity status.
|
activity
|
Global activity.
|
Return Value
All periods that are of one of the statuses specified for the given group.
ModelingGetPeriodsByGroupActivityStatus
Declaration
StringList ModelingGetPeriodsByGroupActivityStatus(string applicationName, string configurationSetId, string versionId, string groupId, ActivityStatus status, GroupActivity activity)Description
Gets all periods with specified status flags for given group and activity. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
groupId
|
Id of the group.
|
status
|
Activity status.
|
activity
|
Group activity.
|
Return Value
All periods in string format that are of one of the statuses specified for the given group.
ModelingPublishCustomModelToOlap
Declaration
void ModelingPublishCustomModelToOlap(string applicationName)Description
Publishes data from stage database to OLAP. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Name of the application.
|
Return Value
Does not return a value.
ModelingPublishToOlap
Declaration
void ModelingPublishToOlap(string applicationName)Description
Publishes from Business Modeling to OLAP. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the Infor d/EPM application.
|
Return Value
Does not return a value.
ModelingSetEntityActivityStatus
Declaration
void ModelingSetEntityActivityStatus(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity, ActivityStatus status)Description
Sets entity activity status for given period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
entityId
|
Id of the entity.
|
periodString
|
Period in string format.
|
activity
|
Entity activity. Must not be Total.
|
status
|
Activity status flag to set.
|
Return Value
Does not return a value.
ModelingSetGlobalActivityStatus
Declaration
void ModelingSetGlobalActivityStatus(string applicationName, string configurationSetId, string versionId, string periodString, GlobalActivity activity, ActivityStatus status)Description
Sets global activity status for given period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
periodString
|
Period in string format.
|
activity
|
Global activity. Must not be Total.
|
status
|
Activity status.
|
Return Value
Does not return a value.
ModelingSetGroupActivityStatus
Declaration
void ModelingSetGroupActivityStatus(string applicationName, string configurationSetId, string versionId, string groupId, string periodString, GroupActivity activity, ActivityStatus status)Description
Sets group activity status for given period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
groupId
|
Id of the group.
|
periodString
|
Period in string format.
|
activity
|
Group activity. Must not be Total.
|
status
|
Activity status flag to set.
|
Return Value
Does not return a value.
ModelingSubmitEntityActivity
Declaration
ActivityStatus ModelingSubmitEntityActivity(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity)Description
Submits entity activity for given period. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the application.
|
configurationSetId
|
Id of the configuration set.
|
versionId
|
Id of the version configured for Consolidation.
|
entityId
|
Id of the entity.
|
periodString
|
Period in string format.
|
activity
|
Entity activity. Must not be Total.
|
Return Value
Resulting entity activity status.
ModelingTriggerCsfIntegration
Declaration
void ModelingTriggerCsfIntegration(string applicationName)Description
Triggers the CSF integration process. Throws an exception in case of an error.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
applicationName
|
Unique name of the Infor d/EPM application.
|
Return Value
Does not return a value.