Skip to content

Commit 2fa29d6

Browse files
authored
Update README.md
1 parent 73a1aff commit 2fa29d6

File tree

1 file changed

+28
-25
lines changed

1 file changed

+28
-25
lines changed

README.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,35 @@
22

33
## Overview
44

5-
You can use [Microsoft Graph API](https://developer.microsoft.com/en-us/graph/docs/concepts/v1-overview) to create some integration points between WorkflowGen and Office 365 applications such Outlook, Excel, Teams, OneDrive, SharePoint and Azure.
5+
You can use the [Microsoft Graph API](https://developer.microsoft.com/en-us/graph/docs/concepts/v1-overview) to create integration points between WorkflowGen and Office 365 applications such Outlook, Excel, Teams, OneDrive, SharePoint, and Azure.
66

77
This repository includes the `Advantys.Workflow.Applications.MicrosoftGraph.dll` assembly and the associated Visual Studio project.
8-
This assembly exposes multiples methods that can be used as WorkflowGen applications for each integration feature.
8+
This assembly exposes multiple methods that can be used as WorkflowGen applications for each integration feature.
99

10-
## Content
10+
## Contents
1111

12-
`docs`: Workflow applications documentation.
12+
`docs`: Workflow applications documentation
1313

14-
`processes`: Process definition file examples.
14+
`processes`: Process definition file examples
1515

16-
`src`: Visual Studio solution.
16+
`src`: Visual Studio solution
1717

1818
## Prerequisites
1919

2020
- Office 365 licences (one license for each user that will be accessing Office applications)
2121

2222
- Access to an Azure portal: https://portal.azure.com/
2323

24-
- Service account with an Office 365 licence (such as `workflowgen@YOUR_DOMAIN.com`)
24+
- A service account with an Office 365 licence (such as `workflowgen@YOUR_DOMAIN.com`)
2525

26-
- Workflowgen.My.dll 4.2.0 (WorkflowGen 7.10 or later)
26+
- `Workflowgen.My.dll` 4.2.0 and WorkflowGen Server version 7.10.0 or later
2727

2828

2929
## Installation
3030

3131
### Application registration
3232

33-
1. Create an application on the https://apps.dev.microsoft.com/ site, such as `WorkflowGen`.
33+
1. Create an application on the https://apps.dev.microsoft.com/ site (such as `WorkflowGen`).
3434

3535
2. In **Application Secret** section, generate a new password and save the secret.
3636

@@ -40,39 +40,43 @@ This assembly exposes multiples methods that can be used as WorkflowGen applicat
4040

4141
5. Each [workflow application](#Workflow-applications-installation) requires specific permissions, so select these in **Application Permissions**, then save the application.
4242

43-
6. To activate permissions, go to the `https://login.microsoftonline.com/YOUR_TENANT_ID/adminconsent?client_id=YOUR_CLIENT_ID&redirect_uri=https://login.microsoftonline.com` URL (replacing `YOUR_TENANT_ID` and `YOUR_CLIENT_ID` with your tenant and client IDs, respectively), and connect using an Administrator account.
43+
6. To activate permissions, go to the URL `https://login.microsoftonline.com/YOUR_TENANT_ID/adminconsent?client_id=YOUR_CLIENT_ID&redirect_uri=https://login.microsoftonline.com` (replacing `YOUR_TENANT_ID` and `YOUR_CLIENT_ID` with your tenant and client IDs, respectively), and connect using an Administrator account.
4444

45-
### Librairies installation on the WorkflowGen Server
45+
### Libraries installation on the WorkflowGen Server
46+
47+
The following components will be installed in the WorkflowGen `\bin` folders (`\wfgen\bin`, `\wfgen\ws\bin`, `..\Program Files\Advantys\WorkflowGen\Service\bin`):
4648

47-
The following components will be installed in the WorkflowGen `/bin` folders (`/wfgen/bin`, `/wfgen/ws/bin`, `../Program Files/Advantys/WorkflowGen/Service/bin`):
4849
- `Advantys.Workflow.Applications.MicrosoftGraph.dll`
50+
4951
- `Microsoft.Graph.dll`
52+
5053
- `Microsoft.Graph.Core.dll`
54+
5155
- `Microsoft.Identity.Client.dll`
5256

5357
#### Quick Start
5458

55-
1. Download the last release pack on your WorkflowGen server.
59+
1. Download the last release pack to your WorkflowGen server.
5660

57-
2. Edit the `config.json`, replacing `WebAppPath` and `ServiceAppPath` with your own path (the default values are already specified).
61+
2. Edit the `config.json` file, replacing `WebAppPath` and `ServiceAppPath` with your own paths (the default values are already specified).
5862

5963
3. Execute the `Install.ps1` script in PowerShell.
6064

6165
#### Custom installation
6266

6367
1. Clone the repository.
6468

65-
2. Open the Visual Studio Solution : `WorkflowGenMicrosoftGraph.sln`.
69+
2. Open the `WorkflowGenMicrosoftGraph.sln` Visual Studio solution.
6670

67-
3. Compile the Solution and copy the `Advantys.Workflow.Applications.MicrosoftGraph.dll` generated to the `src/Install` folder.
71+
3. Compile the solution and copy the generated `Advantys.Workflow.Applications.MicrosoftGraph.dll` file to the `src/Install` folder.
6872

69-
4. Edit the `config.json`, replacing `WebAppPath` and `ServiceAppPath` with your own path (the default values are already specified).
73+
4. Edit the `config.json`, replacing `WebAppPath` and `ServiceAppPath` with your own paths (the default values are already specified).
7074

7175
5. Execute the `Install.ps1` script in PowerShell.
7276

7377
### WorkflowGen configuration
7478

75-
Add the following settings to the WorkflowGen `/wfgen/web.config` with your own values:
79+
Add the following settings to the WorkflowGen `\wfgen\web.config` with your own values:
7680

7781
```xml
7882
<add key="MicrosoftGraphTenant" value="TENANT_ID" />
@@ -82,20 +86,19 @@ Add the following settings to the WorkflowGen `/wfgen/web.config` with your own
8286
<add key="MicrosoftGraphServiceLogPath" value="LOG_PATH" />
8387
```
8488

85-
Where:
86-
* **TENANT_ID**: Your tenant ID, which you can can find in the Azure AD (Directory ID)
89+
* **`TENANT_ID`**: Your tenant ID, which you can find in Azure AD (Directory ID).
8790

88-
* **CLIENT_ID**: The application ID you created earlier
91+
* **`CLIENT_ID`**: The application ID you created earlier.
8992

90-
* **CLIENT_SECRET** : The secret password you generated earlier
93+
* **`CLIENT_SECRET`**: The secret password you generated earlier.
9194

92-
* **SERVICE_ACCOUNT_ID** : Your service account ID, which you can find in the Azure AD account profile (`object id`)
95+
* **`SERVICE_ACCOUNT_ID`**: Your service account ID, which you can find in the Azure AD account profile (`object id`).
9396

94-
* **LOG_PATH** : The path where the logs will be saved
97+
* **`LOG_PATH`**: The path where the logs will be saved.
9598

9699
## Workflow applications installation
97100

98-
All required components are installed, you can now deploy WorkflowGen applications for each desired integration.
101+
Now that the required components are installed, you can deploy WorkflowGen applications for each integration.
99102

100103
### [Outlook](https://github.com/advantys/workflowgen-microsoft-graph/tree/master/docs/Outlook)
101104

0 commit comments

Comments
 (0)