Business Metrics - Quicksight V1

I-Framed Experience

Role Based Access

Included Dashboards

Server Setup

Zinier business analytics and metrics needs are powered and implemented using AWS Quicksight service. It provides easy to use tools to build visualizations, perform ad-hoc analysis, get business insights from the data and share the assets.

This guide describes how to set up business metrics for a newly created org in Zinier.

System Config:

Following system config needs to be created to trigger the business metrics setup related APIs:

Config key: credentials

Config scope: quicksight

Config type: JSONText

Config Value: {

   "accessKeyId": "accessKeyId",

   "secretAccessKey": "secretAccessKey",

   "clientRegion": "us-east-1"

}

Above are the sample values shown. Update the config value accordingly.

APIs:

1. <host>/admin/businessmetrics/setUp: This api is provided to set up business metrics for a newly created org in Zinier.

   • Sample Payload:

     CODE

     {
     
        "datasetId": [
     
            "aef2bb3b-8b35-4da9-ac63-6f5c64bd553e"
     
        ],
     
        "analysisId": "2e6b28d2-6e9c-4d1d-9528-6e8e4bb4566d",
     
        "accountId": "awsAccountId",
     
        "targetOrg": "hwkdev",
     
        "userId": "rahul.kant@zinier.com"
     
     }

     • datasetId: An array of master dataset which needs to be replicated in target org. These datasets will be utilized in the target org’s analysis and dashboard. 

     • analysisId: Master analysisId which needs to be replicated in target org.

     • accountId: AWS quicksight account Id where business metrics need to be set up.

     • targetOrg: Name of the target org.

     • userId: Email Id which will be used to set up the business metrics. 

   • Once the setup is done and successful, following assets will be created in AWS quicksight as part of the API execution.

     • Datasets: All the master data sets will be replicated as <org name>_<master data set name>. It will be utilized in the org’s analysis and dashboard.

     • Analysis: Master analysis will be replicated as <org_name>_analysis. Underlying data set will be the target org’s dataset and it will consume the target org’s data. The theme and structure of the charts and visuals will remain the same as the master analysis.

     • Dashboard: Master dashboard will be replicated as <org_name>_dashboard. Underlying data set will be the target org’s dataset and it will consume the target org’s data. The theme and structure of the charts and visuals will remain the same as the master dashboard.

2. <host>/admin/businessmetrics/getUserURL: This API is used to generate an embed URL of the org dashboard and it will be embedded in the zinier application. This does not require any payload.

3. <host>/admin/businessmetrics/getConsoleURL: This API is used to generate an embed URL of the org console and it will be embedded in the zinier application. This does not require any payload.

   • CODE

     Quicksight role arn:aws:iam::850155822055:role/embedding_quicksight_dashboard_role
     
     Account id: 850155822055
     
     Region: US East (N. Virginia)

RDS prerequisites

Binlog retention hours

The binlog retention hours parameter is used to specify the number of hours to retain binary log files. Amazon RDS normally purges a binary log as soon as possible, but the binary log might still be required for replication with a MySQL database external to Amazon RDS. The default value of binlog retention hours is NULL. This default value is interpreted as follows:

• For RDS for MySQL, NULL means binary logs are not retained (0 hours).

• For Aurora MySQL, NULL means binary logs are cleaned up lazily. Aurora MySQL binary logs might remain in the system for a certain period, usually not longer than a day.

To specify the number of hours for Amazon RDS to retain binary logs on a DB instance, use the mysql.rds_set_configuration stored procedure and specify a period with enough time for replication to occur, as shown in the following example.

Execute this command in the query ide

call mysql.rds_set_configuration('binlog retention hours', 24);

For MySQL DB instances, the maximum binlog retention hours value is 168 (7 days).

After you set the retention period, monitor storage usage for the DB instance to make sure that the retained binary logs don't take up too much storage.

Set the MySQL binary logging format

1. Open the Amazon RDS console at https://console.aws.amazon.com/rds/.

2. In the navigation pane, choose Parameter groups.

3. Choose the parameter group used by the DB instance you want to modify.You can't modify a default parameter group. If the DB instance is using a default parameter group, create a new parameter group and associate it with the DB instance.For more information on parameter groups, see Working with parameter groups.

4. From Parameter group actions, choose Edit.

5. Set the binlog_format parameter to the binary logging format of your choice (ROW, STATEMENT, or MIXED). You can also use the value OFF to turn off binary logging.

6. Choose Save changes to save the updates to the DB parameter group.

After you perform these steps, you must reboot the DB instance for your changes to apply. For more information, see Rebooting a DB instance.

List of environments are currently synced in DMS

Curie

• midcod

• midcoq

Platform 

• midcou

• midcop

DMS Migration task

Manage domains for embedded dashboards in Quicksight

1https://local.application.<envname>.zinier.net:3000

2https://webedi.app.<envname>.zinier.net 

3https://local.application.<envname>.zinier.net 

4https://app.<envname>.zinier.net

Datasets