Developing Wolf Applications

Published on February 2018 | Categories: Documents | Downloads: 38 | Comments: 0 | Views: 363
of 248
Download PDF   Embed   Report

Comments

Content

WOLF User Guide version 1.3 Developing Wolf Applications 2009

WOLF User Guide version 1.3 2009

Table of Contents Before Reading this Document ..................................................................................................................... 6 Document Structure ................................................................................................................................. 6 How to Use this Document ....................................................................................................................... 6 1. Launching the Designer............................................................................................................................. 8 1.1 From the “My Account” page ............................................................................................................. 8 1.2 Using the URL of the Application ........................................................................................................ 9 1.3 From the Run Environment................................................................................................................. 9 2. Overview of the Designer ....................................................................................................................... 10 2.1 Screen Elements of the Designer ...................................................................................................... 11 3. Signing out of the Designer ..................................................................................................................... 12 4. Running an Application ........................................................................................................................... 12 5. Principles of using the Designer .............................................................................................................. 13 6. Developing your Application ................................................................................................................... 15 6.1 Overview ........................................................................................................................................... 15 6.2 Working with Application Properties ................................................................................................ 16 6.3 Actions on an Application ................................................................................................................. 19 7. Working with Entities .............................................................................................................................. 20 7.1 Entity Overview ................................................................................................................................. 20 7.2 Adding a new Entity .......................................................................................................................... 20 7.3 Entity Properties ............................................................................................................................... 21 7.4 Actions on an Entity .......................................................................................................................... 23 7.5 Entity Reports.................................................................................................................................... 24 7.6 Managing an existing Entity .............................................................................................................. 25 © 2009 Wolf Platform as a Service All rights reserved.

Page 2

WOLF User Guide version 1.3 2009

7.7 Working with Edit Screens ................................................................................................................ 26 7.8 Overview of Edit Screens .................................................................................................................. 27 7.9 Edit Screen Preview .......................................................................................................................... 33 7.10 Working with Tabs .......................................................................................................................... 34 7.11 Working with Custom Tasks Group................................................................................................. 36 7.12 Working with Sections .................................................................................................................... 40 7.13 Working with Master/Details Section ............................................................................................. 42 7.14 Working with Fields ........................................................................................................................ 46 7.15 Working with Search Screens ......................................................................................................... 63 7.16 Overview of Search Screens ............................................................................................................ 63 7.17 Search Screen Preview .................................................................................................................... 68 7.18 Working with the Criteria section of the Search Screen ................................................................. 69 7.19 Working with the Results section of the Search Screen ................................................................. 71 7.20 Quick View in the Search Screen .................................................................................................... 73 7.21 Entity Relations ............................................................................................................................... 74 7.22 Creating a Drop Down Field in an Entity ......................................................................................... 77 8. Working with Navigation Items .............................................................................................................. 81 8.1 Navigation Items Overview ............................................................................................................... 81 8.2 Adding a new Navigation Item .......................................................................................................... 81 8.3 Navigation Item Properties ............................................................................................................... 82 8.4 Actions on a Navigation Item ............................................................................................................ 90 8.5 Editing an existing Navigation Item .................................................................................................. 90 8.6 Deleting a Navigation Item ............................................................................................................... 91 9. Working with Business Rules .................................................................................................................. 92 © 2009 Wolf Platform as a Service All rights reserved.

Page 3

WOLF User Guide version 1.3 2009

9.1 Business Rules Overview ................................................................................................................... 92 9.2 Adding a new Business Rule.............................................................................................................. 92 9.3 Overview of the Business Rule Designer........................................................................................... 94 9.4 Working with the Business Rule Header ........................................................................................... 96 9.5 Business Rule Actions...................................................................................................................... 101 9.6 Actions on a Business Rule .............................................................................................................. 174 9.7 Editing an existing Business Rule .................................................................................................... 175 9.8 Deleting a Business Rule ................................................................................................................. 175 10. Working with Reports ......................................................................................................................... 176 10.1 Overview of Reports ..................................................................................................................... 176 10.2 Adding a new Report .................................................................................................................... 178 10.3 Basic Report Properties................................................................................................................. 179 10.4 Data Source for a Report .............................................................................................................. 180 10.5 Designing your Report .................................................................................................................. 184 10.6 Applying Criteria to a Report ........................................................................................................ 202 10.7 Actions on a Report....................................................................................................................... 211 10.8 Editing an existing Report ............................................................................................................. 211 10.9 Deleting a Report .......................................................................................................................... 212 11. Working with Categories..................................................................................................................... 213 11.1 Overview of Categories ................................................................................................................. 213 11.2 Adding a new Category ................................................................................................................. 213 11.3 Category Properties – Assigning a name to the Category ............................................................ 214 11.4 Using Categories in an Application ............................................................................................... 214 11.5 Actions on a Category ................................................................................................................... 217 © 2009 Wolf Platform as a Service All rights reserved.

Page 4

WOLF User Guide version 1.3 2009

11.6 Editing an existing Category .......................................................................................................... 217 12. Downloading Design XML Backup....................................................................................................... 218 12.1 Overview ....................................................................................................................................... 218 12.2 Downloading the design XML of your Application........................................................................ 218 13. Working with Charts ........................................................................................................................... 219 13.1 Overview of Charts........................................................................................................................ 219 13.2 Adding a new Chart/Graph ........................................................................................................... 221 13.3 Basic Chart Properties and setting the data source for a Chart ................................................... 222 13.4 Designing your Chart..................................................................................................................... 225 13.5 Actions on a Chart ......................................................................................................................... 238 13.6 Editing an existing Chart ............................................................................................................... 238 13.7 Deleting a Chart ............................................................................................................................ 238 14. Working with Dashboard Widgets ...................................................................................................... 239 14.1 Overview of Dashboard Widgets .................................................................................................. 239 14.2 Dashboard Widget for presenting Entity data .............................................................................. 239

© 2009 Wolf Platform as a Service All rights reserved.

Page 5

WOLF User Guide version 1.3 2009

Before Reading this Document Before reading this document, we recommend that you review and understand the basics of getting started with Wolf including a brief overview of the Platform, key terms & concepts, an introduction to the different environments of the Platform and typographical conventions as introduced in the “WOLF User Guide version 1.3 - Getting Started” document. Document Structure This document is divided into the following sections: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14.

Launching the Designer Overview of the Designer Signing out of the Designer Running an Application Principles of using the Designer Developing your Application Working with Entities Working with Navigation Items Working with Business Rules Working with Reports Working with Categories Downloading Design XML Backup Working with Charts Working with Dashboard Widgets

How to Use this Document “Launching the Designer” section describes the different ways you can access the Designer of an Application. “Overview of the Designer” section gives an overview of the Designer user interface and how you can use the different tools and options in the Designer. Read the “Signing out of the Designer” section to learn how you can log out of the Designer. “Running an Application” section describes how you can access the Run Environment of an Application from its Designer. “Principles of using the Designer” section highlights important points to remember while using the Designer to build an Application. “Developing your Application” sections details how you can get started with building your Application in the Designer and configure the Application properties. “Working with Entities” section gives an overview of the Wolf Entity Designer Control and how you can create and use Entities in your Application. © 2009 Wolf Platform as a Service All rights reserved.

Page 6

WOLF User Guide version 1.3 2009

“Working with Navigation Items” section gives an overview of the Wolf Navigation Designer Control and how you can create and use Navigation Items in your Application. “Working with Business Rules” section gives an overview of the Wolf Rules Designer Control and how you can create and use Business Rules in your Application. “Working with Reports” section gives an overview of the Wolf Reporting Designer Control and how you can create and use Reports in your Application. “Working with Categories” section explains how you can create and use a Category in your Application. “Downloading Design XML Backup” section describes the process of downloading your Design XML and the basic features of this downloaded Design XML. “Working with Charts” section gives an overview of the Wolf Chart Designer Control and how you can create and use Charts in your Application. “Working with Dashboard Widgets” section gives an overview of Dashboard Widgets and how you can create and use Dashboard Widgets in your Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 7

WOLF User Guide version 1.3 2009 1. Launching the Designer This section describes the different ways in which we can access the Designer of an Application. Using any of the methods mentioned below, you can login and start using the Designer. 1.1 From the “My Account” page Once you are logged into your Wolf Account, you can access the Designer of an Application from the “My Account” page by clicking on the Design button next to the Application.

Note: You need to be signed into your Wolf Account to use this method. The “My Account” page is the home section for managing your Account.

Tip: 1.

If you are logging into the Designer for the first time, you need to login using the Super User credentials of the Application.

2. If you have created Users for an Application with access to the Designer, you can login using the credentials of the User. © 2009 Wolf Platform as a Service All rights reserved.

Page 8

WOLF User Guide version 1.3 2009

1.2 Using the URL of the Application The easiest method to access the Designer is by using the Application URL. Here is a sample format for accessing the Designer of a specific Application: http://run.wolfframeworks.com/design/?appid=[AccountID_ApplicationID] Where [AccountID_ApplicationID] is the unique identifier of an Application. For instance: 123DDDD_a131 is the unique identifier for an Application with the Account ID as 123DDDD and the Application ID as a131.

Note: Using this method you can directly access the Designer of an Application without logging into your Wolf Account.

1.3 From the Run Environment If you are logged into the Run Environment as the Super User, the Design Environment button will be present at all times as the Super User can access the Run and the Designer of an Application.

If you are logged into the Run Environment as a User, the Design Environment button will only be visible if the User has access to the Designer of the Application.

Note: You need to be signed into the Run Environment of the Application to use this method.

© 2009 Wolf Platform as a Service All rights reserved.

Page 9

WOLF User Guide version 1.3 2009

2. Overview of the Designer Logging into the Designer is your first step towards designing and developing your own Wolf Application. The entire Designer is accessible over a browser and has four Wolf Controls arranged in a chronology of logical order. More controls will be added to ease and enhance the Application Designing Process inside the Designer. The figure below gives a top level view of the Designer. It shows how the Designer of an Application will look like when we first login to the Designer. In addition to these screen elements, the Designer contains other elements that load dynamically as per the Node selected in the Solution Explorer.

Note: All screen elements and On Click Help information changes as per your selection in the Solution Explorer. Every time you click on a Node in the Solution Explorer, the Tools, Properties, Help and other Tabs will adjust their display automatically. For example, when we click on the “Edit Screen” node in an Entity, the Designer generates a preview of the Edit Screen next to the Designer Home.

© 2009 Wolf Platform as a Service All rights reserved.

Page 10

WOLF User Guide version 1.3 2009

2.1 Screen Elements of the Designer This section explains the screen elements of the Designer and how you can use the different tools and options in the Designer. Solution Explorer

The iframe window in the left panel of the Designer that allows creation, opening and manipulation of Wolf Designer Controls. Based on the currently selected Node in the Solution Explorer, the Tools, Properties, Help and other Tabs will adjust their display automatically. Designer Toolbar

The Designer Toolbar provides quick and easy access to commonly-performed functions in the Designer. It consists of a set of buttons and drop-down lists that refresh based on the currently selected Node in the Solution Explorer.

1. Save: Update recent changes made to the currently selected Node and its Sub Nodes

since the last Save. 2. Publish: Update recent changes made to the currently selected Node and its Sub Nodes and make these changes reflect in the Run Environment of the Application. A Publish performs an implicit Save. 3. Run App: Launches the Run Environment of the Application. Logging in with the appropriate credentials is necessary for accessing the Run Environment. 4. New: Creating a new Designer Control. Also allows the creation of a new Category. 5. Open: Opening an existing Designer Control. Also allows the opening of an existing Category. 6. Close: Closes the currently selected Node in the Solution Explorer. 7. Remove: Removes or deletes the currently selected Node in the Solution Explorer. Caution: It is important to use the Remove button with caution as removing a Designer Control would mean that it is deleted and can no longer be accessed. 8. Move Up/Down: Move the currently selected Node in the Solution Explorer up/down. 9. Design Backup: Enables you to download and backup the Design XML of an Application on your local machine. On Click Help © 2009 Wolf Platform as a Service All rights reserved.

Page 11

WOLF User Guide version 1.3 2009

The On Click Help dynamically generates help text depending on the Node in the Solution Explorer which you are currently working with. Sign Out button

This button can be used to Sign Out of the Designer. Properties

The iframe window below the Solution Explorer that allows modification of the properties of the currently active element in the Solution Explorer. Different control elements have different associated properties. Designer Home

The section that loads on opening the Designer or clicking on the Application Node in the Solution Explorer. It contains a brief description of the Wolf Designer Controls along with options for creating and editing them. Panel Bars

The Designer consists of two Panel Bars, the Left Panel Bar and the Right Panel Bar that can be positioned to view/hide the screen elements of the Designer.

3. Signing out of the Designer You can sign out of the Designer by clicking on the Sign Out button in the upper right hand corner of the Designer. Caution: Remember to Save/Publish any changes you have made to an Application before signing out. Any unsaved/unpublished changes will be lost on signing out.

4. Running an Application You can launch the Run Environment of an Application by clicking on the Run App button in the Designer toolbar. Logging in with the appropriate credentials is necessary for accessing the Run Environment. Tip: If you are accessing the Run Environment for the first time, login with the Super User credentials. Doing so presents the Administrative interface allowing the Super User to control administrative, security and access features of an Application. The Super User can add, modify and delete Roles, Users and Folders of an Application using this interface.

© 2009 Wolf Platform as a Service All rights reserved.

Page 12

WOLF User Guide version 1.3 2009

5. Principles of using the Designer Point 1: Remember to Save and Publish When using the Designer to build an Application, remember to Save and Publish after making a set of changes to the Application. For example, when adding Fields to an Edit Screen, add all the Fields to the Edit Screen and then use the Publish button. A Save updates recent changes made to the currently selected Node (in the Solution Explorer) and it’s Sub Nodes since the last Save. A Publish updates recent changes made to the currently selected Node and its Sub Nodes and makes these changes reflect in the Run Environment of the Application. Tip: 1. A Publish performs an implicit Save. Therefore, it will suffice to press the Publish button instead of pressing the Save button followed by the Publish button. 2. The Save and Publish buttons are present in the Designer Toolbar. Also, right clicking on a Node in the Solution Explorer presents the Save and Publish options where applicable. Point 2: Nodes in the Designer This topic has been covered in the “WOLF User Guide Version 1.3 - Getting Started” document. Please refer to the “Concept of Nodes in the Designer” section of the document.

Point 3: Using the Properties section The Properties section allows you to change the properties of the currently selected Node in the Solution Explorer. The Properties section is in the form of a grid and you can press F2 to edit a property and press Enter to accept the changes. If you are unsure about any change, press Esc to exit the property edit. A Property name followed by the “*” symbol is a mandatory property. For example, the Entity name is a mandatory property. Tip: 1. If a non-mandatory property is left unspecified, the Application will use the default settings for that property. 2. Changes made to a property most often only reflect in the Run environment of the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 13

WOLF User Guide version 1.3 2009

Point 4: Using the Designer Toolbar The buttons and drop-down lists in the Designer Toolbar refresh based on the currently selected Node in the Solution Explorer. Actions that can be performed by right-clicking on the currently selected Node in the Solution Explorer can also be performed by using the buttons and drop-downs present in the Designer Toolbar.

Point 5: Deleting the browsing history of your web browser After making changes to the user interface of an Application in the Designer, it is recommended that you delete the browsing history of your web browser (Internet Explorer, Mozilla, etc.) before viewing these changes in the Run Environment. Examples of user interface changes include: 1. Adding Fields in an Edit Screen/Search Template of an Entity 2. Changing the Look and Feel of your Application from its properties. 3. Disabling the Quick View of a Search Screen from its properties. 4. Making a Field “read-only” from its properties. However, changes made in Business Rules or in the Properties section most often directly reflect in the Run environment unless they alter the user interface of the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 14

WOLF User Guide version 1.3 2009 6. Developing your Application 6.1 Overview This section describes how you can get started with developing your Wolf Application. After logging in to the Designer, you will be presented with the following interface.

Dragging the Left Panel Bar towards the right displays the Solution Explorer and the Properties section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 15

WOLF User Guide version 1.3 2009

By default, your Application will be named as “WSF Application” (Wolf Solution Framework Application) in the Solution Explorer. The WSF Application Node or simply the Application Node is the top level (Level 0) Node of the Application. Click on the Application Node to refresh the screen elements appearing in the Designer. You can start customizing an Application’s properties from the Properties section. These properties include: 1. Basic Settings: such as Application name, Application image, footer, etc. 2. Mail Settings: required for configuring a custom mail server for an Application. 3. Environment Defaults: choosing a specific date format for an Application.

Note: It is important to remember that you can change the Properties of the Application only if the Application Node is currently selected in the Solution Explorer.

6.2 Working with Application Properties As we can see from the figure below, the Properties have been divided into four sections.

© 2009 Wolf Platform as a Service All rights reserved.

Page 16

WOLF User Guide version 1.3 2009

Property

Description

Misc Solution Name

The name you want to provide to your Application. For example, Contact Manager. Every Application has the name WSF Application by default.

Solution Image/Logo

Select an image that best represents your Application. You can also upload an image through the selectable popup.

Footer

Setting the footer of the Application. This is often used to display copyright information related to the Application.

Terms of Use

Upload your terms of use document and link to it. This link will appear in the footer in the Run Environment.

Look and Feel Skin/Color Scheme

The skin or color scheme that you would like in your Run Environment. The default skin is a bluish shade.

Header Background Color

A hexadecimal color representation for the header section of your Application. Standard HTML short names for colors can also be used, i.e., White, Black etc.

Header Font Color

A hexadecimal color representation for the fonts in the header section of your Application. Standard HTML short names for colors can also be used, i.e., White, Black etc. Remember to have the font color shade contrasting the background color. Having the same color as the background will make the fonts appear invisible.

Mail Settings SMTP Server

Specify the SMTP server through which you would like to send emails. If left unspecified all your outgoing emails will go from the WOLF servers by default.

SMTP User

The SMTP authenticated user. This is required only if your SMTP server requires authentication.

SMTP Password

The SMTP password for above user. This is required only if your SMTP server requires authentication.

SMTP Port

The SMTP server port.

© 2009 Wolf Platform as a Service All rights reserved.

Page 17

WOLF User Guide version 1.3 2009

SSL

Whether the server uses SSL or not. Check it if server uses SSL otherwise leave it unchecked.

Environment Defaults Date Format

All dates will be accept in this date format unless overridden. You can select the date format from a dropdown. Format can be dd/mm/yyyy or mm/dd/yyyy.

© 2009 Wolf Platform as a Service All rights reserved.

Page 18

WOLF User Guide version 1.3 2009

6.3 Actions on an Application In addition to changing the Properties of an Application, there are several actions possible on an Application. To view these actions, right click on the Application Node.

The Save button enables you to Save changes made to an Application. Clicking the New button will present a drop down list of the components that can be created for an Application. The following components can be created: 1. Entity 2. Business Rule 3. Report 4. Navigation Item 5. Category Clicking the Open button will present a drop down list to open an existing component for editing. To download and backup the Design XML of an Application on your local machine, click the Tools option and select Design XML Backup.

© 2009 Wolf Platform as a Service All rights reserved.

Page 19

WOLF User Guide version 1.3 2009

7. Working with Entities 7.1 Entity Overview Start designing your Application with the Wolf Entity Designer. The Wolf Entity Designer is a Wolf Designer Control that assists you to create, modify and delete the Entities of your Application. An Entity may be defined as anything that holds data or a table of data. For example, if you want to build an Application that holds the contact information of people, an Entity called “Contact” may be defined to store the information of each contact. This is a real Entity, which has its own state, properties, data, screens and rules. For visual representation, the Entity uses an Edit Screen. You can add fields in the Edit Screen of your Entity. By default every Entity in Wolf contains a Default Edit Screen with a Tab and a Section defined inside it.

7.2 Adding a new Entity There are several ways of adding a new Entity to an Application. From the Designer Home You can add a new Entity by clicking on the Add a new Entity button in the Designer Home.

From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Entity.

From the Solution Explorer Right click on the Application Node, select New and then select New Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 20

WOLF User Guide version 1.3 2009

A new Entity has the structure shown in the figure below:

7.3 Entity Properties Let’s first take a look at the basic properties of an Entity.

Note: 1. We can view the Entity properties from the Properties section only if the Entity Node is selected in the Solution Explorer. 2. The Entity Name is a mandatory property as it has been marked with a “*”.Every Entity must have a unique Entity Name. Duplicate Entity Names are not allowed in Wolf. 3. © 2009 Wolf Platform as a Service All rights reserved.

Page 21

WOLF User Guide version 1.3 2009

Property

Description

Misc Entity Name (*)

Provide a meaningful name to the Entity. You will use this name every time you refer to this Entity. For example, while using Business Rules or creating Relations with other Entities.

Description

Provide a brief description of the Entity. The Description provided here will be used in the auto generated documentation and also allows other individuals using the Designer to understand its functionality/purpose.

Category

The categorization helps you to organize your Entities. For example, in a CRM Application all the Entities related to an account may be assigned an “Account” category. You can choose the category from a drop-down box listing all the categories of the Application.

Auto Form Attachment Enabled

If checked then the Run Environment user interface will have the ability to add attachments. For example, if you want to attach a photo or some documents to a Contact.

Note: While assigning your Entity to a Category, it is important to remember that only the “General” Category is available by default. Other categories, if required, need to be created before they can be used. Please refer to section “11.Working with Categories” for more information.

© 2009 Wolf Platform as a Service All rights reserved.

Page 22

WOLF User Guide version 1.3 2009

7.4 Actions on an Entity In addition to changing the Properties of an Entity, there are several actions possible on an Entity. To view these actions, right click on the Entity Node.

The Save and Publish buttons enable you to Save/Publish changes made to an Entity. Clicking the Close button enables you to close the working session with the current Entity. To create a Custom Edit Screen for your Entity, click the New button and then select New Edit Screen. Click the Delete button to remove the current Entity from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 23

WOLF User Guide version 1.3 2009

7.5 Entity Reports Clicking on the Entity Node in the Solution Explorer generates an Entity-specific report in the Designer Home. This Entity Report contains the following important information about an Entity: 1. Reference to the Current Entity – Lists the Entity relationships with other Wolf Controls. 2. Space occupied in DB – The space occupied by the Entity data on the server in MB.

© 2009 Wolf Platform as a Service All rights reserved.

Page 24

WOLF User Guide version 1.3 2009

7.6 Managing an existing Entity There are several ways of managing an existing Entity of an Application. Using any of the methods mentioned below opens a popup listing the existing Entities of an Application. Choose the appropriate Entity and then click the Open button in the popup to start working with the Entity. From the Designer Home You can manage an existing Entity by clicking on the Manage an existing Entity button in the Designer Home.

From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Entity.

From the Solution Explorer Right click on the Application Node, select Open and then select Existing Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 25

WOLF User Guide version 1.3 2009

7.7 Working with Edit Screens An Edit Screen in Wolf allows the visual representation of your Entity. An Edit Screen is a form with fields and is used to display the fields/data of an Entity and to provide a means for data entry.

The figure shows how a complete Edit Screen will appear to a User in the Run Environment. It is important to note that an Edit Screen need not necessarily consist of all the components shown in the figure. For example, the simplest Edit Screen may consist of a single Tab and a single Section with Fields defined inside it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 26

WOLF User Guide version 1.3 2009

7.8 Overview of Edit Screens 7.8.1 Types of Edit Screens Edit Screens in Wolf are of two types: 1. Default Edit Screen 2. Custom Edit Screen Even though the basic structure and functionality of both these Edit Screens is similar there are some important differences between the two and we will consider each of them individually in turn. 7.8.1.1 The Default Edit Screen When you create an Entity, the Default Edit Screen is automatically created for you - instantly. An Entity can contain only a single Default Edit Screen inside it and you cannot create any more Default Edit Screens for an Entity. Expand the Entity Node to see the Default Edit Screen of your Entity. Expand the Default Edit Screen Node to see the Tab and expand the Tab Node to see a Section defined inside it. It is important to note that if there are multiple Edit Screens in an Entity, i.e. one Default Edit Screen and any number of Custom Edit Screens, then the Default Edit Screen acts like the master repository of fields in the Entity allowing the Custom Edit Screens to use only the fields defined inside it.

Note: 1. An Entity can contain only a single Default Edit Screen which gets created automatically when the Entity is created. This Default Edit Screen also contains a Tab and a Section defined inside the Tab. 2. It is not possible to change the name of the Default Edit Screen. 3. It is not possible to delete the Default Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 27

WOLF User Guide version 1.3 2009

7.8.1.1.1 Default Edit Screen Properties The Properties of the Default Edit Screen are used for controlling the layout of the Edit Screen and the tools appearing in it.

Property

Description

Misc No. of columns

Select the number of columns to display a multicolumn Editable Form. By default, every Edit Screen has a single column. Multicolumn Forms are useful for longer forms.

Hide [Save and Close]

Checking this box will hide the Save & Close tool from the Edit Screen toolbar. The tool when clicked attempts to save the record and closes the window on successful save.

Hide [Save]

Checking this box hide the Save tool from the Edit Screen toolbar. The tool when clicked attempts to save the record and stays on the same window.

Hide [Save and New]

Checking this box will hide the Save & New tool from the Edit Screen toolbar. The tool when clicked attempts to save the record and resets all inputs to allow you to create a new record.

Hide [Refresh UI]

Show or Hide the Refresh UI tool from the toolbar. The tool works like the F5 key or refresh.

© 2009 Wolf Platform as a Service All rights reserved.

Page 28

WOLF User Guide version 1.3 2009

7.8.1.2 The Custom Edit Screen As compared to the Default Edit Screen, the Custom Edit Screen does not get created automatically when the Entity is created and needs to be created for an Entity. Also, creating a Custom Edit Screen does not lead to the creation of a Tab inside it and a section defined inside the Tab. You will need to create a Tab and a Section inside a Custom Edit Screen. An important point to remember is that an Entity can consist of many Custom Edit Screens as required. Hence it is possible to create and delete Custom Edit Screens whereas there can be a single Default Edit Screen in an Entity. No new Fields can be created inside the Custom Edit Screen and it can only use the Fields that is already defined inside the Default Edit Screen. This makes the Default Edit Screen as the master repository of Fields for an Entity and allows for the flexible representation of an Entity and its Fields/data using the Custom Edit Screens. Note: 1. It is mandatory to specify a name for a Custom Edit Screen. 2. Any number of Custom Edit Screens can be created for an Entity. 3. The Custom Edit Screen can only use the Fields defined inside the Default Edit Screen.

