Integrate with Desygner

Why Integrate with Desygner?

Desygner is a visual content creation solution for personal and business projects. It allows designers to create templates that other teams can use to create new assets while following template rules and layouts. As a result, organizations can efficiently create and edit print-ready documents that respect the organization’s brand.

The integration of Desygner with Oracle Content Management (OCM) allows you (e.g., administrators, designers, content contributors) to take advantages of the features in both applications. For instance, you can create, edit, and manage Desygner assets from the Oracle Content Management web interface, leverage OCM as a cloud-based content management system to improve team collaboration, streamline content creation and publication, and promote content reuse from a single source (the OCM repository).

Prerequisites

There are prerequisites to integrating Desygner with Oracle Content Management. On the Oracle Content Management side, you will need the following before the integration process:

• An Oracle Cloud Account.
• An Oracle Content Management instance.
• A subscription of Desygner.

Integration Process

Integrating Oracle Content Management with Desygner consists of these steps:

1. Add Desygner as SAML Application in Oracle Identity Cloud Service.
2. Create an Application User for Desygner.
3. Enable Desygner Integration in Oracle Content Management.
4. Work with Desygner Asset Types.

Add Desygner as SAML Application in Oracle Identity Cloud Service

This topic describes setting up Desygner to use Oracle Identity Cloud Service (IDCS) for federated Single Sign-On (SSO). Although optional, federated SSO improves the user experience when Desygner is integrated with Oracle Content Management, allowing seamless interaction between Oracle Content Management and Desygner.

Note:

Independent of the federated SSO setup, Desygner needs an application user account to pass information from Desygner to Oracle Content Management. The user account will be created as a special application user in IDCS.

Obtain the Service Provider Entity ID from Desygner

You obtain the Service Provider Entity ID from Desygner and use it to configure the SAML application in IDCS.

1. Log in to the Desygner application as an administrator. Click Workspace Settings in the top right corner. Click Single Sign On and then Configure.
   
   
   
   
2. Note down the value of the Service Provider Entity ID. You will need this value, for example, DESYGNER_F47E212AEF8C65D0_WYEP, when configuring the SAML application in IDCS.
   
   
   
   

Create a SAML Application in Oracle Identity Cloud Service

Create a Security Assertion Markup Language (SAML) application and grant it to users so that they can single sign-on (SSO) into the SaaS application that supports SAML for SSO.

1. Log in to the Oracle Identity Cloud Service (IDCS) admin console: https://cloud.oracle.com/ui/v1/adminconsole
2. Click Applications and Services. Click Add to open the dialog. Select SAML Application.
   
   
   
   
3. Enter a meaningful name for the application, for example, Desygner Connector to OCM. For the Application URL, enter /connect/redirect. Click Next.
4. In the General section, do the following:
   1. Enter the value of the Entity ID which you noted from the Desygner Settings above, for example, DESYGNER_F47E212AEF8C65D0_WYEP

   2. In the Assertion Consumer URL field, enter https://<desygnerHost>/saml/acs

      Leave all the other fields with their default settings.

5. In the Advanced Settings section, uncheck the Enable Single Logout option.
   
   
   
   
6. In the Attribute Configuration section, enter the attributes as shown in the screenshot below. The attributes map the users between IDCS and Desygner.
   
   
   
   
7. In the Authentication and Authorization section, select the checkbox for Enforce Grants as Authorization, and click Finish.
   
   
   
   

Assign the Desygner Role to Users in Oracle Identity Cloud Service

Oracle Identity Cloud Service (IDCS) manages user access to Oracle Content Management and Desygner. It’s recommended that you create an IDCS group with the necessary access roles and add users to the group to inherit the role. This example shows how individual users are assigned to Desygner.

1. Click the Users tab in IDCS.
2. Click Activate, then +Assign to add users who will work with Desygner from Oracle Content Management.
3. Under SSO Configuration, click Download Identify Provider Metadata to download the IDCSMetadata.xml file to your local folder.

Configure Single Sign-On in Desygner

Open the IDCSMetadata.xmlfile on your local machine to extract the information that's needed to configure Single Sign-On in Desygner. The steps below describe how you would find the following fields in the XML file:

• IDP/SLO URL
• EntityID
• X509 Certificate

1. In the IDCSMetadata.xml file downloaded earlier, search for the IDP/SLO URL, the EntityID, and the X509 Certificate values, for example:
   1. https://idcs-a9e0f119e3d04eef8287b584b10354.identity.oraclecloud.com/fed/v1/idp/slo
   2. <dsig:X509Certificate> MIIDXzCCAkegAwIBAgIGAWiWTp/ […] </dsig:X509Certificate><dsig:X509IssuerSerial>
