docs(custom-connector): step by step guide on how to create a custom connector based on the rest connector #5202
Conversation
…connector based on the rest connector
|
👋 🤖 🤔 Hello, @mathias-vandaele! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - **Icon**: Optionally, upload a custom icon with supported formats: SVG, PNG, and JPEG. | ||
| 3. Click `Create Template` to save the new connector template. | ||
|
|
||
| ## Step 4: Customize the New Connector Using the Element Template Editor |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[all.glossary] Inconsistent spelling detected. Use Element template instead of Element Template. Review the WCoE glossary - https://confluence.camunda.com/x/b5RZBw .
| @@ -0,0 +1,97 @@ | |||
|
|
|||
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Click `New Diagram`. | ||
| - Name your diagram and click `Create`. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Click `New Diagram`. | |
| - Name your diagram and click `Create`. | |
| - Click `New Diagram`. | |
| - Name your diagram and click `Create`. |
| - Click on the task element. | ||
| - Select the wrench icon to change the element type and choose `REST Outbound Connector` from the Connectors section. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Click on the task element. | |
| - Select the wrench icon to change the element type and choose `REST Outbound Connector` from the Connectors section. | |
| - Click on the task element. | |
| - Select the wrench icon to change the element type and choose `REST Outbound Connector` from the Connectors section. |
| - Click on the task element. | ||
| - Select the wrench icon to change the element type and choose `REST Outbound Connector` from the Connectors section. | ||
| 3. Configure the REST Connector: | ||
| - In the properties panel, fill out the required fields such as Authentication URL, HTTP method, and any headers or payload needed for the API request. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - In the properties panel, fill out the required fields such as Authentication URL, HTTP method, and any headers or payload needed for the API request. | |
| - In the properties panel, fill out the required fields such as Authentication URL, HTTP method, and any headers or payload needed for the API request. |
| ## Step 3: Save the REST Connector as a New Connector Template | ||
|
|
||
| 1. With the REST Connector task selected, open the element template editor: | ||
| - Click the `Save as Template` button. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Click the `Save as Template` button. | |
| - Click the `Save as Template` button. |
| - Set `resource` as a `Dropdown`. | ||
| - Set `index` as a `String`. | ||
|  |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Set `resource` as a `Dropdown`. | |
| - Set `index` as a `String`. | |
|  | |
| - Set `resource` as a `Dropdown`. | |
| - Set `index` as a `String`. | |
|  |
|  | ||
|
|
||
| 8. **Add an Icon** | ||
| - Enhance your connector's visual appeal by adding an appropriate icon. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Enhance your connector's visual appeal by adding an appropriate icon. | |
| - Enhance your connector's visual appeal by adding an appropriate icon. |
|  | ||
|
|
||
| 9. **Publish the Connector** | ||
| - Once all configurations are complete, click on `Publish` to make your connector available for use. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - Once all configurations are complete, click on `Publish` to make your connector available for use. | |
| - Once all configurations are complete, click on `Publish` to make your connector available for use. |
|  | ||
|
|
||
| 10. **Access Your New SWAPI Connector** | ||
| - The newly published SWAPI connector is now ready for use in your BPMN workflows. |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| - The newly published SWAPI connector is now ready for use in your BPMN workflows. | |
| - The newly published SWAPI connector is now ready for use in your BPMN workflows. |
|
|
||
| ## Conclusion | ||
|
|
||
| By following these detailed steps, you have successfully created a reusable connector template based on the REST connector. This template streamlines interactions with the specified REST API and ensures consistency and standardization across different BPMN workflows. Enjoy integrating the power of the Star Wars API into your business processes! |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| By following these detailed steps, you have successfully created a reusable connector template based on the REST connector. This template streamlines interactions with the specified REST API and ensures consistency and standardization across different BPMN workflows. Enjoy integrating the power of the Star Wars API into your business processes! | |
| By following these detailed steps, you have successfully created a reusable connector template based on the REST connector. This template streamlines interactions with the specified REST API and ensures consistency and standardization across different BPMN workflows. Enjoy integrating the power of the Star Wars API into your business processes! |
akeller
added
available & undocumented
|
@mathias-vandaele, this is currently only changing the 8.8 docs. Do you also mean to change 8.7 and 8.6? I ask because you mention this is available but undocumented. What versions can you use it in? |
@akeller Yes It should also be added for I will add it to |
|
@mathias-vandaele I'll take a look at this for you as discussed 👍 |
Description
Provides a step by step guide on how to create a custom connector based on the REST connector
When should this change go live?
ASAP
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
/docsdirectory (version 8.8)./versioned_docs/version-8.7/directory (version 8.7)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.