7.8.1.2.1 Creating a Custom Edit Screen To create a Custom Edit Screen for an Entity, right click on the Entity Node, select New and then select New Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 29

WOLF User Guide version 1.3 2009

7.8.1.2.2 Deleting a Custom Edit Screen To delete a Custom Edit Screen in an Entity, right click on the Custom Edit Screen and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Custom Edit Screen.

Caution: Deleting a Custom Edit Screen also deletes the Tabs and Custom Tasks defined inside it.

7.8.1.2.3 Custom Edit Screen Properties The Properties of a Custom Edit Screen are identical to those of a Default Edit Screen with the exception of a mandatory property to specify a name for the Custom Edit Screen.

Property

Description

Misc Name (*)

A meaningful name for the Custom Edit Screen. This is mandatory since there can be any number of Custom Edit Screens in an Entity.

The other Custom Edit Screen Properties have been covered in section for Default Edit Screen Properties. © 2009 Wolf Platform as a Service All rights reserved.

Page 30

WOLF User Guide version 1.3 2009

7.8.1.3 Actions on an Edit Screen In addition to changing the Properties of an Edit Screen, there are several actions possible on an Edit Screen. The actions appearing in a Default Edit Screen are limited as compared to that of a Custom Edit Screen. Actions on the Default Edit Screen: To view these actions, right click on the Edit Screen Node. The Save and Publish buttons enable you to Save/Publish changes made to an Edit Screen. Clicking the New button will present a drop down list of the components that can be created for an Edit Screen.

There are two components that can be created in an Edit Screen: 1. Tab 2. Custom Tasks Group Actions on the Custom Edit Screen: The actions listed for the Default Edit Screen apply to a Custom Edit Screen as well. In addition, there are some extra actions possible for a Custom Edit Screen. To delete a Custom Edit Screen, right click on the Custom Edit Screen Node and select Delete.

© 2009 Wolf Platform as a Service All rights reserved.

Page 31

WOLF User Guide version 1.3 2009

The Move up and Move down buttons can be used to move the current Custom Edit Screen up/down with respect to the other Custom Edit Screens present in the Entity. This enables us to arrange the order of the Custom Edit Screens in an Entity.

Note: In general, the term Edit Screen is used to refer to both, the Default Edit Screen as well as the Custom Edit Screen. Differences between the two have already been pointed out in the previous sections and any specific difference that arises will be highlighted.

© 2009 Wolf Platform as a Service All rights reserved.

Page 32

WOLF User Guide version 1.3 2009

7.9 Edit Screen Preview To get a preview of an Edit Screen, click on the Edit Screen Node in the Solution Explorer. The Designer automatically generates a preview of the Edit Screen showing its structure and the Fields inside it.

To refresh the Edit Screen preview, right click on the preview window and choose Refresh.

Tip: The preview is an indication of how your Edit Screen will look in the Run Environment.

© 2009 Wolf Platform as a Service All rights reserved.

Page 33

WOLF User Guide version 1.3 2009

7.10 Working with Tabs Tabs are used for logical grouping of data/Fields in an Edit Screen. An Edit Screen may consist of multiple Tabs. For example, for a “Contact” Entity that stores the contact information of people, different Tabs may be used for storing business data and personal data of the contact. When we create an Entity, the Default Edit Screen consisting of a single Tab is created automatically. However, when we create a Custom Edit Screen, we will need to create a Tab inside it. We can create as many Tabs as required inside an Edit Screen. Tip: An Edit Screen may consist of multiple Tabs. Use the Tabs for logical grouping of data/Fields inside an Edit Screen. 7.10.1 Adding a Tab To create a new Tab for your Edit Screen, right click on the Edit Screen Node, select New and select New Tab. You can then start working with the newly created Tab. Note: Any Tab that you create in the Edit Screen does not have a name assigned to it. You can assign a name to the Tab from the Properties section. 7.10.2 Tab Properties You can provide a meaningful name for your Tab from the Properties section.

Property

Description

Misc Tab Name

You may provide a name for your Tab here. This helps improve the readability when your Edit Screen consists of multiple Tabs.

7.10.3 Actions on a Tab In addition to changing the name of a Tab from the Properties, there are several actions possible on a Tab. To view these actions, right click on the Tab Node. The Save and Publish buttons enable you to Save/Publish changes made to a Tab. Clicking the New button will present a drop down list of the components that can be created for a Tab.

© 2009 Wolf Platform as a Service All rights reserved.

Page 34

WOLF User Guide version 1.3 2009

There are two components that can be created inside a Tab: 6. Section 7. Master/Details Section Use the Delete button to delete the current Tab. The Move up and Move down buttons can be used to move the current Tab up/down with respect to the other Tabs present in the Edit Screen. This enables us to arrange the order of the Tabs appearing in the Edit Screen. For example, the “Contact Entity” contains an Edit Screen with three Tabs in the order: General Details, Professional Details & Personal Details. Suppose we want to display the Personal Details Tab as the first Tab on the Edit Screen. We can do this by clicking on the Personal Details Tab Node and clicking the Move up button twice. 7.10.4 Deleting a Tab To delete a Tab, right click on the Tab Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Tab. Caution: Deleting a Tab also deletes the Sections and Master/Details Sections defined inside it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 35

WOLF User Guide version 1.3 2009

7.11 Working with Custom Tasks Group The Custom Tasks Group holds all the Custom Tasks created for an Edit Screen. A Custom Task creates an additional button in the Edit Screen, which can be clicked to achieve one of three things in an Application: 1. Invoke a Business Rule that achieves a specific functionality 2. Open a Screen such as Search Screen, Edit Screen, Report, Dashboard Item, etc. 3. Open an external URL For example, consider a CRM application that contains two Entities – “Lead” and “Opportunity”. The functionality of the CRM requires that for a particular scenario, a record of the “Lead” Entity needs to be created into an “Opportunity” record. In simple terms, we need to convert a marketing lead into a sales opportunity. We can create a Business Rule to achieve this scenario and link it to a Custom Task. On clicking this Custom Task from the Edit Screen of the “Lead” Entity, the “Lead” will be converted into an “Opportunity”. The figure below shows a Designer preview of how the Custom Task will appear on the Edit Screen:

Any Custom Task that is created gets added in the More Tasks/Actions drop-down of the Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 36

WOLF User Guide version 1.3 2009

7.11.1 Creating a Custom Tasks Group Before creating Custom Tasks for an Application, you need to create a Custom Tasks Group that holds all the Custom Tasks of the Edit Screen. To create a new Custom Tasks Group, right click on the Edit Screen Node, select New and then select Include Custom Tasks. 7.11.2 Actions on a Custom Tasks Group To view the set of actions possible on a Custom Tasks Group, right click on the Custom Tasks Group Node. The Save and Publish buttons enable you to Save/Publish changes made to a Custom Tasks Group. Clicking the New button gives you the option to create a new Custom Task in the group. Use the Delete button to delete the Custom Tasks Group. 7.11.3 Deleting a Custom Tasks Group To delete a Custom Tasks Group, right click on the Custom Tasks Group Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Group.

Caution: Deleting a Custom Tasks Group also deletes the Tasks defined inside it. The method for deleting a single Task from the Group has been discussed later. 7.11.4 Adding a Task To create a new Custom Task (or simply Task), right click on the Custom Tasks Group Node, select New and then select New Task. Tip: A Custom Tasks Group may consist of multiple Tasks. Any Task that is created gets added in the More Tasks/Actions drop-down of the Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 37

WOLF User Guide version 1.3 2009

7.11.5 Task Properties The Properties section allows you to define the objective of the Task.

Property

Description

Misc Task Name

Provide a name that highlights the Task’s objective. For example, a Task that performs the conversion of a lead into an opportunity may be named “Lead to Opportunity Conversion”.

Entity Link Linked Screen

Link the task to a screen in the Application. This means that when the Task button is clicked the relevant screen will open up. Defining this property, auto populates the Screen Name and Screen Type properties below.

Screen Name

A read-only property that displays the screen name.

Screen Type

A read-only property that identifies the type of screen. Such as Search, Edit Screen, Dashboard etc.

Behavior Popup URL

Opens a Popup on clicking the Task button. If a Business Rule is specified as well then the popup will only appear after the Business Rule has finished executing.

Invoke Rule

When the Task button is clicked the selected Business Rule will be invoked. The current Entity will be used as the context.

Disable when New

If checked then the Task will be disabled if the record selected is in the new mode (i.e. not previously saved). The Task will automatically get enabled for existing records.

Close When Done

If checked then the window will close if the Task has executed successfully without any errors.

7.11.6 Actions on a Task In addition to changing the properties of a Task, there are several actions possible on a Task. To view these actions, right click on the Task Node. The Save and Publish buttons enable you to Save/Publish changes made to a Task. © 2009 Wolf Platform as a Service All rights reserved.

Page 38

WOLF User Guide version 1.3 2009

Use the Delete button to delete the Task. The Move up and Move down buttons allow you to arrange the order in which the Tasks appear in the More Tasks/Actions drop-down of the Edit Screen. 7.11.7 Deleting a Task To delete a Task, right click on the Task Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Task. Caution: Deleting a Task removes it permanently from the Designer.

© 2009 Wolf Platform as a Service All rights reserved.

Page 39

WOLF User Guide version 1.3 2009

7.12 Working with Sections You can start adding Fields to your Entity in a Section. Sections are used for logical grouping of data/Fields inside a Tab. For example, in a Tab containing personal contact information, we may have one Section for the address and another Section for the phone numbers of the contact. When we create an Entity, the Default Edit Screen consisting of a single Tab and a Section defined inside the Tab is created automatically. However, when we create a Custom Edit Screen, we will need to create a Tab and a Section for the Tab. We can create as many Sections as required inside a Tab. Tip: You can start adding Fields to an Entity inside a Section.

7.12.1 Adding Sections To create a new Section for a Tab, right click on the Tab Node, select New and select New Section. You can then start adding Fields to the newly created Section. Note: Any Section that you create in a Tab does not have a name assigned to it. You can assign a name to the Section from the Properties. 7.12.2 Section Properties You can provide a meaningful name for your Section and specify its display behavior from the Properties section.

Property

Description

Misc Display Name

Header for the Edit section. This helps improve the readability when your Tab consists of multiple Sections.

Default Behavior Expanded

Should this Section show as Expanded or Collapsed when the form is opened in the Run Environment? This state can be changed through client rules.

Hidden

Should this Section be hidden when the form is opened in the Run Environment? This state can be changed through client rules.

© 2009 Wolf Platform as a Service All rights reserved.

Page 40

WOLF User Guide version 1.3 2009

7.12.3 Actions on a Section In addition to changing the Properties of a Section, there are several actions possible on a Section. To view these actions, right click on the Section Node. The Save and Publish buttons enable you to Save/Publish changes made to a Section. Clicking the New button will present a drop down list of the Fields that can be created inside a Section.

Use the Delete button to delete the current Section. The Move up and Move down buttons can be used to move the current Section up/down with respect to the other Sections present in the Tab. This enables us to arrange the order of the Sections appearing in the Tab. 7.12.4 Deleting a Section To delete a Section, right click on the Section Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Section. Caution: Deleting a Section also deletes all the Fields defined inside it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 41

WOLF User Guide version 1.3 2009

7.13 Working with Master/Details Section Note: Before reading this section, it is recommended that you review the section on Entity Relations. Please refer to section “7.21 Entity Relations”. The Master/Details Section enables the current Entity to access the Fields of an Entity which it holds a Relation with. For example, we have two Entities: Employee Entity and Leave Entity. In the Leave Entity, we establish a Relation with the Employee Entity. We can then access the Fields of the Leave Entity from the Master/Details Section of the Employee Entity. We can create as many Master/Details Sections as required inside a Tab. (Refer to section “7.21 Entity Relations”) It is important to note that the Master/Details Section can only contain the Fields of an Entity that it holds a Relation with and the Wolf System Fields. No new Fields can be created inside the Master/Details Section. Note: A Master/Details Section can only contain the Fields of an Entity that it holds a Relation with and the Wolf System Fields. 7.13.1 Adding Master/Details Sections To create a new Master/Details Section for a Tab, right click on the Tab Node, select New and then select New Master/Details Section. A popup appears listing the Entities the current Entity holds a Relation with. Select the Entity who’s Fields you need to access and then click then Open button in the popup. You can then start adding Fields to the newly created Master/Details Section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 42

WOLF User Guide version 1.3 2009 Note: You cannot create a Master/Details Section if the current Entity does not hold a Relation with other Entities of the Application.

7.13.2 Master/Details Section Properties You can provide a meaningful name for your Master/Details Section and specify its appearance and default behavior from the Properties section.

Property

Description

Misc Display Name

Header for this Master/Details section. This helps improve the readability when your Tab consists of multiple Sections.

Appearance Height(px)

Controls the height that the Master/Details Section occupies on the Edit Screen. If left unspecified the default is as follows: 1. When shared with other Sections on the Tab the height is 150px 2. When it’s the only Section in the Tab it occupies 100% of the height

Expanded

Should this Master/Details Section show as Expanded or Collapsed when the form is opened in the Run Environment? This state can be changed through client rules.

Hidden

Should this Master/Details Section be hidden when the form is opened in the Run Environment? This state can be changed through client rules.

Default Behavior Edit Screen

No Grid Lines Allow text to wrap Disallow add

This setting allows you to control which of the defined Edit Screens should be linked to the double click of this Master/Details Section. This also controls the details that are displayed in the read-only mode. If this value is left unspecified or cleared then the Default Edit Screen is used. If checked then the Master/Details section grid will not display lines separating the rows and columns. By default grid lines are always visible. If checked then the text which overflows its boundaries in each cell will wrap onto the next line. This could be quite useful when displaying data from a Long Text Field such as comments and notes. Disallow the user to add a record from the Child Object table.

© 2009 Wolf Platform as a Service All rights reserved.

Page 43

WOLF User Guide version 1.3 2009

Disallow edit

Disallow the user to edit a record from the Child Object table.

© 2009 Wolf Platform as a Service All rights reserved.

Page 44

WOLF User Guide version 1.3 2009

7.13.3 Actions on a Master/Details Section In addition to changing the Properties of a Master/Details Section, there are several actions possible on a Master/Details Section. To view these actions, right click on the Master/Details Section Node. The Save and Publish buttons enable you to Save/Publish changes made to a Master/Details Section. Clicking the New button will present a drop down list of the Fields that can be added inside the Master/Details Section.

Use the Delete button to delete the current Master/Details Section. The Move up and Move down buttons can be used to move the current Master/Details Section up/down with respect to the other Sections or Master/Details Sections present in the Tab. This enables us to arrange the order of the Sections appearing in the Tab. 7.13.4 Deleting a Master/Details Section To delete a Master/Details Section, right click on the Master/Details Section Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Master/Details Section. Caution: Deleting a Master/Details Section also deletes all the Fields present inside it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 45

WOLF User Guide version 1.3 2009

7.14 Working with Fields An Edit Screen is used for the visual representation of an Entity. The Edit Screen is a form consisting of Fields. A Field may be defined as an element that holds a particular data type and can have other attributes as well. When collected together, this forms an entire record of the Entity. For example, an Entity “Contact” may consist of the “Name”, “Age” and “Phone Number” Fields. Fields can be added in the Section or Master/Details Section of an Edit Screen by using the point and click user interface of the Designer. Wolf supports a large number of auto validated Field types. Note: 1. Fields can only be added in a Section or a Master/Details Section. 2. All Field Types are auto validated.

7.14.1 Field Types A Field can be added, customized and has an associated data type. More Field types will be added in the Designer to ease and enhance the Application Designing Process. The figure below shows the available Field Types in Wolf.

© 2009 Wolf Platform as a Service All rights reserved.

Page 46

WOLF User Guide version 1.3 2009

The following are the Field types in Wolf: 1. Yes/No Field – A Boolean field that holds a yes/no or 0/1 value. This Field is a checkbox which holds a ‘1’ or ‘yes’ value when checked and a ‘0’ or ‘no’ value when unchecked. For example, a checkbox named “Do Not Call” may be used to specify whether a person should be called or not. 2. Text Field – A Field that that holds textual data of shorter lengths. For example, a Field named “First Name” may be used to store a person’s first name. This Field type can be used to hold data that doesn’t fit into any other Field type. The Properties section allows you to convert this Field into a drop-down or automatically perform different validations on the data entered in the Field. 3. Long Text Field – Similar to a Text Field, this Field holds textual data of longer lengths and provides additional space for data entry. This Field is often used for comments or notes. The display height of this Field on the Edit Screen can be varied from the Properties section. For example, a Field named “Job Description” may be used to store the job description. 4. Document Reference Field – A Field that is automatically assigned a sequential number/alphanumeric every time a record is created for an Entity. The number/alphanumeric assigned succeeds the one assigned to the previous record of the Entity. If the previous record has a Document Reference Field with the value 1 automatically assigned to it, then the corresponding Field of the current record will be assigned the value 2. The Properties section allows you to choose the formula for this series. For example, a Field named “Employee No.” may be used to sequentially generate a unique number for every employee that is added. 5. Numeric Field – A Field that holds whole numbers only. For example, a Field named “No. of Employees” may be used to store the number of employees in an organization. 6. Decimal Field – A Field that holds decimal numbers. For example, a Field named “Weight” may be to store the weight of a fruit. 7. Date Field – A Field that holds a date. When a Date Field appears on the Edit Screen, it has a calendar button that allows you to select/pick a date by clicking on it. For example, a Field named “Date of Birth” may be used to store the date of birth. 8. Time Field – A Field that holds the time. For example, a Field named “Closing Time” may be used to specify the closing time of a school. 9. Label Field – A Field that displays a read-only message on the Edit Screen. It may be used for giving special instructions to the User. For example, a Label Field may be used to indicate the meaning of a Field on the Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 47

WOLF User Guide version 1.3 2009

7.14.2 System Fields In addition to the Field Types discussed above, you can also add System Fields to an Application. System Fields contain specific information about an Entity record and come preconfigured with a data type. However, you can change the display properties of these Fields from the Properties section. For example, “Created On” is a System Field that stores the timestamp of when the current record of the Entity was created. System Fields give an indication of the usage of an Application, its Entities and the Entity data. It is important to note that the System Fields can only be added in the Master/Details Section of an Edit Screen. The figure below shows the different System Fields available in Wolf.

Note: System Fields can only be added in the Master/Details Section of the Edit Screen.

The following are the System Fields in Wolf: 1. Created On: This Field stores the timestamp of when the current record of the Entity was first created. 2. Last Changed On: This Field stores the timestamp of when the current record of the Entity was last modified. 3. Status ID: The Status ID controls the view ability and changeability of an Entity record. The following are possible values for the Status ID: a. “C” - Indicates that the Entity record has been closed for further edit. None of the Wolf User interfaces will allow you to change the record, irrespective of the User access privileges you © 2009 Wolf Platform as a Service All rights reserved.

Page 48

WOLF User Guide version 1.3 2009

have. Using the Business Rules, however, you can continue to change the record and reopen it for editing. b. “O” – Indicates that the Entity record is open. It is the default stamp for any record. This does not give the record any special privileges whatsoever. c. “D” – This marks the Entity record for deletion. Once deleted the record cannot be viewed. Deleted records are only archived for audit purposes required by certain Applications. At this point special help will be required to view these deleted records.

4. Created By: This Field stores the username of the User who created the current record of the Entity. 5. Created By User ID: This Field stores the User ID of the User who created the current record of the Entity. 6. Last Changed By: This Field stores the username of the User who last modified the current record of the Entity. 7. Last Changed By User ID: This Field stores the User ID of the User who last modified the current record of the Entity. 8. Folder: This Field stores the name of the Folder in which the Entity data is stored. 9. Folder ID: This Field stores the Folder ID in which the Entity data is stored.

© 2009 Wolf Platform as a Service All rights reserved.

Page 49

WOLF User Guide version 1.3 2009

7.14.3.1 Adding Fields to an Entity You can start adding Fields to an Entity in a Section or a Master/Details Section of the Edit Screen. There are certain rules & restrictions when it comes to adding Fields to a Section or a Master/Details Section of an Edit Screen. We will consider them individually in turn. Adding Fields to a Section a. For a Section of the Default Edit Screen You can add, create or delete any Field Type in a Section of the Default Edit Screen. However, you cannot add System Fields in this Section. To create a new Field in your Section, right click on the Section Node, select New and then select the Field Type.

Note: System Fields cannot be added in a Section of the Default Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 50

WOLF User Guide version 1.3 2009

b. For a Section of the Custom Edit Screen When an Entity consists of multiple Edit Screens then the Default Edit Screen acts as the master repository of Fields and the Custom Edit Screens can only use the Fields defined in the Default Edit Screen. In addition to this, you can add a Label Field in a Section of the Custom Edit Screen. System Fields cannot be added in a Section of the Custom Edit Screen. To add a Field in your Section, right click on the Section Node, select New and then select the Field.

As we can see from the figure above, the Custom Edit Screen can only use the Fields defined in the Default Edit Screen and a Label Field. Note: In addition to using the Fields defined in the Default Edit Screen, you can only create a Label Field in the Section of a Custom Edit Screen. System Fields cannot be added in a Section of the Custom Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 51

WOLF User Guide version 1.3 2009

7.14.3.2 Adding Fields to a Master/Details Section The rules for adding Fields to a Master/Details Section of a Default Edit Screen and a Custom Edit Screen are the same. The Master/Details Section can only contain the Fields of an Entity that it holds a Relation with and the Wolf System Fields. No new Fields can be created inside the Master/Details Section. To add a Field in your Master/Details Section, right click on the Master/Details Section Node, select New and then select the Field.

Note: You cannot create any new Fields inside a Master/Details Section of an Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 52

WOLF User Guide version 1.3 2009

7.14.4 Field Properties 7.14.4.1 For the different Field Types Every Field type has different Properties associated with it depending on its type. The following table lists a set of common Properties for the different Field types. If the Property exists for the Field type, then it is marked with a “Y” in the table. In addition to these Properties, the unique Properties of each Field type have been discussed in the subsequent sections. Property

Yes/No

Text

Long Text

Document Numeric Decimal Date Reference

Time

Label

Misc Display Name

Y

Y

Y

Y

Y

Y

Y

Y

Prompt

Y

Y

Y

Y

Y

Y

Y

Y

Description

Y

Y

Y

Y

Y

Y

Y

Y

Read-only

Y

Y

Y

Y

Y

Y

Y

Y

Hidden

Y

Y

Y

Y

Y

Y

Y

Y

Hide in Quick View

Y

Y

Y

Y

Y

Y

Y

Required

Y

Y

Y

Y

Default Value

Y

Y

Y

Behavior

Y

Y

Y

Y

Y

Y

Dynamic List Store this value

Y

Y

Y

Y

Y

Display this value

Y

Y

Y

Y

Y

© 2009 Wolf Platform as a Service All rights reserved.

Page 53

WOLF User Guide version 1.3 2009

Property Definitions

Property

Description

Misc Display Name (*)

Provide a meaningful name to the Field. You will use this name every time you refer to this Field as a part of the Entity. For example, while using Business Rules or accessing the Field in a Master/Details Section.

Prompt

Display prompt for the Field.

Description

Provide a brief description of the Field. The Description provided here will be used in the auto generated documentation and also allows other individuals using the Designer to understand its functionality/purpose.

Behavior Read-only

If checked then the Field will appear as read-only on the Edit Screen in the Run Environment.

Hidden

If checked then the Field will be hidden on the Edit Screen in the Run Environment.

Hide in Quick View

If checked then the Field will be hidden in the Quick View in the Run Environment. This should be used when the field is never expected to be displayed to the User. For example, Fields like internal statuses, settings, etc.

Required

If checked then the Field is a mandatory Field for the record and the form cannot be saved until this Field has a value. It acts as a required field validation.

Default Value

A default value for the Field in the Run Environment.

Dynamic List Store this value

If checked then the value of this Field will be used in the [value field] while dynamically generating a combo for this Entity. This section of Properties should be used only when the Entity is expected to be treated as a source for combos. Any other fields in this Entity where the property is checked will automatically be reset.

Display this

If checked then the value of this Field will be used is the [displayed value]

© 2009 Wolf Platform as a Service All rights reserved.

Page 54

WOLF User Guide version 1.3 2009

while dynamically generating a combo for this Entity. This section of Properties should be used only when the Entity is expected to be treated as a source for combos. Any other fields in this Entity where the property is checked will automatically be reset.

value

Unique Properties for the Field Types 1. Yes/No Field Property

Description

Behavior Default checked?

If checked then the Field (checkbox) will appear as checked by default in the Run Environment.

2. Text Field Property

Description

Behavior Max Length

Specify the maximum length of the Text Field. This property can be used to increase or decrease the length of input in the Field.

Min Length

Specify the minimum required length of input in the Text Field.

Selectable? Selectable From

This property is used for making a Field into a combo or drop-down. Get the source of this Field from another Entity. The data from the other Entity is used to populate the drop-down values.

Multi Select

If checked then the Field will appear as a multi select drop-down. If left unchecked then the Field appears as a regular drop-down. This property is dependent on the Selectable From property for the drop-down values.

Populate from

Auto populates this field while making a selection.

Refresh on

This is useful when the combo is linked to a data source but its values need

© 2009 Wolf Platform as a Service All rights reserved.

Page 55

WOLF User Guide version 1.3 2009

change of

to be filtered based on the values of other Fields on the page.

3. Long Text Field Property

Description

Behavior Max Length

Specify the maximum length of the Long Text Field. This property can be used to increase or decrease the length of input in the Field.

Validation (char mask)

Validations performed while expecting input into the Long Text Field. You can perform one of the following validations on the input text: 1. Alpha-Numeric 2. Email format 3. IP Address 4. No Validation 5. Only Alphabets

Display Height (px)

Display height of the Long Text Field on the Edit Screen in pixels. If left unspecified the default is 55 px.

Indexing Full text index

Check if the property should be part of a full text index.

© 2009 Wolf Platform as a Service All rights reserved.

Page 56

WOLF User Guide version 1.3 2009

4. Document Reference Field Property

