通知を受け取る

UiPath Studio

UiPath Studio ガイド

オートメーション プロジェクトについて

UiPath Studio allows you to create two types of standalone automation projects: process or library. Processes can incorporate all types of workflows, sequence, flowchart, state machine and global exception handler, while the global exception handler isn't available for libraries. Moreover, libraries can be added as dependencies to automation processes.

Studio で新しいプロセスを開始すると、選択した場所にカスタム名でフォルダーが作成されます。プロジェクトは、手動で保存場所を変更しないかぎり、既定では %USERPROFILE%\Documents\UiPath ディレクトリに保存されます。

プロジェクト フォルダーには、既定で以下のファイルとサブフォルダーが含まれます。

  • ファイル
    • Main.xaml - Created by default to hold your main workflow. In addition, all the other automation XAML files you add to the project are stored in the project folder. Optionally, you can set a different file as main. All the files must be linked through the Invoke Workflow File activity to the file set as main or to a file marked as an entry point to the project. In the case of test projects created in Studio Pro, a TestCase.xaml file is created by default instead of Main.xaml.
    • project.json オートメーション プロジェクトに関する情報が含まれています。
  • サブフォルダー
    • .entities - プロジェクト内で Data Service からインポートされるエンティティが使用されている場合に、そのエンティティに関するデータが含まれています。
    • .local - ローカルにキャッシュされるプロジェクト データが含まれています。
    • .objects - プロジェクト内でオブジェクト リポジトリに追加されたアイテムが使用されている場合に、そのアイテムに関するデータが含まれています。
    • .screenshots - プロジェクト内で UI Automation アクティビティで生成されるスクリーンショットが使用されている場合に、そのスクリーンショットが含まれています。
    • .settings - 実行時に使用される、アクティビティのプロジェクト設定が含まれています。
    • .tmh - プロジェクト内でテスト ケースが使用されている場合、そのテスト ケースに関するデータが含まれています。

📘

重要:

新しいバーションの Studio で作成したプロジェクトは古いバージョンの Studio では実行できない場合があります。詳しくは、「相互運用性」をご覧ください。

プロジェクト言語を設定する

Studio および StudioX のプロファイルで作成されたプロジェクトでは、式に VB.NET 言語を使用します。

Studio Pro のプロファイルでは、新しいプロジェクトを作成するときに VB か C# を選択できます。既定で選択される言語は VB ですが、[ホーム] (Studio の Backstage ビュー) > [設定] > [デザイン] から、C# を新しいプロジェクトの既定の言語に設定することもできます。C# プロジェクトは Studio Pro のプロファイルからしか開くことができないので、注意してください。

同じプロジェクト内で VB と C# の両方の式を使用することはできません。C# ワークフローでの VB の式の使用もサポートされていません (逆も同様)。他のプロジェクトからのアクティビティのコピー アンド ペースト、ワークフローの呼び出しまたはインポートを行うときは、必ずプロジェクトと同じ言語を使用してください。

C# ライブラリを依存関係として VB プロジェクトにインストールできます (逆も同様)。ただし、ライブラリがインストールされているプロジェクトから、言語固有の式を使用してライブラリ プロジェクトの引数に定義されている既定値にアクセスすることはできません。

C# の制限事項

  • 現在の C# の実装は C# バージョン 5 を使用する C# コンパイラに基づいています。したがって、合体代入、null 条件演算子、null 合体演算子、文字列補間などの新機能の利用が制限されます。
  • インクリメント付きの式を含むプロジェクトは無効です。
  • nameof() 演算子を含む式は無効としてマークされ、C# の現在の実装では許可されません。
  • オプションの引数を使用したメソッド呼び出しを含む式には、オプションの引数の値を含める必要があります。
  • C# プロジェクトのデザイン時と実行時のパフォーマンスは VB.NET プロジェクトに比べて低いため、実行時のパフォーマンスを重要視する場合は C# ではなく VB.NET の使用をお勧めします。

プロジェクト バージョンを設定する

セマンティック バージョン管理

セマンティック バージョン管理スキームは、Major.Minor.Patch[-Suffix] という形式です。ここで、

  • Major は、メジャーバージョンです。
  • Minor は、マイナーバージョンです。
  • Patch は、パッチバージョンです。
  • -Suffix (任意) は、パッチバージョンに続いて、ハイフンの後にドットで区切られた識別子が付加されます。これは、プレリリースバージョンを表します。

識別子は、ASCII 英文字とハイフンのみで指定してください。空欄にすることはできません。数値識別子は、0を先頭につけることはできません。また、ビルドのメタデータは、パッチバージョンまたはプレリリースバージョンの後にハイフンが続き、その後にプラス記号が付加された構成になることがあります (例: 1.0.0-alpha+1)。

新しいプロセスやライブラリの作成する場合、既定のスキームはセマンティックです。この設定は、[パブリッシュ] ウィンドウでバージョン番号に数字を追加すれば、変更できます。このプロジェクトのセマンティック バージョンは、project.json ファイルからも変更できます。バージョン番号 major.minor に、パッチ番号 0 が自動的に追加されます。

