From e113b3db3c4d12f4a17c50228ad495fcdcaebcc2 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:35:22 +0200 Subject: [PATCH 01/13] Create README_DE.md --- salesforce-connector-product/README_DE.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 salesforce-connector-product/README_DE.md diff --git a/salesforce-connector-product/README_DE.md b/salesforce-connector-product/README_DE.md new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/salesforce-connector-product/README_DE.md @@ -0,0 +1 @@ + From 13989d098032fb5ec411e1c3114c057f49fb9b2e Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:41:26 +0200 Subject: [PATCH 02/13] Update README.md --- salesforce-connector-product/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index d544e6f..b906b86 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -1,12 +1,13 @@ # Salesforce REST API -This connector builds the REST API and provides a way to access Salesforce resources. A client can use the REST API to manipulate Salesforce objects. Examples are performing CRUD operations on an opportunity object or to querying and retrieving data. This connector: +This connector uses the Salesforce REST API and provides a way to **access** Salesforce resources and **manipulate** objects. -- Provides the standard set of REST APIs to manipulate one specific object of Salesforce Opportunity. -- Tracks the status and the number of each status Opportunity. -- Manipulatea the object Opportunity and builds a standard REST client to apply Salesforce Object Query Language (SOQL). -- Supports you with an easy-to-copy demo implementation to reduce your integration effort. -- Enables low code citizen developers to integrate existing 3rd party systems. +This connector: + +- uses the REST API to process a Salesforce opportunity. +- tracks the status of opportunities +- manipulates opportunities using the Salesforce Object Query Language (SOQL). +- supports you with a demo implementation to reduce your integration effort. ## Demo From 89574629ad10f8acf236e9cb1c5d73ffd9f0926a Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:43:05 +0200 Subject: [PATCH 03/13] Update README_DE.md --- salesforce-connector-product/README_DE.md | 139 ++++++++++++++++++++++ 1 file changed, 139 insertions(+) diff --git a/salesforce-connector-product/README_DE.md b/salesforce-connector-product/README_DE.md index 8b13789..2b61bec 100644 --- a/salesforce-connector-product/README_DE.md +++ b/salesforce-connector-product/README_DE.md @@ -1 +1,140 @@ +# Salesforce REST API + +Dieser Konnektor nutzt die Salesforce REST-API und bietet dir Möglichkeiten, auf Salesforce-Ressourcen zuzugreifen und Salesforce-Objekte zu manipulieren. + +Dieser Konnektor: + +- nutzt die REST-API, um eine Salesforce Opportunity zu bearbeiten. +- verfolgt den Status von Opportunities +- manipuliert Opportunities unter Verwendung der Salesforce Object Query Language (SOQL) anzuwenden. + +## Demo + + 1. Login to the Axon Ivy platform + 2. Click **Starts** in the Axon Ivy menu to open the Full Process List + 3. On the Full Process List, click on **ChartDemo**. + + ![process-start-chart](images/sf-start-chart.png) + + 4. A simple chart for statistical analysis: + + ![simple-chart](images/sf-chart.png) + + 5. On the Full Process List, click on **ListDemo**. + + ![process-start-list](images/sf-start-list.png) + + 6. Opportunity Overview: + + ![list-opportunity](images/sf-list.png) + + 7. Click on the "Add New" button: + + ![add-new-opportunity](images/sf-start-addNew.png) + + 8. Add new Opportunity: + + ![add-new-opportunity-popup](images/sf-addNew.png) + + 9. Click on Opportunity Name to view details: + + ![add-new-opportunity-summary](images/sf-start-detail.png) + + 10. Opportunity details: + + ![opportunity-details-dialog](images/sf-detail.png) + + 11. Opportunity details Activity: + + ![opportunity-details-activity](images/sf-detail-activity.png) + + 12. Click on the icon Pencil to Update an Opportunity: + + ![modify-opportunity](images/sf-start-edit.png) + + 13. Edit Opportunity: + + ![modify-opportunity-popup](images/sf-edit.png) + + 14. Click on the icon "Trash" to remove an Opportunity: + + ![delete-opportunity](images/sf-start-delete.png) + + 15. Delete Opportunity: + + ![delete-opportunity-popup](images/sf-delete.png) + + +## Setup + +### Configuration on Salesforce side + For a client application to access REST API resources, it must be authorized as a trusted visitor. To implement this authorization, utilize a **Connected App** and employ the **OAuth 2.0** authorization flow. + + **Important steps** + + 1. Create a Connected App to generate the necessary authentication information + +- Go to **Setup** -> **Apps** -> **App Manager** -> click on button **New Connected App** + + ![new-connected-app](images/sf-app-manager-01.png) + +- Input all needed information + + ![input-connected-app-info](images/sf-app-manager-02.png) + +- Generate Consumer key And Consumer secret + + ![consumer-key-and-secret](images/sf-app-manager-04.png) + +- Configure Client credential flow + + ![client-credential-flow-user](images/sf-app-manager-03.png) + + +2. Configure authentication providers for your application + +- Go to **Setup** -> **Auth.provider** -> **New** + + ![auth-provider](images/sf-auth-provider.png) + + + +3. Activate the required settings in OAuth and OpenID Connect settings to facilitate secure authentication + +- Go to **Setup** -> **OAuth and OpenID Connect Settings** -> Enable checkboxes + + ![oauth-and-openId](images/sf-auth-openId.png) + + + +4. Set up Named Credentials to manage and secure access to external services + +- Go to **Setup** -> **Named Credentials** -> **New legacy** + + ![named-credential](images/sf-named-credential.png) + + +### Integrate the connector into your project + The **Consumer Key** and **Consumer Secret** are retrieved from the **Connected App** and placed in the `variables.yaml` file. + + Authentication information is set up as a global variable and can be updated anytime. + + + | Variable name | Note |Example | + |--------------------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------| + |salesforce-connector.auth.subdomain |The domain that Salesforce provides to consumers for authentication |axonactive3-dev-ed.develop | + |salesforce-connector.auth.clientId |Consumer Id |3MVG95mg0lk4bathQF4Z_F1GcZZPr8ztvo29c53HhwOXnCKBkP8LkxHnb5KlydXj3Oomw0VHsY | + |salesforce-connector.auth.clientSecret |Consumer Secret |56C6CA448B49032828FE4C4DF16D1AF4804B8CC734E066B255A5B31A | + |salesforce-connector.auth.useAppPermissions |OAuth2 Grantype |true (client_credentials) | + |salesforce-connector.auth.url |Salesforce Rest URI |https://axonactive3-dev-ed.develop.my.salesforce.com/services/data/v58.0 | + + +### Resources +[Developer](https://developer.salesforce.com/docs) + +[Connected App](https://help.salesforce.com/s/articleView?id=sf.connected_app_client_credentials_setup.htm&type=5) + +[Salesforce SOQL](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm) + + From f976d3a31d3a78f879b50698baed1d3c751b0728 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:43:21 +0200 Subject: [PATCH 04/13] Update README.md --- salesforce-connector-product/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index b906b86..74a36c8 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -7,7 +7,6 @@ This connector: - uses the REST API to process a Salesforce opportunity. - tracks the status of opportunities - manipulates opportunities using the Salesforce Object Query Language (SOQL). -- supports you with a demo implementation to reduce your integration effort. ## Demo From 0506f625cb07ff359a528fbfd58a837107ea612b Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:45:20 +0200 Subject: [PATCH 05/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index 74a36c8..f53170e 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -16,7 +16,7 @@ This connector: ![process-start-chart](images/sf-start-chart.png) - 4. A simple chart for statistical analysis: + 4. The connector fetches all opportunities and display them as a bar chart ![simple-chart](images/sf-chart.png) From 7fd7a3782bb79cde1077de0c184a879bee4b7818 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:45:52 +0200 Subject: [PATCH 06/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index f53170e..e2711b1 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -16,7 +16,7 @@ This connector: ![process-start-chart](images/sf-start-chart.png) - 4. The connector fetches all opportunities and display them as a bar chart + 4. The connector fetches all Salesforce opportunities via the REST API and display them as a bar chart ![simple-chart](images/sf-chart.png) From f5b5f9ce87bb07b3dd717c1c3aed1b35921e6095 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:46:24 +0200 Subject: [PATCH 07/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index e2711b1..9b48259 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -12,7 +12,7 @@ This connector: 1. Login to the Axon Ivy platform 2. Click **Starts** in the Axon Ivy menu to open the Full Process List - 3. On the Full Process List, click on **ChartDemo**. + 3. Click on **ChartDemo**. ![process-start-chart](images/sf-start-chart.png) From c4f2f68a01951268f82fff71d8f2ac1e4cdaef25 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:47:04 +0200 Subject: [PATCH 08/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index 9b48259..e00d657 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -11,7 +11,7 @@ This connector: ## Demo 1. Login to the Axon Ivy platform - 2. Click **Starts** in the Axon Ivy menu to open the Full Process List + 2. Click **Starts** in the Axon Ivy menu to open the available process starts 3. Click on **ChartDemo**. ![process-start-chart](images/sf-start-chart.png) From 61dda810854ebc8ba60ceb4efc3f3a04e0758755 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:47:39 +0200 Subject: [PATCH 09/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index e00d657..9427208 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -20,7 +20,7 @@ This connector: ![simple-chart](images/sf-chart.png) - 5. On the Full Process List, click on **ListDemo**. + 5. Click on **ListDemo**. ![process-start-list](images/sf-start-list.png) From f3dd326ba4de430a8aea047cbcbbc927ef87e7f5 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:49:15 +0200 Subject: [PATCH 10/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index 9427208..9c1f910 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -24,7 +24,7 @@ This connector: ![process-start-list](images/sf-start-list.png) - 6. Opportunity Overview: + 6. In this demo the connector displays the opportunities as list: ![list-opportunity](images/sf-list.png) From 607db28c9323c7012804f58fdef2f54c805d0b50 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:49:54 +0200 Subject: [PATCH 11/13] Update README.md --- salesforce-connector-product/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index 9c1f910..20807c6 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -32,7 +32,7 @@ This connector: ![add-new-opportunity](images/sf-start-addNew.png) - 8. Add new Opportunity: + 8. Add a new opportunity: ![add-new-opportunity-popup](images/sf-addNew.png) From d0a7149af00eab2544e596f75bdcde7156bd2a33 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:51:55 +0200 Subject: [PATCH 12/13] Update README.md --- salesforce-connector-product/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/salesforce-connector-product/README.md b/salesforce-connector-product/README.md index 20807c6..ba7900f 100644 --- a/salesforce-connector-product/README.md +++ b/salesforce-connector-product/README.md @@ -48,19 +48,19 @@ This connector: ![opportunity-details-activity](images/sf-detail-activity.png) - 12. Click on the icon Pencil to Update an Opportunity: + 12. Click on the icon "Pencil" to update an opportunity: ![modify-opportunity](images/sf-start-edit.png) - 13. Edit Opportunity: + 13. Edit opportunity: ![modify-opportunity-popup](images/sf-edit.png) - 14. Click on the icon "Trash" to remove an Opportunity: + 14. Click on the icon "Trash" to remove an opportunity: ![delete-opportunity](images/sf-start-delete.png) - 15. Delete Opportunity: + 15. Delete opportunity: ![delete-opportunity-popup](images/sf-delete.png) From eff90790121bbe644cbcf84dc9fe1282122d04b0 Mon Sep 17 00:00:00 2001 From: Sabine Gillner <129939502+ivy-sgi@users.noreply.github.com> Date: Thu, 15 Aug 2024 13:52:21 +0200 Subject: [PATCH 13/13] Update README_DE.md --- salesforce-connector-product/README_DE.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/salesforce-connector-product/README_DE.md b/salesforce-connector-product/README_DE.md index 2b61bec..259930d 100644 --- a/salesforce-connector-product/README_DE.md +++ b/salesforce-connector-product/README_DE.md @@ -11,20 +11,20 @@ Dieser Konnektor: ## Demo 1. Login to the Axon Ivy platform - 2. Click **Starts** in the Axon Ivy menu to open the Full Process List - 3. On the Full Process List, click on **ChartDemo**. + 2. Click **Starts** in the Axon Ivy menu to open the available process starts + 3. Click on **ChartDemo**. ![process-start-chart](images/sf-start-chart.png) - 4. A simple chart for statistical analysis: + 4. The connector fetches all Salesforce opportunities via the REST API and display them as a bar chart ![simple-chart](images/sf-chart.png) - 5. On the Full Process List, click on **ListDemo**. + 5. Click on **ListDemo**. ![process-start-list](images/sf-start-list.png) - 6. Opportunity Overview: + 6. In this demo the connector displays the opportunities as list: ![list-opportunity](images/sf-list.png) @@ -32,7 +32,7 @@ Dieser Konnektor: ![add-new-opportunity](images/sf-start-addNew.png) - 8. Add new Opportunity: + 8. Add a new opportunity: ![add-new-opportunity-popup](images/sf-addNew.png) @@ -48,19 +48,19 @@ Dieser Konnektor: ![opportunity-details-activity](images/sf-detail-activity.png) - 12. Click on the icon Pencil to Update an Opportunity: + 12. Click on the icon "Pencil" to update an opportunity: ![modify-opportunity](images/sf-start-edit.png) - 13. Edit Opportunity: + 13. Edit opportunity: ![modify-opportunity-popup](images/sf-edit.png) - 14. Click on the icon "Trash" to remove an Opportunity: + 14. Click on the icon "Trash" to remove an opportunity: ![delete-opportunity](images/sf-start-delete.png) - 15. Delete Opportunity: + 15. Delete opportunity: ![delete-opportunity-popup](images/sf-delete.png)