Wiki source code of Creating A Person Manager Application
Version 22.1 by Andy Tripp on 2020/06/10
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This tutorial will show you how to build a Contact Manager application. It's very similar to the [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] tutorial. The only difference (so far) is that the FAQ tutorial involves a very trivial object: a FAQ object contains just two things: a "question" and an "answer", while this example uses a Person object that has more properties ("name", "age", "sex", etc.) .This is a very simple application that makes use of XWiki's [[classes, properties, and objects>>platform:DevGuide.DataModel||anchor="HXWikiClasses2CObjects2CandProperties"]]. It also uses a technique that you may frequently use as the basis for several different kinds of applications. | ||
| 6 | |||
| 7 | Also, this tutorial explains things a little differently than the FAQ tutorial. If something here doesn't make sense to you, try going through the FAQ tutorial and maybe it will make more sense. | ||
| 8 | |||
| 9 | = Prerequisites for following the tutorial = | ||
| 10 | |||
| 11 | You should have [[installed XWiki>>platform:AdminGuide.Installation]] and have a [[basic understanding of how to use it>>platform:Features.WebHome]]. | ||
| 12 | |||
| 13 | All through this tutorial you should refer to the [[XWiki Data Model>>platform:DevGuide.DataModel]] for information on XWiki's data model. You might also use the [[XWiki Scripting Guide>>platform:DevGuide.Scripting]] to get you started with scripting in XWiki and manipulating XWiki objects. In addition, this tutorial will introduce the concepts of Authoring Templates and Page Design Sheets, patterns that you will find particularly useful in creating XWiki applications. Completing this tutorial is a recommended prerequisite for anyone who wants to build custom applications on the XWiki engine. And by "custom application", we mean a huge variety of web applications. | ||
| 14 | |||
| 15 | {{warning}} | ||
| 16 | Make sure that your user is an [[Advanced user>>platform:Features.PageEditing||anchor="HAdvancedMode"]] before following this tutorial since you'll need for example to use the wiki editor (##Wiki > Edit## menu). | ||
| 17 | {{/warning}} | ||
| 18 | |||
| 19 | = Application Overview = | ||
| 20 | |||
| 21 | The Person Manager application will allow users to create a "Person object" by entering data (name, age, sex, etc) into a simple form and then submitting the form. Let's sketch out what roughly what those two pages should look like on a "napkin", using [[Balsamiq>>https://balsamiq.com/]]: | ||
| 22 | |||
| 23 | image:personDialog.PNG | ||
| 24 | |||
| 25 | Our page won't look exactly like that, but the point is that a website user can create a Person by filling out a "form" page like this. | ||
| 26 | |||
| 27 | Note all the various types of "widgets" shown here: | ||
| 28 | |||
| 29 | * "name" is a single-line text field | ||
| 30 | * "email" is also a single-line text field, but we'd like it to be validated (e.g. give an error if it doesn't have a "@" in it) | ||
| 31 | * "address" is a multi-line text field | ||
| 32 | * "phone" is a single-line text field (perhaps some validation here, too) | ||
| 33 | * "sex" is a drop-down list | ||
| 34 | * "married" is a checkbox: the only allowed values are "true" and "false" | ||
| 35 | * "image" is actually the name of some image file, but we actually display the image itself. Nice! | ||
| 36 | * "age" is Number field, which looks like a single-line text field, but has validation. | ||
| 37 | * "related people" is one more more links to other web pages. Very nice! | ||
| 38 | |||
| 39 | The Person then appears in a table with all other Person objects that have been previously created. Users can click on the Person in the table to see all the information about the Person. He may also edit that information or delete the Person. The table might look something like this: | ||
| 40 | |||
| 41 | image:personTable.PNG | ||
| 42 | |||
| 43 | When the user clicks on a row in the table, he will get a page that shows the information about the Person, which will look similar to the "Create Person" page, but without the ability to change anything. | ||
| 44 | |||
| 45 | == Objects Overview And Terminology == | ||
| 46 | |||
| 47 | Next, let's summarize the terminology for "Objects". For full details, see [[Data Model>>https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/DataModel/#HXWikiClasses2CObjects2CandProperties]]. There is nothing fancy happening here, but it's important to get our terminology straight. | ||
| 48 | |||
| 49 | A Person is an example of some "Object" or "class". We will use XWiki to define what "properties" are in a "Person" object. For example, we will say that there's a property called "name" of type "String". There's also a property called "age" of type "Number", and an "address" property that's type "TextArea" (a string that can be multiple lines). | ||
| 50 | |||
| 51 | When a user creates a new Person, we call that an "instance" of the "class". So we might say something like "I've created an instance of the Person class, with name 'Joe Smith'". And we would say that our table shows all the instances of the Person class. And instances can not only be created, but also edited or deleted. | ||
| 52 | |||
| 53 | We, the creators of the website, define the "Person" class. We define that once, and we're done. Our users use our website to create, edit, and delete instances of our Person class. | ||
| 54 | |||
| 55 | == Overview Of What We Will Do == | ||
| 56 | |||
| 57 | In this tutorial, we'll do the following steps: | ||
| 58 | |||
| 59 | * Define our Person class, using the XWiki "Data Types" page. | ||
| 60 | * Specify the properties of our Person class, using the XWiki "Class Editor" page. | ||
| 61 | * Define how a Person instance should be displayed, by creating a "Person Sheet" page. | ||
| 62 | * Create a Template and a Template Provider (whatever they are) for our Person class. | ||
| 63 | * Create a web page that displays a table of people. | ||
| 64 | * For each Person that you want to create, create a page and add an instance of our Person class to the page. | ||
| 65 | |||
| 66 | Note that we don't need to define a page for creating or editing a Person, just a page for *displaying* a Person. XWiki will automatically do that for us! | ||
| 67 | |||
| 68 | Once we are done with these steps, our application will be finished. A user of our website can see a page containing the table of Person objects, view the page for an existing person, add a new Person, edit an existing Person, or delete a Person. | ||
| 69 | |||
| 70 | = Go to the Special "Data Types" Page = | ||
| 71 | |||
| 72 | The "Data Types" page is a special XWiki page that lets us define classes like "Person". It'sactually hidden by default. To be "unhide" it, go to your profile page, select the Preferences tab, edit the page and choose to view Hidden Documents. | ||
| 73 | |||
| 74 | To find the "Data Types" page, enter a search query for the keyword "D". This should return a document titled "Data Types". | ||
| 75 | |||
| 76 | = Create the Person Class = | ||
| 77 | |||
| 78 | * On the "Data Types" page, under the heading "Create a new data type", in the "Title" field, enter ##Person## as the name of the page to create:((( | ||
| 79 | {{image reference="personClass.PNG"/}} | ||
| 80 | ))) | ||
| 81 | * As you can see in the Breadcrumb below the new page will be created at location ##XWiki > Person##. In practice the "Data Types" page will automatically prefix the page name with ##Class## (you could also enter ##PersonClass## as the page name directly). | ||
| 82 | * Now it would be nice to have it created in a new location such as ##PersonSpace > Person Class##. Since the ##PersonSpace## parent doesn't exist we cannot use the Tree picker button. Thus click the Pencil button as shown in the following image and replace ##XWiki## by ##PersonSpace##.((( | ||
| 83 | {{image reference="personLocation.PNG"/}} | ||
| 84 | ))) | ||
| 85 | * In technical terms you're creating a page named ##PersonClass## (with a title of "Person Class") located in a space also called ##PersonSpace## and thus the technical reference is ##PersonSpace.PersonClass##. | ||
| 86 | * Click the "Create this Class" button. You should then see a page with the following content:((( | ||
| 87 | {{code language="none"}} | ||
| 88 | {{velocity}} | ||
| 89 | ## Replace the default space with the space where you want your documents to be created. | ||
| 90 | ## Replace the default parent with the one of your choice and save the document. | ||
| 91 | ## | ||
| 92 | #set($defaultSpace = $doc.space) | ||
| 93 | #set($defaultParent = $doc.fullName) | ||
| 94 | {{/velocity}} | ||
| 95 | {{/code}} | ||
| 96 | ))) | ||
| 97 | |||
| 98 | In the code, change the word "$doc.space" with the name of the space where you want your pages to be created: "PersonSpace". | ||
| 99 | The line of code should look like this: | ||
| 100 | |||
| 101 | {{code language="none"}} | ||
| 102 | #set($defaultSpace = 'PersonSpace') | ||
| 103 | {{/code}} | ||
| 104 | |||
| 105 | You can also change the default parent of the new FAQ documents that are going to be created. To do so, replace the "$defaultParent" variable with the name of your document. | ||
| 106 | The line of code should look like this: | ||
| 107 | |||
| 108 | {{code language="none"}} | ||
| 109 | #set($defaultParent = 'PersonSpace.WebHome') | ||
| 110 | {{/code}} | ||
| 111 | |||
| 112 | Click the "Save & View" button. The class is now created and you should be looking at a page titled "Class: Person" that looks like this: | ||
| 113 | |||
| 114 | {{image reference="newPersonClass.PNG"/}} | ||
| 115 | |||
| 116 | = Add Properties to the Class = | ||
| 117 | |||
| 118 | Under the page title, you should see the words "The class does not have any properties yet. You can use the //__class editor__// to define them." Let's just follow those instructions! | ||
| 119 | |||
| 120 | * Click on the 'class editor' link | ||
| 121 | * Note that the link trail in the header is something like "Wiki Home / PersonSpace / Person Class". This shows you that you are indeed on the Person class page in Class edit mode. | ||
| 122 | |||
| 123 | Now, we need to specify all the properties of a Person. Let's have the following properties: | ||
| 124 | |||
| 125 | |=Property Name|=Property Type | ||
| 126 | |name|String | ||
| 127 | |email|EMail | ||
| 128 | |address|TextArea | ||
| 129 | |phone|String | ||
| 130 | |sex|static list | ||
| 131 | |married|Boolean | ||
| 132 | |image|Image | ||
| 133 | |age|Number | ||
| 134 | |relatedPeople|Page (Multiple) | ||
| 135 | |||
| 136 | * Enter the text //name// in the "name" field | ||
| 137 | * Choose "String" for the type of the property and then click on "Add". By using a String type, when a user goes to enter the //name// of a new Person, he will be prompted with a single-line text field.((( | ||
| 138 | {{image reference="name.PNG"/}} | ||
| 139 | ))) | ||
| 140 | * Click on the "+" icon to expand the options for the newly created property | ||
| 141 | * Change the value of the "Pretty Name" field to "Name"(capital N). With this done, the user sees the label "Name" rather than "name" when prompted for the name of a Person. This doesn't make a huge difference for this property, but when it comes to the property with the name "relatedPeople", it's nice to show the user something a little more friendy like "Related People". Also, you could later decide to change that label to "Similar People" without actually renaming the property (and thereby probably breaking something). | ||
| 142 | * Now repeat this to add each of the properties shown in the table above. | ||
| 143 | ** Note that the "EMail" type is like a String, except that it has a "Validation Expression" (e.g. to make sure it has an "@" character). | ||
| 144 | ** If we wanted to, we could add a "Validation Expression" to the "phone" property to make sure it's in a particular format. | ||
| 145 | ** For the "sex" property, in the "Display Type" field, enter "Select". This will give the user a drop-down menu. | ||
| 146 | ** As we define the "sex" property as type "static list", we specify the values for the field like this:((( | ||
| 147 | {{image reference="staticList.PNG"/}} | ||
| 148 | ))) | ||
| 149 | ** Note that there is no "Image" type. That's unfortunate. Let's just define it as a String here, and deal with that later. | ||
| 150 | ** Note that the "size" of our "age" field is 30 digits. Three digits should be plenty, so feel free to change that. | ||
| 151 | ** For our "relatedPeople" property, we want to allow multiple values, not just one. So find the "Multi Select" checkbox and check it. | ||
| 152 | * When you are done, you should see all your properties like this:((( | ||
| 153 | {{image reference="properties.PNG"/}} | ||
| 154 | ))) | ||
| 155 | * When you are done adding and configuring the properties, click the "Save & View" button | ||
| 156 | |||
| 157 | = Create the Page Design Sheet = | ||
| 158 | |||
| 159 | * After the previous step you are now on the FAQClass page which should look like this:((( | ||
| 160 | {{image reference="personClass2.PNG"/}} | ||
| 161 | ))) | ||
| 162 | * Click the first button ("Create the document sheet") to create the document sheet (the Page Design Sheet). This sheet determines how your page's objects will be rendered to the user. The document is automatically created. | ||
| 163 | * You should see a warning message with the text "The sheet is not bound to the class so it won't be applied automatically when a page that has an object of this class is displayed". Click the "Bind the sheet to the class" link that appears after the text. Basically, this ties the Person Class to the Person Sheet. | ||
| 164 | * Now click on "View the sheet document". This takes you to the ##PersonSpace.PersonSheet## page which you can edit in wiki mode and see its default content. This content is Velocity code which simply goes through all the properties and displays each one. For example, it will see that our Person class has a "married" property of type "Boolean", and will show a checkbox with a label of "married" (or perhaps "Married" if we specified that as our "pretty name" for the property). See [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] for more details about this code. This code is actually very close to working as-is. The only thing that would be ugly is that our "image" property would display as just a String, whereas we probably want to display the image itself, not some URL. | ||
| 165 | |||
| 166 | * Click "Save & View" | ||
| 167 | |||
| 168 | = Create the Authoring Template = | ||
| 169 | |||
| 170 | * Navigate back to the ##PersonSpace.PersonClass## document (you can use the arrows in the breadcrumb to do so). | ||
| 171 | * Click on the "Create the document template" button. The Authoring Template will be automatically created. | ||
| 172 | |||
| 173 | Note that earlier, we changed the space name preceding the page name because we wanted all of our Person pages to reside in a space named PersonSpace. Remember that all our documents will be copies of the Authoring Template used as a prototype so the content will be copied in all our Person documents and will execute the Design Sheet code in the context of the current document. See the [[dedicated page>>platform:DevGuide.IncludeInVelocity]] for more information regarding this technique. | ||
| 174 | |||
| 175 | Now we need to associate the prototype object with this document to turn it into a true authoring template: | ||
| 176 | |||
| 177 | * If you're on the template page, navigate back to the ##PersonSpace.PersonClass## document. | ||
| 178 | * At the bottom of the page, look for the following warning message: "The template does not contain an object of type PersonClass. Add a Person object to the template »." | ||
| 179 | * Click on "Add a Person object to the template »":((( | ||
| 180 | {{image reference="personClass3.PNG"/}} | ||
| 181 | ))) | ||
| 182 | |||
| 183 | Next, we want to remove the title for the newly created template: | ||
| 184 | |||
| 185 | * Navigate to the ##PersonSpace.PersonTemplate## document (you can click on the "View the template page (PersonSpace / Person Template)" link for doing that for example. | ||
| 186 | * Edit this document in Wiki mode | ||
| 187 | * Inside the Title field you have "Person Template" written -> delete this text | ||
| 188 | * Save & View | ||
| 189 | |||
| 190 | This step is needed so that all of our future entries don't have "Person Template" as their title. | ||
| 191 | |||
| 192 | Congratulations: you just created an Authoring Template! You're almost done now. | ||
| 193 | |||
| 194 | = Create the Template Provider = | ||
| 195 | |||
| 196 | After the template was created and the object was added, a new section appears with a button to create a template provider to use the existing template. Click that button. | ||
| 197 | |||
| 198 | ((( | ||
| 199 | {{image reference="personClass4.PNG"/}} | ||
| 200 | ))) | ||
| 201 | |||
| 202 | = Create a home page for the Person Manager application = | ||
| 203 | |||
| 204 | Now we are finished defining our Person class, and it's time to create our web pages. Recall that we only have two pages to create: | ||
| 205 | |||
| 206 | * A "main" page that contains a table of Person objects. | ||
| 207 | * A "Person" page that displays a single Person | ||
| 208 | * (We don't need to create a "form" page for creating a new Person or edit an existing person - XWiki does that for us) | ||
| 209 | |||
| 210 | Our "main" page will be the ##PersonSpace.WebHome## page. | ||
| 211 | |||
| 212 | * Click on "PersonSpace" in the breadcrumb to navigate to ##PersonSpace.WebHome## and notice that the page doesn't exist yet. | ||
| 213 | * Edit it in wiki mode | ||
| 214 | * Type in the title "People" | ||
| 215 | |||
| 216 | == Displaying existing Person entries == | ||
| 217 | |||
| 218 | You have 2 options when it comes to displaying existing Person entries: | ||
| 219 | |||
| 220 | 1. Use the livetable component | ||
| 221 | 1. Write custom code in order to display them in a table | ||
| 222 | |||
| 223 | We will only cover the "custom code" option here, because it's actually very easy to write a little code to display the table the way we want to. See the "Using the Livetable component" section of the [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] page for instructions to use a "livetable" instead. | ||
| 224 | |||
| 225 | To create our table, we need to think about Objects, not web pages. As people use our application, they create new instances of our Person class - they create Objects. Let's say there have been three "Person" objects created so far. That means there will be three rows in our table. But how do we write code for this table? We will need to "query the XWiki database" - essentially tell XWiki "get me all the instances of the PersonClass that exist". XWiki provides [[several different ways>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Query%20Module]] to do this query: | ||
| 226 | |||
| 227 | * XWiki Query Language (XWQL) | ||
| 228 | * Hibernate Query Language (HQL) | ||
| 229 | * Solr Query Language (SOLR) | ||
| 230 | |||
| 231 | The [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] page tells you how to use XWQL, but I will show you how to use SOLR. Why is SOLR "better"? It's a bit of a standard, it's very well documented, very flexible and fast. It's also pretty simple. | ||
| 232 | |||
| 233 | Regardless of which of these techniques we use to query, we will be writing code in the [[Velocity Template Language>>https://velocity.apache.org/engine/1.7/user-guide.html]]. | ||
| 234 | |||
| 235 | === Using custom code === | ||
| 236 | |||
| 237 | You will need to write the following code: | ||
| 238 | |||
| 239 | * Display a header above the table that says "People" | ||
| 240 | * Do SOLR query to get all documents (i.e. pages) containing an instance of PersonClass, with a "name" property of any value. | ||
| 241 | * Let's limit the number of results to 1000 because the default for SOLR is 10 and that's too low. | ||
| 242 | * Let's use XWiki syntax to create a table with three columns: Name, Email, and Phone (note that we don't bother to show all properties of a Person as columns in our table, but we could if we wanted). | ||
| 243 | * Loop through each document, doing the following: | ||
| 244 | ** find the PersonClass instance on the page. Set a variable called $object to that. | ||
| 245 | ** get the "name" property from the instance and display that in the first column of the table. | ||
| 246 | ** get the "email" property from the instance and display that in the second column of the table. | ||
| 247 | ** get the "phone" property from the instance and display that in the third column of the table. | ||
| 248 | |||
| 249 | Here is the resulting code: | ||
| 250 | |||
| 251 | {{code language="none"}} | ||
| 252 | {{velocity}} | ||
| 253 | = People = | ||
| 254 | #set ($className = 'PersonSpace.PersonClass') | ||
| 255 | #set ($attr = 'name') | ||
| 256 | #set ($queryStatement = "property.$className.$attr:*") | ||
| 257 | #set ($query = $services.query.createQuery($queryStatement, 'solr')) | ||
| 258 | #set ($discard = $query.bindValue('rows', '1000')) | ||
| 259 | #set ($searchResponse = $query.execute()[0]) | ||
| 260 | |=Name|=Email|=Phone | ||
| 261 | #foreach ($searchResult in $searchResponse.results) | ||
| 262 | #set ($documentReference = $services.solr.resolveDocument($searchResult)) | ||
| 263 | #set ($d = $xwiki.getDocument($documentReference)) | ||
| 264 | #set ($object = $d.getObject("$className")) | ||
| 265 | #if ($object.getProperty('name').getValue() != '') | ||
| 266 | |$object.getProperty('name').getValue()## | ||
| 267 | |$object.getProperty('email').getValue()## | ||
| 268 | |$object.getProperty('phone').getValue() | ||
| 269 | #end | ||
| 270 | #end | ||
| 271 | {{/velocity}} | ||
| 272 | {{/code}} | ||
| 273 | |||
| 274 | Notes: | ||
| 275 | |||
| 276 | * (TODO: explain why the check for empty name is needed - is the query returning the Template or class definition?) | ||
| 277 | * The "##" characters at the end of the lines showing rows in the table are required because XWiki wants all table data for a row to be on a single line.## | ||
| 278 | * TODO: explain Document, DocumentReference, and link to the javadoc. | ||
| 279 | |||
| 280 | * Copy this code and paste it as Wiki content inside ##PersonSpace.WebHome## | ||
| 281 | * Click "Save and View" | ||
| 282 | * New Person entries will now be displayed on the page once you create them. | ||
| 283 | |||
| 284 | At this point, your ##PersonSpace.WebHome## page will just display as an empty table because no instances of PersonClass have been created yet. | ||
| 285 | |||
| 286 | == Creating new Person instances == | ||
| 287 | |||
| 288 | There are 2 ways for you to let your users create new instances of our PersonClass: | ||
| 289 | |||
| 290 | 1. Declare the Person as a template | ||
| 291 | 1. Add a custom creation form | ||
| 292 | |||
| 293 | The [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] page describes how to create a custom form if you want to do that. But the simpler way is for you to use a template. Remember earlier, on the Person Class page, we clicked on a button to create a template, and clicked on another button to create a "Template Provider"? That's all we needed to do! | ||
| 294 | |||
| 295 | With that done, let's go ahead and create an instance of PersonClass. Go to your PersonSpace.WebHome page (the one with the table), and click the "Create" button to create a child page. You will be prompted for a page title and page type. In the list of Types, under "Template" you should see "Person": | ||
| 296 | image:createPerson.PNG | ||
| 297 | |||
| 298 | Fill in the person's name as the page title, choose the "Person" type, and click "Create." | ||
| 299 | You will then be prompted for all the information about your the Person instance that you want to create: | ||
| 300 | image:createPerson2.PNG | ||
| 301 | |||
| 302 | If you previously chose to use a "Custom creation form" for creating new FAQ entries, follow these steps: | ||
| 303 | |||
| 304 | * Go to ##FAQ.WebHome## | ||
| 305 | * Below the "Add a new question" header, enter a question (which will also be used as the document title) in the //Document// field | ||
| 306 | * Click //Create this FAQ// | ||
| 307 | * You can then enter your question in longer form using the //Question// field on the template, like this:((( | ||
| 308 | {{image reference="FAQSheetEdit.PNG"/}} | ||
| 309 | ))) | ||
| 310 | * Click //Save & View// and then you will see the newly created document, like this:((( | ||
| 311 | {{image reference="FAQSheetView.PNG"/}} | ||
| 312 | ))) | ||
| 313 | * Go back to the ##FAQ.WebHome## page (you can use the breadcrumbs) to see the list of existing questions((( | ||
| 314 | {{image reference="FAQsWithEntry.png"/}} | ||
| 315 | ))) | ||
| 316 | |||
| 317 | = Conclusion = | ||
| 318 | |||
| 319 | This tutorial has taught you how to use the Class Wizard app and it has detailed the concepts of classes, objects and properties and introduced the authoring templates and page design sheets. | ||
| 320 | |||
| 321 | You may also have learned a little bit about Velocity scripting in documents. You can use these basic concepts to build custom applications at the document or presentation layer of XWiki without having to compile or deploy code. | ||
| 322 | |||
| 323 | As always, please take the time to make this document better for other users if you find ways that it can be improved as you read it for the first time. |
