- Release Notes
- Overview
- Getting Started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams Scope
- Create Team
- Create Team From Group
- Get Team
- Get Teams
- Channels
- Create Channel
- Delete Channel
- Get Channel
- Get Channels
- Update Channel
- Chats
- Get Chat
- Get Chats
- Get Chat Members
- Messages
- Get Message
- Get Messages
- Get Message Replies
- Reply To Message
- Send Message
- Events
- Create Event
- Delete Event
- Get Event
- Get Events
- Users
- Get User Presence
- How It Works
- Technical References
- Get Started
- About
- Setup
- Technical References
- Azure Form Recognizer Scope
- Activities
- Analyze Form
- Analyze Form Async
- Get Analyze Form Result
- Analyze Receipt
- Analyze Receipt Async
- Get Analyze Receipt Result
- Analyze Layout
- Analyze Layout Async
- Get Analyze Layout Result
- Train Model
- Get Models
- Get Model Keys
- Get Model Info
- Delete Model
- Connectors
- How to Create Activities
- Build Your Integration
Development Guidelines
For more information related to the process of integrating with UiPath, please access the FAQ at this link.
With respect to development guidelines, please find below the standards for creating a custom activity for the UiPath platform. For reference, the current UiPath integrations are accessible here.
1. Naming
-
Activity packages should be named with one of the following formats:
Company.Product.Activities(e.g. UiPath.Orchestrator.Activities)Company.Product.Feature.Activities(e.g. UiPath.Orchestrator.Webhooks.Activities)
- The
UiPathnamespace is reserved for packages created by UiPath Inc. and may not be used by outside developers. - Scopes should include the company or product name (e.g. Use UiPath Scope instead of Application Scope).
- The category in Studio's activity
panel should be
Company Name > Product Name > Feature Name(e.g. UiPath > Studio > Click).
2. Dependencies
-
Must be referenced in the Dependencies section of the NuGet package. This can be easily done in Nuget Package Explorer or in the packages.config file. In order to keep package sizes to a minimum, do not include dependency DLLs within the package itself unless necessary.
- Use exact package versions (i.e. 1.0.6 not >1.0.6)
3. Icons
-
The package must have an icon.
This may be done via Nuget Package Explorer or directly in the .nuspec file.
- Each activity must have an icon.
See here for instructions on adding icons to your activities.
4. License
-
The package must contain a license and require acceptance of that license. Apache 2.0 is the default and can be found here.
This may be done in Nuget Package Explorer or directly in the .nuspec file.
5. Descriptions
-
A summary description must be added to the package, either through Nuget Package Explorer or directly in the .nuspec file.
-
Each activity in the package must have a summary description. This may be added in the DesignerMetadata.cs file. See here for instructions on how to do so.
-
Each property / argument within an activity must have a description.
- Descriptions on the fields of custom classes are useful as well, but not required.
6. Miscellaneous
- The stable version of UiPath Studio at the time of release must be supported.
- Internationalization is preferred, but not required.
