In your Account Settings there is a section called Licenses . This section displays all of the licenses you have purchased, along with any additional purchased blocks of editing or viewing time. Each line contains details on the number of hours used and the hours remaining. To access a more detailed explanation hover the mouse over the numbers.

The Usage Page

The Usage section of your Account Settings page contains a list of all edit, view, and API sessions for your account. You can filter the report by selecting the start and end date/time. Users with Administrator access can also filter the usage for specific users. You can export the report as a CSV file by clicking the document icon to the right of the filters.

Email Notifications

If you consume more than 50% of your hours before the middle of the year, you'll receive a notification by email. Notifications will then be sent by the Displayr system when your usage exceeds 80%, 90%, 95%, 99%, and 100% of allocated usage.

Tracking API Hours

Displayr does not track the time made for individual API calls. Rather, it tracks server time. Calling Displayr's API directly utilizes your view-mode hours which will appear in your Usage section under (API) as the User.

API usage against a Free document uses up the Free license view-mode hours. API usage against a Professional document uses up the Server time for private dashboards hours.

Viewing hours are computed based on the hours that the server hosting the document is active. When a document is initially published as a web page, a server starts to host the document. If no-one interacts further with the document through viewing pages or changing filters, for example, the server is shut down after 10 minutes. Later, if the published document is viewed, the server time starts again in order to provide data, and again the server is shut down after 10 minutes of inactivity. You can control this 10-minute period for each document by going to the Document Settings page, under Properties > When viewing this document, Displayr will stop your server after (minutes).

Note the instruction "While running, your server can respond without taking the time to start, but uses license minutes." There is a cost to starting a server and loading the required data. For example, if this time is set too low (e.g. 1 minute), it is likely that viewers of the document will see "Please wait" until the server starts.

Usage starts to be tracked as soon as the first API call is made.  The server will then remains active for another 10 minutes. If you make another API call within the 10-minute period, the server continues to remain active for another 10 minutes. When the server finally shuts down, we subtract a grace period from the overall time period (typically 5 minutes).

So, for example, if you make an API call once an hour, you would expect to see a usage time of 5 minutes for each API call (server was started and active for 10 minutes - grace time of 5 minutes = usage of 5 minutes). After a day, you would expect to see 120 minutes of usage (5 minutes of usage per hour * 24 hours = 120 minutes).

If you wish to issue API calls every 5 minutes, this effectively means the document's server will remain active indefinitely (24 hours per day). After a day, you would expect to see a full 24 hours of usage. Over a year this will total to roughly 8,760 hours.

Dashboard Usage Statistics

You can also download a log of the different actions users are performing from the Dashboard Usage Statistics section at the bottom of this page. This log contains information about particular actions that individuals perform, for example:

• When a filter was applied
• Which Tab (page in the document) was viewed
• Which user was conducting each action

To obtain a log of detailed usage, select a date range to define the period for which you want to view the logs. Use the Type menu to choose whether you want to see View or Edit usage, and then click on the document icon at the top right to download a CSV file of the results. You can open the file in Excel or another spreadsheet application.

Audit Trail

This report tracks when all documents are created, edited, and viewed.  Select a date range from the filters and use the icon on the right to download the CSV file.

To access the Documents page, login into your Displayr account, click the user icon in the top right corner of your browser window, and then select Documents. When working on a document, you can get back to the Documents page by clicking the Documents button in the top left corner.

To create a new blank document select + New Document and to create a new Folder select + New Folder.  If you have a professional license, you can also access the Upload button. It's also possible to create a new document by uploading a document saved as a QPack. To do that go to the Documents page > Upload > QPack to create a new document from your QPack. Additionally, you can also select Office/PDF to upload a Microsoft Office or a PDF document.

To Edit a document you can either click on the name of a document in the list or hover your mouse to the right of any document and click the Edit option that appears on the screen. Similarly, you can hover over a document and click the View button to open the document in View Mode.

Each user with access to your account is a member of one or more groups. For each document in your account, you can determine which of these groups are allowed to edit and view it.

For more detailed guides on how to control access for editing, viewing, and page-based viewing, see:

• How to Control Who Can Edit Documents in Displayr
• How to Control Who Can View your Documents in Displayr
• How to Control Who Can View Pages in your Document

Default Groups

New accounts will start with three levels of access:

• Administrators - members of this group can view and edit all projects. They can also add new users, create groups, and change the level of user access.
• Edit Projects - members of this group can view and edit all projects.
• View Projects - members of this group can view all projects. By default, all new users will be added to this group.

Creating Groups

To create a group of users:

1. Make sure your account is set up as a Multi-User Account.
2. Go to your company Settings page.
3. Scroll down to the Groups section. Here you will see the list of existing groups set up in your account.
4. Click on + New Group. You will be taken to a new page.
5. Enter a Group name.
6. Enter any group's notes in the Notes section.
7. Tick or un-tick the Explore checkbox based on whether or not you want users in this group to be able to use Explore mode. Users with enabled Explore mode have access to all of the data in your document, so this option is not appropriate for restricting access to parts of the data.
8. Click Save.

