This chapter will guide you through the process of implementing basic functionality using the Genie JavaScript SDK. You will implement a login page, show an application menu driven by the process map in the server application, and hook up a data entry form to an activity and its associated fields and methods.
Creating the Client Configuration JavaScript File
To configure some of the functionality of the SDK, you're target project will need to define a config object in JavaScript, which we’ll detail here:
...
| Code Block | ||
|---|---|---|
| ||
<script type="text/javascript" src="~/Scripts/config.js"></script> |
Creating the Form Mapping File
Form mapping files are used to map activities on the server to pages on the client. Therefore, if the server issues an activity request, the Genie JavaScript SDK will know which page to navigate to in response. Let’s create a form mapping file now:
...
Note: Adding a default="true" attribute to an activity element will result in that activity automatically being navigated to after a successful login.
Creating a Login Page
Now we can finally start building out application. Let’s implement a simple login page, which will contain User Name and Password fields (with corresponding labels obtained from the server), a Log In button, and a message control.
...
Note: After the user has logged in and is using the application, if the user’s session is lost (cleaned up, etc), then a pop up window will appear (invoked by the SDK) asking them to log in again.
Displaying the Process Map as a Menu Bar
Let’s display a menu at the top of the page, based upon the contents of the process map sent by the server, and the form mapping file.
...
Note: You’ll find that the process map now renders on the login screen. To prevent this behaviour, usually your login page will use a different master layout to that of all other pages, which doesn’t include this control.
Creating a Summary List
Let’s implement a view that displays a list of items. Once we have that, we’ll customise it to allow you to drill down upon an item in the list.
Displaying Tabular Data
- Open the SummaryList.cshtml view that we previously created.
- The first thing we need to do is to define an activity container. This will be a div that has attributes that the SDK will look for. Add the following HTML to the end of the view:
...
- Run the project, log in, and navigate to this view using the menu on the Home page. Data from the server should appear in a tabular form.
Customising the List Using Templates
You can customise the rendering of the list using underscore templates. Detailing the use of underscore templates is beyond the scope of this document, but some good sources of information include:
...
- Run your project and navigate to the view. It should now be using the templates you created to render the list.
Enabling Drilling Down on an Item
You can turn on the ability to drill down on an item in a data control by setting the candrilldown attribute to true on the data control element. The first cell of each row will be turned into a hyperlink, which the user can click on to drill down on that row.
...
<table id="mySummaryList" populatemethod="listMyCookingClasses" bind="data" candrilldown="true" drilldownpage="details.html"></table>
Adding Support for Row Actions
A row action typically appears as a button or a hyperlink on each row of the data publication, which performs an action on that row. For example row actions may be things such as Edit, Delete, Add to Cart, and so on. These actions will map to methods on the server.
...
Note: If you want to pass the value of an input element to the method as a parameter, you can use the @userInput special replacement variable as the value of a parameter. When the action is invoked, the SDK will look for an input in the item/row whose name is of the format <rowid>_userinput_<paramname>.
Adding Support for Context Menus
Rather than invoking a method on the server when a button is clicked (as per actions), you may wish to get and display a context menu instead. To do so, follow the same method outlined in the section titled Adding Support for Row Actions, but instead of specifying a methodName attribute, specify a contextMenu attribute instead. For example:
...
</gridview>
</activity>
Enabling Editable Data Grids
Nothing needs to be done to enable editable data grids. When a data publication is received from the server that is marked as being editable, the default template will automatically insert input boxes in editable cells.
Note: If you are templating the data publication control, it’s essential that your input elements have a data-columnid attribute with the column ID that the input element corresponds to as its value in order for any value changes to be sent back to the server. <- Does not work properly currently. Should be by column name.
Creating a Data Entry Form
Let’s create a data entry form that displays data from the server, allows you to edit it, and saves those changes back to the server.
Configuring the Activity Container
You learnt how to configure an activity container in the previous section. Do the same again here for the data entry form, mapping it to an activity/style combination in the server application:
<div bind="activity" activityname="[activityname]" activitystyle="[activitystyle]">
</div>
Implementing a Message Control
You learnt how to configure message control back when implementing the login view. Do the same again here for the data entry form.
...
You’ll note that the message control renders as an unordered list. You can use CSS styles to render it according to your needs.
Binding a Data Entry Field to a Field on the Server
There are a number of ways of binding an input field to a field on the server. One way is as follows:
...
<select></select>
</div>
Binding a Button to a Method on the Server
To finish this data entry form we need a Save button. Add the following HTML to your view:
...