Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MARP-795: Add README_DE #33

Merged
13 commits merged into from
Sep 12, 2024
32 changes: 16 additions & 16 deletions salesforce-connector-product/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# 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).

## 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)

7. Click on the "Add New" button:

![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)

Expand All @@ -48,19 +48,19 @@ This connector builds the REST API and provides a way to access Salesforce resou

![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)

Expand Down
140 changes: 140 additions & 0 deletions salesforce-connector-product/README_DE.md
Original file line number Diff line number Diff line change
@@ -0,0 +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 available process starts
3. Click on **ChartDemo**.

![process-start-chart](images/sf-start-chart.png)

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. Click on **ListDemo**.

![process-start-list](images/sf-start-list.png)

6. In this demo the connector displays the opportunities as list:

![list-opportunity](images/sf-list.png)

7. Click on the "Add New" button:

![add-new-opportunity](images/sf-start-addNew.png)

8. Add a 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)



Loading