This group will now appear in the list of groups on the Settings page.

Assigning User Accounts to Groups

• General account preferences
• Billing details
• User and group permissions
• Administer and purchase licenses and server time
• Monitor usage of your server time

Most of these settings are visible only to account administrators although non-administrators can access some basic user account settings.

To access the Account Settings page, login in to your Displayr account and click the user icon in the top right corner of your browser window and select Account settings.

There are four sections or tabs on the Account Settings page: General, Settings, Licenses, and Usage.

General

In this section, you can make changes to your login and general preferences. These include:

• Password reset
• Time zone setting
• Default language
• New feature notifications

The password reset and time zone settings are user-based settings available to all users including non-administrators.

Settings

This section contains basic account and billing details as well as Users and Groups management. In this section you can:

• Enter/edit company name and account notes.
• Enter default settings for new user group assignments and global group permissions.
• Manage user password and complex password policies.
• View and update billing details such as contact name, email, country, address, and phone number.
• Edit theme CSS styling - you can customize your dashboard by adding customer CSS styling. Click Edit theme CSS/HTML (advanced)  to add your own CSS.  This blog post contains working examples of how to use CSS to customize your dashboard.
• Set Multi-User Accounts - by default, your Displays account is set as a single user account. You can convert it to a multi-user account by clicking the Expand button at the bottom of the Settings page.

Once converted to multi-user, additional options appear:

• New User - click the blue +New User button in the Users section to add a new user to the account. Enter the user name, email address, group membership, and notes. The user will be sent an email with a link to complete the account setup.

All users on the account will be listed in the Users section. Click on a user name to edit the user's details. Note that a specific email address can only be associated with one individual Displayr account.

• Bulk Import - this option can be used to set-up multiple users and groups at once. Select the Buk Import and follow the instructions provided to create and upload a CSV file.
• Groups - any groups created will be listed here. To create a new group, click the New Group button, enter a group name, and click Save. Click on a Group Name to see the details for that group. Here you can also see the members of that group. See the User Groups blog post for more details on setting up and managing groups.
• Webhooks -  used to setup a connection to another application (e.g. send R updated failures to Slack). The webhook URL is obtained from the other application and entered into the URL field after clicking on the New Webhook button.
• Configure Single Sign ON (SAML) - to setup Single Sign On, you need to contact us by emailing support@displayr.com to request a subdomain.
• Pending Bulk Import Jobs - any pending bulk user import jobs will be listed here.

If at any point you want to revert back to a single user account, you can click the Revert to single user company button at the bottom of the Account Settings page. Before doing this you will first need to remove all additional users leaving just one user with administrator privileges.

User accounts can be assigned one of the following permission levels:

• Administrators - allows the user to administer the account, including adding/deleting users, purchasing licenses, etc. Edit and View membership is automatically inherited.
• Edit Projects - allows the user to edit any document in your account. View membership is automatically inherited. The user will need to be assigned an annual license in order to be able to edit documents.
• View Projects - allows the user to view any document in your account. This user does not need a license. When the user views a document, their usage will be deducted from the pool of view-mode time.

Licenses

This tab lists available licenses and server time blocks that have been purchased and which are currently active. Administrators can use the "Add" buttons to purchase new licenses or additional server time. Members of multi-user companies without administrator privileges are able to view only their own licenses.

Individual account invoices can be viewed in the Invoices section with basic details including invoice issue date, payment due date, due amount, and payment status.

The Emails section contains a list of automated email communications sent from the Displayr licensing system including date, subject, and email category.

Usage

The Usage tab can be used to extract Displayr account access details.

• Plan Usage - in this section account administrators can view both edit-mode and view-mode usage for all users. The usage report can be filtered by date/time ranges and administrators are able to filter the results by up to 15 users. Non-administrators can filter by date range but are only able to view their own edit-mode usage statistics.  Up to 100 results are shown per page, however, a full list of results can be exported to CSV by clicking the document icon to the right of the search boxes. Note that the time zone used for usage results and the search boxes is Coordinated Universal Time. In the User column, you can see the names of users you have invited into your company. You may also see (API) - this indicates you are using the API to create or edit a document; see Tracking API hours for more details. You may also see (View / API) - this indicates server time was used for one of your exported dashboards.
• Dashboard Usage Statistics - here you can download a log of different actions that users are performing from the Dashboard Usage Statistics section at bottom of this page. This log contains information about particular actions that individuals perform, such as:

- A filter was applied
- Which Tab (page in the document) was viewed
- Which user was conducting each action

To obtain a log of detailed usage, select the From and To date range to define the period for which you want to view the logs, use the Type menu to choose whether you want to see View or Edit usage, and then use the icon on the right to download a CSV file of the results. You can open the file in Excel or another spreadsheet application.

• Audit Trail - this report tracks when documents are created, edited, and viewed.  Select the From and To date range and use the icon on the right to download the CSV file.

