Skip to main content

Creating Objects and Attributes from an Import Process

Objects and attributes are usually created manually through the Configuration screens.

Objects and attributes are usually created manually through the Configuration screens. However, if you need to create many objects at once, deploy a pre-configured set of structures, or promote changes between environments, you can use the ENERGYSYS Import Object and Attributes process.

This process imports object and attribute definitions from a formatted Excel workbook. It performs validation checks before applying any changes, which prevents partial updates and leaves the system in a consistent state.


Why Use the Import Process?

If an error occurs during a basic data import of object definitions, the database can be left partially updated - resulting in "Object already exists" errors or objects that are not visible in configuration screens. The dedicated import process performs structured validation and either imports everything successfully or imports nothing at all.


How the Import Process Works

The process reads a formatted Excel workbook, validates all objects and attributes against existing configuration, and imports only if every validation check passes. If any check fails, nothing is created or modified.


Validation Checks


Object-level checks:

  • System Name contains no spaces and is within the maximum length

  • Required settings are provided

  • No duplicate objects exist in the import file

  • If attributes are defined, at least one is marked as the unique key

  • Any specified lock date, pre-save process, post-save process, or validation rule already exists in the system


Attribute-level checks:

  • System Name contains no spaces and is within the maximum length

  • The parent object exists or will be created in the same import

  • Required settings are provided

  • Unique key membership of existing objects is not changed

  • Type and Required status of existing attributes are not changed

  • Attribute type is valid

  • Reference types specify a valid object

  • Order number is an integer and not duplicated within the object

  • Unit of measure is valid

  • Attribute does not use a reserved database name


Automatic Corrections

The process automatically corrects minor inconsistencies in the import file:

  • Converts TRUE to T and FALSE to F

  • Enforces consistent casing of object and attribute System Names

For example, if an existing object is named PRODUCT, a reference to product in the import file will be corrected automatically.


Identifying and Fixing Errors

If the process fails, download the Calculation Log and review the workbook. The workbook is structured to help diagnose issues:

  • Blue tab sheets contain existing database data used for comparison

  • Red tab sheets perform validation checks; errors are highlighted in red and marked as "Error"

  • Green tab sheets show the post-validated data that would be imported if no errors exist

Correct the issues in your import file and re-run the process.


Excel Template

An Excel template is provided to prepare your data before running the import. The template mirrors the fields on the Object and Attribute screens and performs many of the same validation checks in advance, allowing you to resolve issues before uploading. Using the template reduces failed import attempts.


How to Run the Import

  1. Open the Configuration application and navigate to Processes \> Process Execution.

  2. Locate ENERGYSYS Import Object and Attributes.

  3. Click Run and upload the completed template workbook.

  4. Review the result. If successful, the objects and attributes are created or updated.


When to Use This Approach

Use the import process when deploying structured configuration changes, moving configuration between environments, or creating many objects at once. For minor one-off changes, use the configuration screens directly. Always validate carefully before running in a production environment.

Did this answer your question?