diff --git a/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index 47aebd49f97..e6c1bbcb239 100644 --- a/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -46,7 +46,6 @@ import TabItem from "@theme/TabItem"; - [Microsoft Teams Connector](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) - Interactions with [Microsoft Teams](https://www.microsoft.com/microsoft-teams/) from your BPMN process. - [Microsoft 365 Connector](/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md) - Interactions with [Microsoft 365](https://outlook.office.com/mail/) mail from your BPMN process. - [OpenAI Connector](/components/connectors/out-of-the-box-connectors/openai.md) - Interact with [ChatGPT](https://chat.openai.com/) and [OpenAI Moderation API](https://platform.openai.com/docs/guides/moderation/overview). -- [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md) - Orchestrate your [Power Automate](https://powerautomate.microsoft.com) Flows with Camunda. - [RabbitMQ Producer Connector](/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md) - Send messages to [RabbitMQ](https://www.rabbitmq.com/) from your BPMN process. - [Salesforce Connector](/components/connectors/out-of-the-box-connectors/salesforce.md) - Manage your Salesforce instance from your BPMN process. - [SendGrid Connector](/components/connectors/out-of-the-box-connectors/sendgrid.md) - Quickly send emails from your BPMN processes. diff --git a/docs/components/connectors/out-of-the-box-connectors/power-automate.md b/docs/components/connectors/out-of-the-box-connectors/power-automate.md deleted file mode 100644 index 04c9449e6ad..00000000000 --- a/docs/components/connectors/out-of-the-box-connectors/power-automate.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: power-automate -title: Power Automate Connector -description: Orchestrate your Power Automate desktop flows with Camunda to trigger, get the status, or get the outputs of the flow. ---- - -The **Power Automate Connector** is an outbound Connector that allows you to orchestrate a Power Automate desktop flow from your BPMN process with [Power Automate](https://powerautomate.microsoft.com). - -:::note -This Connector is designed to orchestrate desktop flows only. -::: - -## Prerequisites - -To use the Power Automate Connector, ensure you have configured the following: - -1. [Azure AD application](https://portal.azure.com) with proper permissions. Visit the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory#create-an-application-registration) to see how you can create one. -2. [Create an application user](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) and add security roles. -3. [Power Automate desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install), and sign in to create your Power Automate flow. -4. [Power Automate machine runtime desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/manage-machines#register-a-new-machine) to manage and troubleshoot machine settings, and enable the on-premise data gateway to access your machine data. -5. Power Automate [on-premises data gateway desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install#install-an-on-premises-data-gateway) to create a connection between the cloud environment and your desktop app. - -## Create a Power Automate Connector task - -To use a **Power Automate Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. - -## Operation types - -The Power Automate Connector currently supports three operation types in the **Operation type** dropdown list: _Get the status of a flow run_, _Get flow outputs_, and _Trigger a flow run_. - -### Authentication - -You can choose among the available Power Automate Connector authentication types according to your authentication requirements. - -### Power Automate Connector (bearer token) - -#### Create a new Connector secret - -We advise you to keep your **Bearer Token** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_BEARER_TOKEN`) so you can reference it later in the Connector. - -#### Configure the bearer token - -[Click here](#get-bearer-token-with-postman) to see how to get the Bearer token with Postman. - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **Bearer Token** in the **Authentication** section. -2. Set **Bearer** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_BEARER_TOKEN}}`). - -### OAuth 2.0 - -#### Create a new Connector secret - -We advise you to keep your **Client ID** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_CLIENT_ID`) so you can reference it later in the Connector. - -#### Configure the OAuth Token - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **OAuth 2.0** in the **Authentication** section. -2. Set **Client Id** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_ID}}`). -3. Set **Client secret** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_SECRET}}`). -4. Set **OAuth Token Endpoint** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_TOKEN_ENDPOINT}}`). - -##### OAuth Token Endpoint - -Provide the **OAuth Token Endpoint** in the following format: https://login.microsoftonline.com/{tanantID}/oauth2/v2.0/token - -Read more on how you can [find your tenantID](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant#find-tenant-id-through-the-azure-portal). - -### Trigger a flow run - -This operation allows you to trigger a Power Automate desktop flow. To execute it, take the following steps: - -1. Select the operation **Trigger a flow run** from the **Operation type** dropdown list. -2. Configure authentication as described in the [authentication](#authentication) section. -3. Fill out the input fields as described in the [configuration](#configuration) section. -4. Fill out the input fields as described in the [input](#input) section. -5. Fill out the response mapping as described in the [trigger a flow run response](#trigger-a-flow-run-response) section. - -#### Trigger a flow run response - -The operation **Trigger a flow run** returns information about the triggered flow. - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowSessionId: response.body.flowsessionId}`. To use operation _Get the status of a flow run_, you need a `flowSessionId`. This expression will add it in the context for you. Learn more in [get the status of a flow run](#get-the-status-of-a-flow-run). - -Response example: - -``` -= { - "@odata.context": "https://org11aaa11a.crm4.dynamics.com/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.RunDesktopFlowResponse", - "flowsessionId": "bb2a1f33-e5b9-ed11-83fe-000d3ab4f483", - "licenseCheck": { - "@odata.context": "#Microsoft.Dynamics.CRM.expando", - "code": "ValidLicenseCoverage", - "message": "Valid License Coverage" - } -} -``` - -#### Configuration - -For this section, you must fill out the **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out the following fields: - -1. **Workflow ID (Flow ID)**: The ID of the Power Automate desktop flow. -2. **Connection name**: Connection to be used with the desktop flow script. You can specify it as connection name or as Connection Reference Logical Name. In the latter case, you have to set the **connectionType** accordingly. [See how to get the connection name](#how-to-get-the-connection-name). -3. **Connection type**: Identifies which type of connection is used in the connection name parameter. Connection type (default), or a connection reference type. -4. **Run mode**: Choose between attended or unattended. -5. **Run priority**: Choose an option (normal, high) or add your own. -6. _(Optional)_ **Inputs**: The desktop flow script input parameters (JSON serialized string). -7. _(Optional)_ **Callback URL**: URL that will be called once the desktop flow script is complete. [See how to use the Webhook Connector](#using-webhook-connector-as-callback-endpoint) as a callback endpoint. - -### Get the status of a flow run - -The operation **Get the status of a flow run** returns information about the newly triggered flow session. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {statusCode: response.body.statuscode}`. - -Response example: - -``` -= { - "@odata.context": "https://[Organization URI]/api/data/v9.2/$metadata#flowsessions(statuscode,statecode,startedon,completedon)/$entity", - "@odata.etag": "W1276122", - "statuscode": 4, - "statecode": 0, - "startedon": "2022-06-16T12:54:40Z", - "completedon": "2022-06-16T12:57:46Z", -} -``` - -Meaning of the different status codes based on the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/entities/flowsession#statuscode-choicesoptions): - -| Status | Statuscode | -| ------ | ------------ | -| 0 | NotSpecified | -| 1 | Paused | -| 2 | Running | -| 3 | Waiting | -| 4 | Succeeded | -| 5 | Skipped | -| 6 | Suspended | -| 7 | Cancelled | -| 8 | Failed | -| 9 | Faulted | -| 10 | TimedOut | -| 11 | Aborted | -| 12 | Ignored | -| 13 | Deleted | -| 14 | Terminated | - -### Get flow outputs - -The operation **Get flow outputs** returns the output of the triggered Power Automate flow. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowOutputs: response.body}`. - -Response example: - -``` -= { - "Output1": "My output value" -} -``` - -## Appendix - -### Using Power Automate Connector best practice - -#### Using Webhook Connector as callback endpoint - -Oftentimes, it is desired to continue the process after a Power Automate flow run finished. You can use the **Callback URL** field if you select the **Trigger a flow run** to specify a URL which will be called after the flow is finished. - -If you wish to continue the Camunda process or start a new one, the [Webhook Connector](/components/connectors/protocol/http-webhook.md) is a good next step. For this, take the following steps: - -1. Create a [Webhook Connector](/components/connectors/protocol/http-webhook.md) and specify the **Webhook ID**. -2. Create a [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md), select the **Trigger a flow run** method, and fill in the fields. - - If you use Camunda 8 SaaS, you can use the following pattern for the **Callback URL**: `{zeebe.client.cloud.region}.{zeebeHostUrl}/{zeebe.client.cloud.clusterId}/inbound/{webhookId}`. - - If you use Camunda 8 SaaS you can find the Zeebe-specific values in you cluster details on the **API** tab under **Client Credentials**. The **webhookId** is the id you specified in the first step, and the **zeebeHostUrl** is connectors.camunda.io. - -#### Get Bearer token with Postman - -1. Allow implicit flow in your [Azure AD app](https://portal.azure.com): - - Go to the **Manifest** tab. - - Set `oauth2AllowImlicitFlow` to `true`. - - Save changes. -2. [Visit the official site](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment) to see how to set up the Postman environment. -3. [Generate an access token](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment#generate-an-access-token-to-use-with-your-environment) and use it in the **Bearer token** field. - -#### How to get the connection name - -1. Go to you [Power Platform admin center](https://admin.powerplatform.microsoft.com), and select [Power Automate app](https://make.powerautomate.com) from the top left menu. -2. In the left menu bar under **Data**, select **Connections > New connection**. -3. Select **Desktop flows** and provide the domain and username of the user on the machine where the desktop flows are running, and also provide the password belongs to this user. -4. Click **Create**. -5. Now, click on the newly created connection, and you can find your connection name in the URL as shown in the example below. The connection name is a part of the URL and is preceded by `connectionName=`. - Example URL: - ``` - https://make.powerautomate.com/enviroments/dw43634dsgsdty45y/connections?apiName=shared_uiflow&connectionName=123453679877564 - ``` - In this example, the connection name is 123453679877564. This is a default connection type. diff --git a/optimize_sidebars.js b/optimize_sidebars.js index b8c96ddc502..9309d27c5b5 100644 --- a/optimize_sidebars.js +++ b/optimize_sidebars.js @@ -884,10 +884,6 @@ module.exports = { "Camunda Operate Connector", "components/connectors/out-of-the-box-connectors/operate/" ), - docsLink( - "Power Automate Connector", - "components/connectors/out-of-the-box-connectors/power-automate/" - ), docsLink( "RabbitMQ Connector", "components/connectors/out-of-the-box-connectors/rabbitmq/" diff --git a/optimize_versioned_sidebars/version-3.10.0-sidebars.json b/optimize_versioned_sidebars/version-3.10.0-sidebars.json index 094d7dbc072..90a87f73227 100644 --- a/optimize_versioned_sidebars/version-3.10.0-sidebars.json +++ b/optimize_versioned_sidebars/version-3.10.0-sidebars.json @@ -1027,11 +1027,6 @@ "label": "Camunda Operate Connector", "href": "/docs/8.2/components/connectors/out-of-the-box-connectors/operate/" }, - { - "type": "link", - "label": "Power Automate Connector", - "href": "/docs/8.2/components/connectors/out-of-the-box-connectors/power-automate/" - }, { "type": "link", "label": "RabbitMQ Connector", diff --git a/optimize_versioned_sidebars/version-3.11.0-sidebars.json b/optimize_versioned_sidebars/version-3.11.0-sidebars.json index af670ce68d8..cb499e04d43 100644 --- a/optimize_versioned_sidebars/version-3.11.0-sidebars.json +++ b/optimize_versioned_sidebars/version-3.11.0-sidebars.json @@ -1091,11 +1091,6 @@ "label": "Camunda Operate Connector", "href": "/docs/8.3/components/connectors/out-of-the-box-connectors/operate/" }, - { - "type": "link", - "label": "Power Automate Connector", - "href": "/docs/8.3/components/connectors/out-of-the-box-connectors/power-automate/" - }, { "type": "link", "label": "RabbitMQ Connector", diff --git a/optimize_versioned_sidebars/version-3.12.0-sidebars.json b/optimize_versioned_sidebars/version-3.12.0-sidebars.json index deb09680fa1..6f22bf97953 100644 --- a/optimize_versioned_sidebars/version-3.12.0-sidebars.json +++ b/optimize_versioned_sidebars/version-3.12.0-sidebars.json @@ -1136,11 +1136,6 @@ "label": "Camunda Operate Connector", "href": "/docs/components/connectors/out-of-the-box-connectors/operate/" }, - { - "type": "link", - "label": "Power Automate Connector", - "href": "/docs/components/connectors/out-of-the-box-connectors/power-automate/" - }, { "type": "link", "label": "RabbitMQ Connector", diff --git a/optimize_versioned_sidebars/version-3.9.0-sidebars.json b/optimize_versioned_sidebars/version-3.9.0-sidebars.json index 16b1d9051e6..d50434ac9ba 100644 --- a/optimize_versioned_sidebars/version-3.9.0-sidebars.json +++ b/optimize_versioned_sidebars/version-3.9.0-sidebars.json @@ -940,11 +940,6 @@ "label": "Camunda Operate Connector", "href": "/docs/8.1/components/connectors/out-of-the-box-connectors/operate/" }, - { - "type": "link", - "label": "Power Automate Connector", - "href": "/docs/8.1/components/connectors/out-of-the-box-connectors/power-automate/" - }, { "type": "link", "label": "RabbitMQ Connector", diff --git a/sidebars.js b/sidebars.js index f465801cf4e..bc32bf795c7 100644 --- a/sidebars.js +++ b/sidebars.js @@ -312,7 +312,6 @@ module.exports = { }, "components/connectors/out-of-the-box-connectors/openai", "components/connectors/out-of-the-box-connectors/operate", - "components/connectors/out-of-the-box-connectors/power-automate", "components/connectors/out-of-the-box-connectors/rabbitmq", "components/connectors/out-of-the-box-connectors/salesforce", "components/connectors/out-of-the-box-connectors/slack", diff --git a/static/.htaccess b/static/.htaccess index a2d927db800..2b95e004f2d 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -3,6 +3,14 @@ RewriteEngine on RewriteCond %{SERVER_PORT} !^443$ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L] +# Redirect to Connectors overview upon deprecation of Power Automate Connector +RewriteRule ^docs/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] +RewriteRule ^docs/next/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/next/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] +RewriteRule ^docs/8.4/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/8.4/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] +RewriteRule ^docs/8.3/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/8.3/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] +RewriteRule ^docs/8.2/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/8.2/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] +RewriteRule ^docs/8.1/components/connectors/out-of-the-box-connectors/power-automate/?$ /docs/8.1/components/connectors/out-of-the-box-connectors/available-connectors-overview/ [R=301,L] + # Disable directory listing and multi views Options -Indexes -MultiViews diff --git a/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index 18c3330ebd8..829ff4f68d9 100644 --- a/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -46,7 +46,6 @@ import TabItem from "@theme/TabItem"; - [Microsoft Teams Connector](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) - Interactions with [Microsoft Teams](https://www.microsoft.com/microsoft-teams/) from your BPMN process. - [Microsoft 365 Connector](/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md) - Interactions with [Microsoft 365](https://outlook.office.com/mail/) mail from your BPMN process. - [OpenAI Connector](/components/connectors/out-of-the-box-connectors/openai.md) - Interact with [ChatGPT](https://chat.openai.com/) and [OpenAI Moderation API](https://platform.openai.com/docs/guides/moderation/overview). -- [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md) - Orchestrate your [Power Automate](https://powerautomate.microsoft.com) Flows with Camunda. - [RabbitMQ Connector](/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md) - Send messages to [RabbitMQ](https://www.rabbitmq.com/) from your BPMN process. - [SendGrid Connector](/components/connectors/out-of-the-box-connectors/sendgrid.md) - Quickly send emails from your BPMN processes. - [Slack outbound Connector](/components/connectors/out-of-the-box-connectors/slack.md) - Send messages to channels or users in your [Slack](https://slack.com) workspace from your BPMN process. diff --git a/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/power-automate.md b/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/power-automate.md deleted file mode 100644 index db958188be7..00000000000 --- a/versioned_docs/version-8.1/components/connectors/out-of-the-box-connectors/power-automate.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: power-automate -title: Power Automate Connector -description: Orchestrate your Power Automate desktop flows with Camunda to trigger, get the status, or get the outputs of the flow. ---- - -The **Power Automate Connector** is an outbound Connector that allows you to orchestrate a Power Automate desktop flow from your BPMN process with [Power Automate](https://powerautomate.microsoft.com). - -:::note -This Connector is designed to orchestrate desktop flows only. -::: - -## Prerequisites - -To use the Power Automate Connector, ensure you have configured the following: - -1. [Azure AD application](https://portal.azure.com) with proper permissions. Visit the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory#create-an-application-registration) to see how you can create one. -2. [Create an application user](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) and add security roles. -3. [Power Automate desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install), and sign in to create your Power Automate flow. -4. [Power Automate machine runtime desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/manage-machines#register-a-new-machine) to manage and troubleshoot machine settings, and enable the on-premise data gateway to access your machine data. -5. Power Automate [on-premises data gateway desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install#install-an-on-premises-data-gateway) to create a connection between the cloud environment and your desktop app. - -## Create a Power Automate Connector task - -To use a **Power Automate Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. - -## Operation types - -The Power Automate Connector currently supports three operation types in the **Operation type** dropdown list: _Get the status of a flow run_, _Get flow outputs_, and _Trigger a flow run_. - -### Authentication - -You can choose among the available Power Automate Connector authentication types according to your authentication requirements. - -### Power Automate Connector (bearer token) - -#### Create a new Connector secret - -We advise you to keep your **Bearer Token** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_BEARER_TOKEN`) so you can reference it later in the Connector. - -#### Configure the bearer token - -[Click here](#get-bearer-token-with-postman) to see how to get the Bearer token with Postman. - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **Bearer Token** in the **Authentication** section. -2. Set **Bearer** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_BEARER_TOKEN}}`). - -### OAuth 2.0 - -#### Create a new Connector secret - -We advise you to keep your **Client ID** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_CLIENT_ID`) so you can reference it later in the Connector. - -#### Configure the OAuth Token - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **OAuth 2.0** in the **Authentication** section. -2. Set **Client Id** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_ID}}`). -3. Set **Client secret** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_SECRET}}`). -4. Set **OAuth Token Endpoint** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_TOKEN_ENDPOINT}}`). - -##### OAuth Token Endpoint - -You should provide the **OAuth Token Endpoint** in the following format: https://login.microsoftonline.com/{tanantID}/oauth2/v2.0/token - -Read more on how you can [find your tenantID](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant#find-tenant-id-through-the-azure-portal). - -### Trigger a flow run - -This operation allows you to trigger a Power Automate desktop flow. To execute it, take the following steps: - -1. Select the operation **Trigger a flow run** from the **Operation type** dropdown list. -2. Configure authentication as described in the [authentication](#authentication) section. -3. Fill out the input fields as described in the [configuration](#configuration) section. -4. Fill out the input fields as described in the [input](#input) section. -5. Fill out the response mapping as described in the [trigger a flow run response](#trigger-a-flow-run-response) section. - -#### Trigger a flow run response - -The operation **Trigger a flow run** returns information about the triggered flow. - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowSessionId: response.body.flowsessionId}`. To use operation _Get the status of a flow run_, you need a `flowSessionId`. This expression will add it in the context for you. Learn more in [get the status of a flow run](#get-the-status-of-a-flow-run). - -Response example: - -``` -= { - "@odata.context": "https://org11aaa11a.crm4.dynamics.com/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.RunDesktopFlowResponse", - "flowsessionId": "bb2a1f33-e5b9-ed11-83fe-000d3ab4f483", - "licenseCheck": { - "@odata.context": "#Microsoft.Dynamics.CRM.expando", - "code": "ValidLicenseCoverage", - "message": "Valid License Coverage" - } -} -``` - -#### Configuration - -For this section, you must fill out the **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out the following fields: - -1. **Workflow ID (Flow ID)**: The ID of the Power Automate desktop flow. -2. **Connection name**: Connection to be used with the desktop flow script. You can specify it as connection name or as Connection Reference Logical Name. In the latter case, you have to set the **connectionType** accordingly. [See how to get the connection name](#how-to-get-the-connection-name). -3. **Connection type**: Identifies which type of connection is used in the connection name parameter. Connection type (default), or a connection reference type. -4. **Run mode**: Choose between attended or unattended. -5. **Run priority**: Choose an option (normal, high) or add your own. -6. _(Optional)_ **Inputs**: The desktop flow script input parameters (JSON serialized string). -7. _(Optional)_ **Callback URL**: URL that will be called once the desktop flow script is complete. [See how to use the Webhook Connector](#using-webhook-connector-as-callback-endpoint) as a callback endpoint. - -### Get the status of a flow run - -The operation **Get the status of a flow run** returns information about the newly triggered flow session. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {statusCode: response.body.statuscode}`. - -Response example: - -``` -= { - "@odata.context": "https://[Organization URI]/api/data/v9.2/$metadata#flowsessions(statuscode,statecode,startedon,completedon)/$entity", - "@odata.etag": "W1276122", - "statuscode": 4, - "statecode": 0, - "startedon": "2022-06-16T12:54:40Z", - "completedon": "2022-06-16T12:57:46Z", -} -``` - -Meaning of the different status codes based on the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/entities/flowsession#statuscode-choicesoptions): - -| Status | Statuscode | -| ------ | ------------ | -| 0 | NotSpecified | -| 1 | Paused | -| 2 | Running | -| 3 | Waiting | -| 4 | Succeeded | -| 5 | Skipped | -| 6 | Suspended | -| 7 | Cancelled | -| 8 | Failed | -| 9 | Faulted | -| 10 | TimedOut | -| 11 | Aborted | -| 12 | Ignored | -| 13 | Deleted | -| 14 | Terminated | - -### Get flow outputs - -The operation **Get flow outputs** returns the output of the triggered Power Automate flow. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowOutputs: response.body}`. - -Response example: - -``` -= { - "Output1": "My output value" -} -``` - -## Appendix - -### Using Power Automate Connector best practice - -#### Using Webhook Connector as callback endpoint - -Oftentimes, it is desired to continue the process after a Power Automate flow run finished. You can use the **Callback URL** field if you select the **Trigger a flow run** to specify a URL which will be called after the flow is finished. - -If you wish to continue the Camunda process or start a new one, the [Webhook Connector](/components/connectors/protocol/http-webhook.md) is a good next step. For this, take the following steps: - -1. Create a [Webhook Connector](/components/connectors/protocol/http-webhook.md) and specify the **Webhook ID**. -2. Create a [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md), select the **Trigger a flow run** method, and fill in the fields. - - If you use Camunda 8 SaaS, you can use the following pattern for the **Callback URL**: `{zeebe.client.cloud.region}.{zeebeHostUrl}/{zeebe.client.cloud.clusterId}/inbound/{webhookId}`. - - If you use Camunda 8 SaaS you can find the Zeebe-specific values in you cluster details on the **API** tab under **Client Credentials**. The **webhookId** is the id you specified in the first step, and the **zeebeHostUrl** is connectors.camunda.io. - -#### Get Bearer token with Postman - -1. Allow implicit flow in your [Azure AD app](https://portal.azure.com). - - Go to the **Manifest** tab. - - Set `oauth2AllowImlicitFlow` to `true`. - - Save changes. -2. [Visit the official site](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment) to see how to set up the Postman environment. -3. [Generate an access token](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment#generate-an-access-token-to-use-with-your-environment) and use it in the **Bearer token** field. - -#### How to get the connection name - -1. Go to you [Power Platform admin center](https://admin.powerplatform.microsoft.com), and select [Power Automate app](https://make.powerautomate.com) from the top left menu. -2. In the left menu bar under **Data**, select **Connections > New connection**. -3. Select **Desktop flows** and provide the domain and username of the user on the machine where the desktop flows are running, and also provide the password belongs to this user. -4. Click **Create**. -5. Now, click on the newly created connection, and you can find your connection name in the URL as shown in the example below. The connection name is a part of the URL and is preceded by `connectionName=`. - Example URL: - ``` - https://make.powerautomate.com/enviroments/dw43634dsgsdty45y/connections?apiName=shared_uiflow&connectionName=123453679877564 - ``` - In this example, the connection name is 123453679877564. This is a default connection type. diff --git a/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index c0233e8b0ac..4627dac83f5 100644 --- a/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -46,7 +46,6 @@ import TabItem from "@theme/TabItem"; - [Microsoft Teams Connector](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) - Interactions with [Microsoft Teams](https://www.microsoft.com/microsoft-teams/) from your BPMN process. - [Microsoft 365 Connector](/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md) - Interactions with [Microsoft 365](https://outlook.office.com/mail/) mail from your BPMN process. - [OpenAI Connector](/components/connectors/out-of-the-box-connectors/openai.md) - Interact with [ChatGPT](https://chat.openai.com/) and [OpenAI Moderation API](https://platform.openai.com/docs/guides/moderation/overview). -- [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md) - Orchestrate your [Power Automate](https://powerautomate.microsoft.com) Flows with Camunda. - [RabbitMQ Connector](/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md) - Send messages to [RabbitMQ](https://www.rabbitmq.com/) from your BPMN process. - [Salesforce Connector](/components/connectors/out-of-the-box-connectors/salesforce.md) - Manage your Salesforce instance from your BPMN process. - [SendGrid Connector](/components/connectors/out-of-the-box-connectors/sendgrid.md) - Quickly send emails from your BPMN processes. diff --git a/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/power-automate.md b/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/power-automate.md deleted file mode 100644 index db958188be7..00000000000 --- a/versioned_docs/version-8.2/components/connectors/out-of-the-box-connectors/power-automate.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: power-automate -title: Power Automate Connector -description: Orchestrate your Power Automate desktop flows with Camunda to trigger, get the status, or get the outputs of the flow. ---- - -The **Power Automate Connector** is an outbound Connector that allows you to orchestrate a Power Automate desktop flow from your BPMN process with [Power Automate](https://powerautomate.microsoft.com). - -:::note -This Connector is designed to orchestrate desktop flows only. -::: - -## Prerequisites - -To use the Power Automate Connector, ensure you have configured the following: - -1. [Azure AD application](https://portal.azure.com) with proper permissions. Visit the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory#create-an-application-registration) to see how you can create one. -2. [Create an application user](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) and add security roles. -3. [Power Automate desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install), and sign in to create your Power Automate flow. -4. [Power Automate machine runtime desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/manage-machines#register-a-new-machine) to manage and troubleshoot machine settings, and enable the on-premise data gateway to access your machine data. -5. Power Automate [on-premises data gateway desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install#install-an-on-premises-data-gateway) to create a connection between the cloud environment and your desktop app. - -## Create a Power Automate Connector task - -To use a **Power Automate Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. - -## Operation types - -The Power Automate Connector currently supports three operation types in the **Operation type** dropdown list: _Get the status of a flow run_, _Get flow outputs_, and _Trigger a flow run_. - -### Authentication - -You can choose among the available Power Automate Connector authentication types according to your authentication requirements. - -### Power Automate Connector (bearer token) - -#### Create a new Connector secret - -We advise you to keep your **Bearer Token** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_BEARER_TOKEN`) so you can reference it later in the Connector. - -#### Configure the bearer token - -[Click here](#get-bearer-token-with-postman) to see how to get the Bearer token with Postman. - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **Bearer Token** in the **Authentication** section. -2. Set **Bearer** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_BEARER_TOKEN}}`). - -### OAuth 2.0 - -#### Create a new Connector secret - -We advise you to keep your **Client ID** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_CLIENT_ID`) so you can reference it later in the Connector. - -#### Configure the OAuth Token - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **OAuth 2.0** in the **Authentication** section. -2. Set **Client Id** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_ID}}`). -3. Set **Client secret** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_SECRET}}`). -4. Set **OAuth Token Endpoint** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_TOKEN_ENDPOINT}}`). - -##### OAuth Token Endpoint - -You should provide the **OAuth Token Endpoint** in the following format: https://login.microsoftonline.com/{tanantID}/oauth2/v2.0/token - -Read more on how you can [find your tenantID](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant#find-tenant-id-through-the-azure-portal). - -### Trigger a flow run - -This operation allows you to trigger a Power Automate desktop flow. To execute it, take the following steps: - -1. Select the operation **Trigger a flow run** from the **Operation type** dropdown list. -2. Configure authentication as described in the [authentication](#authentication) section. -3. Fill out the input fields as described in the [configuration](#configuration) section. -4. Fill out the input fields as described in the [input](#input) section. -5. Fill out the response mapping as described in the [trigger a flow run response](#trigger-a-flow-run-response) section. - -#### Trigger a flow run response - -The operation **Trigger a flow run** returns information about the triggered flow. - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowSessionId: response.body.flowsessionId}`. To use operation _Get the status of a flow run_, you need a `flowSessionId`. This expression will add it in the context for you. Learn more in [get the status of a flow run](#get-the-status-of-a-flow-run). - -Response example: - -``` -= { - "@odata.context": "https://org11aaa11a.crm4.dynamics.com/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.RunDesktopFlowResponse", - "flowsessionId": "bb2a1f33-e5b9-ed11-83fe-000d3ab4f483", - "licenseCheck": { - "@odata.context": "#Microsoft.Dynamics.CRM.expando", - "code": "ValidLicenseCoverage", - "message": "Valid License Coverage" - } -} -``` - -#### Configuration - -For this section, you must fill out the **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out the following fields: - -1. **Workflow ID (Flow ID)**: The ID of the Power Automate desktop flow. -2. **Connection name**: Connection to be used with the desktop flow script. You can specify it as connection name or as Connection Reference Logical Name. In the latter case, you have to set the **connectionType** accordingly. [See how to get the connection name](#how-to-get-the-connection-name). -3. **Connection type**: Identifies which type of connection is used in the connection name parameter. Connection type (default), or a connection reference type. -4. **Run mode**: Choose between attended or unattended. -5. **Run priority**: Choose an option (normal, high) or add your own. -6. _(Optional)_ **Inputs**: The desktop flow script input parameters (JSON serialized string). -7. _(Optional)_ **Callback URL**: URL that will be called once the desktop flow script is complete. [See how to use the Webhook Connector](#using-webhook-connector-as-callback-endpoint) as a callback endpoint. - -### Get the status of a flow run - -The operation **Get the status of a flow run** returns information about the newly triggered flow session. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {statusCode: response.body.statuscode}`. - -Response example: - -``` -= { - "@odata.context": "https://[Organization URI]/api/data/v9.2/$metadata#flowsessions(statuscode,statecode,startedon,completedon)/$entity", - "@odata.etag": "W1276122", - "statuscode": 4, - "statecode": 0, - "startedon": "2022-06-16T12:54:40Z", - "completedon": "2022-06-16T12:57:46Z", -} -``` - -Meaning of the different status codes based on the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/entities/flowsession#statuscode-choicesoptions): - -| Status | Statuscode | -| ------ | ------------ | -| 0 | NotSpecified | -| 1 | Paused | -| 2 | Running | -| 3 | Waiting | -| 4 | Succeeded | -| 5 | Skipped | -| 6 | Suspended | -| 7 | Cancelled | -| 8 | Failed | -| 9 | Faulted | -| 10 | TimedOut | -| 11 | Aborted | -| 12 | Ignored | -| 13 | Deleted | -| 14 | Terminated | - -### Get flow outputs - -The operation **Get flow outputs** returns the output of the triggered Power Automate flow. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowOutputs: response.body}`. - -Response example: - -``` -= { - "Output1": "My output value" -} -``` - -## Appendix - -### Using Power Automate Connector best practice - -#### Using Webhook Connector as callback endpoint - -Oftentimes, it is desired to continue the process after a Power Automate flow run finished. You can use the **Callback URL** field if you select the **Trigger a flow run** to specify a URL which will be called after the flow is finished. - -If you wish to continue the Camunda process or start a new one, the [Webhook Connector](/components/connectors/protocol/http-webhook.md) is a good next step. For this, take the following steps: - -1. Create a [Webhook Connector](/components/connectors/protocol/http-webhook.md) and specify the **Webhook ID**. -2. Create a [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md), select the **Trigger a flow run** method, and fill in the fields. - - If you use Camunda 8 SaaS, you can use the following pattern for the **Callback URL**: `{zeebe.client.cloud.region}.{zeebeHostUrl}/{zeebe.client.cloud.clusterId}/inbound/{webhookId}`. - - If you use Camunda 8 SaaS you can find the Zeebe-specific values in you cluster details on the **API** tab under **Client Credentials**. The **webhookId** is the id you specified in the first step, and the **zeebeHostUrl** is connectors.camunda.io. - -#### Get Bearer token with Postman - -1. Allow implicit flow in your [Azure AD app](https://portal.azure.com). - - Go to the **Manifest** tab. - - Set `oauth2AllowImlicitFlow` to `true`. - - Save changes. -2. [Visit the official site](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment) to see how to set up the Postman environment. -3. [Generate an access token](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment#generate-an-access-token-to-use-with-your-environment) and use it in the **Bearer token** field. - -#### How to get the connection name - -1. Go to you [Power Platform admin center](https://admin.powerplatform.microsoft.com), and select [Power Automate app](https://make.powerautomate.com) from the top left menu. -2. In the left menu bar under **Data**, select **Connections > New connection**. -3. Select **Desktop flows** and provide the domain and username of the user on the machine where the desktop flows are running, and also provide the password belongs to this user. -4. Click **Create**. -5. Now, click on the newly created connection, and you can find your connection name in the URL as shown in the example below. The connection name is a part of the URL and is preceded by `connectionName=`. - Example URL: - ``` - https://make.powerautomate.com/enviroments/dw43634dsgsdty45y/connections?apiName=shared_uiflow&connectionName=123453679877564 - ``` - In this example, the connection name is 123453679877564. This is a default connection type. diff --git a/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index 100a647aeb6..b96104be0db 100644 --- a/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -46,7 +46,6 @@ import TabItem from "@theme/TabItem"; - [Microsoft Teams Connector](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) - Interactions with [Microsoft Teams](https://www.microsoft.com/microsoft-teams/) from your BPMN process. - [Microsoft 365 Connector](/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md) - Interactions with [Microsoft 365](https://outlook.office.com/mail/) mail from your BPMN process. - [OpenAI Connector](/components/connectors/out-of-the-box-connectors/openai.md) - Interact with [ChatGPT](https://chat.openai.com/) and [OpenAI Moderation API](https://platform.openai.com/docs/guides/moderation/overview). -- [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md) - Orchestrate your [Power Automate](https://powerautomate.microsoft.com) Flows with Camunda. - [RabbitMQ Producer Connector](/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md) - Send messages to [RabbitMQ](https://www.rabbitmq.com/) from your BPMN process. - [Salesforce Connector](/components/connectors/out-of-the-box-connectors/salesforce.md) - Manage your Salesforce instance from your BPMN process. - [SendGrid Connector](/components/connectors/out-of-the-box-connectors/sendgrid.md) - Quickly send emails from your BPMN processes. diff --git a/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/power-automate.md b/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/power-automate.md deleted file mode 100644 index 030816160a7..00000000000 --- a/versioned_docs/version-8.3/components/connectors/out-of-the-box-connectors/power-automate.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: power-automate -title: Power Automate Connector -description: Orchestrate your Power Automate desktop flows with Camunda to trigger, get the status, or get the outputs of the flow. ---- - -The **Power Automate Connector** is an outbound Connector that allows you to orchestrate a Power Automate desktop flow from your BPMN process with [Power Automate](https://powerautomate.microsoft.com). - -:::note -This Connector is designed to orchestrate desktop flows only. -::: - -## Prerequisites - -To use the Power Automate Connector, ensure you have configured the following: - -1. [Azure AD application](https://portal.azure.com) with proper permissions. Visit the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory#create-an-application-registration) to see how you can create one. -2. [Create an application user](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) and add security roles. -3. [Power Automate desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install), and sign in to create your Power Automate flow. -4. [Power Automate machine runtime desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/manage-machines#register-a-new-machine) to manage and troubleshoot machine settings, and enable the on-premise data gateway to access your machine data. -5. Power Automate [on-premises data gateway desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install#install-an-on-premises-data-gateway) to create a connection between the cloud environment and your desktop app. - -## Create a Power Automate Connector task - -To use a **Power Automate Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. - -## Operation types - -The Power Automate Connector currently supports three operation types in the **Operation type** dropdown list: _Get the status of a flow run_, _Get flow outputs_, and _Trigger a flow run_. - -### Authentication - -You can choose among the available Power Automate Connector authentication types according to your authentication requirements. - -### Power Automate Connector (bearer token) - -#### Create a new Connector secret - -We advise you to keep your **Bearer Token** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_BEARER_TOKEN`) so you can reference it later in the Connector. - -#### Configure the bearer token - -[Click here](#get-bearer-token-with-postman) to see how to get the Bearer token with Postman. - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **Bearer Token** in the **Authentication** section. -2. Set **Bearer** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_BEARER_TOKEN}}`). - -### OAuth 2.0 - -#### Create a new Connector secret - -We advise you to keep your **Client ID** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_CLIENT_ID`) so you can reference it later in the Connector. - -#### Configure the OAuth Token - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **OAuth 2.0** in the **Authentication** section. -2. Set **Client Id** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_ID}}`). -3. Set **Client secret** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_SECRET}}`). -4. Set **OAuth Token Endpoint** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_TOKEN_ENDPOINT}}`). - -##### OAuth Token Endpoint - -You should provide the **OAuth Token Endpoint** in the following format: https://login.microsoftonline.com/{tanantID}/oauth2/v2.0/token - -Read more on how you can [find your tenantID](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant#find-tenant-id-through-the-azure-portal). - -### Trigger a flow run - -This operation allows you to trigger a Power Automate desktop flow. To execute it, take the following steps: - -1. Select the operation **Trigger a flow run** from the **Operation type** dropdown list. -2. Configure authentication as described in the [authentication](#authentication) section. -3. Fill out the input fields as described in the [configuration](#configuration) section. -4. Fill out the input fields as described in the [input](#input) section. -5. Fill out the response mapping as described in the [trigger a flow run response](#trigger-a-flow-run-response) section. - -#### Trigger a flow run response - -The operation **Trigger a flow run** returns information about the triggered flow. - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowSessionId: response.body.flowsessionId}`. To use operation _Get the status of a flow run_, you need a `flowSessionId`. This expression will add it in the context for you. Learn more in [get the status of a flow run](#get-the-status-of-a-flow-run). - -Response example: - -``` -= { - "@odata.context": "https://org11aaa11a.crm4.dynamics.com/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.RunDesktopFlowResponse", - "flowsessionId": "bb2a1f33-e5b9-ed11-83fe-000d3ab4f483", - "licenseCheck": { - "@odata.context": "#Microsoft.Dynamics.CRM.expando", - "code": "ValidLicenseCoverage", - "message": "Valid License Coverage" - } -} -``` - -#### Configuration - -For this section, you must fill out the **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out the following fields: - -1. **Workflow ID (Flow ID)**: The ID of the Power Automate desktop flow. -2. **Connection name**: Connection to be used with the desktop flow script. You can specify it as connection name or as Connection Reference Logical Name. In the latter case, you have to set the **connectionType** accordingly. [See how to get the connection name](#how-to-get-the-connection-name). -3. **Connection type**: Identifies which type of connection is used in the connection name parameter. Connection type (default), or a connection reference type. -4. **Run mode**: Choose between attended or unattended. -5. **Run priority**: Choose an option (normal, high) or add your own. -6. _(Optional)_ **Inputs**: The desktop flow script input parameters (JSON serialized string). -7. _(Optional)_ **Callback URL**: URL that will be called once the desktop flow script is complete. [See how to use the Webhook Connector](#using-webhook-connector-as-callback-endpoint) as a callback endpoint. - -### Get the status of a flow run - -The operation **Get the status of a flow run** returns information about the newly triggered flow session. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {statusCode: response.body.statuscode}`. - -Response example: - -``` -= { - "@odata.context": "https://[Organization URI]/api/data/v9.2/$metadata#flowsessions(statuscode,statecode,startedon,completedon)/$entity", - "@odata.etag": "W1276122", - "statuscode": 4, - "statecode": 0, - "startedon": "2022-06-16T12:54:40Z", - "completedon": "2022-06-16T12:57:46Z", -} -``` - -Meaning of the different status codes based on the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/entities/flowsession#statuscode-choicesoptions): - -| Status | Statuscode | -| ------ | ------------ | -| 0 | NotSpecified | -| 1 | Paused | -| 2 | Running | -| 3 | Waiting | -| 4 | Succeeded | -| 5 | Skipped | -| 6 | Suspended | -| 7 | Cancelled | -| 8 | Failed | -| 9 | Faulted | -| 10 | TimedOut | -| 11 | Aborted | -| 12 | Ignored | -| 13 | Deleted | -| 14 | Terminated | - -### Get flow outputs - -The operation **Get flow outputs** returns the output of the triggered Power Automate flow. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowOutputs: response.body}`. - -Response example: - -``` -= { - "Output1": "My output value" -} -``` - -## Appendix - -### Using Power Automate Connector best practice - -#### Using Webhook Connector as callback endpoint - -Oftentimes, it is desired to continue the process after a Power Automate flow run finished. You can use the **Callback URL** field if you select the **Trigger a flow run** to specify a URL which will be called after the flow is finished. - -If you wish to continue the Camunda process or start a new one, the [Webhook Connector](/components/connectors/protocol/http-webhook.md) is a good next step. For this, take the following steps: - -1. Create a [Webhook Connector](/components/connectors/protocol/http-webhook.md) and specify the **Webhook ID**. -2. Create a [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md), select the **Trigger a flow run** method, and fill in the fields. - - If you use Camunda 8 SaaS, you can use the following pattern for the **Callback URL**: `{zeebe.client.cloud.region}.{zeebeHostUrl}/{zeebe.client.cloud.clusterId}/inbound/{webhookId}`. - - If you use Camunda 8 SaaS you can find the Zeebe-specific values in you cluster details on the **API** tab under **Client Credentials**. The **webhookId** is the id you specified in the first step, and the **zeebeHostUrl** is connectors.camunda.io. - -#### Get Bearer token with Postman - -1. Allow implicit flow in your [Azure AD app](https://portal.azure.com): - - Go to the **Manifest** tab. - - Set `oauth2AllowImlicitFlow` to `true`. - - Save changes. -2. [Visit the official site](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment) to see how to set up the Postman environment. -3. [Generate an access token](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment#generate-an-access-token-to-use-with-your-environment) and use it in the **Bearer token** field. - -#### How to get the connection name - -1. Go to you [Power Platform admin center](https://admin.powerplatform.microsoft.com), and select [Power Automate app](https://make.powerautomate.com) from the top left menu. -2. In the left menu bar under **Data**, select **Connections > New connection**. -3. Select **Desktop flows** and provide the domain and username of the user on the machine where the desktop flows are running, and also provide the password belongs to this user. -4. Click **Create**. -5. Now, click on the newly created connection, and you can find your connection name in the URL as shown in the example below. The connection name is a part of the URL and is preceded by `connectionName=`. - Example URL: - ``` - https://make.powerautomate.com/enviroments/dw43634dsgsdty45y/connections?apiName=shared_uiflow&connectionName=123453679877564 - ``` - In this example, the connection name is 123453679877564. This is a default connection type. diff --git a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/available-connectors-overview.md b/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/available-connectors-overview.md index 47aebd49f97..e6c1bbcb239 100644 --- a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/available-connectors-overview.md +++ b/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/available-connectors-overview.md @@ -46,7 +46,6 @@ import TabItem from "@theme/TabItem"; - [Microsoft Teams Connector](/components/connectors/out-of-the-box-connectors/microsoft-teams.md) - Interactions with [Microsoft Teams](https://www.microsoft.com/microsoft-teams/) from your BPMN process. - [Microsoft 365 Connector](/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md) - Interactions with [Microsoft 365](https://outlook.office.com/mail/) mail from your BPMN process. - [OpenAI Connector](/components/connectors/out-of-the-box-connectors/openai.md) - Interact with [ChatGPT](https://chat.openai.com/) and [OpenAI Moderation API](https://platform.openai.com/docs/guides/moderation/overview). -- [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md) - Orchestrate your [Power Automate](https://powerautomate.microsoft.com) Flows with Camunda. - [RabbitMQ Producer Connector](/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md) - Send messages to [RabbitMQ](https://www.rabbitmq.com/) from your BPMN process. - [Salesforce Connector](/components/connectors/out-of-the-box-connectors/salesforce.md) - Manage your Salesforce instance from your BPMN process. - [SendGrid Connector](/components/connectors/out-of-the-box-connectors/sendgrid.md) - Quickly send emails from your BPMN processes. diff --git a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/power-automate.md b/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/power-automate.md deleted file mode 100644 index 04c9449e6ad..00000000000 --- a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/power-automate.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: power-automate -title: Power Automate Connector -description: Orchestrate your Power Automate desktop flows with Camunda to trigger, get the status, or get the outputs of the flow. ---- - -The **Power Automate Connector** is an outbound Connector that allows you to orchestrate a Power Automate desktop flow from your BPMN process with [Power Automate](https://powerautomate.microsoft.com). - -:::note -This Connector is designed to orchestrate desktop flows only. -::: - -## Prerequisites - -To use the Power Automate Connector, ensure you have configured the following: - -1. [Azure AD application](https://portal.azure.com) with proper permissions. Visit the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory#create-an-application-registration) to see how you can create one. -2. [Create an application user](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) and add security roles. -3. [Power Automate desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install), and sign in to create your Power Automate flow. -4. [Power Automate machine runtime desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/manage-machines#register-a-new-machine) to manage and troubleshoot machine settings, and enable the on-premise data gateway to access your machine data. -5. Power Automate [on-premises data gateway desktop application](https://learn.microsoft.com/en-us/power-automate/desktop-flows/install#install-an-on-premises-data-gateway) to create a connection between the cloud environment and your desktop app. - -## Create a Power Automate Connector task - -To use a **Power Automate Connector** in your process, either change the type of existing task using the wrench-shaped **Change type** context menu, or create a new Connector task using the **Append Connector** context menu. Follow [our guide on using Connectors](/components/connectors/use-connectors/index.md) to learn more. - -## Operation types - -The Power Automate Connector currently supports three operation types in the **Operation type** dropdown list: _Get the status of a flow run_, _Get flow outputs_, and _Trigger a flow run_. - -### Authentication - -You can choose among the available Power Automate Connector authentication types according to your authentication requirements. - -### Power Automate Connector (bearer token) - -#### Create a new Connector secret - -We advise you to keep your **Bearer Token** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_BEARER_TOKEN`) so you can reference it later in the Connector. - -#### Configure the bearer token - -[Click here](#get-bearer-token-with-postman) to see how to get the Bearer token with Postman. - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **Bearer Token** in the **Authentication** section. -2. Set **Bearer** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_BEARER_TOKEN}}`). - -### OAuth 2.0 - -#### Create a new Connector secret - -We advise you to keep your **Client ID** safe and avoid exposing it in the BPMN `xml` file by creating a secret: - -1. Follow our [guide for creating secrets](/components/console/manage-clusters/manage-secrets.md). -2. Name your secret (i.e `POWER_AUTOMATE_CLIENT_ID`) so you can reference it later in the Connector. - -#### Configure the OAuth Token - -Select the **Power Automate Connector** and fill out the following properties under the **Authentication** section: - -1. Click **OAuth 2.0** in the **Authentication** section. -2. Set **Client Id** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_ID}}`). -3. Set **Client secret** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_CLIENT_SECRET}}`). -4. Set **OAuth Token Endpoint** to the secret you created (i.e. `{{secrets.POWER_AUTOMATE_TOKEN_ENDPOINT}}`). - -##### OAuth Token Endpoint - -Provide the **OAuth Token Endpoint** in the following format: https://login.microsoftonline.com/{tanantID}/oauth2/v2.0/token - -Read more on how you can [find your tenantID](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant#find-tenant-id-through-the-azure-portal). - -### Trigger a flow run - -This operation allows you to trigger a Power Automate desktop flow. To execute it, take the following steps: - -1. Select the operation **Trigger a flow run** from the **Operation type** dropdown list. -2. Configure authentication as described in the [authentication](#authentication) section. -3. Fill out the input fields as described in the [configuration](#configuration) section. -4. Fill out the input fields as described in the [input](#input) section. -5. Fill out the response mapping as described in the [trigger a flow run response](#trigger-a-flow-run-response) section. - -#### Trigger a flow run response - -The operation **Trigger a flow run** returns information about the triggered flow. - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowSessionId: response.body.flowsessionId}`. To use operation _Get the status of a flow run_, you need a `flowSessionId`. This expression will add it in the context for you. Learn more in [get the status of a flow run](#get-the-status-of-a-flow-run). - -Response example: - -``` -= { - "@odata.context": "https://org11aaa11a.crm4.dynamics.com/api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.RunDesktopFlowResponse", - "flowsessionId": "bb2a1f33-e5b9-ed11-83fe-000d3ab4f483", - "licenseCheck": { - "@odata.context": "#Microsoft.Dynamics.CRM.expando", - "code": "ValidLicenseCoverage", - "message": "Valid License Coverage" - } -} -``` - -#### Configuration - -For this section, you must fill out the **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out the following fields: - -1. **Workflow ID (Flow ID)**: The ID of the Power Automate desktop flow. -2. **Connection name**: Connection to be used with the desktop flow script. You can specify it as connection name or as Connection Reference Logical Name. In the latter case, you have to set the **connectionType** accordingly. [See how to get the connection name](#how-to-get-the-connection-name). -3. **Connection type**: Identifies which type of connection is used in the connection name parameter. Connection type (default), or a connection reference type. -4. **Run mode**: Choose between attended or unattended. -5. **Run priority**: Choose an option (normal, high) or add your own. -6. _(Optional)_ **Inputs**: The desktop flow script input parameters (JSON serialized string). -7. _(Optional)_ **Callback URL**: URL that will be called once the desktop flow script is complete. [See how to use the Webhook Connector](#using-webhook-connector-as-callback-endpoint) as a callback endpoint. - -### Get the status of a flow run - -The operation **Get the status of a flow run** returns information about the newly triggered flow session. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {statusCode: response.body.statuscode}`. - -Response example: - -``` -= { - "@odata.context": "https://[Organization URI]/api/data/v9.2/$metadata#flowsessions(statuscode,statecode,startedon,completedon)/$entity", - "@odata.etag": "W1276122", - "statuscode": 4, - "statecode": 0, - "startedon": "2022-06-16T12:54:40Z", - "completedon": "2022-06-16T12:57:46Z", -} -``` - -Meaning of the different status codes based on the [official documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/reference/entities/flowsession#statuscode-choicesoptions): - -| Status | Statuscode | -| ------ | ------------ | -| 0 | NotSpecified | -| 1 | Paused | -| 2 | Running | -| 3 | Waiting | -| 4 | Succeeded | -| 5 | Skipped | -| 6 | Suspended | -| 7 | Cancelled | -| 8 | Failed | -| 9 | Faulted | -| 10 | TimedOut | -| 11 | Aborted | -| 12 | Ignored | -| 13 | Deleted | -| 14 | Terminated | - -### Get flow outputs - -The operation **Get flow outputs** returns the output of the triggered Power Automate flow. - -#### Configuration - -For this section, you must fill out **Organization URI**. This is your dynamics 365 URL. [Visit the docs](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/discovery-service) or [learn about environments](https://learn.microsoft.com/en-us/power-platform/admin/environments-overview#environment-details) to see how to find it. - -#### Input - -For this section, you must fill out **Flow session ID**. This is the unique identifier for entity instances. You can find this in the response of the 'Trigger a flow run' method. - -#### Output - -You can use an output mapping to map the response: - -1. Use **Result Variable** to store the response in a process variable. For example, `myResultVariable`. -2. Use **Result Expression** to map fields from the response into process variables. It comes with a pre-filled value of `= {flowOutputs: response.body}`. - -Response example: - -``` -= { - "Output1": "My output value" -} -``` - -## Appendix - -### Using Power Automate Connector best practice - -#### Using Webhook Connector as callback endpoint - -Oftentimes, it is desired to continue the process after a Power Automate flow run finished. You can use the **Callback URL** field if you select the **Trigger a flow run** to specify a URL which will be called after the flow is finished. - -If you wish to continue the Camunda process or start a new one, the [Webhook Connector](/components/connectors/protocol/http-webhook.md) is a good next step. For this, take the following steps: - -1. Create a [Webhook Connector](/components/connectors/protocol/http-webhook.md) and specify the **Webhook ID**. -2. Create a [Power Automate Connector](/components/connectors/out-of-the-box-connectors/power-automate.md), select the **Trigger a flow run** method, and fill in the fields. - - If you use Camunda 8 SaaS, you can use the following pattern for the **Callback URL**: `{zeebe.client.cloud.region}.{zeebeHostUrl}/{zeebe.client.cloud.clusterId}/inbound/{webhookId}`. - - If you use Camunda 8 SaaS you can find the Zeebe-specific values in you cluster details on the **API** tab under **Client Credentials**. The **webhookId** is the id you specified in the first step, and the **zeebeHostUrl** is connectors.camunda.io. - -#### Get Bearer token with Postman - -1. Allow implicit flow in your [Azure AD app](https://portal.azure.com): - - Go to the **Manifest** tab. - - Set `oauth2AllowImlicitFlow` to `true`. - - Save changes. -2. [Visit the official site](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment) to see how to set up the Postman environment. -3. [Generate an access token](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/setup-postman-environment#generate-an-access-token-to-use-with-your-environment) and use it in the **Bearer token** field. - -#### How to get the connection name - -1. Go to you [Power Platform admin center](https://admin.powerplatform.microsoft.com), and select [Power Automate app](https://make.powerautomate.com) from the top left menu. -2. In the left menu bar under **Data**, select **Connections > New connection**. -3. Select **Desktop flows** and provide the domain and username of the user on the machine where the desktop flows are running, and also provide the password belongs to this user. -4. Click **Create**. -5. Now, click on the newly created connection, and you can find your connection name in the URL as shown in the example below. The connection name is a part of the URL and is preceded by `connectionName=`. - Example URL: - ``` - https://make.powerautomate.com/enviroments/dw43634dsgsdty45y/connections?apiName=shared_uiflow&connectionName=123453679877564 - ``` - In this example, the connection name is 123453679877564. This is a default connection type. diff --git a/versioned_sidebars/version-8.1-sidebars.json b/versioned_sidebars/version-8.1-sidebars.json index baf5c009be3..084be2aa4a0 100644 --- a/versioned_sidebars/version-8.1-sidebars.json +++ b/versioned_sidebars/version-8.1-sidebars.json @@ -347,7 +347,6 @@ }, "components/connectors/out-of-the-box-connectors/openai", "components/connectors/out-of-the-box-connectors/operate", - "components/connectors/out-of-the-box-connectors/power-automate", "components/connectors/out-of-the-box-connectors/rabbitmq", "components/connectors/out-of-the-box-connectors/slack", "components/connectors/out-of-the-box-connectors/sendgrid", diff --git a/versioned_sidebars/version-8.2-sidebars.json b/versioned_sidebars/version-8.2-sidebars.json index 5b59fe5e357..6300cdacbf5 100644 --- a/versioned_sidebars/version-8.2-sidebars.json +++ b/versioned_sidebars/version-8.2-sidebars.json @@ -379,7 +379,6 @@ }, "components/connectors/out-of-the-box-connectors/openai", "components/connectors/out-of-the-box-connectors/operate", - "components/connectors/out-of-the-box-connectors/power-automate", "components/connectors/out-of-the-box-connectors/rabbitmq", "components/connectors/out-of-the-box-connectors/salesforce", "components/connectors/out-of-the-box-connectors/slack", diff --git a/versioned_sidebars/version-8.3-sidebars.json b/versioned_sidebars/version-8.3-sidebars.json index e907bf74c3e..0a698dcb8f2 100644 --- a/versioned_sidebars/version-8.3-sidebars.json +++ b/versioned_sidebars/version-8.3-sidebars.json @@ -397,7 +397,6 @@ }, "components/connectors/out-of-the-box-connectors/openai", "components/connectors/out-of-the-box-connectors/operate", - "components/connectors/out-of-the-box-connectors/power-automate", "components/connectors/out-of-the-box-connectors/rabbitmq", "components/connectors/out-of-the-box-connectors/salesforce", "components/connectors/out-of-the-box-connectors/slack", diff --git a/versioned_sidebars/version-8.4-sidebars.json b/versioned_sidebars/version-8.4-sidebars.json index e90a1f962c1..cd55d12c151 100644 --- a/versioned_sidebars/version-8.4-sidebars.json +++ b/versioned_sidebars/version-8.4-sidebars.json @@ -407,7 +407,6 @@ }, "components/connectors/out-of-the-box-connectors/openai", "components/connectors/out-of-the-box-connectors/operate", - "components/connectors/out-of-the-box-connectors/power-automate", "components/connectors/out-of-the-box-connectors/rabbitmq", "components/connectors/out-of-the-box-connectors/salesforce", "components/connectors/out-of-the-box-connectors/slack",