If you have any questions or need help you can always contact the technical support team by dropping them an email at support@displayr.com.

This feature is not included in the standard Displayr license, as it requires us to host multiple servers in the designated jurisdiction. Contact us to request a quote.

Displayr is used in two modes. When a document is authored, it's in edit mode. When a document is then shared with end users as a dashboard, it is in view mode. You can white label Displayr in view mode, but not in edit mode. We are sometimes asked to white label it in edit mode, but the challenge isn't technical, it's more one of practicality. In Edit mode, Displayr has an extremely large amount of functionality, and it is unlikely that any company will have the resources necessary to train and support users in edit mode.

Embedding in iFrames

Any Displayr document can be embedded in another web page using an iFrame. For example, the feature-packaged Burger Brand Tracking case study is shown below. When you embed a document this way, you can create the document so that it contains no reference to Displayr.

Single sign on

When a document is published as a web page (dashboard), you can set up logins and passwords for the users. If you have an enterprise account, you can also set up single sign on so that all the sign ons are managed via your software.

Automation via the API

Dashboards can be created, modified, and updated programmatically via our API. Click here for a worked example.

Customizing the CSS

Looking at the burger dashboard above, the document can be viewed as having three sections. There is the navigation menu on the left, the controls at the top (such as Search), and then the page itself. The page is designed in edit mode. The other two sections are customizable via CSS.

Subdomains

If you have an enterprise license, it's also possible to get a subdomain, so that the URL in view mode shows your company name. For example, while a document's URL may be https://app.displayr.com/Dashboard?id=8005620b-5699-4784-a28d-6da756afcd41#page=82f0e50d-04bf-4346-bbd5-a66d678aae8c, it would instead become, if your company name was AwesomeCo, https://app.awesomeco.displayr.com/Dashboard?id=8005620b-5699-4784-a28d-6da756afcd41#page=82f0e50d-04bf-4346-bbd5-a66d678aae8c

It's never technically possible for a dashboard to update instantly. Computations take time, albeit small amounts of time. And, the more rapid the updating the more intensive the computer resources. In Displayr, "real-time" means at best, every 10 minutes.

Updating data sets

When data is read in from URLs, SQL, and the Displayr Cloud Drive, there is an option for automatically specifying the regularity of updating of data. When reading in data sets via R, you can also write code to determine when they update.

Updating publication of the dashboard

If you follow the instructions above, you can get your data to update. The next step is to control when the dashboard itself is re-published, as this is required for a viewer to see the updates. This is done via Insert > Utilities > Automatic Updating which inserts an object on the page with options for controlling updating.

Rookie mistakes

There are a few easy-to-make mistakes when using automatic updating.

Automatic publication of documents being manually edited

If you are making manual edits to a document and it is automatically published, it will be automatically published with your incomplete edits revealed to your viewers.

Failure to sync updating

Let's say you have set your data to update every 24 hours. And, you've set your data to republish every 10 minutes. It will republish, but the results will still only change every 24 hours. Or, let's say you kick off automatic publication to occur every Monday, but you have automatic updating of the data on Wednesday. The published document will re-publish on Monday, but only showing the data up until last Wednesday.

Manual R Outputs containing UpdateAt and UpdateEvery

If you are using UpdateAt or UpdateEvery in your write R code these will cause the R code to be re-run, even if Automatic is not checked on the R Output.

Calculations without dependencies

The image below seems to show some impossible results. The automatic updating has occurred at 9:23, but the time stamp above is showing 9:16, so it hasn't actually updated. How has this happened? The code for computing the time stamp at the top is paste("Time where this server is located (somewhere East Coast USA)\n", format(Sys.time(), "%a %b %d %X %Y")) The key thing to note about this code is that it does not depend on anything else. Consequently, once it is computed there is nothing to tell it to recompute, so without doing something else, it will never update.

The fix for this problem is to refer to the automatic updating directly in the code, as in the example in the next section. What happens here is that whenever an R Output is referring to something that updates, it itself updates, and, and thus anything that refers to it will also update. As automatic.updating isn't used, it has no effect other than to trigger the calculation.

Caching

Consider asking a computer to calculate 1+1. There are two principal ways that a computer can give you the answer. One is it can compute the answer. The other, is it can search to see if it has previously answered the question, and return that result. This is known as caching and it is very widespread. It's very common that things on the internet are cached, as it both reduces computing resources and network load (as it can be cached near the end viewer). If, for example, the time stamp below is not correct within 10 minutes, that is due to caching. (But, keep in mind the effect of time zones!).

A page needs to be told to update

If you are looking at a page in Displayr in your browser, you will not see the results update until something happens to make the screen refresh. Like what?

• You can press the Refresh button in your browser
• If Displayr has fallen asleep, when it wakes it will update.
• Anything that performs a calculation on the page (e.g., using a filter).

