• Click on

  help

  in the Navigate toolbar.
• Contact Portrait Support.

• Follow the links published on the homepage , which displays the most relevant content for your site.
• Look at

  sitemap

  which lists all published content, displayed in a browsable tree menu.
• Look at what's

  recent

  which lists the content in the order in which it was published.
• Search for content.
  

  The Search box, located on the toolbar

1. Click on

   sitemap

   on the Navigate toolbar.
2. Browse to the folder you are interested in.
3. Click on the link of the content you want to view.

1. Type in the word(s) you wish to search for in the search box.
2. Note that wildcards are important for quality of results because the searching does exact word matches. For example, searching for 'demonstration' will not match 'demo' or 'demonstrations' but 'demo*' will match them all.
3. Press  Search or Enter key. A list of content which matches your search string will be displayed.
4. Click on the link of the content that interests you, or refine your search.
   

   Example list of results returned by Search. Highlighted is an example result, displaying document title, summary, author and creation dates

1. Click on

   recent

   in the Navigate toolbar. A list of the most recently published content will be displayed, along with who published it, how many comments have been made on it, and when it was published.
   

   Example list of recent items. Highlighted are the two most recent items, showing the type, title, author and modification date

2. Click on the link to the content that interests you.
3. If you are logged in, you can restrict the search to just display what you have recently published.

1. Click on

   recent

   in the Navigate toolbar.
   

   Example list of user specific recent posts. Highlighted is the tab menu clicked to view this list

2. Click on tab
   my recent posts
   A list of your most recently published content will be displayed, along with how many comments have been made on it and when it was published.
3. Click on the link to the content that interests you.

Self-Service Analytics is a web application, with all content being accessed through links in a web page — where ever you see a link in Self-Service Analytics — there's likely to be some content behind it. The ways to view content include:

• Click on an item in the the homepage.
• Browse to the relevant folder and then click on the link you are interested in.
• Search for the document and click link in the list of search results.

• Type in your Username and Password into user login box and press  Login.
• click on link login on the Manage toolbar and follow the instructions above.

1. Click on

   log out

   on the Manage toolbar. You will be logged out and returned to the homepage of the whole site.

1. If you are registered with Self-Service Analytics, but have forgotten your username — contact your System Administrator.
2. If you are not registered with Self-Service Analytics — contact your System Administrator.

1. Browse to the user account page:
   • On the homepage click on link Request new password.
   • Alternatively, click on the Manage toolbar.
2. Enter your Username or E-mail address.
3. Click on  E-mail new password to have your password emailed to email the account you specified (assuming you gave a valid email account in the first place).

The front page (or homepage) is the primary starting point within Self-Service Analytics. Different users will have different homepages depending on the configuration of their account.

• Click on

  home

  on the Navigate toolbar.
• click on link Home on the Location toolbar.

Navigation within Self-Service Analytics is through folding tree menus, displaying folders (), open folders () and all other content. Either:

• Ensure the folder navigation block is displayed, and then
  • To open a folder, click on .
  • To close a folder, click on .
  • To view the content, click on the content title (you can view folders this way too).
• Click on

  sitemap

  on the Navigate toolbar
  • To view the content of a folder, click on the folder ().
  • To view the content, click on the content title.

Self-Service Analytics uses icons to represent the different types of content:

Icon	Content Type	Description
	Folders	Groups of all types of content.
	Article	Simple content type for short write-ups — often used as notes, or points for discussion.
	Link to a Web Page	Link to another web page, often external to Self-Service Analytics.
	Document Upload	Documents of any type which are uploaded to Self-Service Analytics for viewing and searching. Typically used for publishing longer pieces of information created using a standard desktop package like Microsoft Office.
	Project Request	A work item or task requested by one of Self-Service Analytics users. Often used to aid collaboration between groups in defining and delivering work, while tracking the progress of the request.
	Query	A query result showing a summary of customer information, displayed with a variety of tables, charts and other viewers.
	Filter	A query component restricting the records which are used within the query calculations. Filters are only created by saving from the query page — though their description and definition can be viewed like any other content.
	Custom segmentation	A query component describing the breakdown of a segmentation field into groups of related values. Custom segmentations are only created by saving from the custom segmentations page — though their description and definition can be viewed like any other content.
	Custom measures	A query component describing the user-defined calculations performed on the query to generate a set of custom measures. These include simple arithmetic calculations as well as query-wide percentages, differences, ranks and accumulations. Custom measures are only created by saving from the custom measures page — though their description and definition can be viewed like any other content.
	Audit	An audit of a dataset, providing simple profiles over all fields, displayed as a simple web page.
	Dataset	A Portrait Customer Analytics analytical dataset (a focus), displayed as a summary of the dataset with a comprehensive data dictionary.
	Dataset series	A collection of datasets within a single folder, displayed as a summary of the series with a list of timeline queries and datasets, and supporting simple administrative operation.
	Databuild	A description of the tasks undertaken as part of a data preparation process.

The version number is displayed at the foot of every page.

Add the following characters to your text:

• two or more spaces at a line's end = line break
• double returns = paragraph
• *single asterisks* or _single underscores_ = emphasis
• **double** or __double__ = strong
• this is [a link](http://the.link.com "the optional title text") = a link

For complete details on the syntax, see the separate documentation.

Some tables can be sorted by the contents of a column. These tables have column headers which are links or which have or beside one column title.

1. Click on the column header you wish to sort by.
2. Click on this column header again to reverse the sort order.

It is possible to restrict access by role to a single piece of content or a whole folder tree.

1. Browse to the content to which you want to restrict access.
2. Click on tab
   privacy
   (assuming you have sufficient permissions to do so).
3. Select the roles that you want to grant viewing permissions.
4. Select the roles that you want to grant editing permissions.
5. Check propagate if you want the entire contents of that folder (including all sub folders and their contents) to receive these permissions.
6. Press  Submit to set these access permissions.

1. Enable the Site Bookmarks block, to see a list of all existing Quick Links.
2. In the Quick Links block, click on link Portrait Support.

1. Email: support@portraitsoftware.com
2. World Wide Web: www.portraitsupport.com
3. Free Phone Numbers:
   • USA 1 800 335 3860
4. Other Contact Numbers:
   • Telephone (All) +44 131 240 3140
   • Telephone (US and Canada) +1 617 457 5200
   • Fax (All) +44 131 220 4492
   • Fax (USA and Canada) +1 617 457 5299

1. Click on

   news

   on to read all incoming news.

1. Browse to the content you want to share.
2. Click on

   email

   on the Collaboration toolbar. A new email browser should appear.
3. Edit the email and send it as you would any other email.

1. Browse to the content you want to print.
2. Click on File > Print in your web browser.
3. You can also choose to print the page with all headers and side menus removed.

1. Browse to the content you want to print.
2. Click on

   print

   on the Collaboration toolbar. A page which removes all but the page content will be displayed.
3. On your web browser, click File > Print to print this page.

1. Click on

   add

   on the Collaboration toolbar.
2. Enter the Subject of your comment and the Comment itself — which could contain some formatting to make it more readable.
3. To see how the comment will look when posted — without actually posting it — press  Preview comment.
4. Click on  Post comment to add the comment to the content.

If you are not logged in you will need to provide some details about yourself before being allowed to log comments.

• If you are viewing the comment in Self-Service Analytics:
  1. Click on

     reply

     in the Comment toolbar.
  2. Change the Subject and Comment as required.
  3. Press  Post comment to reply to the comment, or  Preview comment to review your response before posting it.
• If you are reading the comment in your email:
  1. Reply to the email comment in your email browser.
     

     An example email response, with the original message quoted at the top

  2. Edit the message accordingly
  3. Leave the To: field of the email unchanged
  4. Send the email. It will be processed by Self-Service Analytics and published with the original comment (though this may not happen immediately).

If there are no replies to a comment:

1. Click on

   edit

   in the Comment toolbar.
2. Change the Subject and Comment as required.
3. Press  Post comment to reply to the comment, or  Preview comment to review your response before posting it.

If you have sufficient permission:

1. Click on

   delete

   in the Comment toolbar.
2. Press  Delete

1. Scroll to the Comment viewing options section.
   

   The Comment viewing options section, displayed beneath the main body of the post and providing customization of the way comments are displayed

2. Select the type of list that best suits your needs:
   • Threaded list: to group comments and replies
   • Flat list: to display comments and replies in the order they are posted
   • Expanded list: to display comment title and body
   • Collapsed list: to display comment title only
3. Press  Save settings to make your change.

1. Scroll to the Comment viewing options section.
2. Select the ordering of list that best suits your needs:
   • Date - newest first: to order the list from most recent comments first.
   • Date - oldest first: to order the list as the comments were posted.
3. Press  Save settings to make your change.

1. Scroll to the Comment viewing options section.
2. Select the number of comments to be displayed on each that best suits your needs.
3. Press  Save settings to make your change.

1. Ensure comments can be moderated.
2. Log in with a role with sufficient permissions to moderate comments.
3. Ensure the administration block is being displayed.
4. Click on administer > comments.
5. Click on secondary tab
   approval queue
   .
6. For the comment to approve for publishing, click

   edit

   .
7. In the Status section check Published.
8. Press  Submit.

1. Browse to the folder to which you wish to add content.
2. Click on tab
   add
   to display the types of content you can publish (assuming you have sufficient permission to publish content).
3. Click on the type of content you wish to add.
   

   The add content page, listing links to create all the available types of content. Highlighted is the tab used to view this page

4. Complete the form displayed — ensuring all required fields are entered. Adding different types will require different information to be provided.
5. Check Receive notification of replies if you want to be informed when someone changes or comments on this content.
6. If offered, attach additional files to the content.
7. Press  Preview to review the content before it is published.
8. Press  Submit to publish the content.

1. Create a new folder:
   • If the folder navigation block is displayed, browse in the folder navigation block to the location for the new folder and click .
     

     An example tree navigation browser of all folders. This is displayed as a block on the left hand side of the screen

   • Alternatively, browse to the location for the new folder and click tab
     add
2. Edit the details of the folder.

1. Add a new Article.
2. Provide a Title to display.
3. Provide a Body containing the text of your Article (which can be formatted to make it easier to read).
4. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you provided a valid email account in the first place).
5. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Link to Web Page.
2. Provide a Title to display.
3. Provide a URL for the link (the web address for the Page you want to link to, which could begin with 'http').
4. Optionally, provide a Description which could give the reader a clearer idea of what the link refers to (which can be formatted to make it easier to read).
5. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you provided a valid email in the first place).
6. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Document Upload.
2. Provide a Title to display.
3. For the UploadedFile, press  Browse... to the file on your PC you wish to publish (this document will be accessible to all authorized Collaborative Framework users).
4. Optionally, provide a Description which could give the reader a clearer idea of the contents of the uploaded document (which can be formatted to make it easier to read).
5. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
6. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Query.
2. Provide a Title to display.
3. For the Query file, press  Browse... to the Query file on your PC you wish to publish (this file was created from Portrait Customer Analytics, with file extensions .qsdv, .qstv, .qspv or .qsmv, will be accessible to all authorized Collaborative Framework users and displayed as a table, chart or plugin).
4. Optionally, provide a Description which could give the reader a clearer idea of the contents of the Query (which can be formatted to make it easier to read).
5. Optionally, provide a reference to the Dataset (SourceFocus) used to create this Query and which can be used to run further queries (this is a number, which can be determined by browsing to the Dataset you wish to reference).
6. Optionally, if you have sufficient permissions, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
7. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Audit.
2. Provide a Title to display.
3. For the QSHTML, press  Browse... to the Audit file on your PC you wish to publish (this file was created from Portrait Customer Analytics, with file extension .qshtml, and will be accessible to all authorized Collaborative Framework users, displayed in-line within their browser).
4. Optionally, provide a Description which could give the reader a clearer idea of the contents of the Audit (which can be formatted to make it easier to read).
5. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
6. Press  Submit to create the new page (or  Preview if you want to review your page first)

