Versions Compared

Old Version 13

changes.mady.by.user René Ponce Carrillo (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Eric Schullek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

These settings are located under Administration-> Dashboards in CAM.

...

Dashboard Settings in Administration

...

Tip

Tip: When using the search filters for Name and Description on the Data Source, Entities, Report Category and Reports tab, the results will show once users click anywhere outside of the search field or hit Enter after entering the text to be searched.

Columns displayed are:

Column

Description

Name

The data source name

Description

Description of what the data source is

Type

Type of the data source

Is Enabled

Yes/No if the source is enabled or disabled

Last Modified Date

Date the source configuration was modified

Last Modified By

The person who last modified the source configuration.

Data sources specify where the data for the reports come from.

We supportSupported sources are:

  • MySQL database (CAM or other)

  • Elastic Search

  • Static S3 bucket from AWS

...

Options for the Types are:

MySQL

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Is CAM DB

Sets if the database is a CAM database

No

Host

Type the name of the host if required. E.g. http://pridev.prosperowaredev.io

Yes

Port

Sets the port of the host, if required.

No

Username

The username to log into the database.

Yes

Password

The password to login to the database.

Yes

Database

Enter the name of the database.

Yes

Timeout

Sets the number of seconds to timeout. 30,000 is default.

No

Charset

Sets the database charset to use. utf8mb4_general_ci is default.

No

Elastic Search

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Host

Type the name of the host if required. E.g. http://pridev.prosperowaredev.io

Authentication

Sets authentication to elastic

No

Port

Sets the port of the host, if required.

No

Username

The username to log into the elastic instance.

Yes

Password

The password to login to the elastic instance.

Yes

API key

Set the API key from the Elastic API.

No

AWS Access Key

Set the access key (application key) from the AWS account here.

No

AWS Secret Key

Set the secret key from the AWS account here.

No

AWS Region

Enter the region of the AWS account you use (uswest…)

No

Cloudid

The cloud system id (from CAM)

No

 

S3

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Access Key

Set the access key (application key) from the AWS account here.

Yes

Secret Key

Set the secret key from the AWS account here.

Yes

Region

Enter the region of the AWS account you use (uswest…)

Yes

Bucket Name

The name of the AWS storage bucket

Yes

Static Client

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Upload Static File

Allows to upload the static Excel File

Yes

Static JSON

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Upload Static File

Allows to upload the static JSON File

Yes

Static Sharepoint

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

External System

Select the external system where the site is located.

Yes

Upload Static File

Allows to upload the static Site File

No

API

Field

Description

Required

Is Enabled

Sets if the source is enabled and active.

No, but determines if active

Tip

Tip: The list can be filtered by any combination of Name, Description, and Type..

...

Tip

Tip: When using the search filters for Name and Description on the Data Source, Entities, Report Category and Reports tab, the results will show once users click anywhere outside of the search field or hit Enter after entering the text to be searched.

Tip

TIP: Just as in CAM, it is possible to filter the entities by any column!

 

Fields

Description

Display Name

An alternative display name for the entity

Data Source

The source of the data for the entity

Description

An optional description for the entity

Entity Name

The entity name. Entities will include the list of indexes (for example elastic indexes or SQL indexes) as well.

Query Type

The type of the query. For analytics, available options are document, folder, workspace, user, and document_history.

Is Enabled

Indicates whether the entity is enabled or not

Last Modified Date

Shows the date the entity was last modified

Last Modified By

Shows the user that last modified the entity

Actions

  • Edit: Select the edit icon to edit the Entity details.

  • Regenerate Fields: If a data source is modified, the user has the ability to regenerate it.

  • Open Entity Fields: Shows the Entity fields. New fields can be added from this screen.

  • Attach Actions: Allows for actions to be attached to an entity. Additionally, the screen shows the actions currently attached to existing entities. Select +Attach Actions to add a new action to the entity. The Out of the box actions are:

    • Matter Detail Dialog

    • Remote CheckIn IFrame

    • Remote CheckIn

    • Remove Object Security

    • Change Default Access

  • Delete Entity: Select this icon to delete the Entity.

Tip

Tip: The list can be filtered by any combination of Entity Name, Description, and Last Modified Date.

...

Tip

Tip: Entities are auto-discovered when Auto discover is clicked. The API looks like this:

/api/v1/dashboard/reportentity/autoDiscover

 

Payload : -

{

     "report_entity_id": "1"}_id": "1"

}

Entity Fields Tab

This new tab showcases the fields within the entity available, that used to be available by going to the “Entities” tab in Administration > Dashboard and then clicking the "Open Entity Fields" button from the action menu.