Description

Misc Docref. Formula

A document reference formula. You can apply one of the following formulas on the Document Reference Field: Auto increment value with 1 as the incremental factor

variant1 & 1

format(variant1 & 1,"00000") Concatenate the formatted value with prefix. "ID" "ID" + format(variant1 & can be replaced with any alphanumeric value 1,"00000") Concatenate the formatted value with suffix. "ID" format(variant1 & can be replaced with any alphanumeric value 1,"00000") + "ID" Note: “variant1” represents the last incremented value Format the auto increment value

5. Numeric Field Property

Description

Behavior Maximum

Specify the maximum length of the Numeric Field. This property can be used to increase or decrease the length of input in the Field.

Minimum

Specify the minimum required length of input in the Numeric Field.

6. Decimal Field Property

Description

Behavior Maximum

Specify the maximum length of the Decimal Field. This property can be used to increase or decrease the length of input in the Field.

© 2009 Wolf Platform as a Service All rights reserved.

Page 57

WOLF User Guide version 1.3 2009

Minimum

Specify the minimum required length of input in the Decimal Field.

Auto Populate Populate from

Auto populates this field while making a selection.

7. Date Field Property

Description

Behavior Default

Specify the Default value for the Date Field Current Date can also be specified as default.

8. Time Field Property

Description

Selectable? Populate from

Auto populates this field while making a selection.

© 2009 Wolf Platform as a Service All rights reserved.

Page 58

WOLF User Guide version 1.3 2009

7.14.4.2 For the System Fields System Fields contain specific information about an Entity record and come preconfigured with a data type. However, you can change the display properties of these Fields from the Properties section. We will first consider the properties of the Created on & Last Changed on System Fields. Both these Fields hold a Date and have similar properties. Field Name(s): Created On, Last Changed On Field Type: Date Property

Description

Display Display Name(*)

Both Fields contain a default name. For example, the Created On Field has a Display Name of “Created On”. However, you can change the default name to provide a name of your choice. It is mandatory to specify a name for a System Field.

Display Width (px)

The Display Width of the Field in pixels. The field occupies the given horizontal width on the Edit Screen.

Sorting Sorting Order

A sorting order for the Fields. The Sorting Order and Sort Direction work as follows: Field1 has Sorting Order="0" and Sort Direction = "Ascending" Field2 has Sorting Order="1" and Sort Direction = "Descending" Then the Fields will be displayed as: Field1 ascending, Field2 descending

Sort Direction

The default sort direction for the Results table. Make sure that you have specified the sorting order otherwise this setting will be ignored.

Behavior Read-only

If checked then the Field will appear as read-only on the Edit Screen in the Run Environment.

© 2009 Wolf Platform as a Service All rights reserved.

Page 59

WOLF User Guide version 1.3 2009

Hidden

If checked then the Field will be hidden on the Edit Screen in the Run Environment.

Next we will consider the properties of other System Fields. These Fields hold textual information and have similar properties. Field Name(s): Status ID, Created By, Created By Used ID, Last Changed By, Last Changed By User ID, Folder, Folder ID, Self Relation Level, Parent Relation UID Field Type: Text Property

Description

Display Display Name(*)

All the Fields contain a default name. For example, the Status ID Field has a Display Name of “Status ID”. However, you can change the default name to provide a name of your choice. It is mandatory to specify a name for a System Field.

Display Width (px)

The Display Width of the Field in pixels. The field occupies the given horizontal width on the Edit Screen.

Sorting Sorting Order

A sorting order for the Fields. The Sorting Order and Sort Direction work as follows: Field1 has Sorting Order="0" and Sort Direction = "Ascending" Field2 has Sorting Order="1" and Sort Direction = "Descending" Then the Fields will be displayed as: Field1 ascending, Field2 descending

Sort Direction

The default sort direction for the results table. Make sure that you have specified the sorting order otherwise this setting will be ignored.

Behavior Read-only

If checked then the Field will appear as read-only on the Edit Screen in the Run Environment.

© 2009 Wolf Platform as a Service All rights reserved.

Page 60

WOLF User Guide version 1.3 2009

Hidden

If checked then the Field will be hidden on the Edit Screen in the Run Environment.

Hide in Quick View

If checked then the Field will be hidden in the Quick View in the Run Environment. This should be used when the Field is never expected to be displayed to the User. For example, Fields like internal statuses, settings, etc.

Selectable? Selectable From

This property is used for making a Field into a combo or drop-down. Get the source of this Field from another Entity. The data from the other Entity is used to populate the drop-down values.

Populate from

Auto populates this field while making a selection.

Refresh on change of

This is useful when the combo is linked to a data source but its values need to be filtered based on the values of other Fields on the page.

7.14.5 Actions on a Field In addition to changing the Properties of a Field, there are several actions possible on a Field. It is important to note that, the actions on a Field are similar irrespective of the Field Type and where it is defined. For example, a System Field in a Master/Details Section has similar properties as that of a Date Field defined in the Section of a Custom Edit Screen. The Save and Publish buttons enable you to Save/Publish changes made to a Field. Use the Delete button to delete the current Field. The Move up and Move down buttons can be used to move the current Field up/down with respect to the other Fields present in the Section or Master/Details Section. This enables us to arrange the order of the Fields appearing in the Section or Master/Details Section.

Note: In general, the term Field applies to any Field irrespective of the Field Type and where it is defined. Differences between the various Field Types have already been pointed out in the previous sections and any specific difference that arises will be highlighted.

© 2009 Wolf Platform as a Service All rights reserved.

Page 61

WOLF User Guide version 1.3 2009

7.14.6 Deleting a Field To delete a Field, right click on the Field Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Field. Caution: Deleting a Field removes it permanently from your Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 62

WOLF User Guide version 1.3 2009

7.15 Working with Search Screens Search Screens or Search Templates allow listing as well as filtering of the records of an Entity. Search Screens allow inline and mouse operations for editing Entity data. However, Search Screens can also be configured for representation of data in different formats such as Dashboard Widgets.

The figure shows how a complete Search Screen will appear to a User in the Run Environment. It is important to note that a Search Screen need not necessarily consist of all the components shown in the figure. For example, the simplest Search Screen may consist only of a Results Table.

7.16 Overview of Search Screens As compared to the Edit Screen, the Search Screen is not created automatically every time we create an Entity and needs to be created for an Entity. Once a Search Screen is created you can start defining its Properties and defining the layout of the Search Screen. An important point to remember is that an Entity can consist of any number of Search Screens as required. The Properties of a Search Screen may be configured to represent data in various formats such as a simple Search Screen, Reports, Dashboard Widgets, etc. No new Fields can be created inside a Search Screen and it can only use the Fields defined inside the Default Edit Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 63

WOLF User Guide version 1.3 2009

Note: 1. It is mandatory to specify a name for a Search Screen. 2. Any number of Search Screens can be created for an Entity. 3. The Search Screen can only use the Fields defined inside the Default Edit Screen.

7.16.1 Creating a Search Screen To create a Search Screen for your Entity, right click on the Search Node, select New and then select New Search Screen. You can then start working with the newly created Search Screen.

Creating a Search Screen automatically creates a Criteria section and a Results Table for the Search Screen. You can view these by expanding the Node of the newly created Search Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 64

WOLF User Guide version 1.3 2009

7.16.2 Search Screen Properties The Properties of a Search Screen play a crucial role in deciding the structure, layout and functionality of the Search Screen.

Property

Description

Misc Template Name (*)

A meaningful name for the Search Screen. This is mandatory since there can be any number of Search Screens in an Entity.

Data Business Rule

Get the results of the search by performing Actions specified in a Business Rule. The Business Rule is used for filtering the records appearing in the Results Table. Leave this property blank to perform a standard search on the Entity.

Show/Hide… Hide Quick View

If checked then Quick View will not appear when a record is selected from the Results Table. The Quick View presents a non-editable preview of the Entity data when an item is selected in the Results Table. In general, the Quick View should be used only if the Entity contains information that cannot be accommodated into the columns of Results Table.

Hide [New]

If checked, the New tool is hidden in the Search Screen Toolbar. The New tool when clicked opens the linked Edit Screen, allowing you to create a new record for the Entity.

Hide [Open]

If checked, the Open tool is hidden in the Search Screen Toolbar. The Open tool when clicked opens the currently selected record for editing.

Hide [Delete]

If checked, the Delete tool is hidden in the Search Screen Toolbar. The Delete tool when clicked deletes the currently selected record.

Toolbar Behavior Edit Screen

This setting allows you to control which of the defined Edit Screens should be linked to the New and Open Tools that appear in the toolbar. This also controls the details that are displayed in the Quick View section of the current Search Template If this value is left unspecified or cleared then the default Edit Screen is used.

© 2009 Wolf Platform as a Service All rights reserved.

Page 65

WOLF User Guide version 1.3 2009

Results Table Behavior Auto Load Results

If checked then the Results Table will fetch data automatically whenever the page is loaded.

No Grid Lines

If checked then the Results Table grid will not display lines separating the rows and columns of the Results Table. By default grid lines are always visible.

Allow text to wrap

If checked then the text which overflows its boundaries in each cell will wrap onto the next line. This could be quite useful when displaying data from a Long Text Field such as comments and notes.

Disallow add

If checked then the User cannot add an Entity record through the Results Table itself. This will only work if the Search does not point to a Business Rule in addition to his security privileges.

Disallow edit

If checked then the User cannot edit an Entity record through the Results table itself. This will only work if the Search does not point to a Business Rule in addition to his security privileges.

Technical Show Levels

Show Numbering

The Results Table is capable of showing grouped information. If checked then this will be set to true if every record of the results data source has a <level> element. The Results Table shows a numbering in the first column by default. If unchecked this numbering will not be displayed.

© 2009 Wolf Platform as a Service All rights reserved.

Page 66

WOLF User Guide version 1.3 2009

7.16.3 Actions on a Search Screen In addition to changing the properties of a Search Screen, there are several actions possible on a Search Screen. To view these actions, right click on the Search Screen Node. The Save and Publish buttons enable you to Save/Publish changes made to a Search Screen. Click the Delete button to delete the current Search Screen.

7.16.4 Deleting a Search Screen To delete a Search Screen, right click on the Search Screen Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Search Screen. Caution: Deleting a Search Screen also deletes the Criteria section and the Results Table of the Search Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 67

WOLF User Guide version 1.3 2009

7.17 Search Screen Preview To get a preview of a Search Screen, click on the Search Screen Node in the Solution Explorer. The Designer automatically generates a preview of the Search Screen showing its structure and the Fields inside the Criteria section and the Results Table.

To refresh the Search Screen preview, right click on the preview window and choose Refresh.

Tip: The preview is an indication of how your Search Screen will look in the Run Environment.

© 2009 Wolf Platform as a Service All rights reserved.

Page 68

WOLF User Guide version 1.3 2009

7.18 Working with the Criteria section of the Search Screen The Criteria section allows you to choose the Fields of an Entity which you wish to use as criteria for filtering records in Search Screens. The results of this filtering appear in the Results Table. For example, for a Contact Entity, we may choose the First Name and the Last Name Fields as Search Criteria. The Criteria section is created automatically every time a Search Screen is created. However, the Criteria section does not display in the Search Screen till we add Criteria Fields to it. As the Search Screens are essentially a part of an Entity, only the Fields already defined in the Edit Screen and System Fields can be used as search criteria. Note: To include a field as a Search Criteria it must already be defined in the Edit Screen of the Entity. 7.18.1 Adding Criteria Fields To add a new criteria Field, right click on the Criteria Node, select New and then choose the appropriate Field.

© 2009 Wolf Platform as a Service All rights reserved.

Page 69

WOLF User Guide version 1.3 2009

As we can see from the figure above, only the Fields defined in the Edit Screen and the System Fields may be used as search criteria. 7.18.2 Criteria Field Properties The display attributes of a Criteria Field can be changed from the Properties section. Each Field Type or System Field has different Properties depending on its type. It is important to note that the Properties of a Criteria Field can only vary its display attributes; the behavior of the Field is inherited from the corresponding Field in the Edit Screen and cannot be varied. Please refer to the section “7.14.4 Field Properties” for a full understanding of Field Properties. 7.18.3 Actions on a Criteria Field In addition to changing the properties of a Criteria Field from the Properties section, there are several actions possible on a Criteria Field. To view these actions, right click on the Field Node. The Save and Publish buttons enable you to Save/Publish changes made to a Criteria Field. Use the Delete button to delete the current Field. The Move up and Move down buttons can be used to move the current Field up/down with respect to the other Fields present in the Search Screen Criteria. This enables us to arrange the order of the Fields appearing in the Criteria section. 7.18.4 Deleting a Criteria Field To delete a Field from the Criteria section, right click on the Field Node and select Delete. A popup appears asking for your confirmation. Choose Yes to delete the Criteria Field. Deleting a Criteria Field does not delete the corresponding Field from the Edit Screen. However, any changes made to the Criteria Field properties are lost on deletion. Tip: A Field that has been deleted from the Criteria section can be added again.

© 2009 Wolf Platform as a Service All rights reserved.

Page 70

WOLF User Guide version 1.3 2009

7.19 Working with the Results section of the Search Screen The Results section allows you to choose the Fields of an Entity which appears in the Results Table of a Search Screen. The Results table lists the records of an Entity and in case a Search criterion is applied, it lists the records satisfying the criteria. The Search Screen toolbar contains several tools that allow you work with the records in the Results Table. Also, if the Quick View is enabled, the details of the currently selected record will be displayed in the Results Table. The Results section is created automatically every time a Search Screen is created. However, we will need to choose the Fields on an Entity which we wish to display in the Results Table. As the Search Screens are essentially a part of an Entity, only the Fields already defined in the Edit Screen and System Fields can be used in the Results Table. Note: To include a Field in the Results Table it must already be defined in the Edit Screen of the Entity.

7.19.1 Adding Results Table Fields To add a Field to the Results Table, right click on the Results Node, select New and then choose the appropriate Field.

© 2009 Wolf Platform as a Service All rights reserved.

Page 71

WOLF User Guide version 1.3 2009

As we can see from the figure above, only the Fields defined in the Edit Screen and the System Fields may be used in the Results Table. 7.19.2 Results Table Field Properties The display attributes of a Results Table Field can be changed from the Properties section. Each Field Type or System Field has different Properties depending on its type. It is important to note that the Properties of a Results Table Field can only vary its display attributes; the behavior of the Field is inherited from the corresponding Field in the Edit Screen and cannot be varied. Please refer to the section “7.14.4 Field Properties” for a full understanding of Field Properties. The “Use Image Map” property of a Results Table Field: This is a unique property for the Results Table Fields which allows us to link the entire Results Table column to an image map. This will cause an image to display based on different values instead of the standard text display.

7.19.3 Actions on a Results Table Field In addition to changing the properties of a Results Table Field from the Properties section, there are several actions possible on a Results Table Field. To view these actions, right click on the Field Node. The Save and Publish buttons enable you to Save/Publish changes made to a Results Table Field. Use the Delete button to delete the current Field. The Move up and Move down buttons can be used to move the current Field up/down with respect to the other Fields present in the Results Table. This enables us to arrange the order of the Fields appearing in the Results Table. 7.19.4 Deleting a Results Table Field To delete a Field from the Results Table, right click on the Field Node and select Delete. A popup appears asking for your confirmation. Choose Yes to delete the Results Table Field. Deleting a Results Table Field does not delete the corresponding Field from the Edit Screen. However, any changes made to the Results Table Field properties are lost on deletion. Tip: A Field that has been deleted from the Results Table can be added again.

© 2009 Wolf Platform as a Service All rights reserved.

Page 72

WOLF User Guide version 1.3 2009

7.20 Quick View in the Search Screen The Quick View presents a non-editable preview of the Entity data when an item is selected in the Results Table. The details displayed in the Quick View depend on the Edit Screen linked to the Search Template. In general, the Quick View should be used only if the Entity contains information that cannot be accommodated into the columns of the Results Table. By default, the Quick View for a Search Screen is enabled. The figure above shows how the Quick View will appear in the Run Environment.

The Quick View can be enabled/disabled from the Properties of a Search Screen You can disable the Quick View from the Properties of a Search Screen by checking the Hide Quick View checkbox.

© 2009 Wolf Platform as a Service All rights reserved.

Page 73

WOLF User Guide version 1.3 2009

7.21 Entity Relations Establishing a relationship between Entities allows you to derive the data/Fields defined in one Entity for use in the other Entity. Wolf enables you to establish different types of references between Entities. Relations are one example of this. Note: Relations can only be established between existing Entities.

7.21.1 Creating a Relation between Entities While creating a Relation between two Entities, one Entity will behave as the Master Entity and the other as the Child Entity. The Master Entity will access the data/Fields of the Child Entity. For example, we want to access the data/Fields of a Leave Details Entity in an Employee Entity. In simple words, we want to keep track of the leave data of an employee. The Employee Entity becomes the Master and the Leave Details Entity becomes the Child. In the Leave Details Entity, we establish a Relation with the Employee Entity. This enables the Employee Entity to access the Fields/data of the Leave Details Entity. However, the Leave Details Entity will not have a similar access to the Fields of Employee Entity. To create a Relation between the Entities, open the Child Entity; right click on the Relation Node, select New and then select the Master Entity, i.e., the Entity you want to establish a Relation with.

© 2009 Wolf Platform as a Service All rights reserved.

Page 74

WOLF User Guide version 1.3 2009

Once a Relation is established we can access the Fields of the Leave Details Entity from a Master/Details Section in the Employee Entity. Note: The Master Entity under the Relations Node in the Child Entity is known as a Relation Entity. Please refer to the section “7.13 Working with Master/Details Section”. 1. The Relation needs to be established in the Child Entity. 2. The Child Entity will not have access to the data/Fields of the Master Entity. 3. You can establish as many Relations as required between Entities.

7.21.2 Actions on a Relation Entity There are several actions possible on a Relations Entity. To view these actions, right click on the Relation Entity Node. The Save and Publish buttons enable you to Save/Publish any changes made to a Relation. Use the Delete button to delete the current Relation. The Move up and Move down buttons can be used to move the current Relation Entity up/down with respect to the other Relation Entities.

© 2009 Wolf Platform as a Service All rights reserved.

Page 75

WOLF User Guide version 1.3 2009

7.21.3 Deleting a Relation To delete a Relation, right click on the Relation Entity Node and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Relation. Deleting a Relation Entity does not delete the corresponding Master Entity from the Application. However, the Master Entity will no longer be able to access the data/Fields of the Child Entity. If required, the Relation can be re-established at a later stage.

Caution: Deleting a Relation means that the Master Entity will be unable to access the data/Fields of the Child Entity until the Relation is re-established.

© 2009 Wolf Platform as a Service All rights reserved.

Page 76

WOLF User Guide version 1.3 2009

7.22 Creating a Drop Down Field in an Entity Please refer to earlier sections of Working with Entities for a detailed understanding of how to accomplish the tasks mentioned in this section. As already mentioned, a Text Field can be used for holding data that doesn’t fit into any other Field type. The “Selectable From” property is used for making a Text Field into a combo or drop-down. This property sets the data source of the Field as another Entity. The data from the other Entity is then used to populate the drop-down Field’s values. For example, the “Contact” Entity consists of three Fields: Title, Name and Age and we want to make the “Title” Field a drop-down list.

Step 1: The first step is to create an Entity called “Title Drop Down” that will act as the data source for the “Title” Field. We will create a single Text Field named “Title Name” in a Section of the Default Edit Screen of this Entity. The Entity structure is as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 77

WOLF User Guide version 1.3 2009

Step 2: Click on the “Title Name” Field of the “Title Drop Down” Entity in the Solution Explorer to view its properties. Check the “Store this value” and “Display this value” properties under the “Dynamic List” section.

Step 3: Create a Search Template called “Title Search” in the “Title Drop Down” Entity. The purpose of this Search Screen is to allow a User to view/add/modify/delete data from the “Title Drop Down” Entity. Add the “Title Name” Field in the Results section of this Search Screen.

Tip: As the “Title Search” contains only a single Field inside it, we can hide the Quick View of the Search Screen from its properties.

© 2009 Wolf Platform as a Service All rights reserved.

Page 78

WOLF User Guide version 1.3 2009

Step 4: The next step is to set the “Title Drop Down” Entity as the data source of the “Title” Field of the “Contact” Entity. Click on the “Title” Field of the “Contact” Entity in the Solution Explorer to view its properties. Go to the “Selectable?” section of the properties and click on the “Selectable from” property. Press F2 to edit the property and click the ellipsis button to make a selection. A popup appears allowing you to choose the type of linkage you wish to create. Step 5: In the popup, expand the “Selection from generated combos” Node, click on the “Title Drop Down” Entity and then click on the Open button.

© 2009 Wolf Platform as a Service All rights reserved.

Page 79

WOLF User Guide version 1.3 2009

Step 6: Press Enter to finalize these changes. Press Publish. The “Title” Field of the “Contact” Entity is now a drop-down Field with the “Title Drop Down” Entity as the data source. Step 7: Click on the “Title” Field of the “Contact” Entity in the Solution Explorer to view its properties. Check the “Store this value” and “Display this value” properties under the “Dynamic List” section. Caution: It is important to note that the “Title” Field of the “Contact” Entity will be an empty drop-down until data is populated in the “Title Drop Down” Entity. Also, any data added/modified/deleted from the “Title Drop Down” Entity will have a corresponding effect on the values of the “Title” drop-down.

Note: The screens of the “Contact” Entity and the “Title Drop Down” Entity need to be linked to Navigation Items. The Navigation Items will allow a User (with the appropriate access privileges) to access these screens and view/add/modify/delete data from their Entities in the Run environment. For example, the “Title Search” will need to be linked to a Navigation Item to allow a User to view/add/modify/delete data from the “Title Drop Down” Entity in the Run environment. Navigation Items have been discussed in the section “8. Working with Navigation Items”.

© 2009 Wolf Platform as a Service All rights reserved.

Page 80

WOLF User Guide version 1.3 2009

8. Working with Navigation Items 8.1 Navigation Items Overview Design your business system navigation with the help of Navigation Items. The Wolf Navigation Designer is a Wolf Designer Control that assists you to create, modify and delete the Navigation Items of your Application. Navigation Items or Menus are access points to different areas of an Application or external web pages. For Example: To access an Entity form (Edit Screen) you much create a Navigation Item and link it to the Edit Screen. Navigation Items can be configured to link different elements of your Application such as Search Templates, Dashboard Widgets, Charts, Edit Screens and Reports accessible in the Run Environment of the Application. Note: To access any screen of an Application in the Run Environment it must have a Navigation Item linked to it. 8.2 Adding a new Navigation Item There are several ways of creating a new Navigation Item in an Application. From the Designer Home You can create a new Menu by clicking on the New Navigation Item button in the Designer Home.

From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Navigation Item.

From the Solution Explorer Right click on the Application Node, select New and then select New Navigation Item.

© 2009 Wolf Platform as a Service All rights reserved.

Page 81

WOLF User Guide version 1.3 2009

The Navigation item consists of only a single non-expandable node in the Solution Explorer. The Properties section of the Navigation item allows you to completely define the structure and functionality of the Navigation Item.

8.3 Navigation Item Properties The Properties of a Navigation Item have been divided into different sections with each section allowing you to configure a part of its functionality.

We will consider each section individually in turn. Note: 1. The Name and the Category are mandatory properties for a Navigation Item. 2.

Every Navigation Item must have a unique Name. Duplicate Menu Names are not allowed in Wolf.

3. Changes made to a Navigation Item’s Properties will reflect only in Run Environment.

© 2009 Wolf Platform as a Service All rights reserved.

Page 82

WOLF User Guide version 1.3 2009

8.3.1 Misc Section This section allows you to define the basic properties of a Navigation Item. The Name and the Category are mandatory properties.

Property

Description

Misc Name (*)

Provide a meaningful name to the Navigation Item. You will use this name every time you refer to this Navigation Item. For example, giving Roles/Users access to the Navigation Item.

Category (*)

The categorization helps you to organize your Navigation Items. For example, in a CRM Application all the Menus related to an account may be assigned an “Account” category. You can choose the category from a drop-down box listing all the categories of the Application.

Open in popup

If left unchecked, the Menu will open up as a Tab in the Run Environment. If checked then the Menu will open up as a popup window in the Run Environment. It is useful to open the Menu in a popup when it is linked to an Edit Screen.

Note: While assigning your Entity to a Category, it is important to remember that only the “General” Category is available by default. Other categories, if required, need to be created before they can be used. Please refer to section “11.Working with Categories” for more information. 8.3.2 Entity Link This section of the Properties is used to link the Navigation Item to different screens of an Application such as a Search Screen, Edit Screen, Report, etc. The Screen Name and Screen Type are read only properties and are auto populated based on the Linked Screen property.

Property

Description

Entity Link Linked Screen

Link the Navigation Item to a screen in an Application.

Screen Name

The screen name. This will be automatically populated when you link the Navigation to a screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 83

WOLF User Guide version 1.3 2009

Screen Type

A read only property that helps you identify the type of screen the Menu is linked to. For example Report, Search Screen, Dashboard, etc.

8.3.2.1 How to link your Navigation Item to a Search Screen of your Application? Let’s consider, we want to link a Navigation Item to a Search Screen of an Entity. Step 1: Create a new Navigation Item for the Application. Click on the Navigation Item Node in the Solution Explorer to view its properties from the Properties section. Step 2: The first step is to provide a meaningful name for your Navigation Item and assign it to an appropriate Category. Let’s name the Navigation Item “Demo Navigation” and assign it to the “General” Category. Press Publish. Step 3: The next step is to link this Menu to the Search Screen. Visit the Entity Link section of the Navigation Item’s Properties. Click on the Linked Screen property and press F2 to edit the property.

© 2009 Wolf Platform as a Service All rights reserved.

Page 84

WOLF User Guide version 1.3 2009

Step 4: Click the ellipsis button. A popup appears listing all the screens of your Application. Our requirement is to link the Navigation Item to the Demo Search Screen of the Demo Entity. In the popup, expanding the Entity Node shows a list of the screen types available for the Entity. Expand the Search Screens Node to see the list of Search Screens in the Demo Entity. Click on the Demo Search Node and then click on the Open button.