Audits are just web pages which are displayed in-line within Self-Service Analytics. Like any other web page, they can be displayed in a separate web browser:

1. Click on the Audit.
2. click on link View beneath QSAudit.
3. If you want to send the whole Audit to another user, click on link download and save the files to disk.

1. Add a new Project Request.
2. Provide a Title to display.
3. Select the name of the user who is the Originator of the request.
4. Select the Priority of the request.
5. Provide a Specification of the request — providing enough information to give someone else a clear idea of what you are wanting. This might be a request for a new piece of analysis, a new bit of data, a new report or a new model. This can be formatted to make it easier to read.
6. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
7. Optionally, to Attach new file, press  Browse... to a file on your PC you wish to include with the Project Request (this file could provide more details on your request, and will be accessible to all authorized Collaborative Framework users, displayed in-line within their browser). Press  Attach to attach this file.
8. Press  Submit to create the new page (or  Preview if you want to review page first)
9. At a later stage, you can select the name of the Analyst who you think could undertake this work.
10. Finally, you can detail how this work was completed (the Resolution).

1. Add a new Dataset.
2. Provide a Title to display.
3. Provide a server path to your Portrait Customer Analytics focus linking it to the new Dataset: the focus path should end in a focus file with extension .ftr, which must be accessible (and writable) to all authorized Collaborative Framework users. The contents of this will be displayed as a list of fields within the dataset and links to further analysis options).
4. Optionally, provide a Description which could give the reader a clearer idea of the contents of the Dataset (which can be formatted to make it easier to read).
5. Optionally, provide a server path to a metadata file corresponding to your Portrait Customer Analytics focus; the Metadata file path should end in a metadata file with extension .xml, which must be accessible to all authorized Collaborative Framework users. The contents of this will be used to customize how the field lists are displayed.
6. Optionally, provide a server path to a translations file corresponding to your Portrait Customer Analytics focus; the Translations file path should end in a translations file with extension .xml, which must be accessible to all authorized Collaborative Framework users. The contents of this will be used to customize how the the intelligent query search interprets the Dataset.
7. Optionally, if you have sufficient permissions, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
8. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Dataset Series.
2. Provide a Title to display.
3. Optionally, provide a Description which could give the reader a clearer idea of the contents of the Dataset (which can be formatted to make it easier to read).
4. Optionally, if you have sufficient permissions, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
5. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Add a new Databuild.
2. Provide a Title to display.
3. Provide a Portrait Customer Analytics server path to your new Databuild — the QSBPath (this path should end in a Databuild file with extension .qsb. This will be accessible to all authorized Collaborative Framework users, displayed as a list of tasks and parameters describing the Databuild).
4. Optionally, provide a Description which could give the reader a clearer idea of the contents of the Databuild (which can be formatted to make it easier to read).
5. Optionally, to Subscribe, select to receive notification of replies to this content (which will email you whenever anyone changes or posts a comment on this — assuming you gave a valid email in the first place).
6. Press  Submit to create the new page (or  Preview if you want to review your page first)

1. Browse to the content you wish to edit.
2. Click on tab
   edit
   to change the content (assuming you have sufficient permission to edit that page).
3. Make the changes you require to the fields in the form.
4. Press  Submit to make your changes or  Preview if you wish to review your changes first.

1. Browse to the content you wish to delete.
2. Click on tab
   edit
   (assuming you have sufficient permission to edit that page).
3. Scroll to the foot of the page and press  Delete to select this content for removal.
4. Press  Delete to confirm deletion of this content.

1. Browse to the content you want to move — this could be a folder or other published content.
2. To move a folder:
   1. Click on tab
      edit
   2. Scroll to the Folder section.
   3. Browse to the folder location where you want to move the content (the Parent folder).
   4. Press  Submit to move the folder.
3. To move any other type of content:
   1. Click on tab
      move
   2. Browse to the folder location where you want to move the content (the Parent folder).
   3. Press  Move to selected folder to move the content.

The default display order for folders is alphabetical. You can provide a specific ordering by changing the 'weight' of each folder you wanted ordered:

1. Click on tab
   edit
2. In the Weight section specify the order in which the folders should be displayed: lower weights 'float up' compared with higher weights.
3. Press  Submit to change the order of the folder.

The default display order for content in a folder is alphabetical. You can provide a specific ordering by changing the 'weight' of each piece of content you wanted ordered:

1. Click on tab
   move
2. In the Weight section specify the order in which the contents should be displayed: lower weights 'float up' compared with higher weights.
3. Press  Move to selected folder to change the order of the content.

Required fields are marked with a * and Self-Service Analytics will not warn if they have not been completed when submitting the form.

Some content types allow additional files to be attached to the content.

1. Scroll to the Attachments section.
   

   An example of the attachments section available when creating certain content types

2. Press  Browse... to select a file on your PC to attach to the content.
3. Press  Attach to attach this file.

1. Click on

   bookmark

   on the Collaboration toolbar or on your bookmarks block.
2. Edit the Title or URL fields. This can be used to add bookmarks to any web page.
   

   An example of the manage bookmarks page, with options to edit or delete the bookmarks

3. Press  Save to add this to your bookmarks.

1. Click on

   bookmark

   on the Collaboration toolbar or on your bookmarks block.
2. Edit URL field to be the link to the external web page.
   

   An example of the manage bookmarks page, with options to edit or delete the bookmarks

3. Press  Save to add this to your bookmarks.

• Click on

  bookmarks

  on the Manage toolbar. This will display a page with all of your bookmarks listed, and give you the option to manage these bookmarks.
• Configure your user settings to display the bookmark block. Click on

  manage

  in this block to display the bookmarks page.

1. Display your bookmarks.
2. On the bookmarks page, click on link delete in the table row of the bookmark you want to delete.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll down to the section you want to configure:
   • the Account information section
   • the Navigation setting section
   • the Subscription settings section
   • the Block configuration section
   • the Comment settings section
   • the Locale settings section
   • the Theme settings section
3. Make the changes you require.
4. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Account information section.
3. Make the changes you require:
   • Change your username.
   • Change your contact email address.
   • (If your system is configured to allow you to do this) change your password (you must enter your new password twice).
4. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Navigation setting section.
3. Select how you want to display the toolbar links:
   • Show both text and icons.
   • Show text only.
   • Show icons only.
4. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Subscription settings section.
3. Check the box to enable automatic subscription to all posts.
4. Uncheck the box to disable automatic subscription to all posts.
5. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Block configuration section and select which block to configure:
   • bookmark block
   • quick links block
   • a list of recently posted nodes block
   • a list of recent comments block
   • the folder navigation block
   • the list of new users
   • the list of who is currently using Self-Service Analytics
   • the administration menu
