Sharing an object

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

You can share objects or folders with groups or with specific users. However, they must have access rights to the underlying data. Once you share a folder, the users or groups have access to all items in that folder.

For some object types, you can also provide a shareable link so the user or group doesn't need to search for the object within Kyvos. You can send the link using your email client. The recipient must log in to Kyvos to be able to access the information.

You can email a snapshot of a worksheet and dashboard directly from within Kyvos. You can also set up a schedule to email worksheets at a specified time and date or use a recurring schedule.

Note

From Kyvos 2023.5 onwards, when you duplicate an object, the access rights of the original object will be automatically applied to the duplicated objects. This applies to all Kyvos entities, including datasets, relationships, semantic models, worksheets, and dashboards.

Sharing an object

To share an object or change share settings, perform the following steps.

Right-click the object name from the list and click Share.
Depending on the object type, you may see additional options and can choose Grant Access, via email, or via Link. Otherwise, you'll see the grant access options.
Follow the steps below for the option you choose.

Sharing object via Link

To share an object via Link, perform the following steps:

To share an object via Link, select and copy the URL text or click the icon next to the link to copy it to the clipboard.
Paste the URL text into an email message or other messenger applications such as Slack.
To grant access before sending via a link, click Grant Access at the bottom of the dialog and follow the instructions given in the topic below.
Click OK.

Sharing object via Grant Access

To grant access, perform the following steps.

Click the Grant Access button and then select a user or group to whom you want to allow access.
Drag that username or group into the Shared With column.
Choose to place it in one of the areas: Read Only, Read and Write, or Deny.
The choices shown here are based on the selected user's or group's rights to the underlying data.
To change the share settings, right-click the group or user name in the Shared With column.
Set the rights to Read Only, Read and Write, Deny, or Inherit Folder Rights.
Click Share.

Sharing object via Email

Note

You must have Email Account configured in your environment to receive email notifications. See the Mail Account section for more details.

To share an object via Email, perform the following steps.

To share an object via Email, select the recipients and do one of the following:
1. Type email addresses for individuals.
2. Click the Users/Groups icon (
  ) and click a group name, user name, or type to quickly find a name.
3. Optionally, click CC or BCC to copy or blind copy recipients on the message. Then select those additional recipients.
  If No Email Id is shown, that account is not associated with an email address and you will need to share the object using a different method.
Enter a Subject and Message that will be sent in email.
By default, Include a link to this document is selected. To send the file as an attachment, clear the checkbox.

Note

The recipients must have read access rights to view the document.

If you share a PDF or CSV file, you can attach it or send a link to it.

Choose the object to Attach as Do not include additional attachments, Include a PDF version of this document , or Include the data from this document as a CSV file.
The CSV option is available only if the Cross-Tabular option is enabled on your Dashboard/ Worksheet.
If you share a dashboard, you will also see the Include an Image version of this document option.
If you choose PDF, CSV, or Image, select Settings and specify further details.
1. For PDF, you can specify the following:
  1. Export View options: By default Export visualization with Tabular view is selected. If exporting a crosstab or table, you can view the number of Selected Columns and their details by clicking the drop-down list. If there is not currently a crosstab view, the Cross-Tabular option is disabled.
  2. By default, the file is exported as a Zipped folder. Clear the checkbox if you want the unzipped file.
  3. If exporting a dashboard, you can specify to Include Dashboard Title and Include Card Information.
    NOTE:
    - You will see the PDF option only if WORKSHEET_EMAIL_SCHD_PDF_FORMAT property is enabled from the olapengine.properties in Kyvos Manager > Manage Kyvos > Properties.
    - You will see the PDF option only if WORKSHEET_EMAIL_SCHD_PDF_FORMAT property is enabled from the olapengine.properties in Kyvos Manager. Please contact Kyvos Support to set this up for you.
