Home » Documentation » Tools » Using the Model Editor tool
When creating customer blocks or componets there are a number of steps involved in creating the neccesary changes in the database. To facilitate this and to eliminate some of the repetitions work that may introduce human errors the Model Editor tool has been developed.
The Model Editor is a winforms application used to create and manage models using a graphical user interface.
The Model Editor is located under your Scensum directory under the Tools\Litium.Scensum.Model.WinEditor folder.
Configure the Model Editor
Locate and open the Litium.Scensum.Model.WinEditor.exe.config file in a text editor.
IoCConfigPath
The path to the IoC file used when instantiating the template objects.
SettingXmlFilePathTemplate
The path to the settings folder, used among others to read the database connection string. If you change the relative location between the FTP server and the Settings files/folder you'll have to update this path.
User, Password
Stores the last successful login where the Remember me option was selected.
Starting the Model Editor
Locate the Litium.Scensum.Model.WinEditor.exe file and start the Model Editor by double clicking it.
A login dialogue should appear. Sign in using the Scensum back office credentials. You need to sign in with a user that has access to Interface.Template privilege. Checking the Remember checkbox will retain the username and password for the next time you start the Model Editor.

Model folder window
On a successful login the Model Editor main form is displayed. This form lists all created models grouped by model folders.

| 1. |
Model folder bar |
A model folder has no function on the public site but is used to segment models into logical groups in the Model Editor and back office. Double click the model folder bar to edit the folder name. |
| 2. |
Delete model folder |
Deletes the model folder and any models in the folder. |
| 3. |
Expand/collapse model folder |
Expand model folder to display the model list. |
| 4. |
Add model folder |
Displays a dialogue window to create a new model folder. |
| 5. |
Model list |
Lists all models for the expanded model folder. |
| 6. |
Add model |
Press to display model form and create a new model. |
| 7. |
Delete model |
Press to delete the model. |
| 8. |
Model name |
Click the model name to open the model form to manage the model. |
| 9. |
Entity editor |
Click to open the fragment entity editor window to manage entities. |
| 10. |
Component editor |
Click to open the component editor window to manage components. |
Entity Editor window
Clicking the Entity Editor button in the Model Folder window brings up the Entity Editor window where entities can be managed. The created entities can then be used in a model fragment.

| 1. |
Entity list |
List all existing entities for the system. |
| 2. |
Add entity |
Add empty line in the list for creation of a new entity. |
| 3. |
Delete entity |
Deletes an existing entity. If the entity is in use a confirmation dialogue message needs to be confirmed before the entity is deleted.
|
| 4. |
Ok |
Persist changes to the database. |
| 5. |
Cancel |
Cancel changes and close the window. |
Component editor
The component editor manages all components in the system.

| 1. |
Componet bar |
Displays the name and common name separated by a hyphen of the component. Double click to edit the component name. |
| 2. |
Add component |
Opens dialogue window to create new component. |
| 3. |
Delete component |
Deletes entire component. |
| 4. |
Component parameter list |
Lists all parameters for a component. |
| 5. |
Add parameter |
Adds empty line to parameter list to create new parameter. |
| 6. |
Delete parameter |
Deletes the component parameter |
| 7. |
Move parameter |
Move parameter to another component. |
| 8. |
Save |
Persist changes to database. |
| 9. |
Cancel |
Cancels changes and closes the window. |
Component parameter list
A component parameter is the variable that can be used in the template when rendering a component.
| Title |
The parameter name, accessed programmatically |
| Data Type |
Deprecated... |
| Description |
A free text describing the component parameter. |
Model form window
Clicking an existing model or choosing to create a new model will display the model form.

| 1. |
Model name |
The name of the model, used when listing in back office and model editor. |
| 2. |
Common Name |
The system name to access the model programmatically. |
| 3. |
Model folder |
The container where the model is stored, choose another folder to move the model. |
| 4. |
Fragment region |
All model fragments are grouped into fragment regions. Double click to open the region dialogue window to edit the region name. |
| 5. |
Add Fragment Region |
Click to open the fragment region dialogue window to create a new fragment region. |
| 6. |
Settings region |
All settings are grouped into a setting region. |
| 7. |
Add Setting |
Click to add a setting region. Each model can only contain one setting region and you cannot name the region. The add button is disabled when a setting region has been added. |
| 8. |
Copy |
Opening an existing model displays a button to clone the entire model. Copying a model opens a second model form window with a clone of the model. The copy is not created until the Save button is pressed. |
| 9. |
Save |
Persists changes to the database. |
| 10. |
Cancel |
Cancel any changes and close the model form window. |
Fragment region

| 1. |
Functions and entities |
Click to open the functions and entities management window |
| 2. |
Delete fragment region |
Deletes the fragment region and all contained fragments |
| 3. |
Move fragment region up |
Move the fragment above the previous fragment region. Disabled when region is on top. |
| 4. |
Move fragment region down |
Move the fragment below the next fragment region. Disabled when region is on bottom. |
| 5. |
Add fragment |
Adds empty line in fragment list for creation of new fragment. |
| 6. |
Fragment list |
Lists all fragment in the fragment region. |
| 7. |
Title |
The display name of the fragment. Click the field to edit the name. |
| 8. |
Common Name |
The system name of the fragment, used to access the fragment programmatically. Click the field to edit the common name. |
| 9. |
Size |
Size of the text field where the template fragment value should be entered in number of rows. Click the field to edit the size. |
| 10. |
Up, Down |
Sort the fragment above the previous, or below the next fragment in the list. |
| 11. |
Functions and entities |
Click to open the functions and entities management window |
| 12. |
Delete fragment |
Deletes the fragment from the list. |
| 13. |
Move |
Move to another fragment region. |
Fragment functions and entities
Each fragment can have multiple functions(i.e. conditions and variables) and entities connected to them. The functions and entities are listed in back office when editing templates.
Click the Functions and entities on the fragment to manage the fragment functions and entities.

| 1. |
Fragment functions |
Contains all fragment functions. |
| 2. |
Function list |
Lists all functions added to the fragment. |
| 3. |
Add function |
Adds empty line in function list to create new function. |
| 4. |
Delete function |
Deletes function from fragment. |
| 5. |
Entity list |
Lists all entities added to the fragment. |
| 6. |
Manage entities |
Open Entity Editor for management of available entities. |
| 7. |
Add entity |
Adds empty line in entity list to create new entity. |
| 8. |
Delete entity |
Deletes entity from fragment. |
| 9. |
Ok |
Persist changes to the database. |
| 10. |
Cancel |
Cancel changes and close window. |
Fragment function list
A fragment function is the variable or condition that can be used in the template when rendering a model fragment.
| Fragment |
The current fragment |
| Type |
Variable or Condition, Variable is a dynamic value initialized in runtime. Condition is a true/false statement with an if...else...endif syntax. |
| Common Name |
A system name used to access the function programmatiacally. |
| Description |
Free text describing the function. |
Fragment entity list
Instead of specifying each variable explicitly, a fragment entity can be referenced. The entity encapsulates the available variables that can be used in the template when rendering a model fragment.
| Fragment |
The current fragment |
| Entity |
Choose entity from the list of defined entities. |
| Description |
Free text describing the function. |
Comments made
No comments are made
You need to be logged in to make a comment