Security is important to all of us, and in particular when dealing with your research data.  To ensure that you can see and understand who has accessed your documents in Displayr, and what changes and additions have been made, you can now download an Audit Trail report from Displayr.  Here's what to do:

1. Go to your Account > Usage page.
2. Scroll to the Audit Trail section at the bottom of the screen.
3. Select the From and To dates that you want to generate a report for.
4. Click the paper icon to download the .csv file.

Report Contents

The downloaded report contains nine columns with this information:

1. Timestamp of the event.
2. A description of the event (see below for what is recorded)
3. The ID of the user that caused the event.
4. The name of the user that caused the event.
5. The document ID number
6. The document name
7. The ID of any user whose status was changed.
8. The name of the modified user.
9. A details field.

Audited Events

The following events are included in the audit:

1. Create new Displayr document
2. Create Displayr document from QPack upload
3. Create Displayr document from /Try link
4. Create Displayr document from API using QPack
5. Create Displayr document from API using QScript
6. Duplicate Displayr document
7. Delete Displayr document
8. Edit Displayr document
9. View Displayr document
10. Download Displayr document QPack
11. Upload Office document
12. Delete Office document
13. View Office document
14. Add user
15. Remove user
16. Edit user groups

Part 1: Set up User Groups

If the dashboard is to be filtered according to a person's user group, then you need to begin by creating user groups and assigning your users to them.

To create a group:

1. Log in to Displayr.
2. Click on the Account icon in the top right and select Account Settings.
3. Select the Settings option
4. Scroll down to the Groups section and select + New Group.
5. Enter a Group name
6. Un-tick Users in this group can explore. (Explore mode allows people to see other data in the data set, so you need to turn this off).
7. Click Save.

In this article, I am creating a document that will filter results by Australian states, so I have created user groups in my account for each state that my stakeholders come from. The result looks like this:

In addition to the default user groups (Administrators, Edit Projects, and View Projects) there is a separate group for each state (ACT, NSW, NT, etc).

Part 2: Assign your users to groups

Next, in order to ensure that people only see results for a subset of the sample, each user requires an individual login and a correctly assigned user group. Importantly, you should avoid assigning these people to any groups that have access to the whole document. It will depend on how you have organized your groups, but typically, restricted users should NOT be part of the default groups like Administrators, Edit Projects, or View Projects.

You can assign a user login to a user group when you first invite them to Displayr. To do so:

1. Go to your account Settings page.
2. Click the + New User button in the User section.
3. Enter the person's Name, Email, and any Notes.
4. Choose the appropriate group in the Group membership section. You can choose more than one group by holding CTRL and clicking.
5. Click Save.

In the example above, the user Chris F will be added to the NSW user group when he accepts his invitation to join this Displayr account.

You can also change a person's group membership later on. To do so:

1. Click the person's name under the Users section.
2. Fill out the form as above.
3. Click Save.

Part 3: Create an R Output to identify the user group

Within your document, every page must contain an R Output which accesses the user groups for the person who is currently viewing the page.  One example of the code that you can use is as follows:

1. Select Insert > R Output.
2. Enter the code below into the R CODE section.
3. Click Calculate.
4. Hide this output by selecting Appearance > Hide.

The code I am using in this example is:

UserGroups = QViewModeUserGroups

if (is.null(UserGroups)) {
    UserGroups = c('NSW', 'VIC')
}
    
if ("Administrators" %in% UserGroups) {
    UserGroups = c('NSW', 'VIC')    
}
    
UserGroupsPage1 = UserGroups

The output will look like this in Edit mode, but will not be visible when viewing the document as it is hidden:

Some notes on how this code works:

• The special property QViewModeUserGroups is used to obtain the user groups.
• If you are in Edit mode, then the QViewModeUserGroups property returns a value of NULL. So the second part of the code checks for a NULL value, and in that case, manually assigns user groups NSW and VIC (for New South Wales and Victoria in Australia). When you want to test the appearance in Edit mode, this is the line to change.
• The third part of the code determines what account administrators will see when viewing the document. Again, here I have assigned NSW and VIC, and this line can be changed when you want to see what a person from a specific user group will see.
• The final line assigns the name of this output to be UserGroupsPage1. As mentioned above, an output like this needs to be present on every page that you want to filter for the user. It is good housekeeping to name the output according to the page it is used on, particularly when you are making a document with many pages.

Part 4: Create a filter based off of the user groups

For each page you wish to filter by user, you need to construct an R Variable which reads the user groups identified in Part 3, and uses that information to make decisions about which cases should be shown. As I am working with a very simple example, my filter will simply match any respondents whose State variable from the survey matches any of the current user groups.

1. Select Insert > New R > Numeric Variable.
2. Enter code like the example below into the R CODE section on the right.
3. Click Calculate.
4. Enter a Name and Label for your new variable. Again, as this needs to be done for each page, it is good practice to label your filter according to the name of the page on which it is to be used.
5. Tick the Usable as a filter box.
6. Tick the Hidden except in data tree box.

 
State %in% UserGroupsPage1

