Analytics » Publishing Options » Creating URL/Permalink to Views

Creating URL/Permalink to Views

 Creating URL/Permalink - Introduction

In Virtutem Analytics you can easily create a standalone Permanent URLs(Permalink) for any view you have created in Virtutem Analytics . Virtutem Analytics allows you to create a URL with private access with/without login or with public access. Permalink allows your users to access the shared reports through a URL so that your reports can be bookmarked for quick reference anytime or can be linked from other websites. Users visiting these links will be able to see the latest live version of the view. Any changes you make to the view or the underlying data will be reflected automatically in the permalink.


You can create URL for any type of view that you have created in Virtutem Analytics including Charts, Pivot tables, Summary views, Tabular views, Dashboards, Tables and Query tables. By default, all views created in Virtutem Analytics s are private. Only users to whom the view has been shared can see the report using the corresponding report's URL. Shared user has to login into Virtutem Analytics s when prompted for login. If the user has already logged into Virtutem Analytics (in the same browser), then it will not prompt for login. For more information on how to share reports to users, Refer to the topic   Sharing and Collaboration .


In case you do not want the users to be logged into Virtutem Analytics while accessing the report, then you need to create URL with the setting Access without Login or make the view public. We will discuss about the various access models for each view type in the following sections.

 Creating Permalink for Charts

Virtutem Analytics provides option to create a URL to your chart in interactive mode or in image mode. With this you will be able to share your charts through a created URL with interactive options as you have within the Virtutem Analytics service such as toolbar menu, user filters, mouse over effects. Depending on the option selected, the URL for your chart will be generated.

       Interactive Mode

When you create a URL for the chart in interactive mode, then users visiting the URL can view and interact with the chart as you could do when you view the chart within the Virtutem Analytics user interface. The following interactions are possible when a chart is in interactive mode:

  • Mouse over the chart for tooltips & highlights.

  • Click on any data point in the chart to view the underlying data (drill down).

  • You can also include the chart toolbar to enable users to change the chart type.

  • Apply User Filters, if the chart contains user filters.

  • Interact with legend for mouse over effects and chart filtering based on values listed in the legend.

      Image Mode

When you create a URL for the chart in image mode, the chart will be generated as a static image and thus the web page will get loaded faster.

 The following are the three access models that you can choose for your chart permalink for both Interactive and Image mode.

  • Creating Permalink with Private Access with Login

  • Creating Permalink with Private Access without Login

  • Creating Permalink with Public Access

 Creating Permalink for Charts with Private Access with Login

When you create a URL for your chart, by default it will be set to   Private Access with Login   setting to provide highest level of security to your chart. In this access mode you have to   share the chart   to your users and those shared users will be able to access the chart, on successful login. Any other users to whom you have not shared the view or public users will not be able to access the chart.


You can create permalink for the charts with   Private Access with Login   setting by following the steps below:

  • From   Explorer   tab, open the chart and invoke   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Access  Permission will,be se to Access with Login by default.

  • The   Setting   group box provides opton to customize the embeded chart.  Specify the width and height in the corrresponding boxes in   Set Screen  Size   option.

  • In the   Chart Rendering   section selecte   As Interactive   or   As Image   -
  • Select the required legend position for the chart from the drop-down list under the   Legend Position   option. The supported options are:
    • Right   - Places the legend to the right side of the chart.
    • Left   - Places the legend to the left side of the chart.
    • Top-Left   - Places the legend to the top left of the chart below the title.
    • Top-Center   - Places the legend to the top center of the chart below the title.
    • Top-Right   - Places the legend to the top right of the chart below the title.
    • Bottom-Left   - Places the legend to the bottom left corner of the chart.
    • Bottom-Center   - Places the legend to the bottom center of the chart.
    • Bottom - Right   - Places the legend to the bottom right corner of the chart.
  • Select a theme from the drop down menu under   Theme   option. The selected theme will be applied only when you have the Toolbar (next option discussed) included.
  • Select the   Auto Refresh every N seconds   checkbox and then specify time in seconds to automatically refresh your view to show latest data.
  • You can choose to display a selective set of data in your embedded view using the   Specify Filter Criteria option. To know how to specify filter criteria,   refer here .

  • Select   Toolbar , if you want to include the chart toolbar in the permalink. This option will be available only when you set this as an interactive chart.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field.