2. Return to Desygner, click Workspace Settings, then Single Sign On, and do the following:
   1. For the SAML 2.0 Endpoint (HTTP) field, enter the IDCS IDP/SLO URL from the IDCSMetadata.xml file, for example:

      https://idcs-a9e0f119e3d04eef8287b584b10354.identity.oraclecloud.com/fed/v1/idp/slo

   2. For the Identity Provider Issuer field, enter the same IDCS URL but change the suffix to /fed. This will also be shown as the EntityID field in the IDCSMetadata.xml file, for example,

      https://idcs-a9e0f119e3d04eef8287b584b10354.identity.oraclecloud.com/fed

      
      
      
      
      
   3. Under the Public Certificate field, add the entire X509 Certificate value.
   4. Finally, set the User Attribute Mappings section.
      
      
      
      

Test the SSO Configuration

Log in to Oracle Content Management as the user who was added in the SAML application created for Desygner. In another tab, access the Desygner URL, e.g., https://<DesygnerHost>/login/sso.

If the SSO configuration is successful, you will be redirected to the landing page of Desygner.

User Mappings in Desygner

Depending on the user access privileges, Desygner creates a different access level for each user. To illustrate the scenario, this section describes an example of two hypothetical users, John Smith and Robin Fisher.

1. John Smith is a user in Desygner and Oracle Identity Cloud Service (IDCS). The userId links to an existing Desygner userId when he logs in to Desygner from Oracle Content Management. The userId has enterprise privileges.
2. Robin Fisher is a user only in IDCS, but not in Desygner. When she logs in to Oracle Content Management through IDCS and accesses Desygner, the userId for Robin Fisher is created in Desygner. This userId has Pro+ privileges. To access Desygner for the first time, she would need to click Forgot Password and then reset the password.

Create an Application User for Desygner

When an asset is updated in the Desygner application, the asset is sent to Oracle Content Management (OCM) using the Oracle Content Management REST API. To invoke the API, Desygner needs an application user in OCM and an associated secure OAuth token. For this flow, the token is requested for the client application. Use this token to call Oracle Content Management.

Create a Confidential Application for Desygner

You set up the OAuth grant type, client credentials, to access the resource.

1. Log in to the Oracle Identity Cloud Service Admin Console,

   https://cloud.oracle.com/ui/v1/adminconsole

2. Click Confidential Application. Give the application a name, and optionally, a description. For example, DesygnerOAuthApp. Click Next.
3. Choose to configure this client as a Client.
4. In the Allowed Grant Types section, select the checkbox for Client Credentials.
5. Scroll down to the Token Issuance Policy section. Under the Resources section, click Add Scope to give the application access to the required Oracle Content Managment instance.
6. Click the right arrow to select the scope. The only scope required is the one ending in urn:opc:cec:all. Select the checkbox next to it and then click Add.
7. Click Next until the end.
8. Click Finish.
9. Note the Client ID and Client Secret values for retrieving a token later.
10. Check Activate and click Save to enable the application.

Assign the Oracle Content Management Role to the Application

You assign the Oracle Content Management repository administrator role and other necessary roles to the Desygner application.

1. Log in to the IDCS Admin Console,

   https://cloud.oracle.com/ui/v1/adminconsole

2. Click Oracle Cloud Services.
3. Select the Oracle Content Management service instance for which you need privileges. This instance name would have been provided by the account administrator.

4. Click Application Roles. Navigate to the role CECRepositoryAdministrator. Click in the right-hand corner. In the dropdown, click Assign Applications.

5. Search and find the application you created in the previous step, DesygnerOAuthApp. Select the application user, DesygnerOAuthApp, in this example.
6. Similarly add the application to CECServiceAdministrator and CECSitesAdministrator roles.
7. Click Save.

Set Up the Webhook URL in Desygner

When editing is completed in Desygner, documents in Desygner and Oracle Content Management need to be synchronized. The synchronization is achieved by setting up the webhook URL in Desygner to generate an OAuth access token for Desygner to invoke the Oracle Content Management (OCM) REST API, which then updates the Desygner documents in OCM.

Note:

As a prerequisite to generating the OAuth access token, a confidential app must be created in IDCS.

