VS Code のフロー

UiPath for Visual Studio Code 拡張機能をインストールして構成し、ローカル ワークスペースからフローを構築、デバッグ、デプロイできるようにします。

概要

UiPath for Visual Studio Code 拡張機能を使用すると、VS Code からフローを構築、デバッグ、デプロイできます。.flow ファイル用のビジュアル エディターが付属し、UiPath にサインインし、作業内容をパッケージ化して Orchestrator にパブリッシュします。

キャンバス、ノード、変数、デバッグは、Studio Web と同じように機能します。このページでは、VS Code に固有の内容 (拡張機能のインストール、サインイン、ローカル ワークスペースからのパッケージ化) について説明します。フローの構築方法については、このガイドの残りの部分、 最初のフローから始めて、こちらをご覧ください。

開始する前に

以下が必要です。

• VS Code 1.110.0 以降。
• UiPath アカウント。
• Node.js と npm は PATHで利用可能です。初回サインイン時に、拡張機能は npm (npm install -g @uipath/cli) を使用して UiPath CLI (uip) をインストールします。
• UiPath 環境へのネットワーク アクセス。

注:

VS Code での Data Fabric エンティティの作成と編集はプレビュー機能です。VS Code でのみ使用できます。Studio Web でエンティティ プロジェクトを含むソリューションを開くことはできますが、エンティティ自体を編集することはできません。

拡張機能が実行される場所は、拡張機能の設定方法にも影響します。以下の注意事項は、ローカル マシンではなくリモート環境で作業する場合に適用されます。

注:

リモート ワークスペース (Windows Subsystem for Linux (WSL)、SSH、Codespace、または開発コンテナー) では、拡張機能はリモート ホストで実行されます。UiPath CLI は、ローカル マシンではなく、ローカル マシンにインストールする必要があります。

拡張機能をインストールする

1. VS Code Marketplace または Open VSX レジストリ から UiPath Maestro をインストールします。
2. プロンプトが表示されたら、VS Code を再読み込みします。
3. アクティビティ バーの [ UiPath ] アイコンを選択して、[UiPath] ビューを開きます。

UiPath ビューには次の 3 つのセクションがあります。

• [接続 ] には、サインイン ステータス、環境、テナントが表示されます。
• ソリューション エクスプローラー には、ワークスペース内のソリューション、プロジェクト、およびフローが一覧表示されます。
• リソース : サインインすると、選択したテナントのフォルダーと Orchestrator リソースが一覧表示されます。

サインイン

拡張機能は、バンドルされた UiPath 認証ライブラリを使用してプロセス内でサインインし、OAuth/Proof Key for Code Exchange (PKCE) ブラウザー フローを実行します。拡張機能によってトークンが保存されることはありません。

1. [ 接続 ] セクションで [ サインイン] を選択します。
2. CLI がまだインストールされていない場合は、プロンプトを受け入れてインストールします。この拡張機能は npm install -g @uipath/cli実行されます。
3. ブラウザーが開き、サインインが完了します。認証ライブラリは、ポート 8104でコールバックlocalhost受信します。
4. 承認したら、VS Code に戻ります。それ以降は、セッションは自動的に更新されます。

サインアウトするには、[接続] セクションで [サインアウト] を選択します。これにより、プロセス内でサインアウトされ、キャッシュされたセッションがクリアされます。

注:

サインインでは、OAuth コールバックにポート 8104 on localhost を使用します。サインインに失敗する場合は、古いプロセスによってポートが保持されている可能性があります。解放してもう一度やり直してください。macOS または Linux の場合は、 lsof -ti :8104 | xargs kill -9を実行します。Windows では、 netstat -ano | findstr :8104 を実行してプロセス ID を見つけてから、 taskkill /F /PID <id>を実行します。

環境とテナントを選択する

サインイン後、作業する場所を選択します。

1. UiPath を実行します。[環境] を選択して、環境を確認します。既定値は Cloud です。
2. UiPath を実行します。[テナント] を選択して、テナントまたは組織を選択します。

