Exporting Clarity's Data Models

Effective software development relies on testing data models and artifacts within development environments. Exporting these elements is a foundational step in the migration process, enabling seamless transitions and maintaining data consistency across environments. In this exercise, you'll learn how to export one of Clarity’s objects previously created through the Liferay UI.

Exercise: Exporting the Contact Us Object Definition

Here, you'll export Clarity's Contact Us object definition and explore its associated JSON file.

1. In your running Liferay instance, sign in as the Clarity Admin user.

   • Username: admin@clarityvisionsolutions.com

   • Password: learn

2. Open the Global Menu (), go to the Control Panel tab, and click Objects.

3. Click Actions () for the Contact Us object and select Export Object Definition.
   

4. Click on the Contact Us object and navigate to the Fields tab, identifying the currently included fields.
   

5. Open the downloaded Object_Definition_ContactUs_[...].json file in a text editor or IDE.

   Many text editors and IDEs offer extensions to “prettify” JSON code, improving its readability for human comprehension.

6. Examine the file’s JSON elements and nested values.
   This contains the object data used to create a client extension payload, once added to an items array block.

Great! You’ve exported and examined the JSON structure of an object definition, the first steps in data migration preparation. Next, you’ll learn about migrating data between environments with Liferay’s backend client extensions.