2. For CSV, you can specify the following:
  1. Export View options: If you are exporting a crosstab, by default Tabular is selected and you can view the number of Selected Columns and their details by clicking the drop-down list. If you are exporting a crosstab, then the Cross-Tabular option is disabled.
  2. You can use the default formatting choices or change the line separator, field separator, and enclosed by characters.
  3. Specify whether to include the header.
  4. By default, the file is Zipped. To send the file as a CSV file, clear the checkbox. You can choose to keep the measure formatting by selecting the checkbox. To learn more, click the i icon or see the Exporting data from a crosstab section.
    Ensure that only CSV formatted worksheets can be scheduled for email.
3. For Image (only for dashboards), you can specify the following:
  1. Select the corresponding checkboxes if you want to Include Dashboard Title.
    When exporting the dashboard as an image, you cannot select the Include Card Information option.
  2. Specify if the image is to be sent as a Zipped, Unzipped, or Inline image.
  3. Choose the Image Format from PNG and JPEG.
4. Click Apply.
Click Preview to view the message before sending it.
To grant access before sending via email, click Grant Access at the bottom of the dialog and follow the instructions shown earlier in this topic.
After everything is verified and completed, Once you are ready to send the message, click Send.

Note

With the Kyvos 2023.1 release onwards, the email ID of the worksheet sender will be included in the CC section of the email sent to the recipient, enabling the recipient to identify the sender and initiate a conversation if needed.

Scheduling emailing

To schedule emailing of Worksheets or Dashboards, perform the following steps.

Follow the instructions for sharing via Email.
On the Email Data dialog box, click Schedule Email to create a schedule for when it should be sent.
1. Choose Run once or Recurring.
2. For Run once:
  1. Set the date and time zone.
  2. Click Apply.
3. For Recurring:
  1. Set a start and end date.
  2. Set a frequency: daily, weekly, monthly.
  3. Select the number of days to build on.
  4. Specify once per day or repeat.
  5. For repeat, specify the details: set an interval of how many hours and minutes, and what time it starts and ends.
  6. Select the time zone.
  7. Click Apply.
Click Preview to view the message before sending it.
To grant access before sending via email, click Grant Access at the bottom of the dialog and follow the instructions shown earlier in this topic.
Once you are ready to send the message, click Send.

Alternate ways of sharing

For some object types, you can also click the Actions menu (…) or the Options menu and choose Share.

Once you have set a schedule to email an object, you can later edit or remove the schedule in the same dialog box. You can also view schedule details in the Monitor.

Note

The user or group must have rights to the folder that the file is in, and their security settings must allow them access.

Stop sharing

To stop sharing an object or folder, perform the following steps.

Right-click the object or folder name from the list and click Share.
Do one of the following:
1. Right-click the user or group name and select Deny.
2. Drag the user or group name from the Shared With column back to the first column.

Sharing source entity

Kyvos supports recursively sharing an entity along with all its underlying entities. For example, if you want to share a semantic model with another user and its underlying source, such as datasets, relationships, semantic models, worksheets, and associated files, you can do so without having to navigate through every underlying source entity.

Points to know

All the underlying entities of the sharing entities will be shared with the user based on their rights over those entities and the selected sharing rights.
Underlying source entities will not be shared with a user denied access to an entity.
Higher access rights will not be granted to users with read-only access to an entity or those who want to share underlying source entities.
The complete hierarchy of underlying source entities will be shared with a user who has both read and write rights over an entity.
Datasets, relationships, semantic models, and worksheets will be shared as underlying source entities.

To share source entity, perform the following steps.

Right-click the object or folder name from the list and click Share.
Click the Grant Access button and then select a user or group to whom you want to allow access.
Drag that username or group into the Shared With column.
Choose to place it in one of the areas: Read Only, Read and Write, or Deny.
The choices shown here are based on the selected user's or group's rights to the underlying data.
To change the share settings, right-click the group or user name in the Shared With column.
Set the rights to Read Only, Read and Write, Deny.
Click Share Source Entity and then click Share.