system.mes.oee.getCalculationConfigs
Description
Returns the OEE Calculation Configurations for the given location. By default only enabled
configurations are returned; pass includeDisabled=True to also return soft-deleted (disabled)
configurations.
Permissions
This method requires the OEE.READ.GET permission.
Syntax
system.mes.oee.getCalculationConfigs(locationIdOrPath, includeDisabled=False)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
locationIdOrPath | String | False | Location ID (ULID) or path. |
includeDisabled | Boolean | True | Optional. When True, soft-deleted (disabled) configurations are also returned. When False (the default), only enabled configurations are returned. |
Returns
A JSON list of OeeCalculationConfigurationDTO objects.
| Name | Type | Nullable | Description | Default Value |
|---|---|---|---|---|
id | String | True | The ID of the configuration (ULID). | null |
locationId | String | False | Identifier for the associated location. | null |
locationPath | String | True | Path for the associated location (display only). | null |
periodType | String | False | Period granularity: HOUR, DAY, WEEK, MONTH, or SHIFT. | null |
numRowsPerCycle | Integer | False | Maximum records to generate per job cycle. | 1 |
weekStartDay | String | False | First day of the calendar week for WEEK bucketing. | "MONDAY" |
numDaysDelay | Integer | False | Minimum number of days a period must end before it is pre-computed. The pre-processed row in the rollup table will always be at least this many days behind the current date. This is to allow for a settling period. | 1 |
latestCalculationTimestamp | Instant | True | ISO-8601 timestamp of the most recently computed period. | null |
enabled | Boolean | False | Whether this configuration is active. | true |
notes | String | True | Optional notes. | null |
Code Examples
# List all enabled calculation configs for a line
configs = system.mes.oee.getCalculationConfigs("Enterprise/Site/Line1")
for config in configs:
print config['periodType'], "- rows per cycle:", config['numRowsPerCycle']
# Include disabled (soft-deleted) configs as well
all_configs = system.mes.oee.getCalculationConfigs("Enterprise/Site/Line1", includeDisabled=True)