When users visit the permalink it will prompt for login details as shown below, in case the user has not logged in already into Virtutem Analytics . On successful login they will be able to access the chart.

 Creating Permalink for Charts with Private Access without Login

In case you want your chart to be accessed by the users to whom you share the permalink of the view and do not want them to login into Virtutem Analytics every time they access the URL, then you have to create it with   private Access without Login   setting. Both Interactive and image mode is supported in this model. When this setting is selected Virtutem Analytics will generate a permalinks which will contain a unique   randomly generated private key (private link), making them secure and very hard (if not impossible) to guess.


To create permalink for the charts with Private Access with Login setting, follow the steps below:

  • Open the chart and invoke   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL dialog will open.

  • Select   Access without Login   in the Access Permision section.

  • If you want to edit the permissions to be granted to this view, then click   Editing Private Link Permissions link. The   Edit Permissions for the selected tables/report   dialog box will open.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close.

 Note
    You can regenerate the random key, if you want to make the previously published link invalid for security reasons. To regenerate the random key, select Regenerate Random Key link in the dialog box. You have to share your permalink to your users again, if you want to continue your existing users to access the view without logging in.

 Creating Permalink for Charts with Public Access

In case you want your chart to be accessible to all users who visits the permalink and do not require the random key based link generation (as in   Private access without login   option), then you have to create it with   Public Access setting.

 To do this:
  •  Make the chart for which you want to create permalink public. Refer to the topic   Making Views/Database Public   for information on how to make a chart public and to grant the required permissions.
  • Click  Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close .

 Editing Permissions of Created Charts URL

You can edit permissions of the created URL of the chart anytime you want. Refer to the   Editing Permissions for Created URL   section to know how to edit permissions of the chart.

 Creating Permalink for Tables, Pivots, Summary and Tabular Views

Virtutem Analytics supports creating permalink for all type of views such as Table, Query Table, Pivot Table, Summary View and Tabular View created in Virtutem Analytics .


You can choose one of the following three access models while creating permalink (similar to the options provided for the   Charts discussed in the previous   section):

  • Creating Permalink with Private Access with Login

  • Creating Permalink with Private Access without Login

  • Creating Permalink with Public Access

 Creating Permalink for views with Private Access with Login

When you create a permalink for your view with Private Access with Login setting, then it would prompt for the users to login with Virtutem Analytics login ID to access the view. Also, only users to whom you have shared the view (Using the   Share option ) would be able to access the view, on successful login. This is the most secure way of sharing a view.


The following steps illustrates how to create a permalink for a table in Virtutem Analytics :

  • From the   Explorer   tab, open the corresponding table and invoke   Publish > URL/ Permalink to this view option in the toolbar. The   Access URL   dialog will open.

  • Select the required options provided for the view.

The following table describes various options available for different types of views.

OPTION

DESCRIPTION

APPLICABLE TO

Width

Allows you to set the width of the published view.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

Height

Allows you to set the height of the published view.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

Theme

Allows you to set the theme of the published view.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

Auto Refresh Every N Seconds

Allows you to automatically refresh your view at a set interval to display latest data.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

Data Type Symbol

Provides the data type symbol of the corresponding column in the header.
Symbols used e.g.:-   for text data type, for date etc.

 

Applicable for Tables, Query Tables and Tabular views.

Toolbar

Provides a toolbar of the corresponding view at the top, when published.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

Search Box

Provides a search box at the top of the view.
When you check the Toolbar option, this option becomes inactive. 

Applicable only for Tables.

Column Chooser

