Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 4.35 KB

actions-dashboards.md

File metadata and controls

62 lines (44 loc) · 4.35 KB
Raw
title description ms.custom ms.date ms.reviewer ms.suite ms.tgt_pltfrm ms.topic applies_to ms.assetid caps.latest.revision author ms.author search.audienceType
Actions on dashboards (Developer Guide for Dynamics 365 Customer Engagement) | MicrosoftDocs
Learn about performing actions such as create, retrieve, update, or delete, on organization-owned and user-owned dashboards.
10/31/2017
pehecke
article
Dynamics 365 Customer Engagement (on-premises)
586a10d6-4448-474e-9428-d13520f52213
27
JimDaly
jdaly
developer

Actions on dashboards

You can perform actions such as create, retrieve, update, or delete, on organization-owned and user-owned dashboards.

Actions on an Organization-Owned Dashboard

To perform the following actions on an organization-owned dashboard (SystemForm), you must have the System Administrator or the System Customizer role assigned to your account in [!INCLUDEpn_dynamics_crm]:

  • Create, retrieve, update, and delete. You can create or update an organization-owned dashboard by using the [!INCLUDEcc-dyn365-ce-web-services] or by customizing the entity form. For detailed information about creating a dashboard, see Create a Dashboard.

  • Set an organization-owned dashboard as the default dashboard for an organization by setting the SystemForm.IsDefault attribute value to true while creating or updating the dashboard.

    [!IMPORTANT] Using the methods available in the [!INCLUDEcc-dyn365-ce-web-services], it is possible to set two dashboards as the default. Make sure that no other dashboard is the default dashboard for the organization before updating this setting programmatically.

    After you update an organization-owned dashboard, you must publish the metadata changes to make it visible across the organization. You can use the xref:Microsoft.Crm.Sdk.Messages.PublishAllXmlRequest message or xref:Microsoft.Crm.Sdk.Messages.PublishXmlRequest message to publish the changes made for an organization-owned dashboard. For a sample code that demonstrates this, see Sample: Create, Retrieve, Update and Delete (CRUD) a Dashboard.

    For a list of supported messages on the organization-owned dashboard entity, see SystemForm Entity.

Actions on a User-Owned Dashboard

You can perform the following actions on a user-owned dashboard (UserForm):

  • Create, retrieve, update, and delete. For detailed information about creating a user-owned dashboard, see Create a Dashboard.

  • Change the ownership of a user-owned dashboard by assigning it to another user or team using the xref:Microsoft.Crm.Sdk.Messages.AssignRequest message.

  • Retrieve the access that the specified security principal (user or team) has to a user-owned dashboard using the xref:Microsoft.Crm.Sdk.Messages.RetrievePrincipalAccessRequest message. You can also retrieve all the security principals (users or teams) that have access to a user-owned dashboard, along with their access rights to the user dashboard using the xref:Microsoft.Crm.Sdk.Messages.RetrieveSharedPrincipalsAndAccessRequest message.

  • Collaborate with other users and teams on specific areas by sharing a user-owned dashboard with them using the xref:Microsoft.Crm.Sdk.Messages.GrantAccessRequest, xref:Microsoft.Crm.Sdk.Messages.ModifyAccessRequest, and xref:Microsoft.Crm.Sdk.Messages.RevokeAccessRequest messages.

    For a list of supported messages on the user-owned dashboard entity, see UserForm Entity.

See also

Dashboards for Microsoft Dynamics 365 Customer Engagement
Using FormXML for Dashboards
Create a Dashboard
Sample Dashboards
Dashboard Entities
Sample: Create, Retrieve, Update and Delete (CRUD) a Dashboard
Sample: Assign a User-Owned Dashboard to Another User

[!INCLUDEfooter-include]