Application Wizard

Start by clicking on "More applications" from the "Applications" panel and then on "Create your own!". This will take you to the App Within Minutes home page.

applications-panel.png

There you can see listed the existing applications. Click on the "Create Application" button to start the wizard.

AppWithinMinutes-Step0.png

Application Location

In the first step you have to provide the application name and location, which will determine the application home page URL. The application code will be generated as nested pages inside the specified location.

AppWithinMinutes-Step1.png

Application Structure

In the second step you define the application structure, i.e. the type of data the application will handle. At the end of this step the wizard will create for you:

  • a page to hold the application structure
  • a template page to store the default field values and to be used ("copied") when creating new application entries
  • a sheet that will be used to display and edit the application entries
  • a translation page to help localize the application

AppWithinMinutes-Step2.png

Field Palette

The second step of the App Within Minutes wizard helps you define the type of data your application will handle. The field palette lists the available field types. Most of these field types are mapped directly to XClass property types:

AppWithinMinutes-FieldPalette.png

Field TypeXClass Property Type
Short TextString
Long TextTextArea
NumberNumber
BooleanBoolean
Static ListStatic List
PagePage
DateDate
UserList of Users
GroupList of Groups
Database ListDatabase List

See the XWiki Data Model documentation to understand what an XClass is and what are all the available property types. The consequence of this mapping is that most of your application structured data will be stored in objects (XClass instances) attached to your application entries (documents). In fact, in this step the App Within Minutes wizard creates an XClass for your application.

Some field types, such as Title and Content are not mapped to an XClass property type but to a document field instead. Visually there's no difference between a Short Text field and the Title field. The difference comes from how the value is stored. In the case of the Title field the value will be stored in the title of an application entry (document). Same with the Content field: the value will be store in the content of the application entry (what you can edit in Wiki edit mode). This has a limitation though: you can use at most one Title/Content field per application.

Application Entries

In the third step you can configure the location where the application entries will be created. The information you enter here will be used in the Create Page dialog.

AppWithinMinutes-Step3.png

Application Presentation

In the last step you can customize the way the home page of your application will look like. You can specify:

  • the application title and description
  • the columns to display in the entries live table
  • the icon to be used on the Applications panel (since XWiki 4.2)

AppWithinMinutes-Step4.png

Home Page

At the end the wizard takes you to the home page of your application, which is the place from where you can manage the application data: edit the application structure, add new entries, edit or delete existing ones.

AppWithinMinutes-HomePage.png

Applications Panel Entry

Starting with XWiki 4.2 your application is listed in the Applications panel, with the icon you've chosen:

AppWithinMinutes-PanelEntry.png

Create Page Template

Since XWiki 8.4 you can create application entries not only from the application home page ("Add new entry") but also from the Create Page dialog (like you would create a normal wiki page).

AppWithinMinutes-CreatePage.png

Rename Application

Starting with XWiki 11.1 you can rename/move an application by renaming/moving its home page. Note that you can change the application title without renaming the application just by editing the application home page. Be aware that the application code is going to be regenerated if you rename the application, in order to work with the new application location. Code customizations will be overwritten as a consequence, but you can rollback the changes afterwards.

Also note that the application code is not updated automatically if the application location changes as a result of renaming or moving one of the parent pages of the application. For instance, if the application is located in Path / To / Books and you rename the "Path" parent page to "New Path" preserving children then you'll get the following warning when visiting the application home page:

awm-rename-parent.png

In order to fix the application code you need to edit the application and go through all the steps of the application wizard, updating the application configuration if necessary.

Tags:
Created by Marius Dumitru Florea on 2019/02/19 11:28
    

Get Connected