Step 5: Selecting the Linked Screen property auto generates the Screen Name and Screen Type. Press Enter to finalize these changes. Press Publish. We have successfully linked the Navigation Item to the Demo Search Screen of the Demo Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 85

WOLF User Guide version 1.3 2009

8.3.3 Other Link This section of the Properties is used for linking the Navigation Item to external web pages or to an externally controlled widget.

Property

Description

Other Link Externally Controlled Widget

This is a widget that can be controlled by you. The widget will be written using the document.write(<script href="....">) JavaScript command. You can have the script file residing on your servers or point to one of our existing widgets. For a complete list of available widgets please visit our website. The following is a ready table to use for different functionalities http://demo.wolfframeworks.com/ewidgets/ drawImage.js?imageurl=IMAGEURL http://demo.wolfframeworks.com/ewidgets/ Draw Frame from external URL drawFrame.js?framesrc=IFRAMESOURCE http://demo.wolfframeworks.com/ewidgets/ Include Splash Page Style Sheet from URL drawCSS.js?cssurl=CSSURL Link the Navigation Item to files in the system other than the Application screens. Can be used for linking the Navigation Item to files on a server or external web pages. Load Image from external URL

Link

8.3.4 Dashboard Settings This section of the Properties is used for controlling the layout and the styling of the dashboard section of the Splash Screen. Please refer to section “14. Working with Dashboard Widgets”.

Property

Description

Dashboard Settings Image

Displays an image in the Dashboard section of the Splash Screen. This setting will be ignored if the Screen Type is not a Dashboard.

Style

A specific HTML styling that you wish to give to the Dashboard.

© 2009 Wolf Platform as a Service All rights reserved.

Page 86

WOLF User Guide version 1.3 2009

8.3.5 Splash Screen This section of the Properties is used for displaying the Navigation Item on the Splash Screen in the Run Environment.

Property

Description

Splash Screen Image

Displays an image linked with the Navigation Item in the Splash Screen.

Text

The text to be displayed along with the Navigation Item in the Splash Screen. If this Property is left unspecified, the Navigation Item will not be displayed on the Splash Screen.

8.3.6 Where does the Navigation Item appear in the Run Environment? The Properties of a Navigation Item allow you to control where it will appear in the Run Environment. It is important to note that the Entity Link and the Other Link section of the Properties only control which screen/external webpage the Navigation Item is linked to and we will assume that the link has been specified for all the cases below. Case 1: Navigation Item with the Name and Category specified.

© 2009 Wolf Platform as a Service All rights reserved.

Page 87

WOLF User Guide version 1.3 2009

A Navigation Item with only the Name and Category Properties specified does not appear on the Splash Screen in the Run Environment. This Navigation Item will appear in the All Navigation Items drop-down under the appropriate Category. Note: This setting is normally used for Navigation Items such as Drop-Downs, Master Settings or Menus that are infrequently used and hence are not required to appear on the Splash Screen.

Case 2: Navigation Item with the Name, Category & Splash Screen Text specified. A Navigation Item with the Name, Category and Splash Screen Text Properties specified will appear on the Splash Screen as well as in the All Navigation Items drop-down in the Run Environment. It appears on the Splash Screen under the appropriate Category with the name assigned under the Splash Screen Text.

This Navigation Item will also appear in the All Navigation Items drop-down under the appropriate Category with the name assigned from the Name property in the Misc section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 88

WOLF User Guide version 1.3 2009

Note: This setting is normally used for Navigation Items that are required frequently and hence can be accessed from the Splash Screen.

© 2009 Wolf Platform as a Service All rights reserved.

Page 89

WOLF User Guide version 1.3 2009

8.4 Actions on a Navigation Item In addition to changing the Properties of a Navigation Item, there are several actions possible on a Navigation Item. To view these actions, right click on the Navigation Item Node.

The Save and Publish buttons enable you to Save/Publish changes made to a Navigation Item. Clicking the Close button enables you to close the working session with the current Navigation Item. Click the Delete button to remove the current Navigation Item from the Application. 8.5 Editing an existing Navigation Item There are several ways of managing an existing Navigation Item of an Application. Using any of the methods mentioned below opens a popup listing the existing Menus of an Application. Choose the appropriate Menu and then click the Open button in the popup to start working with the Menu.

From the Designer Home You can manage an existing Navigation Item by clicking on the Edit a previously created Navigation Item button in the Designer Home.

© 2009 Wolf Platform as a Service All rights reserved.

Page 90

WOLF User Guide version 1.3 2009

From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Navigation Item.

From the Solution Explorer Right click on the Application Node, select Open and then select Existing Navigation Item.

8.6 Deleting a Navigation Item To delete a Navigation Item, right click on the Navigation Item and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Navigation Item.

Caution: Deleting a Navigation Item will remove it permanently from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 91

WOLF User Guide version 1.3 2009 9. Working with Business Rules 9.1 Business Rules Overview Define your business processes using the Business Rules. Business Rules are the heart of Wolf Platformas-a-Service. The Wolf Rules Designer is a Wolf Designer Control that assists you to create, modify and delete the Business Rules of your Application. The Business Rules manage, change and generate the state of the Application and its Entities. They consist of a set of predefined actions that can be configured and invoked as and when required in any sequence. The Business Rule is available to be invoked for generating reports or taking care of business processes or data manipulation.

9.2 Adding a new Business Rule There are several ways of creating a new Business Rule in an Application. From the Designer Home You can create a new Business Rule by clicking on the Create a new Business Rule button in the Designer Home.

From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Business Rule.

From the Solution Explorer Right click on the Application Node, select New and then select New Business Rule.

© 2009 Wolf Platform as a Service All rights reserved.

Page 92

WOLF User Guide version 1.3 2009

The Business Rule consists of only a single non-expandable Node in the Solution Explorer. Clicking on the Business Rule Node in the Solution Explorer opens a Tab adjacent to the Designer Home for defining the actions of the Business Rule. This Tab is called the Business Rule Designer.

Every Business Rule created in an Application will consist of its own Business Rule Designer. It is important to note that the Business Rule does not consist of any Properties.

Note: 1. Each Business Rule consists of its own Business Rule Designer that allows you to define the actions of the Business Rule. 2. A Business Rule does not consist of any Properties.

© 2009 Wolf Platform as a Service All rights reserved.

Page 93

WOLF User Guide version 1.3 2009

9.3 Overview of the Business Rule Designer The figure below gives a top level view of the Business Rules Designer. It shows how the Business Rules Designer will look like when it is first created.

9.3.1 Concept of Nodes in Business Rules Designer The Business Rule Designer allows creation, manipulation and deletion of the actions of a Business Rule. The actions defined in the Business Rule possess a hierarchical structure in the form of Nodes and Sub Nodes. The figure below illustrates this concept:

© 2009 Wolf Platform as a Service All rights reserved.

Page 94

WOLF User Guide version 1.3 2009

The Business Rule Header Node is the top level (Level 0) Node for a Business Rule. The actions of the Business Rule are the Level 1 Nodes. If a Level 1 Node is expandable there will be a “+” beside it which can be clicked to see its Sub Nodes. Tip: 1. If a Node is expandable there will be a “+” sign beside it. Clicking on the “+” sign will expand the selected Node and allow you to see the Sub Nodes inside it. 2. The Nodes are aligned in accordance with their hierarchy. The Business Rule Header Node (Level 0) is leftmost aligned and the Level 1 Nodes are slightly right aligned to the Header Node

9.3.2 Business Rule Designer Toolbar The Business Rule Designer Toolbar provides easy access to commonly-performed functions while working with a Business Rule.

1. Expand all: Expands all the collapsed Nodes and Sub Nodes (if any) in the Business Rules Designer. 2. Expand selected node: Expands the currently selected Node/Sub Node if it is collapsed. 3. Quick Info: Quick help on the color conventions followed in the Business Rules Designer. 4. XML: Gives a preview of the XML definition of the current Business Rule. 5. Print: Prints the current Business Rule.

© 2009 Wolf Platform as a Service All rights reserved.

Page 95

WOLF User Guide version 1.3 2009

9.4 Working with the Business Rule Header Start defining your Business Rule from the Header. The Header consists of four components that allow you to define a Business Rule and its actions. The figure below shows the Business Rule Header.

When you first create a Business Rule, you need to specify three key details about the Business Rule from the Header: 1. Business Rule Name 2. For Entity 3. To be called: When? After specifying these details, you can click the arrow in the Header to start defining the actions of the Business Rule. Note: 1. The Header is the starting point for a Business Rule. Start by defining the three key details of a Business Rule: it’s Name, the Entity that it acts upon and when it is should be called. 2. Click the arrow in the Header to start defining the actions of a Business Rule. 9.4.1 Business Rule Name The first step while creating a Business Rule is to provide a meaningful name for the Business Rule. For example, a Business Rule that counts the number of male contacts in the Contact Entity may be named as “Number of Male Contacts”. It is mandatory to provide a name for the Business Rule. How do I provide a name for the Business Rule? Step 1: To provide a name for the Business Rule, click on the [Business Rule Name] text in the Header. A drop-down list appears with the text [Constant].

© 2009 Wolf Platform as a Service All rights reserved.

Page 96

WOLF User Guide version 1.3 2009

Step 2: Click on the [Constant] button. A popup appears with a textbox in which you can specify the name of the Business Rule.

Step 3: Provide a name for the Business Rule and then click Ok.

9.4.2 For Entity Determine which Entity your Business Rule will act upon. The Business Rule acts upon the Entity data to generate the desired results. For example, a Business Rule that acts upon the Contact Entity utilizes the Contact Entity’s data to perform calculations or manipulations. This step is important as the chosen Entity will set the context for the actions in the Business Rule. How do I set the Entity which a Business Rule acts upon? To set the Entity which the Business Rule acts upon, click on the [Entity] text in the Header. A drop-down appears listing the Entities of your Application. Choose the appropriate Entity from the list.

© 2009 Wolf Platform as a Service All rights reserved.

Page 97

WOLF User Guide version 1.3 2009

9.4.3 To be called: When? Decide when the Business Rule should be invoked. Business Rules can be invoked for two conditions: 1. Every time the Entity is saved 2. Unspecified

How do I specify when a Business Rule needs to be invoked? To specify when the Business Rule should be invoked, click on the [When?] text in the Header. A dropdown appears with the two options: Every time the Entity is saved and Unspecified. Click on the appropriate option.

9.4.3.1 Using the “Every time the Entity is saved” condition A Business Rule with this condition is auto invoked every time a record of the Entity is created, edited or deleted. The Entity in the current context is the one specified in the Header of the Business Rule. This condition is used to alter the normal process which occurs when an Entity is saved and to perform an action or a set of actions on the Entity record. This type of Business Rule is also known as the “On Save Business Rule”. For example, let’s say we need to generate an alert message every time a record is saved in the Contact Entity. The Business Rule Header will look as shown in the diagram below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 98

WOLF User Guide version 1.3 2009

It is important to remember that if the Business Rule is invoked for this condition then it must end with an action that updates the Entity, i.e. the Update [Entity Name] action. The sample Business Rule is as shown below:

It is important to note that there can be only a single Business Rule with the condition “When? = Every time the Entity is saved” for an Entity. Any other Business Rules acting upon the Entity should be invoked on the “When? = Unspecified” condition. The “On Save Business Rule” can consist of any number of calls to “Unspecified” Business Rules specified inside it. Tip: If you want to discontinue the use of an “On Save Business Rule” on an Entity simply change the condition to “When? = Unspecified”.

Caution: 1. If the Business Rule is invoked for the condition “When? = Every time the Entity is saved” then the body of the Rule must conclude with the Update [Entity Name] action. 2. There can be only a single Business Rule with the condition “When? = Every time the Entity is saved” for an Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 99

WOLF User Guide version 1.3 2009

9.4.3.2 Using the “Unspecified” condition We can use a Business Rule with this condition in most instances such as for generating Reports, auto filtering Search Screens, invoking a Business Rule from another Business Rule, creating Combos as well as for Custom Tasks. An “Unspecified” Business Rule is one that does not act as a trigger but sits unless it has been invoked. For example, we want to auto filter the records of a Search Screen in the Contact Entity to display contacts whose age is less than or equal to 21. The Business Rule Header will look as shown in the diagram below:

There may be any number of Business Rules with the “Unspecified” condition for an Entity. These Business Rules may be used for different purposes such as Reports, Search Screens or invoked from another Business Rule. The “Unspecified” Business Rules can be classified into two types: 1. Rules that act upon an Entity record to achieve an action or a set of actions 2. Rules that act upon a particular element of the Application: These Business Rules act on a specific element such as Search Screens, Reports, Fields, etc. and need to be invoked from the Rules that act upon an Entity record to achieve an action or a set of actions These Business Rules will need to be invoked by an “On Save Business Rule” to be used in an Application. For example, we have 3 Business Rules in an Application – BR1, BR2 and BR3. Let’s consider BR1 is an “On Save Business Rule” and BR2 & BR3 are two “Unspecified” Business Rules. Our requirement is to invoke the “Unspecified” BR3 in the Application. This can be achieved in two different ways: a. BR1 invokes BR2 and BR3 b. BR1 invokes BR2 and BR2 invokes BR3 9.4.3.3 How do I call multiple Business Rules acting on a single Entity? As already mentioned, there can only be a single “On Save Business Rule” and any number of Unspecified Business Rules acting on an Entity. A conditional chain of further calls can be established from the “On Save Business Rule”. © 2009 Wolf Platform as a Service All rights reserved.

Page 100

WOLF User Guide version 1.3 2009

9.4.4 Adding Actions to a Business Rule Once you have specified the key details of a Business Rule from its Header you can start adding Actions to the Business Rule. Click on the arrow in the Header to start adding Actions to the Business Rule.

A drop-down appears with the list of possible Actions. Click on the appropriate Action to add it to your Business Rule.

9.5 Business Rule Actions Business Rule Actions enable you to define the objective of the Business Rule. These Actions can be configured and invoked from the Business Rule as and when required in any sequence. The figure below shows the list of Actions that can be defined inside a Business Rule:

© 2009 Wolf Platform as a Service All rights reserved.

Page 101

WOLF User Guide version 1.3 2009

9.5.1 Important points to remember while using the Business Rule Actions 1. Clicking the arrow next to an Action Node gives the list of available options.

2. The changes made to a Business Rule will only reflect in the Run Environment of an Application. 3. The Actions in the Business Rule will be executed serially in the order that they are defined. Options exist for arranging and deleting the Action Nodes. 4. The following options can be used for arranging the order of Actions in a Business Rule: a.

Move current node up: Moves the current Node one step up with respect to the other same level Action Nodes in the Business Rule. Moving a Node up/down allows us to specify the sequence in which the Actions will be executed.

b. Move current node down: Moves the current Node one step down with respect to the other same level Action Nodes in the Business Rule.

© 2009 Wolf Platform as a Service All rights reserved.

Page 102

WOLF User Guide version 1.3 2009

c. Delete current node: Deletes the current Node. Deleting a Node also deletes the Sub Nodes (if any) which are present inside it. The Move up/down options for an Action always arranges the Node with respect to other same level Actions Nodes in the Business Rule. It is important to note that these options are available for all the Level 1 Actions Nodes in a Business Rule. However, these options are not available for all the Action Nodes in a Business Rule.

Tip: Refer to the Quick Info from the Business Rule Designer Toolbar to become familiar with the color conventions used in the Business Rule Actions.

9.5.2 Different Actions in a Business Rule Let’s take a look at the different Actions that can be added in a Business Rule. 9.5.2.1 The “If … Then …” Action This Action will check a logical condition and will perform a set of Actions if the condition is true or perform no Action if the condition is false. The logical condition to be checked is specified under the “The following apply” Node and the set of Actions to be executed are specified under the “Then” Node.

9.5.2.1.1 Options for the “If” Node The “If” Node is the top level Node in the “If … Then …” Action. The options for this Node allow you to specify the sequence in which this Action will be executed or to remove this Action from a Business Rule. Click on the arrow next to the “If” Node to see the list of options. Available options: 1. Move current node up 2. Move current node down 3. Delete current node © 2009 Wolf Platform as a Service All rights reserved.

Page 103

WOLF User Guide version 1.3 2009

9.5.2.1.2 Options for the “The following apply” Node On creation, every “If … Then …” Action consists of a default condition. In addition to the default condition, this Node allows you to specify additional conditions. These conditions may be either elementary or complex conditions. If the condition(s) is true then the Actions under the “Then” Node will be executed. Click on the arrow next to the “The following apply” Node to see the list of options. Available options: 1. Add a New Elementary Condition: allows you to specify an additional elementary condition 2. Add a New Complex Condition: allows you to specify an additional complex condition You may add as many elementary/complex conditions as required to completely specify a logical condition for the “If … Then …” Action. 9.5.2.1.3 Setting a logical condition for the “If … Then …” Action 9.5.2.1.3.1 The default condition: By default the following condition exists for every “If … Then …” Action:

The controls existing in the default condition allow you to specify the logical condition for an “If … Then …” Action. Click on the arrow next to the default condition Node to see the list of options. Available options: 1. Reset: Allows you to reset the controls of the default condition. It is important to note that the default condition cannot be deleted.

Tip: 1. You can specify elementary or complex conditions in addition to the default condition. 2. Choose the Reset option to reset the values specified for the default condition.

© 2009 Wolf Platform as a Service All rights reserved.

Page 104

WOLF User Guide version 1.3 2009

Steps for setting a logical condition: Step 1: Click on the first [Field, Variable or Constant] control in the condition to set the first operator.

This control allows you to set the first operator for the logical condition. You can choose the first operator for the logical condition from the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to use a text input in the logical condition. Step 2: Click on the [Is Equal To] control to set the comparison operator. This control allows you to choose the comparison operator for the logical condition. By default, it is set to “Is Equal To”. Click on the [Is Equal To] control to choose from a drop-down list of operators. It is important to note that the list of operators will refresh based on the first operator chosen. For example, if the first operator is a Text Field the drop-down list will refresh its values based on this.

© 2009 Wolf Platform as a Service All rights reserved.

Page 105

WOLF User Guide version 1.3 2009

Step 3: Click on the first [Field, Variable or Constant] control in the condition to set the second operator. This control allows you to set the second operator for the logical condition. The values in the drop-down list are similar to those for the first operator.

Let’s say we want to specify a logical condition that checks for all contacts above the age of 60 for an Entity. The logical condition will look as shown below:

The Actions to be implemented if the logical condition is true are specified under the “Then” Node.

© 2009 Wolf Platform as a Service All rights reserved.

Page 106

WOLF User Guide version 1.3 2009

9.5.2.1.3.2 Adding an elementary condition To add an elementary condition to the Business Rule, click on the arrow next to the “The following apply” Node and select Add a New Elementary Condition. The newly added elementary condition will look as shown below:

The controls existing in the elementary condition are similar to those in the default condition. In addition to these controls, the elementary condition contains an extra control: Click on the [and] control to specify a logical AND/OR. This control allows you to specify the kind of logical operation (AND/OR) taking place between the elementary condition and the condition above it. If the elementary condition is specified, the logical condition will look as shown below:

This condition will check for all contacts above the age of 60 and with the title “Mr.” The logical condition will evaluate to true only if both the conditions are satisfied. Click on the arrow next to the elementary condition Node to see the list of available options: 1. Add a New Elementary Condition: allows you to specify an additional elementary condition 2. Add a New Complex Condition: allows you to specify an additional complex condition 3. Move current node up: moves the elementary condition Node up with respect to the other condition Nodes 4. Move current node down: moves the elementary condition Node down with respect to the other condition Nodes 5. Delete current node: deletes the current elementary condition

© 2009 Wolf Platform as a Service All rights reserved.

Page 107

WOLF User Guide version 1.3 2009

9.5.2.1.3.3 Adding a complex condition To add a complex condition to the Business Rule, click on the arrow next to the “The following apply” Node and select Add a New Complex Condition. The newly added complex condition will look as shown below:

The controls existing in the complex condition are similar to those in the default condition. In addition to these controls, the complex condition contains an extra control: Click on the [and] control to specify to specify a logical AND/OR. This control allows you to specify the kind of logical operation (AND/OR) taking place between the complex condition and the condition above it. If the complex condition is specified, the logical condition will look as shown below:

This condition will check for all contacts with the name “John”, with the title “Mr.” and above the age of 60. The logical condition will evaluate to true only if all the conditions are satisfied. Available Options:

The options available depend on the Node of the complex condition that we are working with. a. At the “and the following apply” Node of the complex condition:

© 2009 Wolf Platform as a Service All rights reserved.

Page 108

WOLF User Guide version 1.3 2009

1. Add a New Elementary Condition: allows you to specify an additional elementary condition inside the complex condition 2. Add a New Complex Condition: allows you to specify an additional complex condition inside the complex condition 3. Move current node up: moves the complex condition Node up with respect to the other condition Nodes 4. Move current node down: moves the complex condition Node down with respect to the other condition Nodes 5. Delete current node: deletes the current complex condition

b. At the default condition Node inside the complex condition: 1. Reset: Allows you to reset the controls of the default condition Note: 1. An elementary condition defined anywhere inside a logical condition has the same controls and options. 2. A complex condition defined anywhere inside a logical condition has the same controls and options. 3. 9.5.2.1.4 Adding Actions to the “Then” Node Once we have defined the logical condition for the “If … Then …” Action, we need to define the Actions that take place if the logical condition is true. These actions need to be defined inside the “Then” Node of the Action. To start adding Actions, click on the arrow next to the “Then” Node. A drop-down list of the available Actions appears. Click on the appropriate Action to add it. Note: You may add as many Actions as required under the “Then” Node.

© 2009 Wolf Platform as a Service All rights reserved.

Page 109

WOLF User Guide version 1.3 2009

For example, we need to raise an alert message if a contact’s age is greater than 60. The sample “If … Then …” Action will look as shown below:

Note: The Actions under the “Then” Node will be executed only if the logical condition in the “If … Then…” Action is satisfied. If this condition evaluates to false then the Actions under the “Then” Node will not be executed.

© 2009 Wolf Platform as a Service All rights reserved.

Page 110

WOLF User Guide version 1.3 2009

9.5.2.1.5 Nested “If … Then …” Actions An “If … Then …” Action inside another “If … Then …” Action is known as a nested “If … Then …” Action. There is no limit to the level of nesting. A nested “If … Then …” Actions will look as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 111

WOLF User Guide version 1.3 2009

9.5.3 Repetitive Actions A Repetitive Action performs an Action or a set of Actions for a fixed number of times or until a logical condition is satisfied. The Repetitive Actions are of three types: 1. On Entity Records: The “For-each record of [Entity]” Action acts upon Entity records. 2. On Entity Attachment Records: The “For-each record/line in [Attachment File Name]” Action acts upon the records in an Attachment. 3. For a fixed number of times: The “Run Actions while counter is lesser than or equal to [0]” Action perform an Action for a fixed number of times. We will consider each of them individually in turn.

9.5.3.1 Repetitive Action on Entity Records: For-each record of [Entity] The “For-each record of [Entity]” Action performs an Action or a set of Actions on each record of an Entity that satisfies a logical condition. In the absence of a logical condition, the Action(s) will be performed on all the records of an Entity. The Action/Actions to be performed are specified in the body or the Nodes of the “For-each record of [Entity]”. The figure below shows the basic structure of the “For-each record of [Entity]” Action:

© 2009 Wolf Platform as a Service All rights reserved.

Page 112

WOLF User Guide version 1.3 2009

9.5.3.1.1 The “For” Node The “For” Node is the top level Node in the “For-each record of [Entity]” Action. This Node allows you to specify the Entity which this Action will operate upon. All the Nodes and controls in the Action will adjust themselves automatically based on the selected Entity.

To specify an Entity for the “For-each record of [Entity]” Action, click on the [Entity] control in the “For” Node. A drop-down list of all the Entities in the Application appears. Click on the appropriate Entity.

Click on the arrow next to the “For” Node to see the list of available options.

© 2009 Wolf Platform as a Service All rights reserved.

Page 113

WOLF User Guide version 1.3 2009

The available options can be divided into two types: 1. Adding an Action in the body of the “For-each record of [Entity]”Action: This process is similar to adding Actions to the “If … Then …” Action. Click on the appropriate Action from the drop-down list to add it. 2. Arranging the order of the “For-each record of [Entity]”Action with respect to the other Actions defined in a Business Rule

9.5.3.1.2 The “Columns” Node The “For-each record of [Entity]” Action is often used to return tabular data to Reports, Search Screens and Dashboard Widgets. The “Columns” Node is used to select the Fields from an Entity that will be returned as column data to these tables. In addition to this, the “Columns” Node also allows us to use Fields from an Entity for data manipulations or calculations inside the Action. The Entity in the current context is the one specified in the “For” Node of the Action. It is important to note that you may add as many columns as required in this Node. 9.5.3.1.2.1 Adding Columns in the “Columns” Node: Click on the arrow next to the “Columns” Node to see the list of available options: 1. Add Column: This option adds a Field as-is, i.e. without performing any calculations. 2. Summary Column: This option provides a Field’s summary based on the Entity data. Field can be summarized based on different functions such as average, sum or count. 3. Calculated Column: This option adds a calculated Field. The calculations are used for deriving different data from a Field such as “Month Name” from a Date Field. Click on the appropriate option to add the column. 9.5.3.1.3 Column in the “Columns” Node The figure below shows how different types of columns appear under the “Columns” Node.

© 2009 Wolf Platform as a Service All rights reserved.

Page 114

WOLF User Guide version 1.3 2009

The controls existing in a column allow you to choose the Field as well as an alias for the Field. Choosing a Field for a column To choose a Field for a column, click on the [Field] control. A drop-down listing the Fields appears. Click on the Field to add it. The following Fields can be added to the “Columns” Node: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Fields of an Entity holding a Relation to the current Entity. 4. System Fields of an Entity holding a Relation to the current Entity. Providing an Alias for a Field Step 1: To provide an Alias for the Field, click on the [Alias] control. A drop-down list appears with the text [Enter text]. Step 2: Click on the [Enter text] button. A popup appears with a textbox in which you can specify an alias for the Field name. Options for a Column Click on the arrow next to the column to see the list of options. Available options: 1. Move current node up 2. Move current node down 3. Delete current node 9.5.3.1.4 Record Selection Filter This Node contains Sub Nodes that allow you to specify filters for record selection in the “For-each record of [Entity]” Action. This Node acts as a header for the filtering section and contains the following Sub Nodes inside it: 1. The “No. of records” Node 2. The “Ignore Entity Privilege Filters” Node © 2009 Wolf Platform as a Service All rights reserved.