レガシーバージョン管理

プロジェクトにより生成されるレガシーのバージョン番号の形式は、「M.m.bbbb.rrrrr」です。それぞれの意味は次のとおりです。

  • M はメジャーバージョンです。
  • m はマイナーバージョンです。
  • bbbb はビルドバージョンです。
  • rrrrr はリビジョンバージョンです。

メジャーバージョンとマイナーバージョンは project.json ファイルでも編集できますが、ビルドバージョンとリビジョンバージョンはアルゴリズムに従って生成されます。ビルドの値は、2000年1月1日からの経過日数です。リビジョンの値は、現時点からリリース時までに経過した秒数です。この結果を2で割って、リビジョン番号が65535を超えないようにします。

[パブリッシュ] ウィンドウに候補として表示されるバージョン番号は、このプロジェクトの以前のバージョン管理スキームに基づいて生成されています。タイムスタンプは、4 桁のバージョン管理スキームを使用するプロジェクトを考慮に入れたものです。

プロジェクトを管理する

392

[プロジェクト] パネルでは、現在のプロジェクトの内容の確認、フォルダーの追加、ファイルの場所を開く、依存関係の管理、プロジェクト設定の調整などの操作が行えます。

1444

ファイル エクスプローラーから [プロジェクト] パネルに直接ファイルをコピー アンド ペーストできます。.xaml ワークフローを含む 1 つまたは複数のファイルに対して、同じ操作をドラッグ アンド ドロップによって実行することも可能です。ショートカットの Ctrl + C および Ctrl + V を使用しても、ファイルをコピーして、ツリーの任意の場所に複製できます。

OptionDescription
Expand Allexpand_allExpands all nodes in the automation project.
Collapse Allcollapse_allCollapses all nodes in the automation project.
RefreshrefreshRefreshes the project.
Show All Filesshow_filesShows all files belonging to the automation project, including the project.json.
File Explorerfile_explorerOpens the project's location on the machine.
Project Settingsproject_settingsOpens the Project Settings window for processes or libraries.
Remove Unused Screenshotsremove_screenshotsRemoves screenshots that aren't used when running the automation project.

プロジェクトのコンテキスト メニュー

[プロジェクト] パネルの任意の場所を右クリックすると、コンテキスト メニューが開きます。このコンテキスト メニューには、以下の表に示すオプションが表示されます。利用可能なオプションは、パネル内のどこを右クリックするかと、プロジェクトの種類、およびプロジェクトがソース管理に追加されるかどうかによって異なります。

OptionDescription
Open Project FolderOpens the local folder containing the project.
Project SettingsOpens the Project Settings window for adjusting project preferences.
AddOpens a list of items that can be added to the project: folder, sequence, flowchart, state machine or global handler.
Import WorkflowsImports .xaml files to the project and adds Imported in the file name if it coincides with the name of the main file.
Import FilesOpens the File Explorer window for importing various files into your project.
Add to Source ControlAdds the current project to source control using Git Init, Copy to Git, Add to TFS, or Add to SVN options. Please note that this option is only visible when right-clicking the project node.
When a project is added to source control, additional options are available in the context menu. See the options for GIT and the options for SVN and TFS.
OpenOpens the selected files using the default program.
Open File LocationOpens the local folder containing the file.
RenameEnables you to rename the selected file or folder, and opens the Rename Item window. The item is renamed in all occurrences.
DeleteDeletes the selected item only from your local machine.
Select for CompareSelects the current file for comparison.
Compare with SelectedCompares the current file with the previously selected file using Compare Files.
Find ReferencesFinds all references to the file in the project. The results are displayed in the Find References panel.
Debug FileDebugs the selected .xaml file.
Set as MainSets the selected .xaml file as Main in the project definition, meaning that the project execution starts with that file. There can only be one Main project file. The name of the file set as main appears in bold in the Project panel.
PropertiesOpen the library’s Properties window for adding a tooltip and Help Link.
Set as Global HandlerSets the .xaml file as the Global Exception Handler for the project. This is applicable to one workflow per project/process.
Remove HandlerRemoves the Global Exception Handler tag from the .xaml file.
Enable Entry PointMarks the selected workflow file as an entry point for the process, making it possible to select it as the workflow to run first when using the Invoke Process and Run Parallel Process activities in other processes.
Notes:
When a file is marked as an entry point, an arrow is displayed on the icon next to the file name icon_enable_entry_point.
Enabling a file that is ignored from publishing as an entry point sets the file as publishable.
This option is not available for test case files.
This option is not available in library projects.
Disable Entry PointNo longer marks the selected workflow file as an entry point for the process. This option is not available for the workflow file that is set as Main.
Ignore from PublishMarks one or more selected files as excluded from publishing.
Notes:
When a file is ignored from publishing, the icon next to the file name turns gray icon_ignore_publish.
Ignoring a file marked as an entry point from publishing disables the entry point.
In a library project, a file that is ignored from publishing is included in the package, but no reusable component is created and made available in the Activities panel in projects where the library is installed as a dependency.
Set as PublishableMarks one or more selected files that are excluded from publishing as publishable.