[ リソース] セクションでは、選択したテナントのフォルダーとリソースを参照できます。

結果: [リソース] セクションには、選択したテナントのフォルダーと Orchestrator リソースが表示されます。

フローを作成または開く

• 実行 フロー: 新しいフロー (Ctrl/Cmd+Alt+N) を使用して、新しい .flow ファイルを作成します。
• エクスプローラーから既存の .flow ファイルを開くか、 フロー: [フローを開く ] (Ctrl/Cmd+Alt+O) を実行します。
• ソリューションを開いた状態で、ソリューション エクスプローラーのタイトル バーで [フローを追加] を選択して、アクティブなプロジェクトにフローを追加します。

ファイルがビジュアル フロー エディターで開きます。Studio Web の場合とまったく同じように、ノードの構築、接続、設定を行います。

同じワークスペース内で Data Fabric エンティティをモデル化することもできます。「 VS Code のエンティティ」をご覧ください。

パッケージ化してデプロイ

VS Code からパブリッシュするには、ワークスペースを UiPath ソリューションとしてパッケージ化して Orchestrator にデプロイします。デプロイの処理については、「 フローをデプロイする 」をご覧ください。

• UiPath: パッケージ : 現在のワークスペースから .uipx ソリューションを構築します。
• UiPath: デプロイ: パッケージ化されたソリューションを Orchestrator にアップロードします。
• [UiPath: パッケージ化してデプロイ ] では、両方の手順が同時に実行されます。
• UiPath: [ターゲットをデプロイ ] を切り替えると、移動先フォルダーが変更されます。

既定では、拡張機能はデプロイの成功後にデプロイをアクティブ化します。アクティブ化せずにデプロイするには、[ uipath.autoActivateDeployment ] 設定をオフにします。

UiPath CLI から同じパッケージを実行するには、「 UiPath: Generate .env File」を実行します。これにより、uipに対応した .env ファイルが書き込まれます。

デバッグ

VS Code でのデバッグは、選択したクラウド テナントを経由してルーティングします。エディターからフローを実行し、ライブ デバッグ ビューで実行を監視します。実行の進行に応じて更新される Mermaid 実行フローチャートが表示されます。実行を読み取って失敗を解決する方法については、「 効果的にデバッグする 」をご覧ください。

コマンドとキーボード ショートカット

コマンド パレットから任意のコマンドを実行します (Ctrl/Cmd+Shift+P)。フロー エディターのショートカットは、 .flow ファイルがアクティブなエディターである場合にのみ適用されます。

フロー エディター

コマンド	既定のキーバインド
フロー: 新しいフロー	Ctrl/Cmd+Alt+N
フロー:オープンフロー	Ctrl/Cmd+Alt+O
フロー: フローを保存	Ctrl/Cmd+S
フロー: 名前を付けてフローを保存	Ctrl/Cmd+Shift+S
フロー: 元に戻す	Ctrl/Cmd+Z
フロー: やり直し	Ctrl+Y / Cmd+Shift+Z
フロー: Zoom In	Ctrl/Cmd+=
フロー: Zoom アウト	Ctrl/Cmd+-
フロー: Reset Zoom	Ctrl/Cmd+0
フロー: 画面に合わせる	Ctrl/Cmd+Shift+F
フロー: フローを検証	Ctrl/Cmd+Shift+V
フロー: エクスポート フロー	なし

UiPath Platform