image-20241029-130826.pngImage Added

Report Category tab

...

 

Tip

Tip: When using the search filters for Name and Description on the Data Source, Entities, Report Category and Reports tab, the results will show once users click anywhere outside of the search field or hit Enter after entering the text to be searched.

...

Tip

Users can create custom categories .by adding one in admin OR clicking add new category from the lookup directly that pulls report categories!

The following data is available:

  • Id is hidden

KPI

Description

Data Type

Display Name

Name of the report category.

Text

Description

Description of the report category.

Text

Last Modified Date

Shows the date the report category is last modified.

Date

Last Modified By

Shows the person who last modified the report category.

Text

Is Enabled

Sets if the report category is an enabled or disabled category.

Bit

Filter

Allows to filter by display name, description or is enabled.

Text

Edit

Allows to edit the report category.

Button

Delete

Deletes the report category.

Button

Add Report

Adds a new report category.

Button

Tip

Tip: The list can be filtered by any combination of Name, Description, and Type.

...

The following data is available:

  • Id is hidden

KPI

Description

Data Type

Name

Name of the report.

Text

Description

Description of the report.

Text

Data Type

Type of the data pulled in the report

Text

Generated Query JSON

If the query in the report generates a json result of metadata, this is displayed here.

Text

Last Modified Date

Shows the date the report is last modified.

Date

Last Modified By

Shows the person who last modified the report.

Text

Is Enabled

Sets if the report is an enabled or disabled report.

Bit

Filter

Allows to filter by display name, description or is enabled.

Text

Edit

Allows to edit the report.

Note: when editing a report, a message will warn users that changing the report may affect other widgets and dashboards. Clicking on Details will show a list of the dashboards, widgets, and filters that use the report that is being edited.

Button

Delete

Deletes the report.

Button

Add Report

Adds a new report.

Button

Tip

Tip: The list can be filtered by any combination of Name, Description, and Type.

...

Once the information is provided, it is possible to perform actions on the data:

Join Data

...

It is possible to create joins between entities.

...

Info

Note that Full Outer Joins are not supported in MySQL currently and are not supported in Dashboards.

  1. After selecting the type of

...

  1. join, select the other entity and define the condition.

  2. To view the tooltip of what each Join means, click the Info

...

  1. “i” next to the

...

  1. join. Self-explanatory joins will not have a tooltip.

Info

Important: Join Data is not available for Elastic Search reports.

...

It is possible to select from any of the available columns to set a filter based on how the value of the column relates to another value that can be freely set.

  1. To view the tooltip of what each filter means, click the

...

  1. Info“i” next to the Filter. Self-explanatory filters will not have a tooltip.

...

Available conditions are:

...

Info

If you add a second filter, the filter is blank by default until selected.

Sorting

...

  1. It is possible to add sorters to rearrange the information.

  2. For each sorter, click the arrow to switch between ascending or descending sorting. Multiple sorting criteria can be added.

  3. Sorting aggregations in Elastic and other data sources is now possible.

Summaries

...

  1. It is possible to add summaries by selecting a metric, and then selecting a column from either of the joined entities to group by. it is possible to add multiple metrics and groupings.

Available metrics:

  • Count of rows

  • Sum of

  • Average of

  • Number of distinct values of

  • Cumulative sum of

  • Cumulative count of rows

  • Standard deviation of

  • Minimum of

  • Maximum of

Info

If the user selects a metric related to numbers only (average of, maximum of, minimum of, sum of), then the select entity field dropdown will only show columns that contain numbers.

Preview

  1. It is possible to run a preview of the report by clicking the Preview button.

Settings tab

This tab allows setting the Visual Theme and configuring the Navigation.

...

...

Visual Theme

The Visual Theme dropdown offers three options: Basic, Litera, and CAM.

...

Info

After changing the theme, the open page will reload to load in the new theme.

Navigation

  1. Once a Visual Theme has been selected, it is possible to set up the navigation as a Sidebar, or a Top tab bar.

...

 

  1. Selecting either the Sidebar or Tob tab bar will allow the user to

...

  1. select the Max Number of Dashboards. By default, the number is set to 20.

Note

The maximum number of dashboards that can be added to the navigation is 200.

  • The dashboards currently available in the navigation will also be displayed as a list. It is possible to rearrange the items in the list by dragging the items up or down or deleting an item by clicking on the trash can.

  1. Selecting the Plus sign will allow users to add more dashboards to the navigation.

Info

Note: Any other tabs open in your browser will need to be refreshed after applying a new theme.

...