1. Log in to the Desygner UI (e.g., https://oracle.desygner.com/login) as an administrator.
2. Click in the top right corner and select Integrations.
3. Enter the Webhook URL field.
   
   
   
   

   The webhook URL is a configurable URL in the Desygner API. The URL contains the following fragments:

   • Desygner API OCM webhook endpoint: /brand/companies/oracle/webhook
   • IDCS two-legged OAuth information
   • The OCM instance identifier

   The final webhook URL is shown as follows:

   https://api.desygner.com/brand/companies/oracle/webhook?idcs_id=<...>&idcs_secret=<...>&idcs_scope=<...>&idcs_account=<...>&instance=<...>

   • The idcs_account can be obtained from the SSO redirection at a URL like this:

     https://<your idcs_account>.identity.oraclecloud.com/ui/vi/signin

     Input the value in the webhook URL without the prefix idcs-, (e.g., b8078481XXX….XXXXbe1af018b).

   • The OCM instance (e.g., finalcXXXX……XXXXXXontrol) can be obtained from your Oracle Content Management instance at a URL like this:

     https://<your OCM instance>.cec.ocp.oraclecloud.com/documents/home

   • The Client ID idcs_id (e.g., 522a37XXXXXX….XXXXX201f) , Client Secret idcs_secret (e.g., 4d6cbf82-XXXX….XXXX393a4ff21e), and Scope idcs_scope (e.g., ....XXXXXX) can be obtained from IDCS. Note that these need to be URL encoded.

   Here is an example of a configured webhook URL:

   https://api.qcdesygner.xyz/brand/companies/oracle/webhook?idcs_id=a7525f35a25344dea2baab7457d3a00e&idcs_secret=dc16ee62-1b96-4a51-a37a-72e2ef56c77d&idcs_scope=https%3A%2F%2F2E364A57C2D741B0A72B21240A542CD0.cec.ocp.oraclecloud.com%3A443%2Furn%3Aopc%3Acec%3Aall&idcs_account=a9e0f119e3d04eefad8287b584b10354&instance=sandbox-oce0002

Enable Desygner Integration in Oracle Content Management

After you've done the integration steps in Oracle Identity Cloud Service and Desygner, you continue the integration process by configuring the Desygner connectors in Oracle Content Management to enable the connection between the two applications and associate the Desygner asset types to your repository.

Create a Publishing Channel and an Asset Repository

To create asset repositories and publishing channels, click on the Content option in the left navigation menu (under ADMINISTRATION). On the Content page, access Publishing Channels and Repositories in the Content dropdown menu.

Note:

To set this up, you need to have the repository administrator role (CECRepositoryAdministrator) in Oracle Content Management.

1. Create a publishing channel.
2. Create an asset repository and associate it with the publishing channel that you created earlier.

Enable the Integration

1. Log in to the Oracle Content Management web interface as an administrator.
2. Click Integrations in the left navigation menu and open the Applications page.
3. Enable the Desygner option as seen here. Click to set or change the Desygner settings at any time.
   
   
   
   
4. The Desygner Configuration dialog opens when you enable the integration. Configure the Desygner connector settings. Input the connection information for Desygner as needed. Some entries are pre-populated for you:

   Field Name	Description
   Description	A description of the integration.
   Company Id	The companyId of your organization, which will be used in Desygner REST API. For example, oracle.
   REST URL	The REST URL for Desygner, e.g., https://api.desygner.com
   Edit URL	The Edit URL for Desygner that's used for editing the PDF documents, https://<companyId>.desygner.com/edit

5. Once the connector configuration is completed, two connectors are enabled, Desygner Asset and Desygner Template. Additionally, two digital asset types of the same name are also created respectively. As an administrator, you can verify this by selecting Content (under ADMINISTRATION) in the left navigation menu of the OCM UI. Select Asset Types from the dropdown menu on the Content page. For details on asset types, see Manage Asset Types to learn more.
   
   
   
   

Enable the Integration on Asset Repositories

As a repository administrator, enable the Desygner integration on repositories of your choice to control who and how people access and use Desygner.

1. Associate the asset types with the repository of your choice. See Associate an Asset Type with a Repository for related details.

   To create or edit the Asset Repository dialog, choose Content in the left navigation menu. On the Content page, choose Repositories in the Content dropdown menu. Select your repository to open Edit Asset Repository.

   In the Content Connectors dropdown menu, Desygner Asset and Desygner Template connectors are available. Choose the connector based on your need. When Desygner Asset is selected, you can create a Desygner asset from a Desygner template. When Desygner Template is selected, you can import a Desygner template from Desygner to OCM. Automatically, the digital asset types are mapped to the repository.

   Click Save when you're done.

2. The integration features immediately become visible in the repository, and you can perform tasks such as the following on the Assets page:
   • Import and edit the Desygner template.
   • Create a Desygner asset from the Desygner template.
   • Edit an asset in the Desygner UI.
   • Publish assets in the repository to the publishing channel.

   • Note:

     For details on the Assets page, see Get to Know the Assets Page.

3. You’ve completed the integration process. Share the repository with users so they can work with Desygner in Oracle Content Management.

   To add members and manage access rights, choose Content from the left navigation menu to open the Repository page. Select your repository and then click Members to access the Repository Members dialog.

   Add the application user that you created earlier to the repository. Search for the application user’s name (e.g., DesygnerOAuthApp) and add the user as a manager to the repository.

   
   
   
   
   

   Additional users can be added at this time, and you can control their access of asset types. In the following screenshot, the highlighted user can view, create, and update Desygner assets in the repository, but cannot delete any.

   See Share a Repository and Manage Digital Assets for related details.

   
   
   
   
   

Work with Desygner Asset Types

After the integration with Desygner is enabled, you can work with Desygner asset types on the Assets page: import a template from Desygner (under the Add dropdown menu), create, edit, and publish your Desygner assets.