Some notes about this code:

• I am using the State variable from my data set. This variable has categories which are the states of Australia (NSW, VIC, SA, etc). For simplicity, I have deliberately chosen my user groups to match the categories of this variable.
• I have used the %in% operator. This checks each respondent's State category and works out if it is included in the set of user groups for the person currently viewing this page.
• Depending on the setup of your user groups and how you need to work out which respondents should be included in the sample for each user group you will likely need to use more complicated logic.

Part 5: Filter your page

To make use of your new filter you need to apply it to the outputs on your page.

1. Holding CTRL on your keyboard, click on all of the tables and visualizations which need to be filtered.
2. In the Object Inspector, use Inputs > FILTERS AND WEIGHT > Filter(s) to apply this filter variable.

Part 6: Edit the document settings

Now that you have a document ready to go, you need to ensure that all of the user groups have been given permission to view this document.

1. Click on the cog icon in the top right.
2. Expand the Properties section.
3. In the Authorised for view only section, select all of the user groups that you created for this document in Part 1 above.
4. Click Save.

You can't see the whole menu at once, but my selections for this project for step 4 look like this:

Part 7: Publish

Finally, you need to publish your document as a Private Web Page. To do so:

1. Select Export > Web Page.
2. Under Who has access, choose Login and password required.
3. Click Publish.

The link will now be available to copy and share with others, the Open in new tab button will take you to the published version, and the Save button will return you to your document.

Testing

There are two main approaches for testing the function of your dashboard. The first is to use a testing account as follows:

1. Add a test user (using the steps in Part 3 above) with an email address that is different from the one you use to log in to Displayr. It should be an email account that you have access to so that you can confirm and change the password.
2. Add the test user to the group that you want to test.
3. Log out of Displayr and log in again with this test account, or start a Private Browsing or Incognito window in your browser (CTRL + SHIFT + N in Chrome or CTRL + SHIFT + P in Firefox) and log in with the test account.

To test a different group, simply modify the group membership of your test account (as in Part 3 above).

An alternative is to modify the code in Part 3 to determine which group name is provided to Displayr when you view your document from your Administrator account. This will allow you to test different scenarios by modifying the code.

The basic process for controlling who can view your documents is as follows:

1. Create a User Group for each of your clients.
2. Assign people to the relevant user groups. This is done when you invite new people to join your account, and you may also change the settings for existing user accounts.
3. Set up access permission settings for each document.
4. Ensure your published document requires users to log in with a password.

In order to complete these steps, you must be an account Administrator, and your account must be set up as a multi-user account (for more on this, see the Displayr wiki).

Part 1: Create user groups

The first step is to create user groups for each of your clients. In my example, I will create two user groups in my account - Client A and Client B.

To add a group:

1. Log in to Displayr.
2. Click on the cog icon in the top right and select Settings.
3. Scroll down to the Groups section and select + New Group.
4. Enter a Group name, and click Save.

I have added two new groups in my account, called Client A and Client B. My intention is to assign any viewers who should view results for Client A to that group, and similarly for people from Client B. The Groups section in my account settings now looks like this:

There are three default groups:

• Administrators - these people can access all documents and settings in your account.
• Create/Edit Documents - by default, these people can edit and view all documents in your account.
• View Documents - by default, these people can view but not edit all documents in your account.

If you are restricting access to users then do not add restricted users to any of these groups, as they will be able to access other documents and pages.

Part 2: Assign users to groups

Now that groups have been defined, new accounts can be assigned to those groups. When you invite someone to join your account you can specify which groups they belong to. You can also change which groups someone is in at a later time.

You can invite a new user to your account by clicking the + New User button in the Users section of your Settings page. If you are inviting a new user to your account, you can choose the group(s) that the user belongs to at the time. For example, when inviting my first user, Chris A, I assign him to Client A and fill out the fields below before clicking Save (which will send the invitation).

If you need to assign or change which group(s) a person is in later on:

1. On the Settings page, scroll down to the Users section.
2. Click the person's name.
3. Make selections in the Group membership section (just as in the screenshot above).
4. Click Save.

Part 3: Choose which groups can view each document

With users and groups defined, you can now choose who has access to your documents. These steps should be included in the work-flow of anyone who is responsible for creating new documents in your company.

Next, I'll set the document settings so that only people assigned to the group for Department A can see the first page, and similarly for Department B.

1. Click the cog in the top right of your browser window and select Documents.
2. Hover next to the document you want to set up and click the Settings.
3. Expand the Properties section.
4. Under Authorized for view only, hold SHIFT and select the client user group. Do NOT add the client group to the Authorized for view and edit section as this will give them permission to edit the document.
5. Click Save.

For this document, I have added the Client A user group to the groups which are allowed to view the document.

Part 4: Publishing your document

In order for these settings to apply, you need to ensure that your document requires a person to log in with their password to view it. This is a choice that you make the first time you publish your document with the Login and password required option in the Export ribbon.