Page 115

WOLF User Guide version 1.3 2009

3. The “Where the following apply” Node and its Sub Nodes used for specifying a logical condition We will consider each Sub Node individually in turn.

9.5.3.1.4.1 No of records This Node allows you to specify the number of records the Business Rule should fetch from an Entity. To specify a number, click on the [All] control in the Node. A drop-down listing the available options appears. You can choose a numerical value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number using [Constant]. 2. Numerical Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. The Context control has variables that relate to the state of the current execution. 4. Session Fields of the Application that possess a numerical value. 5. The Enter number control opens a popup allowing you to specify a numerical value. Tip: By default the “For-each record of [Entity]” Action fetches all the records of an Entity or the records satisfying a logical condition. 9.5.3.1.4.2 The “Ignore Entity Privilege Filters” Node When the Run Environment is accessed by the Super User of an Application, it presents the Administrative interface allowing the Super User to control administrative, security and access features of an Application. It also allows the Super User to specify Entity privileges (View/Edit/Delete) for every Entity of an Application. While fetching records from an Entity for the “For-each record of [Entity]” Action, this Node checks whether the Entity privileges should be ignored or not. By default, these Entity privilege settings will not be ignored. To ignore these settings, click on [No]. A drop-down appears with the options “Yes” and “No”. Click on Yes to ignore Entity privilege settings. © 2009 Wolf Platform as a Service All rights reserved.

Page 116

WOLF User Guide version 1.3 2009

9.5.3.1.4.3 The “Where the following apply” Node and its Sub Nodes used for specifying a logical condition The process of setting a logical condition for the “For-each record of [Entity]” is similar to the process for the “If … Then …” Action. However, there are minor differences between the two which will be pointed out here. 9.5.3.1.4.3.2 “Where the following apply” Node On creation, every “For-each record of [Entity]” Action consists of a default condition. In addition to the default condition, this Node allows you to specify additional conditions. These conditions may be either elementary, complex or defined in a variable/constant. If the condition(s) is true then the Actions defined inside the “For-each record of [Entity]” Action will be executed. Click on the arrow next to the “Where the following apply” Node to see the list of options. Available options: 1. Add a New Elementary Condition: allows you to specify an additional elementary condition on a Field or a calculated Field 2. Add a New Complex Condition: allows you to specify an additional complex condition 3. Add Condition from variable/constant: allow you to use a condition specified in a variable/constant of the Business Rule. You may add as many conditions as required to completely specify a logical condition for the “For-each record of [Entity]” Action. 9.5.3.1.4.3.3 Setting a logical condition for the “For-each record of [Entity]” Action 9.5.3.1.4.3.3.1 The default condition By default the following condition exists for every “For-each record of [Entity]” Action:

The controls existing in the default condition allow you to specify the logical condition. Click on the arrow next to the default condition Node to see the list of options: 1. Reset: Allows you to reset the controls of the default condition. It is important to note that the default condition cannot be deleted © 2009 Wolf Platform as a Service All rights reserved.

Page 117

WOLF User Guide version 1.3 2009 Tip: 1. You can specify elementary or complex conditions in addition to the default condition. 2. Choose the Reset option to reset the values specified for the default condition.

Steps for setting a logical condition: Step 1: Click on the [Field] control in the condition to set the first operator.

This control allows you to set the first operator for the logical condition. The first operator for the “Foreach record of [Entity]” Action is always an Entity Field. You can choose the Field for the logical condition from the following: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Fields of an Entity holding a Relation to the current Entity. 4. System Fields of an Entity holding a Relation to the current Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 118

WOLF User Guide version 1.3 2009

Step 2: Click on the [Is Equal To] control to set the comparison operator. This control allows you to choose the comparison operator for the logical condition. By default, it is set to “Is Equal To”. Click on the [Is Equal To] control to choose from a drop-down list of operators. It is important to note that the list of operators will refresh based on the first operator chosen. For example, if the first operator is a Text Field the drop-down list will refresh its values based on this. Step 3: Click on the first [Field, Variable or Constant] control in the condition to set the second operator. You can choose the operator for the logical condition from the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to use a text input in the logical condition.

9.5.3.1.4.3.3.2 Adding an elementary condition The “For-each record of [Entity]” Action allows you to specify an elementary condition on a Field or on a calculated Field. To add an elementary condition, click on the arrow next to the “Where the following apply” Node and select Add a New Elementary Condition. Then choose from one of the options: 1. On Field 2. On Calculated Field © 2009 Wolf Platform as a Service All rights reserved.

Page 119

WOLF User Guide version 1.3 2009

The controls existing in the elementary condition are similar to those in the default condition. In addition to these controls, the elementary condition contains an extra control: Click on the [and] control to specify to specify a logical AND/OR. This control allows you to specify the kind of logical operation (AND/OR) taking place between the elementary condition and the condition above it. The conditions will look as shown below:

An elementary condition on a Calculated Field contains an extra control that allows you to specify the kind of calculation to be performed on the Field. Click on the [Calculated] control to specify the kind of calculation. Choose from one of the options: 1. Month Name: Obtains the month name from a Date Field. 2. Days To: Calculates the difference in the number of days between the current date and the date specified in the Date Field. Click on the arrow next to the elementary condition Node to see the list of available options: 1. Add a New Elementary Condition: allows you to specify an additional elementary condition 2. Add a New Complex Condition: allows you to specify an additional complex condition 3. Add Condition from variable/constant: allows you to specify an additional condition from a variable/constant 4. Move current node up: moves the elementary condition Node up with respect to the other condition Nodes 5. Move current node down: moves the elementary condition Node down with respect to the other condition Nodes 6. Delete current node: deletes the current elementary condition

© 2009 Wolf Platform as a Service All rights reserved.

Page 120

WOLF User Guide version 1.3 2009

9.5.3.1.4.3.3.3 Adding a complex condition To add a complex condition, click on the arrow next to the “Where the following apply” Node and select Add a New Complex Condition. The controls existing in the complex condition are similar to those in the default condition. In addition to these controls, the complex condition contains an extra control: Click on the [and] control to specify to specify a logical AND/OR. This control allows you to specify the kind of logical operation (AND/OR) taking place between the complex condition and the condition above it. Click on the arrow next to the complex condition Node to see the list of available options: 1. Add a New Elementary Condition: allows you to specify an additional elementary condition 2. Add a New Complex Condition: allows you to specify an additional complex condition 3. Add Condition from variable/constant: allows you to specify an additional condition from a variable/constant 4. Move current node up: moves the complex condition Node up with respect to the other condition Nodes 5. Move current node down: moves the complex condition Node down with respect to the other condition Nodes 6. Delete current node: deletes the current complex condition

9.5.3.1.4.3.3.4 Adding a condition defined in a variable/constant To add a condition defined a variable/constant, click on the arrow next to the “Where the following apply” Node and select Add Condition from variable/constant.

To specify the variable/constant in which the condition is defined, click on the Variable or Constant control in the condition. A drop-down list with the available options appears. Choose the appropriate variable/constant in which the condition is defined. © 2009 Wolf Platform as a Service All rights reserved.

Page 121

WOLF User Guide version 1.3 2009

Click on the arrow next to the condition Node to see the list of available options: 1. Move current node up: moves the condition Node up with respect to the other condition Nodes 2. Move current node down: moves the condition Node down with respect to the other condition Nodes 3. Delete current node: deletes the current condition

9.5.3.1.5 The “Group By” Node This Node groups the results of the “For-each record of [Entity]” Action based on a Field or a Calculated Field. The tabular data returned by the “For-each record of [Entity]” Action will be grouped based on the Field(s) specified under this Node. To specify a Group Field, click on the arrow next to the “Group By” Node. A drop-down listing the following options appears: 1. Add Column 2. Calculated Column Click on the appropriate option. Tip: The results of the “For-each record of [Entity]” Action may be grouped based on multiple Fields.

You can choose a Field for grouping the results from the following: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Fields of an Entity holding a Relation to the current Entity. 4. System Fields of an Entity holding a Relation to the current Entity.

The “Add Column” option for grouping results: This option allows you to group the results based on a Field.

© 2009 Wolf Platform as a Service All rights reserved.

Page 122

WOLF User Guide version 1.3 2009

The “Calculated Column” option for grouping results: This option allows you to group the results based on a calculated Field. You can choose the calculations to be performed on a Field from one of the following types: 1. Month Name (Field): Based on the month name derived from a Date Field. 2. Sum (Field): Based on the sum of a numeric Field.

The Group Fields will look as shown below:

Setting a Group Field: Click on the [Field] control to set the Group Field. It is important to note that the order of the Group Fields under the “Group By” Node plays a crucial role in deciding the result of the “For-each record of [Entity]”Action. The results are first grouped on the basis of the “Level 1” Group Field. These grouped results are then grouped based on the “Level 2” Group Field and so on. Click on the arrow next to the Group Field Node to see the list of available options: 1. Move current node up: moves the Group Field Node up with respect to the other Group Field Nodes 2. Move current node down: moves the Group Field Node down with respect to the other Group Field Nodes 3. Delete current node: deletes the current Group Field

© 2009 Wolf Platform as a Service All rights reserved.

Page 123

WOLF User Guide version 1.3 2009

9.5.3.1.6 The “Sort matching records in the following order” Node This Node allows you to sort the results of the “For-each record of [Entity]”Action in Ascending/Descending order. The sorting is performed on a Field(s) contained in the results of the Action. To add a Sort Field, click on the arrow next to the “Sort matching records in the following order” Node and then select Add Sort field. Tip: The results of the “For-each record of [Entity]” Action may be sorted based on multiple Fields.

You can sort the results based on the following Fields: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Fields of an Entity holding a Relation to the current Entity. 4. System Fields of an Entity holding a Relation to the current Entity. Setting a Sort Field: To set a Sort Field, click on the [Field] control and then choose the appropriate Field. To specify the sorting order click on the [Ascending] control and choose from Ascending or Descending. By default the sorting is performed in the Ascending order.

It is important to note that the order of the Sort Fields under the “Sort matching records in the following order” Node plays a crucial role in the way the sort results are displayed. The results are first sorted on the basis of the “Level 1” Sort Field. These sorted results are then sorted based on the “Level 2” Sort Field and so on. Click on the arrow next to the Sort Field Node to see the list of available options: 1. Move current node up: moves the Sort Field Node up with respect to the other Sort Field Nodes

© 2009 Wolf Platform as a Service All rights reserved.

Page 124

WOLF User Guide version 1.3 2009

2. Move current node down: moves the Sort Field Node down with respect to the other Sort Field Nodes 3. Delete current node: deletes the current Sort Field

9.5.3.1.7 Adding Additional Actions to the “For-each record of [Entity]” Action Click on the arrow next to the “For” Node to see the list of available actions. Click on the appropriate Action from the drop-down list to add it.

Once you have added the Actions you can click the arrow next to an Action Node to arrange or delete the Action.

Tip: Multiple Actions can be added in the body of the “For-each record of [Entity]” Action.

© 2009 Wolf Platform as a Service All rights reserved.

Page 125

WOLF User Guide version 1.3 2009

9.5.3.2 Repetitive Action on Entity Attachment Records: The “For-each record/line in [Attachment File Name]” The “For-each record/line in [Attachment File Name]” Action performs an Action or a set of Actions on each line/record of an Attachment File. The Action/Actions to be performed are specified in the body of the “For-each record/line in [Attachment File Name]” Action. The figure below shows the basic structure of the Action:

9.5.3.2.1 Specifying the Attachment File Name The “For-each” Node is the top level Node in the “For-each record/line in [Attachment File Name]” Action. This Node allows you to specify the Attachment File which this Action will operate upon. To specify an Attachment File for the Action: Step 1: Click on the [Attachment File Name] control in the “For-each” Node. A drop-down list appears with the text [Constant].

Step 2: Click on the [Constant] button. A popup appears with a textbox in which you can specify the name of the Attachment File.

© 2009 Wolf Platform as a Service All rights reserved.

Page 126

WOLF User Guide version 1.3 2009

Step 3: Provide the name of the file and then click Ok. 9.5.3.2.2 Specifying the Actions to be performed on the Attachment Click on the arrow next to the “For-each” Node to see the list of available actions. Click on the appropriate Action from the drop-down list to add it.

Once you have added the Actions you can click the arrow next to an Action Node to arrange or delete the Action.

Tip: Multiple Actions can be added in the body of the “For-each record/line in [Attachment File Name]” Action.

© 2009 Wolf Platform as a Service All rights reserved.

Page 127

WOLF User Guide version 1.3 2009

9.5.3.3 For a fixed number of times: The “Run Actions while counter is lesser than or equal to [0]” Action The “Run Actions while counter is lesser than or equal to [0]” Action performs an Action or a set of Actions for a fixed number of times. The Action/Actions to be performed are specified in the body of the “Run Actions while counter is lesser than or equal to [0]” Action. The figure below shows the basic structure of the Action:

9.5.3.3.1 Specifying the counter of the Action The counter is a numerical value that denotes how many times the Action/Actions inside the “Run Actions while counter is lesser than or equal to [0]” will be executed. To specify a counter, click on the [0] control in the header of the Action. A drop-down listing the available options appears. You can choose a numerical value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number using [Constant]. 2. Numerical Fields or of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. The Context control has variables that relate to the state of the current execution. 4. Session Fields of the Application that possess a numerical value. 5. The Enter number control opens a popup allowing you to specify a numerical value.

9.5.3.3.2 Specifying the Actions to be performed Click on the arrow next to the “Run Actions while counter is lesser than or equal to [0]” Node to see the list of available actions. Click on the appropriate Action from the drop-down list to add it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 128

WOLF User Guide version 1.3 2009

Once you have added the Actions you can click the arrow next to an Action Node to arrange or delete the Action. Tip: Multiple Actions can be added in the body of the “Run Actions while counter is lesser than or equal to [0]” Action.

© 2009 Wolf Platform as a Service All rights reserved.

Page 129

WOLF User Guide version 1.3 2009

9.5.4 The “Create a new record in an Entity” Action This Action creates an Entity record in the Application. Additionally, this Action allows you to specify Field values of the Entity record. The figure below shows the basic structure of the Action:

9.5.4.1 Specifying an Entity for the “Create a new record in an Entity” Action The “Create a New Entity” is the top level Node for the Action. It allows you to specify the Entity for which a record will be created. To specify the Entity, click on the [Entity] control in the Action. A drop-down appears listing the Entities of your Application. Choose the appropriate Entity from the list.

This step is important as the chosen Entity will set the context for the Action’s Sub Nodes and their controls. Click on the arrow next to the “Create a New Entity” Node to see the list of available options: 1. Set a Field’s value: allows you to specify Field values for the Entity record 2. Move current node up 3. Move current node down 4. Delete current node

© 2009 Wolf Platform as a Service All rights reserved.

Page 130

WOLF User Guide version 1.3 2009

9.5.4.2 Setting a Field’s value Once you have specified an Entity for the Action, you can start specifying Field values for the Entity record. To set a Field’s value, click on the arrow next to the “Create a New Entity” Node and select Set a Field’s value. The “Set a Field’s value” Node will look as shown below:

The controls existing in this Node allow you to specify a Field and its value. To specify a Field, click on the [Field] control in the Node. You can set the value of the following Fields: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Unique ID of an Entity holding a Relation to the current Entity.

To specify a Field’s value, click on the [Field, Variable or Constant] control in the Node. You can choose a value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Fields or System Fields of an Entity holding a Relation with the current Entity. 4. Context variables that relate to the state of the current execution. 5. Session Fields 6. The Enter text control allows you to specify a text input.

© 2009 Wolf Platform as a Service All rights reserved.

Page 131

WOLF User Guide version 1.3 2009

For example, we want to create a new record for the “Contact Entity”, the “Create a new record in an Entity” Action will appear as shown below:

Click on the arrow next to the “Set a Field’s value” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

Tip: You can set the value of multiple Fields in an Entity by using this Action.

9.5.5 The “Update a record in an Entity” Action This Action allows you to update Field values of an Entity record. The Entity in the current context is the one which the Business Rule is acting upon. Note: The “Update a record in an Entity” Action only allows you to update the Field values of the Entity which the Business Rule is acting upon. The figure below shows the basic structure of the Action:

9.5.5.1 Specifying the Entity for the “Update a record in an Entity” Action As already mentioned, this Action can only update the Field values of the Entity which the Business Rule is acting upon. To specify the Entity for this Action, click on the [Entity] control in the Action. A dropdown appears listing the relevant Entity. Click on the Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 132

WOLF User Guide version 1.3 2009

As we can see in the figure above, the “Update a record in an Entity” Action can only update the Entity which the Business Rule acts upon. Click on the arrow next to the “Update Entity” Node to see the list of available options: 1. Set a Field’s value: allows you to specify Field values for the Entity record 2. Move current node up 3. Move current node down 4. Delete current node

9.5.5.2 Setting a Field’s value Once you have specified an Entity for the Action, you can start updating Field values of the Entity record. To update a Field’s value, click on the arrow next to the “Update Entity” Node and select Set a Field’s value. The “Set a Field’s value” Node will look as shown below:

The controls existing in this Node allow you to specify a Field and its value. To specify a Field, click on the [Field] control in the Node. You can set the value of the following Fields: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Unique ID of an Entity holding a Relation to the current Entity.

To specify a Field’s value, click on the [Field, Variable or Constant] control in the Node. You can choose a value from one of the following:

© 2009 Wolf Platform as a Service All rights reserved.

Page 133

WOLF User Guide version 1.3 2009

1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Context variables that relate to the state of the current execution. 4. Session Fields 5. The Enter text control allows you to specify a text input. Click on the arrow next to the “Set a Field’s value” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

Tip: You can update the value of multiple Fields in an Entity by using this Action.

9.5.6 The “Update multiple records in an Entity” Action As opposed to the “Update a record in an Entity” Action which updates a single record in an Entity, this Action is used to perform a bulk update of records in an Entity. The figure below shows the basic structure of the Action:

© 2009 Wolf Platform as a Service All rights reserved.

Page 134

WOLF User Guide version 1.3 2009

9.5.6.1 Specifying the Entity for the “Update multiple records in an Entity” Action The “Bulk Update records of Entity” is the top level Node for the Action. It allows you to specify the Entity whose records will be updated. To specify the Entity, click on the [Entity] control in the Action. A drop-down appears listing the Entities of your Application. Choose the appropriate Entity from the list.

This step is important as the chosen Entity will set the context for the Action’s Sub Nodes and their controls. Click on the arrow next to the “Create a New Entity” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

9.5.6.2 Specifying a logical condition for the Action The “Where the following apply” Node and its Sub Nodes are used for specifying a logical condition for the “Update multiple records in an Entity” Action. It is important to note that it is not mandatory to specify a logical condition for this Action. In the absence of a logical condition, all the records of the Entity are updated. If a logical condition is specified then the Action updates the records of the Entity that satisfy the logical condition.

The process of setting a logical condition for the “Update multiple records in an Entity” Action is identical to that of the “For-each record of [Entity]” Action. Also, the controls and the options for both

© 2009 Wolf Platform as a Service All rights reserved.

Page 135

WOLF User Guide version 1.3 2009

the actions are similar. Please refer to section “9.5.3.1.4.3 The “Where the following apply” Node” and its Sub Nodes for a complete understanding of how to specify a logical condition. 9.5.6.3 The “Ignore Entity Privilege Filters” Node When the Run Environment is accessed by the Super User of an Application, it presents the Administrative interface allowing the Super User to control administrative, security and access features of an Application. It also allows the Super User to specify Entity privileges (View/Edit/Delete) for every Entity of an Application. While updating the records of an Entity for the “Update multiple records in an Entity” Action, this Node checks whether the Entity privileges should be ignored or not. By default, these Entity privilege settings will not be ignored. To ignore these settings, click on [No]. A drop-down appears with the options “Yes” and “No”. Click on Yes to ignore Entity privilege settings. 9.5.6.4 The “Change the value of the following fields” Node This Node allows you to specify the changes to be made to the Fields of a record in the bulk update. If no logical condition is specified, the update will reflect in all the records of the Entity. If a logical condition is specified, the update will reflect in only those records that satisfy the condition. 9.5.6.4.1 Setting a Field’s value To specify the changes to be made to a Field, click on the arrow next to the “Change the value of the following fields” Node and select Set a Field’s value. The “Set a Field’s value” Node will look as shown below:

The controls existing in this Node allow you to specify a Field and the changes to be made to its value in the bulk update. To specify a Field, click on the [Field] control in the Node. You can set the value of the following Fields: 1. Fields in an Edit Screen of the current Entity. 2. System Fields of the current Entity. 3. Unique ID of an Entity holding a Relation to the current Entity.

© 2009 Wolf Platform as a Service All rights reserved.

Page 136

WOLF User Guide version 1.3 2009

To specify a Field’s value, click on the [Field, Variable or Constant] control in the Node. You can choose a value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Fields or System Fields of an Entity holding a Relation with the current Entity. 4. Context variables that relate to the state of the current execution. 5. Session Fields 6. The Enter text control allows you to specify a text input.

Click on the arrow next to the “Set a Field’s value” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

© 2009 Wolf Platform as a Service All rights reserved.

Page 137

WOLF User Guide version 1.3 2009

9.5.7 The “Perform an Advanced Search” Action The “Perform an Advanced Search” Action is used to return tabular data to Reports, Search Screens and Dashboard Widgets. The primary difference between this and the “For-each record of [Entity]” Action is that no additional Actions can be specified in the body of this Action. Hence, no manipulations can be performed on the tabular data returned by this Action. The figure below shows the basic structure of this Action:

The following Nodes in the “Perform an Advanced Search” and the “For-each record of [Entity]” Action are identical in structure, functionality and available options: 1. The “Columns” Node and its Sub Nodes 2. The “Record Selection Filter” Node and its Sub Nodes a. The “No. of records” Node b. The “Ignore Entity Privilege Filters” Node c. The “Where the following apply” Node and its Sub Nodes used for specifying a logical condition 3. The “Group By” Node and its Sub Nodes 4. The “Sort matching records in the following order” Node and its Sub Nodes Please refer to the “For-each record of [Entity]”Action for a detailed explanation of these Nodes and their functionality. © 2009 Wolf Platform as a Service All rights reserved.

Page 138

WOLF User Guide version 1.3 2009

We will consider only those Nodes which are unique to the “Perform an Advanced Search” Action. 9.5.7.1 The “Get records from Entity” Node The “Get records from Entity” Node is the top level Node in the “Perform an Advanced Search” Action. This Node allows you to specify the Entity which this Action will operate upon. All the Nodes and controls in the Action will adjust themselves automatically based on the selected Entity. To specify an Entity for this Action, click on the [Entity] control in the “Get records from Entity” Node. A drop-down list of all the Entities in the Application appears. Click on the appropriate Entity. Click on the arrow next to the “For” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

9.5.7.2 The “Write the output to a Combo file with the name (optional): Combo name” Node This Node allows you to create a drop-down Field of your choice and assign a name to it. This name can then be referenced from the “Selectable From” property of any Field. This is an advanced feature and only used for some advanced workarounds. Its use is not recommended.

© 2009 Wolf Platform as a Service All rights reserved.

Page 139

WOLF User Guide version 1.3 2009

9.5.8 Set Temporary Value This is a set of Actions that allow you to set a temporary value in the Business Rule using different methods. These temporary values can then be accessed by the current Business Rule and optionally by other Business Rules for assignment, data manipulation, etc. These are several methods for setting a temporary value. We will consider each of them individually in turn. Setting the Variable Name This step is common while setting any temporary value and we will consider it individually. The first step while setting a temporary value is to choose the variable to which you want to assign a value. This may be an existing variable in your Application or you can create a new variable. Click on the [Variable Name] control. A drop-down appears with the following options: 1. Temporary Values: Use this option to assign a value to an existing variable of your Application. The existing variables will appear in the drop-down list. Click on a variable name to use it. 2. Constant: Use this option to create a new variable in your Application. Clicking on the [Constant] button opens a popup with a textbox in which you can specify the variable name.

Options for the “Set the value of” Node All the Actions under the “Set Temporary Value” category contain a “Set the value of” Node as the top level Node. Click on the arrow next to the “Set the value of” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node These options are common to all the Actions under the “Set Temporary Value” category.

© 2009 Wolf Platform as a Service All rights reserved.

Page 140

WOLF User Guide version 1.3 2009

9.5.8.1 Through assignment This is the simplest method for setting a temporary value. This method assigns a value to a variable in your Application through direct assignment. The figure below shows the basic structure of this Action:

Setting the value of the variable: To assign a value to the variable, click on the [Field, Variable or Constant] control in the Node. You can choose a value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Fields or System Fields of an Entity holding a Relation with the current Entity. 4. Context variables that relate to the state of the current execution. 5. Session Fields 6. The Enter text control allows you to specify a text input.

For example, we may want to initialize a variable with some text in a Business Rule. The Action will appear as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 141

WOLF User Guide version 1.3 2009

9.5.8.2 By Concatenation of multiple values This method concatenates the data from one or more sources and assigns it to a variable. The data source may be a Field, variable or a constant in the Application. The figure below shows the basic structure of this Action:

Setting the value of the variable: Adding a data source: the “Concatenate the following” Node As the value is obtained by concatenating the data from multiple sources, we will need to specify each data source individually. By default, this Action consists of a single data source. To specify an additional source, click on the arrow next to the “Concatenate the following” Node and select Concatenate with… The figure below shows how the Action appears on adding an additional data source:

Tip: You can add multiple data sources to this Action. The data from every source is concatenated to generate the value assigned to the variable.

Click on the arrow next to the “Concatenate the following” Node to see the list of available options: 1. Concatenate with… 2. Move current node up 3. Move current node down 4. Delete current node © 2009 Wolf Platform as a Service All rights reserved.

Page 142

WOLF User Guide version 1.3 2009

Specifying the data source: the “Field, Variable or Constant” Node Click on the [Field, Variable or Constant] control. You can choose a value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Fields or System Fields of an Entity holding a Relation with the current Entity. 4. Context variables that relate to the state of the current execution. 5. Session Fields 6. The Enter text control allows you to specify a text input.

