Dynamics

Deploy Skuid Pages in the Dynamics UI

With Skuid Platform, you typically deploy sites through apps and routes, and users would access those apps by going directly to your Skuid site’s URL. However, it is also possible to deploy a Skuid site within Dynamics CRM by embedding Skuid pages within your Dynamics instance.

Note

Technically, you are embedding a Skuid route within the Dynamics instance; this route in turn displays a Skuid page.

If your team needs to work within the Dynamics User Interface (UI), you can use Skuid Platform to seamlessly integrate Skuid pages within it.

Prerequisites

Before attempting any of the steps specific to Dynamics deployment, you must complete the following:

  • Your Skuid pages must already be designed.

    • Creating “main form” (i.e. record detail) pages for Dynamics records? Just make sure that the model pointed to the record entity has a condition looking for the id URL/Page Parameter.

      For example, a Lead detail Skuid page would have a model with the following properties:

      External Object Name: Leads

      Condition: leadid = (param) id

  • Your apps and routes must be set.

  • You must have a Dynamics data source.

  • Creating an Azure AD SSO configuration is highly recommended.

    When users access Skuid within Dynamics they must still authenticate to Skuid Platform. With an SSO configuration in place, this authentication process will be seamless. Without it, users will need to log into Skuid within the Dynamics UI, which can be a non-ideal experience.

    • You may also use a different identity provider than Azure AD, but that IdP must allow its login page to be embedded in iFrames. Specifically, the x-frame-options header must be set to allow your Dynamics domain to embed the login page.

Theming

For a seamless Dynamics experience, consider using the corresponding theme in your Skuid pages.

  1. Open the page in the App Composer.
  2. Click the page within the canvas to access the Edit Page Properties pane.
  3. Set Theme to Dynamics.
  4. Save your page.

Whitelist the Dynamics Domain

As a security precaution, Skuid does not automatically let other sites embed Skuid pages within them. Because of this, you must first whitelist your Dynamics domain within Skuid Settings.

  1. Navigate to Configure > Site > Security.

  2. Click fa-plus-circle Add New Policy.

  3. Check Is Active?

  4. In the Whitelisted URI field, enter the domain name of the Dynamics instance.

    e.g.

    example.crm.dynamics.com

  5. Click Save.

Export Skuid Pages to Dynamics

With your Dynamics domain whitelisted, and your pages created and organized within Skuid Platform, you must now export those pages to your Dynamics instance. After creating a Dynamics data source, each route on the the Configure App page will have a new row action: fa-file-excel-o Export to Dynamics.

You’ll need to repeat the following steps for each page you wish to export to Dynamics.

  1. Navigate to Apps in the Skuid UI.
  2. Click fa-wrench Configure next to the name of the app you wish to export pages from.
  3. Click fa-file-excel-o Export to Dynamics.
  4. Fill out the appropriate Web Resource Details:
    • Dynamics Data Source: Choose the data source connected to Dynamics instance you wish to deploy to.
    • Web Resource Name: The name that will be assigned to the Skuid page when it is stored in Dynamics as a web resource.
  5. Click Next Step.
  6. Fill out the appropriate Page Export details:
    • Type of Page:
      • None: The Skuid page will be stored as an undesignated web resource.
      • Main Form: To be used as a detail page for a specific object.
        • Page Name: This determines the display name shown within the page view dropdown.
        • Entity of Page: The Dynamics entity for which this Skuid page should serve as a Main Form.
      • Dashboard: A general page that will appear as a new tab—not directly overriding any object’s detail page.
        • Page Name: This determines the display name shown within the page view dropdown.
    • Page Authentication:
      • Automatic: Use SAML: With this option selected, Skuid Platform will attempt to authenticate using an SSO configuration. If an Azure AD SSO configuration for the Dynamics instance is selected, the login process will be seamless and users will not realize they are exiting the Dynamics user experience.
      • Manual: Show Skuid Login Page: Whenever a user accesses a Skuid page within Dynamics without a currently active Skuid Platform login session, the Skuid Platform login page will appear—requiring users to enter their username and password before continuing.

Skuid will then display a summary of all your choices on the Export Preview step.

If everything looks as it should, click fa-sign-in Export.

You will then see a popup that indicates the export is taking place. This can take a few moments, so do not navigate away from the page.

Publish Changes on Dynamics

After Skuid exports the page to Dynamics, you still must publish those changes. Skuid will show a popup to confirm that the pages have been properly exported and ask if you wish to publish these changes now.

To do this:

  1. Click Open Dynamics System Customization.
  2. Publish the relevant component:
    • Search for and individually select the Skuid page web resource, then and click Publish.
    • Click Publish All Customizations.

Note

If you click Finish from the popup, you’ll need to publish your customizations before using Skuid from the Dynamics solutions explorer.

Accessing the Skuid Page within Dynamics

Once you’ve published the resources containing your Skuid pages, users may access these Skuid pages as views using the view dropdown arrow on dashboards. A detail page’s form may be selected through a similar dropdown list.

Warning

Any changes made within Skuid pages exported to Dynamics will be instantly visible within Dynamics. While this is beneficial for quick updates, keep this in mind so as not to disrupt production use of your Dynamics CRM instance.

Troubleshooting

  • When publishing my Skuid pages, I receive the following error: There was an error uploading your customizations to Dynamics.

    • Your Dynamics CRM Profile does not have permission to update Web Resources. Contact your Dynamics system administrator to do make the updates, or to give you the appropriate permissions.
  • My Skuid page does not load when users click the appropriate view in Dynamics.

    • The Dynamics CRM instance may not be whitelisted within Skuid settings.

      • To verify this, open your browser’s console and see if an error similar to this message is displayed:

        Refused to display 'https://<Your.Skuid.Site>/dynamics?orglcid=0000&orgname=<YourOrg>&userlcid=0000&inDynamics=true' in a frame because it set 'X-Frame-Options' to 'sameorigin'.

      • To resolve this, follow the steps listed in Whitelist the Dynamics Domain.

    • Users may not be authenticating properly. To resolve this:

      • If using SAML for authentication, ensure your SSO configuration is properly set up.
      • If using Manual authentication, verify that users can log in normally on the Skuid site.