Now, when Chris A from Client A logs in to Displayr, he'll see any documents that Client A has been given access to. He won't be able to edit the documents, only view them.

So remember, there are a few key steps to restricting access on a page-by-page basis. First, you need to create user groups for each of your clients. Second, you need to make sure that you create accounts for the people who will view the documents, and that each person is assigned only to the group for the respective client. Finally, you need to set access within each document to specify which client can view that document.

We hope you found this helpful - check out "Using Displayr" for more articles with tips and tricks!

The basic process for controlling who can view pages in your documents is as follows:

1. Create a User Group for each level of access (e.g. department).
2. Assign the people to the relevant groups. This is done when you invite new people to join your account, and you may also change the settings for existing user accounts.
3. Set up tab-based access in your document to choose which groups can see each page.
4. Ensure your published document requires users to log in with a password.

In order to complete these steps you must be an account Administrator, and your account must be set up as a multi-user account (for more on this, see the Displayr wiki).

Part 1: Create user groups

The first step is to work out how you want to group the people who will be using your document, and then create groups to reflect that desired structure. In my example, I will create two user groups in my account.

To add a group:

1. Log in to Displayr.
2. Click on the cog icon in the top right and select Settings.
3. Scroll down to the Groups section and select + New Group.
4. Enter a Group name, and click Save.

I have added two new groups in my account, called Department A and Department B. My intention is to assign any viewers who should view results for Department A to that group, and similarly for people in Department B. The Groups section in my account settings now looks like this:

There are three default groups:

• Administrators - these people can access all documents and settings in your account.
• Edit Projects - by default, these people can edit and view all documents in your account.
• View Projects - by default, these people can view but not edit all documents in your account.

If you are restricting access to users then do not add restricted users to any of these groups, as they will be able to access other documents and pages.

Part 2: Assign users to groups

Now that groups have been defined, new accounts can be assigned to those groups. When you invite someone to join your account you can specify which groups they are in. You can also change which groups someone is in at a later time.

You can invite a new user to your account by clicking the + New User button in the Users section of your Settings page. If you are inviting a new user to your account, you can choose the group(s) that the user belongs to at the time. For example, when inviting my first user, Chris A, I assign him to Department A and fill out the fields below before clicking Save (which will send the invitation).

If you need to assign or change which group(s) a person is in later on:

1. On the Settings page, scroll down to the Users section.
2. Click the person's name.
3. Make selections in the Group membership section (just as in the screenshot above).
4. Click Save.

Part 3: Choose which groups can view each page (tab-based access)

With users and groups defined, you can now choose who has access to each page of your document. This is known as the tab-based access settings. These steps should be included in the work-flow of anyone who is responsible for creating new documents in your company. They can only be done once you have created some pages in your project. Settings can be updated later on when needs change or when new pages are added.

As an example, I've created a super-basic dashboard with pages for my two different departments. When editing, it looks like this:

Next, I'll set the document settings so that only people assigned to the group for Department A can see the first page, and similarly for Department B.

1. Click the cog in the top right of your browser window and select Documents.
2. Hover next to the document you want to set up and click the Settings.
3. Expand the Properties section.
4. Click Set tab-based access to document.
5. Next to the name of each of your pages, click into the box and select which User Groups should be allowed to view that page. You can make multiple selections by holding CTRL or SHIFT when clicking.
6. Click Save.

Note that the settings page here will inform you of any user groups who already have access to the entire document. People whose viewing is to be restricted should not be given membership to these groups.

Part 4: Publishing your document

In order for these settings to apply, you need to ensure that your document requires a person to log in with their password to view it. This is a choice that you make the first time you publish your document with the Private Web Page option in the Export ribbon, but you can also change this later:

1. Go to the document settings as above.
2. Expand the Properties section.
3. Ensure the option Allow viewing without a password is unticked.
4. Click Save.

Now, when someone who is in the group Department A views the document, all they will see is the first page (of course you can make yours look prettier than mine!):

So remember, there are a few key steps to restricting access on a page-by-page basis. First, you need to create user groups which define the levels of access, just like my departments here. Second, you need to make sure that you create accounts for the people who will view the document, and that each person is assigned only to the group that relates to their access. Finally, you need to set tab-based access within the document to specify which groups of people can see each page.

We hope you found this helpful - check out "Using Displayr" for more articles with tips and tricks!

To be able to use these settings you must be an account Administrator. If you are not already an administrator, ask your account administrator to follow the steps in Part 2, below, to add you to the Administrator user group. Also, your account must be set up as a multi-user account (for more on this, see the Displayr wiki).

Part 1: Create user groups

The first step is to work out how you want to group the people in your organization, and then create groups to reflect that desired structure. In my example, I will create two user groups in my account.

To add a group:

1. Log in to Displayr.
2. Click on the cog icon in the top right and select Settings.
3. Scroll down to the Groups section and select + New Group.
4. Enter a Group name, and click Save.

