Get Started with MRP

Note

Get your portal live, add your first embed, and invite viewers.

Prerequisites

• MyReportPortal account: app.myreportportal.com
• Sigma workspace + at least one workbook/dashboard ready to embed
• the email address to test customer access and row-level security

Tip

When you first log into MyReportPortal, you’ll be greeted by a wizard that will walk you through the following steps to get you up and running with Sigma embedding in a matter of minutes!

1. Connect Sigma (API/Embed Setup)

Add your Sigma embed credentials under Settings → Sigma. MyReportPortal uses them to sign embed URLs on your customers’ behalf.

Initiate Configuration in MyReportPortal

1. Navigate to the MyReportPortal dashboard.
2. Under the Settings menu on the left sidebar, click on Sigma.
3. On the Sigma API Configuration page, click the Edit button located in the top-right corner.

Identify Cloud Provider in Sigma

1. Open a new tab and log into your Sigma account (app.sigmacomputing.com).
2. Click on your profile icon or navigation menu in the bottom-left corner to access the Administration console.
3. Under the Account section, look at the Site overview to identify the cloud provider and region assigned to your Sigma instance (e.g., AWS-US West).
4. Return to the MyReportPortal tab and select the matching option from the Cloud Provider dropdown menu.

Generate API Credentials in Sigma

1. Switch back to the Sigma Administration Console tab.
2. From the left-hand navigation sidebar, click on Developer access.
3. Click the Create new button in the upper-right corner.
4. In the Create client credentials modal, select the following checkboxes:
   • REST API
   • Embedding
5. Enter a Name (e.g., MRP Demo Account) and a Description for easy identification.
6. Assign yourself or another administrator as the Owner to ensure proper access control.
7. Click Create.

Apply Credentials to MyReportPortal

1. A modal titled Access Credentials will display your new keys.
2. Click Copy to clipboard next to the Client ID.
3. Switch to the MyReportPortal tab and paste the value into the Client ID field.
4. Return to the Sigma tab, click Copy to clipboard next to the Secret, and store it in a secure location.
5. Switch back to MyReportPortal and paste the copied key into the Client Secret field.
6. Click the Verify Credentials button to finalize the setup.

Tip

Success: Your Sigma instance is now securely connected to MyReportPortal!

2. Add Your First Embed

Initiate the Embed Creation

1. From the MyReportPortal homepage, click the Add embed button. Alternative: Navigate to the left sidebar menu, look under the Content section, select Embeds, and click the + Add Embed button in the top-right corner.
2. In the Create Embed modal, enter a Name for the embed configuration (e.g., Test Embed).

Select the Sigma Workbook and Content Scope

1. Click into the Workbook search field.
2. Begin typing the name of the desired workbook to filter your available options, then select the correct workbook from the dropdown menu (e.g., Plug Electronics: Individual Customer Sales).
3. Under the What do you want to embed? option, select whether you want to embed a specific page or the Entire Workbook.

Configure Target Audiences (Embed Teams)

1. Click into the Embed Teams field to select which user groups should have access to this report.
2. Choose one or multiple existing embed teams from the dropdown menu (e.g., Corporate Customers).
3. Optional (Create a Embed Team on the Fly): If the embed team you need doesn’t exist, click the + New Embed Team button, enter a name (e.g., Test Group), and click Create to instantly add and assign it.
4. Click the Create Embed button at the bottom of the modal to finalize your settings.

3. Invite Your First Embed Users

Add a New Embed User

1. From the MyReportPortal homepage, click the Add Embed User button.
   • Alternative: Navigate to the left-hand menu sidebar, look under the People section, select Embed Users, and click the + Add Embed User button in the top-right corner.
2. In the Add Embed User modal, fill out the user’s details:
   • Email: Enter the user’s primary email address (e.g., test_user@gmail.com).
   • First name: Enter the user’s first name (e.g., Johnny).
   • Last name: Enter the user’s last name (e.g., Spreadsheets).

Assign Access and Send Invitation

1. Click on the Embed Teams dropdown menu to select the specific embed team(s) this embed user should belong to (e.g., Corporate Customers).
2. Ensure the Send invitation email checkbox is toggled on if you want the user to receive an immediate invite notification to join.
3. Click the **Add Embed User ** button to complete the process.

::: tip Success: The new embed user profile has been successfully created, assigned to their respective embed team, and an invitation email has been initiated! :::