1

Discovery Conference 2016: Reports you must know how to build Conrad Henley-Calvert, Millpost Technologies: conrad@millpost.com.au

Introduction to the Staff Site The aspects of the staff site that we will be looking at are very much about creating and modifying

IQAs so that they can be used correctly on the dashboards and for searches. There are also some

basic website content management techniques that you need to use. We’ll look at those first,

before moving on to look at IQAs.

The staff site is a core site in RiSE with its own sitemap, or menu structure, and using core content.

RiSE> Site Builder> Manage websites

RiSE> Site Builder> Manage sitemaps

RiSE> Page Builder> Manage content

Note the padlock showing that the site, sitemap and content are locked. That means they cannot be

changed. This is because ASI makes improvements to the staff site with each release, including new

tools that need to be showcased through examples, and needs to be able to add those to your iMIS

without overwriting changes that you have made.

So, if it’s all locked, and you can’t edit it, how do you make changes? Generally, you add, you copy

and you manage shortcuts. Prior to version 20.2, you had to copy the staff site in order to make

some of the changes you needed to, but this is no longer necessary.

2

Reading the site map Let’s start with a look at the site map for the staff site. Expanding the Community section and

working up from the bottom, we see the following.

The two security sub-menu items, users and roles, link to specialist pieces of functional content. You can’t change these and wouldn’t want to because you need them to do what they are doing.

Manage duplicates, committees and communities are linked to core content and can’t be changed. There’s not really much you would want to do to change them; once there is, you can expect that ASI will reconfigure the out-of-the-box staff site to allow that.

Dashboard, find contact and add contact are all linked using shortcuts. You can’t change which shortcuts they use, but you can change, on a site-by site basis if necessary, which content the shortcut points to.

So wherever the site map uses shortcuts, you can copy and configure that content knowing that

when you upgrade:

Your configured content will not be overwritten and will be what staff continue to use

The latest ASI example of that content will be available for you to review and copy wholesale

or in part

You can also add new navigation items, linking directly to content or by using shortcuts. For

example, you could add a new node that gathers all the dashboards together in one part of the site

map; you can link to content as many times as you like if it helps people find it.

3

Step by step copying

Find and copy the content To copy a piece of content ready for configuring it to suit your needs, we will take as an example the

community dashboard. You need to identify the content and the shortcut pointing to it.

1 Before copying any content, you should have a folder for all your own configured content within RiSE> Page Builder> Manage content.

2 Within RiSE> Site Builder> Manage sitemaps, find the navigation item and identify the shortcut it references.

3 Within RiSE> Site

Builder> Manager shortcuts, find the shortcut and identify the content it references.

4 Within RiSE> Page Builder> Manage content, find the content item.

5 At this point you will want to copy the content. Two hints:

a Remember that the community dashboard has a tabbed area. This typically indicates multiple content items and in this case you see these in the same folder as the main dashboard page. So you will want to copy the whole folder so that you can configure all aspects of the dashboard.

4

b You will probably be configuring all the dashboards in due course, so it may make sense to copy the entire Staff Dashboards folder in one go.

6 Once you have

selected the level you want to copy, click Organize> Copy.

7 Click on the

folder where you will put all your configured content.

8 Click Organize> Paste.

9 Your pasted

content will initially show as working. Publish it.

5

10 In RiSE> Site Builder> Manage shortcuts, add a new shortcut specifically for the staff site, using the shortcut identified earlier but referencing the copied content.

11 To get this to take effect immediately, publish the navigation item and do a hard refresh in your browser.

Tabs: Content Collection Organisers When we look at the copied content, we see that the tabbed area, managed using a Content

Collection Organiser, is still pointing to the core content. To fully effect a change to configurable

content, we need to configure this to point each tab to the equivalent copied content.

Note that a Content Collection Organiser can have tabs defined either by adding individual tabs and

selecting individual content records (in which case the content records do not need to be in the

same location), or by referencing a folder in which case the content items in that folder will form the

tabs.

IQAs The other thing that you need to copy is the IQAs. While the out-of-the-box IQAs are not locked,

they are overwritten at upgrade. You should have a folder for your own IQAs, into which you copy

individual IQAs or whole folders of IQAs that you plan to modify. As you configure the various parts

of the site, change the iParts to reference your own IQAs.

6

IQAs for the staff site

IQAs for progress trackers Dynamic content item (iPart) used is Utility> Progress Tracker

Simple total eg community dashboard $/Samples/Dashboards/Community/Progress Tracker - Total Active Individuals

Target eg member dashboard $/Samples/Dashboards/Membership/Progress Tracker - New members

7

Complex eg specific event dashboard (detail) $/Samples/Dashboards/Events/Specific Events/Progress Tracker - Total Registrations

Note also the filtering in this one, because it is reporting on a specific event.