I have added two new groups in my account, called Department A and Department B. My intention is to assign any staff who should have only access to work done by Department A are assigned to that group, and similarly for people in Department B. The Groups section in my account settings now looks like this:

There are three default groups:

• Administrators - these people can access all documents and settings in your account.
• Create/Edit Documents- by default, these people can create, edit, and view all documents in your account.
• View Documents - by default, these people can view but not edit all documents in your account.

If you are restricting access to users then do not add restricted users to any of these groups, as they will be able to access other documents.

Part 2: Assign users to groups

Now that groups have been defined, new users can be assigned into those groups. When you invite someone to join your account you can specify which groups they are in. You can also change which groups someone is in at a later time.

If you are inviting a new user to your account, you can choose the group(s) that the user belongs to at the time. For example, when inviting my first user, Chris A, I assign him to Department A and fill out the fields below before clicking Save (which will send the invitation).

If you need to assign or change which group(s) a person is in later on:

1. On the Settings page, scroll down to the Users section.
2. Click the person's name.
3. Changing their Group membership selections just as in the screenshot above.
4. Click Save.

Part 3: Choose which groups have edit access to each document

With users and groups defined, you can now choose who has access to each of your documents. These steps should be included in the work-flow of anyone who is responsible for creating new documents in your company.

1. Click the cog in the top right and select Documents.
2. Hover next to the document you want to set up, and click Settings.
3. Expand the Properties section.
4. Under Authorized for view and edit, select those groups which should have access to edit. In this example, I include Department A along with the default groups.
5. (Optional) If you also want to restrict who can view this document, you can do so at this time by making selections in the Authorized for view only section.
6. Click Save.

Now, when Chris A logs in, he'll only be able to access this document (imaginatively called Department A - Project 1), and the Demo data that comes pre-loaded into all Displayr accounts.

Part 4: Setting the defaults

The Settings page also contains options for specifying which groups are allowed to edit and view documents by default. It is also possible to specify:

1. The default user group which is allowed to view, but not edit, a new document. For this, change the setting called New projects can be viewed by anyone in this group, and click Save.
2. The default user group which is allowed to edit, and also view, a new document. For this, change the setting called New projects can be viewed and edited by anyone in this group, and click Save.

By controlling documents and user groups in the ways described above, you can ensure that the right people have access to the different documents in your account.

We hope you found this helpful - check out "Using Displayr" for more articles with tips and tricks!

• Customize the overall look of the off-page elements of the document, such as the appearance of the navigation, and how the document name appears.
• Customize the logo that is shown when people create a link to a Displayr document on an iPad.
• Specify the language that is used by people in View mode (i.e., people that look at a published document), such as the words used on the login screens.

To modify these settings, log in to Displayr, click the Account icon at the top-right of the screen, select Account Settings, and then switch to the Settings tab on your account page. If you scroll down you will see the Edit theme CSS/HTML (advanced) option below Billing details, which is clickable. This option will allow control over the appearance of your published documents, but it does require a little knowledge of CSS and HTML.

Introduction: Specifying where your theme is applied

By default, any code you write into the Cascading Style Sheet (CSS) box will affect both the Displayr document's Edit Mode and its View Mode. It will also be applied to all the documents in your company.

Below, I will explain how to apply the css to the View Mode only and how to assign CSS to specific documents in your company.

To ensure that your css will only affect the document when it's in View Mode, use the following code before entering the css pertaining to the page element that needs to be changed:

 
body.dashboard.view 

The "dashboard" part of the code ensures that the css you are applying will affect all the documents in the company. This is especially handy if you are looking to apply consistent branding across all your documents.

To apply your css to a specific document in your company, simply replace "dashboard" with your document's project id which can be found in the URL when you are in Edit Mode. This will be explained more in Example 1 below.

Example 1: Hiding the document name for a document

By default, Displayr places the name of a document in the top left-corner of the web pages that are shared with users (i.e., dashboards). Sometimes this is undesirable. In the example below, a heading has been created in a yellow box on the page, so having the heading appear also at the top-left of the screen just undermines the design.

To turn it off for all documents in a company, modify the CSS by clicking on Edit theme/CSS (Advanced) /theme and pasting the following text into the Cascading Style Sheet (CSS) box.

body.dashboard.view .project-name-text { display: none; }

To turn it off for just a specific document, use:

body.project-213724.view .project-name-text {    display: none;}

where 213724 is the Project ID of the document, which is shown in a document's URL:

Example 2: Customizing the navigation bar

A screenshot of a document created in Displayr is shown below. Note that the navigation, shown on the left-side of the pages, is exactly as it looks within Displayr. It can be modified by changing the CSS.

Below is the reworked version, where I have changed the navigation.

I modified the CSS by clicking on Edit theme/CSS (Advanced) /theme and pasting the following text into the Cascading Style Sheet (CSS) box. This applies to all the dashboards in my company.