Click on the arrow next to the “Field, Variable or Constant” Node to see the list of available options: 1. Concatenate with… 2. Move current node up 3. Move current node down 4. Delete current node

For example, you want to raise an alert message of the form “Name Age” (For example: “James 18”) every time a record is saved in the “Contact” Entity. The sample Business Rule is as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 143

WOLF User Guide version 1.3 2009

© 2009 Wolf Platform as a Service All rights reserved.

Page 144

WOLF User Guide version 1.3 2009

It is important to note that the order of the data sources under the “Concatenate the following “ Node plays a crucial role in deciding the output of this Action. Considering the sample Business Rule above, the temporary value is obtained by concatenating the value from the data sources in the following order: 1. Name (A Field in the Contact Entity) 2. “ ” (Blank space as a text input) 3. Age ( A Field in the Contact Entity) Any change in the order of the data sources will have a corresponding effect on the resultant temporary value.

9.5.8.3 By calculating the difference between two dates This Action evaluates the difference between two dates in days or months and assigns the value to a variable. The figure below shows the basic structure of this Action:

Setting the value of the variable: To assign a value to the variable, you need to specify two dates and an additional control that specifies whether you require the difference between these dates in days or months. To specify the first date, click on the [Date1] control. You can choose the date from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule and contains a date value. You can also specify a Date using [Constant]. 2. Date Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. The Context control has variables that relate to the state of the current execution.

© 2009 Wolf Platform as a Service All rights reserved.

Page 145

WOLF User Guide version 1.3 2009

4. Session Fields of the Application that possess a date value. 5. The Enter date control opens a popup allowing you to specify a date.

To specify the second date, click on the [Date2] control. The values in the drop-down list are similar to those for the [Date1] control. Click on the [Days/Months] control to specify whether the difference between the two dates is in days or months. A drop-down appears with the following values: 1. Days 2. Months Click on the appropriate option.

9.5.8.4 By Adding days to an existing date This Action generates a date value by adding a specific number of days to an existing date and then assigns this date value to a variable. The figure below shows the basic structure of this Action:

Setting the value of the variable: To assign a value to the variable, you need to specify a date and the number of days to be added to this date. To specify the number of days to be added, click on the [Number] control. You can choose a number from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number using [Constant]. 2. Numerical Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. © 2009 Wolf Platform as a Service All rights reserved.

Page 146

WOLF User Guide version 1.3 2009

3. The Context control has variables that relate to the state of the current execution. 4. Session Fields of the Application that possess a numerical value. 5. The Enter number control opens a popup allowing you to specify a numerical value.

To specify the date, click on the [Date] control. The values in the drop-down list are similar to those for the [Date1] and [Date2] controls of the “By calculating the difference between two dates” Action. Choose an appropriate date from the drop-down list.

9.5.8.5 By comparing two dates This Action compares the two date values specified in the Action and assigns a value to the variable based on this comparison. The figure below shows the basic structure of this Action:

A value is assigned to the variable based on the following criteria: 1. If Date1 < Date2 then the value assigned = -1 2. If Date1 = Date2 then the value assigned = 0 3. If Date1 > Date2 then the value assigned = +1

Setting the value of the variable: To specify the two dates, click on the [Date1] or [Date2] control. The values in the drop-down list are similar to those for the [Date1] and [Date2] controls of the “By calculating the difference between two dates” Action. Choose an appropriate date from the drop-down list.

© 2009 Wolf Platform as a Service All rights reserved.

Page 147

WOLF User Guide version 1.3 2009

9.5.8.6 By extracting info. from a date This Action extracts information from a date value and assigns it to a variable. The figure below shows the basic structure of this Action:

Setting the value of the variable: The first step is to decide the information to be extracted from the date. Clicking on the [info.] control presents a drop-down list of information that can be extracted from a date value:

Most of this information that can be extracted from a date value is self-explanatory. The “A Universal Display Format” displays the date in the format “DD - Month name – YYYY”. The second step is to choose the date value or Field from which the information will be extracted. To specify a date, click on the [Field or Variable] control. The values in the drop-down list are similar to those for the [Date1] and [Date2] controls of the “By calculating the difference between two dates” Action. Choose an appropriate date from the drop-down list. For example, we want to determine the day of the week from a Date. The sample Business Rule will look as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 148

WOLF User Guide version 1.3 2009

9.5.8.7 By performing a math operation This Action performs a mathematical operation and assigns the value to a variable. The figure below shows the basic structure of this Action:

Setting the value of the variable: Performing mathematical operations within a group: By default, the “By performing a math operation” Action consists of a single group inside it:

To specify a number anywhere in the mathematical operation, click on the [Number] control. You can choose a number from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number using [Constant]. 2. Numerical Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. The Context control has variables that relate to the state of the current execution. 4. Session Fields of the Application that possess a numerical value. 5. The Enter number control opens a popup allowing you to specify a numerical value.

© 2009 Wolf Platform as a Service All rights reserved.

Page 149

WOLF User Guide version 1.3 2009

To choose an operation between two numbers anywhere in this Action, click on the [Operation] control. You can choose an operation from one of the following: 1. Addition (+) 2. Subtraction (-) 3. Division (/) 4. Multiplication (*) For example, if we want to add the numbers 105 and 217, the sample Action will appear as shown below:

Click on the arrow next to the “Group” Node to see the list of available options: 1. Add a New Operation: allows you to specify an additional mathematical operation inside the group 2. Add a New Group: allows you to create a new group inside the group To specify multiple mathematical operations within a group, click on the arrow next to the “Group” Node and the select Add a New Operation. The new operation appears as shown below:

Tip: You can perform multiple mathematical operations within a group.

© 2009 Wolf Platform as a Service All rights reserved.

Page 150

WOLF User Guide version 1.3 2009

Click on the arrow next to the “Operation Number” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node It is important to note that the order of the mathematical operations and groups plays a crucial role in deciding the output of this Action. Adding a Group: To create a group inside an existing group, click on the arrow next to the “Group” Node and the select Add a New Group. The new group appears as shown below:

The [Operation] control in the “Operation Group” Node of the new group is used to specify the kind of operations occurring between the current group and the number directly above it. Click on the arrow next to the “Operation Group” Node to see the list of available options: 1. Add a New Operation 2. Add a New Group 3. Move current node up 4. Move current node down 5. Delete current node Tip: You can create multiple groups inside the “By performing a math operation” Action.

© 2009 Wolf Platform as a Service All rights reserved.

Page 151

WOLF User Guide version 1.3 2009

9.5.8.8 By Appending a row to it This Action is used to return tabular data as a response from the Business Rule. It allows you to return date from a Field, temporary variable or constant as a part of the tabular data. This Action is different in structure from the preceding “Set Temporary Value” Actions and we will consider it individually. The figure below shows the basic structure of this Action:

Setting the Variable Name: Click on the [Variable Name] control. A drop-down appears with the following options: 1. Temporary Values: Use this option to assign a value to an existing variable of your Application. The existing variables will appear in the drop-down list. Click on a variable name to use it. 2. Constant: Use this option to create a new variable in your Application. Clicking on the [Constant] button opens a popup with a textbox in which you can specify the variable name. Options for the “Append a row to” Node: Click on the arrow next to the Node to see the list of available options: 1. Set a Column’s value 2. Move current node up 3. Move current node down 4. Delete current node Structuring the tabular data to be returned by the Action: As already mentioned, this Action is used to return tabular data as a response from the Business Rule. The structure of the tabular data to be returned is defined under the “Append a row to Variable Name” Node. To set a column for the table, click on the arrow next to the “Append a row to Variable Name” Node and then select Set a Column’s value. The figure below shows how the Action appears on adding a column:

© 2009 Wolf Platform as a Service All rights reserved.

Page 152

WOLF User Guide version 1.3 2009

Click on the [Column] control to provide a name for the column. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the name of the Column. The next step is to select a data source for the column. Click on the [Field, Variable or Constant] control to specify a data source. You can choose the data source from the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 4. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 5. The Enter text control allows you to specify a text input. Once the data source is set for the column, its data is returned as a response by the Action in a tabular format. Note: The “Include a Response” Action is used to return the tabular data from this Action as a response.

Let’s consider we want to obtain the list of contacts above the age of 21 from the Contact Entity. We will use the following Actions to achieve our objective: 1. “For-each record of [Entity]” Action 2. “By Appending a row to it” Action 3. “Include a Response” Action

© 2009 Wolf Platform as a Service All rights reserved.

Page 153

WOLF User Guide version 1.3 2009

The sample Business Rule is as shown below:

Explanation of the Business Rule: 1. The “For-each record of [Entity]” Action iterates through the list of records in the Contact Entity and selects those records where Age is greater than 21. 2. The “By Appending a row to it” Action is placed inside the body of the “For-each record of [Entity]” Action. The Name, Age and date of birth of each selected Contact record are appended as a row to the tabular data contained inside the “var_response” variable. 3. The “Include a Response” Action is placed outside the body of the “For-each record of [Entity]” Action. Once the iterations of the “For-each record of [Entity]” Action are complete, it returns the “var_response” variable as a response from the Business Rule. This Business Rule can then be linked to a Search Screen, Report or Chart that can utilize this tabular data.

© 2009 Wolf Platform as a Service All rights reserved.

Page 154

WOLF User Guide version 1.3 2009

9.5.8.9 By Making a Query Expression Similar to the “By Appending a row to it” Action, this Action is used to return tabular data as a response from the Business Rule. The difference being that this Action formulates the tabular data by performing a query to the Application database. The figure below shows the basic structure of this Action:

Structuring the tabular data to be returned by the Action: From the structure of the Action, it is apparent that this Action performs a query and subsequently formulates the tabular data by using a subset of the “Perform an Advanced Search” Action. Please refer to the “Perform an Advanced Search” Action for a detailed explanation of the Nodes and their functionality.

Note: The “Include a Response” Action is used to return the tabular data from this Action as a response.

© 2009 Wolf Platform as a Service All rights reserved.

Page 155

WOLF User Guide version 1.3 2009

9.5.8.10 By Performing an Advanced Search Similar to the “By Appending a row to it” Action, this Action is used to return tabular data as a response from the Business Rule. The difference being that this Action formulates the tabular data by performing an advanced Search. The figure below shows the basic structure of this Action:

Structuring the tabular data to be returned by the Action: From the structure of the Action, it is apparent that this Action formulates the tabular data by using the “Perform an Advanced Search” Action. Please refer to the “Perform an Advanced Search” Action for a detailed explanation of these Nodes and their functionality.

Note: The “Include a Response” Action is used to return the tabular data from this Action as a response.

© 2009 Wolf Platform as a Service All rights reserved.

Page 156

WOLF User Guide version 1.3 2009

9.5.9 The “Include a Response” Action This Action is used to return a response from the Business Rule. This response may be a Field, Variable or a Constant in the Application. The “Include a Response” Action is often used in conjunction with the following “Set Temporary Value” Actions to return tabular data from a Business Rule: 1. By Appending a row to it 2. By Making a Query Expression 3. By Performing an Advanced Search The figure below shows the basic structure of this Action:

Setting the response to be returned by the Business Rule: This is an important step in which we decide what data will be returned in the response. To set the response to be returned by the Business Rule, click on the [Field, Variable or Constant] control in the Action. You can choose a response from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to specify a text input.

© 2009 Wolf Platform as a Service All rights reserved.

Page 157

WOLF User Guide version 1.3 2009

Assigning a name to the response: The next step is to assign a name to this response. This name helps you to identify the response from the Business Rule in other parts of the Application such as Reports, Search Screens, etc. Click on the [Constant] control to provide a name for the response. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify a name for the response. Please see the “9.5.8.7 By Appending a row to it” Section for a practical example of using this Action. Click on the arrow next to the Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

9.5.10 The “Include a Comment” Action This Action can be used for inserting comments in your Business Rule. These comments serve as a guideline while working with the Business Rule. The figure below shows the basic structure of this Action:

Click on the [Comment] control to add a comment. . A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can add the text of your comment. The figure below shows a Business Rule with a comment.

You may add as many comments as required in a Business Rule. Click on the arrow next to the Comment Node to see the list of available options: © 2009 Wolf Platform as a Service All rights reserved.

Page 158

WOLF User Guide version 1.3 2009

1. Move current node up 2. Move current node down 3. Delete current node

9.5.11 The “Call” Actions The “Call” Actions enable your Business Rule to communicate with external software systems or other Business Rules in the Application. The “Call” Actions are of three types: 1. Web: Used to call a GET, POST or a SOAP web request from the current Business Rule. 2. Business Rule: Used to call another Business Rule from the current Business Rule. 3. A .NET Assembly: Used to call a .NET assembly from the current Business Rule. In addition to these methods, Wolf Applications have several other methods of interacting with each other as well as other external software systems.

9.5.11.1 The Web Request “Call” Actions Wolf allows you to call web requests of the following types: 1. GET Request 2. POST Request 3. SOAP Request

For a detailed understanding of HTTP and the Web requests concepts please refer to: 1.

http://en.wikipedia.org/wiki/HTTP

2.

http://www.jmarshall.com/easy/http/#resources

3.

http://www.w3.org/Protocols/

© 2009 Wolf Platform as a Service All rights reserved.

Page 159

WOLF User Guide version 1.3 2009

9.5.11.1.1 The GET Request The Action for calling the GET Web Request has the following basic structure:

Click on the arrow next to the Request Node to see the list of available options: 1. Include Parameter 2. Move current node up 3. Move current node down 4. Delete current node Specifying the URL of the GET request: Click on the [URL] control to specify the path of the requested resource. You can choose the resource URL from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to specify a text input.

© 2009 Wolf Platform as a Service All rights reserved.

Page 160

WOLF User Guide version 1.3 2009

Including a parameter in the GET request: To include an extra parameter in the GET request, Click on the arrow next to the Request Node and then select Include Parameter. The GET Request with an additional parameter appears as shown below:

Click on the [Field, Variable or Constant] control to specify the parameter field from your Application. The options for specifying a parameter field are identical to those of choosing the URL for the GET Request. Click on the [Parameter] control to specify the extra parameter. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the extra parameter. Tip: You can include multiple parameters in the GET Request.

Click on the arrow next to the parameter Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

9.5.11.1.2 The POST Request The Action for calling the POST Web Request has the following basic structure:

The method for Specifying the URL and including a parameter in the POST request are identical to those for a GET request. In addition to this, the options for the nodes and sub-nodes are similar for the two requests. Please refer to the “9.5.11.1.1 The GET Request” for a detailed understanding of these.

© 2009 Wolf Platform as a Service All rights reserved.

Page 161

WOLF User Guide version 1.3 2009

9.5.11.1.3 The SOAP Request The Action for calling the SOAP Web Request has the following basic structure:

The options for the Request Node are similar to those of the GET request. Specifying the URL of the SOAP request: The process of specifying the URL for the SOAP request is identical to that of the GET request. Specifying the Namespace to be used: To specify a namespace for the SOAP request, click on the [Name Space] control. The options for specifying a namespace are identical to those for choosing the URL for the GET Request. Specifying the Web Method to be invoked: To specify the web method to be invoked for the SOAP request, click on the [Web Method Name] control. The options for specifying a web method are identical to those for choosing the URL for the GET Request. Including a parameter in the SOAP request: The process of including a parameter for the SOAP request is identical to that of the GET request. Please refer to the “9.5.11.1.1 The GET Request” for a detailed understanding of concepts.

© 2009 Wolf Platform as a Service All rights reserved.

Page 162

WOLF User Guide version 1.3 2009

9.5.11.2 The Business Rule “Call” Actions These Actions allow you to call or process a Business Rule inside the current Business Rule. The called Business Rule maybe a part of the same or another Wolf Application. As already mentioned, there can only be a single “On Save Business Rule” and any number of Unspecified Business Rules acting on an Entity. A conditional chain of further calls can be established from the “On Save Business Rule”. The Business Rule “Call” Actions are of two types: 1. With Current Context 2. With New Context A Business Rule with the current context is more commonly used when calling a Business Rule. As already mentioned, a Business Rule is always applied to an Entity. When you make a call to another Business Rule, you establish two sides of the call: the calling Business Rule (caller) and the called Business Rule (callee). Mostly the caller and the callee are applied to the same Entity in context. A Context holds some more information about the call which is made to the Business Rule during execution.

Entity Related Information: forms the basis of the context. All Temporary Values & Session information: User related information. In some cases the callee Business Rule is applied to a different Entity. Since the Entity is the most important bit in the context and is now required to be changed, it is called in a different context. Let’s take an example. In the case of an “Order Form” with “Order details”, you could be first running a Business Rule on “Order Form” but also need to run another Business Rule on each of the Associated “Order Details”. In this case you would loop through Entity records and change the context for the callee to “Order Details”. While changing context, remember that none of the temporary values created in the caller Business Rule will be available in the callee Business Rule. Make sure you send them as parameters if you need to work them in the callee Business Rule. The Last one to be aware of is Session Values. When calling a Business Rule you can change the identity of the caller. This might be required because of access restrictions. This is also used for cross Application calls. Since the context in the callee Business Rule is new, it is important to remember that none of the temporary values created there can be accessed in the caller Business Rule. To return information you must use the “Include a Response” Action. The returned response can then be used in the caller as a constant by prefixing the name with the name of the Business rule and an underscore as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 163

WOLF User Guide version 1.3 2009

Callee Business Rule Name = Process Order Details Temporary value in Callee = Success

Caller Business Rule = Process Order Form Access the response from the callee using constant = Process Order Details_Success

9.5.11.2.1 Calling a Business Rule with Current context This Action has the following basic structure:

Click on the arrow next to the “Process Business Rule” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node Specifying the callee Business Rule: Click on the [Rule Name] control to specify the callee Business Rule name. A drop-down listing the Business Rules of your Application appears. Click on a Business Rule to specify it as the callee Business Rule. Additionally, the drop-down list also contains the [Constant] control that allows you to specify a callee Business Rule name.

© 2009 Wolf Platform as a Service All rights reserved.

Page 164

WOLF User Guide version 1.3 2009

9.5.11.2.2 Calling a Business Rule with New context This Action has the following basic structure:

Click on the arrow next to the “Process Business Rule” Node to see the list of available options: 1. Pass a variable 2. Move current node up 3. Move current node down 4. Delete current node

Passing a variable to the callee Business Rule: To pass a variable or temporary value to the callee Business Rule, click on the arrow next to the “Process Business Rule” Node and then select Pass a variable.

To specify the name of the variable or temporary value being passed, click on the [Variable Name] control. You can choose the variable name from the following:

© 2009 Wolf Platform as a Service All rights reserved.

Page 165

WOLF User Guide version 1.3 2009

1. A Temporary Value accessible in the called Business Rule. This could be a variable or a constant defined inside the Business Rule. 2. The Constant option allows you to specify the variable name in a text box. Tip: You can pass multiple variables to the callee Business Rule. Click on the arrow next to the “Pass the variable” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

Specifying the callee Business Rule: Click on the [Rule Name] control to specify the callee Business Rule name. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the name of the callee Business Rule. Specifying the Context: Click on the [Context] control to specify the Context for the Business Rule cal. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the Context.

Specifying the identity or User credentials of the callee Business Rule’s Application: The Sub Nodes of the “With Identity” Node allow you to specify the following key details of the callee Business Rule’s Application: a. User Name b. Password c. Solution

© 2009 Wolf Platform as a Service All rights reserved.

Page 166

WOLF User Guide version 1.3 2009

Specifying the User Name: Click on the [User] control to specify the User Name. You can choose a value from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Fields or System Fields of an Entity holding a Relation with the current Entity. 4. Context variables that relate to the state of the current execution. 5. Session Fields 6. The Enter text control allows you to specify a text input. Specifying the Password: Click on the [Password] control to specify the Password. The options for choosing the password are similar to that of the [User] control. Specifying the Solution: Click on the [Solution] control to specify the Solution or Application ID. The options for choosing the solution are similar to that of the [User] control. Note: The AccountID_ApplicationID is the unique identifier of an Application/Solution. For instance: 123DDDD_a131 is the unique identifier for an Application with the Account ID as 123DDDD and the Application ID as a131.

© 2009 Wolf Platform as a Service All rights reserved.

Page 167

WOLF User Guide version 1.3 2009

9.5.11.3 The .NET Assembly “Call” Action This Action is used to call a .NET Assembly inside the current Business Rule. For a detailed understanding of a .NET Assembly and its concepts please refer to: http://en.wikipedia.org/wiki/.NET_assembly The Action for calling a .NET Assembly has the following basic structure:

Click on the arrow next to the “Call .NET Assembly” Node to see the list of available options: 5. Move current node up 6. Move current node down 7. Delete current node

Specifying the Assembly Name: Click on the [Assembly] control to specify the Assembly Name. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the Assembly Name. Specifying the Class Name: Click on the [Class] control to specify the Class Name. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the Class Name. Specifying the Method Name: Click on the [Method] control to specify the Method Name. A drop-down list appears with the text [Constant]. Click on the [Constant] button. A popup appears with a textbox in which you can specify the Method Name.

© 2009 Wolf Platform as a Service All rights reserved.

Page 168

WOLF User Guide version 1.3 2009

9.5.12 The “Send an email” Action This Action allows you to compose an email message and send it to single or multiple recipients. The figure below shows the basic structure of the Action:

Click on the arrow next to the “Send email” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node Setting the sender’s email-id: To set the sender’s email-id, click on the [Send from email-id] control. You can choose the sender’s email-id from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time.

© 2009 Wolf Platform as a Service All rights reserved.

Page 169

WOLF User Guide version 1.3 2009

5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to specify a text input. Specifying the mail recipient(s): To specify the mail recipient(s), click on the [Mail recipient(s)] control. The options for specifying the recipient(s) are identical to those for choosing the sender’s email-id. To specify multiple email recipient(s), click on the Enter text control in the drop-down list. A textbox appears in which you can specify multiple email-ids separated by semicolons “;”. Specifying the mail subject: To specify the mail subject, click on the [Mail Subject] control. The options for specifying the subject are identical to those for choosing the sender’s email-id. Specifying the mail body: To specify the mail body, click on the [Mail body] control. The options for specifying the body are identical to those for choosing the sender’s email-id. Specifying the mail format: You can send an email in two formats: 1. HTML: Used to compose a message using HTML. The HTML tags will be processed by the Business Rule while composing the email. 2. Plain text: Used to compose a message in plain text. The HTML tags will be ignored in this format and will be displayed as-is. To specify the mail format, click on the [HTML / Plain text] control. A drop-down appears with the following options: 1. HTML 2. Text Click on the appropriate option. Tip: You can use HTML formatting in the email message by choosing the Mail Format as HTML.

© 2009 Wolf Platform as a Service All rights reserved.

Page 170

WOLF User Guide version 1.3 2009

9.5.13 The “Raise alert message” Action This Action is used to raise an alert message in the Application. It allows you to specify a custom message in the alert popup. The figure below shows the basic structure of the Action:

Click on the arrow next to the “Raise Alert” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node Specifying a custom alert message: To specify a custom alert message, click on the [Message] control. You can choose the text for the message from one of the following: 1. A Temporary Value accessible in the Business Rule. This could be a variable or a constant defined inside the Business Rule or another Business Rule. You can also specify a number or a user defined variable using [Constant]. 2. Fields or System Fields of an Entity. The Entity in the current context is the one which the Business Rule is acting upon. 3. Field or System Fields of an Entity holding a Relation with the current Entity. 4. The Context control has variables that relate to the state of the current execution. It is different from the Session Fields as in the session has information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. The context is more specific to information during the execution of the Business Rule, i.e., new or existing record, Date and Time. 5. The Session Fields contain information about the current login instance. For example, User Logged In, Users Folder, Browser IP, etc. are Session Fields. 6. The Enter text control allows you to specify a text input.

© 2009 Wolf Platform as a Service All rights reserved.

Page 171

WOLF User Guide version 1.3 2009

This Action plays a useful role in debugging an Application. It is important to remember that, the Business Rule/Application will continue its normal flow after raising an alert message. Tip: The “Raise alert message” Action is useful for debugging your Application.

9.5.14 The “Raise error message” Action This Action is used to raise an error message in the Application. It allows you to specify a custom message in the error popup. The difference between this Action and the “Raise alert message” Action is that the Application stop executing after raising an error message. The figure below shows the basic structure of the Action:

Click on the arrow next to the “Raise Error” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node Specifying a custom error message: To specify a custom error message, click on the [Message] control. The options for specifying the error message are identical to those for the “Raise alert message” Action. This Action plays a useful role in debugging an Application. Tip: The “Raise error message” Action is useful for debugging your Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 172

WOLF User Guide version 1.3 2009

9.5.15 The “Exit Business Rule” Action This Action, when encountered, terminates the execution of the current Business Rule. The figure below shows the basic structure of the Action:

Click on the arrow next to the “Exit” Node to see the list of available options: 1. Move current node up 2. Move current node down 3. Delete current node

© 2009 Wolf Platform as a Service All rights reserved.

Page 173

WOLF User Guide version 1.3 2009

9.6 Actions on a Business Rule To view the actions possible on a Business Rule, right click on the Business Rule Node in the Solution Explorer.

The Save and Publish buttons enable you to Save/Publish changes made to a Business Rule. Clicking the Close button enables you to close the working session with the current Business Rule. Click the Delete button to remove the current Business Rule from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 174

WOLF User Guide version 1.3 2009

9.7 Editing an existing Business Rule There are several ways of managing an existing Business Rule of an Application. Using any of the methods mentioned below opens a popup listing the existing Business Rules of an Application. Choose the appropriate Rule and then click the Open button in the popup to start working with the Rule. From the Designer Home You can manage an existing Navigation Item by clicking on the Edit a previously created Navigation Item button in the Designer Home.

From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Business Rules. From the Solution Explorer Right click on the Application Node, select Open and then select Existing Business Rules.

9.8 Deleting a Business Rule To delete a Business Rule, right click on the Business Rule and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Business Rule. Caution: Deleting a Business Rule will remove it permanently from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 175

WOLF User Guide version 1.3 2009

10. Working with Reports 10.1 Overview of Reports Define analytics and build unique reports using the Wolf Reporting Designer. You can build intelligence into your Application and draw insights from data by creating analytical reports. View the Reports as HTML views or embed these Reports to make advanced dashboard items as part of a HTML page. A Report is an analytical expression designed using a Business Rule and presented using the Wolf Report template. Reports can be configured for representation of data in different formats.