Git のコンテキスト メニュー オプション

Git リポジトリに追加されたプロジェクトでは、[プロジェクト] パネルの各ファイルの横にファイルのステータスを示すアイコンが表示されます。
git branch The file is synced with the repository.
git edited The file has been modified.
source control added The file has been added.

Right-click a file or project node in the Project panel to open the GIT-specific context menu for Managing Projects with GIT.

234
OptionDescription
CommitCommits current changes to the local GIT repository.
PushPushes the current version onto the remote repository.
Pull (rebase)Pulls remote files and rebases the current branch.
Manage BranchesOpens the GIT window with options for managing currently added branches.
Show ChangesOpens the File Diff window for comparing changes between the local version and the remote version of the file.
Show HistoryOpens the Show History window for comparing two versions of the same file.
UndoOpens the Undo Pending Changes window if the file was not committed or pushed to the remote repository.

SVN と TFS のコンテキスト メニュー オプション

SVN または TFS リポジトリに追加されたプロジェクトは、 [プロジェクト] パネル内の各ファイルの横にアイコンが表示され、ファイルのステータスを示されます。
svn locked The file is not checked out for editing.
svn checked out The file has been checked out for editing.
svn edited The file has been edited.
source control added The file has been added.

Right-click a file or project node in the Project panel to open the context menu with options specific to managing projects with TFS or SVN.

233
OptionDescription
Open Opens the selected .xaml file in the Designer panel, in read-only mode if it was not checked out for edit from the TFS/SVN repository.
Rename Enables you to rename the selected file or folder, and opens the Rename Item window. When checking in the renamed .xaml file, the previously modified version must also be checked in.
Delete Deletes the selected item only from your local machine. The latest checked in version of the file is still available in the TFS/SVN repository.
Check Out For EditMarks the selected file or folder as locked for editing. Checking out a file locks it on the server so that no one else can edit it.
Finish EditingChecks in the project.json file in the respository, together with changes and a commit message.
Add Uploads the selected item to the TFS/SVN server. This option is not available, if the item was previously uploaded to the server.
Get Latest Version Downloads the latest version of the selected item from the TFS/SVN repository.
Show changes...Opens the File Diff to compare changes between the versioned file and the one mapped locally.
Check In Displays the Check In Changes window and enables you to upload the selected item to the server as the newest version. The .xaml file must be saved before uploading it. After it’s checked in, the file becomes read-only in Studio.
Undo Displays the Undo Pending Changes window and enables you to Revert the changes done to the project, either revert modified files to previous or unversioned states, or retrieve files which were deleted from the local machine.

Changes cannot be reverted after the file was checked in.
RunRuns the selected workflow, even if it's not checked out or added to the repository.
Set as MainSets the selected .xaml file as Main in the project. The first created .xaml is set as Main by default.

プロジェクト設定を調整する

作業中のオートメーション プロジェクトごとに、一連の設定を個別に作成できます。これらの設定は [プロジェクト設定] ウィンドウで行えます。[プロジェクト設定] ウィンドウを開くには、[プロジェクト] パネルの settings_icon をクリックします。

880

[設定] ウィンドウのフィールドの説明

FieldDescription
NameChange the name of the project. Such names may contain whitespace characters. When naming projects, keep in mind that whitespace characters are removed at publish time. This field accepts up to 128 characters.
DescriptionChange the project description. This field accepts up to 500 characters.
Disable PauseEnable or prevent users from pausing processes in the Robot tray. Set to Yes if pausing the process during execution would result in crashing it. For example, if an activity in your workflow uses the Timeout property, pausing the execution might cause the timeout to expire, thus breaking the execution.
Starts in BackgroundSet to Yes to turn the project in a Background Process and allow it to run in the background concurrently with other processes, as long as it does not use UI interaction.
Supports PersistenceSet to Yes to turn the project in an Orchestration Process.
PiP Ready Set to Yes to indicate that the project was tested using Picture in Picture. If set to No, the option to use this feature is not available for the process.
Starts in PiP Set to Yes to indicate that the process should be run by default using the Picture in Picture feature.
Modern Design Experience Set to Yes to enable a modern experience of working with UI Automation, including new and improved activities, recorders, and wizards, as well as the Object Repository.

[OK] をクリックすると、[プロジェクト] パネルと project.json ファイルに変更が表示されます。

プロジェクト レベルでアクティビティのプロパティを調整する方法については、「アクティビティのプロジェクト設定を行う」をご覧ください。

📘

注:

Windows Workflow Foundation の制限により、大量のアクティビティを 1 つのシーケンスから別のシーケンスにコピーする場合は必ず、下にスクロールして、あらかじめ [Designer] パネルを開いておくことをお勧めします。

1 年前に更新


オートメーション プロジェクトについて


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。