コマンド	説明
UiPath: サインイン	UiPath にサインインします。
UiPath: サインアウト	サインアウトし、キャッシュされたセッションをクリアします。
UiPath: [環境] を選択します	[UiPath] 環境を選択します。
UiPath: テナントを選択	テナントまたは組織を選択します。
UiPath: 新しいプロジェクトを作成	ソリューションにプロジェクトを追加します。[ Data Fabric ] を選択してエンティティ プロジェクトを作成します。
UiPath: 新しいファイル	プロジェクトにファイルを追加します。[ エンティティ ファイル ] を選択してエンティティを追加します。
UiPath: エンティティ ファイルを追加	既存のエンティティ プロジェクトに別のエンティティを追加します。ソリューションに 1 つがある場合に利用可能。
UiPath: パッケージ	ワークスペースから .uipx ソリューションを構築します。
UiPath: デプロイ	パッケージ化されたソリューションを Orchestrator にアップロードします。
UiPath: パッケージ化してデプロイ	パッケージ化とデプロイを 1 ステップで完了します。
UiPath: ターゲットのデプロイを切り替える	移動先フォルダーを変更します。
UiPath: .env を生成ファイル	CLI 互換の .env ファイルを記述します。
UiPath: 更新	[接続] ツリーを更新します。
UiPath: 出力ログを表示	UiPath 出力チャネルを開きます。
UiPath: 基本情報	「はじめに」のチュートリアルを開きます。

キャンバスのショートカットの完全なセットについては、「 キーボード ショートカット」をご覧ください。

設定

VS Code の設定で拡張機能を設定します。

uipath.environment

サインイン時に使用する UiPath 環境。既定値は cloudです。既存の CLI セッションが他の場所を指している場合に優先されます。

uipath.autoActivateDeployment

デプロイが成功したら、ソリューションのデプロイをアクティブ化します。既定値は trueです。

uipath.cli.path

UiPath CLI バイナリへの絶対パスです (uip)。PATHでuipを見つけるには空のままにします。CLI が PATH上にない場所にインストールされている場合に設定します。

uipath.telemetry.enabled

匿名化された使用状況テレメトリを送信します。既定値は trueです。この拡張機能は、VS Code のグローバル telemetry.telemetryLevelも尊重します。いずれかの設定をオフにすると、テレメトリが無効化されます。

トラブルシューティング

サインインに失敗する

OAuth コールバック ポートがビジー状態の場合、または CLI がセッションを失った場合、サインインは失敗します。

• ポート使用中。CLI は、コールバックに localhost のポート 8104 を使用します。古いプロセスでポートが保持されている場合は、ポートを解放して、再度サインインします。macOS または Linux の場合は、 lsof -ti :8104 | xargs kill -9を実行します。Windows では、 netstat -ano | findstr :8104を実行してから taskkill /F /PID <id>を実行します。
• 古いセッションです。[ UiPath: サインアウト] を実行してから、[ UiPath: もう一度サインイン ] を実行して、新しいサインインを強制します。
• ログを読み取ります。「 UiPath: Show output Log」 を実行し、 UiPath 出力チャネルにサインイン エラーがないか確認します。

CLI が見つからない

この拡張機能は uipに展開されます。バイナリが見つからない場合、サインインとパッケージ化は失敗します。

1. ターミナルで uip --version を実行して、CLI がインストールされていることを確認します。
2. uip が PATHにない場合は、uipath.cli.path をバイナリの絶対パスに設定します。
3. CLI がまったくインストールされていない場合は、 UiPath: [サインイン ] を実行してインストール プロンプトを受け入れるか、 を使用して手動 npm install -g @uipath/cliインストールします。そのためには、 PATHに Node.js と npm が必要です。

リモート ワークスペースに CLI が表示されない

WSL、SSH、Codespaces、開発コンテナー ワークスペースでは、拡張機能はローカル マシンではなくリモート ホストで実行されます。uip バイナリをそのホストにインストールする必要があります。ローカルの Windows または macOS マシンにインストールされている CLI は拡張機能に表示されません。リモート ワークスペースに CLI をインストールしてから、再びサインインします。

デプロイがアクティブ化されない

既定では、拡張機能はデプロイの成功後にデプロイをアクティブ化します。デプロイがアップロードされてもアクティブ化されない場合は、 uipath.autoActivateDeployment がオンになっていることを確認してください。

関連ページ

• 最初のフロー
• VS Code のエンティティ
• フローをデプロイする
• 効果的にデバッグする