Salesforce Data Cloud Ingestion from Confluence - Implementation Template

(0 reviews)

Setup instructions

The comprehensive instructions on this page show how to configure data sources and deploy the provided integration application for Confluence to MuleSoft Anypoint Platform. Users are guided through the essential steps needed for successful deployments in two different scenarios as well as a section on troubleshooting common issues:

Data source configurations

The Confluence Cloud REST API v2 is used for interacting with Confluence. Some configuration is required on the Confluence side in order for the ingestion application to function correctly. This includes registering the Webhooks and obtaining the Confluence Space ID required during application deployment

Confluence Space ID

  1. Go to the Confluence space in the UI where you want to locate the space ID.
  2. Look at the browser's URL, where you'll find a section like https://yourconfluenceurl.com/spaces/SPACEKEY/overview. The space key (the unique identifier for each space in Confluence) is typically located between /spaces/ and /overview/. For example, if the URL is https://example.atlassian.net/wiki/spaces/ABC/overview, the space key would be ABC.
  3. To retrieve the Space ID, use the Confluence REST API’s - Get Spaces endpoint, passing the space key as a parameter.

Register Webhooks

Registering Webhooks allows change events to flow into the Mule application. Download this asset and use the Postman collection in the /src/test/resources folder to create the Webhooks by configuring the collection variables as required.

Deploying via MuleSoft Direct

To enable the ingestion of unstructured data into Data Cloud this application must first be deployed using MuleSoft Direct. When enabling the integration, the following properties must be configured to connect with the data source and target system.

Property NameDescription
Confluence Space IDA unique identifier assigned to a specific space within a Confluence instance, used to distinguish it from other spaces.
Confluence HostnameThe address or domain name used to access a Confluence instance, such as example.atlassian.com.
Confluence UsernameThe unique identifier used by a user to log in to a Confluence instance.
Confluence API TokenA secure, unique key used for authenticating API requests to a Confluence instance, allowing access without using a password.
Content Type (page or blogpost)The classification of content in Confluence. The application supports page and blogpost content types.
Salesforce HostnameThe address or domain name used to access a Salesforce instance, such as login.salesforce.com.
Salesforce Consumer KeyThe consumer key of a connected app in Salesforce, used in conjunction with the consumer secret to authenticate and authorize API requests.
Salesforce Consumer SecretThe consumer secret associated with the consumer key of a connected app.
Mule Configuration EnvironmentThe target deployment environment configuration selector.

Additional configuration steps

After the application has been deployed there are some additional configuration steps that should be done within Anypoint Runtime Manager. The following instructions are for CloudHub 2.0 deployments but the steps are similar for CloudHub deployments.

  • Find the deployed application by entering the name in the Search Applications field.
  • Click on the application name or select the entry and click the Manage Application button on the right. For CloudHub 2.0 deployments, a screen appears with multiple tabs to configure the application (for CloudHub deployments you will need to click the Settings item on the left navigation bar).
  • Update the Runtime Version to the latest patch release and select the Use Object Store V2 checkbox under the Runtime Options section.
  • Consider increasing the number and size of the replicas (workers) if the source container being monitored has a large number of resources and/or a high volume of changes.
  • Click the Apply Changes to deploy the new configuration

Deploying via Anypoint Platform

To support the ingestion of unstructured data into Data Cloud the application must first be deployed from MuleSoft Direct in order to create the required connector (in Data Cloud); once deployed the application can be updated in Anypoint Runtime Manager as needed.

Getting started

bulb.png The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Deployment

Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub and CloudHub 2.0. These scripts depend on repositories, global settings, deployment profiles and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile, like Anypoint Platform client ID and secret.

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

Required property overrides

Many templates can also be run from Anypoint Studio or Anypoint Code Builder without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information, like passwords and secret keys. These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments. At a minimum, the following properties must be customized to reflect the target deployment environment.

Property NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
confluence.hostConfluence Hostname
confluence.usernameConfluence Username
confluence.api-tokenConfluence API Token
app.container-idConfluence Space ID
confluence.resource-typeContent Type (page or blogpost)
ingest-common.salesforce.hostSalesforce Hostname
ingest-common.salesforce.client-idSalesforce consumer key
ingest-common.salesforce.client-secretSalesforce consumer secret
mule.envTarget deployment environment configuration selector

Troubleshooting

  • If change notifications aren’t flowing to Data Cloud, import the Postman collection by downloading the template app and verify that Webhooks are registered in Confluence for the deployed Mule application.

Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onNov 21, 2024
Asset overview

Asset versions for 1.0.x

Asset versions
VersionActions
1.0.10
1.0.9