sdk
latest
false
Developer Guide
Last updated Mar 23, 2024

Configuring the activity metadata

You can define key activity metadata such as category, name, description, or icon in the file ActivitiesMetadata.json located in the Resources folder. This metadata is used by UiPath Studio and Studio Web to discover the activities defined in the activity DLL.

See the following table for a description of available properties. The same requirements that apply to custom libraries metadata also apply to custom activity metadata.

PropertyDescription
resourceManagerName
The resource manager used to get the resource keys. The key for the resource manager is defined in the file Resources.Designer.cs. You can find it in public static global::System.Resources.ResourceManager ResourceManager.
For example: UiPath.Activities.Template.Resources.Resources
fullNameThe full name of the activity.
shortNameThe short name of the activity.
displayNameKeyThe display name of the activity.
descriptionKeyThe activity description.
categoryKeyThe name of the category under which to place the activity in the Activities panel in Studio.
iconKeyThe icon of the activity. The file must be located in the Resources/Icon folder.
viewModelType
The class to use as the ViewModel (UI definition) for this activity. It follows the pattern: {namespace}.{className}.
For example: UiPath.Activities.Template.ViewModels.ActivityTemplateViewModel
For example, for the Calculator activity, the file looks as follows:
{
  "resourceManagerName": "UiPath.Examples.Activities.Resources.Resources",
  "activities": [
    {
      "fullName": "UiPath.Examples.Activities.Calculator",
      "shortName": "Calculator",
      "displayNameKey": "Calculator_DisplayName",
      "descriptionKey": "Calculator_Description",
      "categoryKey": "Examples",
      "iconKey": "calculator.svg",
      "viewModelType": "UiPath.Examples.Activities.ViewModels.CalculatorViewModel"
    }
  ]
}{
  "resourceManagerName": "UiPath.Examples.Activities.Resources.Resources",
  "activities": [
    {
      "fullName": "UiPath.Examples.Activities.Calculator",
      "shortName": "Calculator",
      "displayNameKey": "Calculator_DisplayName",
      "descriptionKey": "Calculator_Description",
      "categoryKey": "Examples",
      "iconKey": "calculator.svg",
      "viewModelType": "UiPath.Examples.Activities.ViewModels.CalculatorViewModel"
    }
  ]
}
The displayNameKey and descriptionKey ID's are defined in the file Resources.Designer.cs and the values are defined in the file Resources.resx.
In Studio, the configuration results in the following:


1 - Category (categoryKey)
2 - Display name (displayNameKey)
3 - Description (descriptionKey)
4 - Icon (iconKey)

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.