Entity Management

📘

This describes the functionality to be released week of 7.26.23. The feature is available now, just less featureful.

Entity Management

The Liberate platform offers a powerful Entity Management feature that allows users to leverage large datasets in their workflows. This documentation provides an overview of the Entity Management feature, its capabilities, and best practices for working with it effectively.

Overview

The Entity Management feature enables users to upload and manage CSV files containing potentially large datasets. These datasets can be utilized in various tasks during workflow development, such as data mapping. For example, you can maintain a list of country codes and the corresponding countries they map to.

Uploading Files

To utilize the Entity Management feature, you need to upload CSV files containing your datasets. The platform provides version tracking and audit controls for these files. When uploading a new file, the system assigns it a state, which can be one of the following:

• Current: Represents the active file being used by workflows.
• Uploading: Indicates that a new file is being uploaded and processed.
• Archived: Represents previously uploaded files that are no longer active.
• Failed: Indicates that the upload process encountered an error.

During the file upload process, you may experience a delay, especially with large files. It's important to be patient and allow the system enough time to process the file.

File Replacement

If you need to update or replace an existing file with a new version, the Entity Management feature allows for seamless file replacement. When replacing a file, the system will prompt you to provide a comment or reason for the change. This comment serves as a reference and allows users to view the history of file changes, including the time and user who made the modification.

Once a replaced file becomes the current version, it will be used by all QA and production workflows that reference it. It's essential to ensure that the new file is accurate and properly tested before replacing the existing one.

Rollback Considerations

It's important to note that the Liberate platform does not have built-in rollback capabilities within the Entity Management feature. Therefore, it's recommended to save previous versions of files on your local computer or another secure storage location. In case you need to initiate a rollback, you can replace the current file with a previously known good version.

Best Practices

To make the most of the Entity Management feature, consider the following best practices:

• Ensure the accuracy and quality of the uploaded CSV files before using them in workflows.
• Use descriptive and meaningful file names to easily identify the purpose and content of each dataset.
• Document any changes made to files by providing comments or reasons during the replacement process.
• Regularly backup important files to enable rollback if necessary.
• Perform thorough testing when introducing new files or making changes to existing ones.