Modeling functions

ModelingExecuteBusinessObjectDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName, bool clearData)

Description

Runs 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 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

Instance of ModelingOperationResult.

ModelingExecuteBusinessObjectDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName)

Description

Runs 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 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

Instance of ModelingOperationResult.

ModelingExecuteBusinessObjectDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName)

Description

Does not run any query from a given application and does not load data into the Integration table indicated by a given business object type. It clears the content of tables. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteBusinessObjectDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName, bool clearData, VariantDictionary parameterValues)

Description

Runs 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteBusinessObjectDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteBusinessObjectDataLoadQuery(BusinessObjectType businessObjectType, string applicationName, string queryName, VariantDictionary parameterValues)

Description

Runs 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteFactDataDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName, bool clearData)

Description

Runs 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 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

Instance of ModelingOperationResult.

ModelingExecuteFactDataDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName)

Description

Runs 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 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

Instance of ModelingOperationResult.

ModelingExecuteFactDataDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName)

Description

Does not run any query from a given application and does not load data into the Integration table indicated by a given data import type. It clears the content of tables. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteFactDataDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName, bool clearData, VariantDictionary parameterValues)

Description

Runs 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteFactDataDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteFactDataDataLoadQuery(IntegrationDataImportType integrationDataImportType, string applicationName, string queryName, VariantDictionary parameterValues)

Description

Runs 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteFactMapping

Declaration

ModelingOperationResult ModelingExecuteFactMapping(string applicationName, string mappingName)

Description

Runs a given fact mapping in an application. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteFactMapping

Declaration

ModelingOperationResult ModelingExecuteFactMapping(string applicationName, string mappingName, VariantDictionary parameterValues)

Description

Runs a given fact mapping in an application. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Unique name of the Infor d/EPM application.
mappingName Unique name of the mapping.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteHierarchyMapping

Declaration

ModelingOperationResult ModelingExecuteHierarchyMapping(string applicationName, string mappingName)

Description

Runs a given hierarchy mapping in an application. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteIntegrationDataImport

Declaration

ModelingOperationResult ModelingExecuteIntegrationDataImport(IntegrationDataImportType integrationDataImportType, string cycleElement, string versionElement, string applicationName)

Description

Runs import of data from the Integration table for a given data import type. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteIntegrationStructureImport

Declaration

ModelingOperationResult ModelingExecuteIntegrationStructureImport(BusinessObjectType businessObjectType, string applicationName, IntegrationImportType integrationImportType)

Description

Runs import of structure from the Integration table for a given business object type. Throws an exception in case of 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

Instance of ModelingOperationResult.

ModelingExecuteIntegrationStructureImport

Declaration

ModelingOperationResult ModelingExecuteIntegrationStructureImport(BusinessObjectType businessObjectType, string applicationName)

Description

Runs 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 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

Instance of ModelingOperationResult.

ModelingExecuteIntegrationTableLoadQuery

Declaration

ModelingOperationResult ModelingExecuteIntegrationTableLoadQuery(string tableName, string applicationName, string queryName, bool clearData, VariantDictionary parameterValues)

Description

Runs a given query from a given application and loads data into the Integration table indicated by a table name. Optionally, the content of tables is cleared before the load. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
tableName 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteScript

Declaration

ModelingOperationResult ModelingExecuteScript(string applicationName, string scriptName, VariantDictionary parameterValues)

Description

Runs script from a given application. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Unique name of the application.
scriptName Name of the script.
parameterValues Defines values for script parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteTableDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName, bool clearData)

Description

Runs 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. It can also be used to run 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 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

Instance of ModelingOperationResult.

ModelingExecuteTableDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName)

Description

Runs a given query from a given application and loads data into a given Staging table. It can also be used to run 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 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

Instance of ModelingOperationResult.

ModelingExecuteTableDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteTableDataLoadQuery(string applicationName, string tableName)

Description

Does not run any query from a given application and does not load data into a given Staging table. It clears the content of tables. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Unique name of the application.
tableName Name of the Staging table.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteTableDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName, bool clearData, VariantDictionary parameterValues)

Description

Runs 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. It can also be used to run 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingExecuteTableDataLoadQuery

Declaration

ModelingOperationResult ModelingExecuteTableDataLoadQuery(string applicationName, string tableName, string queryName, VariantDictionary parameterValues)

Description

Runs a given query from a given application and loads data into a given Staging table. It can also be used to run 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 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.
parameterValues Defines values for query parameters in the form of parameter name and value pairs.

Return Value

Instance of ModelingOperationResult.

ModelingGetEntityActivityStatus

Declaration

ActivityStatus ModelingGetEntityActivityStatus(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity)

Description

Gets status of a given entity and activity for a period. Throws an exception in case of 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 Infor d/EPM Consolidation.
entityId ID of the entity.
periodString Period in a 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 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 Infor d/EPM Consolidation.
periodString Period in a 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 a given group and activity for a period. Throws an exception in case of 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 Infor d/EPM Consolidation.
groupId ID of the group.
periodString Period in a 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 a given entity and activity. Throws an exception in case of 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 Infor d/EPM Consolidation.
entityId ID of the entity.
status Activity status.
activity Entity activity.