8

IQAs for charts Dynamic content item (iPart) used is Utility> Query Chart Viewer

Eg community dashboard $/Samples/Dashboards/Community/Members by committee

Eg events dashboard $/Samples/Dashboards/Events/Total Event Registrations by Member Type

9

Some more detail on summary IQAs for progress trackers and charts Create a new IQA using CsContact.

Add some display columns (here they are the defaults).

As we would expect, all records in the database are returned.

Count the iMIS ID and try again.

You will find that you have to remove any display properties that you don’t want to summarise

across in order to bring back meaningful results. Note that you also can’t sort by properties that you

don’t want to summarise over.

You can give the properties aliases so that the output values make sense to the viewer.

10

Publishing IQA results as on screen lists Dynamic content item (iPart) used is Utility> Query Menu

Eg community dashboard – top committees $/Samples/Dashboards/Community/Top committees

Eg event dashboard – recent and upcoming events $/Samples/Dashboards/Events/Event Details - Recent and Upcoming

Eg specific event dashboard – roster $/Samples/Dashboards/Events/Specific Events/Roster List

11

Eg specific event dashboard – detail $/Samples/Dashboards/Events/Specific Events/Registrations by Type List

Eg organisation profile – history $/ContactManagement/DefaultSystem/Queries/Advanced/Contact/Financial/Billing Payments

12

Publishing IQA results as on screen menus of queries Dynamic content item (iPart) used is Utility> Query Menu

Eg community dashboard – data integrity $/Samples/Dashboards/Community/Data integrity

Eg find contacts – directory (people search) $/ContactManagement/DefaultSystem/Queries/Directory/PeopleSearch

Eg find contacts – directory (organisation search) $/ContactManagement/DefaultSystem/Queries/Directory/OrganizationSearch

13

Hyperlinks in IQAs

Contacts and organisations $/ContactManagement/DefaultSystem/Queries/Directory/PeopleSearch [Any IQA here]

$/Samples/Dashboards/Events/Specific Events/Roster List

The party.aspx page is a special page that redirects to the appropriate profile pages, using shortcuts,

based on:

Who is logged in

What permissions they have

Whether they are trying to view the record for a person or an organisation

That means you don’t need to make a distinction. Just start your link ~/Party.aspx?ID=

In the first example, [ID] means to add the field with alias ID to the end of the link.

In the second example, [code_ContactId] means to add the field with alias code_ContactId to the

end of the link.

Aliases beginning “code” (with a lower case “c”) do not appear in the results list but can be used in

links.

14

Events $/Samples/Dashboards/Events/Event Details - Recent and Upcoming

The event.aspx page is a special page that redirects to the appropriate event pages, using shortcuts,

based on:

Who is logged in

The settings for the specific event

That means you don’t need to make a distinction. Just start your link ~/Event.aspx?EventKey=

In the example, [code_EventCode] means to add the field with alias code_EventCode to the end of

the link.

Aliases beginning “code” (with a lower case “c”) do not appear in the results list but can be used in

links.

15

Dynamic filters in IQAs

Events $/Samples/Dashboards/Events/Specific Events/Roster List

In this example, the IQA is being filtered on the URL parameter EventKey. Note that the URL

parameter’s name is defined in the previous example; the link and the filter must be consistent in

the name.

If you look through the components of the specific event dashboard, you will find that EventKey

features as a filter either in the iPart (Progress Tracker) or in the underlying query (Query Chart

Viewer, Query Menu).

This can be used more generally. From the iMIS documentation:

"@url:" Filters by a specified URL parameter. Specify the name of the URL parameter after the

colon in "@url:".

Date and time $/ContactManagement/DefaultSystem/Queries/My Registrations

From the ASI documentation:

@Date: Filters by the current date.

@Now: Filters by the current date and time.

16

People and organisations $/ContactManagement/DefaultSystem/Queries/My Registrations

$/ContactManagement/DefaultSystem/Queries/Advanced/Contact/Financial/Billing Payments

From the iMIS documentation:

Filter by ContactKey and UserKey properties of a business object:

"@LoggedInUser" and "@Me": Both filter by the currently logged-in user.

"@SelectedUser" and "@SubjectContact": Filters by the selected contact. The contact

is selected based on the contact key passed in the URL parameter. If no contact key is passed

in the URL, the contact is considered to be the On Behalf Of contact (if set), or the logged in

user.

For example, set NetContact.ContactKey equal to "@SelectedUser".

Filter by ID:

"@SelectedID": For authenticated users, this variable filters by a selected contact ID. The

ID is selected based on the ID passed in the URL parameter. If no ID is passed in the URL, the

ID is considered to be the On Behalf Of contact's ID (if set), or the logged in user's ID.

For example, set CsContact.ID equal to "@SelectedID".