Subscribe

UiPath Studio

The UiPath Studio Guide

About the Project.Json File

Project.json is an automatically generated file which is created for each .xaml file marked as Main in the project folder.

The file holds varied information, including project dependencies, or web services loaded in libraries. For more information about web services in libraries, check out the Loading Web Services in Libraries page.

📘

Important:

Manually editing the project.json file should be attempted for troubleshooting scenarios only, as it may lead to severe consequences and loss of support.
As of 2018.2, you should specify a project.json file when running your project from the UiRobot.exe (command line) client.

The parameters contained in the Project.json file are described in the following table.

ParameterDescription
nameThe title of the automation project. It is provided in Studio when creating a new process or library.
descriptionThe description of the project. It is provided in the Description field in Studio when a new project is created.
mainThe entry point of the automation project. It consists of an .xaml file. The default name is “Main.xaml”. It is displayed both as the title of the Designer panel and in the Properties panel in Studio. If you want to execute a different project first, change the value of this parameter to the name of the .xaml file to be processed.
Note: If your automation project contains multiple files, each of them should be linked to the Main.xaml file through the Invoke Workflow File activity. This is especially useful when the project is published to Orchestrator and sent to a Robot, as the Robot executes only the file provided in this parameter.
dependenciesThe activities packages used to create the automation project and their versions. The list is updated every time a dependency is added or removed from the project, or when a package version changes.
Note: Version numbers are composed of the following parts, in order: major, minor, build, and revision. The build value is the number of days that elapsed since 01.01.2000. The revision value is the number of seconds which elapsed on the day of the release, starting from 5 AM, GMT.
webServices- namespace - The name of the service provided in the Add new service window for libraries.
- serviceDocument - The path to the .xml or .json file containing metadata for the SOAP or Swagger service. The file is used when the service is repaired, and should be versioned as part of the project.
- webDocumentUri - The file path or link to the Swagger or SOAP resource (provided when the service is created in the Add new service window).
- uniqueReference - A reference needed for versioning the service.
entitiesStores- serviceDocument - The path to the local entities file.
- tenantName - The tenant where the Data Service resides.
- namespace - The namespace under which the entities are imported (the project namespace).
- uniqueReference - A reference needed for versioning the service.
schemaVersionThe version of the project.json file.
studioVersionThe version of Studio used to create the automation project. This parameter is updated with the Studio version in which the latest changes were made.
projectVersionThe version used when publishing this project to a feed. Represents the one set in the Publish window.
runtimeOptions- exceptionHandlerWorkflow - The runtime exception handler for the process.
- autoDispose - Whether the process supports disposing of IDisposable objects to free up system resources.
- netFrameworkLazyLoading - The option to load referenced assemblies only if they are used in the project.
- isPausable - Whether pause is enabled for the process
- isAttended - Whether the process allows unattended executions.
- requiresUserInteraction - Whether the process is a background process.
- supportsPersistence - Whether the process is a long running process.
- excludedLoggedData - Contains keywords that can be added to the name of an activity to prevent variable and argument values from being logged at the Verbose level. That can also be achieved by selecting the Private checkbox of any activity. Read more about the protection of sensitive information here.
- executionType - The process execution type.
- readyForPiP - Whether the process is marked as PiP ready.
- startsInPiP - Whether the process is configured to start in PiP.
- mustRestoreAllDependencies - Whether all project dependencies are restored.
- pipType - The type of PiP used in the process.
designOptions- projectProfile - The Studio profile used when the project was created, either Business (StudioX) or Development.
- outputType Shows the project type, either Process, Library, or Tests.
- libraryOptions
- includeOriginalXaml - Whether to include original workflow files in the resulting .nupkg file.
- privateWorkflows - The full name of private .xaml files contained in the library.
- processOptions
- ignoredFiles - List of RPA workflow files ignored from publishing.
- fileInfoCollection - Contains the following information for each test case file in the process: editingStatus (Publishable or InProgress), testCaseId, and fileName.
- modernBehavior - Whether the process is configured to use the Modern Design Experience.
argumentsContains the following information for each input and output argument defined in the workflow file that is set as Main: name, type, whether it is required, and whether it has a default value (hasDefault).
Note: Arguments information is added only to the file in the .nupkg package after publishing.
expressionLanguageThe language set for the process (VisualBasic or CSharp).
entryPointsContains the following information for each file marked as an entry point to the process filePath,
uniqueId. and the following information for each input and output argument in the file: name, type, whether it is required, and whether it has a default value (hasDefault).
Note: Arguments information is added only to the file in the .nupkg package after publishing.
isTemplateWhether the project is a template.
templateProjectDataContains the following information for template projects:
- defaultProjectDescription - The default project description for processes based on the template.
- defaultProjectName - The default project name for processes based on the template.
targetFrameworkThe target framework set for the project (Legacy, Windows, or Portable).

The following is an example of the contents of a project.json file included in a package published from Studio.

{
  "name": "UI-40028",
  "description": "Blank Process",
  "main": "Flowchart.xaml",
  "dependencies": {
    "UiPath.Excel.Activities": "[2.9.3]",
    "UiPath.Mail.Activities": "[1.9.3]",
    "UiPath.System.Activities": "[20.10.1]",
    "UiPath.UIAutomation.Activities": "[20.10.6]"
  },
  "webServices": [],
  "entitiesStores": [],
  "schemaVersion": "4.0",
  "studioVersion": "20.10.2.0",
  "projectVersion": "1.0.1",
  "runtimeOptions": {
    "autoDispose": false,
    "isPausable": true,
    "requiresUserInteraction": true,
    "supportsPersistence": false,
    "excludedLoggedData": [
      "Private:*",
      "*password*"
    ],
    "executionType": "Workflow",
    "readyForPiP": false,
    "startsInPiP": false
  },
  "designOptions": {
    "projectProfile": "Developement",
    "outputType": "Process",
    "libraryOptions": {
      "includeOriginalXaml": false,
      "privateWorkflows": []
    },
    "processOptions": {
      "ignoredFiles": []
    },
    "fileInfoCollection": [],
    "modernBehavior": false
  },
  "arguments": {
    "input": [
      {
        "name": "argument1",
        "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "required": false,
        "hasDefault": false
      },
      {
        "name": "argument2",
        "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
        "required": false,
        "hasDefault": false
      }
    ],
    "output": []
  },
  "expressionLanguage": "VisualBasic",
  "entryPoints": [
    {
      "filePath": "Main.xaml",
      "uniqueId": "5289efb0-f8bc-42f3-8cf4-0caa3a7d1915",
      "input": [
        {
          "name": "argument1",
          "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
          "required": false,
          "hasDefault": false
        },
        {
          "name": "argument2",
          "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
          "required": false,
          "hasDefault": false
        }
      ],
      "output": []
    },
    {
      "filePath": "Flowchart.xaml",
      "uniqueId": "d0904ba0-506e-437d-979c-b9da4325faad",
      "input": [
        {
          "name": "argument1",
          "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
          "required": false,
          "hasDefault": false
        },
        {
          "name": "argument2",
          "type": "System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
          "required": false,
          "hasDefault": false
        }
      ],
      "output": []
    }
  ],
  "isTemplate": false,
  "templateProjectData": {},
  "publishData": {}
}

Updated 7 days ago

About the Project.Json File


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.