Introduction
An entity stores all the HTML pieces of the Sagitec Studio Suite (Xelence), which includes logic and rules. In order to create a form, or create queries, methods, or any properties, an entity must already exist.
You can create entities in Xelence with different methods. One of these methods is with data from an existing database table. This creates an entity for working with that table.
Prerequisites
- An entity with the same name should not already exist.
- Make sure the folder in which you want to save your entity, is already created.
|
Quick Steps |
| 1 |
Create a New Item |
| 2 |
Select the Object Type |
| 3 |
Select the creation method |
| 4 |
Enter the entity details, then click Next |
| 5 |
Select any applicable One-to-Many Relationships, then click Next |
| 6 |
Review Picklist information, then click Next |
| 7 |
Optionally, enter Design Specification information, then click Finish |
| 8 |
View the summary report, then click OK |
Detailed Steps
Step 1. Click the Create New Item icon.
Step 2. Select the Object Type.
You are creating an entity.
Step 3. Select the creation method.
Here, you are creating an entity with a table.
Step 4. Enter the entity details, then click Next.
Enter the entity details. The important properties are:
- Table Name: Programmatic name of the table you are basing the entity on.
- Entity Name (ID): Programmatic name of the entity.
- Select Folder: Specifies the location for the entity. You can either choose an existing folder or create a new one.
- Parent Entity: Enter the Parent Entity name if you want to inherit information from the parent entity.
- Description: You can also add a description if your entity requires any explanation.
Tip: When you enter the Table Name, the Entity Name will populate as “ent{Table Name} with no spaces. If desired, you can rename the entity.
Step 5. Select any applicable One-to-Many Relationships, then click Next.
Add any table relationships that are applicable. If no options appear, you can skip this step.
Tip: Xelence will create a new entity for each table you make a relationship with.
Step 6. Review Picklist information, then click Next.
This step shows all the Picklists that are automatically generated by the system. Before completing this step, it’s helpful to review the different Picklists. It is a good reference guide.
Step 7. Optionally, enter Design Specification information, then click Finish.
In the Extra Fields section, enter the Design Specification value if you want to link your entity to a documentation record.
Then, click the Finish button to create the entities. Xelence creates an entity for the table and an entity for each relationship you configured.
Step 8. View the summary report, then click OK.
Xelence displays a summary of the entities it created. Close the popup and begin working with the entities.
Xelence creates an entity for the table and each selected relationship.
When you have completed the wizard and created your entities, it should look something like this:
#Xelence
#Entity