body.dashboard.view .item-expander-group--1 { display: none !important; }
body.dashboard.view .item-icon { display: none !important; }
body.dashboard.view #report-tree { font-size: 16px; font-weight: 300; }
body.dashboard.view .tree-view .tree-view-inner .item { height: auto !important; margin-bottom: 0.3em; background-color: #00c8c8; color: white; padding-top: 0.2em; padding-bottom: 0.2em; border: none; }
body.dashboard.view .tree-view .tree-view-inner .item:hover { background-color: #3E7dcc; }
body.dashboard.view .tree-view .tree-view-inner .item.selected-item { background-color: #3E7dcc; }
body.dashboard.view .tree-view .tree-view-inner .item .item-title { top: -1px; }
body.dashboard.view .tree-view-long-item-tooltip-container { visibility: hidden; }

Example 3: Centering the page

The default appearance of a page centers the page of a document relative to the navigation bar. This code instead centers it relative to the entire screen. This changes is made for documents in a company (replace the # to limit it to a specific document, following example 1).

body.dashboard.view #left-panel { z-index: 1000 }
body.dashboard.view #workarea { transform-origin: 50% top 2px !important; }
body.dashboard.view #workarea-container, body.dashboard.view #workarea { left: 0 !important; right: 0 !important; margin: 0 auto; position: absolute; }
body.dashboard.view #workarea-container { background: none !important }

Example 4: Removing the header strip

By default, when a dashboard is being viewed, Displayr shows a search box, filters, and various other details on the top:

These can be removed by adding the following line of code:

body.dashboard.view #header-strip { visibility: hidden; }

It's also possible to remove individual elements of the header strip such as the Filter or Explore buttons. To remove the Filter button for a specific document:

1. Go to your dashboard in Edit mode and copy the project id from the URL at the top of the browser, e.g. https://app.displayr.com/Dashboard?project_id=-XXXXXX
2. Click the Profile icon at the top right > Account Settings > Settings
3. Scroll down and click Edit theme CSS/HTML (advanced)
4. In the first box, paste the text below (replacing the 'XXXXXX' with your actual project id):  body.project-XXXXXX.view #filter-button {visibility: hidden;}
5. Click Save.
6. Go back to your dashboard and click Export > Republish (if you have previously published your document) > Open in new tab and the filter tab will be removed.

To remove the Explore button or other elements, replace #filter-button with the name of the element in the example code above. For example, to remove the Search bar, use #documentsearch or Explore button, use #explore-menu-button.

Example 5: Multiple changes

In the final example, I:

• Make all the changes made in Example 2.
• Make additional changes to the navigation for project 220178 (as shown to the right).
• Hide the document name.
• Align the page to the left.

/* Hiding the document name for all dashboards in the company. */

body.dashboard.view .project-name-text { display: none; }

/* Centering dashboards on the page, rather than in the space to the right of the navigation bar. */

body.dashboard.view #left-panel { z-index: 1000 }
body.dashboard.view #workarea { transform-origin: 50% top 2px !important; }
body.dashboard.view #workarea-container, body.dashboard.view #workarea { left: 0 !important; right: 0 !important; margin: 0 auto; position: absolute; }
body.dashboard.view #workarea-container { background: none !important }

/* Changing the default appearance of the nagivation bar to remove the within-page items and to Displayr coloring */

body.dashboard.view .item-expander-group--1 { display: none !important; }
body.dashboard.view .item-icon { display: none !important; }
body.dashboard.view #report-tree { font-size: 16px; font-weight: 300; }
body.dashboard.view .tree-view .tree-view-inner .item { height: auto !important; margin-bottom: 0.3em; background-color: #00c8c8; color: white; padding-top: 0.2em; padding-bottom: 0.2em; border: none; }
body.dashboard.view .tree-view .tree-view-inner .item:hover { background-color: #3E7dcc; }
body.dashboard.view .tree-view .tree-view-inner .item.selected-item { background-color: #3E7dcc; }
body.dashboard.view .tree-view .tree-view-inner .item .item-title { top: -1px; }
body.dashboard.view .tree-view-long-item-tooltip-container { visibility: hidden; }

/* Changing the navigation bar panels for dashboard 220178 */

body.project-220178.view .tree-view .tree-view-inner .item { height: auto !important; margin-bottom: 0.3em; background-color: #F1F1F1; color: #0078C0; padding-top: 0.2em; padding-bottom: 0.2em; border: none; }
body.project-220178.view .tree-view .tree-view-inner .item:hover { color: #F1F1F1; background-color: #0078C0; }
body.project-220178.view .tree-view .tree-view-inner .item.selected-item { color: #F1F1F1; background-color: #0078C0; }

/* Left-aligning the workarea dashboard for 223863 */

body.project-223863.view #workarea { left: 0 !important }

It is pretty straightforward to perform simple modifications of this code (e.g., change the color settings). It is possible to do a whole lot more, but to do this you need somebody with expertise in web development. Sadly, our support team cannot help with this, as it is well outside of our expertise! (Thanks go to Jan, the developer who helped me with this post.)