3. Check the box of the block you wish to display.
4. Uncheck the box of the block you wish to hide.
5. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Comment settings section.
3. Edit the text you would like used as your signature on all the comments you post.
4. Scroll to the bottom of the page and click  Save account to enable these changes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Locale settings section.
3. Select the time-zone that corresponds to where you are based (which may be different from the time-zone where Self-Service Analytics is located.
4. Scroll to the bottom of the page and click  Save account to enable these changes.

If your Collaborative Framework has been suitably configured, you can change the styling from a number of predefined themes.

1. Click on

   my account

   in the Manage toolbar.
2. Scroll to the Theme settings section.
3. Select the color scheme you would like to use to display Self-Service Analytics content.
4. Scroll to the bottom of the page and click  Save account to enable these changes.

Self-Service Analytics can email you when content changes — this might be because someone has edited the page or posted a comment to it — and can apply to content originally posted by you or any other user. However, this depends on you providing a valid email in the first place. To configure this:

• For content you publish, either:
  • configure your account settings to automatically subscribe you for anything you post, or
  • select to subscribe to a piece of content when you add it, or later when you edit it.
• For all content, click

  subscribe

  on the Collaboration toolbar.

• what subscriptions you have in place
• remove a subscription

Click on on the Manage toolbar to list all of the content to which you are subscribed.

• On any content you are subscribed for, click

  unsubscribe

  on the Collaboration toolbar.
• Click on

  subscriptions

  on the Manage toolbar to view all of your subscriptions. click on link unsubscribe to remove the notification of changes on the selected content.

1. Browse to the Project Request.
2. Click on tab
   edit
   to change the assignment of the request.
3. Scroll down the page and select the Analyst to which you want to assign the request.
4. Scroll down the page and select Assigned for Request Status.
5. Enter a description of why you made this change in Request Status change reason.
6. Press  Submit to make the change, or  Preview to review your response before submitting it.

The Project Request will now display Request Status Assigned and this change will be captured in the request history.

1. Browse to the Project Request.
2. Click on tab
   edit
   to change the assignment of the request.
3. Scroll down the page and select the Request Status to which you want to change the request.
4. Enter a description of why you made this change in Request Status change reason.
5. Press  Submit to make the change, or  Preview to review your response before submitting it.

The Project Request will now display the new Request Status and this change will be captured in the request history.

1. Browse to the Project Request.
2. Click on tab
   history

A sortable table of changes is displayed — covering when the change was made, the change of state, who by and what reason they gave.

1. Click on

   Project Request

   on the Navigate toolbar.

A sortable table of Project Requests is displayed.

Decisionhouse can be configured to allow you to published views from its viewers directly to Self-Service Analytics.

1. Use Decisionhouse to build up the view you are interested in publishing. This can be in any of the viewers: including the graphical Crossdistribution, Profile or Geographical Viewers or the textual Crosstab Viewer.
2. Use Export > Publish this ... menu in the viewer to start the publishing process.

The new Query will appear in the location you selected. You can configure how this is displayed to recreate the same view as was displayed in Decisionhouse.

The Quadstone System Explorer can be configured to allow you to publish anything on the Portrait Customer Analytics server directly to Self-Service Analytics as a Upload Document.

1. Browse in the Quadstone System Explorer to the file you are interested in uploading to Self-Service Analytics. This can be of any file type.
2. In the Quadstone System Explorer use Publish right-click menu to start the publishing process.

The new Document will appear in Self-Service Analytics in the location you selected.

The Quadstone System Explorer can be configured to allow you to publish a crosstab file (any of .qsdv, .qstv, .qspv or .qsmv files) on the Portrait Customer Analytics server directly to Queries on Self-Service Analytics.

1. Browse in the Quadstone System Explorer to the crosstab file you are interested in uploading to Self-Service Analytics.
2. In the Quadstone System Explorer use Publish View right-click menu to start the publishing process.

The new Query will appear in Self-Service Analytics in the location you selected.

The Quadstone System Explorer can be configured to allow you to publish references to a Focus on the Portrait Customer Analytics server directly to a Dataset on Self-Service Analytics.

1. Browse in the Quadstone System Explorer to the Dataset you are interested in uploading to Self-Service Analytics. This will be a file with extension .ftr.
2. In the Quadstone System Explorer use Publish Focus right-click menu to select all required options for publishing a Dataset:
   

   An example of publishing a focus from the Quadstone System Explorer

3. Optionally, browse to a related metadata file or translations file.
4. Press  OK to start the publishing process.

The new Dataset will appear in Self-Service Analytics in the location you selected.

The Quadstone System Explorer can be configured to allow you to publish references to Data Build Plan on the Portrait Customer Analytics server directly to Self-Service Analytics.

1. Browse in the Quadstone System Explorer to the Data Build Plan you are interested in uploading to Self-Service Analytics. This will be a file with extension .qsb.
2. In the Quadstone System Explorer use Publish Build Plan right-click menu to start the publishing process.

The new Databuild will appear in Self-Service Analytics in the location you selected.

The Quadstone System Explorer can be configured to allow you to publish a Profile and Audit or Model Snapshot (both .qshtml files) on the Portrait Customer Analytics server directly to Audits on Self-Service Analytics.

1. Browse in the Quadstone System Explorer to the Profile and Audit you are interested in uploading to Self-Service Analytics. This will be a file with extension .qshtml.
2. In the Quadstone System Explorer use Publish Audit right-click menu to start the publishing process.

The new Audit will appear in Self-Service Analytics in the location you selected.

You can use the Data Build Command, qppublish to publish any type of content from Portrait Customer Analytics server to Self-Service Analytics.

1. Ensure your path is set to access the Data Build Command correctly.
2. Use qppublish to either:
   • create a new folder: for example:

     qppublish -folder -title "February Databuild Results" -location 225 
      -description "Regular databuild." -user me -password ****

   • publish some new content: for example:

     qppublish -title "Customer Audit" customer.qshtml
     -location 225 -user me -password ****

1. Browse to the downloads page on Self-Service Analytics web site.
2. For users wanting to publish from Portrait Customer Analytics or from Windows Explorer, click on link Publishing Client Installer.
3. Follow the installation instructions on these pages.

1. Browse to the downloads page on Self-Service Analytics web site.
2. click on link JRE 1.4.2 Installer.
3. Follow the installation instructions on that page.
4. click on link Java3D Installer.
5. Follow the installation instructions on that page.

1. Browse to the content you want to list on the homepage — this could be a folder or other published content.
2. Edit this page.
3. If you have sufficient permissions, in the Options section check Promoted to front page to select this content to be added to the homepage.
4. Press  Submit to add the content to the homepage.

1. Browse to the content you no longer want to list on the homepage — this could be a folder or other published content.
2. Edit this page.
3. If you have sufficient permissions, in the Options section uncheck Promoted to front page to select this content to be removed to the homepage.
4. Press  Submit to remove the content to the homepage.

1. Browse to the content you want to fix at the top of lists on the homepage — this could be a folder or other published content.
2. Edit this page.
3. If you have sufficient permissions, in the Options section check Sticky at top of lists to select this content to be displayed at the top of lists on the homepage.
4. Press  Submit to ensure this content is always listed on the homepage.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings  > home .
4. Configure the layout of the homepage according to your needs:
   • Choose the Number of columns of Homepage Channels displayed on the homepage.
   • Enter the maximum number of Homepage Channels (the Number of boxes) displayed on the homepage.
   • Select the maximum Number of items displayed for each of the Homepage Channels (ordered by recency of last edit or stickiness).
   • Choose the Content displayed for each item — the title only or additionally including a short description of the item.
   • Enter the Number of characters in titles to restrict the length of the titles displayed.
5. Press  Save configuration to enable these changes to the homepage.

The homepage of a user can be set to any page in the Collaborative Framework. By default, it is the the homepage, and some roles only see the query page of the current dataset as their homepage and others have a group specific homepage.

1. Either:
   • Login with an administrator role.
   • Enable Self-Service Analytics to allow users to change their homepage.
2. As administrator:
   1. Ensure the administration block is being displayed.
   2. Click on administer > users.
   3. For the selected user, click on link edit.
3. As a non-administrator user:
   1. Click on

      my account

      in the Manage toolbar.
4. Browse to the Home Page Link section (if it is enabled).
5. Either,
   • enter the relative URL of a page within Self-Service Analytics (without the leading ?q=,
   • enter home to select the site wide homepage, or
   • leave blank, to allow Self-Service Analytics to set the value.
6. Press  Save account to change the default save location.

In each case, the selected page is displayed whenever the user goes to their home.

Roles can be configured to allow users with that role to change their own default homepage. This is not the default configuration of any of the standard roles.

1. Configure user permissions.
2. Scroll to user module > change homepage.
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

Roles can be configured to restrict users with that role to only view the current dataset as their default homepage. This is the default configuration of the profiler user in the standard roles.

1. Configure user permissions.
2. Scroll to qs_profiler module > use profiler homepage
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

Note:

• you should ensure that the current dataset has been selected and has a dataset series associated with it.
• there is only one current dataset within Self-Service Analytics for use by all users. However, you can configure different users to query different datasets by default.

You can configure all users with a specific role to query a single current dataset when they first log in. However, if you want a number of different datasets to be available for different users, you will have to configure their default homepage to make it refer to the location of the query page (which will look like: http://myserver/?q=profiler/...).

Roles can be configured to allow users with that role to change the default dataset used by all users. This is the default configuration of the profiler admin user in the standard roles.

1. Configure user permissions.
2. Scroll to qs_profiler module > administer profiler
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

The current dataset is used by default for users who's homepage is a query page. To allow this to be easily updated for all users — this is done in a single place, either interactively or in batch:

1. Ensure a dataset series has been created for the dataset.
2. Either:
   • Login with an administrator role.
   • Enable Self-Service Analytics to allow users to change the current dataset.
3. Ensure the administration block is being displayed.
4. Click on administer > settings > profiler.
5. In the Profiler settings section, select Current dataset series from the list of available dataset series.
6. Press  Save configuration to change the default dataset.

The current dataset for this dataset series will apply to all profiler users.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   add
5. Enter the details of the new user.
6. Press  Create account to add this new user.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. click on link edit for the user you wish to allow administration permissions.
5. Scroll to the Roles section.
6. Check admin.
7. Press  Save account to make the user administrator.

A user's role determines what actions they are able to undertake and what content they are able to view.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. click on link edit for the user who's roles you wish to change.
5. Scroll to the Roles section.
6. Check the roles you wish this user to have.
7. Press  Save account to enable these changes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. click on link edit for the user you wish to delete.
5. Scroll to the Status section.
6. Select Blocked.
7. Press  Save account to block the account.
8. Click on tab
   edit
9. Press  Delete account to delete the user.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .

A list of when users logged in is captured in Self-Service Analytics:

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > logs > users .

A list of what queries have been executed in the last month is captured in Self-Service Analytics:

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > logs > profiler .

A sortable table will be displayed giving a date, a summary of the query, which user executed the query and a link to the full details of the request.

By default, Self-Service Analytics stores a log for 4 weeks. To change this:

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings.
4. Scroll to the Error handling section.
5. Edit Discard log entries older than: to the time span you want.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   configure
5. In the User registration settings section, select which Public registrations option you want for Self-Service Analytics.
6. Press  Save configuration to enable these changes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   configure
5. Click on secondary tab
   permissions
   . This shows a matrix of function (vertical) and role (horizontal).
6. Check the box to enable a particular permission for a particular role.
7. Uncheck the box to disable a particular permission for a particular role.
8. Press  Save permissions to set the roles' permissions.

1. Configure user permissions.
2. Scroll to node module > access content
3. Uncheck the box to disable this permission for anonymous user.
4. Scroll to upload module > view uploaded files
5. Uncheck the box to disable this permission for anonymous user.
6. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to search module > search content
3. Uncheck the box to disable this permission for anonymous user.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to aggregator module > access news feeds
3. Uncheck the box to disable this permission for anonymous user.
4. Check the box to enable this permission for any role you want to access news.
5. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to comment module > access comments
3. Uncheck the box to disable this permission for anonymous user.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to comment module > post comment
3. Check the box to enable this permission for anonymous user or any other role you want to be able to add comments.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Ensure the user role can post comments.
3. Scroll to comment module > post comments without approval
4. Check the box to enable this permission for anonymous user (or any other role) to allow them to add comments without moderation.
5. Uncheck the box to require comments from this user role to be moderated.
6. Press  Save permissions to set the role's permissions.

Users can be organized within (customer) groups. A user (role) must have specific permissions to administer these groups.

1. Configure user permissions.
2. Scroll to customer module > administer customers
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to comment module > moderate comments
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to node module > moderate nodes
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

Roles with content access permissions can control the promotion, moderation and stickiness of the content.

1. Configure user permissions.
2. Scroll to node module > administer nodes
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to quadstone module > applet viewers
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to quadstone module > fast counts
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to quadstone module > launch client applications
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to quadstone module > view records
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to book module > edit own folders
3. Uncheck the box to disable this permission for authenticated user.
4. Check the boxes to enable this permission for your chosen roles.
5. Press  Save permissions to set these permissions.

1. Configure user permissions.
2. Scroll to bookmarks module > access bookmarks
3. Uncheck the box to disable this permission for authenticated user.
4. Check the boxes to enable this permission for your chosen roles.
5. Press  Save permissions to set these permissions.

1. Configure user permissions.
2. Scroll to comments module > post comments
3. Uncheck the box to disable this permission for authenticated user.
4. Check the boxes to enable this permission for your chosen roles.
5. Press  Save permissions to set these permissions.

1. Configure user permissions.
2. Scroll to privacy_book module > manage book privacy
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to flexinode module.
3. For each content type change the  > create ... content and  > edit own ... content:
   • Uncheck the box to disable this permission for authenticated user.
   • Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

1. Configure user permissions.
2. Scroll to subscriptions module > maintain subscriptions
3. Uncheck the box to disable this permission for authenticated user.
4. Check the boxes to enable this permission for your chosen roles.
5. Press  Save permissions to set these permissions.

1. Either:
   • Login with an administrator role.
   • Enable Self-Service Analytics to allow users to change their own password.
2. As administrator:
   1. Ensure the administration block is being displayed.
   2. Click on administer > users.
   3. For the selected user, click on link edit.
3. As a non-administrator user:
   1. Click on

      my account

      in the Manage toolbar.
4. Browse to the Password section (if it is enabled).
5. Enter the new password in each of the text-boxes.
6. Press  Save account to change the password.

Roles can be configured to allow users with that role to change their own passwords. This is not the default configuration of any of the standard roles.

1. Configure user permissions.
2. Scroll to user module > change password
3. Check the boxes to enable this permission for your chosen roles.

1. Either:
   • Login with an administrator role.
   • Enable Self-Service Analytics to allow users to change their own theme.
2. As administrator:
   1. Ensure the administration block is being displayed.
   2. Click on administer > users.
   3. For the selected user, click on link edit.
3. As a non-administrator user:
   1. Click on

      my account

      in the Manage toolbar.
4. Browse to the Theme settings section (if it is enabled).
5. Check the Selected theme.
6. Press  Save account to change the theme.

Roles can be configured to allow users with that role to change their own theme. This is not the default configuration of any of the standard roles.

1. Configure user permissions.
2. Scroll to user module > change theme
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

The users default save location is the folder which will be selected by default whenever that user creates any new content within Self-Service Analytics. If no default is set, and no folder is selected when saving — the content will be placed at the root folder of Self-Service Analytics and should be moved to a known place as soon as possible.

1. Either:
   • Login with an administrator role.
   • Enable Self-Service Analytics to allow users to change their default save location.
2. As administrator:
   1. Ensure the administration block is being displayed.
   2. Click on administer > users.
   3. For the selected user, click on link edit.
3. As a non-administrator user:
   1. Click on

      my account

      in the Manage toolbar.
4. Browse to the Default Save Location section (if it is enabled).
5. Browse to the required folder.
6. Press  Save account to change the default save location.

Roles can be configured to allow users with that role to change their default save location. This is not the default configuration of any of the standard roles.

1. Configure user permissions.
2. Scroll to user module > change default save location
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

Roles can be configured to allow users with that role to share saved queries or filters. This is the default configuration of the profiler admin user in the standard roles.

1. Configure user permissions.
2. Scroll to qs_profiler module > administer queries
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   configure
5. Click on secondary tab
   roles
   . This shows a list of all available roles.
6. Type the name of the new role in the text box.
7. Press  Add role to create the new user role.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users.
4. For the selected user, click on link edit.
5. Click on the user you wish to add more information to.
6. Click on secondary tab
   personal information
   . This shows a list of all available pieces of user information that can be provided.
7. Type the values of the information for that user form provided.
8. Press  Save account to change the details.

When ever a user name is listed in Self-Service Analytics, it is attached by a link to their user page.

Any user can change their own personal information. Users with sufficient permissions can edit other users information.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   configure
   and then secondary tab
   profile
   . This lists all the information fields kept about a user.
5. Either:
   • click on link edit on a selected piece of information to change the name of that field, or
   • click on link delete on a selected piece of information to remove this field information, or
   • in the Add a new field section click on one of the information field types to add a new field of information.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > users .
4. Click on tab
   configure
   and then secondary tab
   profile
   . This lists all the information fields kept about a user.
5. click on link edit on a selected piece of information to change, or
6. Either:
   • check The user must enter a value to require this information to be provided, or
   • check Visible in user registration form to capture this information at registration time.

The customer module provides support for groups of users.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > modules .
4. Browse to the 'customer' module.
5. Check Enabled for this module
6. Press  Save configuration to make the change.

When this module is enabled, new roles customer_user and customer_superuser are automatically created.

A customer corresponds to a group of related users.

1. Login with as customer administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > customers .
4. Browse to tab
   create
5. Enter the Company Name and Information details
6. Press  Create New Customer to create this new group.

When this customer is created, a new homepage is created for this group, and new roles are generated to allow users to view and edit content within this group.

1. Login with as customer administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > customers .
4. Browse to the customer group you wish to remove, and click on link edit.
5. In the Deletion section, press the  Delete to remove that group (and remove all the users from this group).

1. Login with as customer administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > customers .
4. Browse to the customer group you wish to add to, and click on link edit.
5. In the Membership section you can add and remove users from the group by clicking on the button beside the users name.

The users name will appear in the group membership list (with an option to remove that user from the group). The user will automatically gain customer_user role and also the 'view' role for that group. You can also add the 'edit' role for that group. A user can only belong to one group at a time.

1. Login with as customer administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > customers .
4. Browse to the customer group you wish to remove from, and click on link edit.
5. In the Membership section you can remove users from the group by clicking on the button beside the user's name.

The users name will be removed from the group membership list (with an option to add that user to the group).

You can require specific content types to be moderated before they are published for all to see in Self-Service Analytics. These will be kept in a submission queue before it is accepted for publishing.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > content .
4. Click on tab
   configure
5. Click on secondary tab
   default workflow
   . This shows a matrix of content types (vertical) and the default configuration (horizontal).
6. Check the box to require a type of content to be moderated, check the moderate default for that content type.
7. Uncheck the publish default for that content type.
8. Press  Save configuration to set the content types defaults.

You can move content which is to be moderated and kept in the submission queue into being fully published on Self-Service Analytics by:

1. Login with a user role with sufficient permissions to moderate content.
2. Ensure the administration block is being displayed.
3. Click on administer > content .
4. Optionally select the the Filter options section to "View posts that need approval" and press  Filter.
5. Check the documents you want to approve for publishing
6. (Ensure the Update options section is set to "Approve the selected posts")
7. Press  Update to publish all of these selected documents.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > themes .
4. Click on Enabled for each theme you want to make available to users.
5. Select which theme you want to be used as the default theme for all authenticated users and guests.
6. Press  Save configuration to enable the themes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings .
4. In the General settings section edit Name.
5. Press  Save configuration to enable these changes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings .
4. In the General settings section edit E-mail address. Ensure this is a valid email address — many aspects of Self-Service Analytics will not work as expected if this is not the case.
5. Press  Save configuration to enable these changes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings .
4. In the General settings section edit Slogan.
5. Press  Save configuration to enable these changes.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings .
4. In the General settings section edit Mission.
5. Press  Save configuration to enable these changes.

1. Login with administration role.
2. Ensure the administration block is being displayed.
3. Click on administer > modules .
4. Check Enabled for module aggregator.
5. Press  Save configuration to enable this module.
6. Click on administer > users .
7. Scroll to aggregator module > administer news feeds..
8. Check the boxes to enable this permission for your chosen roles.
9. Press  Save permissions to set these permissions.
10. Add news feeds as required.

1. Login with administration role.
2. Ensure the administration block is being displayed.
3. Ensure the aggregator module is enabled.
4. Click on administer > aggregator .
5. Click on tab
   add feed
6. Enter the details of the news feed: the name you wish to use, the URL of the RSS or RDF feed, the frequency of update and, optionally, how many of the most recent news items should be displayed in a new block.
7. Press  Submit to enable this news feed.

You can add additional links to quick links:

1. Login as the admin user.
2. Add bookmarks for this user.

These new bookmarks will be available to all users through their quick links block.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > blocks .
4. Configure the blocks as appropriate:
   • Check Enabled for each block to display by default for all users.
   • Check Custom for allow users to choose which block they want displayed.
   • Reorder the placement of blocks by changing the relative weights of the blocks.
   • Locate the block on left or right sidebars.
5. Press  Save blocks to enable these changes.

You can add additional the Navigate toolbar options to allow authenticated users to list all published content of a specific type. Project Requests are displayed by default.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings  > flexinode .
4. Scroll to the Flexinode Listings section.
5. Check Display toolbar shortcut for listing ... for the content type your users want to see.
6. Press  Save configuration to add the selected types to the toolbar.

All authenticated users will see these additional options on the Navigate toolbar.

As a Collaborative Framework administrator, you can restrict the maximum size or types of files which can be uploaded to Self-Service Analytics.

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > uploads .
4. Configure the uploads as appropriate for your needs:
   • In the Settings for authenticated user section, set Maximum file size per upload to restrict size of uploaded files and Permitted file extensions to restrict the file types available for upload.
   • In the General settings section, set Maximum total file size.
5. Press  Save configuration to enable these changes.

Outbound mail is used to notify new users of their password, and also for subscription notification (if you have 'subscriptions' module enabled). This is all configured during the installation. However it can be modified by following the steps below:

1. First you'll need to remote desktop to the server:
2. Using the control panel, stop the 'Quadstone Portal Web Server' service
3. Using a text editor, edit %QSHOME%\qp2.2A\portal\apache2\php.ini and find the [mail function] section. Information similar to the following should be entered:

   [mail function]
   SMTP = email.quadstone.com
   smtp_port = 25
   sendmail_from = quadstone@company.net
   

4. Restart the 'Quadstone Portal Web Server qp2.2A' service.
5. Now test it:
   1. Use your local web browser to log in to Self-Service Analytics as the admin user. Go to administer > modules and click the enable box for mailhandler and subscriptions modules, then  Save Configuration.
   2. Now log out and back in as your own user, and visit any content page of your choice. You should see a 'subscribe' icon near the title. Click on it to subscribe to the page.
   3. Log out and back in as admin and visit the same page. Edit or comment on it. When you submit your change, there should be a grey box near the top of the page (you might need to scroll up) detailing the people who got notified. You should also receive an email in your normal email box.

Self-Service Analytics can be configured to allow users to reply to outbound emails, with these replies captured within the Collaborative Framework content.

The inbound mail is where you set up a POP or IMAP-accessible mailbox, which Self-Service Analytics automatically polls during it's background cron processing. This can be used to add content into Self-Service Analytics via email. Currently it is setup to post replies to subscription notification mail as a comment to the original node. This mailbox should be configured as the 'outbound' email address, the mailhandler module should then be enabled and configured it via administer > mailhandler.

Please ensure cron processing is enabled and that 'Delete messages after they are processed?' is ticked.

1. Log in to Self-Service Analytics as user with administration role,
2. Go to administer > mailhandler.
3. click on link add mailbox, and complete as follows:

     Email address: quadstone@company.net
     Folder: INBOX (leave default)
     POP3 or IMAP: select IMAP
     mailbox domain:
     mailbox port: 143
     mailbox username: quadstone
     mailbox password: <leave blank>
     mime preference: select plain text
     security: disabled
     send error replies: enabled
     from header: <leave blank>
     default commands: "type: comment" (without the quotes)
     signature separator: --
   

4. tick the box to delete messages
5. enable cron processing.
6. Finally click  submit.

To test it, use your mail client to reply to the message you have received from the subscription notification above, and wait a few minutes (or go to the administer > mailhandler > list page and click  retrieve), and visit the original content page and see if a new comment has been added. Then test it by triggering a subscription notification by subscribing to some piece of content and making a change to it from a different user account. This will trigger an outbound mail confirming your SMTP setup is correct. You should then reply to that message and either wait for mailhandler to automatically poll (if you've enabled cron processing) or just use the  retrieve link at administer > mailhandler and check that it adds your reply as a comment.

The query page is where queries are built and executed using the underlying dataset. To access this page:

• For users with the profiler role goto the homepage which should correspond to the query page of your current Dataset
• Browse to the Dataset you wish to query. Then:
  • click on one of the field names to start a profile of this field
  • click on

    query

    to start with a default query.

This will display a query page to allow you to select the fields, measures and filters for your query.

The query page consists of a number of panes:

• the tab navigation: breaking down into:
  • tab
    query
    used to provide access to the list of fields, which contain the elements of the query for these fields.
  • tab
    layout
    used to allow you to change how the query results are displayed.
  • tab
    advanced
    used to allow you to further customize the information displayed in the results.
  • tab
    results
    the tables and charts containing the values generated from the current query.
  You can navigate by clicking on these tabs at any time during the analysis process, with the results only updated when  Go button is pressed.
• information about the current dataset (including sizes and recency),
• action link to save and load query elements,
• the current query, which shows the state of the current query, and provides you with  Go button to run the query. When  Go is pressed, the current query is executed and the results tab is brought into view, with the numbers updated for that query.
• the page associated with the current tab.

A typical user workflow of the query page could be like:

1. Browse to the query page
2. Add an additional segmentation field
3. Press  Go to run the query
4. Look at the results
5. return to the query page to add a filter to restrict the results
6. Press  Go and look at the results
7. Change the layout of the results
8. Press  Go and look at the results
9. Add a custom segmentation to one of the fields, or additional custom measures
10. Press  Go and look at the results

In most places where a list of fields is presented (and depending on the associated metadata) they are displayed grouped into related topics — with navigation of this hierarchical list by opening and closing groups. To navigate this field list:

• For all fields and groups, hovering over the name will display a description of that field or group (if such a description has already been added).
• Clicking on field groups (or the plus sign beside the name), shows their contents — which may be any combination of fields or further field groups. What groups are open or closed will remain in place between queries.
• Clicking on fields has different effects depending on the location of the field list. In a dataset, clicking on a field creates a profile of this field, while on a query page, clicking on a field (or on the plus beside the name) displays the query options for this field.
• As an option to manual browsing for fields, you can use the find fields facility.

A text box exists at the bottom of each field list to ease the finding of fields in a field list. To find a field containing a specific phrase in its name or description, type the phrase into the text box and click on link Find. To clear this text box, click on link Clear. The field list will be displayed with fields with this phrase in the name or description highlighted in the view. Note: this search is case sensitive.

You can create any crosstab query or profile query you like, using any combination of fields and functions through the query page.

1. Access the query page for your chosen dataset.
2. Browse the hierarchical field list, until you find the field you are looking to use.
3. Click on the field name to see the query options available.
4. To add this field as a segmentation of the query, click on the field name. The field you have selected will appear in current query pane.
   

   The query options for a field. Highlighted is the option to add this field as a segmentation to the current query

5. To add a measure of this field as a summary figure of the query, click on the named measure (which includes the field name and some function). The measure you have selected will appear in current query pane.
   

   The query options for a field. Highlighted is the option to add a measure of this field to the current query

6. To add a filter on this field to restrict the records used in the query, click on the appropriate filter type (a number of different filter choices will be available depending on the field). The filter you have selected will appear in current query pane.
   

   The query options for a numeric field. Highlighted are the options to add filters on this field as a record restriction to the current query

7. Press  Go to run the query. This will generate a chart and a table of the query results.

You can customize the layout and contents of the results produced by:

• Add a field, measure or filter to the current query.
• Remove a field, measure or filter from the current query.
• Generate separate profiles for each field to create a series of profile query views (as opposed to a single crosstab query).
• Change how the filter clauses are combined.
• Alter the way the results are displayed.
• change the way the values are grouped in segmentation fields.
• create new measures from calculations on the existing measures.
• Save the query or filter for reuse.
• Undo the last action, or clear the query completely.

• Browse to tab
  query
• Add fields, measures or filters in the same way as creating the original query.

In the current query, click on the element you want to remove from the query (when you hover over these, the cursor will change to be a delete symbol).

• Note: at least one measure must remain in the query.
• You can also reset the current query to its original state, or remove the last added query element.

By default, the count measure is always present in a new query and will be displayed when a query is reset. You can the count measure from the Defaults group at the top of the fields list.

By default, queries are generated as crosstab querys. This means all the fields specified are used to create a single query result. However, you can change this default:

1. In the current query pane there is an option to calculate either a crosstab or profile.
   

   The query type selector — highlighted is the choice between crosstab, profile and dataview queries

2. Select which query type you want, either:
   • crosstab to create a single query result combining all fields, or
   • profile to create independent results from all fields.
   • dataview to list individual records.

By default, filters are combined to require all filter conditions to be satisfied before a record is used (or included) within the query. This is equivalent to an 'and' logical combination of filters. However, you can change this default:

1. In the current query pane there is an option to include all or any of the records.
   

   The filter combination selector — highlighted is the choice between including using all or any filter combinations

2. Check which filter combination you want, either:
   • all: to include records which satisfy ever filter clause in the query (equivalent to an 'and' combination), or
   • any: to include records which satisfy at least one of the filter clauses in the query (equivalent to an 'or' combination).

From tab (either ad-hoc or saved), you can export the results numbers to Excel for further processing. In either case, in the the Query section, click on link Open in Excel.

In the current query pane, click on link clear. This will return the query to its original state — with the single 'count' measure and no fields or filters.

In the current query pane, click on link undo. This will return the query to the state before the last action. You will then have the option to undo this change — click on link redo.

You can save queries or filters for reuse at a later date, simplifying the process of recreating a useful query without having to pull together all the individual elements manually each time you want to use them.

1. In the current query pane, either click

   save query

   to save the full contents of the current query (including filters), or click

   save filter

   to only save the filter described in the current query.
2. In the popup:
   

   Save a query or filter popup. Highlighted is the default "Profiler area" destination folder once saved.

   • Give a suitable title. This name will be used when loading the object, or when browsing the location where the save object is stored.
   • Edit the description (by default this includes the definition of the query or filter, but you should add something more meaningful). This description will be provided when you view the saved object, or as hovertext when you use the load option.
   • Select a location to organize this saved content (by default this will be your default save location). This will be used when organizing your saved queries and filters alongside all other saved content.
3. Press  OK to complete the save operation.

You can load saved queries or filters for reuse, simplifying the process of recreating a useful query without having to pull together all the individual elements manually each time you want to use them.

1. In the current query pane, either click

   open query

   to load the full contents to the current query (including filters), or click

   open filter

   to only replace the filter described in the current query with this new filter.
2. In the popup
   

   Load a query or filter popup.

   1. A list of previously saved queries or filters is displayed (in the folder order).
   2. Use the name or location to select which query or filter to load.
   3. Either:
      • For queries: click on the name to load the query, or
      • For filters:
        • in the Options pull-down, select click on link add negated to add a filter which excludes records defined by that filter,
        • in the Options pull-down, select click on link add expanded to add a filter by its description, rather than its name,
        • click on the name to load the filter as a named filter.

The current query (or its filter) will be replaced by the loaded query description.

To save the results of a query (as opposed to the query definition itself) and publish them for other users:

1. Browse to tab
   results
2. click on link Publish result.
3. Complete the details of the Query.
4. Press  Submit to publish the Query.

This will create a snapshot of the query results which can be viewed alongside other published content, and will not change with time.

You can limit the records which take part in a query by adding filters. Different types of filters exist depending on the type of the field on which the filter is based.

• For all filter types, you have the choice to include or exclude records based on that filter. This is done through a is/is not toggle — which allows the user to invert the selected filter. Flipping the toggle is reflected in the current query description of the filter.
  

  Include or exclude selected records choice

• For all field types, you can select whether the records in that field are missing or not missing (e.g. whether they have a defined value or not). Clicking on either option will add opposing filter clauses to the current query.
  

  Include or exclude missing values

• For categorical fields, you can select on specific field labels. Clicking on a label will select records with field value equal to the selected value. As for numeric filters, this selection can be inverted to exclude those values selected.
  

  Select on labels. Highlighted is the user choice to include or exclude the selected values from the query.

• For numeric fields, you have a choice of:
  • selecting a predefined range: click on the range label to add a filter on records with values in the range selected. The ranges are inclusive at the lower end and exclusive at the higher end.
    

    Select on ranges. Highlighted is the user choice to include or exclude the selected ranges from the query.

  • selecting an user defined range: enter values into the textboxes provided, and click on link Add to create the filter. Entering values into only one box will create an open ended selection e.g. values greater than 10. Un-checking the boxes will change an inclusive selection into an exclusive selection (e.g. the end value will not be included in the selection).
    

    Select on user defined ranges

• For date fields, you have a choice of:
  • selecting values from predefined date ranges: click on the range label to add a filter on records with values in the range selected.
    

    Select on pre-defined date ranges

  • selecting values from your own range of dates: choose start and finish dates for the range either by selecting individual day, month and year components, or using the calendar () to choose a date. click on link add to add the date range to the current query.
    

    Select on ad-hoc date ranges. Highlighted is the calendar helper for selecting date values.

• For string fields, without categorical interpretation: only direct matching of string values is available: type the field value into the textbox provided and click on link Add to create the filter. Only records with values who exactly equal this will be included in the filter.
  

  Select on single string value. Highlighted is the opportunity to exclude a value from the query.

When loading a saved filter, you can choose to add the filter details (rather than the filter name), by selecting the click on link add expanded Option.

When loading a saved filter, you can choose to use this to exclude the customers specified by the filter, choose the click on link add negated Option.

You can create a new filter on the current query directly from the results tables or charts. These filters take into account all segmentation fields involved in the query. To do this, you either:

• Click on a table segmentation field label, to add a filter on that field only.
  

  Creating a filter from a table label. Highlighted is a segmentation field label, which adds a filter on this field to the query.

• Click on a table result cell, to add a filter corresponding to all the field labels which define that cell.
  

  Creating a filter from a table cell. Highlighted is a link which would add a filter on all segmentation fields defining this cell.

• Click on a chart result bar or line point, to add a filter corresponding to all the field labels which define that cell.
  

  Creating a filter from a chart. Highlighted shows clicking on a bar to add a filter defined by the two segmentation fields of the chart.

• Click on the value in the dataview result, to add a filter corresponding to the selected value.
  

  Creating a filter from a dataview result table. Highlighted shows clicking on a value to add a filter defined by the the segmentation field and its value.

You can view a list of customer records from any dataset published in Self-Service Analytics. You do this by specifying a description of the group of people:

1. Query the Dataset you wish to select from.
2. Build up a filter to represent the records you wish to display.
3. Select a dataview query type.
4. Press  Go to display the first 20 records selected.
   

   Display dataview query results of individual records

5. To view more than 20 records, change the number of rows value and press  Update.
6. To export the displayed recordset to Excel, click on link Open in Excel.
7. Press  Next and  Prev to scroll through the groups records.
8. Optionally, save or load a dataview query.

Note:

• All the fields used as segmentations, measures or filters are displayed in the dataview query.
• You can configure the dataset to always include specific fields in a dataview query result.

If you add a filter to the query, restricting the query to a subset of the data, you get an additional export records action link in the results tab. This allows all of the selected customer records to be exported into another system. You are prompted from some details of the export, which are saved within Self-Service Analytics: A job then executes in the background configured using a Portrait Customer Analytics build script.

Users can export records from a query. A user (role) must have a specific permission to export records.

1. Configure user permissions.
2. Scroll to quadstone module > export records
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

You can see the status of any recent jobs from http://server:portnumber/?q=qsjobs.

You can configure the details of how the export is deployed by editing the build script in: QSHOME/2.2A/ws/config/jobscripts/exportrecords.qsb This script takes the following parameters:

focus

Path and name of the underlying Portrait Customer Analytics focus containing the data (also referred to from parameter exportlist.focus.pathname). This focus is created for this export script in a temporary directory with a record selection of the relevant population in-place (on field qs_vfield_portalSelection_selectOnes). You can delete it upon completion of the export.

exportlist.drupal.user.uid

The user identifier of the person running the export.

exportlist.drupal.user.company

The company identifier of the person running the export.

username

The username of the person running the export (also referred to from parameter exportlist.drupal.user.name).

jobname

A user-supplied name for the job.

jobid

A unique identifier for the job.

exportfield

Name of the field describing the model or targeting segmentation (typically CampaignTargetingField).

fields

A comma separated list of fields including at least the above export field and any showData fields in the dataset.

campaignnid

The Self-Service Analytics identifier for the campaign content (also referred to from parameter exportlist.nid).

exportlist.title

The title of the list content item saved on export.

exportlist.cellcode

The code given with the list content item saved on export.

exportlist.date

The date on which the export was started.

A data dictionary is displayed when viewing a dataset page. This can be accessed either by browsing to the dataset page, or from the current query.

To see the data dictionary for the dataset underlying your current query click on in the query page.

You can return to the full details of the underlying dataset behind a query. Simply, click on on the Query toolbar.

If the Query has been published with an associated Dataset you will be able to execute another query against this same dataset by clicking the click on link run by the query definition.

You can change the way results are displayed through tab

1. In Layout choices, select how you want the query results displayed. Not all options will be available to all users.
   

   The options available to change how the Queries are displayed. Highlighted is the selection box of the five key combinations.

2. Optionally, check Show empty rows. This will display all rows and columns in the results, irrespective of whether there are any values to be reported (missing query cells report 'NULL' values).
3. Optionally, check Allow piecharts. This will display the results in a piechart if the query consists of a single field and for the query measures which can be meaningfully summed.
4. Optionally, for queries with more than one field, check Manual layout to allow you more control over how fields and measures are attached to the axes of the charts or tables. The options include:
   

   The options available to change how the Queries are displayed

   • Rows: to select which field is displayed on the vertical axis of the results table (or the x-axis of the chart), or
   • Column items: to select which of the remaining fields or, alternatively, measures is displayed on the horizontal axis of the results table (or as the stacked or interleave bards of the chart), or
   • check Single table to include all measures in a single result table (as opposed to displaying each measure in a separate result table).
   All fields which are not explicitly placed on rows or columns will be displayed on pages: each value of each page field will be displayed as a separate table.
5. If you select a Display choices which contains a plugin, select which Plugin option you wish to use (though only certain options are available depending on the type of query).
6. Press  Update to refresh the display of the query results.

If you have suitable permissions, you can change the way a Query is displayed (for all users):

1. Click on tab
   edit layout
2. Select the layout choice required.
3. Press  Update to change the display.

When changing the layout of a query a preview of the layout which you will get after the query has been run is displayed. As you change the layout choices, the preview updates.

In tab choose Display types to include either tables or charts, and in section Sort by contains a pull down list of fields and measures. If you select one of these, the results tables and charts will be ordered (in ascending alphabetical order) by these values.

In tab choose Display types to include an option with charts, and check Show linecharts. The layout preview will update, and the result charts will be displayed with lines.

In tab choose Display types to be 'Single table'. The layout preview will update, and the results will contain a single table with all of the segmentation fields spread across the vertical axis.

Set up a single table result, and in tab check Hide summary to hide the summary rows in the results.

In tab check Show empty to hide the rows in the results which have empty results cells.

Set up a single table result, and in tab select from Fastest moving to pick the field which will be used as the fastest moving (right most) field in the results table.

Dual-axis charts are the default chart types when there are exactly two measures across a single segmentation field in a query result. Dual-axis charts show both of these measures on a single chart, with one measure on each vertical axis, blocks to show one measure and line to show the other. You can decide not to use a dual-axis chart to display your query results:

1. browse to tab
   layout
2. uncheck Use dual-axis charts
   

   Dual-axis layout.

3. click  Update

Compatible measures are either measures on the same field, for example average Income, maximum Income and minimim Income, or the same measure on different fields, for example average SpendJan, average SpendFeb, average SpendMar. By default, Self-Service Analytics will try to display compatible measures by a single segmentation field on a single chart. But you can select which measures are compatible:

1. browse to tab
   layout
2. in the Use single-axis charts check the measures you want to appear on the same chart
   

   Compatible measures, all displayed on a single chart. This example includes measures on the Income field.

3. click  Update

Self-Service Analytics can combine profiles (of a set of related fields) into a single table and chart, if all the fields share a common set of values or common custom segmentation.

By default, all query result labels use a set of abbreviations:

• numbers: K for thousands, M for millions. To suppress these abbreviations, configure the dataset metadata setting the kmbinlabels attribute of each required field element to false.
• dates: English language descriptions in the format DD MMM YYYY, without time components, and collapsing repeated date components e.g. 20 to 25 Mar 2005 or 20 Mar to 20 Apr 2006. To suppress these abbreviations, configure the dataset metadata setting the ymdlabels attribute of the metadata element to true.

The formatting abbreviations used in the display can also be used when you enter numeric values in filter end-point and custom segmentation boundary definitions. For example, you could enter 100K for the value 100000. You can also use comma thousand separators for these inputs. For example, you could enter 100,000 for 100000, and 1,000,000 for 1000000.

Fields which represent currency values can be configured to be displayed (either in segmentation labels or measures in results) using the relevant currency symbol. You can do this by setting the currency attribute of each relevant field element to the currency character of choice (e.g. $).

Fields which contain binary values or whose values are limited to the range [0,1] can be configured to be displayed as percentages. You can do this by setting the percentage attribute of each relevant field element to true.

The labels used on chart and table rows and columns are created automatically by Self-Service Analytics. However, you can override these labels with your own. You can do this by embedding a custombinlabel attribute to each relevant field. You can then configure a specific label to represent a range of values by adding upperboundary, lowerboundary, and label attributes.

You can configure the default chart type and size of charts for all users of Self-Service Analytics:

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings > profiler.
4. Set the option you are interested in:
   • enter chart width and height values (in terms of pixels)
   • check Show linecharts to display line charts by default.
5. Press  Save configuration to save these defaults.

For improved performance, segmentation afields with large numbers of values or categories are treated differently. You can configure what is a large number of categories:

1. Login with an administrator role.
2. Ensure the administration block is being displayed.
3. Click on administer > settings > profiler.
4. Set the limit in the Category threshold textbox.
5. Press  Save configuration to save this default.

A timeline query has a set of results from different snapshots in time (corresponding to the evaluation of the query on subsequent datasets in the dataset series). Between the Query: description and the results tables or charts is:

• The Series: link to the dataset series, and
• The label of the dataset of the current result, with links to the next and previous results in the series. click on link previous result to view a result from an earlier dataset, and click on link next result to view the result from a later dataset.

When publishing or editing a query, if you have sufficient permissions, in Series, check Repeat to make this Query refreshed when new datasets is added to the dataset series.

The navigation of a timeline query contains a label to indicate the result displayed. This is either the dataset name, or the date on which that dataset was published. To change this:

1. Log in with a role with sufficient permissions
2. Click on tab
   manage
3. In the Series labels section click:
   •  Use dataset publish date to use the date as the label
   , and
   •  Use dataset title to use the name of the dataset as the label.
   The text in this section will update to reflect the current choice.

1. Configure user permissions.
2. Scroll to qs_profiler module > administer timeline queries
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

1. Configure user permissions.
2. Scroll to qs_datasetseries module > administer dataset series
3. Check the box to enable this permission for your chosen role.
4. Press  Save permissions to set the role's permissions.

The list of queries scheduled for refresh is listed on the dataset series page. The query result page contains a link to the dataset series it belongs to.

Either create, publish or move a published dataset to the same folder as the dataset series.

Either:

• delete the dataset, or
• move the dataset out of the dataset series folder, or
• manage the dataset series to exclude this dataset.

The progress of which queries have been refreshed and which datasets have been used to refresh them is listed on the dataset series page. The dataset list shows what proportion of the queries have been updated, and the query list shows what proportion of the datasets have been used in this update.

The list of datasets associated with a dataset series is listed on the dataset series page. This page also includes an indication of which is the current dataset in the dataset series. The dataset page itself contains a link to the dataset series it belongs to.

The dataset page contains a link to the dataset series it belongs to.

The current dataset in a dataset series is listed on the dataset series page. For users with sufficient permissions, this can be changed to be another dataset in the series. The current dataset is automatically update when new datasets are added to the dataset series.

Dataset series are managed from tab This includes

• Setting the current dataset
• Including or excluding datasets from the dataset series (without moving the datasets from the folder)
• Setting the format of the date labels in the timeline queries

The current dataset is automatically set to be the dataset most recently added to the dataset series. You can change this to be another dataset in the series by:

1. Browse to the dataset series
2. Click on tab
   manage
3. In the Included datasets section click  Make current on the dataset you want to be used as the current dataset.
   

   Setting the current dataset in a dataset series

For users of Self-Service Analytics who are not familiar with the details of the fields and datasets published in the system, an intelligent search capability is available to suggest useful queries — based on a plain language description of what the users is looking for. The idea is to make searching structured data as simple as searching unstructured data is on the internet. To request query suggestions, you simply type the text you are looking for in the suggestions box and press  Suggest queries. A list of possible queries, ordered by relevance, will be returned to you. These queries can then be executed. From this list of results, either:

• Browse the suggestions: click on link Next to view the next five search results, click on link Last to view the last five search results, click on link Previous to view the previous five search results, click on link First to view the first five search results.
• See the query results from a suggestion: click on the suggested query to calculate its results on the current data.
• Modify the suggestion using the query tab.

To see the suggestions box as part of your current query either:

• log in as a user with the executive role, in which case, the query suggestions are your sole way of querying the data, or
• switch your current query from the build query mode to the suggest query mode.

From the list of query suggestions, click on the query which you want to run. The result of this query will be displayed in tab The description of this query will now be displayed in the suggestions box. This will allow you to easily refine your search for suggestions.

To refine the suggestion text, either:

• edit the text in the suggestions box, either including additional names (of fields) or values (for selecting particular data values) or removing suggestion contents for a broader search, or
• browse to tab
  query
  and use the folding field list to add additional breakdown fields or to select particular data values.
  

  Adding structured query elements to your suggestions. Highlighted is an example of where a filter on Gender has been added.

When you rerun the suggestions, this changes will be taken into account.

click on link suggest queries above the current query.

click on link build query above the current query.

Roles can be configured to restrict users with that role to only access Self-Service Analytics through the executive interface. This is the default configuration of the executive standard roles.

1. Configure user permissions.
2. Scroll to quadstone module > structured queries
3. Uncheck the boxes to restrict this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

You can add a custom segmentation to any field which has been added to a query. To do this:

1. Browse to tab
   advanced
   This can either be directly using the query page navigation, or via a shortcut link on the field names in tables or data dictionaries on tab
   results
2. Browse to secondary tab
   custom segmentations
   :
   

   Custom segmentations on the advanced tab

3. Click on the name of the field you want to add a custom segmentation.
4. • For numeric fields, select to add a custom segmentation with either equal width ranges, equal population ranges, or user defined boundaries.
   • For date fields, a similar set of choices exist, with the addition of specifying a periodic interval.
   • For string or categorical fields, create a custom segmentation by merging (and renaming) the existing categories
5. When you have made your changes, click on link add to add the custom segmentation to the field.
   

   A custom segmentation on a field. Highlighted is the add link, required to add the segmentation to the query.

A field in the current query with a custom segmentation is marked with an asterisk:

Click on the asterisk marker on the field to remove the custom segmentation.

Changing an existing custom segmentation follows the same procedure as adding one in the first place. From the results page, a custom segmentation can be quickly changed by clicking on the name of the field you want to customize.

1. Add another customer segmentation to the field.
2. Select custom segmentation with equal width ranges.
3. Enter the number of ranges you want to create.
4. click on link add to add the custom segmentation to the current query, or
5. Save this custom segmentation for use on another field.

1. Add another customer segmentation to the field.
2. Select custom segmentation with equal population segments.
3. Enter the number of ranges you want to create.
4. click on link add to add the custom segmentation to the current query, or
5. Save this custom segmentation for use on another field.

1. Add another customer segmentation to the field.
2. Either:
   • Create a custom segmentation by specifying a new set of boundaries:
     1. click on link new
        

        User defined custom segmentation.

     2. Enter the boundary values.
        

        User defined custom segmentation.

     3. Click  OK to set the custom segmentation definition on the field.
   • Edit the boundaries of the existing custom segmentation with user defined boundaries.
   1. Either:
      • Click to add a new range within these boundaries
      • Click to remove this range.
      • Type alternative numbers in the Boundary boxes to change the (lower) boundary value for this range.
   2. click on link add to add the custom segmentation to the current query, or
3. Save this custom segmentation for use on another field.

For a date field:

1. Add another customer segmentation to the field.
2. Choose to create a custom segmentation with equal width ranges.
3. Select the periodic interval to group by.
4. click on link add to add the custom segmentation to the current query, or
5. Save this custom segmentation for use on another field.

1. Add another customer segmentation to the field.
2. Either:
   • Check the boxes of the categories you want to combine, and click on link merge to combine them.
   • Check the boxes of the categories you want to separate, and click on link split to break them down into their case category values.
   • Click on the field name to rename it.
3. click on link add to add the custom segmentation to the current query, or
4. Save this custom segmentation for use on another field.

After preparing the custom segmentation, you can store the description for use at a later date or on another field:

1. In the custom segmentation pane, click on link save to save the custom segmentation currently displayed for that field.
   

   Highlighted is the action link to save a custom segmentation.

2. In the popup:
   

   Save a custom segmentation popup

   1. Give a suitable title. This name will be used when loading the object, or when browsing the location where the save object is stored.
   2. Edit the description (by default this includes a definition of the custom segmentation, but you should add something more meaningful). This description will be provided when you view the saved object, or as hovertext when you use the load option.
   3. Select a location to organize this saved content (by default this will be your default save location). This will be used when organizing your saved queries and filters alongside all other saved content.
3. Press  OK to complete the save operation.

You can load saved custom segmentations for reuse, simplifying the process of recreating a useful custom segmentation without having to pull together all the individual elements manually each time you want to use them.

1. Browse to tab
   advanced
2. Browse to secondary tab
   custom segmentations
   .
3. Browse to the field you want to add the custom segmentation to.
4. click on link open
   

   Highlighted is the action link to load a custom segmentation.

5. In the popup
   

   Load a custom segmentation popup

   1. A list of previously saved custom segmentations is displayed (organized in your folder structure).
   2. Use the names, descriptions (provided as a screentip when hover over the name), location or saved date to select which query or filter to load.
   3. To load the selection, click on link on the name.
6. click on link add to add this newly loaded custom segmentation to the current query.

The current custom segmentation on the field will be replaced by the loaded custom segmentation.

From the results tab, click on the field name in the results table to change the custom segmentation on this field. You will be taken directly to tab with the custom segmentation for this field opened.

1. Configure user permissions.
2. Scroll to quadstone module > advanced profiler features.
3. Check the boxes to enable this permission for your chosen roles.
4. Press  Save permissions to set these permissions.

You can create custom measures using any measure (or custom measure) which has been added to a query. To do this:

1. Browse to tab
   advanced
   This can either be directly using the query page navigation, or via a shortcut link on the measure names in tables or data dictionaries on tab
   results
2. Browse to secondary tab
   custom measures
   .
   

   Custom measures on the advanced tab

3. Use the calculator to build up your custom measures (based on existing query measures or other custom measures, combined with some calculation). For example:
   • perform cell arithmetic on query results.
   • display results as summary percentages
   • display results as differences
   • display results as rank ordering
   • display results as cumulative totals
4. Give your custom measure a name.
5. When you have made your changes, click on link add to add the custom measure to the query.

A new measure will be added to the current query and the measure (with its description) will be added to the table of custom measures below the calculator. After building up a set of custom measures, you can:

• Run the query to see the results, by pressing the  Go.
• Remove a measure from the current query.
• Remove a measure from the custom measures.
• Create a similar custom measure based on an existing custom measure.
• Save the set of custom measures for reuse.
• Load a saved set of custom measures.

You can add custom measures which perform simple arithmetic calculations on each cell of the query result independently. For example, you could subtract a measure of costs from a measure of revenues to produce a simple profit breakdown across the segmentation fields. You would do this by selecting the two measures and how they are to be combined.

1. Select the left hand measure.
2. Select the arithmetic operation to combine them.
3. Select the right hand measure.
4. Optionally, give the new measure a meaningful name.
5. click on link add to add the measure to the query.

For arithmetic calculations the measures can either be:

• Other base query measures
• Predefined custom measures
• A constant value. In this case, a value is given by default, but you use a different constant value by selecting to Change constant and providing the new value in the pop-up box that appears.


Selecting to change the constant used in an arithmetic custom measure

You can add custom measures which displays each cell of the query result as a percentage of the summary figure. For example, you could do this for a single segmentation query to show the population counts as percentages e.g. across a Male/Female split. Further, if two segmentation fields are included in the query, you could show the population counts as percentages of rows (or across one of the query dimension), to show a breakdown by Age, but normalised compared to the Gender breakdown. You would do this by selecting one measure and the summary calculation to define how the base measure is to be displayed.

1. Select the measure.
2. Select the appropriate Percentage ... operation to display:
   

   Adding a percentage custom measure

   • Percentage of column: displays results as a percentage of the column summary, for each query result column independently.
     

     Percentage of column. Highlighted is a column of results, all expressed as a percentage of the column summary figure.

   • Percentage of table: displays results as a percentage of the table summary, for each query result table independently.
     

     Percentage of table. Highlighted is a cell value, the summary across the whole table, and this cell value expressed as a percentage of the table summary.

   • Percentage of overall: displays results as a percentage of the whole query summary, across all pages of the query result.
   • Percentage of first column: displays results as a percentage of the first column in the result table, across each query result column independently.
     

     Percentage of first column. Highlighted is the first row of the table, another row of the table, and that row expressed as a percentage of the first row.

   • Percentage of first row: displays results as a percentage of the first row in the result table, across each query result row independently.
     

     Percentage of first row. Highlighted is the first column of the table, another column in the table, and that column displayed as a percentage of the first.

3. Optionally, give the new measure a meaningful name.
4. click on link add to add the measure to the query.

Note:

• for queries with a single segmentation field, ... column, ... table and ...overall all display the same results.
• for queries with two segmentation fields, ... table and ...overall display the same results.

If a query result has only two rows, a difference row will be automatically displayed. You can add custom measures which displays each cell of the query result as a difference of the summary figure. For example, you could do this to show the uplift in response rates between treated and control groups for a marketing campaign. You would do this by selecting one measure and the summary calculation to define how the base measure is to be displayed.

1. Select the measure.
2. Select the appropriate Difference ... operation to display:
   

   Adding a difference custom measure

   • Difference of column: displays results as a difference from the column summary, for each query result column independently.
     

     Difference from column. Highlighted are rows which show the difference between the values and the summary values.

   • Difference from table: displays results as a difference from the table summary, for each query result table independently.
     

     Difference from table. Highlighted are a cell in the table, the table summary cell, and these cells displayed as a difference from the overall table summary cell.

   • Difference from overall: displays results as a difference from the whole query summary, across all pages from the query result.
   • Difference from first column: displays results as a difference from the first column in the result table, across each query result column independently.
     

     Difference from first column. Highlighted are the first row in the table and another row in the table, both displayed as differences from the first row.

   • Difference from first row: displays results as a difference from the first row in the result table, across each query result row independently.
     

     Difference from first row. Highlighted are the first column and another column, both displayed as differences from the first column.

3. Optionally, give the new measure a meaningful name.
4. click on link add to add the measure to the query.

Note:

• for queries with a single segmentation field, ... column, ... table and ...overall all display the same results.
• for queries with two segmentation fields, ... table and ...overall display the same results.