Versions Compared

Version Old Version 2 New Version Current
Changes made by

Eric Schullek

Eric Schullek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

If a tenant isn’t setup set up to use the new analytics report builder, the old interface and options still show.

...

2- The New query tab allows for creating a new query ad-hoc , or saved. Existing queries saved can be viewed on the Existing Queries tab.

3- In SQL analytics you can pick tables and columns from the schema if you need to use them , or view what is available.

4- Type your SQL-based query here.

5- Actions to run on the query results are shown in this bar.

...

Users can directly create or edit existing SQL queries by clicking the New Query or Existing Queries buttons, respectively, under the Queries tab.

Note: Following The following columns are required when querying data from the   document, folder/workspace tables for New queryqueries as well as Existing queryqueries. These columns are required to perform Query Menu Options on a queried result.

Column Names:'extId', 'extContainerId', 'number', 'version', 'folderType'.

Also, update your existing saved queries with these required fields.

Expand
titleNew Query

New Query

Queries can be added to Analytics from the New Query option. The Litera database configured for use with CAM is listed in the left-hand side pane with the following database button -

Image Removed

Image Added

The tables available within the Litera database are listed below. Click the arrow next to the table to view the list of columns available within each table. You can further click on the column names to view the column types.

Note

Note: A Data Sync task must be configured and run to populate the database with records.

Click on the table name, to view the columns under each table.

Tip

Tip: Double-click on the table name to auto-populate a SELECT statement query in the Query field. Click Execute to view the query results.

  1. In the Queries tab, click New Query

  2. Define the query. The query must meet the following conditions:

    • The query must include a SELECT statement.

    • The Parameters in the query cannot be declared - they must be configured in the Parameter Configuration dialog.

    • You can only query the database given in the left-hand side panel.

Tip

Tip: The column lookups now display field_name and alias (if existing), instead of field_name and display_name.

Tip

Tip: In the Analytics UI, the default columns/order in entity lookups is are based on the entity and query type. Depending on the configuration, CAM will pre-select and correctly order existing columns (for example required columns) in the lookups to improve organization and reduce scrolling.

  1. Click Execute to run the query and view the results on the same screen.

  2. Click Save to save and add the query to the Existing Queries drop-down.

  3. Autosaving the query is now possible in CAM as you type it. Users can navigate to another tab if they need to look something up, and return. Note: This only keeps the latest query version of when you typed in something to the window or changed it. Prior edits aren’t saved automatically unless you manually click Save to the Existing queries list. Enable the setting in Admin to enable this.

  4. In the New Query window, type information in the provided fields, based on the table below, then click Save.

Field

Description

Name

Enter a name for the query. This name will be displayed in the drop-down in the existing queries list.

Description

Enter a description for the query 

Query

Contains the body of the query

Query Results Type

This is auto-filtered and displays the query results type.

Note: when users upload an Analytics bulk job CSV for iManage through the Jobs tab, an asterisk (*) should be added to the custom metadata for the partial search to work.

Info

Bulk validations now display when a user tries to run a query for more than 25,000 documents and prevents prevent the user from continuing without refinement or reduction of the query count.

...

Expand
titleParameter Configuration

Configuring Parameters

To configure parameters, click Save after you enter a query in the query field. In the New Query window, click the Parameters button, type information in the provided fields, based on the table below, then click Save.

Field

Description

Parameter Name

The name of the parameter as used in the query

Description

A descriptive label for the parameter that will be displayed in the Existing Queries tab when the query is selected from the drop-down.

Control Type

Specifies the parameter type to be displayed. Options available are :

  • Textbox - A text input field into which users can enter any text.

  • Datefield - A text input field that allows the user to select the date.

  • Boolean - A Boolean value (True or False) that specifies whether to display the field in the form.

  • Multiselect - A multi-text drop-down selection field to assign document access.

Default Value

An optional default value for the parameter.

Note: If using multiple parameter values, use the IN operator with the query.

  1. Click the Execute button to run the query.

...

Expand
titleExisting Queries

Existing Queries

The Existing Queries tab allows you to edit or execute the saved queries. All the queries created and saved in the New Query tab are available here for selection. Several out-of-the-box queries are also available to run reports. See out-of-the-box queries for more information.

  1. In the Queries tab, click Existing Queries

  2. All the saved queries are listed in the drop-down. Select the query to execute.

  3. The selected query name is displayed.

    Image Removed

    Image Added

    Click the button to view options for the query -

  • Click Show to view the query details. You cannot edit the query here.

  • Click Edit to edit the query. In the New Query window, make the necessary changes and click Save.

  • Click Delete to delete the query.

  1. Click the Execute button to run the query.

  2. The query results are displayed in the Query Results panel. Click on any of the items in the panel to view all the column details.

Expand
titleExisting Queries Tab Action Menu

Action Options

To access the menu click the following button at the far right corner of the page

Image Removed

Image Added

Menu

Description

Edit

Select to edit the saved query.

Show Query

Select to display the query in view mode only.

Hide Query

Displayed if the Show Query option is selected. Select to close the query view mode.

Delete

Select to delete the saved query

Pin to tab

Select to pin the query as a tab on the Analytics page. Read here for detailed instructions to pin a query.

Expand
titlePin Queries to Analytics Tab

Pinning Queries

Frequently accessed queries can be pinned to the Analytics tab for quick access. This option can be accessed from the Existing Queries tab.

  1. Save and add the query to the Existing Queries tab.

  2. Select the query from the Existing Queries drop-down.

    Image Removed

    Image Added

    Click the action menu button at the far right corner of the page and select Pin select the Pin to tab.

  3. Enter a short name for the query. This name will be displayed on the pinned tab. Click Save.

  4. The query is now pinned to the Analytics tab next to the Download Count tab.

  5. Image Removed

    Image Added

    Click the at the far left corner and to view the pinned query select Show Query. This displays the query in view mode only. To close the view mode,

    Image Removed

    Image Added

    click the button again and select Hide Query.

  6. To un-pin the query select the tab and

    Image Removed

    Image Added

    click the button at the far left corner and select Unpin from the tab.

...