Return Value

All periods in a string format that have 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 a given global activity. Throws an exception in case of 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 Infor d/EPM Consolidation.
status Activity status.
activity Global activity.

Return Value

All periods that have 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 a given group and activity. Throws an exception in case of 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 Infor d/EPM Consolidation.
groupId ID of the group.
status Activity status.
activity Group activity.

Return Value

All periods in a string format that have one of the statuses specified for the given group.

ModelingOperationResultGetMessages

Declaration

StringList ModelingOperationResultGetMessages(ModelingOperationResult result)

Description

Gets the list of messages returned from Modeling Service.

Supported Runtime Versions

5.0

Parameters Description
result Instance of ModelingOperationResult.

Return Value

List of messages returned from Modeling Service.

ModelingOperationResultIsSuccess

Declaration

bool ModelingOperationResultIsSuccess(ModelingOperationResult result)

Description

Gets if the result level is Success.

Supported Runtime Versions

5.0

Parameters Description
result Instance of ModelingOperationResult.

Return Value

True or false.

ModelingOperationResultIsWarning

Declaration

bool ModelingOperationResultIsWarning(ModelingOperationResult result)

Description

Gets if the result level is Warning.

Supported Runtime Versions

5.0

Parameters Description
result Instance of ModelingOperationResult.

Return Value

True or false.

ModelingPublishCustomCubeToOlap

Declaration

ModelingOperationResult ModelingPublishCustomCubeToOlap(string applicationName, string cubeName, bool includeDimensions)

Description

Publishes cube from the Staging database to OLAP. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Name of the application.
cubeName Dimension name
includeDimensions Include dimensions.

Return Value

Instance of ModelingOperationResult.

ModelingPublishCustomDimensionToOlap

Declaration

ModelingOperationResult ModelingPublishCustomDimensionToOlap(string applicationName, string dimensionName)

Description

Publishes dimension from the Staging database to OLAP. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Name of the application.
dimensionName Dimension name

Return Value

Instance of ModelingOperationResult.

ModelingPublishCustomModelToOlap

Declaration

ModelingOperationResult ModelingPublishCustomModelToOlap(string applicationName)

Description

Publishes data from the Staging database to OLAP. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Name of the application.

Return Value

Instance of ModelingOperationResult.

ModelingPublishToOlap

Declaration

ModelingOperationResult ModelingPublishToOlap(string applicationName)

Description

Publishes from Business Modeling to OLAP. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Unique name of the Infor d/EPM application.

Return Value

Instance of ModelingOperationResult.

ModelingSetEntityActivityStatus

Declaration

ModelingOperationResult ModelingSetEntityActivityStatus(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity, ActivityStatus status)

Description

Sets the entity activity status for a given period. Throws an exception in case of 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 Infor d/EPM Consolidation.
entityId ID of the entity.
periodString Period in a string format.
activity Entity activity. Must not be Total.
status Activity status flag to set.

Return Value

Instance of ModelingOperationResult.

ModelingSetGlobalActivityStatus

Declaration

ModelingOperationResult ModelingSetGlobalActivityStatus(string applicationName, string configurationSetId, string versionId, string periodString, GlobalActivity activity, ActivityStatus status)

Description

Sets the global activity status for a given period. Throws an exception in case of 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 Infor d/EPM Consolidation.
periodString Period in a string format.
activity Global activity. Must not be Total.
status Activity status.

Return Value

Instance of ModelingOperationResult.

ModelingSetGroupActivityStatus

Declaration

ModelingOperationResult ModelingSetGroupActivityStatus(string applicationName, string configurationSetId, string versionId, string groupId, string periodString, GroupActivity activity, ActivityStatus status)

Description

Sets the group activity status for a given period. Throws an exception in case of 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 Infor d/EPM Consolidation.
groupId ID of the group.
periodString Period in a string format.
activity Group activity. Must not be Total.
status Activity status flag to set.

Return Value

Instance of ModelingOperationResult.

ModelingSubmitEntityActivity

Declaration

ActivityStatus ModelingSubmitEntityActivity(string applicationName, string configurationSetId, string versionId, string entityId, string periodString, EntityActivity activity)

Description

Submits entity activity for a given period. Throws an exception in case of 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 Infor d/EPM Consolidation.
entityId ID of the entity.
periodString Period in a string format.
activity Entity activity. Must not be Total.

Return Value

New activity status of the entity.

ModelingTriggerCsfIntegration

Declaration

ModelingOperationResult ModelingTriggerCsfIntegration(string applicationName)

Description

Triggers the CSF integration process. Throws an exception in case of error.

Supported Runtime Versions

5.0

Parameters Description
applicationName Unique name of the Infor d/EPM application.

Return Value

Instance of ModelingOperationResult.