Important points to remember while designing a Report: 1. Any Report created or any changes made to an existing Report in the Designer will only reflect in the Run environment of the Application. 2. The data source for a Report is a Business Rule. This Business Rule must return data in a tabular format. 3. As the Report essentially displays Application data, if there is no data in the Application the Report will not display any data. 4. The Report must be linked to a Navigation Item in order to make it accessible to Roles/Users of an Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 176

WOLF User Guide version 1.3 2009

The figure shows how a complete Report will appear to a User in the Run Environment.

It is important to note that a Report need not necessarily consist of all the components shown in the figure. For example, the simplest Report may consist of a Report title and a single Group inside it.

© 2009 Wolf Platform as a Service All rights reserved.

Page 177

WOLF User Guide version 1.3 2009

10.2 Adding a new Report There are several ways of creating a new Report in an Application. From the Designer Home You can create a new Report by clicking on the Design a New Report button in the Designer Home.

From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Report. From the Solution Explorer Right click on the Application Node, select New and then select New Report.

A new Report has the structure shown in the figure below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 178

WOLF User Guide version 1.3 2009

Options for the Report Node: Right click on the Report Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Report. Clicking the Close button enables you to close the working session with the current Report. Click the Delete button to remove the current Report from the Application.

10.3 Basic Report Properties Let’s first take a look at the basic properties of a Report.

Property

Description

Misc Report Name (*)

Provide a meaningful name to the Report. You will use this name every time you refer to this Report. For example, while assigning the Report to a Navigation Item.

Note: The Report Name is a mandatory property as it has been marked with a “*”.Every Report must have a unique Report Name.

© 2009 Wolf Platform as a Service All rights reserved.

Page 179

WOLF User Guide version 1.3 2009

10.4 Data Source for a Report Every Report in an Application consists of a data source. This is the most important step while designing a Report for your Application as the Report’s output and design are dependent on the data source. The data source for a Report is a Business Rule or a response returned from a Business Rule. It is important to remember that, the Business Rule that acts as a data source must return data in a tabular format. To specify a data source for a Report, click on the “DataSource” Node of the Report. The Properties section will appear as shown below:

The Business Rule or the response from a Business Rule that acts as a data source for the Report needs to be specified in the “Business Rule” property. This can be done as follows: Step 1: Click on the “Business Rule” property in the Properties Section and press F2 to edit the property. Step 2: Click the ellipsis button to make a selection.

© 2009 Wolf Platform as a Service All rights reserved.

Page 180

WOLF User Guide version 1.3 2009

Step 3: A popup appears listing the Business Rules of your Application that return tabular data. In the popup, expanding the Business Rules Node shows a list of the Business Rules which you can utilize. Choose the appropriate Business Rule/response from a Business Rule and then click on the Open button.

© 2009 Wolf Platform as a Service All rights reserved.

Page 181

WOLF User Guide version 1.3 2009

Step 4: Press Enter to finalize these changes. Press Publish. We have successfully linked the Report to a Business Rule. Let’s consider we are designing a Report that gives the information of all contacts in the Contact Entity with age greater than or equal to 21. The data source for the Report can be a Business Rule or a response returned from a Business Rule. We will achieve our objective using a Business Rule without a response as well as a Business Rule that returns a response. Example 1: Business Rule (without a response) used as a data source for the Report:

The “Sample Business Rule” will be used as a data source for the Report. Note: 1. The data source for a Report can be a Business Rule or a response returned from a Business Rule. 2. The Business Rule that acts as a data source for the Report plays a key role in deciding the output and design of the Report. The options for the other nodes in a Report will be generated based on this selection.

© 2009 Wolf Platform as a Service All rights reserved.

Page 182

WOLF User Guide version 1.3 2009

Example 2: Business Rule with a response used as a data source for the Report:

The response “var_response” from the “Demo Business Rule” will be used as a data source for the Report. Tip: A Business Rule with a response is usually used when we need to perform certain calculations on the Entity data and use this calculated data in the Report.

© 2009 Wolf Platform as a Service All rights reserved.

Page 183

WOLF User Guide version 1.3 2009

Options for the Data Source Node: Right click on the Data Source Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made while selecting a data source.

10.5 Designing your Report You can start designing the layout of your Report from the “Design” Node.

Options for the Design Node: Right click on the Design Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Design of the Report.

Tip: The data source of the Report plays a key role in deciding its output and design. The options for the Nodes under the “Design” Node of a Report will be generated based on this selection.

© 2009 Wolf Platform as a Service All rights reserved.

Page 184

WOLF User Guide version 1.3 2009

10.5.1 Specifying a header and footer for a Report The “Report” Node can be used for specifying a header and footer for your Report. To add a header/footer for a Report, right click on the “Report” Node, select New and then choose a Header/Footer.

Specifying the data for the Report header/footer: The data for the Report header/footer is obtained as a response from a Business Rule. However, it is important to note that the response from the Business Rule should not contain tabular data. For example, a Report header maybe of the form: “Contacts with age greater than or equal to 21” Similarly, Report footer maybe of the form: “Summary: Total No. of Contacts: 30 Contacts above the age of 21: 12”

We will consider a practical example of creating a Report header and footer at the end of this section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 185

WOLF User Guide version 1.3 2009

To process of specifying the data for the Report header and footer is similar. We will consider the example of the Report header. Step 1: To add a header for a Report, right click on the “Report” Node, select New and then choose Header. Step 2: Click on the “Header” Node in the Solution Explorer. Click on the “Report Header” property in the Properties section, press F2 to edit the property and click the ellipsis button to make a selection. Step 3: A popup appears listing the Business Rules of your Application that return a response. Expand the Business Rules Node in the popup to see the list. It is important choose a response that does not return tabular data. Choose the appropriate response from a Business Rule and then click on the Open button.

Step 4: Press Enter to finalize these changes. Press Publish. We have successfully linked the Report header to a Business Rule response. A similar process is used for adding footer to the Report. It is important to note that, the Report header and footer will be displayed only once in the Report. © 2009 Wolf Platform as a Service All rights reserved.

Page 186

WOLF User Guide version 1.3 2009

Let’s consider we want a Report of all the contacts in the Contact Entity with the contact’s age greater than or equal to 21. Also, the Report header should contain the text: “Contacts above the age of 21” and the Report footer should contain a summary of the form: “Total Contacts with age above 21 years: [Number]”. The sample Business Rule for the Report is as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 187

WOLF User Guide version 1.3 2009

The “Demo Business Rule” returns three response variables: 1. var_response: A response that will be used as a data source for the Report 2. header_response: A response that will be used for the Report header. 3. var_footer: A response that will be used for the Report footer. Explanation of the Business Rule: 1. The “For-each record of [Entity]” Action iterates through the list of records in the Contact Entity and selects those records where Age is greater than or equal to 21. It further extracts the data from the “Name” and “Age” fields for each of these records. 2. The “By Appending a row to it” Action is placed inside the body of the “For-each record of [Entity]” Action. The Name and Age of each selected Contact record are appended as a row to the tabular data contained inside the “var_response” variable. 3. Additionally, each time a record satisfies the logical condition in the “For-each record of [Entity]” Action, the value of the variable “rec_count” is incremented by 1. The “rec_count” variable will be used in the footer. 4. Once the iterations of the “For-each record of [Entity]” Action are complete, the “Include a Response” Action returns the “var_response” variable as a response from the Business Rule. 5. The “Set Temporary Value through assignment” Action is used to assign text data for the header to the “header_response” variable. The “Include a Response” Action returns the “header_response” variable as a response from the Business Rule. 6. The “Set Temporary Value by concatenation of multiple values” Action is used to compose the text data for the footer by concatenating text data with the “rec_count” variable. The resultant value is assigned to the “var_footer” variable. The “Include a Response” Action returns the “var_footer” variable as a response from the Business Rule.

The responses from the Business Rule are then linked to the appropriate portions of the Report to generate the desired output: 1. var_response: To the “Data Source” of the Report 2. header_response: To the Report header 3. var_footer: To the Report footer © 2009 Wolf Platform as a Service All rights reserved.

Page 188

WOLF User Guide version 1.3 2009

The Report with a header and footer will appear as shown below in the Run environment:

The process for designing the body of the Report is discussed in the subsequent sections. Options for the Header/Footer Node: Right click on the Header/Footer Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Header/Footer of the Report. The Delete button deletes the current Header/Footer. Tip: You can use HTML formatting in the Header/Footer of the Report.

10.5.2 Designing the layout of the Report body You can start designing the layout of a Report from the “Group” Node. In its basic form, the “Group” Node appears as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 189

WOLF User Guide version 1.3 2009

As already mentioned, the Business Rule used as a data source for the Report plays a crucial role in deciding its design and output. The options for the Sub Nodes of the “Group” Node of a Report will be generated based on this selection. A “Group” Node in a Report consists of the following Sub Nodes: 1. Header: A header value for the Group 2. Detail: The body of the Group 3. Footer: A footer value for the Group It is important to note that it is not mandatory to specify the Header and Footer for a Group.

10.5.2.1 Grouping the Report output by a Group Field: It is possible to group the output of a Report by a Group Field. The Group Field is selected from the Fields returned by the data source and the output of the Report will be ordered by this Field. For example, a Report that displays information of contacts can be grouped by the age of the contacts. That is the output of the Report will be divided into Groups with each Group falling under a different age value. Specifying a Group Field: Step 1: To specify a Group Field, click on the “Group” Node in the Solution Explorer. Step 2: Click on the “Group Field” property in the Properties section, press F2 to edit the property and click the ellipsis button to make a selection. Step 3: A popup appears listing the Fields returned by the data source of the Report. Choose the appropriate Field from the list and then click on the Open button.

© 2009 Wolf Platform as a Service All rights reserved.

Page 190

WOLF User Guide version 1.3 2009

Step 4: Press Enter to finalize these changes. Press Publish. We have successfully created a Group Field for the Report. If we consider the example of grouping the Report by the age of the contacts, the Group can then be designed as follows: Group Header: “Age: [Age data]” Group Detail: Name of Contact Group Footer: Count of Contacts Let’s consider there is a single contact with Contact Name as “Mark” and Age as 21, the group will have the following structure: Age: 21 Name of Contact: Mark Count of Contacts: 1

© 2009 Wolf Platform as a Service All rights reserved.

Page 191

WOLF User Guide version 1.3 2009

The Report in the Run environment will appear as shown below:

The figure above illustrates how the Report will appear on using a Group Field and further details the appearance of the Header, Detail and Footer of the Group. Options for the Group Node: Right click on the Group Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Group. Note: It is not mandatory to specify a Group Field. A Group Field is only required when the output of the Report is required to be grouped as per a specified criteria.

© 2009 Wolf Platform as a Service All rights reserved.

Page 192

WOLF User Guide version 1.3 2009

10.5.2.2 Specifying the Group Header: To specify a header for the Group, right click on the “Header” Node, select New and then select the Field which you wish to include as the Group header. The Header Field(s) will be displayed in the following format: [Field Name]: [Field Value]. For example, the Group header will be displayed as “Age: 21” for the Age Field for the group where age=21. The Fields which appear in the New drop-down are those returned by the data source of the Report. You can select multiple Fields as Group Headers.

Options for the Header Node: Right click on the Header Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Group Header. The New option allows you to add a Field as a Group Header. If we consider the example Report in the section “10.5.2.1 Grouping the Report output by a Group Field” where we have grouped the Report output as per the age of the contacts, the header of each Group is the Age Field with the value and the Name of the contact(s) belonging to each Group are displayed in the Group Detail. Note: 1. It is not mandatory to specify a Group Header. A Group Header is normally used in conjunction with a Group Field in the Group Node of the Report or when the Report is filtered by certain criteria. 2. You can select multiple Fields as Group Headers. © 2009 3. Wolf Platform as a Service All rights reserved.

Page 193

WOLF User Guide version 1.3 2009

Properties of the Header Field: As the header Field is displayed in the Report, it is possible to vary its display attributes from the Properties section. Click on the header Field in the Solution Explorer to view the list of properties.

Property

Description

Misc Display Name (*)

The name that will be displayed for this Field in the Group header of the Report. By default, the Display Name is the Field name returned by the data source.

Type

There is different pre-display formatting that happens for different Field types. Leave this blank if you are expecting the data source to return this as an alphanumeric value. You can select the Type from the following: 1. Date 2. Decimal/currency 3. Number 4. Text 5. Yes/No

Width(px)

Display width in pixels. The field occupies the given horizontal width in your Report.

Options for the Header Field: Right click on the Header Field to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Header Field. Use the Delete button to delete the current Header Field. The Move up and Move down buttons can be used to arrange a Header Field with respect to the other Header Fields present in the Group Header.

© 2009 Wolf Platform as a Service All rights reserved.

Page 194

WOLF User Guide version 1.3 2009

10.5.2.3 Specifying the Group Detail: The Group detail constitutes the most important part of the Group, i.e., the Group body. The Fields returned by the data source can be used for designing the Group body. To add a Field to the Group body, right click on the “Detail” Node, select New and then click on a Field to add it.

The Fields which appear in the New drop-down are those returned by the data source of the Report. You can add as many Fields as required to design your Group body. Options for the Detail Node: Right click on the Detail Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Group Detail. The New option allows you to create a New Group or add a Field to the Group Detail. If we consider the example Report in the section “10.5.2.1 Grouping the Report output by a Group Field” the Name Field is displayed in the Group Detail. Note: You can add as many Fields as required to design your Group body.

© 2009 Wolf Platform as a Service All rights reserved.

Page 195

WOLF User Guide version 1.3 2009

Properties of the Detail Field: As the detail Field is displayed in the Report, it is possible to vary its display attributes from the Properties section. Click on the Detail Field in the Solution Explorer to view the list of properties.

Property

Description

Misc Display Name (*)

The name that will be displayed for this Field in the Group Detail of the Report. By default, the Display Name is the Field name returned by the data source.

Type

There is different pre-display formatting that happens for different Field types. Leave this blank if you are expecting the data source to return this as an alphanumeric value. You can select the Type from the following: 1. Date 2. Decimal/currency 3. Number 4. Text 5. Yes/No

Width(px)

Display width in pixels. The field occupies the given horizontal width in your Report.

Options for the Detail Field: Right click on the Detail Field to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Detail Field. Use the Delete button to delete the current Detail Field. The Move up and Move down buttons can be used to arrange a Detail Field with respect to the other Detail Fields present in the Group Detail.

© 2009 Wolf Platform as a Service All rights reserved.

Page 196

WOLF User Guide version 1.3 2009

We will now consider an example of designing a simple Report without using the Group Field, i.e. , the Report output will not be ordered by a Group Field. Let’s consider we want a Report of all the contacts in the Contact Entity with Age greater than or equal to 21. The sample Business Rule that will be used as a data source for the Report is as shown below:

The “Sample Business Rule” simply fetches the data from the “Name” and “Age” Fields for every record in the Contact Entity where “Age” is greater than or equal to 21. We will now consider the design of the “Demo Report”. 1. The “Sample Business Rule” is used as the data source for the Report. 2. The “NameData” and “AgeValue” Fields from the data source are added in the Group Detail of the Report. 3. The display attributes of the Fields are changed to “Contact Name” and “Age” respectively.

© 2009 Wolf Platform as a Service All rights reserved.

Page 197

WOLF User Guide version 1.3 2009

The design of the Report is as shown in figure below:

The Report in the Run environment will appear as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 198

WOLF User Guide version 1.3 2009

10.5.2.4 Specifying the Group Footer: To specify footer for the Group, right click on the “Footer” Node, select New and then select the Field which you wish to include as the Group footer. The Footer Field(s) will be displayed in the following format: [Field Name]: [Field Value with summary function applied]. The Fields which appear in the New drop-down are those returned by the data source of the Report. You can select multiple Fields as Group Footers.

Options for the Footer Node: Right click on the Footer Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Group Footer. The New option allows you to add a Field as a Group Footer. If we consider the example Report in the section “10.5.2.1 Grouping the Report output by a Group Field” where we have grouped the Report output as per the age of the contacts, the footer of each Group is the Name Field with the Count summary function applied. Therefore the Footer returns a count of the number of times the Name Field occurs in each Group. Note: 1. It is not mandatory to specify a Group Header. 4. You can select multiple Fields as Group Headers. © 2009 Wolf Platform as a Service All rights reserved.

Page 199

WOLF User Guide version 1.3 2009

Properties of the Footer Field: As the footer Field is displayed in the Report, it is possible to vary its display attributes from the Properties section. Also, we can choose the summary function to be applied on the Field from its properties. Click on the footer Field in the Solution Explorer to view the list of properties.

Property

Description

Misc Display Name (*)

The name that will be displayed for this Field in the Group footer of the Report. By default, the Display Name is the Field name returned by the data source.

Summary Function

Select a summary function to be applied when the Field is displayed. This will be the running summary displayed at the end of a group. You can select the function from the following: 1. Average 2. Count 3. Sum

Options for the Footer Field: Right click on the Footer Field to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Footer Field. Use the Delete button to delete the current Footer Field. The Move up and Move down buttons can be used to arrange a Footer Field with respect to the other Footer Fields present in the Group Footer.

© 2009 Wolf Platform as a Service All rights reserved.

Page 200

WOLF User Guide version 1.3 2009

If we consider the example Report in the section “10.5.2.1 Grouping the Report output by a Group Field” where we have grouped the Report output as per the age of the contacts, the footer will be displayed at the end of each Group. Consider the sample Report in the section “10.5.2.3 Specifying the Group Detail” where the Report output is not grouped. Let’s say we introduce a Group Footer for this Report which performs a Count of the “Name” Field. The resultant Report in the Run environment will appear as shown below:

This is expected functionality as all the records now fall into a single Group. It is important to note that, a Group Header will provide incorrect data unless the Report output is Grouped or the Report is filtered by certain criteria. Applying criteria to a Report is discussed in the next section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 201

WOLF User Guide version 1.3 2009

10.6 Applying Criteria to a Report The Criteria Node can be used for introducing a search/criteria Field for filtering the output of a Report. For example, we have a Report that displays the details of all the contacts in the Contact Entity. We can include a search Field that allows us to filter the Report results based on the Name Field. A Report with a criterion in the Run environment will appear as shown below:

The results of the Demo Report can then be filtered on the basis of the Name. By default, a Report does not consist of any criteria. It is important to remember that every search Field in the Criteria section needs to have a reference in the Business Rule that acts as a data source for the Report. The Business Rule in turn references the Entity/Entities data that are used for generating the Report.

Tip: You can add multiple search Fields in the Criteria Section of a Report. However, each of these search Fields needs to have a corresponding reference in the Business Rule used as a data source for the Report.

© 2009 Wolf Platform as a Service All rights reserved.

Page 202

WOLF User Guide version 1.3 2009

Adding criteria to a Report: To add search Fields to a Report, right click on the Criteria Node, select New and then select the Field Type.

Caution: Every search Field in the Report’s Criteria section needs to have a reference in the Business Rule that acts as a data source for the Report.

Options for the Criteria Node: Right click on the Criteria Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Criteria section. Clicking the New button will present a drop down list of the Field types that can be added in the Criteria Section. Configuring the Criteria Fields of a Report: We will consider a practical example for configuring the Criteria Fields of a Report. Let’s consider a Report that displays information of the contacts in the Contact Entity and our requirement is to introduce a search Field for filtering the Report results based on the “Name” Field. The figure below shows the structure of the Report without any search Criteria.

© 2009 Wolf Platform as a Service All rights reserved.

Page 203

WOLF User Guide version 1.3 2009

For this example, we will assume that following are already created in your Application: 1. The “Contact” Entity 2. The “Sample Business Rule” which fetches the “Name” and “Age” Fields for every record in the Contact Entity 3. A “Demo Report” that displays the information of all the contacts in the Contact Entity by using the “Sample Business Rule” Step 1: The most important step in configuring a search Field is determining its Field type. Let us first observe the structure of the Contact Entity. The Contact Entity consists of the following Fields: Field Name

Field Type

Name

Text

Age

Number

Date of Birth

Date

As we need to filter the Report based on the “Name” Field, we will introduce a Text Field in the Criteria section of the Report. To add a Text Field, right click on the Criteria Node, select New and then select New Text Field. Step 2: Once a Text Field has been added in the Criteria section, we need to create a reference for this Field in the Business Rule that acts as the data source for the Report. This can be achieved in two steps. The first step is to configure the Text Field in the Report from its Properties section. Click on the newly added Text Field in the Solution Explorer to view its properties from the Properties section.

© 2009 Wolf Platform as a Service All rights reserved.

Page 204

WOLF User Guide version 1.3 2009

The “Name in BR” property and the “Display Name” property are mandatory properties that are unique to a search Field in the Criteria section of a Report and we will consider only these properties. The rest of the properties are similar to those of a Text Field in an Edit Screen. Please refer to the section “7.14.4 Field Properties” for a full understanding of Field Properties.

Property

Description

Misc Name in BR

The name by which the search Field will be referenced in the Business Rule that is used as a data source for the Report. Make sure you do not have any special characters or spaces in this name. It is best to have this name different from any of the existing Field names to avoid conflicts. A "var_" prefix is a good idea. For example, “var_name”.

Display Name

The name with which this Field will appear in the Criteria section of the Report.

We will edit these two properties as follows: © 2009 Wolf Platform as a Service All rights reserved.

Page 205

WOLF User Guide version 1.3 2009

1. Name in BR: Enter the name “Var_Name”. The search Field will be referenced by this name in the Business Rule. 2. Display Name: Enter the name “Name”. The search Field will appear with this name in the Report. We will leave the rest of the properties of the Text Field as is. The properties of the Text Field have been changed as shown below:

The second step is to create a reference for this Text Field in the Business Rule used as a data source for the Report. We will open the “Sample Business Rule” in the Solution Explorer and create the appropriate reference. The figure below shows the “Sample Business Rule”:

We will create a reference for the Text Field in the “Where the following apply” Node of the “Perform an Advanced Search” Action using the guidelines shown below: © 2009 Wolf Platform as a Service All rights reserved.

Page 206

WOLF User Guide version 1.3 2009

1. The [Field] control is set to “Name” Field of the Contact Entity. 2. The [Is Equal To] control can be set to the condition which we wish to apply. In this case we will leave the control as is. 3. The [Field, Variable or Constant] is set to the “Var_Name”, the name of the Text Field in the Criteria Section of the Business Rule. After making these changes, the Business Rule will appear as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 207

WOLF User Guide version 1.3 2009

The figure below provides a clear picture of the process:

Once we have published the Business Rule, the Text Field in the Criteria section of the Report will have a reference in the “Sample Business Rule”. The “Demo Report” will appear in the Run environment as shown below:

We can now filter the “Demo Report” based on the “Name” Field.

© 2009 Wolf Platform as a Service All rights reserved.

Page 208

WOLF User Guide version 1.3 2009

Properties of the Search/Criteria Field of a Report: In addition to possessing all the properties of the corresponding Field Type in the Edit Screen, each Criteria Field contains two extra properties:

Property

Description

Misc Name in BR

The name by which the search Field will be referenced in the Business Rule that is used as a data source for the Report. Make sure you do not have any special characters or spaces in this name. It is best to have this name different from any of the existing Field names to avoid conflicts. A "var_" prefix is a good idea. For example, “var_name”.

Display Name

The name with which this Field will appear in the Criteria section of the Report.

For example, a Text Field in the Criteria Section of the Report contains the following properties:

© 2009 Wolf Platform as a Service All rights reserved.

Page 209

WOLF User Guide version 1.3 2009

Please refer to the section “7.14.4 Field Properties” for a full understanding of Field Properties.

Actions on a Criteria Field of a Report In addition to changing the properties of a Criteria Field from the Properties section, there are several actions possible on a Criteria Field. To view these actions, right click on the Field Node. The Save and Publish buttons enable you to Save/Publish changes made to a Criteria Field. Use the Delete button to delete the current Field. The Move up and Move down buttons can be used to move the current Field up/down with respect to the other Fields present in the Criteria section of a Report. This enables us to arrange the order of the Fields appearing in the Criteria section.

Deleting a Criteria Field To delete a Field from the Criteria section of a Report, right click on the Field Node and select Delete. A popup appears asking for your confirmation. Choose Yes to delete the Criteria Field. Any changes made to the Criteria Field properties are lost on deletion.

Tip: A Field that has been deleted from the Criteria section of a Report can be added again.

Caution: If a Field is removed from the Criteria section of a Report, the corresponding reference to the Field in the Business Rule needs to be removed.

© 2009 Wolf Platform as a Service All rights reserved.

Page 210

WOLF User Guide version 1.3 2009

10.7 Actions on a Report To view the actions possible on a Report, right click on the Report Node in the Solution Explorer.

The Save and Publish buttons enable you to Save/Publish changes made to a Report. Clicking the Close button enables you to close the working session with the current Report. Click the Delete button to remove the current Report from the Application.

10.8 Editing an existing Report There are several ways of managing an existing Report of an Application. Using any of the methods mentioned below opens a popup listing the existing Reports of an Application. Choose the appropriate Report and then click the Open button in the popup to start working with it. From the Designer Home You can manage an existing Report by clicking on the Manage an existing Report button in the Designer Home.

© 2009 Wolf Platform as a Service All rights reserved.

Page 211

WOLF User Guide version 1.3 2009

From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Report. From the Solution Explorer Right click on the Application Node, select Open and then select Existing Report.

10.9 Deleting a Report To delete a Report, right click on the Report and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Report. Caution: Deleting a Report will remove it permanently from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 212

WOLF User Guide version 1.3 2009

11. Working with Categories 11.1 Overview of Categories A Category is an element that helps to categorize and organize your Application Designer controls (such as Entities and Navigation Items). For example, in an Application that collects information of all the individuals in a university, the Entities dealing with information about different students such as undergraduate students, postgraduate students, etc. may be assigned a "Student" Category. The Entities dealing with information about professors, lecturers and other teaching stuff may be assigned a "Faculty" Category. Similarly, you may create and assign a "Report" Category for all the Reports in your application. Important points to remember while working with Categories: 1. Only the “General” Category is available by default. Other categories, if required, need to be created before they can be used. 2. When creating a Dashboard Widget, the Navigation Item should be assigned the "Dashboard" Category.

