The Modify Unit is an Operation Unit and it's used to modify the values of one or more instances of an Entity.
When the Modify Unit is activated it physically changes one or more rows of the physical table related to the selected Entity replacing the old values with the data received as input.
Properties
The Properties View of the Modify Unit
Id: The unique key automatically assigned by WebRatio to identify the Unit (e.g. mfu2).
Name: A meaningful name for the Unit, used as label (e.g. Modify employee).
Bulk: A flag stating that the Unit is able to perform multiple Entity instance creations at once (expecting arrays as input parameters).
Entity: The Data Model Entity on which the Unit is based (e.g. employee).
Home: A flag stating that the Modify Unit must be executed as the first operation when the user enters in the related Site View.
Default: A flag stating that the Modify Unit must be executed as the first operation when the user enters the Area containing the Unit.
Landmark: A flag stating that the link shown in the corresponding Landmark menu that will activate the Unit. If the operation or the operation chain has no outgoing link, the final target page will be the last page visited.
Protected: A flag stating that the access to the Modify Unit is granted only to users belonging to groups entitled to access to it.
Secure: A flag stating that all the links that can activate the Modify Unit are implemented using the Secure HTTP protocol, instead of the HTTP protocol.
Custom Descriptor: A flag stating that the Unit uses a Custom Descriptor.
Custom URL Name: The Custom URL Name of the Unit. It is possible to define a custom name that will be used as URL to reach the Modify Unit, instead of the standard Id (used by default). The custom URL name must not contain whitespaces, non-ascii characters or other special characters like /, ?.
Configuration
The Context Menu of the Modify Unit
A Modify Unit can be configured through a context menu that can be reached right clicking on the Unit either in the Work Area or in the Outline View. The context menu contains the following options:
Add Link: Adds an outgoing link to the Unit which can be used to transport information and eventually to activate different actions (such as adding new content to the page, reaching another page with new content, activating operation chains).
Add OK Link: Adds an outgoing OK Link to the Unit. The OK Link is activated when the Unit performs its operation correctly and can be used to transport information. Moreover, the OK Link will cause the execution of its target element (opens a target page or activates other Operation Units).
Add KO Link: Adds an outgoing KO Link to the Unit. The KO Link is activated when the Unit isn't able to perform its operation correctly and can be used to transport information. Moreover, the KO Link will cause the execution of its target element (opens a target page or activates other Operation Units).
Add Property: Adds a custom property to the Unit. A Property is composed by Name and Value and permits to mark the element for different purposes.
Add Key Condition: Adds a Key Condition to the Unit.
The Input and the Output of the Unit are accessible through the Parameters Coupling window of incoming and outgoing Links respectively.
Input
Input configuration of the Modify Unit
The input of the Modify Unit consists of all the Conditions defined on the Unit (identifying the Entity instances to be modified) and all the Attributes and 1:N Relationship Roles of the Entity on which the Unit is defined (defining the new values for the instances). To access the input parameters, open the Parameters Coupling dialog with a double click or by selecting the "Coupling" property on an incoming link to the Modify Unit.
In case of BLOB attributes the unit exposes an additional input parameter named "<attribute-name> [file name]" which permits to specify an alternative file name (valid only if the BLOB value is provided in input).
In case of bulk modifying, the rules driving the creation of instances are the following:
if all the attribute values are arrays of length L, the unit exactly modifies L different instances.
if arrays of length L are inter-mixed with either arrays of length one or plain values, again L different instances are modified; single values are replicated all over the L instances.
if arrays with different lengths (greater than one) are provided to the unit an error will be returned.
Output
Output configuration of the Modify Unit
The output of the Modify Unit consists of the Key attributes identifying the modified Entity instances (or the NULL value if no instance has been modified). To access the Output Parameters, open the Parameters Coupling dialog with a double click or by selecting the "Coupling" property on an outgoing link from the Modify Unit.
Here all the Output Parameters can be coupled with the Input Parameters of the target element.
Examples
The purpose of this section is to show the usage of the Modify Unit through examples.
This example is based on the Data Model shown in the following image.
The Data Model used in the example
This Data Model consists of two Entities : "Company" and "Employee".
The "Company" entity has many attributes, such as "Name", "E-mail", "Nationality", and so on.
The "Employee" entity has attributes such as "Name", "Surname", "Email", "Role" and so on.
An Employee belongs to one Company while, obviously, a Company has many Employees. This is represented with the 1:N Relationship "Company_Employee".
Example 1: Modify an Employee
Our goal is to give the possibility to the user to select and modify the data of an employee in the application.
In order to accomplish this example, it is necessary to go through the following steps:
Add a Page to the Site View: select the "Page" icon from the palette, and place it on the Site View. Change the page name (setting "odify an Employee") and other properties in the Properties View (such as "Home" or "Landmark" properties) to make the page accessible.
Add a Power Index Unit to the page: select the Power Index Unit icon from the palette and place it inside the page. Change the "Name" property in "Employee List".
Set the Entity on which the Power Index Unit is based: click on the "Edit" button next to the "Entity" property in the Properties View. Then choose the "Employee" Entity from the opened dialog pane.
Choose which attributes of the selected Entity must be shown: click on the "Edit" button of the "Display Attributes" property. Then choose the "name", "surname", "hire date" and "company" attributes from the opened dialog.
Define the sort criteria of the Power Index Unit: click on the "Edit" button next to the "Default Sort Attributes" property, then choose the "surname" attribute and the "ascending" sort criteria. Since the Power Index Unit is dinamically sortable, set the "Sortable" property to true and the "Sort History Size" property to 1.
Define the division of the Employee List in pages: select the Power Index Unit, set the "Block Factor" property to "10" and the "Block Window" property to "10".
Add an Entry Unit to the page: select the Entry Unit icon from the palette and place it inside the page. Change the "Name" property in "Employee Data".
Define the Entry Unit fields:right click on the Entry Unit and select the Field Wizard option. In the opened dialog pane, select the Employee Entity. In the next pane, select the "oid", "name", "surname", "email", "birth date", "hire date" and "role" attributes. In order to modify the Company the employee belongs to, select the "EmployeeToCompany [1:N]" Relationship Role. Since all the Fields will be preloaded with the information of the selected employee, select the "Mark new fields as preloaded" checkbox.
Hide the "oid" Field: expand the Entry Unit in the Outline View and select the Oid Field. In the Property View, select the "Hidden" property and deselect the "Modifiable" property.
Draw a normal link between the "Employee List" Power Index Unit and the "Employee Data" Entry Unit: select the Link button from the palette and click on the "Employee List" Power Index Unit (the Source of the Link) and then on the "Employee Data" Entry Unit (the Target of the Link). Set the Name property of the newly created Link to "Modify" and the Type property to "normal".
Define the parameters coupling: open the Parameters Coupling window of the newly created link in order to define the coupling between the output parameters of the source Unit and the input parameters of the target Unit.In the Parameters Coupling dialog, couple the "oid" Attribute of the Power Index Unit with the "oid" Field of the Entry Unit,the "name" Attribute of the Power Index Unit with the "name" Field of the Entry Unit,the "surname" Attribute of the Power Index Unit with the "surname" Field of the Entry Unit,the "hire date" Attribute of the Power Index Unit with the "hire date" Field of the Entry Unit and the EmployeeToCompany.oid parameter (the primary key of the Companty the Employee is connected to) with the "Company - Preselection" Selection Field Slot.
Add a Selector Unit to the page: select the Selector Unit icon from the palette and place it inside the page. Change the "Name" property in "All Companies".
Set the Entity on which the Selector Unit is based: click on the "Edit" button next to the "Entity" property in the Properties View. Then choose the "Company" Entity from the opened dialog pane.
Define the sort criteria of the Selector Unit: click on the "Edit" button next to the "Sort Attributes" property, then choose the "name" attribute and the "ascending" sort criteria.
Draw a transport link between the "All Companies" Selector Unit and the "Employee Data" Entry Unit: select the Link button from the palette and click on the "All Companies" Selector Unit (the Source of the Link) and then on the "Employee Data" Entry Unit (the Target of the Link). Set the Name property of the newly created Link to "Companies data passing" and the Type property to "transport".
Define the parameters coupling: open the Parameters Coupling window of the newly created link in order to define the coupling between the output parameters of the source Unit and the input parameters of the target Unit.In the Parameters Coupling dialog, couple the "oid" Attribute of the Selector Unit with the "Company [output]" Selection Field Slot of the Entry Unit and the "name" Attribute of the Selector Unit with the "Company [label]" Selection Field Slot of the Entry Unit.
Add a Data Unit to the page: select the Data Unit icon from the palette and place it inside the page. Change the "Name" property in "Modified Employee".
Set the Entity on which the Data Unit is based: click on the "Edit" button next to the "Entity" property in the Properties View. Then choose the "Employee" Entity from the opened dialog pane.
Choose which attributes of the selected Entity must be shown: click on the "Edit" button of the "Display Attributes" property. Then choose the Data Unit attributes from the opened dialog.
Add a Modify Unit: select the Modify Unit icon from the palette and place it inside the Web Model. Change the "Name" property in "Modify Employee".
Set the Entity on which the Modify Unit is based: click on the "Edit" button next to the "Entity" property in the Properties View. Then choose the "Employee" Entity from the opened dialog pane.
Draw a normal link between the "Employee Data" Entry Unit and the "Modify Employee" Modify Unit: select the Link button from the palette and click on the "Employee Data" Entry Unit (the Source of the Link) and then on the "Modify Employee" Modify Unit (the Target of the Link). Set the Name property of the newly created Link to "Save" and the Type property to "normal".
Define the parameters coupling: open the Parameters Coupling window of the newly created link in order to define the coupling between the output parameters of the source Unit and the input parameters of the target Unit.In the Parameters Coupling dialog, press the Guess Coupling button. WebRatio will automatically couple all the Input Parameters with the Output Parameters. Then couple the "oid" Field of the Entry Unit with the automatically created Key Condition of the Modify Unit {{Note|The Guess Coupling functionality will perform a name comparison between Input and Output Parameters guessing possible coupling. It is particulary useful to use it with the Field Wizard functionality, since it will create the Fields with the same names of the Entity Attributes.
Draw an OK link between the "Modify Employee" Modify Unit and the "Modified Employee" Data Unit: select the Link button from the palette and click on the "Modify Employee" Modify Unit (the Source of the OK Link) and then on the "Modified Employee" Data Unit (the Target of the OK Link). Set the Name property of the newly created OK Link to "Employee modified".
Define the parameters coupling: open the Parameters Coupling window of the newly created link in order to define the coupling between the output parameters of the source Unit and the input parameters of the target Unit.In the Parameters Coupling dialog, couple the "oid" Attribute of the Modify Unit with the automatically created Key Condition of the Data Unit
Generate the Web application: click on "Generate Full Web Project" on the WebRatio Menu Bar. Once the generation process has completed, it is possible to start the application server and test the Web application.
The Web Model of the example
The Properties View of the Power Index Unit
The Properties View of the Entry Unit
The "Modify" Link Parameters Coupling window
The Properties View of the Selector Unit
The "Companies data passing" Link Parameters Coupling window