Provides an option to show or hide columns from the view.

Applicable for Table, Tabular view and Query Table,

Title

Provides title of the View

Pivot and Summary views.

Description

Provides a brief description of the view

Applicable for Pivot and Summary views.

Specify Filter Criteria

Allows you to filter the data by specifying a filter criteria.

Applicable for Tables, Query Tables, Pivots, Summary and Tabular views.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close .

When users visit the permalink it will prompt for login details as shown below, in case the user has not logged in already into Virtutem Analytics . On successful login they will be able to access the view.

 Creating Permalink for views with Private Access without Login

In case you do not want all your users to login to Virtutem Analytics , but still want to share the view securely, then you can create a permalink for the view for the view with Private Access without Login setting. When this setting is selected Virtutem Analytics s will generate a permalinks which will contain a unique randomly generated private key (private link), making them secure and very hard (if not impossible) to guess.


To create a permalink for a table with private access without login, follow the steps given below:

  • Open the corresponding table and then invoke   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Select   Access without Login   in the Access Permision section.

  • If you want to edit the permissions to be granted to this view, then click   Editing Private Link Permissions link. The   Edit Permissions for the selected tables/report   dialog box will open.

  • Grant or remove Read/Export permissions for the selected table by selecting/deselecting the corresponding check boxes and then click   OK . An alternative way to change permissions is described under the   Editing Permissions of permalink   section.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close.

 Note:
    You can regenerate the random key, if you want to make the previously published link invalid for security reasons. To regenerate the random key, select Regenerate Random Key link at the bottom of the dialog box.

 Creating Permalink for views with Public Access

If you want to create a permalink for a view which will be accessible to all users who visits the permalink and do not require the random key based link generation (as in Private access without login option), then you can create it with Public Access setting.

To do this:

  • Make the view for which you want to create permalink as public. Refer to the topic   Making Views/Database Public   for information on how to make a chart public and to grant the required permissions.

  • Click   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close.

 Editing Permissions of Created View URL

You can edit permissions of the URL anytime you want. Refer to the   Editing Permissions for Created URL   section to know how to edit permissions of the view.

 Creating Permalink for Dashboards

You can create a permalink to the dashboards in Virtutem Analytics following the same steps as described for other types of views in the previous section.


Following are the three access models that you can choose while creating permalink for your dashboard (similar to options provided for the   Charts discussed in the previous   section):

  • Creating Permalink with Private Access with Login

  • Creating Permalink with Private Access without Login

  • Creating Permalink with Public Access

 Creating Permalink for Dashboard with Private Access with login

When you create a permalink for your view with Private Access with Login setting, then users with whom you have privately shared this view can access these view after successful login.

To create a permalink to your dashboard:

  • Open the corresponding table and then invoke   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Select a theme color from the   Theme   drop-down. The selected theme will be applied only when you have the Toolbar (next option discussed) included.

  • Select the   Auto Refresh every N seconds   checkbox and then specify time in seconds to automatically refresh your view to show latest data.

  • You can choose to display a selective set of data in your embedded view using the   Specify Filter Criteria option. To know how to specify filter criteria,   refer here .

  • Select   Toolbar , if you want to include the chart toolbar when embedded.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close .

When users visit the permalink it will prompt for login details as shown below, in case the user has not logged in already into Virtutem Analytics . On successful login they will be able to access the view.

 Creating Permalink for Dashboard with Private Access without Login

You can create the permalink for your dashboard with   Private Access without Login   setting, if you do not want all your users to login to Virtutem Analytics , but still want to share the view securely. When this setting is selected Virtutem Analytics will generate a permalinks which will contain a unique randomly generated private key (private link), making them secure and very hard (if not impossible) to guess.