11.2 Adding a new Category There are several ways of creating a new Category in an Application. From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Category.

From the Solution Explorer Right click on the Application Node, select New and then select New Category.

© 2009 Wolf Platform as a Service All rights reserved.

Page 213

WOLF User Guide version 1.3 2009 11.3 Category Properties – Assigning a name to the Category We can assign a name to the Category from the Properties section.

Property

Description

Misc Category Name (*)

Assign a meaningful name to the Category. This is a mandatory property and the Category will be referenced by this name in the Designer.

11.4 Using Categories in an Application 11.4.1 How do I assign a Category to an Entity? Let’s say we want to assign the “People” Category to the “Contact” Entity. We are assuming that the “Contact” Entity and “People category already exist in the Application. Step 1: Open the “Contact” Entity in the Designer. Step 2: Click on the “Contact” Entity in the Solution Explorer and view its properties from the Properties section. Step 3: Go to the “Category” property of the Entity and press F2 to see the options. A drop-down listing the categories of your Application appears. Click on the “People” Category and then press Enter to finalize these changes.

© 2009 Wolf Platform as a Service All rights reserved.

Page 214

WOLF User Guide version 1.3 2009

Step 4: Press Publish. We have successfully assigned the “Contact” Entity to the “People” Category. Assigning Categories to Entities helps you to logically group the Entities of an Application. It is important to note that the assignment of a Category to an Entity does not reflect in the Run environment of the Application.

11.4.2 How do I assign a Category to a Navigation Item? Let’s say we want to assign the “People” Category to the “Contact List” Navigation Item. We are assuming that the “Contact List” Menu and “People category already exist in the Application. Step 1: Open the “Contact List” Navigation Item in the Designer. Step 2: Click on the “Contact List” Navigation Item in the Solution Explorer and view its properties from the Properties section. Step 3: Go to the “Category” property under the “Misc” section and press F2 to see the options. A drop-down listing the categories of your Application appears. Click on the “People” Category and then press Enter to finalize these changes.

© 2009 Wolf Platform as a Service All rights reserved.

Page 215

WOLF User Guide version 1.3 2009

Step 4: Press Publish. We have successfully assigned the “Contact List” Navigation Item to the “People” Category. Note: The Category is a mandatory property for a Navigation Item. In simple terms, it is mandatory to assign a category to the Navigation Item.

Assigning Categories to Navigation Items helps you to logically group the Navigation Items of an Application. Additionally, the categorization of the Navigation Items also displays in the Run environment of the Application. Figure below shows how the categorization of Navigations Items appears in the Run environment of the Application:

© 2009 Wolf Platform as a Service All rights reserved.

Page 216

WOLF User Guide version 1.3 2009

11.5 Actions on a Category In addition to assigning a name to the Category, there are several actions possible on a Category. To view these actions, right click on the Category Node.

The Publish button enables you to Publish changes made to a Category. Clicking the Close button enables you to close the working session with the current Category.

11.6 Editing an existing Category There are several ways of managing an existing Category of an Application. Using any of the methods mentioned below opens a popup listing the existing Categories of an Application. Choose the appropriate Category and then click the Open button in the popup to start working with it.

From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Categories.

From the Solution Explorer Right click on the Application Node, select Open and then select Existing Categories.

© 2009 Wolf Platform as a Service All rights reserved.

Page 217

WOLF User Guide version 1.3 2009

12. Downloading Design XML Backup 12.1 Overview The Designer is equipped with an option that allows you to download and backup the design XML of your Application on your local machine. In case of system errors or inconsistencies you can send the latest design XML to the Wolf team for restoring your Application design.

12.2 Downloading the design XML of your Application From the Designer Toolbar To download the design XML, click on the Other tools/options related to the selected node from the Designer toolbar and then select Design XML Backup. From the Solution Explorer Alternatively, you can right click on the Application Node in the Solution Explorer, select Tools and then select Design XML Backup. Using any of the methods mentioned above presents a popup as shown below:

Click the Save button in the popup to save the design XML in your local machine.

© 2009 Wolf Platform as a Service All rights reserved.

Page 218

WOLF User Guide version 1.3 2009 13. Working with Charts 13.1 Overview of Charts Activate smart visual analytics for your Application data using charts and graphs. The Wolf Chart Control assists you to create, modify and delete charts and graphs for your Application. Visualization of Data adds a new degree of usability to an Application. The Wolf Chart Control is a pointand-click interface that helps you to visually represent the data of your Wolf Application by using the Google Charts API in the background. Important points to remember while designing a Chart: 1. Any Chart created or any changes made to an existing Chart in the Designer will only reflect in the Run environment of the Application. 2. The data source for a Chart is a Business Rule. This Business Rule must return data in a tabular format. 3. As the Chart essentially displays Application data, if there is no data in the Application the Chart will not display any data. 4. The Chart must be linked to a Navigation Item in order to make it accessible to Roles/Users of an Application. The figures below show how different charts/graphs appear to a User in the Run Environment. It is important to note that depending on the Chart type, a Chart need not necessarily consist of all the components shown in the figure.

© 2009 Wolf Platform as a Service All rights reserved.

Page 219

WOLF User Guide version 1.3 2009

© 2009 Wolf Platform as a Service All rights reserved.

Page 220

WOLF User Guide version 1.3 2009

13.2 Adding a new Chart/Graph There are several ways of creating a new Chart in an Application. From the Designer Toolbar Click the New drop-down from the Designer Toolbar and select New Chart.

From the Solution Explorer Right click on the Application Node, select New and then select New Chart.

© 2009 Wolf Platform as a Service All rights reserved.

Page 221

WOLF User Guide version 1.3 2009

A new Chart has the structure shown in the figure below:

13.3 Basic Chart Properties and setting the data source for a Chart Let’s first take a look at the basic properties of a Chart.

Property

Description

Misc Chart Title(*)

Provide a meaningful title to the Chart. You will use this name every time you refer to this Chart. For example, while assigning the Chart to a Navigation Item.

Data Source Chart Data (*)

The data source for a Chart is a Business Rule or a response returned from a Business Rule. This data source must return data in a tabular format.

© 2009 Wolf Platform as a Service All rights reserved.

Page 222

WOLF User Guide version 1.3 2009 Note: Each Chart contains four mandatory properties (marked with a “*”): 1. Chart Title 2. Chart Data 3. Chart Type 4. Horizontal Labels Source 13.3.1 Data Source for a Chart Every Chart in an Application consists of a data source. This is the most important step while designing a Chart for your Application as the Chart’s output and design are dependent on the data source. The data source is a Business Rule or a response returned from a Business Rule. It is important to remember that, the Business Rule that acts as a data source must return data in a tabular format. To specify a data source for a Chart: Step 1: Click on the “Chart Data” property in the Properties section and press F2 to edit the property. Step 2: Click the ellipsis button to make a selection. Step 3: A popup appears listing the Business Rules of your Application that return tabular data. In the popup, expanding the Business Rules Node shows a list of the Business Rules which you can utilize. Choose the appropriate Business Rule/response from a Business Rule and then click on the Open button.

© 2009 Wolf Platform as a Service All rights reserved.

Page 223

WOLF User Guide version 1.3 2009

Step 4: Press Enter to finalize these changes. Press Publish. We have successfully linked the Chart to a Business Rule. Let’s consider we are designing a Chart called “Contacts Age Distribution” that displays the number of contacts belonging to every age value. The data source for the Chart can be a Business Rule or a response returned from a Business Rule. We will achieve our objective using a Business Rule without a response. The Business Rule “Contacts Age Distribution” is as shown below: The “Perform an Advanced Search” Action and the “For-each record of [Entity]” Action are normally used to return data in a tabular format from a Business Rule. It is important to remember that every Column added under the “Columns” Node must have an Alias name in the case of both these Actions. Also, the Alias name specified should not have any white spaces inside it. For example, “AgeCount” is a valid Alias name whereas “Age Count” is an invalid Alias name. Using an Alias name of “x” will display the data obtained from that column as a Horizontal Label.

© 2009 Wolf Platform as a Service All rights reserved.

Page 224

WOLF User Guide version 1.3 2009

This Business Rule will be used as a data source for the Chart.

13.4 Designing your Chart 13.4.1 Choosing the Chart type The “Display Settings” Node of the Chart allows you to select the Chart type and the base color for the Chart. Click on the “Display Settings” Node to see the list of properties.

© 2009 Wolf Platform as a Service All rights reserved.

Page 225

WOLF User Guide version 1.3 2009 Property

Description

Type Chart Type(*)

Choose the type of Chart you wish to create.

Chart Dimensions Base Color

Options for the Display Settings Node: Right click on the Display Settings Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Display Settings of the Chart. Specifying the Chart type: Click on the “Chart Type” property and press F2 to edit the property and make a selection. A drop-down listing the Chart types appears. Choose the Chart type from the following: 1. Bar H1: Horizontal bar chart with stacked bars 2. Bar H2: Horizontal bar chart with multiple parallel bars 3. Bar V1: Vertical bar chart with stacked bars 4. Bar V2: Vertical bar chart with multiple parallel bars 5. G-o-Meter: Chart displayed like a speed-o-meter 6. Line: Simple line chart 7. Pie: Simple pie chart 8. Pie 3D: 3D Pie chart 9. Radar: Radar chart

© 2009 Wolf Platform as a Service All rights reserved.

Page 226

WOLF User Guide version 1.3 2009

13.4.2 Specifying the Horizontal Labels of the Chart Horizontal Labels are present on the axes of the Chart which signifies that the data shown is relevant to these Fields or labels. For example, these may be the name of the cities, Months, Month short name, quarters of a financial year, etc. Labels can be obtained from a Business Rule, in which case the label values are the data returned by the Business Rule or alternatively you can use predefined label names. You can specify the Horizontal Labels of a Chart by using the “Horizontal Labels” Node of the Chart. Click on the “Horizontal Labels” Node to see the list of properties.

Property

Description

Data Source Horizontal Labels Source(*)

You can choose the Labels for a Chart from the following: 1. A Business Rule that acts as the source of the Horizontal Labels - the label values will be the data returned by the Business Rule. Most often the Business Rule used as the data source for the Chart (Chart Data) is used in this property. 2. Predefined Label types

Tip: Most often the Business Rule used as the data source for a Chart is also used as the Horizontal Labels Source. However, there may be an instance when we wish to customize the data displayed in the Horizontal Labels. For example, if we have a chart that displays the sale of different products in a company, the Business Rule used as the data source for the Chart will compute the total selling price of each product and another Business Rule will be used to display the products names as the Horizontal Labels.

© 2009 Wolf Platform as a Service All rights reserved.

Page 227

WOLF User Guide version 1.3 2009

Specifying the Horizontal Labels Source: Step 1: Click on the “Horizontal Labels Source” property in the Properties section and press F2 to edit the property. Step 2: Click the ellipsis button to make a selection. Step 3: A popup appears listing the Business Rules of your Application and the predefined Label types. In the popup, expanding the Business Rules Node shows a list of the Business Rules which you can utilize. Expanding the “Other Common Labels” Node displays a list of predefined label types that you can utilize. Choose the appropriate Business Rule/predefined label type and then click on the Open button.

Step 4: Press Enter to finalize these changes. Press Publish. We have successfully created a Label source for the Chart.

© 2009 Wolf Platform as a Service All rights reserved.

Page 228

WOLF User Guide version 1.3 2009

Let’s consider a sample Business Rule which can be used as data source for the Chart as well as the Horizontal Labels Source.

Important points to remember while setting a Business Rule as the Horizontal Labels Source: 1. The Alias name “x” needs to be assigned to the Column whose data will be displayed in the Horizontal Labels of the Chart. 2. Only a single Column can be given the Alias Name “x”.

© 2009 Wolf Platform as a Service All rights reserved.

Page 229

WOLF User Guide version 1.3 2009

Options for the Horizontal Labels Node: Right click on the Horizontal Labels Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Labels of the Chart. 13.4.3 Specifying the Legend Entries of the Chart Legend Entries signify the color indexes and labels for the data been plotted in the Chart. The Legend Entries help a User to identify which Chart data is represented in which color and for what label. The Legend Entries Group is present just along the chart with color boxes. Caution: Before selecting the Legends, please remember to Save and Publish the changes made so far in the Chart. This will display the available legends coming from the Business Rule (which is the data source for the Chart), with a right click on the Legend Entries node.

13.4.3.1 Specifying a Legend Entry: Right click on the Legend Entries Node, select New and then select a legend coming from the Business Rule (which is the data source of the Chart).

Tip: You can specify multiple Legend Entries for a Chart. However, remember to keep the Legend Entries meaningful and relevant to the data being displayed.

13.4.3.2 Specifying a name for the Legend Group: You can specify a name for the Legend Group by using the “Legend Entries” Node of the Chart. Click on the “Legend Entries” Node to see the list of properties. © 2009 Wolf Platform as a Service All rights reserved.

Page 230

WOLF User Guide version 1.3 2009

Property

Description

Misc Legend Display Name

A display name for the Legend Group. This will be displayed in the Chart as the header for the Legend Entries.

Options for the Legend Entries Node: Right click on the Legend Entries Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to the Legend Entries of the Chart. The New button presents a drop-down of the legends coming from the Business Rule (which is the data source of the Chart).

13.4.3.3 Working with the Legend Entries Changing the name of a Legend Entry: Once you have added a Legend Entry, it is possible to change its display name from the Properties section. Click on the Legend Entry to view its properties from the Properties section.

By default, the display name assigned to a Legend Entry is the name returned by the Business Rule. © 2009 Wolf Platform as a Service All rights reserved.

Page 231

WOLF User Guide version 1.3 2009 Property

Description

Display Display Name

A display name for the Legend Entry. The Legend Entry will be displayed with this name in the Chart. By default, the display name assigned to a Legend Entry is the name returned by the Business Rule.

Options for the Legend Entry Node: Right click on the Legend Entry Node to see the list of available options: The Save and Publish buttons enable you to Save/Publish changes made to a Legend Entry. Use the Delete button to delete the current Legend Entry. The Move up and Move down buttons can be used to move the current Legend Entry up/down with respect to the other Legend Entries present in the Chart Legend. This enables us to arrange the order of the Legend Entries appearing in the Chart.

Deleting a Legend Entry: To delete a Legend Entry, right click on the Legend Entry Node and select Delete. . A popup appears asking for your confirmation. Choose Yes to delete the Legend Entry. The Legend Entry will no longer be displayed in the Chart. Tip: A Legend Entry that has been deleted from a Chart can be added again.

Note: Once a Legend Entry has been deleted, it will no longer be displayed in the Chart.

© 2009 Wolf Platform as a Service All rights reserved.

Page 232

WOLF User Guide version 1.3 2009

Sample Chart for displaying age-wise details of contacts Please refer to earlier sections of this document for a detailed understanding of how to accomplish the tasks mentioned in this section. Let’s consider we want to build a Chart that displays the age-wise summary of contacts from the Contact Entity. The Chart should display the total number of contacts as well as the number of contacts with a phone number for each age value. For this Chart, we will assume that the “Contact” Entity has already been created in your Application and has the following structure: Field Name

Field Type

Name

Text

Age

Number

Phone Number

Text

Step 1: Create a Business Rule “Contacts Age Analysis” that will be used as the data source for the Chart. The Business Rule is as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 233

WOLF User Guide version 1.3 2009 Tip: As the Business Rule is being used as a data source for the Chart, we will call it for “When? =Unspecified”. Explanation of the Business Rule: 1. The Business Rule uses the “Perform an Advanced Search” Action to obtain the following data from the “Contact” Entity: a. Age b. Count of records for each Age c. Count of Phone Numbers for each Age The data is grouped by the “Age” Field. Tip: As the data is grouped by the “Age” Field, we can perform a count of the Age and the Phone Numbers for each Age value. 2. The Alias name “x is assigned to the “Age” Column and its data will be displayed in the Horizontal Labels of the Chart. Step 2: Create a Chart “Contact Age Analysis” in the Application and use the “Contacts Age Analysis” Business Rule as the data source for the Chart.

© 2009 Wolf Platform as a Service All rights reserved.

Page 234

WOLF User Guide version 1.3 2009

Note: The name entered in the “Chart Title” property will be displayed as the header for the Chart.

Step 3: Set the Chart type for the Chart. Our requirement is to build a Chart that displays the age-wise summary of contacts. The Chart should display two summaries: the total number of the contacts and the number of contacts with a phone number for each Age value. Hence, we need to select a Chart Type that is capable of displaying both these distinct summaries. Based on our requirements we can choose a Chart type from among the following: 1. Line Chart: Simple line chart 2. Bar H1: Horizontal bar chart with stacked bars 3. Bar H2: Horizontal bar chart with multiple parallel bars 4. Bar V1: Vertical bar chart with stacked bars 5. Bar V2: Vertical bar chart with multiple parallel bars We will opt for the Bar H1 Chart type for our Chart.

Step 4: Setting the Horizontal Labels Source As our requirement is to display the age-wise summary of contacts, we can use the data from the Age Field as the Horizontal Labels Source. In accordance with our requirements, the “Contacts Age Analysis” Business Rule in Step 1 has the Alias name “x” assigned to the “Age” Column. Therefore, we set the “Contacts Age Analysis” Business Rule as the Horizontal Labels Source.

Step 5: Save and Publish the changes made so far in the Chart.

Step 6: Choosing the Legend Entries for the Chart. As already mentioned, the Legend Entries signify the color indexes and labels for the data been plotted in the Chart. Our requirement is to display two distinct summaries in the Chart. Therefore we include two Legend Entries: © 2009 Wolf Platform as a Service All rights reserved.

Page 235

WOLF User Guide version 1.3 2009

1.

Count for total number of contacts per Age value

2. Count for number of contacts with a phone number per Age value To include these Legend Entries, right click on the “Legend Entries” Node and add the “AgeCount” and “PhoneCount” legends coming from the “Contacts Age Analysis” Business Rule.

Also, we will provide more meaningful names for the Legend Entries from their respective properties. Rename the “AgeCount” to “Total No. of Contacts” and “PhoneCount” to “Contacts with a Phone No.”. The design of the Chart is as shown in figure below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 236

WOLF User Guide version 1.3 2009

The Chart in the Run environment will appear as shown below:

© 2009 Wolf Platform as a Service All rights reserved.

Page 237

WOLF User Guide version 1.3 2009

13.5 Actions on a Chart To view the actions possible on a Chart, right click on the Chart Node in the Solution Explorer.

The Save and Publish buttons enable you to Save/Publish changes made to a Chart. Clicking the Close button enables you to close the working session with the current Chart. Click the Delete button to remove the current Chart from the Application. 13.6 Editing an existing Chart There are several ways of managing an existing Chart of an Application. Using any of the methods mentioned below opens a popup listing the existing Chart of an Application. Choose the appropriate Chart and then click the Open button in the popup to start working with it. From the Designer Toolbar Click the Open drop-down from the Designer Toolbar and select Existing Chart. From the Solution Explorer Right click on the Application Node, select Open and then select Existing Chart. 13.7 Deleting a Chart To delete a Chart, right click on the Chart and select Delete. A popup appears asking for your confirmation. Choose Yes to permanently delete the Chart.

Caution: Deleting a Chart will remove it permanently from the Application.

© 2009 Wolf Platform as a Service All rights reserved.

Page 238

WOLF User Guide version 1.3 2009

14. Working with Dashboard Widgets Please refer to earlier sections of this document for a detailed understanding of how to accomplish the tasks mentioned in this section. 14.1 Overview of Dashboard Widgets A Dashboard Widget is a box on the Splash Screen which exposes a specific section or functionality of an Application. For example, we may wish to display a list of frequently viewed contacts from the “Contact” Entity in a Dashboard Widget for quick and easy reference. The figure below shows how a simple Dashboard Widget appears in the Run environment:

Note: It is possible to present different areas of your Application as Dashboard Widgets. For example, you may display a Chart as a Navigation Item and a Dashboard Widget.

14.2 Dashboard Widget for presenting Entity data The most common use of a Dashboard Widget is for presenting Entity data. Depending on the format in which this data is presented, there are two types of Dashboard Widgets: 1. Simple Dashboard Screens 2. Paged Dashboard Screens These two differ in the way the Entity data is displayed in the Widget. However, the process for creating and configuring these is similar. © 2009 Wolf Platform as a Service All rights reserved.

Page 239

WOLF User Guide version 1.3 2009

14.2.1 Essentials Designer elements for creating a Dashboard Widget The following Designer elements are required for creating a Dashboard Widget that presents Entity data: 1. An Entity whose data will be presented in the Dashboard Widget 2. A Business Rule that acts upon the Entity to obtain the required data 3. A Search Template in the Entity which displays data using this Business Rule 4. The “Dashboard” Category 5. Configuring a Navigation Item to display a Dashboard Widget 14.2.2 Creating and Configuring a Dashboard Widget We will consider a practical example to illustrate this process. Let’s consider we want to a Dashboard Widget that displays the name and phone number of contacts in the “Contact” Entity whose age is greater than 21. For this example, we will assume that the “Contact” Entity is already created in your Application and consists of the following Fields: 1. Name 2. Age 3. Phone Number

Step 1: Create a Business Rule “Contacts with age greater than 21” that acts on the “Contact” Entity to obtain the required data Note: As the Business Rule will be linked to a Search Screen of the “Contact” Entity, we will call the Business Rule for “When? = Unspecified”.

© 2009 Wolf Platform as a Service All rights reserved.

Page 240

WOLF User Guide version 1.3 2009

The Business Rule will appear as shown below:

Explanation of the Business Rule: The Business Rule uses the “Perform an Advanced Search” Action to obtain the data from the “Name” and “Phone Number” Fields of the “Contact” Entity whenever the “Age” is greater than 21. Step 2: Create a Search Template in the “Contact” Entity and set the “Contacts with age greater than 21” Business Rule as the data source for it We will first create a Search Template named “Contacts Dashboard” in the “Contact” Entity. To link the Search Screen to a Business Rule, click on the “Contacts Dashboard” Search Screen in the Solution Explorer. Go to the “Data” section in the Properties and click on the “Business Rule” property. Press F2 to edit the property.

© 2009 Wolf Platform as a Service All rights reserved.

Page 241

WOLF User Guide version 1.3 2009

Click the ellipsis button to make a selection. A popup appears listing the Business Rule of your Application. Expand the “Business Rules” Node to see the list. Click on the “Contacts with age greater than 21” Business Rule and then click the Open button. Press Publish to finalize these changes. The “Contacts with age greater than 21” Business Rule has been set as the data source for the “Contacts Dashboard” Search Screen. Step 3: Add and organize the data in the “Contacts Dashboard” Search Screen. This is an important step as the data displayed in this Search Screen and its order will be identical to that in the Dashboard Widget. Our requirement is to display the “Name” and “Phone Number” Fields in the Dashboard Widget. Caution: While creating a Dashboard Widget, do not add Fields in the Criteria section of the Search Screen which is linked to the Dashboard Widget.

© 2009 Wolf Platform as a Service All rights reserved.

Page 242

WOLF User Guide version 1.3 2009

To add Fields in the Results section of the “Contacts Dashboard” Search Screen, right click on the Results Node, select New and then click on a Field to add it.

It is clear from the figure that only the Fields returned by the Business Rule can be added to the Results section of the Search Screen. Tip: 1. The data displayed in this Search Screen and its order will be identical to that in the Dashboard Widget. 2. Use the Move up and Move down buttons to arrange the order of the Fields in the Results section.

Our requirement is to display the “ContactName” and “ContactPhone” Fields returned by the Business Rule. Hence we will add both these Fields in the Results section of the Search Screen. Tip: 1.

It is possible to change the display name of the Fields in the Results section of the Search Screen from their Properties section.

2. The Field names are displayed as table columns only in the case of Paged Dashboard Screens. The Simple Dashboard Screens only display the data contained in the Fields. 3. © 2009 Wolf Platform as a Service All rights reserved.

Page 243

WOLF User Guide version 1.3 2009

Step 4: Create the “Dashboard” Category in the Application.

Tip: When creating a Dashboard Widget, the Navigation Item should be assigned the "Dashboard" Category.

Step 5: Configuring a Navigation Item to display a Dashboard Widget. Create a Navigation Item “Contacts older than 21 years” in the Application and assign it to the “Dashboard” Category. Caution: The Navigation Item will not display as a Dashboard Widget unless it is assigned to the “Dashboard” Category.

© 2009 Wolf Platform as a Service All rights reserved.

Page 244

WOLF User Guide version 1.3 2009

Use the “Entity Link” section of the Navigation Item’s properties to link it to the “Contacts Dashboard” Search Screen. Also, at this stage we need to decide the type of Dashboard Widget which we wish to create, i.e., Simple or Paged Dashboard Screen. Click on the Linked Screen property and press F2 to edit the property. Click the ellipsis button. A popup appears listing all the screens of your Application. Our requirement is to link the Navigation Item to the “Contacts Dashboard” Search Screen of the “Contact” Entity. In the popup, expanding the “Contact” Entity Node shows a list of the screen types available for the Entity. The “Paged Dashboard screens” Node allows us to create a Paged Dashboard Widget and the “Simple Dashboard screens” Node allows us to create a Simple Dashboard Widget.

© 2009 Wolf Platform as a Service All rights reserved.

Page 245

WOLF User Guide version 1.3 2009

Click on the appropriate screen and then click on the Open button. Press Enter to finalize these changes. Press Publish. We have successfully linked the Navigation Item to a Dashboard screen of the Contact Entity and the Dashboard Widget has been configured. The figures below represent how a Dashboard Widget appears in the Run environment of an Application:

© 2009 Wolf Platform as a Service All rights reserved.

Page 246

WOLF User Guide version 1.3 2009

14.2.3 Display format of the different Dashboard Widgets in the Run environment of the Application The figures below represent how the different Dashboard Widgets display Entity data. a. Simple Dashboard Widget:

© 2009 Wolf Platform as a Service All rights reserved.

Page 247

WOLF User Guide version 1.3 2009

b. Paged Dashboard Widget:

© 2009 Wolf Platform as a Service All rights reserved.

Page 248

Sponsor Documents

Or use your account on DocShare.tips

Hide

Forgot your password?

Or register your new account on DocShare.tips

Hide

Lost your password? Please enter your email address. You will receive a link to create a new password.

Back to log-in

Close