These settings are located under Administration-> Dashboards in CAM.
Dashboard Settings in Administration
Data Source tab
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 support:
MySQL database (CAM or other)
Elastic Search
Static S3 bucket from AWS
Add Data Source
Click Add Data Source or click edit on an existing source:
Enter:
Name: Required
Description: Optional
Type: Required. Select from the following:
MySQL database (CAM or other)
Elastic Search
Static S3 bucket from AWS
Static Client report (CSV from client system)
Static JSON file
Static Sharepoint List
Cloud Elastic Search provider
Office 365 Graph API: From an Office365 source
CAM Native API
Web API
CAM metadata
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 |
Yes | ||
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: The list can be filtered by any combination of Name, Description, and Type..
Entities tab
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 |
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. |
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 |
|
Tip: The list can be filtered by any combination of Entity Name, Description, and Last Modified Date.
Adding a New Report Entity
To add a new Report Entity, click the Add Entity button and provide the required details.
When selecting the Data Source for the new Report Entity, if STATIC_S3_ is selected, users will have the option to upload a static file, such as an .XLSX file, as shown in the screen below.
Warning: The Display Name maximum length is 255 characters. If a longer name is inputted, a message will warn the users about the length being exceeded.
Operations for entities include:
Create: There are two ways to add report entities:
Auto-discovery: This is based on the data source, data entities will be populated automatically.
Manually: users can add data sources manually, but on the save, it should validate the entity from the source.
Read:
Update: any manual update will require validation.
Delete: deleting a data source will mark all related entities, reports, and widgets as deleted as well.
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"
}
Report Category tab
Report categories allow bucketing reports based on a category for selection based on system, or type.
Out-of-the-box categories are:
Financial Reports
DMS Reports
Security Reports
Client_Side_Report
Ledger Report
Users can create custom 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: The list can be filtered by any combination of Name, Description, and Type.
Reports tab
The reports tab allows to import and add reports to CAM.
A report is an answer to a question about business data represented as a list of records that meet a predefined criterion. The report records can generate downloadable documents or be presented visually as widgets in dashboards.
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. | Button |
Delete | Deletes the report. | Button |
Add Report | Adds a new report. | Button |
Tip: The list can be filtered by any combination of Name, Description, and Type.
Adding a New Report with Report Builder
Click the Add Report button.
2. Enter the following information:
Report Name
Report Description
Data Source:
MySQL database (CAM or other)
Elastic Search
Static S3 bucket from AWS
Static Client report (CSV from client system)
Static JSON file
Static Sharepoint List
Cloud Elastic Search provider
Office 365 Graph API: From an Office365 source
CAM Native API
Web API
CAM Metadata
3. Set Report Entities. Select from the available entities. The list will vary depending on the selected data source.
4. Select Report Categories:
Client Side Report
DMS
Experience
Finance
Ledger
Security
Users can create custom report categories.
5. Columns
Check/Uncheck the columns to be used in the report. The number of columns changes depending on the currently selected Entity.
A select all button is available to select all columns if desired or to unselect all.
Only mapped entities will show in the results.
For your convenience:
The Add a New Report window will display the Data Source first on top, and the Dsiplay Name of the report after it.
The input value of the Display Name to Unique Code is replicated in the form.
Changing the Unique Code manually will not modify the display Name.
Once the information is provided, it is possible to:
Join Data
It is possible to create joins between entities.
Three relationships exist between report entities to select from:
Left Outer Join
Right Outer Join
Inner Join
Note that Full Outer Joins are not supported in MySQL currently and are not supported in Dashboards.
After selecting the type of joint, select the other entity and define the condition.
To view the tooltip of what each Join means, click the Info i next to the Join. Self-explanatory joins will not have a tooltip.
Important: Join Data is not available for Elastic Search reports.
Add Filters
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.
To view the tooltip of what each filter means, click the Info i next to the Filter. Self-explanatory filters will not have a tooltip.
Available conditions are:
Equal to
Not equal to
Greater Than
Less than
Between
Greater than or equal to
Less than or equal to
Not less than
Not greater than
In
Not In
Starts With
Ends With
Contains
Like
Is empty
Not empty
If you add a second filter, the filter is blank by default until selected.
Sorting
It is possible to add sorters to rearrange the information. For each sorter, click the arrow to switch between ascending or descending sorting. Multiple sorting criteria can be added.
Sorting aggregations in Elastic and other data sources is now possible.
Summaries
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
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
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.
Basic: Sets a basic layout and coloration.
Litera: Sets a Litera logo, left black colored panel.
CAM: Sets the theme out of the box for CAM. This is the Default Layout.
After changing the theme, the open page will reload to load in the new theme.
Navigation
Once a Visual Theme has been selected, it is possible to set up the navigation as a Sidebar, or a Top tab bar.
Selecting either the Sidebar or Tob tab bar will allow the user to then select the Max Number of Dashboards. By default, the number is set to 20.
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.
Selecting the Plus sign will allow users to add more dashboards to the navigation.
Note: Any other tabs open in your browser will need to be refreshed after applying a new theme.