To create a permalink to your dashboard with Private Access without Login:

  • Open the corresponding table and then invoke   Publish > URL/ Permalink to this view   option in the toolbar. The   Access URL   dialog will open.

  • Select   Access without Login   in the Access Permision section.

  • If you want to edit the permissions to be granted to this view, then click   Editing Private Link Permissions link. The   Edit Permissions for the selected tables/report   dialog box will open.

  • Grant or remove Read/Export permissions for the selected table by selecting/deselecting the corresponding check boxes and then click   OK . An alternative way to change permissions is described under the topic Editing Permissions of permalink section.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close .

 Creating Permalink for Dashboard with Public Access

If you want to create a permalink for your dashboard which will be accessible to all users who visits the permalink and do not require the random key based link generation (as in Private access without login option), then you can create it with Public Access setting.

  • Open the corresponding table and then invoke   Publish > URL/ Permalink to this view   option in the toolbar.

  • Copy the generated permalink from the   URL for accessing this view(/table) independently   field and then click   Close .

 Editing Permissions of Created Dashboard URL

You can edit permissions of the created URL of the dashboard anytime you want. Refer to the   Editing Permissions for Created URL   section to know how to edit permissions of the dashboard.

 Editing Permissions of the Created Permalink

Virtutem Analytics allows you to edit the previously granted permissions of the permanent URL (both private and public). You can also completely remove access to the link.

  • Open the corresponding view and invoke the   Share > Edit Existing Shared Details   option in the toolbar. The Edit Existing Shared Details   dialog will open.

  • Click the   Edit Permission   link adjacent to the appropriate option.

  • To edit permissions granted for the created URL with private access without login, click the link adjacent to Private Link.

  • To edit permissions granted for the created URL with private access without login, click the link adjacent to the shared users' name.

  • To edit permissions granted for the created URL with public access, click the link adjacent to   Public Visitor. 

  • The Edit Permission for the selected table/report   dialog will open. Modify the permission granted and then  

Click Ok


You can grant new permissions or revoke permissions for the selected table by selecting/deselecting the corresponding check box in the Edit Permission dialog box. Click   OK   to complete the process. If you want to remove access to the private/public or shared users for the URL, click on the corresponding   Remove   link adjacent to each shared member and then click   Close

 Applying Filters on the Views

Virtutem Analytics allows you to apply dynamic filters to your views when sharing it to your users. These filters gets applied on the fly over the data displayed as part of the view, when users access it using its permalink. Using this feature, you can share the same permalink to different set of users by applying different set of filter criteria, to suit the allowed permission, context and profile of the user who is accessing the URL.


Filters can be applied by passing the required filter criteria to the parameter named ZOHO_CRITERIA and appending it as a part of the URL/Permalink. The view's data is filtered and displayed based on the criteria specified, whenever a user access the link.


Example:


The generated Permalink/URL for a chart would look like as shown below.

http://reports.zoho.com/ZDBDataSheetView.cc?OBJID=29406000000445889&STANDALONE=true&privatelink=63b5c6b5fa2091af20e1b57243cd4c26&LP=RIGHT&ZDB_THEME_NAME=blue

&REMTOOLBAR=true&INCLUDETITLE=true&INCLUDEDESC=true

The above URL displays Store Sales bar chart when accessed by the users. To limit the view to just show the Store Sales for the year 2008, add &ZOHO_CRITERIA=year("Date")='2008' to the URL as shown below. Here in the example Year function is used to extract year from the column Date.  

http://reports.zoho.com/ZDBDataSheetView.cc?OBJID=29406000000445889&ZOHO_CRITERIA=Year("Date")='2008'&STANDALONE=true

&privatelink=63b5c6b5fa2091af20e1b57243cd4c26&LP=RIGHT&ZDB_THEME_NAME=blue&REMTOOLBAR=true&INCLUDETITLE=true&INCLUDEDESC=true

Now, the URL displays Store Sales chart containing only the values matching the year 2008 as shown below, when accessed by the users.

     Filter Criteria Format

Filter criteria will exactly follow the same format as that given in       Applying Filters on Embedded Views       section of Embedding View in Web pages topic.

Related Topics