--- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge ## Knowledge:Bridge Knowledge:Bridge allows you to use Confluence as a source for creating content that can be published to Salesforce Knowledge. [Knowledge:Bridge Overview](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-overview.md) ### Release Notes * #### [Knowledge:Bridge Confluence Cloud Add-on only updates](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-confluence-cloud-add-on-only-upda.md) January 13, 2025 * #### [Knowledge:Bridge 1.4](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-4.md) January 13, 2025 * #### [Knowledge:Bridge 1.2](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-2.md) January 13, 2025 ### Featured * #### [Knowledge:Bridge Installation and Setup](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-installation-and-setup.md) Installing Knowledge:Bridge Components Knowledge:Bridge Salesforce package Knowledge:Bridge Salesforce package manages the license details and provides compone... * #### [Upgrading to Knowledge:Bridge v1.4](https://docs.zagile.com/kb/v1.4/confluence-cloud/upgrading-to-knowledge-bridge-v1-4.md) Knowledge:Bridge Salesforce Package v1.4.6 Use this URL to install the package into any organization: https://login.salesforce.com/packaging/installPackage.ape... ### Topics * #### [Knowledge:Bridge Overview](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-overview.md) * [Using Knowledge:Bridge for publishing Confluence pages to Salesforce](https://docs.zagile.com/kb/v1.4/confluence-cloud/using-knowledge-bridge-for-publishing-confluence-p.md) * [Knowledge:Bridge Components](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-components.md) * [Knowledge:Bridge Cloud Supported Macros](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-cloud-supported-macros.md) * #### [Knowledge:Bridge Installation and Setup](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-installation-and-setup.md) * [Assign Knowledge:Bridge Permission Sets](https://docs.zagile.com/kb/v1.4/confluence-cloud/assign-knowledge-bridge-permission-sets.md) * [Configure K:B General Settings](https://docs.zagile.com/kb/v1.4/confluence-cloud/configure-k-b-general-settings.md) * [Authenticate Salesforce to Confluence](https://docs.zagile.com/kb/v1.4/confluence-cloud/authenticate-salesforce-to-confluence.md) * [Add Lightning Web Component to Knowledge Record Page](https://docs.zagile.com/kb/v1.4/confluence-cloud/add-lightning-web-component-to-knowledge-record-pa.md) * [Authenticate Confluence to Salesforce](https://docs.zagile.com/kb/v1.4/confluence-cloud/authenticate-confluence-to-salesforce.md) * [1 more pages](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-installation-and-setup.md) * #### [Knowledge:Bridge User's Guide](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-user-s-guide.md) * [Publishing Pages to Salesforce Knowledge](https://docs.zagile.com/kb/v1.4/confluence-cloud/publishing-pages-to-salesforce-knowledge.md) * [Updating / Deleting Pages published to Salesforce Knowledge](https://docs.zagile.com/kb/v1.4/confluence-cloud/updating-deleting-pages-published-to-salesforce-kn.md) * [Publishes Pages Report](https://docs.zagile.com/kb/v1.4/confluence-cloud/publishes-pages-report.md) * [Knowledge:Bridge Configurations](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-configurations.md) * [Configure Article Fields](https://docs.zagile.com/kb/v1.4/confluence-cloud/configure-article-fields.md) * [4 more pages](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-user-s-guide.md) * #### [Advanced Topics](https://docs.zagile.com/kb/v1.4/confluence-cloud/advanced-topics.md) * [Programmatic Access to Salesforce Article Properties in Confluence Cloud](https://docs.zagile.com/kb/v1.4/confluence-cloud/programmatic-access-to-salesforce-article-properti.md) * [Permissions Required for Salesforce API-Only Integration User](https://docs.zagile.com/kb/v1.4/confluence-cloud/permissions-required-for-salesforce-api-only-integration-user.md) * #### [Knowledge:Bridge Release Notes](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-release-notes.md) * [Knowledge:Bridge Confluence Cloud Add-on only updates](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-confluence-cloud-add-on-only-upda.md) * [Knowledge:Bridge 1.4](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-4.md) * [Knowledge:Bridge 1.2](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-2.md) * [Knowledge:Bridge 1.1](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-1.md) * [Knowledge:Bridge 1.0](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-0.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Add Lightning Web Component to Knowledge Record Page > Knowledge:Bridge provides a Lightning Web Component to apply the Article stylesheet to published Confluence pages in Salesforce. This component provides formatting for Confluence tables, panels, layouts, supported macros, etc. Edit your Knowledge Lighting Record Page in Salesforce Object Manager ![image2022-10-20_17-47-26.png](https://docs.zagile.com/__attachments/a_768f20cc0a149093b84b1fcea4e49293a78be656baa82c414f30ebc9b621d238/image2022-10-20_17-47-26.png?cb=d12f834cba1e59fe79f41df5ef87b7b9) Add the *Article StyleSheet* Lighting Web Component somewhere in the page and save ![image2022-10-20_17-50-34.png](https://docs.zagile.com/__attachments/a_5cfe500535e693662454d98bb6287a70b379e4f26bd63340b65ae6afbe915164/image2022-10-20_17-50-34.png?cb=1142764eac3244a36a4cc0485adb3530) The same Lightning Web Component can be optionally added to the Article Detail page of a Digital Experience Site in the Community Builder ![image2022-10-20_17-57-23.png](https://docs.zagile.com/__attachments/a_1f839b562eb3a54ea7a650b2aaa09009f82b6d01ef4dc6a96a33c858eea018e6/image2022-10-20_17-57-23.png?cb=b48cab3b04f3ba74538d8a9add5d411b) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Advanced Topics * [Programmatic Access to Salesforce Article Properties in Confluence Cloud](https://docs.zagile.com/kb/v1.4/confluence-cloud/programmatic-access-to-salesforce-article-properti.md) * [Permissions Required for Salesforce API-Only Integration User](https://docs.zagile.com/kb/v1.4/confluence-cloud/permissions-required-for-salesforce-api-only-integration-user.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Assign Knowledge:Bridge Permission Sets Knowledge:Bridge provides a number of permission sets out-of-the-box that must be assigned to specific users based upon the type of access and usage they will require for the integration. These assignments must be done following the package installation to ensure that users have the necessary permissions. These permission sets are described below: **K:B User** - This permission set ensures access to custom objects bundled with the package and the K:B App. It is required for all users who will be managing Knowledge:Bridge published Articles. **K:B Administrator** - This Permission Set provides admin access to Knowledge:Bridge package configurations in addition to access to custom objects bundled with the package and the K:B App. It is recommended for users who will be managing connections to Confluence instances. **K:B Integration User**- This permission set ensures access to Knowledge:Bridge package components that are involved in the exchange between Salesforce and Confluence. This permission set must be assigned to the Salesforce account designated as the Integration User (Salesforce account used to log into Salesforce from Confluence). For details on managing permission set assignments in Salesforce, please refer to the following: [https://help.salesforce.com/articleView?id=perm_sets_manage_assignments.htm\&type=5](https://help.salesforce.com/articleView?id=perm_sets_manage_assignments.htm&type=5) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Authenticate Confluence to Salesforce ## Authenticate Confluence to Salesforce In Confluence Administration → Apps → Knowledge:Bridge, ![KBdoc1.jpg](https://docs.zagile.com/__attachments/a_e40c3378add5b2eec347ab0dbc67f9f9fcf1825870dae50309188d9073979432/KBdoc1.jpg?cb=9a2eba9b152888766d4b67dec7349252) Click on the **Login to Salesforce** button. ![image-20260506-224148.png](https://docs.zagile.com/__attachments/a_9b097ab1b0242fb1e4c0c4e2ef8c0368cc33e80b435452b1280c4f6a38fdb827/image-20260506-224148.png?cb=be0d53d9781a4dbe4ade1baa47d95ce6) Copy the Callback URL. ![image (10)-20260507-200443.png](https://docs.zagile.com/__attachments/a_3689c51720b3f233e62d086389772e0ab39345fefeaf5eedf6720a10ca154085/image%20(10)-20260507-200443.png?cb=587da755c5ef4a03eb282aa0de8d542d) Go to Salesforce in a new tab as a Salesforce Admin and open the **External Client App Manager** in the Setup, add a**New External Client App**filling the required fields. ![KBdoc49.jpg](https://docs.zagile.com/__attachments/a_bb11510ffbccaa217099f19bca58979da8bdcaa012f3c100e6aeda17f0cf0ae1/KBdoc49.jpg?cb=636726d7ef3df3178cd6d27c07fc8bdd) Go to the **API (Enable OAuth Settings)**section 1. Check Enable OAuth. 2. Paste the copied Calback URL. 3. Select the following OAuth scopes: * Access the identity URL service (id, profile, email, address, phone) * Manage user data via APIs (api) * Perform requests at any time (refresh_token, offline_access) 4. Click on the Create button ![image (12)-20260507-201926.png](https://docs.zagile.com/__attachments/a_21f5fdbe0f140aa93f346765394bee5b9b9469e0148baa06c39ca6e68b119a87/image%20(12)-20260507-201926.png?cb=adb65fc0b0733058edcdb4364d822086) Once the External Client App was created, copy the Consumer Key and Secret (find them in the Settings Tab → OAuth Settings in the External Client App). Return to Confluence, paste the copied Consumer Key and Secret and click **Continue.**Note that the External Client App may take some minutes to be ready (you may get "invalid client Id" if it is not ready). ![image (11)-20260507-200711.png](https://docs.zagile.com/__attachments/a_47b3a784f2556eb4eee5396f3e665099169f65faddd7f1e48af51c91fbc570be/image%20(11)-20260507-200711.png?cb=5a02b001c71ddbc8472d6bea3e5ab018) Log in to Salesforce using the account that will be used for publishing Confluence pages to Salesforce Knowledge. Allow Access to the External Client App created before. ![KBdoc55.jpg](https://docs.zagile.com/__attachments/a_c66c570abc8d13dd24e771a8e0eaf250211f5310b87635a49201b5efb22734d7/KBdoc55.jpg?cb=686e17a898753ea5ec8147d4142e241a) Once authentication is successful, you will be redirected to Confluence, review the Connection Information. ![KBdoc56.jpg](https://docs.zagile.com/__attachments/a_9da0defd7d8dd87357ab44aac80bdc3fec2126630d5521414008e910637de153/KBdoc56.jpg?cb=448cc5f552d2f1d88960a972239d6d06) If the Consumer key and secret need to be updated go to the **Advanced Options** toggle, set the new values and **Save** , then click on the **Login to Salesforce** button. ![image (13)-20260507-202603.png](https://docs.zagile.com/__attachments/a_513811fd218a4faa7d863067dd0e4420dbdbd3e122781a6547acacc2d34f172b/image%20(13)-20260507-202603.png?cb=a0a351a73096b0bac56d0482c4849356) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Authenticate Salesforce to Confluence Create a new Auth. Provider in Salesforce Setup using the following parameters: * **Provider Type:** ZKBConfluenceCloudAuthProvider * **Name:** kbcloud (it must be exactly*kbcloud)* * **URL Suffix:** kbcloud (it must be exactly*kbcloud)* * **Execute Registration As:** Select your current user. ![image2022-10-18_14-4-16.png](https://docs.zagile.com/__attachments/a_3172f68983f2147966122c5eb2a9fef8413d98834dee0d513cabe3fd81ca04ed/image2022-10-18_14-4-16.png?cb=785dee4807c3af5733f96e15e5869f3a) ## Login to Confluence using Named Credentials In Named Credentials on Salesforce Setup, edit the *kbcloud_principal* named credential. Update the following values: * **Authentication Protocol**: OAuth 2.0 * **Authentication Provider**: kbcloud ![image2022-10-18_14-6-42.png](https://docs.zagile.com/__attachments/a_25f059f15392caafa108299033b562c26dcc12566b32010be9c001c244a3a78a/image2022-10-18_14-6-42.png?cb=7122fc860a7461ecf6737367d3720a1e) After saving it will redirect you to the Atlassian site to authenticate and allow access to your Confluence Cloud instance. ![KBdoc60.jpg](https://docs.zagile.com/__attachments/a_bb8ab909bc3a5f4a8ddade7d1b8f29b2436a88042290f47c350e8fe045d44429/KBdoc60.jpg?cb=f4366a6c138bc7c36f71d0a60ea2c1d6) Verify the **Authentication Status:** ![image2022-10-18_14-8-48.png](https://docs.zagile.com/__attachments/a_bcf03bf70bc5092138fe3cba8884166e28a27df963eed1260677fbf472b46781/image2022-10-18_14-8-48.png?cb=c180ff1ad24de469bd93f18defaa00a6) ### Add the Confluence Connection in Knowledge:Bridge App In Salesforce Apps, find the for Knowledge:Bridge App ![image2022-10-18_14-12-30.png](https://docs.zagile.com/__attachments/a_0b6bf314867caf670f6ee2f4d5bc4801b2a0187d9df6221254835f23fbb1f716/image2022-10-18_14-12-30.png?cb=7423ced0ec637d6b3df644d02d4eae58) In the *K:B Settings Tab*, add a new Confluence connection and select an instance from the available Atlassian sites (authenticated previously via named credential) and set an Alias. ![image2022-10-18_14-13-46.png](https://docs.zagile.com/__attachments/a_50e603865ba2f3d35f72cb4cc62691566f80f62de71edb3bc94a0c17044fcdae/image2022-10-18_14-13-46.png?cb=adb332979bea4a93c994ecb6767b6743) ## How to re-authenticate to Confluence If re-authentication is needed (for example to use a different Integration user or because the connection is broken) follow the next steps: In Named Credentials on Salesforce Setup, edit the *kbcloud_principal* named credential. Do not change any property and just click on save ![KBdoc61.jpg](https://docs.zagile.com/__attachments/a_820ac93576855b98920aadb42e6327f535528e4c7fe2e6cabf99ef297ee6ede6/KBdoc61.jpg?cb=0dba2aabce58b06cbe1b28f0c7c7a343) After saving it will redirect you to the Atlassian site to authenticate and allow access to your Confluence Cloud instance. ![KBdoc60.jpg](https://docs.zagile.com/__attachments/a_ce32086223d9941475e2e2dfc8f7001a1425007e8165345c5771d3857490dd66/KBdoc60.jpg?cb=f4366a6c138bc7c36f71d0a60ea2c1d6) Verify the **Authentication Status:** ![KBdoc62.jpg](https://docs.zagile.com/__attachments/a_9e65002e644e2e46223dfc1440456779f5f1195df2439d849d2e8049544abf6b/KBdoc62.jpg?cb=8b5e032fc986daaf00b6f71c74a2f99f) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Bulk publishing to Knowledge Articles Knowledge:Bridge provides the ability to bulk publish multiple pages in a Confluence Space to Salesforce Knowledge Articles. The 'Publish Space' feature from Confluence Space Settings perform the bulk publish action on the selected content in a Space. ![KBdocSpaceSettings.jpg](https://docs.zagile.com/__attachments/a_17b2b36b00e618c0b6261b93cab9d263863d976ba37b58d8cb292b04e8b2a794/KBdocSpaceSettings.jpg?cb=0d5c038ed040eac9e1a1ff6ba01b83a6) ![KBdoc11.jpg](https://docs.zagile.com/__attachments/a_b844d6b715f3bd74a754b6f0d1929b42faaaa64756053675a3ee789497cbdda7/KBdoc11.jpg?cb=bf62f96c59fe0a97949dde54ac3709e9) The pages can be filtered by Title or by Status. ![KBdoc12.jpg](https://docs.zagile.com/__attachments/a_394cb82c8b417249df60034d4150868226a0972978cd2ab109da2564dce7842b/KBdoc12.jpg?cb=14bcaa78dd685ada3b85c9994b60f994) This action will cause the selected pages to be published or updated (if previously published). By default selecting a page will also select all its descendants, use **Alt/Option + Click** to select individual pages, or right-click on the checkbox (or page title) for more selection options. ![image-20260407-224154.png](https://docs.zagile.com/__attachments/a_94223a0b20ddb91a9a4e8bd565c5856056bf1cf90cd25926dcb689edb0dc6fee/image-20260407-224154.png?cb=98cf722d31bce32d3935ee9641e14f36) Metadata can be assigned to pages that will be published for the first time. (Categories, Channels, and Record Type) ![image-20260406-162317.png](https://docs.zagile.com/__attachments/a_99d014b8a08ddc533989eb57ab3f979d3de67b96beaf3930073f3e7cb0e726bf/image-20260406-162317.png?cb=d8314a8af4f163371c0e35ad8f0a3f39) Note that bulk publish creates or updates Articles in Salesforce Knowledge in Draft mode (the articles can be reviewed and made Online in bulk from Salesforce). ![image-20260407-224327.png](https://docs.zagile.com/__attachments/a_117921582bd9bc82a94b4c28d41b60b5fc23df99df277a36509e376502556d3e/image-20260407-224327.png?cb=10f42851f2c6baef8b9c63192377763b) Once bulk publish is confirmed, the pages will be queued for publish and you will get redirected to view the progress of the bulk publish. Use the refresh icon to review the progress. ![KBdoc43.jpg](https://docs.zagile.com/__attachments/a_b1bb8a9e99fc8a1d93036f1d72540e4550fd41d9a798a175c0542cd38bb0b1c2/KBdoc43.jpg?cb=257713a653803e2d70f16d64ffae7441) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Bulk Unpublishing to Knowledge Articles Knowledge:Bridge provides the ability to bulk unpublish multiple pages, this will delete the Knowledge Articles in Salesforce and remove any Knowledge:Bridge metadata associated with the pages. The 'Unpublish Space' feature from Confluence Space Settings performs the bulk unpublish action on the selected content in a Space. ![KBdocSpaceSettings.jpg](https://docs.zagile.com/__attachments/a_12f4464691916fe2bb54debd9459b04c67aeb82d4f2113ed93ef3205aaabbeae/KBdocSpaceSettings.jpg?cb=0d5c038ed040eac9e1a1ff6ba01b83a6) ![KBdoc18-20260324-164437.jpg](https://docs.zagile.com/__attachments/a_6784d64bda89f05850a9345448f07ea100ad437988e61a4764c9746f1abb1546/KBdoc18-20260324-164437.jpg?cb=2f5f96a7cb56345b174dddbf227a5c00) The pages can be filtered by Title or by Status. ![image-20260324-153316.png](https://docs.zagile.com/__attachments/a_fcd02ae73f43d8d9d44fd09eed635f1d4d7106562287b60546e8550091081caa/image-20260324-153316.png?cb=9d8a1ae3e06563222603cab4f2f07d9d) This action will cause the selected pages to be unpublished from Salesforce Knowledge. ![image-20260407-225211.png](https://docs.zagile.com/__attachments/a_92b277bc98fe73fc4b5f2683c4656db37acec15aa4840777743a345aa04a0d64/image-20260407-225211.png?cb=8d21e230252b3fd7a792d1eaf65a858a) A notification email address can be optionally added. ![image-20260407-225255.png](https://docs.zagile.com/__attachments/a_726ca8cc7721da9f53cb66dfd1b0920358abe33a5a30bff4fdc2ceeb0fc776ae/image-20260407-225255.png?cb=29fda0d2ac93109c8e6556c45461e9c9) Once it is confirmed, the pages will be queued for unpublish and it will redirect you to view the progress. Use the refresh icon to review the bulk unpublish progress. ![KBdoc44.jpg](https://docs.zagile.com/__attachments/a_312209964e0ac5ba074bbb666569a20ad653c48cef005e718bd8a6a2a51b00ad/KBdoc44.jpg?cb=73d3b3c11e38c0441923ace928c0cf02) ![image-20260407-225504.png](https://docs.zagile.com/__attachments/a_53a58b60719dffb66b3585a41d22be686b8ee0c0ed73003b1becf488dc4376d1/image-20260407-225504.png?cb=35caf633e7d1933924fadb5053e93069) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Configure Article Fields Knowledge:Bridge sets the following Knowledge Article fields by default: * Article Title * Article Summary * URL Name * Channels * Article Content It is possible to **optionally** let Confluence users populate other Knowledge Article standard or custom fields by defining a Global or Knowledge Action in Salesforce (by a Salesforce Administrator) that may be selected in the "Configure Article Fields" tab in the Space settings for Knowledge:Bridge. ## Configure Article Fields Article Fields and layout can be defined in Salesforce as a Global Action or Knowledge Action. Use Global Action to let Confluence users populate fields only the first time the page is being published (can not be edited from Confluence after page is published). Use Knowledge Action to let Confluence users to set fields when publishing the page to Salesforce for the first time (fields are populated immediately after a Knowledge Article is created) but also let them update the fields via "Update Metadata" or "Bulk publish" options. Note it is also possible to use both, in this scenario fields defined in Global Action will be used for creating the Article and fields defined in Knowledge Action will be used for update. We recommend using Global Action only in the following scenarios: * Knowledge Article has custom **required** fields in the Knowledge Article Layout in Salesforce (and so if those fields are not populated at creation time then it is an error) * You are using Knowledge Action but want to define a different set of fields that can be populated when publishing the page for the first time only. For all other use cases we recommend using Knowledge Action. ### Article Fields via Global Action In Salesforce go to Setup → Global Actions → New Action and select "Create a Record" for Knowledge object, set a label and name but make sure the name field starts with the "**KB_** " prefix. Record type selection is **required** (different than --Master--) if there are records types defined for Knowledge object. ![CleanShot 2024-11-26 at 14.34.50@2x-20241126-193552.png](https://docs.zagile.com/__attachments/a_d060897243de6cd34e80551ad41da8b713ae85be608d191acbe27b3e6dfbfbb8/CleanShot%202024-11-26%20at%2014.34.50@2x-20241126-193552.png?cb=b230332abc6eb23dfcf6cec539cbbff5) Save and next add the Knowledge fields that Confluence users may populate (note Title and URL Name are required and should not be removed from the layout). It is also possible to set other fields as required by editing the field properties (in the example below we set "Product" as required). Save the layout. ![CleanShot 2024-11-26 at 14.44.27@2x-20241126-194508.png](https://docs.zagile.com/__attachments/a_3ea27a1d025f7971df6fbd4c8817da919e7d22083ca33932128c018c33bd2f24/CleanShot%202024-11-26%20at%2014.44.27@2x-20241126-194508.png?cb=86b358d89cd927f33d375589f426457c) In Confluence, go to the Space Settings ![KBdoc32.jpg](https://docs.zagile.com/__attachments/a_7b33a57af1d0daeed984b924f6872136e5b52e603d32da2bae53692f970bcb58/KBdoc32.jpg?cb=d7a6bfeebe49182ecb0f243638f32188) Then go to Integrations → Knowledge:Bridge → Configure Article Fields, select the Global action created previously and save. ![KBdoc34.jpg](https://docs.zagile.com/__attachments/a_9ee5b716f2d41bf49034dc0b0f16708aaf8b20ff959cac33a4820ffda3274ab5/KBdoc34.jpg?cb=8c19e98b644f48647029b96bdc317dfc) After saving when a Confluence user tries to publish a page the global action fields will be presented to the user ![image-20260407-153350.png](https://docs.zagile.com/__attachments/a_e98857456201a73f6abf0d72d4c3bf63aa235c513ec64d8ffcfca5ce57a5b88a/image-20260407-153350.png?cb=4d0a47d4a1ced56d1d0a55e8359f2edc) #### Article Fields via Knowledge Action In Salesforce go to Setup → Object Manager → Knowledge → Buttons, Links, and Actions → New Action and select "Update a Record", set a label and name but make sure the name field starts with the "**KB_**" prefix. ![CleanShot 2024-11-26 at 18.19.08@2x-20241126-231953.png](https://docs.zagile.com/__attachments/a_eca3eb66189b5dcaba01adf744cb3eb637a9e163b2aa5270344ff95b63987582/CleanShot%202024-11-26%20at%2018.19.08@2x-20241126-231953.png?cb=e6359c905f1250e54ccd1496e4fe9917) Save and next add the Knowledge fields that Confluence users may populate (Title and URL Name can be removed from the layout, also make sure Body/Content field is NOT added). It is possible to set fields as required by editing the field properties (in the example below we set "Product" as required). Save the layout. ![image-20260407-184718.png](https://docs.zagile.com/__attachments/a_2e1762615f1556b0bfc9be5926b9b4f0c2eb3892ea4e25077d17025aac6ac379/image-20260407-184718.png?cb=c597ba48b65a5abd3b1ed101e6e760e3) In Confluence, go to the Space Settings. ![KBdoc32.jpg](https://docs.zagile.com/__attachments/a_93cece4f952a1dd28b486dedf68674895dd59e31eb54f3e1f4b2adcb18d29613/KBdoc32.jpg?cb=d7a6bfeebe49182ecb0f243638f32188) Then go to Integrations → Knowledge:Bridge → Configure Article Fields, select the Knowledge Action created previously and save. ![KBdoc35.jpg](https://docs.zagile.com/__attachments/a_671523d20c4313b1eb346d9f66f9190d2013c98decba65a5d099af7fcd3ac5ee/KBdoc35.jpg?cb=7cb7da04b56d1b1d43ed902bf063b00b) After saving when a Confluence user tries to publish a page for the first time the Knowledge Action fields will be presented to the user ![image-20260407-185017.png](https://docs.zagile.com/__attachments/a_898326d545b96dfc2319bc7d73d670195745402a234d501ace28108dfe6ad296/image-20260407-185017.png?cb=cf6085a15c7047e28187f999355d51f6) For updating Article fields go to Apps → Update Salesforce Metadata ![KBdoc36.jpg](https://docs.zagile.com/__attachments/a_e774218c676582eb3e278075834af769c6774f9117b71c1b6a708f6a187bd40d/KBdoc36.jpg?cb=d7873dca2b6b5f947c3a1e9a2e026c3c) Then go to Article Fields ![KBdoc37.jpg](https://docs.zagile.com/__attachments/a_f562ad10580698c3d9c8b018dfa615ccaa0e3c02fe63c554a866ccce86947292/KBdoc37.jpg?cb=9fc6d2f14a2c173dcf74b05c1edff118) ### Supported Field Types | **Type** | **Status** | |-------------------------|---------------| | Lookup Relationship | supported | | Checkbox | supported | | Currency | supported | | Date | not supported | | Date/Time | not supported | | Email | supported | | File | not supported | | Number | supported | | Percent | supported | | Phone | supported | | Picklist | supported | | Picklist (Multi-Select) | supported | | Text | supported | | Text Area | supported | | Text Area (Long) | supported | | Text Area (Rich) | supported | | URL | supported | | Formula | not supported | ### Considerations * When publishing via global action, Channels are not available for selection by default, each channel checkbox need to be added to the global action layout if needed. * Default channels configured in Knowledge:Bridge space settings does not apply for pages published via global action, or pages published via Knowledge action when there are at least one channel checkbox in the knowledge action layout. * Title, URL Name and Body Article fields are always set by Knowledge:Bridge and can not be populated/modified via Global or Knowledge actions. * Field dependencies are not supported (dependent picklists) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Configure K:B General Settings The following steps are required before establishing authentication between Salesforce and Confluence for publishing Knowledge Articles. * Create a Lookup relationship in K:B Published Page object with your Knowledge object * Create a Lookup relationship in your Knowledge object with K:B Published Page object * Specify Knowledge Object, Body field and lookup field in General Settings in Salesforce ## Step 1 - Create a Lookup relationship with your Knowledge Object in K:B Published Page In Salesforce Object Manager find the ***K:B Published Page*** object and add a new *Lookup Relationship* related to your ***Knowledge*** object in *Fields \& Relationships.* ![image2022-10-20_16-13-40.png](https://docs.zagile.com/__attachments/a_551632481c2bf07857dedb60c1ba22352e9f03603bd494a92921b283f64e4547/image2022-10-20_16-13-40.png?cb=380eca82c0f20196386173fc68e1b77f) The following key parameters are required to create a lookup relationship field: * **Field Label:** *knowledgeArticleVersionId* * **Field Name:** *knowledgeArticleVersionId* (it must be exactly *knowledgeArticleVersionId*) * **What to do if the lookup record is deleted?:** Clear the value of this field. ![image2022-10-18_20-50-46.png](https://docs.zagile.com/__attachments/a_799e7667361813973541cf68c650dfcc5b8d5dc392aa1d2035e09d7afedd1a89/image2022-10-18_20-50-46.png?cb=2bf1ed86451f3ab20c90e69fc394c92e) ### Step 2 - Create a Lookup relationship with K:B Published Page in your Knowledge Object In Salesforce Object Manager find your ***Knowledge*** object and add a new *Lookup Relationship* related to ***K:B Published Page*** object in *Fields \& Relationships.* ![CleanShot 2025-01-08 at 16.05.56@2x-20250108-210609.png](https://docs.zagile.com/__attachments/a_9cc1d5b2790a704a137cae6bbe15e11e58341eb2cdf10516de8eeaf498645d12/CleanShot%202025-01-08%20at%2016.05.56@2x-20250108-210609.png?cb=5276e896276ee121c61df2b87cd4b3d9) Set a field label and name and create the field. Make sure the parameters are set as shown in the red section: ![CleanShot 2025-01-08 at 16.06.40@2x-20250108-210650.png](https://docs.zagile.com/__attachments/a_929e47aa6d3a3b39b2360df745db4d028964e32328f5f9aeb3427b0168071dd7/CleanShot%202025-01-08%20at%2016.06.40@2x-20250108-210650.png?cb=1cae909e117dc29912834c1acd065534) ### Step 3 - Specify Knowledge Object, Body field and Lookup field in K:B General Settings in Salesforce In Custom Metadata Types in Salesforce Setup, find the *K:B General Settings* and click on *Manage Records* **,** ![image2022-10-18_12-14-17.png](https://docs.zagile.com/__attachments/a_5ce739fdd54006d3ff014d1fdd5a97ba816e02bd13f123a4e5dadc0b085fc967/image2022-10-18_12-14-17.png?cb=f0b04e93dea70e2e30d43af82c6d246a) Editthe *ZKBGeneralSettings* record with the following fields: * **Article Object:** Select the Salesforce Knowledge object * **Article Body Field:** Select your Article Body Field. (If you don't have already an Article Body Field create a *Text Area (Rich*) field on the Salesforce Knowledge Object with the max length of 131072) * **K:B Published Page Lookup Field:**Select the Lookup field created in the Step 2 "Create a Lookup relationship with K:B Published Page in your Knowledge Object" section above. * **Email Notifications To:**Knowledge:Bridge will use this email address to send error notifications that may occur in the background. ![image2025-1-8_15-59-11.png](https://docs.zagile.com/__attachments/a_04ac6cac2919c86df20f733a5afe0199c8d3823f14b7588fd1f9b13f83623eb4/image2025-1-8_15-59-11.png?cb=a5907957222b92166c0f954c824f1d6c) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge 1.0 ## Release 1.0.3 **Release Date: August 20, 2021** **Bug Fixes** * Fix for connection pool shutdown issue when Confluence restarted ### Release 1.0.2 **Release Date: April 30, 2021** **Bug Fixes** * Fix for add-on getting disabled on Confluence restarts * Fix to prevent Confluence Sytem Labels published as Promoted Terms ### Release 1.0.1 **Release Date: March 21, 2021** > Please note that you will need to uninstall the existing Knowledge:Bridge Add-on prior to installing this update and re-authenticating Confluence to Salesforce **Bug Fixes** * Fix for smartlinks between confluence pages in bulk publish * Fix for a bug that prevents publishing pages with unsupported macros * Fix for a bug that prevents unpublishing an article if the article is already deleted from Salesforce * Fix for UI conflicts with Scroll Versions enabled Spaces **Improvements** * Salesforce auth access tokens are now encrypted in Confluence * Salesforce Connected app is now optional for authentication to Salesforce * Bulk unpublish pages at space level * Support for confluence page IDs as a custom field in Salesforce Knowledge articles ### Release 1.0 **Release Date: December 21, 2020** * Configure individual Confluence Space(s) for publishing to Salesforce * Assign publishing metadata (Channel, Category, Article Type, etc.) to page(s) * Set Publish Strategy (Free-form or Hierarchical) * Bulk publish pages in a Space to Salesforce Knowledge Articles * Grant permissions to Confluence Groups for publishing pages to Salesforce Knowledge * Associate Confluence users and profiles with permissions to publish pages to Salesforce Knowledge * Update published pages in Salesforce Knowledge --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge 1.1 ## Release 1.1 **Release Date: November 3, 2022** * Support for Confluence Cloud --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge 1.2 ## Confluence Server and Confluence Data Center add-on only update (1.2.3) **Release Date: July 10, 2024** **Fixes:** * Resolves a problem with embedded images when page title contains / characters * Bulk publish results was displaying previous results in some scenarios **Improvements:** * Added Confluence Advanced Search Filters SF Published Date and SF Updated Date * Require only minimal required scopes for connection to Salesforce via Connected App ### Confluence Server and Confluence Data Center add-on only update (1.2.2) **Release Date: October 26, 2023** **Fixes:** * Resolves a problem when publishing a page with deleted attachments referenced in the page content * Settings are now stored in Active Objects instead of deprecated Bandana storage ### Confluence Server and Confluence Data Center add-on only update (1.2.1) **Release Date: October 16, 2023** **Improvements:** * Support for Confluence Data Center * Support for page attachments added in preview mode * Upgraded third-party libs ### Release 1.2 **Release Date: April 12, 2023** **Improvements for Confluence Cloud** * Support for updating channels and categories in bulk from space settings * Default Salesforce file visibility to "All Users" to make attachments visible on Customer portals * Improved error handling when embedded image is too large --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge 1.4 ## Release 1.4.6 **Release Date: June 18, 2026** **Improvements:** * Prevent duplicated error messages in bulk publish for errors with promoted search terms, categories and too many smart links. * Security improvements. **Fixes:** * Publish may not resolve all the links to other pages when Confluence is under heavy load and CQL search does not return the default number of results. * Bulk publish fails to publish more than 100 pages when using Global or Knowledge actions for Knowledge custom fields. ### Release 1.4.5 **Release Date: October 7, 2025** **Improvements:** * Support for displaying detailed publish status (Published as Online vs Published as Draft) in Confluence Bulk publish results and Published pages report. * Store Knowledge:Bridge Salesforce package version in Confluence page content properties when publishing to make it possible to identify pages that may require re-publishing on future package upgrades. ### Release 1.4.4 **Release Date: August 26, 2025** **Fixes:** * Error when publishing pages with User mention macros. **Improvements:** * Improvements for Confluence tables style and width in Salesforce. ### Release 1.4.3 **Release Date: July 10, 2025** **Fixes:** * Fix for Attachments (displayed as link) in the Confluence legacy editor not being processed when publishing to Salesforce. * Links to Anchors defined in the Confluence page not working in the published Salesforce Knowledge Article. **Improvements:** * Support for Knowledge Object text fields instead of rich text fields for Article body. * Improvements for the *Contributors Summary* macro. * Support for text colors from the new Confluence editor. ### Release 1.4.2 **Release Date: February 25, 2025** **Fixes:** * Fix for error publishing pages with large publish history entries. ### Release 1.4.1 **Release Date: January 13, 2025** **Improvements:** * Support for Knowledge Article custom fields when publishing pages from Confluence Cloud * Support for inline Attachments in Confluence Cloud * Capture parent Id, position, page creator, owner and last updated by Confluence metadata in Salesforce for Confluence Cloud * Support for lookup reference "published Page" from Knowledge object to KBPublished object that stores Confluence metadata * Count only successfully published pages towards page license limits * Support for expand, code snipped macros and colored table cells for Confluence Cloud when adopting the new Salesforce rich text editor. * Support for excerpt and excerpt-include macros in Confluence Cloud **Fixes:** * Support for [deprecation of Confluence Cloud v1 endpoints](https://community.developer.atlassian.com/t/rfc-19-deprecation-of-confluence-cloud-rest-api-v1-endpoints/71752) * Bulk publish gets stuck on "processing attachments" when integration user does not have edit page permission * Set published Salesforce files permissions by linked record (Knowledge Article) instead of by owner * Fix for "Failed to delete Salesforce file(s)" error when publishing pages * Added "read:page:confluence" and "write:page:confluence" Confluence Cloud API scopes to support the new Atlassian v2 REST API. **This requires to re-authenticate to Confluence to be effective** * Problem loading Knowledge Article CSS in digital experiences sites with multiple domains --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Cloud Supported Macros This page lists the standard Confluence Cloud macros supported by Knowledge:Bridge. ## Formatting | **Name** | **Api Name** | **Status** | |---------------|--------------|--------------| | Info panel | info | supported | | Note panel | panel | supported | | Error panel | warning | supported | | Custom panel | panel | supported | | Success panel | tip | supported | | Warning panel | note | supported | | Code Snipped | code | supported | | Status | status | supported | | Expand | expand | supported \* | \*Requires the new Lightning Article Editor is enabled ### Navigation | **Name** | **Api Name** | **Status** | |-----------------------|----------------|---------------| | Page Tree | pagetree | not supported | | Page Tree Search | pagetreesearch | not supported | | Children Display | children | supported | | Livesearch | livesearch | not supported | | Table of Contents | toc | supported | | Page Index | index | not supported | | Anchor | anchor | supported | | Table of Content Zone | toc-zone | supported | ### Media | **Name** | **Api Name** | **Status** | |-------------------|--------------|---------------| | Office Excel | viewxls | not supported | | Office Word | viewdoc | not supported | | Office Powerpoint | viewppt | not supported | | PDF | viewpdf | not supported | | Gallery | gallery | supported | ### Visuals And Images | **Name** | **Api Name** | **Status** | |-----------------|--------------|---------------| | Roadmap Planner | roadmap | not supported | | Chart | chart | not supported | ### External Content | **Name** | **Api Name** | **Status** | |------------------|--------------|---------------| | Trello Board | trello-board | not supported | | Trello Card | trello-card | not supported | | Widget Connector | widget | supported | | Jira | jira | not supported | | Jira Charts | jirachart | supported | ### Reporting | **Name** | **Api Name** | **Status** | |------------------------|----------------|---------------| | Page Properties Report | detailssummary | supported | | Page Properties | details | supported | | Users List | userlister | not supported | | Popular Labels | popular-labels | not supported | ### Confluence Content | **Name** | **Api Name** | **Status** | |----------------------------|----------------------------|---------------| | Attachments | attachments | supported | | Labels List | listlabels | not supported | | Related Labels | related-labels | not supported | | Content by Label | contentbylabel | not supported | | Recently Updated | recently-updated | not supported | | Recently Updated Dashboard | recently-updated-dashboard | not supported | | Spaces List | spaces | not supported | | Blog Posts | blog-posts | not supported | | Content Report Table | content-report-table | not supported | | Profile Picture | profile-picture | not supported | | User Profile | profile | not supported | | Contributors | contributors | supported | | Contributors Summary | contributors-summary | supported | | Task report | tasks-report-macro | not supported | | Decision report | decisionreport | not supported | | Change History | change-history | not supported | | Create from Template | create-from-template | not supported | | Excerpt | excerpt | supported | | Include Page | include | supported | | Excerpt Include | excerpt-include | supported | --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Components ## Knowledge:Bridge for Confluence Cloud ![image2023-1-6_11-4-20.png](https://docs.zagile.com/__attachments/a_16a8d677d53def2036ebda32509773c9e62ed33df74277a412005df246818725/image2023-1-6_11-4-20.png?cb=1f2c9650b83f260639fa7bdfe744c49d) ### Knowledge:Bridge Salesforce Package Knowledge:Bridge's Salesforce package provides the following: * License and published pages limit validation * Apply Article Style in Lightning and Digital Experiences * K:B App to setup Confluence connections and list all Articles published from Confluence * Custom objects for Confluence page and attachments metadata * Custom metadata types for configuration #### Knowledge:Bridge Confluence App Knowledge:Bridge Add-on for Confluence provides the following: * Enable Confluence spaces for publishing to Salesforce * Configure and maintain Article metadata (Categories, Channels, Record Types, etc.) by page or in bulk * Publish one or many Confluence pages to Salesforce Knowledge (draft mode or online), including images and attachments * Update one or many Confluence pages to Salesforce Knowledge * Update Knowledge Article metadata (Categories, Channels, Record Types, etc.) * Unpublish one or many previously published Confluence pages from Salesforce Knowledge * Assign publish permissions to specific Confluence groups * Maintain publish history and related attributes --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Configurations ## Knowledge:Bridge Configurations Knowledge:Bridge Confluence add-on provides two levels of configuration. **Global configuration** -- performed by Confluence admin for authenticating Confluence to Salesforce 1. Authenticate to Salesforce for publishing Confluence pages to Salesforce Lightning Knowledge Articles 2. Advanced options to update Salesforce External Client App Details 3. Logout from Salesforce to remove authentication credentials ![KBdoc56.jpg](https://docs.zagile.com/__attachments/a_cfb126eff4ea425a70902159cfcc175b0b18db51a58f650a4459a6ca5f3b0688/KBdoc56.jpg?cb=448cc5f552d2f1d88960a972239d6d06) **Space configuration** -- performed by Space Admin for setting up Confluence space for Knowledge:Bridge 1. Enable the Space for publishing pages to Salesforce Knowledge Articles 2. Grant permissions to Confluence Groups for publishing pages to Salesforce 3. Configure Article fields 4. Bulk publishing of pages in a Space 5. Bulk unpublishing of pages in Space 6. Remove all Knowledge:Bridge data in Space ![KBdoc32.jpg](https://docs.zagile.com/__attachments/a_c43b7094a46d30dc508b27381ddcf39746e400b7ec2ac24a8df7eea0b0bc11dc/KBdoc32.jpg?cb=d7a6bfeebe49182ecb0f243638f32188) ![KBdoc33.jpg](https://docs.zagile.com/__attachments/a_51c266f7a16152dd98a482f6680e0fe0321af22b670ef0a5b879e6734dda447b/KBdoc33.jpg?cb=957fdd72cec03fb5e5dfffbedc1b3cf3) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Confluence Cloud Add-on only updates ## Confluence Cloud add-on only update (5.4.0) **Release Date: June 1, 2026** **Fixes** * Error unpublishing Salesforce Article from Confluence when using "API Only" profile integration user and Article is in "Online" status. **Improvements** * Added "Archived" status icon in Content by line Article Info option. ### Confluence Cloud add-on only update (5.3.0) **Release Date: May 7, 2026** **Fixes** * Missing scroll bars in Publish History and Update Metadata. * Update Metadata errors when data categories are inactive in Salesforce. **Improvements** * Support for Salesforce OAuth 2.0 Web Server Flow, deprecated the Device Authentication Flow when logging in to Salesforce from Confluence. * Support for the new Salesforce requirements for Connected Apps and External Client Apps (PKCE and Refresh token rotation). * Bulk publish results are now stored by Confluence space. * New Bulk publish experience with page search, filtering and performance improvements. * Publish / Unpublish options at the page level are now hidden for users in groups not configured for publishing. * Improvements for Remove Data at the space level to handle Atlassian rate API limits. * Security improvements. ### Confluence Cloud add-on only update (5.1.0) **Release Date: October 29, 2025** **Fixes** * Problems publishing pages for Confluence users with large number of groups associated (more than 200). * Confluence group renames may prevent the users in the group from publishing pages. **Improvements** * Added Knowledge:Bridge published pages report at the Space level. * Improve content by line Knowledge:Bridge status after updating page to Salesforce. * Pages with new versions not yet published to Salesforce are now flagged as "Update Pending" status (renamed from "Needs Update"). ### Confluence Cloud add-on only update (5.0.0) **Release Date: September 30, 2025** **Improvements** * Support for Confluence API changes related to page descendants deprecation that impact Bulk Publish. * Added new scopes "`read:hierarchical-content:confluence`" and "`read:content.permission:confluence`" to support Confluence Cloud descendants REST API deprecation. * Support for rendering Folders in Bulk Publish (except for root level folders due to API limitations). * Validate Confluence Integration User permissions on single page publish. * Improved error handling when Salesforce package is not installed. * Filter archived pages in bulk space operations. * Hide disabled Data Categories in Salesforce Article Info popup. * Display Confluence Integration user in Salesforce Authentication page. * New configuration for user groups that are allowed to publish pages as Online. * Knowledge Articles can be updated as Online from Salesforce Article Info popup. * Pages with new versions not yet published to Salesforce are now flagged as "Needs Update" status. * Visual indicator for pages published as Draft vs Online in the content byline section on the page. ### Confluence Cloud add-on only update (4.2.0) **Release Date: July 10, 2025** **Fixes** * Fixes on Bulk Publish wizard navigation. * Open in new Tab not working for links in the Knowledge:Bridge UI in Confluence. **Improvements** * Custom text fields length validation (if max length defined in Salesforce Global or Quick Action) when publishing. * Improved error handling on Bulk Unpublish pages for JOB_NOT_FOUND error. ### Confluence Cloud add-on only update (4.1.0) **Release Date: February 25, 2025** **Improvements** * Upgraded Atlassian Forge framework libraries and runtime. * Add dynamic content icon for pages which latest version is published to Salesforce * Support for restricting the "Delete Article" option by Confluence user groups **Fixes:** * Minor fixes for publishing pages with custom fields via Global Actions and Quick Actions * Support for Confluence API deprecation related to page content conversion * Truncate history entries for long text area custom field changes * Truncate older publish history entries ### Confluence Cloud add-on only update (4.0.0) **Release Date: January 13, 2025** **Improvements** * Support for Knowledge Article custom fields when publishing pages * Error handling when publishing pages that reference content from Confluence blocked spaces * Support for Confluence API changes related to user info retrieval on Publish History * Added new scope "write:page:confluence" to support Confluence Cloud v2 REST API **Fixes:** * Support for Atlassian's new Forge runtime * Improved error handling * Minor fixes on bulk publish ### Confluence Cloud add-on only update (3.0.0) **Release Date: March 21, 2024** **Improvements** * Prepare for [data residency for Forge hosted storage apps](https://developer.atlassian.com/platform/forge/changelog/#CHANGE-1484) ### Confluence Cloud add-on only update (2.6.0) **Release Date: February 28, 2024** **Improvements** * Error handling when publishing restricted pages where the integration user can not edit page * Performance improvements for Select All and Expand All in bulk publish/unpublish **Fixes:** * Select/unselect descendants and children not working in bulk publish/unpublish for non-published pages * Fix for "Request Error: Failed to fetch" error when accessing large bulk publish results page ### Confluence Cloud add-on only update (2.5.0) **Release Date: Oct 3, 2023** **Improvements** * Ability to restrict publishing Articles as Online from Confluence * Option to re-publish a previous bulk publish job * Bulk publish and unpublish tree now allows selection of descendants and children pages using right click on the parent page --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge - Dependent Libs and Licenses This section lists third-party libraries and corresponding licenses bundled with Knowledge:Bridge. ## Knowledge:Bridge Salesforce Package | **Library** | **License Type** | | |-------------------|------------------|-------------------------------------------------------------------------------------| | fflib-apex-common | BSD-3 | | | fflib-apex-mocks | BSD-3 | | | apex-dml-manager | BSD-3 Style | | | apex-lang | Apache 2 | | | Jsoup | MIT | | ### Knowledge:Bridge Confluence Server and Data Center Add-on | **Library** | **License Type** | | |--------------|------------------|-----------------------------------------------------------------------------| | jQuery | MIT | | | jsTree | MIT | | | AngularJS | MIT | | | jStyleParser | GNU LGPLv3 | | | httpMime | Apache 2 | | | antlr | BSD | | ### Knowledge:Bridge Confluence Cloud Add-on | **Library** | **License Type** | |----------------------------------------------|------------------------------------------------| | @atlaskit/\* | Apache-2.0 | | @babel/runtime | MIT | | @compiled/react | Apache-2.0 | | @emotion/cache | MIT | | @emotion/hash | MIT | | @emotion/is-prop-valid | MIT | | @emotion/memoize | MIT | | @emotion/react | MIT | | @emotion/serialize | MIT | | @emotion/sheet | MIT | | @emotion/stylis | MIT | | @emotion/unitless | MIT | | @emotion/use-insertion-effect-with-fallbacks | MIT | | @emotion/utils | MIT | | @floating-ui/dom | MIT | | @floating-ui/utils | MIT | | @forge/\* | Atlassian Developer Terms | | @popperjs/core | MIT | | async-wait-until | MIT | | bind-event-listener | MIT | | copy-to-clipboard | MIT | | css-box-model | MIT | | debounce-promise | MIT | | devextreme | DevExtreme Complete End User License Agreement | | devextreme-react | MIT | | dom-helpers | MIT | | final-form | MIT | | final-form-focus | MIT | | hoist-non-react-statics | BSD-3-Clause | | i18next | MIT | | i18next-browser-languagedetector | MIT | | inferno | MIT | | inferno-create-element | MIT | | lodash | MIT | | memoize-one | MIT | | prop-types | MIT | | raf-schd | MIT | | react | MIT | | react-copy-to-clipboard | MIT | | react-dom | MIT | | react-fast-compare | MIT | | react-i18next | MIT | | react-is | MIT | | react | MIT | | react-popper | MIT | | react-redux | MIT | | react-transition-group | BSD-3-Clause | | react-uid | MIT | | redux | MIT | | scheduler | MIT | | shallowequal | MIT | | styled-components | MIT | | stylis | MIT | | tiny-invariant | MIT | | toggle-selection | MIT | | tslib | 0BSD | | use-memo-one | MIT | | use-isomorphic-layout-effect | MIT | --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Installation and Setup ## Installing Knowledge:Bridge Components * **Knowledge:Bridge Salesforce package** Knowledge:Bridge Salesforce package manages the license details and provides components for applying stylesheets to the final published article. The package is available for download directly from the Salesforce AppExchange. You can also install it using the link below: > Use this URL to install the package into any organization (v1.4.6): > > > > > Note: If you are installing into a sandbox organization you must replace the initial portion of the URL with [http://test.salesforce.com](http://test.salesforce.com/) We recommend installing the package for **Admins Only** and assigning K:B Administrator and K:B User permission sets appropriately. * **Knowledge:Bridge Add-on for Confluence Cloud** -- Allows publishing of Confluence pages to Salesforce Knowledge Articles. The Knowledge:Bridge Confluence add-on is available from the Atlassian Marketplace. > Please use the link below to install the Knowledge:Bridge Add-on for Confluence Cloud > > [Connector for Salesforce Knowledge and Confluence](https://marketplace.atlassian.com/1229266) ### Next steps * [Assign Knowledge:Bridge Permission Sets](https://docs.zagile.com/kb/v1.4/confluence-cloud/assign-knowledge-bridge-permission-sets.md) * [Configure K:B General Settings](https://docs.zagile.com/kb/v1.4/confluence-cloud/configure-k-b-general-settings.md) * [Authenticate Salesforce to Confluence](https://docs.zagile.com/kb/v1.4/confluence-cloud/authenticate-salesforce-to-confluence.md) * [Add Lightning Web Component to Knowledge Record Page](https://docs.zagile.com/kb/v1.4/confluence-cloud/add-lightning-web-component-to-knowledge-record-pa.md) * [Authenticate Confluence to Salesforce](https://docs.zagile.com/kb/v1.4/confluence-cloud/authenticate-confluence-to-salesforce.md) * [Set up Confluence Space for Publishing to Salesforce Knowledge](https://docs.zagile.com/kb/v1.4/confluence-cloud/set-up-confluence-space-for-publishing-to-salesfor.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Overview * [Using Knowledge:Bridge for publishing Confluence pages to Salesforce](https://docs.zagile.com/kb/v1.4/confluence-cloud/using-knowledge-bridge-for-publishing-confluence-p.md) * [Knowledge:Bridge Components](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-components.md) * [Knowledge:Bridge Cloud Supported Macros](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-cloud-supported-macros.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge Release Notes * [Knowledge:Bridge Confluence Cloud Add-on only updates](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-confluence-cloud-add-on-only-upda.md) * [Knowledge:Bridge 1.4](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-4.md) * [Knowledge:Bridge 1.2](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-2.md) * [Knowledge:Bridge 1.1](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-1.md) * [Knowledge:Bridge 1.0](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-1-0.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Knowledge:Bridge User's Guide * [Publishing Pages to Salesforce Knowledge](https://docs.zagile.com/kb/v1.4/confluence-cloud/publishing-pages-to-salesforce-knowledge.md) * [Updating / Deleting Pages published to Salesforce Knowledge](https://docs.zagile.com/kb/v1.4/confluence-cloud/updating-deleting-pages-published-to-salesforce-kn.md) * [Publishes Pages Report](https://docs.zagile.com/kb/v1.4/confluence-cloud/publishes-pages-report.md) * [Knowledge:Bridge Configurations](https://docs.zagile.com/kb/v1.4/confluence-cloud/knowledge-bridge-configurations.md) * [Configure Article Fields](https://docs.zagile.com/kb/v1.4/confluence-cloud/configure-article-fields.md) * [Bulk publishing to Knowledge Articles](https://docs.zagile.com/kb/v1.4/confluence-cloud/bulk-publishing-to-knowledge-articles.md) * [Managing Published Articles in Salesforce](https://docs.zagile.com/kb/v1.4/confluence-cloud/managing-published-articles-in-salesforce.md) * [Bulk Unpublishing to Knowledge Articles](https://docs.zagile.com/kb/v1.4/confluence-cloud/bulk-unpublishing-to-knowledge-articles.md) * [Reset Knowledge:Bridge Configuration and Data in a space](https://docs.zagile.com/kb/v1.4/confluence-cloud/reset-knowledge-bridge-configuration-and-data-in-a.md) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Managing Published Articles in Salesforce ## Access Metadata for Published Confluence Pages > Knowledge:Bridge stores Confluence page metadata in the Salesforce custom object **K:B Published Page** and Confluence Attachment metadata in **K:B Attachment** custom object. > > Salesforce Users with the '*K:B User*' permission set have access to these objects in the Knowledge:Bridge App The *All* list view in the *K:B Published Pages* Tab provides information about pages published from Confluence. You can optionally pin this list view as the default list view. ![image2022-10-25_13-24-24.png](https://docs.zagile.com/__attachments/a_c1794030107f98e6ce877ed812920df3567a0f5e372e955e1822f75ad4244d3d/image2022-10-25_13-24-24.png?cb=a758895e852c18a3f73e4d0a4bc793f4) This list view provides information about last published date, last published status (useful to identify any page that was not published successfully) and a link to *View* the corresponding Knowledge Article in Salesforce. Additional Information about the Confluence page is available for each K:B Published Page record ![image2022-10-25_13-31-40.png](https://docs.zagile.com/__attachments/a_febe0855c41fbc941981da746f5d9cf397a4df6d61832f1d070323f3ae8b487e/image2022-10-25_13-31-40.png?cb=810f1b3158d9c69099c2446a75bd56db) 1. Navigates to the Page in Confluence 2. Link to the specific Knowledge Article version published from Confluence 3. Link to the Knowledge Article (this may take you to a different Article version of same Knowledge Article if the Article was updated directly in Salesforce) 4. Last publish *Status* and *Extended Status* provides information about the last publish operation and any additional error message if the page was not published successfully. ### Make Articles Online in Bulk The Salesforce Knowledge object provides some list views for Draft, Archived and Published Articles. It is possible to create a new list view to list Knowledge:Bridge Draft Articles. Go to your Salesforce Knowledge, ![image2022-10-25_14-9-8.png](https://docs.zagile.com/__attachments/a_389f549b467b4e9a79deaacb82a4ed5565c986066c7b07bcc19db10e4479c98b/image2022-10-25_14-9-8.png?cb=14e1c9dd3f383ea7d8b3c35aca63ebb5) and create a new List View ![image2022-10-25_13-49-23.png](https://docs.zagile.com/__attachments/a_ad96cc40a3e1ffafb1aa08dac15c201d673caef079142f7442948822c7123ed7/image2022-10-25_13-49-23.png?cb=6589838ea9c3a9e8dcb839cbd515ed97) Use the following filters ![image2022-10-25_13-58-10.png](https://docs.zagile.com/__attachments/a_f4b5f671b106306aa1640e63b29d634bc18fad794fc3d971931fa0b7bd476586/image2022-10-25_13-58-10.png?cb=d349b4091e83646b459b040e61a283db) This list view can be helpful for reviewing the published draft Articles and if everything looks good make them Online in bulk (select multiple Articles and use the *Publish* button) ![image2022-10-25_14-3-45.png](https://docs.zagile.com/__attachments/a_f21984553a169082c02e0077c00ff4118c6171320a5f54575133781863527578/image2022-10-25_14-3-45.png?cb=b50b0b0080e0eb9ca6464d7af7b061af) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Permissions Required for Salesforce API-Only Integration User In this page we will describe all the necessary Salesforce permissions for the Salesforce Integration User using the [Minimum Access - API Only Integrations profile](https://help.salesforce.com/s/articleView?id=platform.integration_user.htm&type=5). ## Salesforce API Only Integration User The Salesforce Integration User must have the following properties: * **User license**: Salesforce Integration * **Profile**: Minimum Access - API Only Integrations * **Knowledge user**: enabled ![KBdoc66.jpg](https://docs.zagile.com/__attachments/a_da6ab6bd4712227103ba19890a04cf11a5047611fdbee07c3e7ee5f12f7d6673/KBdoc66.jpg?cb=03adf45105009b2f16775e89fac9ffe9) ### Permission Set License Assignment for API Only Integration User In the user's page go to *Permission Set License Assignments -\> Edit Assignments* , select the *Salesforce API Integration* option and save. ![image-20260604-193512.png](https://docs.zagile.com/__attachments/a_10f3a503837b66bbdf8c94b3937eff2241d653e217f91b6966627bdcbcc74829/image-20260604-193512.png?cb=7e778e0ef4c6b705e4cd572a2ee92302) ### Knowledge Access Permission Set for Integration User Create a new Permission Set for Knowledge access for the Integration User in Salesforce setup. ![CleanShot 2026-06-09 at 17.52.04-20260609-225223.png](https://docs.zagile.com/__attachments/a_f925b3491cff041e5350c9e3181abd2aab3efa8312204eb46156d2dece51e7a7/CleanShot%202026-06-09%20at%2017.52.04-20260609-225223.png?cb=80ea08cd325131c6a675df6b83375c7a) After saving, go to Object Setting in the permission set and find the Knowledge object (Knowledge__kav or similar). ![CleanShot 2026-06-09 at 17.55.09-20260609-225523.png](https://docs.zagile.com/__attachments/a_19dc3278ab238f17513e427ddec92360592d630e4424a6a3b3faae718a769ee5/CleanShot%202026-06-09%20at%2017.55.09-20260609-225523.png?cb=79dac905b87b7740cddc2ad05d8b3a70) Enable the following permissions and save (make sure to select all the Object Permissions, enable Edit Access to all the fields and select record types if available). ![CleanShot 2026-06-09 at 18.20.19-20260609-232031.png](https://docs.zagile.com/__attachments/a_197a9239c7b6b5a4e5cd0293991ecf9e6757f7047d2b9e61ecae95cc603aa354/CleanShot%202026-06-09%20at%2018.20.19-20260609-232031.png?cb=a16c99b5b60af2f64f2bd44c25e10483) In the permission set overview go to "App permissions". ![CleanShot 2026-06-09 at 18.08.35-20260609-230847.png](https://docs.zagile.com/__attachments/a_3b38a68f5fc46151e6cd37509007942e93a6d5dd140807a615ce434815896c76/CleanShot%202026-06-09%20at%2018.08.35-20260609-230847.png?cb=201bbcc6d5e0ff5471c2117938d78fa0) Enable the following permissions in the *Knowledge Management* section and save: * Archive Articles * Manage Articles * Publish Articles * View Archived Articles * View Draft Articles ![image-20260604-173615.png](https://docs.zagile.com/__attachments/a_487d03c116d1ecdeea8ac1b8797549097fca3a9702987a219d934b772523ec66/image-20260604-173615.png?cb=6d9a4abcfc070396fc436967da077d4d) ### Assign Permission Sets to the Integration User In the user's page go to Permission Set Assignments -\> Edit Assignments, add the permission set previously created and the *K:B Integration User* *permission set (both are required)* and save. ![CleanShot 2026-06-09 at 18.25.08-20260609-232520.png](https://docs.zagile.com/__attachments/a_61c55c60ab5c3f2a397cc4725c9486876a2caf749116038276eddfa767c0fb9d/CleanShot%202026-06-09%20at%2018.25.08-20260609-232520.png?cb=db891aeafa9eb0c4733820bd09ac0d83) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Programmatic Access to Salesforce Article Properties in Confluence Cloud Knowledge:Bridge stores Salesforce Article metadata data in Confluence Content Properties which can be accessed through the [Confluence Rest API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/#about) (through the "Get content properties for page" or "Search content" endpoints). Two entity properties are stored for each Confluence Page that has been published to Salesforce: 1. `salesforce_publications_property`: This property stores information about the last publish of the Confluence page. ![image-20250821-161921.png](https://docs.zagile.com/__attachments/a_96ff16ce36adab0dc2972de1d6ce94fc1684dbe8afbf4d56742ad46c8a13e451/image-20250821-161921.png?cb=b23b4bc486e225c14aefff553de87772) **Attributes:** * **lastModifiedDate**: Timestamp of last published date. * **articleNumber**: Unique number automatically assigned to Articles in Salesforce. * **publishedBy**: The latest Confluence User Account Id that published the article to Salesforce. * **lastPublishedVersion**: The latest Confluence version that was published to Salesforce. 2. `salesforce_history_property`: This property stores an entry for each publish, unpublish and update metadata operation that was performed on the Page. ![image-20250822-012450.png](https://docs.zagile.com/__attachments/a_f175b119a8f9d134df59c57ba66276315d601e5b0458d23aeb1ecc19714072e2/image-20250822-012450.png?cb=c13d46a4d8e2069cf77c73baf4f733c5) **Attributes**: * **version**: Confluence page version published to Salesforce. * **user**: Confluence user who published the Page. * **action**: The following values are possible. * `PUBLISH`: Article was published as draft. * `PUBLISH_ONLINE`: Article was published as online. * `UPDATE_METADATA`: Article Metadata (categories, channels, custom fields, etc.) was updated as draft. More information can be extracted from *oldMetadata* and *newMetadata*. * `MAKE_ONLINE`: Draft article was update to online. * `UNPUBLISH`: Article was deleted from Salesforce. Atlassian provides some [tutorials](https://developer.atlassian.com/cloud/confluence/using-the-rest-api/) about how to access the Confluence Rest API. ## **Example** : The following script is a sample python code to get a list of Published Pages that needs update in Salesforce (Page was updated in Confluence but that update was not send to Salesforce yet). **Example.py** Python # This code sample uses the 'requests' library: # http://docs.python-requests.org import optparse import requests from requests.auth import HTTPBasicAuth import json """This script logins to the specified Confluence Cloud and retrieves a list of Published Pages that needs update in Salesforce""" def getRequestConfluence(url, user, api_token, query): auth = HTTPBasicAuth(user, api_token) headers = { "Accept": "application/json" } response = requests.request( "GET", url, headers=headers, params=query, auth=auth ) return json.loads(response.text) def getPublishedPages(user, api_token, cnf_url, space_key): """ Get pages from a space""" url = f"{cnf_url}/wiki/rest/api/search" query = { 'cql': f"Type=page and space={space_key}", 'expand': "content.metadata.properties.salesforce_publications_property,content.version", 'limit': 100 } pages = getRequestConfluence(url, user, api_token, query) nextUrl = pages['_links']['next'] if 'next' in pages['_links'] else '' return pages['results'], nextUrl def getPublishedPagesUsingNextCursor(user, api_token, cnf_url, next_url): """ Get pages from a space using next with cursor""" url = f"{cnf_url}/wiki/{next_url}" pagesCursor = getRequestConfluence(url, user, api_token,{}) nextUrlCursor = pagesCursor['_links']['next'] if 'next' in pagesCursor['_links'] else '' return pagesCursor['results'], nextUrlCursor def parse_args(): """Generates command line arguments for the script.""" parser = optparse.OptionParser() parser.add_option('-u', '--user', dest='user', help='Username to access Confluence') parser.add_option('-a', '--api_token', dest='api_token', help='API TOKEN to access Confluence') parser.add_option('-c', '--cnf', dest='cnf_url', help='Confluence URL') parser.add_option('-s', '--space_key', dest='space_key', help='Space Key') return parser.parse_args() if __name__ == '__main__': (options, args) = parse_args() pages, nextUrl = getPublishedPages(options.user, options.api_token, options.cnf_url, options.space_key) while nextUrl!= '': pagesCursor, nextUrlCursor =getPublishedPagesUsingNextCursor(options.user, options.api_token, options.cnf_url, nextUrl) nextUrl = nextUrlCursor pages = pages + pagesCursor print('Pages Published that needs update in Salesforce') for page in pages: titlePage = page['content']['title'] if not 'salesforce_publications_property' in page['content']['metadata']['properties']: continue articleNumber = page['content']['metadata']['properties']['salesforce_publications_property']['value']['sfdcFields']['articleNumber'] cnfVersion = page['content']['version']['number'] lastPublishedVersion = page['content']['metadata']['properties']['salesforce_publications_property']['value']['lastPublishedVersion'] if cnfVersion != lastPublishedVersion : print('* Title: ' + titlePage + ', ArticleNumber: ' + articleNumber + ', Page Version: ' + str(cnfVersion) + ', Last Published Version: ' + str(lastPublishedVersion)) ### Example Output python example.py --user xxxx --api_token xxxxxx --cnf xxx --space_key xxx Pages Published that needs update in Salesforce * Title: Page 2, ArticleNumber: 000001001, Page Version: 3, Last Published Version: 1 --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Publishes Pages Report Knowledge:Bridge provides the option to list all the Confluence pages in a Space and whether they are published to Salesforce or not. Find the report in the Space apps in Confluence as the "Knowledge:Bridge" app. ![KBdoc63.jpg](https://docs.zagile.com/__attachments/a_12b12b5fd1d5bf50a1600e5631e5cfac771bd48d35df65d527fc7221e1f4bfd8/KBdoc63.jpg?cb=05c0579bd3fed1a8060ffaddae89c967) All the pages in the space are listed with the following details: * **Page**: Title of the page (can be sorted) * **Page Status**: The possible values are: * **Published(Draft)**: The page was published to Salesforce as Draft * **Published(Online)**: The page was published to Salesforce as Online * **Update Pending**: The page was updated in Confluence, but not yet published again to Salesforce * **Unpublished**: The page is not published in Salesforce * **Owner:**The Confluence page owner * **Created**: The date when the page was created in Confluence * **Last modified**: The date when the page was last updated in Confluence * **Last published**: The date when the page was last published to Salesforce * **Article Number**: The Salesforce Knowledge Article Number, this link will open the Article in Salesforce. The pages can be filtered by Title and/or Status: * **Title**: search by keywords and hit Enter or click on the Filter button ![KBdoc64.jpg](https://docs.zagile.com/__attachments/a_b385d36bb1eb1f8bbf42aceaac0ac1eeed14d60eaabe1ef3d1e6829526a7adc1/KBdoc64.jpg?cb=a420e5394491e86bba08346405ee49b9) * **Status**: Select one or more values and hit Enter or click the Filter button ![KBdoc65.jpg](https://docs.zagile.com/__attachments/a_0b8c9de2c0335b0162a0e90c935300d656b28e29243e75c1789366f265c25cf6/KBdoc65.jpg?cb=87cb7d420b994219f186900aa44a04ca) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Publishing Pages to Salesforce Knowledge Once the Confluence space is enabled for publishing to Salesforce Knowledge, each page will display '*Publish Page to Salesforce'* option in the *Apps* menu, as shown below. ![KBdoc38.jpg](https://docs.zagile.com/__attachments/a_45aa0d608fed0e4ec73ad4f42a8a7a4d44399be2be9da14c1a81fec83ab0ebf1/KBdoc38.jpg?cb=5f5b8a8218f9cdf5afcc19be6ae5e957) The steps for publishing a single page to Salesforce involve: * Selecting the Categories to assign to the Article in Salesforce ![image-20260407-043025.png](https://docs.zagile.com/__attachments/a_41f520de16b5a2da0e66ed48ec55ca96bbfd02406032c0bc0a9239dd045d3759/image-20260407-043025.png?cb=e6b7a559ce571f1c148e5bd5dc1c2381) * Selecting Record Type, Channel(s), etc. ![image-20260407-043532.png](https://docs.zagile.com/__attachments/a_dec1859940efc5cfd47aafb882ad047f1ab74953ce9aae07ce87917100f07cc0/image-20260407-043532.png?cb=57537f659eb2c7815766264db8495df0) * and whether to publish the page in 'Draft' or 'Online' mode ![KBdoc22.jpg](https://docs.zagile.com/__attachments/a_ca633d061b410da6ec21f870fe646a2627854e686c3a90ea479a71bb493cebc3/KBdoc22.jpg?cb=152fdd17b77e5dbb19b37cabff5314e7) If the page being published has references (links) to other pages in Confluence not yet published in Salesforce, these references are flagged. In such scenarios, the link to the corresponding page will navigate to a non existing Knowledge Article in Salesforce. Alternatively, you can choose to publish all of those pages to Salesforce before or after continuing. ![KBdoc24.jpg](https://docs.zagile.com/__attachments/a_dce57cbe9314d00b911e74f286833887bca1edf84f196ddf84c2d02be766a75d/KBdoc24.jpg?cb=0817f21eb27eec94e972e2e2d147d8b4) If you choose to publish the page in *Draft* mode, you may review the published Article in Salesforce via the '*View in Salesforce* ' link provided, as well as, make the *Article Online*. It is recommended to review the draft Article in Salesforce prior to making it Online and available to Internal Salesforce Users or public Sites. ![image-20260324-170208.png](https://docs.zagile.com/__attachments/a_2bcbdc7724a7f939ce6e7a080551af911259bfbde282267516cfec6b719d6b3b/image-20260324-170208.png?cb=20c3ab6a397546a6f45ddf6238fc94ea) Confluence page as rendered in Salesforce Lightning Knowledge ![image2022-10-18_16-26-12.png](https://docs.zagile.com/__attachments/a_8d582e50ed5b1f18fc301f3d987d99b3897d99c1836866af11c98d7bc469a2e0/image2022-10-18_16-26-12.png?cb=75bf7641164f8252aca0ed2a0ef9551d) For each page, Knowledge:Bridge can retrieve the Knowledge Article metadata associated with the page. This is easily accessed via the 'SF Article Info' link on the page header, as shown below: ![KBdoc39.jpg](https://docs.zagile.com/__attachments/a_5afc9aedca17bcd24ec9c2c3015fec844cf7f22a6c01edccdf6429977059dcf7/KBdoc39.jpg?cb=7ff38ee38ecf8957213470d399828314) ## Salesforce Article Info The 'SF Article Info' link on the page header shows an icon with the following meanings. |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | ![image-20260514-000843.png](https://docs.zagile.com/__attachments/a_2a3eebec3a460fa944eb1ac0304860fcfc6aa288970b2129074b1096eacba4a5/image-20260514-000843.png?cb=7ab2bf6b29982e4c5c056266367101bf) | The latest Confluence page version was published in Salesforce as DRAFT | | ![image-20260514-010449.png](https://docs.zagile.com/__attachments/a_78c2f8051440713075ae659a0337a9568242e6a7fa3ef12c473f86cd98305045/image-20260514-010449.png?cb=0d4f55d37384f9bab3b876c623ec97a2) | The latest Confluence page version was published in Salesforce as ONLINE | | ![image-20260514-010623.png](https://docs.zagile.com/__attachments/a_b73c0d7433d6035440b4701ebe037e2d891edc7943fbb8ee39833fc1db04a2d4/image-20260514-010623.png?cb=afc57804afa889c70984bb81b2f828c5) | The latest Confluence page version has not been published in Salesforce | | ![image-20260514-011649.png](https://docs.zagile.com/__attachments/a_5eadfe45fd32acdccaee75baa1f3239d48385fcd882f0bc9b8e17305a0f05973/image-20260514-011649.png?cb=de7b645803381304645ffba2070ef076) | Error retrieving article information from Salesforce because it was deleted or authentication is incomplete | --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Reset Knowledge:Bridge Configuration and Data in a space Knowledge:Bridge stores configuration and data in each Confluence space in which it is enabled in Entity Properties. The configuration refers to the items above that determine how content from a space will be published to Salesforce, as well as, the metadata to be used for that page. The data refers to the history, version, etc associated with each page that is published to Salesforce Knowledge Articles. Knowledge:Bridge provides the option to remove either the configuration or both the configuration and data from the space. Configuration may need to be reset if publishing characteristics need to be revised or reset. Data may need to be removed if the space is no longer used for publishing content to Salesforce. > A space previously configured for Knowledge:Bridge can be reset if 1) it is no longer being used to publish pages to Salesforce Knowledge Articles, or 2) if it needs to be reconfigured for Knowledge:Bridge. Knowledge:Bridge provides **two options** to reset and remove data in Space Settings: * **Reset:** removes existing configuration so it is no longer active for publishing to Salesforce. * **Remove Data:** besides removing the existing configuration it also removes all Knowledge:Bridge data including page Content properties from all published Confluence pages in the space. It is important to note that the **Remove Data** option only acts on Knowledge:Bridge configuration and data. It does not affect space content (pages, etc.). ## Reset ![KBdocSpaceSettings.jpg](https://docs.zagile.com/__attachments/a_1645502dac75a003ad4d20a690f24290a67d28fbdcdad4f5c2be6d08a00121c0/KBdocSpaceSettings.jpg?cb=0d5c038ed040eac9e1a1ff6ba01b83a6) ![KBdoc26.jpg](https://docs.zagile.com/__attachments/a_b81e440e538f2b43e34f788a27d91377033211d09cfe309c01b49212bd1bb20c/KBdoc26.jpg?cb=55b9822f2e0ce5662b8f68df5be4ba09) ![KBdoc27.jpg](https://docs.zagile.com/__attachments/a_88ad55e30a6565fd3222a7cc6cfe6a59933021a0044cd7f72fa4488ae1e1d6a3/KBdoc27.jpg?cb=022d1f1b785a9ad61ef3bfea8b028ce0) ### Remove Data ![KBdocSpaceSettings.jpg](https://docs.zagile.com/__attachments/a_3e04e922abe8d98f21757eb24a885485786350666c82b2c9eaa30419ff2b7c77/KBdocSpaceSettings.jpg?cb=0d5c038ed040eac9e1a1ff6ba01b83a6) ![KBdoc28.jpg](https://docs.zagile.com/__attachments/a_7d22e686de05e5570c8d915784c3809167d6b2a05d27dd683ce3acb8ce94bc9d/KBdoc28.jpg?cb=e73da8faeafe8b7e60987c8a940592ac) *Remove K:B Data from this space* will show how many Pages in the space has Knowledge:Bridge metadata ![KBdoc30.jpg](https://docs.zagile.com/__attachments/a_8768c1a2f25e9e038a86b71543506babaf2f575812237c38697bd2c9a8081994/KBdoc30.jpg?cb=d60982608451528862478d748d1e71c6) ![KBdoc29.jpg](https://docs.zagile.com/__attachments/a_ff93a35071f8ed054c4a897590b0bff999c8c2d43f7d746ea7842824102dcc31/KBdoc29.jpg?cb=3165aecc1ef6ab25b546b9c2c71f491f) Once Remove Data is confirmed, the Knowledge:Bridge Space configuration and data will be removed ![KBdoc31.jpg](https://docs.zagile.com/__attachments/a_08b8c2e171f8386c37d5e2a659b25474d6f43cdf81bf8a7fa2a288fc97bdcb9b/KBdoc31.jpg?cb=79fb6ff165eea7d655cdd76c390d4908) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Set up Confluence Space for Publishing to Salesforce Knowledge ## Set up Confluence Space for Publishing to Salesforce Knowledge Once authentication is successfully established with Salesforce for posting pages to Knowledge Articles, you can begin the setup of each Space which will be used for publishing to Salesforce in Confluence Space Settings → Integrations → Knowledge:Bridge. ### Space Activation and Configuration Space preparation for use with Knowledge:Bridge consists of the following key steps: 1. Activation -- Enabling the Confluence Space for publishing to Salesforce. One or more Spaces within Confluence may be enabled. Once enabled, the options for publishing pages to Salesforce Knowledge become configurable. 2. Channels -- Selecting default channels for publishing pages to Salesforce Knowledge. 3. Permissions -- Selecting Confluence Groups that may be permitted to publish pages to Salesforce (as draft or online) and unpublish. ![KBdoc6.jpg](https://docs.zagile.com/__attachments/a_18c18243404a22daa9263af4e705fea6f29708520fc60af94bda682a23fe4bf4/KBdoc6.jpg?cb=0f04c97435004615ea7b881015205b83) For publishing pages from a Knowledge:Bridge enabled Space please refer to [Knowledge:Bridge User's Guide](https://zagile-docs.atlassian.net/wiki/spaces/KBD/pages/655448/Knowledge+Bridge+User+s+Guide) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Updating / Deleting Pages published to Salesforce Knowledge Once a Confluence page has been posted to Salesforce as Knowledge Article, either in draft mode or published mode (visible in selected channels), its reference to the Article from Salesforce (Article ID, URL) are stored in the Confluence page properties. Some of the attributes stored with the page are: * Article ID (from Salesforce) * Published timestamp * Version of published page The page is also marked as published to Salesforce. Knowledge:Bridge provides various options via the *More actions* menu (shown above on the right) for actions that can be taken on the published page. ![KBdoc40.jpg](https://docs.zagile.com/__attachments/a_f618de04ea2f94e8ff14ecba8fb809d18fa772856f280a4a212ec660223d5451/KBdoc40.jpg?cb=bd7a594c87d24d6fe360ae9c3fd6652f) **Delete Salesforce Article --** Allows you to delete a previously published page from Salesforce Knowledge. Publish history is maintained. **Publish History** -- Reflects the publishing activity performed on the page for posting as Salesforce Knowledge Article ![image-20260514-154754.png](https://docs.zagile.com/__attachments/a_c16671860f0de0f99aaf6794c2c6133dc889325483f6de2c41e5155598603f08/image-20260514-154754.png?cb=914683df55efe7bf88b97b19bd4ab573) **Update Page in Salesforce** -- This option allows you to update a previously published page. ![image-20260407-212223.png](https://docs.zagile.com/__attachments/a_b622ff0339efcf089f1993f51d79548b055c5417eac981339638337d6110627e/image-20260407-212223.png?cb=9c121fcd7ecb2d8f79e49796b4b35984) After clicking on *Update*it will scan the page for any links to other Confluence pages that may not have been published. If you continue, these links will point to yet non existing Salesforce Articles (these links will work properly once you publish the referenced pages). This scan gives you the option to resolve the links/references prior updating the Article. ![image-20260407-213658.png](https://docs.zagile.com/__attachments/a_0710ef13b845c63028d80d9fe76175ab0e701b06c031c66bdd9f51b8ccfe8cea/image-20260407-213658.png?cb=699718a30e4d01c4d7156e4fd1761dbd) Finally, when the corresponding Salesforce Article is updated from this page, a pop up provides the confirmation, along with additional details and a link to view the article in Salesforce. ![image-20260407-213750.png](https://docs.zagile.com/__attachments/a_8338a976f4709ae7e5625ed0b22a269338f6b1499093a9ab6f5c72b9e154e431/image-20260407-213750.png?cb=0b3f75591e4b22704e32ba268728f262) **Update Salesforce Metadata** -- Provides the option to update Categories, Channels, Record Type and Knowledge Custom Fields (when Global Action / Knowledge Action is defined at the space configuration) associated with a previously published page. ![KBdoc41.jpg](https://docs.zagile.com/__attachments/a_789b88bd903377d8e71dc03479c111f2dd53843676687658406bdf6d6f6178cb/KBdoc41.jpg?cb=50d67c9f000484d8e2248881e3219164) ![KBdoc42.jpg](https://docs.zagile.com/__attachments/a_f452b26c61bc6bc19b70775f9771e7a21a3291fef8a74ba0cd9693baf39d4d85/KBdoc42.jpg?cb=777d598198394252d854cdbe22503fc4) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Upgrading to Knowledge:Bridge v1.4 | **Knowledge:Bridge Salesforce Package** **v1.4.6** | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Use this URL to install the package into any organization: Note: If you are installing into a sandbox organization you must replace the initial portion of the URL with [http://test.salesforce.com](http://test.salesforce.com/) | ## Upgrading Knowledge:Bridge to Release v1.4 Please follow these steps to upgrade: 1. Upgrade the Salesforce package using the link above or get the package from the [AppExchange](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3A00000FMYRRUA5). 2. Upgrade the Confluence Add-on to v4.0.0 (**for Confluence Cloud only** ), go to the Confluence Administration → Atlassian Marketplace → Manage Apps, click on the "**Update**" button for Knowledge:Bridge App ![CleanShot 2025-01-13 at 18.23.24@2x-20250113-232402.png](https://docs.zagile.com/__attachments/a_f244f3a4a322ddc25cb9a93bd58afd4ca6e7b8843728a9d31bfdcb8430697369/CleanShot%202025-01-13%20at%2018.23.24@2x-20250113-232402.png?cb=aed5a2bf739e2826770c6618a8110ea8) 3. Re-authenticate to Confluence (**for Confluence Cloud only** ) using Named Credentials REQUIRED 1. In Named Credentials on Salesforce Setup, edit the *kbcloud_principal* named credential. 2. Make sure "Start authentication Flow on Save" is enabled and Save ![CleanShot 2024-11-25 at 16.08.24@2x-20241125-210855.png](/__attachments/a_ff7d61bc3fc2358339e730f86f3713d2982258801d01faded37e925cd2d6ca6b/CleanShot%202024-11-25%20at%2016.08.24@2x-20241125-210855.png?cb=e5baf1c1f8507f795acb63cdced2d7ea) 3. After saving it will redirect you to the Atlassian site to authenticate and allow access to your Confluence Cloud instance: ![image-20241125-185112.png](/__attachments/a_eca4b1f1a05fb729a8a0f2914d912da10f7cc96e79520695b67bed2f29aca119/image-20241125-185112.png?cb=b781b8660178ce7f0fbd1f5bb3b50df8) 4. Verify the **Authentication Status:** ![image-20241125-185211.png](/__attachments/a_e210a8a7a948c93942ef604e14e5f975453cd15dceb5f973f83596fdbeb1ba45/image-20241125-185211.png?cb=86ad65a74ea305e0ac69ba935b07873c) 4. Create a Lookup relationship with K:B Published Page in your Knowledge Object: 1. In Salesforce Object Manager find your **Knowledge** object and add a new *Lookup Relationship* related to *K:B Published Page* object in *Fields \& Relationships.* ![CleanShot 2025-01-08 at 13.14.00@2x-20250108-181456.png](/__attachments/a_bd800dfdceb39f080133378c0f5e37c6e0475e2e1a81767313c9b0354f7984af/CleanShot%202025-01-08%20at%2013.14.00@2x-20250108-181456.png?cb=f856df403c90df71772e0dd5fb6f4565) 2. Set a field label and name and create the field. Make sure the parameters are set as shown in the red section ![CleanShot 2025-01-08 at 13.20.03@2x-20250108-182039.png](/__attachments/a_33d96e7111d55543f47acd6252e090cdd192e714d196c499d87bfea669c318d4/CleanShot%202025-01-08%20at%2013.20.03@2x-20250108-182039.png?cb=4a342cfee067d6fa975d2675ece4ed4e) 5. Specify the K:B Published Page Lookup Field in K:B General Settings in Salesforce: 1. In Custom Metadata Types in Salesforce Setup, find and click on the *K:B General Settings* custom metadata type,then find the Page Layouts section and Edit the Page Layout ![CleanShot 2025-01-08 at 13.30.05@2x-20250108-183034.png](/__attachments/a_e1a138874c9a88d23d06cafee4084df76680edd60fd549753ded59d07d04c967/CleanShot%202025-01-08%20at%2013.30.05@2x-20250108-183034.png?cb=bbea60597b8554d6ab5ee1f031129286) 2. Add the **K:B Published Page Lookup Field** to the layout and Save ![CleanShot 2025-01-08 at 13.31.37@2x-20250108-183311.png](/__attachments/a_59ef7420c071f784557f4a65e88f8b023ddb6de4f819cbd083022aec19e319fc/CleanShot%202025-01-08%20at%2013.31.37@2x-20250108-183311.png?cb=b327bdc736d8f7c5f79f8ae025dee19a) 3. Click on *Manage K:B General Settings* and Edit the *ZKBGeneralSettings* record ![CleanShot 2025-01-08 at 13.35.33@2x-20250108-183553.png](/__attachments/a_35e5b85387076e171f80338b8d092aff3bf708476131a792506a5d98dca2b4aa/CleanShot%202025-01-08%20at%2013.35.33@2x-20250108-183553.png?cb=294ab1442dbdba562231a434cddd9030) ![CleanShot 2025-01-08 at 13.36.23@2x-20250108-183639.png](/__attachments/a_c00f8f71d0c2a5cae1c5d98b6d01f9e9e0fcb9fb4b3e66d4d0cf301efc1d2057/CleanShot%202025-01-08%20at%2013.36.23@2x-20250108-183639.png?cb=2259436d3b733a7eed44466513105471) 4. Select the Lookup field created in Step 4 as the "K:B Published Page Lookup Field" and Save ![CleanShot 2025-01-08 at 13.39.25@2x-20250108-183950.png](/__attachments/a_2a7a8d6dfbe0fd49d2b5f67f0cecfa6616b912a65d8a07b1dd7e3180bd6d17bc/CleanShot%202025-01-08%20at%2013.39.25@2x-20250108-183950.png?cb=2f401191f7cdb42a451310a3ff14fdbb) --- version: "v1.4" variant: "Confluence Cloud" language: "en" --- # Using Knowledge:Bridge for publishing Confluence pages to Salesforce **Knowledge:Bridge** enables Confluence Wiki to be the document source for Salesforce Knowledge articles, for creating, curating, and managing the content -- all out-of-the-box, and without expensive and time-consuming custom consulting efforts. This allows your product and tech writing teams to create and manage documentation and other technical content that can be easily shared with Sales, Support, and Marketing teams, as well as on Salesforce Experience Cloud, to help you drive sales and achieve customer satisfaction. ![kbDigitalExp1.png](https://docs.zagile.com/__attachments/a_e879371512d5d7f43d62cff67078b93e4710dfa086a69dfc6c0d435a4aa0eb5e/kbDigitalExp1.png?cb=4f713a0f57f63d5e0f591a1436f385bf) > Product teams can easily post documentation and articles, and Go-to-Market, Customer Success, and Support teams can receive curated content -- each without leaving their respective application. Confluence wiki is commonly used by product teams for documentation and knowledge sharing. A challenge is that go-to-market and customer service teams need easy access to that content within Salesforce Knowledge. Knowledge:Bridge closes that gap so that internally generated content by product teams can be easily shared with Sales and Support teams in Salesforce, as well as, with customer communities via portals. --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # zAgileConnect ## zAgileConnect zAgile Connector for Salesforce \& Jira Integration. Deliver exceptional customer support with improved coordination across teams. [zAgileConnect Overview](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-overview.md) ### Release Notes * #### [zAgileConnect Jira Cloud Add-on only updates](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-jira-cloud-add-on-only-updates.md) June 18, 2025 * #### [zAgileConnect 1.17](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-17.md) June 18, 2025 * #### [zAgileConnect 1.16](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-16.md) June 18, 2025 ### Featured * #### [Salesforce Hyperforce migration and its impact on zAgileConnect](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/salesforce-hyperforce-migration-and-its-impact-on-.md) For zAgileConnect customers who are currently using Salesforce with Jira Server or Jira Data Center. Please note that this does not impact connectivity with Ji... * #### [Migrating zAgileConnect from JIRA On-Premise to JIRA Cloud](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/migrating-zagileconnect-from-jira-on-premise-to-ji.md) Following options describe the steps for migrating zAgileConnect Salesforce-Jira links from on-premise Jira (or another Jira Cloud) to Jira Cloud. The steps wi... * #### [Security Advisory Re: Salesforce External Client App (ECA) for Customers using Jira Cloud](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/security-advisory-re-salesforce-external-client-app-eca-for-customers-using-jira-cloud.md) Who does this impact? zAgileConnect customers who have: one or more Atlassian-hosted Jira (Jira Cloud) instances integrated with Salesforce What action is requ... ### Topics * #### [zAgileConnect Overview](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-overview.md) * [Using zAgileconnect to integrate Jira with Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/using-zagileconnect-to-integrate-jira-with-salesfo.md) * [zAgileConnect Features](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-features.md) * [zAgileConnect Component Architecture](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-component-architecture.md) * #### [zAgileConnect Installation \& Configuration](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-installation-configuration.md) * [zAgileConnect Installation Prerequisites](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-installation-prerequisites.md) * [Installing the Salesforce Package](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/installing-the-salesforce-package.md) * [Installing Jira Add-on](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/installing-jira-add-on.md) * [Enabling Connectivity between Salesforce and Jira](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/enabling-connectivity-between-salesforce-and-jira.md) * [Authenticating Salesforce \& JIRA](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/authenticating-salesforce-jira.md) * [7 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-installation-configuration.md) * #### [zAgileConnect User's Guide](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-users-guide.md) * [Creating Jira Issue from Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/creating-jira-issue-from-salesforce.md) * [Searching Relevant Jira Issues from Case](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/searching-relevant-jira-issues-from-case.md) * [Updating a JIRA Issue from Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/updating-a-jira-issue-from-salesforce.md) * [Sharing Comments between Salesforce and JIRA](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/sharing-comments-between-salesforce-and-jira.md) * [Sharing Attachments between Salesforce and JIRA](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/sharing-attachments-between-salesforce-and-jira.md) * [4 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-users-guide.md) * #### [zAgileConnect Advanced Topics](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-advanced-topics.md) * [Migrating zAgileConnect from JIRA On-Premise to JIRA Cloud](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/migrating-zagileconnect-from-jira-on-premise-to-ji.md) * [Access Permissions for Jira Issue Operations](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/access-permissions-for-jira-issue-operations.md) * [Mapping fields from Salesforce object to Jira Issue](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/mapping-fields-from-salesforce-object-to-jira-issu.md) * [Filters for Auto-creation of JIRA Issue on Case Creation](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/filters-for-auto-creation-of-jira-issue-on-case-cr.md) * [Importing Existing Case-Issue Relationships into zAgileConnect](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/importing-existing-case-issue-relationships-into-z.md) * [9 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-advanced-topics.md) * #### [zAgileConnect API - Usage \& Reference](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-usage-reference.md) * [zAgileConnect API -- Create and Update Jira Issues from Salesforce -- Usage \& Examples](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-create-and-update-jira-issues-fr.md) * [zAgileConnect API -- Link and Unlink Jira Issues from Salesforce -- Usage \& Examples](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-link-and-unlink-jira-issues-from.md) * [zAgileConnect API -- Creating Issue Comments from Salesforce -- Usage \& Examples](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-creating-issue-comments-from-sal.md) * [zAgileConnect API -- Sending Attachments to Jira Issues from Salesforce -- Usage \& Examples](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-sending-attachments-to-jira-issu.md) * [zAgileConnect API -- Transition Jira Issues from Salesforce -- Usage \& Examples](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-transition-jira-issues-from-sale.md) * [6 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-api-usage-reference.md) * #### [zAgileConnect Release Notes](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-release-notes.md) * [zAgileConnect Jira Cloud Add-on only updates](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-jira-cloud-add-on-only-updates.md) * [zAgileConnect 1.17](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-17.md) * [zAgileConnect 1.16](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-16.md) * [zAgileConnect 1.15](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-15.md) * [zAgileConnect 1.14](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-1-14.md) * [6 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-release-notes.md) * #### [Frequently Asked Questions](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/frequently-asked-questions.md) * ['There is no access to some fields for Case' error message on Salesforce properties panel](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/there-is-no-access-to-some-fields-for-case-error-m.md) * ['Unable to display fields. It seems like you don't have permission to edit this issue' in Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/unable-to-display-fields-it-seems-like-you-don-t-h.md) * ['Unable to display fields' message when creating Issue](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/unable-to-display-fields-message-when-creating-iss.md) * ['Secure query included inaccessible field' on Related Jira Issues](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/secure-query-included-inaccessible-field-on-relate.md) * [Using Salesforce Flows to update Case Status based on Jira Issue transitions](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/using-salesforce-flows-to-update-case-status-based.md) * [4 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/frequently-asked-questions.md) * #### [Upgrade and Security Advisories](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/upgrade-and-security-advisories.md) * [Security Advisory Re: Salesforce External Client App (ECA) for Customers using Jira Cloud](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/security-advisory-re-salesforce-external-client-app-eca-for-customers-using-jira-cloud.md) * [\[Security Update\] Salesforce Connected App Requirements May 11, 2026](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/security-update-salesforce-connected-app-requirements-may-11-2026.md) * [Security Advisory Re: Salesforce Connected App Usage Restrictions Change](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/security-advisory-re-salesforce-connected-app-usag.md) * [Upgrade Advisory Re: upcoming Jira Cloud API changes impacting zAgileConnect](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/upgrade-advisory-re-upcoming-jira-cloud-api-change.md) * [Upgrade Advisory for Salesforce Platform API Versions 21.0 through 30.0 Retirement](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/upgrade-advisory-for-salesforce-platform-api-versi.md) * [2 more pages](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/upgrade-and-security-advisories.md) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Access Permissions for Jira Issue Operations The Related JIRA Issues VF page and the corresponding Lightning Web Component available with zAgileConnect package, allow the users to perform a number of functions in JIRA from within the Case page, such as Creating an Issue, Editing an Issue, Deleting an Issue created from the Case, Linking and Unlinking existing JIRA Issues to the Case, etc. ## zAgileConnect Custom Permissions The following functions are configurable for restriction by User or Profile: * Issue Creation * Issue Editing * Issue Deletion * Issue Linking * Issue Unlinking * Use Jira Integration User (see note below) * Login to Jira (see note below) * Transitioning Issues **Integration user and Login to Jira Custom Permissions** 'Use Jira Integration User' and 'Login to Jira' custom permissions work in tandem. If 'Use Jira Integration User' is disabled, the Salesforce users will need to login to Jira using their own accounts to perform actions from the Related Jira Visualforce page and Lightning Web Components. If 'Login to Jira' custom permission is disabled, then 'Use Jira Integration User' must be enabled so that Salesforce users may perform Jira actions via the Integration User account from the Related Jira Visualforce page and Lightning Web Components. Permissions corresponding to each of the above functions are first set in 'zAgileConnect Permissions' configuration section of the package, as shown below. Here, you can select whether each of these functions is available to 'All' licensed users or a subset, based on either users or profiles. Setting specific function(s) that must be restricted from 'All' users is the first step before associating the custom permission(s) with specific Users and/or Profiles. ![image2021-9-14_18-31-40.png](https://docs.zagile.com/__attachments/a_27efd8ce48e52321646d198ceaca24bb4f6715d9d85e9e6bbb3c42e7c3a1360b/image2021-9-14_18-31-40.png?cb=115686c006f66fa9614ce825fbccd376) ### Associating zAgileConnect Custom Permissions by Profile By default, zAgileConnect Custom Permissions are enabled for all profiles (if the package is installed for All Users). To restrict them for a Profile, navigate to 'Enabled Custom Permissions' link on the Profile configuration page and update the selection of enabled Custom Permissions, based on the ones to be retricted. ![image2021-9-14_18-30-42.png](https://docs.zagile.com/__attachments/a_5867d41237e7579302c995ad2a7e4ebe64cfa6ec8be0a920ae3eac0ff8f7fe9f/image2021-9-14_18-30-42.png?cb=23ca33792fde0921c5db654b3abef7cc) ![image2021-9-14_18-29-32.png](https://docs.zagile.com/__attachments/a_d994e69b892be706ebca57755ee7e0b6fe6d801627e0180dbe2916bc134b1168/image2021-9-14_18-29-32.png?cb=3574f674ebcdc25c84357c605c221ae4) ### Associating zAgileConnect Custom Permissions by Users To associate zAgileConnect Custom Permissions, you must first build Permission Sets for the above functions that will be restricted. The permission set(s) may then be associated with each User, as appropriate. ![image2016-12-12-143129.png](https://docs.zagile.com/__attachments/a_ff1faaa61cf7ee4bba03e61c496df2b5a58569ded942ecc1eefa242c22468aa7/image2016-12-12-143129.png?cb=364b48efc50ba2489ec7204c34507675) In the example above, a Custom Permission Set ZC_No_Delete only enabled Create and Link permissions related to JIRA Issues. Once Permission Set(s) are defined, they can be associated with a specific User's profile, as shown below ![image2016-12-12-143353.png](https://docs.zagile.com/__attachments/a_462cb1099d6ffb32b3da42a675842ea1fa2c7a248c23483756bb1f1b29d74b2f/image2016-12-12-143353.png?cb=8085b16375666ebab03228abcb02f91d) Based on the example above, the Related JIRA VF page will disable (hide) buttons for Editing, Unlinking and Deleting an Issue, since only Create and Link options are enabled). ![image2016-12-12-143919.png](https://docs.zagile.com/__attachments/a_0202102598f8bbe5af1f2ed2a848414032ae9b497c24c337bd7d2f859a1a8a02/image2016-12-12-143919.png?cb=7fb2a08e984d6aea993f281b14caa7c2) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Access permissions for Jira Issue operations from Salesforce Access permissions to Jira Issue functions such as Create, Edit, Delete, Link, etc, can be configured in Salesforce by Profile and by User. This section provides steps for this configuration. ## zAgileConnect Custom Permissions The following functions are configurable for restriction by User or Profile: * Issue Creation * Issue Editing * Issue Deletion * Issue Linking * Issue Unlinking * Use Jira integration user * Login to Jira * Transitioning Issues Permissions corresponding to each of the above functions are first set in 'zAgileConnect Permissions' configuration section of the package, as shown below. Here, you can select whether each of these functions is available to 'All' licensed users or a subset, based on either users or profiles. Setting specific function(s) that must be restricted from 'All' users is the first step before associating the custom permission(s) with specific Users and/or Profiles. For more details on setting custom permissions for Jira Issue operations from Salesforce, please refer to [(V1.17) Access Permissions for Jira Issue Operations](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/access-permissions-for-jira-issue-operations.md) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Add Trigger to Opportunity for capturing updates to send to Jira You will need to create the trigger and its unit test in a sandbox environment and then deploy into production by promoting a Change Set. For more information on this, please refer to [https://help.salesforce.com/articleView?id=000171224\&type=1](https://help.salesforce.com/articleView?id=000171224&type=1) The object that is integrated with Jira (ex: Opportunity) will need a trigger to send to Jira its events (updates, deletes). This step is not needed for Account and Contact objects, since the triggers for these objects are already provided with zAgileConnect. References to Opportunity in the code below (used in the example flow) will be replaced by the object to be integrated with Jira. trigger OpportunityTrigger on Opportunity (before delete, after delete, after update, after undelete) { zsfjira.ZTriggerFactory.createAndExecuteHandler(Opportunity.sObjectType); } You will need a unit test for the trigger in order to deploy it to production: @isTest private class OpportunityTriggerTest { static testMethod void testTrigger() { //Create Record Opportunity opp = new Opportunity(); //Fill fields opp.Name='Test Name'; opp.StageName = 'Qualification'; opp.CloseDate = Date.today()+30; insert opp; Id oppId = opp.Id; try{ //Update record opp.Name += '(Edited)'; update opp; System.assert(opp!=null); //Delete record delete opp; System.assertEquals(0,[SELECT count() FROM Opportunity WHERE Id =:oppId]); }catch(zsfjira.ZTriggerFactory.ZTriggerException exe){ System.assert(false, 'Trigger could be defined incorrectly'); } } } --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # (Optional) Add Visualforce Page to Case layout for Related Jira Issues in Salesforce Classic These steps only apply for customers using Salesforce Classic instead of Lightning. 1. edit the layout of the Case page, 2. create a section for the JIRA Related Issues, and 3. drag the Visualforce page 'zAgileConnect JIRA' into this section. ![image2020-8-26_15-34-14.png](https://docs.zagile.com/__attachments/a_948ffef919fdd104ea9f3c3fa7d997bb09f19b1bc9ef6fbd4e9778895ee34d31/image2020-8-26_15-34-14.png?cb=72d1e7b7f6f36092239b6ab04913b28d) ![image2020-8-26_15-35-3.png](https://docs.zagile.com/__attachments/a_9fd1a6dcb96743c98cfe11d6cdf6847a9297c0ff7ab6482e98294c8cab7931ec/image2020-8-26_15-35-3.png?cb=ac8b899b151b976fff14d2b463d0ec3a) Set the property of this page for sufficient width and scrolling, as desired. ![image2020-8-26_15-35-42.png](https://docs.zagile.com/__attachments/a_de690c4c00ee561727a9c37a8110be352d9a6fbff44379409446ddd2b85b4a5e/image2020-8-26_15-35-42.png?cb=03eb86a6eba46632a094db4d8b4eb776) On the Case page, configure Jira Issue fields to display on the page ![Screen Shot 2021-01-30 at 8.42.46 PM.png](https://docs.zagile.com/__attachments/a_30e4090e2903aff1182391eb21cadab25ffa7d928b24c83cc6406699f925f5f6/Screen%20Shot%202021-01-30%20at%208.42.46%20PM.png?cb=249cc8b9680722cba2420099c6b93f39) ![Screen Shot 2021-01-30 at 8.52.50 PM.png](https://docs.zagile.com/__attachments/a_57bc2e19f65bb6b0ddb602806bae604b271996bfcec7fdd776eb6d559cc61fd3/Screen%20Shot%202021-01-30%20at%208.52.50%20PM.png?cb=6e4e9ed1177e79050aaad72a80caa82a) ![image2021-1-30_20-59-39.png](https://docs.zagile.com/__attachments/a_d9c11abc9a4a7f139229e832947c1252366ea22d0dc11a44ecd25100779d8b91/image2021-1-30_20-59-39.png?cb=989d2c576e3d214fba3e5c3262453f3c) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Adding Salesforce to JIRA Application Links In Jira Settings → Jira Apps → Application Links, create a new link for Salesforce, using the URL of your Salesforce instance (example: ![CleanShot 2026-01-08 at 19.22.32@2x-20260109-002259.png](https://docs.zagile.com/__attachments/a_fcd99e99f60447cf03939c614c4458efe6d6b74149feaaa1ae4a655b1a2587ac/CleanShot%202026-01-08%20at%2019.22.32@2x-20260109-002259.png?cb=9f9b1955360ee3fd940d1b70854dab18) ![image2021-1-29_21-13-17.png](https://docs.zagile.com/__attachments/a_59cd71b954f2030362f6f759a3c47492fdbdcc04475b7d9fc5e2e935eac04c57/image2021-1-29_21-13-17.png?cb=f7af13ade6315b29c1874284770ecd59) Continue with manual configuration when the following pop up is displayed, enter Application Name and Continue ![image2021-1-29_21-13-46.png](https://docs.zagile.com/__attachments/a_7af824decfd17380cd10c63a5e76c7360f7df3ccf8a4782d0253f37f8678e1f4/image2021-1-29_21-13-46.png?cb=977ff29b23962f5cd0716ff6b35c8e03) Once the link is created, Edit the link to update Incoming Authentication and upload the certificate created in Salesforce ![Screen-Shot-2015-08-10-at-8.24.40-PM.png](https://docs.zagile.com/__attachments/a_1c18e0e01883ce1473ff7361cc981db9dff153aa5eb150c0600c047d951f418f/Screen-Shot-2015-08-10-at-8.24.40-PM.png?cb=95a5f6a5f31894c716bb197f3baa7154) Consumer Key (as shown below) must be the ID of the Salesforce Org which will log into Jira ![image2021-1-29_21-21-51.png](https://docs.zagile.com/__attachments/a_709ce651ce3c10095cd003f855705e27db519fc933300a15aa74f5134b6daff1/image2021-1-29_21-21-51.png?cb=3c5c593b2e55cf2ec46efa0b03ee49a4) Paste the certificate downloaded from Salesforce in the Public Key text box (as shown below). Please make sure to open the certificate in a text editor (with no formatting) and copy/paste the **entire** content of the cert including the BEGIN--\>END brackets. ![image2021-1-29_21-26-3.png](https://docs.zagile.com/__attachments/a_5c62c1ffef11600a6b67ded7f3f90650708b2d34728704feab922660a0673206/image2021-1-29_21-26-3.png?cb=a5f588c49cc1af599013ac9a2c9e750d) Save the configuration and close the window ![image2021-1-29_21-26-48.png](https://docs.zagile.com/__attachments/a_ebcf4e363a2258cb797f04265a6654660c77f41e3901140f1b56e18b309c8d33/image2021-1-29_21-26-48.png?cb=d1ee17df0dc245ff43a381aac2fe317e) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Assign zAgileConnect Permission Sets Available with zAgileConnect package v1.13 zAgileConnect provides a number of permission sets out-of-the-box that must be assigned to specific users based upon the type of access and usage they will require for the integration. These assignments must be done following the package installation to ensure that users have the necessary permissions. These permission sets are described below: **zAgileConnect Subscription User** - This permission set ensures access to custom objects bundled with the zAgileConnect package. It is required for all users who will be licensed for zAgileConnect. **zAgileConnect Admin User** - (Not required for Salesforce Administrators) This permission set provides admin access to zAgileConnect package configurations in addition to access to custom objects bundled with the package. It is recommended for users who will need to administer zAgileConnect package configurations. In addition to this permission set, zAgileConnect Admin users will also need the following permissions: * Download AppExchange Packages * Customize Applications * View Setup and Configuration **zAgileConnet Integration User**- This permission set ensures access to zAgileConnect package components that are involved in bidirectional exchange between Salesforce and Jira. This permission set must be assigned to the Salesforce account designated as the Integration User (Salesforce account used to log into Salesforce from Jira). **zAgileConnect Platform User** - This permission set allows **users not licensed** for zAgileConnect to perform certain operations involving Jira, such as posting comments and attachments to Jira, posting field updates in Salesforce objects to Jira (Salesforce Properties), etc. *This permission set is not needed if the zAgileConnect package has been installed for 'All Users'.* For details on managing permission set assignments in Salesforce, please refer to the following: [https://help.salesforce.com/articleView?id=perm_sets_manage_assignments.htm\&type=5](https://help.salesforce.com/articleView?id=perm_sets_manage_assignments.htm&type=5) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Authenticating Salesforce & JIRA The following steps involve authenticating each application to the other, i.e. Salesforce to Jira (using OAuth 1.0) and Jira to Salesforce (OAuth 2.0), using an integration user account in each application selected for this purpose. All transactions, messages, and actions are submitted to the other application using this account. Following authentication via these steps, an OAuth token is retrieved and used in subsequent exchange. Permissions and restrictions associated with each account may be used to control the scope of the actions that can be performed on behalf of all of the users. Please also see: [zAgileConnect JIRA Integration User required permissions](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-jira-integration-user-required-permi.md) * [Sign in to Jira from Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/sign-in-to-jira-from-salesforce.md) * [Sign in to Salesforce from Jira](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/sign-in-to-salesforce-from-jira.md) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Capturing the count of Jira Issues associated with a Case A Roll-Up summary field may be used to store the number of JIRA issues associated with a Case. This count is derived from the junction object **ZIssue_Case** since this has a master-detail relation with Case. Note that the same field can be defined for other Salesforce Objects. * Define new field as Roll-Up Summary as shown below * Assign the field to Salesforce Profiles, Layouts and Save ![image2021-12-14_16-44-38.png](https://docs.zagile.com/__attachments/a_d63c77d8fdc93a108766bb008a0b3bafecb12a2b4b1c253668e0eae5d2dce092/image2021-12-14_16-44-38.png?cb=d8923a745cafea1d385d0b6b5636e3d7) ![image2021-12-14_16-45-19.png](https://docs.zagile.com/__attachments/a_07434d27a9c00efb0cb368c58da1cf70df24b9417e9b7bcd261badac251f00ae/image2021-12-14_16-45-19.png?cb=a23ba2d5a917843168e75859b5392dd3) ![image2021-12-14_16-36-30.png](https://docs.zagile.com/__attachments/a_9101ddd34db4eb4aac9b421d46a4103375752ba7bc14a44f9132f30a09f6a1d3/image2021-12-14_16-36-30.png?cb=0d2a5812aa4bcdd952b6045c0a3f192f) The Jira_Issues roll-up summary field can be included on Case List Views, Reports, etc. ![image2021-12-14_16-43-25.png](https://docs.zagile.com/__attachments/a_cb3f051e6a4f0c4578508700eb9f70a41d1e4508eb9096a45a872d43e35642a0/image2021-12-14_16-43-25.png?cb=bcda4c602f946ddde2e753b5b7cdc3d3) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Configuring Salesforce Link/Unlink actions from Jira **Enabling Link/Unlink Actions from Salesforce** In General Settings option of zAgileConnect Salesforce package, enable Link and Unlink Actions to allow Jira users to link or unlink Jira Issues with Salesforce objects. This option applies to all Salesforce objects that have been configured for integration with Jira Issues. Specific objects for Linking and Unlinking are selected subsequently in Jira. ![Screen Shot 2021-02-26 at 3.00.52 PM.png](https://docs.zagile.com/__attachments/a_94f9b499e82f66a2f3fe286e6defc9589b8e0fd0ef76e839eca56e519079f06b/Screen%20Shot%202021-02-26%20at%203.00.52%20PM.png?cb=0a07a9b545990b01d4431bafdb7b15ac) **Configuring Jira Groups and Projects for Link/Unlink Actions** Salesforce Action (Link and Unlink) are enabled for specific Jira Groups and Projects through assignments in this configuration. ![Screen Shot 2021-02-26 at 3.13.38 PM.png](https://docs.zagile.com/__attachments/a_9bfd338ff7c8e1c6901ec876caa481b3044b0b73f78d0d1aaec32efc9e42e41e/Screen%20Shot%202021-02-26%20at%203.13.38%20PM.png?cb=9439989e65575b8274cc8d5106defa4f) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Configuring zAgileConnect ## Prerequisites > 1. The zAgileConnect add-on must be installed in Jira. > > 2. Authentication must be completed between Salesforce and JIRA before proceeding with these steps. > > *The configuration of the JIRA add-on needs to be done in parallel with the package configuration.* > > *Admin privileges are required in both applications for the configuration steps.* *Prerequisite Steps to be completed prior to the configuration* ![Screen Shot 2021-01-24 at 10.39.02 PM.png](https://docs.zagile.com/__attachments/a_2b679690b971e33f192811802b76fe223f4a97a2d641ee8bef75e7423cef2450/Screen%20Shot%202021-01-24%20at%2010.39.02%20PM.png?cb=b55c2716556207500acff84a93317701) *Configuration Steps (3 thru 7)* *The green checkmark against each step validates completion of required steps.* ![Screen Shot 2021-01-24 at 10.39.16 PM.png](https://docs.zagile.com/__attachments/a_86fa8b32384b979af59e2ab715244b22d4982c5ea25104955a156ff8c24ba579/Screen%20Shot%202021-01-24%20at%2010.39.16%20PM.png?cb=9eaf4e6e038283530276e6a727708fcb) ## Related Links * [zAgileConnect Installation \& Configuration](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/zagileconnect-installation-configuration.md) * [Select Case Properties and Attachment Sources to Send to Jira](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/select-case-properties-and-attachment-sources-to-s.md) * [Select defaults for JIRA Project, Issue Type and Priority](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/select-defaults-for-jira-project-issue-type-and-pr.md) * [Access permissions for Jira Issue operations from Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/access-permissions-for-jira-issue-operations-from-.md) * [(Optional) Add Visualforce Page to Case layout for Related Jira Issues in Salesforce Classic](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/add-visualforce-page-to-case-layout-for-related-ji.md) * [Select JIRA Issue Properties to bring to Salesforce](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/select-jira-issue-properties-to-bring-to-salesforc.md) * [Add Jira Lightning Web Components (LWC)](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/jira-lightning-web-components-lwc.md) * [Select Salesforce fields to send to Jira Issues](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/select-salesforce-fields-to-send-to-jira-issues.md) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Configuring zAgileConnect for Jira Service Management Projects **To enable this functionality, please contact our zAgile for information on usage and licensing costs.** zAgileConnect offers enhanced integration with Jira Service Management (JSM), enabling a seamless collaboration experience. With this new functionality, you can connect your Salesforce organization to a Jira instance running JSM. This integration provides the flexibility to create JSM Requests directly from Salesforce, while ensuring that they align with your Service Desks and Request Types configurations. ## Configuration In the zAgileConnect Salesforce package configuration, navigate to the section "Select Jira Projects and Issue Types" and open the "Jira Service Management" tab. ![CleanShot 2026-04-06 at 15.07.39@2x-20260406-200747.png](https://docs.zagile.com/__attachments/a_727031d3ead56791f7144ec3b753c344af95ffd27639caeca23df7151f54360f/CleanShot%202026-04-06%20at%2015.07.39@2x-20260406-200747.png?cb=a344121a293d9f8d7fb17c87fcabf66a) In this section, you will find a list of all available Service Desks (JSM Projects) along with their related Request Types. You can select multiple Service Desks and Request Types. Additionally, you can define the order in which they will be displayed when creating a JSM Request. It is important to note that the first Service Desk and Request Type selected will be the default Request Type when creating a JSM request from Salesforce. ### Usage #### Create JSM Requests In the zAgileConnect Related Issues LWC, click on "New". ![image-2023-6-27_16-4-40.png](https://docs.zagile.com/__attachments/a_312bd3d2340d19a80d67ed21ec22e3633f9d8515ecb3f28b400b67404eecf809/image-2023-6-27_16-4-40.png?cb=5a295155bbbea1014e31b850ccb3da1e) On the next screen, you will be prompted to choose between creating a Jira Issue or a JSM Request. Select the "Jira Service Management" option to create a JSM Request. Note this options will only be available if Jira Projects and JSM Service Desks are configured in "Select Jira Projects and Issue Types". ![image-2023-6-27_16-8-3.png](https://docs.zagile.com/__attachments/a_eea8a570369dc3299dda911694e31d5e251bc9cecf1e7e6f8b1984df79d78b49/image-2023-6-27_16-8-3.png?cb=d7ce1ea48788598b326e0243679c253b) After clicking on "Next," the Request creation screen will be displayed. The available Service Desks will be the ones you configured in the previous steps. The form shown on the screen will adhere to the JSM Request form configured in Jira for the selected Service Desk and Request Type. ![image-2023-6-27_16-13-6.png](https://docs.zagile.com/__attachments/a_6b3d9ec7c3f28dd272c1e6bbe28f8eb074c7648c7ddd008a269df37bff3ffff2/image-2023-6-27_16-13-6.png?cb=f9f612eb96a8a8008b846c4d69df5564) #### JSM Fields The current implementation supports the following specific JSM fields: Request Type and Organizations. Other JSM fields such as Reviewers, Approvers, and others that are implemented using **Jira custom fields** are also supported. The supported JSM fields can be configured (optionally) in "Select Issue Fields to Pull from Jira" option in package configuration as any other Jira custom field. ![image-2023-6-27_16-22-54.png](https://docs.zagile.com/__attachments/a_2044dc44ff388ee35b5eb669010c4e0e66eb2b2ca73d0a19ac250eeaae1e4b01/image-2023-6-27_16-22-54.png?cb=009345705ef33f34d4035c37781b78c4) #### Edit JSM Requests Editing JSM Requests in Salesforce is similar to editing Jira Software Issues. A pop-up will appear for editing the ticket, and this form adheres to the Project and Issue Type screen schema defined in the Jira Software configuration. ![image-2023-6-27_16-26-16.png](https://docs.zagile.com/__attachments/a_644941be2f9784b6aa2ae1e81c1ab58962facad6418f2a8b6a48bc843f45438d/image-2023-6-27_16-26-16.png?cb=fe5d71f8ca12a7d502cdc78d7ee00530) DO NOT Edit the Issue Type of a JSM ticket from Salesforce as it can have unexpected outcome, since the Issue Type must align with its related Request Type in JSM. ### Limitations 1. Auto-Create Jira Issue is not supported for Jira Service Management Requests Types. 2. zAgileConnect Apex and Flows APIs do not support creation of JSM Requests. 3. JSM tasks such as Reviews, or any other JSM actions, besides creation of Requests and Approval actions, are not supported. Approvals are only supported in Jira Cloud. 4. JSM Request creation is only available in Lightning Experience. --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Create a look-up relationship for Opportunity in ZIssueSF The first step is to create a look-up relationship for Opportunity in ZIssueSF custom object packaged with zAgileConnect. ZIssueSF is a package object which is used to manage the relationships between Jira Issues and Salesforce objects. The look-up relationship define in ZIssueSF allows zAgileConnect to track all Salesforce objects configured for integration with JIRA. Please note the following re: configuring this Lookup relationship: * The field will needs to be visible to profiles that will use this integration with Jira * This Field does not need to be added to ZIssue_SF layout (Unselect the option) * ZIssue_SF Related List does not need to be added to the Opportunity layout (Unselect the option) ![img1534271400_2.png](https://docs.zagile.com/__attachments/a_46191028eb8a3ed8b8e439e98b2825cad91db056754d75319a36f1811c7cfc11/img1534271400_2.png?cb=5d3e78c6e55730b8234bd5dbdff4de62) ![img1534271400_3.png](https://docs.zagile.com/__attachments/a_ade4ad8fe6032244fa56d3425538701c6978df74197e1d548d505522330dd976/img1534271400_3.png?cb=9d8448a9907e2886bac86d3cb6071c93) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Create a new junction object to link Opportunity and ZIssue This step involves creating a junction object that will provide the linkages between Opportunity and ZIssue. This object establishes Master-Detail relationship between Opportunity (or another Salesforce object to be integrated with JIRA) and one or more Jira Issue(s). A junction object is needed for each object that is to be integrated with Jira issue. Once created, this junction object will also represent inverse Master-Detail relationships with Opportunity and ZIssue (Jira Issue), These will be defined in subsequent steps. ![img1534271400_4.png](https://docs.zagile.com/__attachments/a_5bd78a20287c7af78fb92f6645caf37d0057a18b4f12a90846242d5543ab696a/img1534271400_4.png?cb=a2bf28532edb631c7716091218d5e242) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Add the Lightning Web Components to the non-Case Object Go to the Lightning App Builder for the non-Case Object and add the zAgileConnect Lightning Web Components. The recommended approach is to add a new Tab for the components. The components you can add are the following: * Related Jira Issues * Search Jira Issues * Related Jira Activity ![CleanShot 2026-06-23 at 13.58.57-20260623-185953.png](https://docs.zagile.com/__attachments/a_e7664dbb2e3868125e16f73d37fcb1c668d1eb3a360b00e1bb403be0feada528/CleanShot%202026-06-23%20at%2013.58.57-20260623-185953.png?cb=7978cc5918efb9d6eb7ac3405b844f53) More details about the Lightning Web Components can be found in [Add Jira Lightning Web Components (LWC)](https://docs.zagile.com/zagileconnect/v1.17/jira-cloud/jira-lightning-web-components-lwc.md). If you are still using Salesforce Classic and Visualforce pages you may want to create a new Visualforce Page (Optional). These steps are only needed if you are still using Salesforce Classic instead of Lightning. Go to Build/Develop/Visualforce pages and create a VF page with the following body (Change the standardController (**"Account"** in the example above) with the API name of the object you want to integrate. Follow the steps below for adding your VF page to the object layout): ## Add Visualforce Page to the Object Layout Create a section for the Jira Related Issues and drag the Visualforce page created above (for non-Case objects) into this section. For Case Object, zAgileConnect provides Visualforce page 'zAgileConnect Jira' with the package that can be added to a Case page layout. ![layout0.png](https://docs.zagile.com/__attachments/a_9c6dcdef8e384ef36c5a3ff235aea61aa679fc25e43d2815e0aa7fc3177ebc32/layout0.png?cb=09db54449a192942d01018baefc961fa) Set the property of this page for sufficient width and scrolling, as desired. ![layout2.png](https://docs.zagile.com/__attachments/a_fc9819cb7d5c5632d6f99f35e00f1df95fb347cf13015ec579afb142ff80714f/layout2.png?cb=534bdfc5ec678e14bf40f2d0c7d87de8) Using the Tools icon on the top right of the Visualforce page, define here the columns you want to display and their order. ![layout3.png](https://docs.zagile.com/__attachments/a_fb22a7e9d2ea4d62f9ce73cec1e7c1fab70c16a9f7952994a77229df9246bcaf/layout3.png?cb=77266695f81a7ef1b0d4efcfd926f979) ![layout4 (1).png](https://docs.zagile.com/__attachments/a_0aaee0fb86d0558dc89d85970e581b1a5d1ed5423114a36fc7b281821a97223c/layout4%20(1).png?cb=8c5bc3a9006d8132ff845b641c4047ce) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Create Master-Detail relationship between Opportunity (Master) and the Junction object Once a new junction object is created, Master-Detail relationships need to be defined between this junction object and Opportunity and ZIssue (Jira). First, we define a Master-Detail relationship with Opportunity. * Field-level security with this field must be defined for Profiles that will need to access these relationships * Field should be included in selected Page Layouts Custom Related Lists for ZIssue (Jira Issue) need to be included in the selected Page Layouts. ![img1534271400_5.png](https://docs.zagile.com/__attachments/a_e383e3528b92d13a6dce4176b4d69a14fe1ccf377159dc62ae1a7394c2e431f1/img1534271400_5.png?cb=e31fa039593b97c234a6aa5f226a7943) ![img1534271400_6.png](https://docs.zagile.com/__attachments/a_1e43b3f4a1874328363a2db1a167f506cec1a22bad2c81dd6a81c209c35c4578/img1534271400_6.png?cb=fd239cece1bb3f8bfe1dbdc8ac418689) --- version: "v1.17" variant: "Jira Cloud" language: "en" --- # Create Master-Detail relationship between ZIssue (Master) and the Junction object Next, we define a Master-Detail relationship with ZIssue. * Field-level security with this field must be defined for Profiles that will need to access these relationships * Field should be included in selected Page Layouts * Custom Related Lists for ZIssue (Jira Issue) need to be included in the selected Page Layout. * **Field Name and Field Label must be set to 'ZIssueId'** ![img1534271400_7.png](https://docs.zagile.com/__attachments/a_eb11a0b4dba629ea24164b5b64218f77f6cccfdbb126f1fd9532b57df9ab6356/img1534271400_7.png?cb=24dd4545c93e3b7861931262161b54e5) ![img1534271400_8.png](https://docs.zagile.com/__attachments/a_6ffe1c0c9c72d27e1d4894d8b5088ff8f6f76f8f95df588244b65d852d5af831/img1534271400_8.png?cb=385c599be478049ccebecf9191083647) [Next Page](https://docs.zagile.com/llms-full.txt/1)