次の方法で共有


IA-Connect セッション

IA-Connect は、クラウドからオンプレミスの仮想マシンに、または Citrix または Microsoft リモート デスクトップ 'RDS' 接続経由で RPA 機能を追加する、ロボット プロセス オートメーション 'RPA' プラットフォームです。 これは、環境、セッション、ファイル管理を自動化し、IA-Connect を構成するためのモジュールです。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate(パワーオートメート) Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Ultima Labs
URL https://www.ultima.com/ultima-labs
Email IAConnect@ultima.com
コネクタ メタデータ
Publisher ウルティマビジネス
Website https://www.ultima.com/ultima-labs
プライバシー ポリシー https://www.ultima.com/privacy-policy
カテゴリ IT 運用;生産性

IA-Connect は、Power Automate Cloud Flows からオンプレミスの仮想マシン、または Citrix または Microsoft Remote Desktop (RDS) 接続経由で RPA 機能を追加する、RPA (ロボティック プロセス オートメーション) プラットフォームです。 IA-Connect コネクタには 800 を超えるアクションが用意されており、Power Automate Cloud Flow から直接、あらゆる種類のオンプレミス アプリケーションを自動化できます。 すべての IA-Connect アクションは Power Automate Cloud Flow から直接利用でき、クラウド ベースとオンプレミスのアプリケーション間の統合が容易になり、既存の Power Automate 条件、ループ、動的コンテンツ、式、および例外処理を RPA プロセスで利用できます。 また、IA-Connect コネクタを利用すると、フロー実行履歴から完全な実行履歴と監査機能が提供される一方で、RPA プロセスを開発するために別のアプリケーション/コンソール/スタジオを用意する必要も排除されます。

[前提条件]

IA-Connect コネクタのいずれかを使用するには、IA-Connect ソフトウェアをインストールする必要があります。 これは 30 日間無料でテストできます。その後、IA-Connect ライセンスが必要になります。

IA-Connect ソフトウェアは、次の 2 つの主要なコンポーネントで構成されています。

  • IA-Connect Orchestrator。これは、独自の Azure テナントでホストする Azure WebApp です。 これにより、1 つ以上のオンプレミスまたはクラウドベースの仮想マシンへの RPA フローのルーティングとセキュリティが処理されます。

  • IA-Connect エージェントとディレクター。自動化するソフトウェアにアクセスできる仮想マシンにインストールされます。 さらに、IA-Connect エージェントは Citrix または Microsoft Remote Desktop Services (RDS) セッション内で実行できます。このセッションでは、RPA コマンドが仮想チャネルをリモート セッションに渡して実行されます。 IA-Connect エージェントはネットワーク共有から実行でき、インストールは必要ありません。

使用可能な IA-Connect コネクタ

使用可能な IA-Connect コネクタは次のとおりです。

  • 動的コードの IA-Connect
  • IA-Connect Java
  • JML の IA-Connect
  • メインフレームの IA-Connect
  • IA-Connect Microsoft Office
  • SAP GUI の IA-Connect
  • IA-Connect セッション
  • IA-Connect ユーザーインターフェース
  • IA-Connect Web ブラウザー

資格情報を取得する方法

ライセンスを受け取り、30日間の無料試用版を開始するには、当社のウェブサイト(https://www.ultima.com/IA-Connect/Power-Automate)でリクエストを送信してください。

試用版の要求を受け取ったら、IA-Connect ソフトウェアの設定を支援し、試用版ライセンスを提供するために提供された電子メール アドレスを介して、お客様に連絡します。 これは完全な機能を備えた試用版であり、試用期間中に、ご自身の環境内の 9 つの IA-Connect コネクタすべてに対して 800 個のアクションのいずれかをテストできます。

コネクタの概要

IA-Connect の試用版要求を送信すると、インストールとセットアップに関する IA-Connect ソフトウェアとドキュメントを含む ZIP ファイルをダウンロードできるようになります。 また、必要に応じてインストールプロセスを通じてサポートとガイダンスを提供するために、お客様に連絡します。

Support

試用期間中は、Ultima Labs (IAConnect@ultima.com) に問い合わせてサポートとサポートを受けることができます。

IA-Connect ライセンスを購入すると、Ultimaの英国ベースのテクニカルサービスセンター(TSC)から、特注のトレーニングまたはサポートに利用できるサポートトークンを受け取ります。

既知の問題、一般的なエラー、FAQ

ナレッジ ベースには、既知の問題、IA-Connect コネクタの使用時に発生する可能性がある一般的なエラー、よく寄せられる質問に関する記事が多数含まれています。 これは https://support.ultima.com/ultimalabs でアクセスでき、これらのリソースにアクセスするためのアカウントは、IA-Connect 試用版中および IA-Connect ライセンスの購入時に提供されます。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
API キー securestring この API の API キー 正しい
IA-Connect Orchestrator アドレス 文字列 HTTP(S) コンポーネントを使用せずに IA-Connect Orchestrator アドレスを指定する 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

CSV テキストをコレクションとして取得する

IA-Connect エージェントがコレクション (テーブル) として実行されているコンピューター上の CSV ファイルを返します。 CSV ファイルへの読み取り専用アクセスのみが必要です。

CSV ファイルへの書き込み

IA-Connect エージェントが実行されているコンピューターに CSV ファイルを作成します。 CSV ファイルは、コレクション (テーブル) または JSON 形式のテーブルから作成されます。

HTTP ファイルのダウンロード

http(S) を使用して、IA-Connect エージェントが実行されているコンピューターにファイルをダウンロードします。

IA-Connect セッションが名前で閉じるのを待ちます

指定した IA-Connect Director セッションが閉じるのを待ちます。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

IA-Connect セッションにインデックスでアタッチする

指定した IA-Connect Director セッションにインデックスでアタッチします (たとえば、最初の Citrix ICA セッションにアタッチします)。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

INI ファイル内の変数データを置き換える

INI ファイル内の 1 つの変数を更新します。

mouse_eventの調整

指定したピクセル数だけマウスを移動し、新しいマウス位置を読み取って、mouse_eventメソッドを調整します。

Orchestrator worker の一覧を取得する

IA-Connect Orchestrator に登録されているワーカーとそのライブ 状態の一覧を取得します。

Orchestrator worker の可用性の状態を取得する

基本的なオーケストレーターの状態を取得します。 これを使用して、Orchestrator が使用可能であり、応答していることを確認できます。

Orchestrator worker を取得する

IA-Connect Orchestrator に登録されている個々のワーカーの詳細とライブ 状態を取得します。

Orchestrator worker メンテナンス モードを設定する

IA-Connect Orchestrator で定義されている IA-Connect ワーカーをメンテナンス モードにするか (フローがワーカーに割り当てられないように)、またはワーカーをメンテナンス モードから外します。

Orchestrator から worker の可用性統計を取得する

IA-Connect Orchestrator からワーカーの可用性統計を返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

Orchestrator から worker を割り当てる

IA-Connect Orchestrator からワーカーを割り当てます。 タグまたはワーカー名 (またはその両方) を使用してワーカーを要求できます。これにより、必要なワーカーをより正確に選択できます。 ワーカーが割り当てられると、そのワーカーはフローに割り当てられ、作業の実行として報告されます。 オーケストレーターでは、割り当てを実行するときに、引き続き "サポートされているフロー環境 ID"、"サポートされているフロー名"、および "サポートされていないフロー名" が考慮されることに注意してください。 複数のワーカーが検索に一致する場合は、通常の負荷分散規則が適用されます。

Orchestrator からフロー統計を取得する

IA-Connect Orchestrator からフロー統計の一覧を返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

Orchestrator からログイン履歴を取得する

レポート用の IA-Connect Orchestrator ログイン履歴を返します。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

Orchestrator からワーカー フローの使用ヒートマップを取得する

IA-Connect Orchestrator からワーカー フロー使用状況の日次ヒートマップを返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

Orchestrator から汎用資格情報を取得する

IA-Connect Orchestrator に格納されている汎用資格情報を取得します。 資格情報には、ユーザー名、パスワード、ホスト名、URL、およびその他の汎用データを保持できます。

Orchestrator の 1 回限りシークレットを作成する

1 回限りのシークレットは、一度取得できるシークレットを、一意の URL を使用して格納する機能を提供します。 これは通常、サード パーティとシークレットを共有するために使用されます。 Orchestrator UI、REST API、またはフローから 1 回限りのシークレットを作成できます。

Orchestrator の状態を取得する

基本的なオーケストレーターの状態を取得します。 これを使用して、Orchestrator が使用可能であり、応答していることを確認できます。

Orchestrator の自動化タスク操作を取得する

一意のタスク操作 ID を指定して、特定の Orchestrator オートメーション タスクを取得します。

Orchestrator オートメーション タスクにメモを追加する

選択した Orchestrator オートメーション タスクにメモを追加します。 このメモは、この自動化タスク (ServiceNow など) にリンクされているソース システムに渡され、最も一般的にチケットに詳細を追加するために使用されます。 Orchestrator 自動化タスクがソースにリンクされていない場合は、例外が発生します。

Orchestrator オートメーション タスクの出力データを設定する

Orchestrator オートメーション タスクの出力データを設定します。 タスクを完了し、タスクを作成したプロセスによって収集される出力データを提供する場合に一般的に使用されます。

Orchestrator フロー統計から最後に失敗したアクションを取得する

IA-Connect Orchestrator を介してワーカーに渡された最後のアクションの詳細を取得します (そのアクションが失敗した場合)。 このアクションは、エラー処理時に最も一般的に使用されます。

Orchestrator 自動化タスクの削除

延期された Orchestrator 自動化タスクを削除します。

Orchestrator 自動化タスクの状態を変更する

選択した Orchestrator オートメーション タスクの状態、またはその他のタスク プロパティを変更します。

Orchestrator 自動化タスクを割り当てる

選択した Orchestrator オートメーション タスクを、指定したユーザーまたはグループに割り当てます。 この割り当ては、この自動化タスク (ServiceNow など) にリンクされているソース システムに渡され、最も一般的に、追加処理のために別のユーザーまたはユーザーのグループにチケットを渡すために使用されます。 Orchestrator 自動化タスクがソースにリンクされていない場合は、例外が発生します。

Orchestrator 自動化タスクを取得する

特定の Orchestrator オートメーション タスクを取得します。

PowerShell プロセスを実行する

ディスク上の既存のスクリプトを実行するか、実行するスクリプトの内容を指定して、PowerShell プロセスを起動します。 代わりに "PowerShell スクリプトの実行" アクションを使用することを検討してください。これははるかに強力であり、PowerShell スクリプトからの出力のデータ テーブルを提供します。 PowerShell スクリプトが標準出力または標準エラーに出力する場合 (たとえば、テーブルを返す代わりに Write-Host を使用する)、PowerShell 7 が必要な場合、または代替ユーザーとして Active Directory アクションを実行していて、WinRM 経由の CredSSP が使用できない場合は、このアクションを使用します。

TCP ポートが応答中か

ネットワーク TCP ポートが、IA-Connect エージェントによる接続試行に応答しているかどうかを報告します。 これは、IA-Connect エージェントが実行されているコンピューター (リモート ホストの場合は「localhost」と入力) または任意のリモート コンピューター上の TCP ポートである可能性があります。 IA-Connect エージェントは、TCP ポートに正常に接続すると、すぐに TCP 接続を閉じます。

UnZIP ファイル

ZIP 圧縮を使用して圧縮されたファイルを解凍します。

Web API にメッセージを送信する

Web API にメッセージを送信し、応答を受信します。 これは任意の Web API で使用できますが、一般的な使用方法は REST API です。 IA-Connect では、仮想マシンから Web API へのメッセージの送信 (つまり、オンプレミスのリソースにアクセスするため) または Citrix または Microsoft リモート デスクトップ セッション (分離された環境からのみアクセスできる API へのアクセスなど) をサポートします。

ZIP にファイルを追加する

ファイルを ZIP 圧縮します (ファイルを圧縮アーカイブに格納します)。

ZIP にフォルダーを追加する

フォルダー内の ZIP ファイルを ZIP ファイルに圧縮します (圧縮アーカイブにファイルを格納します)。

すべての IA-Connect コマンド統計情報を取得する

IA-Connect エージェントが現在のセッションで実行したコマンドに関して、現在保存されているすべての統計情報を返します。

すべての Orchestrator 自動化タスクを取得する

フィルターに一致するすべての Orchestrator オートメーション タスクを取得します。

ウィグル マウス

指定した座標数だけマウスを前後に移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。

エージェント GUI IA-Connect 前面に移動する

IA-Connect エージェント GUI を前面に表示し、画面に表示されるようにします。

エージェント GUI の不透明度 IA-Connect 設定する

IA-Connect エージェントの不透明度を 1 (表示) から 0 (透明) に設定します。

エージェント GUI の位置 IA-Connect 設定する

IA-Connect エージェント GUI の画面上の位置を、指定した場所に設定します。

エージェント GUI の最上位 IA-Connect 設定

IA-Connect エージェントを最上位に設定します。 つまり、IA-Connect エージェントは常に画面に表示され、他のアプリケーション ウィンドウの背後に非表示にすることはできません。

エージェント IA-Connect プロセス数を取得する

ユーザー セッションで現在実行中の IA-Connect エージェントのインスタンスの数を返します。 これは、IA-Connect エージェントの複数のインスタンスが実行されているかどうかを検出するのに役立ちます。

エージェント IA-Connect 現在のライセンス状態を取得する

IA-Connect エージェントが現在ライセンスされているかどうかを返し、ライセンスが付与されている場合はライセンスのプロパティを返します。

エージェント IA-Connect 閉じる

IA-Connect エージェントを閉じます。 これは、IA-Connect エージェントが実行されていたユーザー セッションには影響しません。

エージェント コマンド タイムアウト IA-Connect 設定する

IA-Connect エージェントが実行される各コマンドに使用するコマンド タイムアウトを設定します。

エージェント スレッドが正常に完了するまで待ちます

エージェント スレッドが完了するまで待機し、必要に応じてスレッド出力データを取得します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドが完了しても失敗した場合は、例外が発生します。

エージェント スレッドの状態を取得する

エージェント スレッドの状態を取得し、必要に応じてスレッド出力データを取得します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。

エージェント スレッドを削除する

実行中の場合は、エージェント スレッド、またはすべてのエージェント スレッドを削除し、スレッドを最初に強制終了 (終了、中止) します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドを監視しているプロセスまたはフローは、"エージェント スレッド ID が存在しません" というエラーを受け取ります。

エージェント スレッドを取得する

エージェント スレッドの一覧を返します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 通常、エージェント スレッドが完了し、そのデータが取得されると、エージェント スレッドは削除され、スレッドの一覧には表示されません。

エージェント スレッドを強制終了する

エージェント スレッドを強制終了 (終了、中止) します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドは削除されません ("エージェント スレッドの削除" アクションを使用してスレッドを削除します)、エージェント スレッドを監視しているプロセスまたはフローが "エージェント スレッドが中止されましたIA-Connect" エラーを受信できるようにします。

エージェント セッション情報 IA-Connect 取得する

IA-Connect エージェント ユーザー セッションに関する情報を返します。

エージェント メモリにパスワードを格納する

エージェント メモリ (暗号化) にパスワードを格納します。このメモリは、保存されたパスワードをサポートするアクションから使用できます。 パスワードはメモリにのみ格納され、エージェントを閉じると失われます。

エージェント メモリ内のパスワードを削除する

エージェント メモリに格納されているパスワードを削除するか、エージェントに格納されているすべてのパスワードを削除します。

エージェント ログ IA-Connect 取得する

ファイルとして、または内容を読み取って出力変数に返すことによって、現在の IA-Connect エージェント ログを返します。

エージェント ログ レベル IA-Connect 取得する

現在の IA-Connect エージェント ログ レベルを返します。 ログ 記録レベルは 1 から 4 に設定され、1 は最も低いレベル、4 は最も高くなります。

エージェント ログ レベル IA-Connect 設定する

IA-Connect エージェントのログ 記録レベルを指定した値に設定します (1 は最低レベル、4 は最も高いレベル)。

エージェントのグローバル座標構成 IA-Connect 取得する

IA-Connect Agent グローバル座標系構成の構成を取得します。この構成は、要素の位置 (たとえば、マウス検査中) を表示し、マウス位置を計算するために使用されます (たとえば、グローバル マウス アクションを実行する場合)。

エージェントのグローバル座標構成 IA-Connect 設定する

IA-Connect Agent グローバル座標系を構成します。このシステムは、要素の位置 (たとえば、マウス検査中) を表示し、マウスの位置を計算するために使用されます (たとえば、グローバル マウス 操作を実行する場合)。 既定値では最新の機能が提供されますが、このアクションを使用して、以前のバージョンのエージェントの動作に戻したり、API が別の座標系を使用していることを指定したりできます。

エージェント情報 IA-Connect 取得する

バージョン番号とエージェント実行可能ファイルへのパスを含む、IA-Connect エージェントのプロパティを返します。

オーケストレーター フロー統計の結果を更新する

IA-Connect Orchestrator の現在のワーカー フローの結果統計を更新します。 これは、IA-Connect オーケストレーターのフロー統計の最終的な結果を変更するために使用されます。これは通常、レポートの目的で使用されます。 これは、現在のフローに対してのみ機能します (オーケストレーターはフロー実行 ID を検出します)。 他のフローの統計を変更することはできません。

オーケストレーターの自動化タスク操作を削除する

一意のタスク操作 ID を指定して、特定の Orchestrator 自動化タスクを削除します。

キー イベントを送信する

低レベルのキーボード ドライバーを使用して、グローバル キー押下イベントを IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

キーの送信

グローバル キー押下を IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

クライアント ホスト名を取得する

IA-Connect Director が実行されているクライアントのホスト名を返します。

クライアントからサーバーにファイルをコピーする

(IA-Connect Director を実行している) ローカル コンピューターからリモート コンピューター (IA-Connect エージェントを実行している) にファイルをコピーします。

クリップボードのクリア

IA-Connect エージェント ユーザー セッションのクリップボードの内容をクリアします。

クリップボードの設定

IA-Connect エージェント ユーザー セッションのクリップボードの内容を設定します。

クリップボードを取得する

IA-Connect エージェント ユーザー セッションのクリップボードの現在のコンテンツを取得します。

コマンド統計 IA-Connect リセットする

IA-Connect エージェントが現在のセッションで実行したコマンドに関して、現在保存されているすべての統計情報をリセットします。

コンピューター ドメインを取得する

IA-Connect エージェント ユーザー セッションを実行しているコンピューターのドメインを返します。

コンピューター名を取得する

IA-Connect エージェント ユーザー セッションを実行しているコンピューターの名前を返します。

スクリーン リーダーが有効になっているか

IA-Connect エージェント ユーザー セッションでスクリーン リーダーが有効になっているかどうかを返します。

スクリーン リーダーの設定

IA-Connect エージェント ユーザー セッションでスクリーン リーダーを有効または無効にします。

スクリーンショットを撮る

IA-Connect エージェント ユーザー セッションのスクリーンショットを取得し、Base64 でエンコードされた文字列として返します。

セッション IA-Connect 名前で存在するか

指定した IA-Connect Director セッションが存在する場合に返します。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

セッションがロックされている

IA-Connect エージェントが実行されているセッションがロックされているかどうかを報告します。

セッションのロック

IA-Connect エージェントが実行されているセッションをロックします。

セッションのロック解除

IA-Connect エージェントが実行されているセッションのロックを解除します。 これにより、資格情報プロバイダーのみがコンピューターのロックを解除できるため、IA-Connect Unlocker 資格情報プロバイダーをセッションをホストしているコンピューターにインストールする必要があります。

セッションをキープ アライブを停止する

IA-Connect エージェント ユーザー セッションのキープ アライブを停止します。

セッションを維持する

指定した間隔でマウスを動かして IA-Connect エージェント ユーザー セッションを維持し、セッションがアイドル状態にならないようにします。

テキスト ファイルを書き込む

IA-Connect エージェントが実行されているコンピューターにテキスト ファイルを作成し、そのファイルにテキストを書き込みます。

ディスクの空き領域を取得する

IA-Connect エージェントが実行されているコンピューター上の指定したディスクの空き領域の量を返します。

ディレクター IA-Connect アップタイムを取得する

この IA-Connect ディレクターの稼働時間を秒単位で返します (つまり、ディレクターの実行時間)。

ディレクター クライアントの種類とセッション情報を取得する

階層 1 ディレクターによって処理されているローカルまたはリモート セッションの詳細を返します。

ディレクター ログ レベル IA-Connect 設定する

IA-Connect Director のログ 記録レベルを指定した値に設定します。 ログ 記録レベルは 0 から 4 に設定されます。 0 は無効です。 1 は最も低いログ レベル (および既定値) です。 4 は最も高いログ レベルです。

ディレクターから送信された代替 IA-Connect エージェントを実行する

IA-Connect Director から代替エージェントをアップロードし、代替エージェント実行可能ファイルを読み込んで、代替 IA-Connect エージェント (新しいバージョンなど) を実行します。

ディレクターのログ レベル IA-Connect 取得する

現在の IA-Connect Director ログ レベルを返します。 ログ 記録レベルは 0 から 4 に設定されます。 0 は無効です。 1 は最も低いログ レベル (および既定値) です。 4 は最も高いログ レベルです。

ディレクター情報 IA-Connect 取得する

バージョン番号と Director 実行可能ファイルへのパスを含む、IA-Connect Director のプロパティを返します。

ディレクトリにアクセス可能か

ディレクトリ (フォルダー) にアクセスできるかどうか、およびアクセス許可によって、IA-Connect エージェントが存在するコンピューターでのアクセスが制限されているかどうかを返します。

ディレクトリの削除

IA-Connect エージェントが実行されているコンピューター上のディレクトリ (フォルダー) を削除します。

ディレクトリの消去

IA-Connect エージェントが実行されているコンピューター上のディレクトリ (フォルダー) を消去し、ディレクトリ内に格納されているすべてのファイルを削除します。

ディレクトリは存在しますか

IA-Connect エージェントが実行されているコンピューターにディレクトリ (フォルダー) が存在するかどうかについて、true または false を報告します。

ディレクトリを作成する

IA-Connect エージェントが実行されているコンピューターにディレクトリ (フォルダー) を作成します。

ドライブの一覧を取得する

IA-Connect エージェントが実行されているコンピューター上のドライブの一覧を返します。

パスワード キー イベントを送信する

グローバル キー押下イベントを、特に低レベルのキーボード ドライバーを使用してパスワードを入力するために、IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パスワード キーを送信する

グローバル キー押下を IA-Connect エージェント ユーザー セッションに送信します。これは、特にパスワードを入力するためです。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パスワードの生成

テンプレート形式で定義されている辞書の単語、数字、記号、文字を含むパスワードを生成します。

パスワード文字列を展開する

格納されているパスワードへの参照を含む入力文字列 IA-Connect 受け入れ、その文字列を、格納されているパスワードに置き換えられた参照で返します。

ファイル サイズを取得する

IA-Connect エージェントが実行されているコンピューター上のファイルのサイズ (バイト単位) を返します。

ファイル セキュリティから ID を削除する

IA-Connect エージェントが実行されているコンピューター上のファイルのセキュリティアクセス許可から ID (ユーザー、グループ、コンピューターなど) を削除します。

ファイル セキュリティのアクセス許可を取得する

IA-Connect エージェントが実行されているコンピューター上のファイルに現在設定されているアクセス許可の一覧を返します。

ファイルからすべてのテキストを読み取る

IA-Connect エージェントが実行されているコンピューター上のファイルのテキスト コンテンツを読み取ります。

ファイルにアクセス許可を追加する

IA-Connect エージェントが実行されているコンピューター上のファイルにアクセス許可を追加します。

ファイルのコピー

IA-Connect エージェントが実行されているコンピューターにファイルをコピーします。

ファイルの内容を Base64 として取得する

指定したファイルの内容を Base64 形式で取得します。これは、API 経由の転送に適した形式で、元のテキストまたはバイナリ形式に簡単に変換できます。

ファイルの所有者を設定する

IA-Connect エージェントが実行されているコンピューター上のファイルの所有者を設定します。

ファイルの移動

IA-Connect エージェントが実行されているコンピューター上のファイルを移動します。

ファイルは存在しますか

IA-Connect エージェントが実行されているコンピューターにファイルが存在するかどうかについて、true または false を報告します。

ファイルをクリップボードにコピーする

指定したローカル ファイルを、IA-Connect エージェント ユーザー セッションのクリップボードにコピーします。

ファイルを削除する

IA-Connect エージェントが実行されているコンピューター上のファイルを削除します。

ファイルを削除する

IA-Connect エージェントが実行されているコンピューター上のパターンに一致する指定したフォルダー内のファイルを削除します。

ファイルを取得する

IA-Connect エージェントが実行されているコンピューター上のフォルダー (パターンの CSV リストに一致する) 内のファイルの一覧を返します。

フォルダーにアクセス許可を追加する

IA-Connect エージェントが実行されているコンピューター上のフォルダーにアクセス許可を追加します。

フォルダーに所有者を設定する

IA-Connect エージェントが実行されているコンピューター上のフォルダーの所有者を設定します。

フォルダーのセキュリティから ID を削除する

IA-Connect エージェントが実行されているコンピューター上のフォルダーのセキュリティアクセス許可から ID (ユーザー、グループ、コンピューターなど) を削除します。

フォルダーのセキュリティの継承を解除する

IA-Connect エージェントが実行されているコンピューター上のフォルダーのセキュリティ継承を解除します。

フォルダーのセキュリティアクセス許可を取得する

IA-Connect エージェントが実行されているコンピューター上のフォルダーに現在設定されているアクセス許可の一覧を返します。

フォルダーのセキュリティ継承を有効にする

IA-Connect エージェントが実行されているコンピューター上のフォルダーでセキュリティ継承を有効にします。

フォルダーを取得する

IA-Connect エージェントが実行されているコンピューター上の指定したフォルダー内のすべてのサブフォルダーを返します。

フローの結果 JSON から失敗したアクションのエラー メッセージを取得する

1 つ以上のフロー result() 式の JSON 出力をデテリアリスし、失敗したアクションから最初に見つけたエラー メッセージを取得します。 エラー メッセージは、さまざまな形式で JSON に格納できます。 このアクションは既知の形式を処理し、最初に見つかっているエラー メッセージを返します。

フローを完了としてマークする

フローを完了としてマークします。これにより、割り当てられたワーカー マシンが他のフローを処理できるようになりました IA-Connect Orchestrator に通知されます。

プリンターの一覧を取得する

IA-Connect エージェント セッションで使用可能なすべてのプリンターの一覧を返します。

プロセス ID でプロセスを取得する

指定したプロセス ID を持つプロセスが、IA-Connect エージェント ユーザー セッションで実行されているかどうかを返します。 プロセス ID は一意であるため、ID と一致できるプロセスは 1 つだけです。プロセス ID は動的であり、アプリケーションを起動するたびに異なります。

プロセス ID のコマンド ライン プロパティを取得する

指定したプロセス ID を持つ IA-Connect エージェント ユーザー セッションで実行中のすべてのプロセスのコマンド ライン プロパティを返します。

プロセスの実行

プロセス、コマンド、またはアプリケーションを起動します。

プロセスを取得する

IA-Connect エージェント ユーザー セッションで実行中のプロセスの一覧を返します。 必要に応じて、プロセス名を指定してフィルター処理できます。

マウス カーソルの位置を設定する

IA-Connect エージェント ユーザー セッションのマウス カーソルを指定した位置に設定します。 setcursorpos API は、選択したアクティブなマウス移動 API に関係なく、マウスの移動に使用されます。

マウス ホイールを回す

IA-Connect エージェント ユーザー セッションでマウス ホイール (正または負の切り欠き) をオンにします。

マウスの中央クリック

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンをクリックします。

マウスの中央ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンを離します。

マウスの中央ボタンを下へ

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンを押します (離しません)。 マウスを離すには、マウスの中央ボタンアップアクションを使用します。

マウスの右ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの右ボタンを離します。

マウスの右ボタンを下に移動

IA-Connect エージェント ユーザー セッションでマウスの右ボタンを押します (離しません)。 マウスを離すには、マウスの右ボタンアップアクションを使用します。

マウスの左クリック

IA-Connect エージェント ユーザー セッションでマウスの左ボタンをクリックします。

マウスの左クリックをダブルクリック

IA-Connect エージェント ユーザー セッションでマウスの左ボタンをダブルクリックします。

マウスの左ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの左ボタンを離します。

マウスの左ボタンを下に移動

IA-Connect エージェント ユーザー セッションでマウスの左ボタンを押します (離しません)。 マウスを離すには、マウスの左ボタンアップ アクションを使用します。

マウスの移動方法を設定する

現在のマウス移動メソッドを mouse_event または setcursorpos に設定します。

マウスを中央に押し続けます

IA-Connect エージェント ユーザー セッションのマウスの中央ボタンを、指定した秒数保持します。

マウスを右クリック

IA-Connect エージェント ユーザー セッションでマウスの右ボタンをクリックします。

マウスを右長押し

IA-Connect エージェント ユーザー セッションのマウスの右ボタンを、指定した秒数保持します。

マウスを左に押し続けます

IA-Connect エージェント ユーザー セッションのマウスの左ボタンを、指定した秒数保持します。

マウスを座標で中央に保持する

IA-Connect エージェント ユーザー セッションの指定した座標で、指定した秒数、マウスの中央ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

マウスを座標で右に押し続けます

IA-Connect エージェント ユーザー セッションの指定した座標で、指定した秒数、マウスの右ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

マウスを座標で左に押し続けます

IA-Connect Agent ユーザー セッションの指定した座標で、指定した秒数、マウスの左ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

マウスを座標に移動する

IA-Connect エージェント ユーザー セッション内のマウスを指定したピクセル座標に移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

マウスを相対的に移動する

IA-Connect エージェント ユーザー セッション内のマウスを、現在の位置を基準にして、指定したピクセル数だけ移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

マウス乗数を取得する

IA-Connect エージェント ユーザー セッションのグローバル マウス乗数を取得します。 既定値は (1, 1) ですが、[マウス乗数の設定] アクションによって変更された可能性があります。

マウス乗数を設定する

IA-Connect エージェント ユーザー セッションのグローバル マウス乗数を設定します。 これは、リモート デスクトップのスケーリングで問題が発生した場合に、開発中に役立ちます。

マウス移動メソッドを取得する

現在のマウス移動メソッドを取得します。

ユーザー資格情報からの読み取り

IA-Connect エージェント セッションで、ユーザーのプロファイルの資格情報からユーザー名とパスワードを読み取ります。 資格情報は、Windows コントロール パネルから表示できます。 ユーザー名とパスワードの両方を汎用資格情報から取得できますが、Windows 資格情報から取得できるのはユーザー名のみです。

ユーザー資格情報への書き込み

IA-Connect エージェント セッションでユーザーのプロファイルの資格情報にユーザー名とパスワードを書き込み、存在しない場合はその資格情報を作成します。 資格情報は、Windows コントロール パネルから表示できます。

ユーザー資格情報を削除します

IA-Connect エージェント セッションでユーザーのプロファイルの資格情報を削除します。 資格情報は、Windows コントロール パネルから表示できます。

ライセンス キー IA-Connect 設定する

ライセンス キーを使用して IA-Connect エージェントにライセンスを付与します。 これには、IA-Connect Orchestrator に保持されているライセンスのライセンス文字列またはフレンドリ名を指定できます。

ライセンス コード IA-Connect 設定する

古いスタイル (7.0 および 7.1) のエージェント ドメイン ライセンスを IA-Connect エージェントにアップロードします。

リモート セッションの切断

IA-Connect エージェントがリモート セッションで実行されている場合、このアクションはリモート セッションを切断します。 これはログオフと同じではなく、リモート セッションは切断された状態で実行されたままになります。 このアクションは、新しいセッションを開始するのではなく、後でリモート セッションに接続し、同じ状態から続行する場合に使用できます。 IA-Connect エージェントがローカルで実行されている場合、このアクションによってセッションがロックされます。

リモート デスクトップ セッション (RDS) を起動する

RDP 起動ファイルを使用してリモート デスクトップ セッション (RDS) を起動します。

リモート デスクトップ セッション (RDS) 起動ファイルを作成する

リモート デスクトップ クライアント UI の自動化を必要とするのではなく、指定したパラメーターを使用してリモート デスクトップ セッションを自動的に起動するために使用できるリモート デスクトップ セッション (RDS) 起動ファイルを作成します。 RDS 起動ファイルの拡張子は '.rdp' で、RDP ファイルと呼ばれることがよくあります。

ログオフ リモート セッション

IA-Connect エージェントが実行されているリモート セッションをログオフします。

他のすべての IA-Connect エージェントを強制終了する

ユーザー セッションで現在実行中の IA-Connect エージェントの他のインスタンスをすべて強制終了します。 これにより、IA-Connect エージェントのインスタンスが 1 つだけ実行されるようになります。

代替 IA-Connect エージェントを実行する

ファイルの場所からエージェント実行可能ファイルを読み込んで、別の IA-Connect エージェント (新しいバージョンなど) を実行します。

使用可能な IA-Connect セッションを取得する

IA-Connect Director セッションの一覧を取得します (ローカル、Microsoft RDP、Citrix ICA など、IA-Connect エージェントが実行されているセッションへの使用可能な接続)。

例外を発生させる

入力例外が空白でない場合は、指定されたメッセージで例外を発生させます。 これは、フロー (HTTP 400) で例外メッセージをトリガーする場合に役立ちます。これは、以前のアクションでエラーが発生した場合に、エラー処理ステージによってキャッチされます。 この例外は、IA-Connect Orchestrator フローの実行統計には記録されません。

保存されたパスワードを取得する

以前に生成または保存されたパスワードを取得します。

名前で IA-Connect セッションにアタッチする

指定した IA-Connect Director セッションに名前でアタッチします。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

名前でセッション IA-Connect 強制終了する

指定した IA-Connect Director セッションが存在する場合は強制終了します。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

名前でプロセス数を取得する

指定したプロセス名を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスの数を返します。

四角形の座標を変換する

四角形のピクセル座標を仮想から物理または物理から仮想に変換します。 ポイントを変換する場合は、Right=Left と Bottom=Top を設定するだけです。 物理座標は、モニター上のピクセルに直接マップされます。 仮想座標は DPI スケーリングされます。 すべてのディスプレイ デバイスの基になるディスプレイ スケーリングが 100%の場合、物理座標と仮想座標の両方が同じです。

座標でのマウスのダブルクリック

指定した座標の IA-Connect Agent ユーザー セッションでマウスの左ボタンをダブルクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

座標でのマウスの中央クリック

指定した座標の IA-Connect Agent ユーザー セッションでマウスの中央ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

座標でピクセルカラーを取得する

指定した座標でのピクセルの RGB 色を返します。

座標でマウスを右クリックする

指定した座標にある IA-Connect Agent ユーザー セッションでマウスの右ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

座標でマウスを左クリックする

指定した座標にある IA-Connect Agent ユーザー セッションのマウスの左ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

座標間でのマウスの中央ドラッグ

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの中央ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

座標間でのマウスの左ドラッグ

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの左ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

座標間でマウスを右にドラッグする

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの右ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

座標間でマウスを移動する

IA-Connect Agent ユーザー セッションで、指定した 2 つの座標間でマウスを移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

強制終了プロセス

指定したプロセス名を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスをすべて強制終了します。

強制終了プロセス ID

指定したプロセス ID を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスを強制終了します。プロセス ID は一意であるため、1 つのプロセスのみが ID と一致します。プロセス ID は動的であり、アプリケーションを起動するたびに異なります。

新しい Orchestrator 自動化タスクを追加する

フローから監視できるキューに新しい Orchestrator 自動化タスクを追加します。 タスクは、すぐに実行できる状態にすることも、後で実行できるように延期することもできます。

新しい Orchestrator 自動化タスク操作を追加する

新しい Orchestrator 自動化タスクを追加し、操作 ID を受け取ります。タスクが外部ポーラーまたはオーケストレーター トリガーによって処理されている場合は、特定のタスク名が必要です。 このアクションは、推測可能なタスク ID ではなく、否定できない操作 ID で応答するという点で、"新しいオーケストレーター自動化タスクの追加" (TasksAddNewTaskOperation) とは異なります。

新しい Orchestrator 遅延タスクを追加する

フローから監視できるキューに新しい Orchestrator 遅延タスクを追加します。 タスクは、今後指定した時間に延期されます。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

新しい Orchestrator 遅延タスク操作を追加する

新しい Orchestrator 遅延タスクを追加し、操作 ID を受け取ります。タスクは、今後指定した時間に延期されます。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。 タスクが外部ポーラーまたはオーケストレーター トリガーによって処理されている場合は、特定のタスク名が必要です。 このアクションは、推測可能なタスク ID ではなく、繰り返し不可能な操作 ID で応答するという点で、"新しいオーケストレーター遅延タスクの追加" (TasksAddNewDeferral) とは異なります。

既存の Orchestrator 自動化タスクを延期する

キューに既に存在する既存の Orchestrator タスクを延期します。 タスクは、今後指定した時間に延期されます。 これは一般的に、既存のタスクを再延期するために使用されます (つまり、タスクは以前に延期されており、ここでもう一度延期する必要があります)。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

既存の Orchestrator 自動化タスク操作を延期する

キューに既に存在する既存の Orchestrator タスクを延期します。 タスクは、今後指定した時間に延期されます。 これは一般的に、既存のタスクを再延期するために使用されます (つまり、タスクは以前に延期されており、ここでもう一度延期する必要があります)。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

既定のプリンターを取得する

IA-Connect エージェント セッションのユーザーの既定のプリンターの名前を取得します。

既定のプリンターを設定する

IA-Connect エージェント セッションのユーザーの既定のプリンターを設定します。

最後の入力情報を取得する

IA-Connect エージェント ユーザー セッションで最後のユーザー入力が受信されてからの時間を取得します。

最新の IA-Connect セッションにアタッチする

最近接続した IA-Connect Director セッションにアタッチします (必要に応じて、指定した種類)。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

次の Orchestrator 自動化タスクを取得する

指定された検索条件に一致する次の Orchestrator 自動化タスクを取得します。 取得できるのは、(延期日に達した) 'New' タスクと 'Deferred' タスクだけです。 保留タスクは取得されません。

次ホップ IA-Connect Director を構成する

ダブルホップ シナリオで次ホップ ディレクターを構成します。 これは、既定の IA-Connect 次ホップ ディレクター設定が適していない場合にのみ必要です。

次ホップ IA-Connect ディレクターの設定をリセットする

設定されているカスタム IA-Connect Director の設定をリセットし、既定の設定を復元します。

次ホップ IA-Connect 有効にする

次ホップ セッションで実行されている IA-Connect エージェントに受信したすべてのコマンドを転送する次ホップを有効にします。

次ホップ IA-Connect 無効にする

(次ホップ エージェントに転送されるのではなく) それを受け取るエージェントによって今後のすべてのコマンドが処理されるように、次ホップを無効にします。

次ホップ IA-Connect 状態を取得する

このコマンドを受信するエージェントの次ホップ ディレクターの状態を報告します。 次ホップが有効になっている場合、そのエージェントはコマンドを次ホップ (次ホップ ディレクター経由) に転送します。 次ホップが無効になっている場合、そのエージェントはコマンド自体を処理します (既定)。

次ホップ セッション IA-Connect 接続するまで待ちます

次ホップ セッションが接続し、IA-Connect エージェントが次ホップ セッションで実行されるまで待機します。

汎用 IA-Connect Agent コマンドを実行する

引数を JSON として渡し、出力データを JSON として返す汎用 IA-Connect Agent コマンドを実行します。 ディレクターとインスペクターがエージェントより古いバージョンであるため、コマンドを理解していない場合にエージェント コマンドを実行するために使用されます。

現在のマウス座標を取得する

setcursorpos API を使用して、IA-Connect エージェント ユーザー セッション内の現在のマウス カーソル位置を取得します。

環境変数を展開する

IA-Connect エージェント ユーザー セッションの環境変数 (%USERPROFILE% や %TEMP%など) を含む文字列を展開します。

環境情報を取得する

IA-Connect エージェント ユーザー セッションが実行されている環境に関する情報を返します。

画面に四角形を描画する

画面座標の識別、または画面座標を報告するアクションの出力を支援する四角形を画面上に描画します。 四角形は、5 秒後に自動的に削除されます。

画面の解像度を取得する

IA-Connect エージェント ユーザー セッションの画面解像度を返します。 物理デスクトップまたはノート PC で実行されている IA-Connect ローカル エージェントの場合、これにより、すべてのディスプレイ デバイスとそのスケーリングに関する情報が提供されます。 仮想マシンでは、仮想マシンが複数のディスプレイを表示するように構成されていない限り、通常は 1 つのディスプレイのみが報告されます (一般的ではありません)。 通常、リモート セッションでは 1 つの仮想ディスプレイが作成されるため、リモート セッションでは複数のローカル ディスプレイにまたがる場合でも、通常は 1 つのディスプレイのみが報告されます。

親プロセス ID を取得する

指定されたプロセス ID を持つ IA-Connect Agent ユーザー セッションで実行中のすべてのプロセスの親プロセスのプロセス ID を返します。

階層 1 IA-Connect セッションにアタッチする

SOAP メッセージまたは REST メッセージを受信するディレクターの IA-Connect Director セッションにアタッチします。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

CSV テキストをコレクションとして取得する

IA-Connect エージェントがコレクション (テーブル) として実行されているコンピューター上の CSV ファイルを返します。 CSV ファイルへの読み取り専用アクセスのみが必要です。

パラメーター

名前 キー 必須 説明
CSV ファイルのパス
CSVFilePath True string

CSV ファイルへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

最初の行はヘッダーです
FirstLineIsHeader boolean

CSV ファイルの最初の行はヘッダー行ですか?

ヘッダーをトリミングする
TrimHeaders boolean

先頭または末尾の空白を削除するためにヘッダーをトリミングする必要がありますか?

空の行を許可する
AllowBlankRows boolean

true (既定値) に設定すると、CSV データ内の完全に空白の行が許可され、空の行として返されます。 false に設定すると、返されたデータでは完全に空白の行が削除されます (ファイルはそのまま残ります)。

必要に応じて列を拡張する
ExtendColumnsIfRequired boolean

true に設定し、一致する列ヘッダーがないデータ内にセルがある場合 (つまり、ヘッダー行よりも多くのセルを含む行)、Column_Nという名前の列ヘッダーが自動的に作成されます (N は列インデックスです)。 false (既定値) に設定すると、行に一致する列のないデータが含まれている場合は例外が発生します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
CSV データ JSON
CSVDataJSON string

JSON 形式の CSV ファイルの内容。

CSV ファイルへの書き込み

IA-Connect エージェントが実行されているコンピューターに CSV ファイルを作成します。 CSV ファイルは、コレクション (テーブル) または JSON 形式のテーブルから作成されます。

パラメーター

名前 キー 必須 説明
プロパティ
Properties object
入力テーブル JSON
InputTableJSON string

CSV ファイルに書き込むデータのテーブル (JSON 形式)。

出力 CSV ファイルのパス
CSVFilePath True string

CSV ファイルへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

出力エンコード
OutputEncoding string

CSV ファイルに書き込むときに使用するテキスト エンコード形式。 サポートされているエンコードは、UTF8、UTF7、Unicode、ASCII です。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
WriteCollectionToCSVFileResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

HTTP ファイルのダウンロード

http(S) を使用して、IA-Connect エージェントが実行されているコンピューターにファイルをダウンロードします。

パラメーター

名前 キー 必須 説明
URL のダウンロード
DownloadURL True string

HTTP または HTTPS のダウンロード URL。

ファイル パスを保存する
SaveFilename string

保存ファイル名の完全なパス。 このフィールドが空白で、[文字列として内容を返す] を True に指定した場合、ファイルはコンピューターに保存されません。

既存のファイルを上書きする
OverwriteExistingFile boolean

[ファイル パスの保存] 入力で指定した名前のファイルが既に存在する場合は、上書きする必要がありますか?

パススルー認証
PassthroughAuthentication boolean

ユーザーの資格情報を Web サーバーに渡す必要がありますか? これは通常、内部イントラネット サイトにのみ使用されます。

ユーザー エージェント
UserAgent string

これにより、Web ページに報告されたユーザー エージェントを設定できます。 通常、これは必須ではなく、Web ページに特定のエージェント文字列が必要な場合にのみ変更する必要があります。

Accept
Accept string

このパラメーターは、サポートされるコンテンツ タイプを指定します。 これは、ダウンロードするコンテンツに別のコンテンツ タイプが必要な場合にのみ変更する必要があります。

TLS10 のサポート
SupportTLS10 boolean

TLS 1.0 暗号化プロトコルをサポートするには、True に設定します。

TLS11 のサポート
SupportTLS11 boolean

TLS 1.1 暗号化プロトコルをサポートするには、True に設定します。

TLS12 のサポート
SupportTLS12 boolean

TLS 1.2 暗号化プロトコルをサポートするには、True に設定します。

Deflate の自動展開
AutoDecompressDeflate boolean

一部の Web コンテンツは、"deflate" 圧縮を使用して圧縮されて返されます。 この値を True に設定すると、"deflate" がサポートされていることが Web サーバーに通知され、この圧縮を使用してコンテンツが送信されると、自動的に展開されます。

GZip の自動展開
AutoDecompressGZIP boolean

一部の Web コンテンツは、'GZIP' 圧縮を使用して圧縮されて返されます。 この値を True に設定すると、"GZIP" がサポートされていることが Web サーバーに通知され、この圧縮を使用してコンテンツが送信されると、自動的に展開されます。

内容を文字列として返す
ReturnContentsAsString boolean

ファイルの内容を文字列として返す必要がありますか?

コンテンツ エンコードを返す
ReturnContentEncoding string

ダウンロードしたコンテンツのエンコード。 これは、'Return contents as string' が True で、ダウンロードしたコンテンツのエンコードを定義して正しく解釈できる場合にのみ使用されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ファイルの内容をダウンロードする
DownloadFileContents string

ダウンロードしたファイルの内容。

IA-Connect セッションが名前で閉じるのを待ちます

指定した IA-Connect Director セッションが閉じるのを待ちます。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

パラメーター

名前 キー 必須 説明
IA-Connect セッション名
IAConnectSessionName True string

確認する IA-Connect セッションの名前。

秒単位で待機する時間
TimeToWaitInSeconds integer

指定した型のセッションがない場合 (特定の型が指定された場合)、待機 IA-Connect 時間はどのくらい必要ですか?

タイムアウトした場合に例外を発生させる
RaiseExceptionIfTimedout boolean

タイムアウト期間が経過する前に新しいセッションが接続されていない場合は、IA-Connect 例外を発生させる必要がありますか?

成功した場合に階層 1 IA-Connect セッションにアタッチする
AttachToTier1IAConnectSessionOnSuccess boolean

セッション IA-Connect 正常に終了した場合、階層 1 IA-Connect セッション (SOAP または REST メッセージを受信しているディレクターの IA-Connect Director セッション) に接続し直す必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect セッションが閉じられた
IAConnectSessionClosed boolean

指定した名前のセッションが閉じている場合は true、閉じていない場合は false を返します。

アタッチされた階層 1 IA-Connect セッション名
AttachedTier1IAConnectSessionName string

接続された階層 1 IA-Connect セッションの名前。

IA-Connect セッションにインデックスでアタッチする

指定した IA-Connect Director セッションにインデックスでアタッチします (たとえば、最初の Citrix ICA セッションにアタッチします)。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

パラメーター

名前 キー 必須 説明
セッションの種類 IA-Connect 検索
SearchIAConnectSessionType string

検索するセッションの種類 ("ローカル エージェント"、"Microsoft RDP"、"Citrix ICA"、"リモート" など)。 任意のセッションの種類を検索するには、空白のままにします。

セッション インデックス IA-Connect 検索
SearchIAConnectSessionIndex integer

接続するセッションのインデックス。たとえば、最初の一致するセッションの種類は 1、2 番目の一致するセッションの種類は 2 です。

秒単位で待機する時間
TimeToWaitInSeconds integer

指定したインデックスを持つセッションが存在しない場合は、IA-Connect どのくらいの時間待機する必要がありますか?

タイムアウトした場合に例外を発生させる
RaiseExceptionIfTimedout boolean

タイムアウト期間が経過する前に新しいセッションが接続されていない場合は、IA-Connect 例外を発生させる必要がありますか?

仮想チャネルが接続されている必要があります
VirtualChannelMustBeConnected boolean

IA-Connect Director は、セッションにアタッチするときに仮想チャネルが接続されていることを検証する必要がありますか? これにより、IA-Connect エージェントが指定されたセッションで実行されるようになります。

前に表示されていないセッションのみをカウントする
OnlyCountSessionsNotSeenBefore boolean

true に設定すると、以前に実行した "使用可能な IA-Connect セッションの取得" アクション (または IA-Connect Inspector の表示セッション) によって表示されたセッションはインデックスにカウントされません。 これにより、"新しい" セッションのみをカウントできます (たとえば、最初の新しい Citrix セッションにアタッチする)。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アタッチされた IA-Connect セッション名
AttachedIAConnectSessionName string

アタッチされた IA-Connect セッションの名前。

セッションにアタッチ済み
AttachedToSession boolean

IA-Connect がセッションにアタッチされている場合は true、アタッチされていない場合は false を返します。

INI ファイル内の変数データを置き換える

INI ファイル内の 1 つの変数を更新します。

パラメーター

名前 キー 必須 説明
INI ファイル パス
InputFilename True string

INI ファイルへの完全パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

出力 INI ファイル パス
OutputFilename string

更新された INI ファイルを別のファイルに書き込む場合は、出力ファイルへの完全なパスをここに入力します。 入力 INI ファイルは変更されません。出力 INI ファイルは変更を保持します。

INI 検索セクション
SearchSection string

変更する変数を保持するセクションの省略可能な名前。

INI 検索変数名
SearchVariable string

更新する変数の名前。

置換データ
ReplaceData string

変数を更新する置換データ。

INI ファイルのエンコード
InputFilenameEncoding string

INI ファイル エンコード (Unicode、UTF8、UTF7、または ASCII) を指定するか、エンコード値 (西ヨーロッパの場合は 1252 など) を指定します。

入力ファイルが存在しない場合は新しいファイルを作成する
CreateNewFileIfNotExists boolean

入力ファイルが存在しない場合は、新しいファイルを作成する必要がありますか?

等しい前にスペースを書き込む
WriteSpaceBeforeEquals boolean

等号 ( = ) 記号の前にスペースを書き込む必要がありますか?

等しい後にスペースを書き込む
WriteSpaceAfterEquals boolean

等号 ( = ) 記号の後にスペースを書き込む必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

mouse_eventの調整

指定したピクセル数だけマウスを移動し、新しいマウス位置を読み取って、mouse_eventメソッドを調整します。

パラメーター

名前 キー 必須 説明
調整サイズ (ピクセル単位)
CalibrationSizeInPixels integer

調整するためにマウスを移動するピクセル数。 値が小さいほど、キャリブレーションの精度は低くなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
マウス X 乗数
MouseXMultiplier double

マウス X 乗数の値。 値 1.0 は乗数がないことを示します。

マウス Y 乗数
MouseYMultiplier double

マウスの Y 乗数の値。 値 1.0 は乗数がないことを示します。

Orchestrator worker の一覧を取得する

IA-Connect Orchestrator に登録されているワーカーとそのライブ 状態の一覧を取得します。

パラメーター

名前 キー 必須 説明
ライブ ワーカーのみを返す
OnlyReturnLiveWorkers boolean

ライブ ワーカー (Orchestrator にアクティブに接続されているワーカー) のみを返すには、true に設定します。

戻り値

名前 パス 説明
オーケストレーター ワーカー
OrchestratorWorkers array of object

IA-Connect Orchestrator に登録されているワーカーの一覧と、そのライブ 状態。

ID (アイディー)
OrchestratorWorkers.Id integer
名前
OrchestratorWorkers.Name string
CurrentFlowDisplayName
OrchestratorWorkers.CurrentFlowDisplayName string
LiveStatus
OrchestratorWorkers.LiveStatus boolean
LiveStatusLastContactTicks
OrchestratorWorkers.LiveStatusLastContactTicks integer
SecondsSinceLastContact
OrchestratorWorkers.SecondsSinceLastContact integer
MaintenanceMode
OrchestratorWorkers.MaintenanceMode boolean
Priority
OrchestratorWorkers.Priority integer
AgentIsLicensed
OrchestratorWorkers.AgentIsLicensed boolean
IsAvailableForWork
OrchestratorWorkers.IsAvailableForWork boolean
ワーカーの数
NumberOfOrchestratorWorkers integer

応答内の Orchestrator worker の数。

Orchestrator worker の可用性の状態を取得する

基本的なオーケストレーターの状態を取得します。 これを使用して、Orchestrator が使用可能であり、応答していることを確認できます。

戻り値

名前 パス 説明
ワーカーの合計数
TotalWorkersCount integer

Orchestrator で定義されている IA-Connect ワーカーの数(動作しているかどうかに関係なく)。

使用可能なワーカーの数
AvailableWorkersCount integer

Orchestrator で定義 IA-Connect ワーカーの数。作業に使用できます。 使用可能とは、現在実行中のフロー (自動化) ではなく、メンテナンス モードではなく、ライセンスを取得して応答していることを意味します。 これは、新しい受信作業を受け入れるために使用できるワーカーの数です。

使用できないワーカーの数
UnavailableWorkersCount integer

Orchestrator で定義 IA-Connect ワーカーの数。このワーカーは作業に使用できません。 これは、ワーカーの合計数から使用可能なワーカーの数を引いた値に等しくなります。

フローを実行しているワーカーの数
WorkersRunningFlowsCount integer

フロー (オートメーション) を実行している Orchestrator で定義されている IA-Connect ワーカーの数。 これらのワーカーはビジー状態のため、仕事に使用できません。

メンテナンス モードのワーカーの数
WorkersInMaintenanceModeCount integer

Orchestrator で定義 IA-Connect ワーカーの数。メンテナンス モードです。 これらのワーカーは、新しい作業を受け入れないように手動で構成されているため、作業に使用できません。

ライブ ワーカーの数
LiveWorkersCount integer

Orchestrator で定義されている IA-Connect ワーカーのうち、応答しているワーカーの数。 これらのワーカーは、ライセンスのない、メインセンス モード、または実行中のフロー (自動化) である可能性があるため、作業に使用できる場合と使用できない場合があります。

ライセンスされたワーカーの数
LicensedWorkersCount integer

Orchestrator で定義されている IA-Connect ワーカーの数。応答してライセンスが付与されています。 オーケストレーターはワーカーが応答している場合にのみワーカーのライセンス状態を認識するため、ライセンスされたワーカーは常に応答します (したがって、オーケストレーターにその状態を通知します)。 ワーカーが応答を停止した場合、オーケストレーターではライセンスが付与されたと見なされなくなります。 これらのワーカーは、メインテンス モードまたは実行中のフロー (自動化) であるため、作業に使用できる場合と使用できない場合があります。

Orchestrator worker を取得する

IA-Connect Orchestrator に登録されている個々のワーカーの詳細とライブ 状態を取得します。

パラメーター

名前 キー 必須 説明
検索ワーカー ID
SearchWorkerId integer

取得するワーカーの ID。 特定の ID を持つワーカーの詳細を取得するには、1 以上の値に設定します。ID で worker を取得しない場合は、0 に設定します。

検索ワーカー名
SearchWorkerName string

取得するワーカーの名前。 名前でワーカーを取得しない場合は、空白または null に設定します。

戻り値

名前 パス 説明
ワーカー ID
WorkerId integer

このワーカーの内部オーケストレーター ID。

Worker 名
WorkerName string

このワーカーの内部オーケストレーター名。

Worker の説明
WorkerDescription string

このワーカーの内部オーケストレーターの説明。

現在のフローの表示名
CurrentFlowDisplayName string

この作業によって処理されるフローの表示名。ワーカーがアイドル状態の場合は空白です。

Worker のライブ 状態
LiveStatus boolean

True の 場合、ワーカーが現在 Orchestrator に接続され、ポーリングに応答します。 False(ワーカーが接続されていない場合)。

最後の連絡先ティック
LiveStatusLastContactTicks integer

オーケストレーターが最後にワーカーと接触した時刻 (ティック単位)。 これは、0001 年 1 月 1 日午前 0 時 00 分 (UTC) 12:00:00 から経過した 100 ナノ秒間隔の数です。 これは一般的な、ユニバーサルな時刻形式です。

前回の連絡先からの秒数
SecondsSinceLastContact integer

オーケストレーターが最後にワーカーと接触してから経過した時間 (秒単位)。 これは、"最後の接触ティック" と同じ時点を表しますが、相対秒数で表されます。

メンテナンス モードのワーカー
MaintenanceMode boolean

True の 場合、ワーカーが現在メンテナンス モードです。 False(ワーカーがメンテナンス モードでない場合)。

ワーカーの優先度
Priority integer

ワーカーに割り当てられた優先度を表す 1 以上の整数値。 優先順位 1 が最も高い優先順位です。 フローは、優先度が最も高い使用可能なワーカーに送信されます。 複数のワーカーが同じ優先度を持つ場合があり、Orchestrator は "Worker 負荷分散方法" (「サイト設定」を参照) を使用して使用可能なワーカーを選択します。

ワーカーのタイムアウト (秒単位)
TimeoutInSeconds integer

オーケストレーターが IA-Connect Director からの REST API 応答を待機してからタイムアウトするまでの時間 (秒単位)。

worker is licensed
AgentIsLicensed boolean

True の 場合、ワーカーが現在ライセンスされています。 False (worker がライセンスされていない場合)。 ワーカーがライセンスされているかどうかを Orchestrator が認識しない場合は Null (応答していない可能性があります。これは、ポーリングでライブ ライセンス更新プログラムを提供しない非常に古いエージェントである可能性があります)。

エージェント ライセンス機能
AgentLicenseFeatures string

特定のエージェント ライセンス機能。 例: Joiner、Mover、Leaver ライセンスの JML。

ワーカーは仕事に使用できます
IsAvailableForWork boolean

True の 場合、ワーカーが作業に使用できます。つまり、ワーカーは受信した作業を受け入れることが可能です。 False (ワーカーがそうでない場合)。 作業に使用できる状態は、a) ワーカーの状態がライブであるか、b) メンテナンス モードのワーカーか、c) ワーカーがライセンスを取得していますか、d) 現在フローを処理しているワーカーです。

ワーカー接続の種類 ID
WorkerConnectionTypeId integer

構成されたワーカー接続の種類の ID。ワーカーを Orchestrator に接続するために使用されます。 これは、"Azure WCF Relay" の場合は 1、'Azure ハイブリッド接続' の場合は 2、'Azure Virtual Network (VNet) の場合は 3、'Direct' の場合は 4 です。

ワーカー接続の種類名
WorkerConnectionTypeName string

構成されたワーカー接続の種類の名前。ワーカーを Orchestrator に接続するために使用されます。 これは、AzureWCFRelay、AzureHybridConnection、AzureVNet、Direct です。

ディレクター REST API URL
DirectorRestApiUrl string

構成された接続の種類がハイブリッド接続(VNet または直接)の場合、このプロパティにはワーカー REST API URL が含まれます。これは通常、HTTP トラフィックが HTTPS トンネル内で暗号化されるためです (ハイブリッド接続やオンプレミス データ ゲートウェイなど)。 構成された接続の種類が Azure WCF Relay の場合、このプロパティには WCF リレー URL が含まれます。

Azure Service Bus 名前空間
AzureServiceBusNamespace string

構成された接続の種類が Azure WCF Relay の場合、これには Azure Service Bus 名前空間が含まれます。

Azure WCF リレー名
AzureWCFRelayName string

構成されている接続の種類が Azure WCF Relay の場合、このプロパティには Azure WCF リレー名が含まれます。

エージェント接続の種類名
IAConnectAgentConnectionTypeName string

エージェント接続の種類の名前。 "ローカル エージェント"、"Citrix ICA" または "Microsoft RDP" を指定できます。

次ホップ ディレクターにアタッチ
AttachedToNextHopDirector boolean

オーケストレーターに接続されているディレクター (通常はローカル エージェントによってホストされているディレクター) が次ホップ ディレクター (通常は Citrix ICA または Microsoft RDP Director) にアクションを転送している場合、このプロパティは True に設定されます。 ディレクターが接続先のエージェント (通常はローカル エージェント) にアクションを直接送信する場合、このプロパティは False に設定されます。

次ホップ ディレクター セッションの種類
NextHopDirectorSessionType string

オーケストレーターに接続されているディレクター (通常はローカル エージェントによってホストされているディレクター) が、次ホップ ディレクター (通常は Citrix ICA または Microsoft RDP Director) にアクションを転送している場合、このプロパティは接続の種類の名前を保持します。これは "Citrix ICA" または "Microsoft RDP" になります。

ディレクター バージョン
DirectorVersion string

IA-Connect Director の内部バージョン。REST API インターフェイスを処理し、IA-Connect worker で実行されている IA-Connect エージェントに対して IA-Connect Inspector を提供します。

エージェントのバージョン
AgentVersion string

IA-Connect ワーカーで実行されている IA-Connect エージェントの内部バージョン。

ディレクターリリースバージョン
DirectorReleaseVersion double

rest API インターフェイスを処理し、IA-Connect ワーカーで実行されている IA-Connect エージェントの IA-Connect Inspector を提供する、IA-Connect Director の IA-Connect リリース バージョン。

エージェントのリリース バージョン
AgentReleaseVersion double

IA-Connect ワーカーで実行されている IA-Connect エージェントの IA-Connect リリース バージョン。

ディレクターのホスト名
DirectorHostname string

IA-Connect Director をホストしているオペレーティング システムのホスト名。 これはワーカーのホスト名であり、通常はワーカー名と同じです。

ディレクター NETBIOS ドメイン名
DirectorNetBIOSDomainName string

IA-Connect ワーカーで実行されている IA-Connect エージェントのコンポーネントである、IA-Connect Director をホストしているオペレーティング システムの NETBIOS ドメイン名。 ワークグループの場合、これは通常、worker ホスト名です。 Active Directory ドメインの場合、これはドメイン NetBIOS 名です。 たとえば、MYDOMAIN です。

ディレクター DNS ドメイン名
DirectorDNSDomainName string

IA-Connect ワーカーで実行されている IA-Connect エージェントのコンポーネントである、IA-Connect Director をホストしているオペレーティング システムの DNS ドメイン名。 ワークグループの場合、通常は空白です。 Active Directory ドメインの場合、これはドメイン DNS 名です。 例: mydomain.local。

サポートされているフロー環境 ID の数
SupportedFlowEnvironmentIdsCount integer

指定されたフロー環境 ID からのフローのみを処理するように worker が構成されている場合、このプロパティは、サポートされているフロー環境 ID の数を一覧に保持します。 ワーカーが任意の環境からのフローを処理できる場合、このプロパティは 0 を保持します。

サポートされているフロー名の数
SupportedFlowNamesCount integer

ワーカーが特定の名前を持つフローのみを処理するように構成されている場合、このプロパティは、一覧でサポートされているフロー名の数を保持します。 ワーカーが任意の名前でフローを処理できる場合、このプロパティは 0 を保持します。

サポートされていないフロー名の数
UnsupportedFlowNamesCount integer

ワーカーが特定の名前を持つフローの処理を拒否するように構成されている場合、このプロパティは、サポートされていないフロー名の数を一覧に保持します。 ワーカーが特定のフローを拒否するように構成されていない場合、このプロパティは 0 を保持します。

worker タグの数
WorkerTagsCount integer

ワーカーが一部のタグで構成されている場合、このプロパティはリスト内のタグの数を保持します。 ワーカーにタグがない場合、このプロパティは 0 を保持します。

worker 必須タグの数
WorkerMandatoryTagsCount integer

ワーカーがいくつかの必須タグで構成されている場合、このプロパティはリスト内の必須タグの数を保持します。 ワーカーに必須のタグがない場合、このプロパティは 0 を保持します。

Orchestrator worker メンテナンス モードを設定する

IA-Connect Orchestrator で定義されている IA-Connect ワーカーをメンテナンス モードにするか (フローがワーカーに割り当てられないように)、またはワーカーをメンテナンス モードから外します。

パラメーター

名前 キー 必須 説明
ワーカー ID
WorkerId integer

ワーカーの ID。 これは、オーケストレーターの内部にある整数値 (1 以上) です。 Orchestrator UI で worker の詳細を表示し、ブラウザーの URL で ID を探すことで、ワーカーの ID を確認できます。 名前でワーカーを検索する場合は、この値を 0 に設定し、[Worker name] フィールドに名前を入力します。

ワーカー名
WorkerName string

ワーカーの名前。 これにより、Orchestrator は、指定された名前のワーカーのワーカーの一覧を検索します。 名前で検索する場合は、'Worker Id' を 0 に設定します (ワーカー ID の使用を無効にする場合)。

メンテナンス モード
MaintenanceMode boolean

メンテナンス モードを有効にするには true (既定値) に設定します。そのため、フローはワーカーに割り当てません。 メンテナンス モードを終了するには false に設定し、フローをワーカーに割り当てることができます (ワーカーが他のルールによって拒否されていない場合)。

戻り値

名前 パス 説明
コマンドの結果
SetOrchestratorWorkerMaintenanceModeResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator から worker の可用性統計を取得する

IA-Connect Orchestrator からワーカーの可用性統計を返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

パラメーター

名前 キー 必須 説明
過去数日以内
WithinLastNumberOfDays integer

結果をフィルター処理して、最後に指定した日数内に開始されたもののみを取得します。 フィルター処理しない場合は 0 に設定します。

フロー名
SearchFlowName string

結果をフィルター処理して、指定されたフロー名を持つ結果のみを取得します。 フロー名でフィルター処理しない場合は空白に設定します。

フロー開始時刻の開始ウィンドウ
SearchFlowStartTimeStartWindow date-time

指定した開始時刻より後に開始された結果のみを取得するように結果をフィルター処理します。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-24T07:00:00' は、2022 年 1 月 24 日に 07.00 時間後に開始されたフローのすべての Orchestrator Flow 統計を返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

戻り値

名前 パス 説明
ワーカーの可用性統計 JSON
WorkerAvailabilityStatsJSON string

JSON 形式の worker 可用性統計の一覧。

worker 可用性統計の数
NumberOfWorkerAvailabilityStats integer

返された worker 可用性統計の数。

Orchestrator から worker を割り当てる

IA-Connect Orchestrator からワーカーを割り当てます。 タグまたはワーカー名 (またはその両方) を使用してワーカーを要求できます。これにより、必要なワーカーをより正確に選択できます。 ワーカーが割り当てられると、そのワーカーはフローに割り当てられ、作業の実行として報告されます。 オーケストレーターでは、割り当てを実行するときに、引き続き "サポートされているフロー環境 ID"、"サポートされているフロー名"、および "サポートされていないフロー名" が考慮されることに注意してください。 複数のワーカーが検索に一致する場合は、通常の負荷分散規則が適用されます。

パラメーター

名前 キー 必須 説明
ワーカー タグ
WorkerTag string

割り当てるワーカーの省略可能なタグ。 タグを使用すると、ワーカーをグループに分類できます。 タグ名では大文字と小文字は区別されません。 複数のタグを別々の行に入力することで指定できます。割り当てメカニズムでは、これらのタグのいずれかを持つ任意のワーカーが考慮されます (一致する必要があるタグは 1 つだけです)。 ワイルドカード検索は、ワイルドカード: タグ* 形式 (ワイルドカード: JML*など) を使用して実行できます。正規表現の検索には RegEx: TagExpression (RegEx: ^JML など) の形式を使用します。

ワーカー名
WorkerName string

割り当てるワーカーの省略可能な名前。 ワーカー名では大文字と小文字は区別されません。 複数の worker を個別の行に入力することで指定できます。割り当てメカニズムでは、一致する名前のワーカーが考慮されます。 ワイルドカード検索を実行するには、ワイルドカード: Name* (ワイルドカード: vmrpa* など) を使用し、正規表現検索には RegEx: Expression という形式を使用します (例: RegEx: ^vmrpa)。

ワーカーがすぐに使用できない場合は例外を発生させる
RaiseExceptionIfWorkerNotImmediatelyAvailable boolean

true に設定し、適切なワーカーを割り当てられなかった場合は、例外が発生します。 false (既定値) に設定され、適切なワーカーを割り当てられなかった場合、Orchestrator は HTTP 状態コード 500 を返し、"再試行ポリシー" に従って PA フローが待機します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
割り当てられたワーカー名
WorkerNameAllocated string

割り当てられたワーカーの名前。 ワーカーが割り当てられていない場合は空白。

Orchestrator からフロー統計を取得する

IA-Connect Orchestrator からフロー統計の一覧を返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

パラメーター

名前 キー 必須 説明
過去数日以内
WithinLastNumberOfDays integer

結果をフィルター処理して、最後に指定した日数内に開始されたもののみを取得します。 フィルター処理しない場合は 0 に設定します。

フロー名
SearchFlowName string

結果をフィルター処理して、指定されたフロー名を持つ結果のみを取得します。 フロー名でフィルター処理しない場合は空白に設定します。

フローの最後のアクションの結果
SearchFlowLastActionResult boolean

結果をフィルター処理して、指定した最後のアクションの結果のみを取得します。 成功したフローのみを取得する場合は true に設定します。 失敗したフローのみを取得する場合は false に設定します。 フローの最後のアクションの結果でフィルター処理しないように、値を空白に設定しないでください。

フロー開始時刻の開始ウィンドウ
SearchFlowStartTimeStartWindow date-time

指定した開始時刻より後に開始された結果のみを取得するように結果をフィルター処理します。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-24T07:00:00' は、2022 年 1 月 24 日に 07.00 時間後に開始されたフローのすべての Orchestrator Flow 統計を返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

フロー開始時刻の終了ウィンドウ
SearchFlowStartTimeEndWindow date-time

指定した開始時刻より前に開始されたもののみを取得するように結果をフィルター処理します。 フィルター処理しない場合は空白に設定します。 たとえば、"2022-01-25T07:00:00" は、2022 年 1 月 25 日に 07.00 時間以前に開始されたすべての Orchestrator Flow 統計を返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

戻り値

名前 パス 説明
オーケストレーター フロー統計 JSON
OrchestratorFlowStatsJSON string

すべてのオーケストレーター フロー統計の一覧 (JSON 形式)。

フロー統計の数
NumberOfOrchestratorFlowStats integer

返されたフロー統計の数。

Orchestrator からログイン履歴を取得する

レポート用の IA-Connect Orchestrator ログイン履歴を返します。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

パラメーター

名前 キー 必須 説明
過去数日以内
WithinLastNumberOfDays integer

指定した日数内の Orchestrator ログインのみを取得するように結果をフィルター処理します。 フィルター処理しない場合は 0 に設定します。

メール アドレス
SearchByEmail string

指定したメール アドレスを持つ Orchestrator ログインのみを取得するように結果をフィルター処理します。 メール アドレスでフィルター処理しない場合は空白に設定します。

ログイン履歴の開始期間
SearchLoginHistoryTimeStartWindow date-time

指定した開始時刻以降に Orchestrator ログインのみを取得するように結果をフィルター処理します。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-24T07:00:00' は、2022 年 1 月 24 日に 07.00 時間後にすべての Orchestrator ログインを返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

ログイン履歴の終了期間
SearchLoginHistoryTimeEndWindow date-time

指定した開始時刻より前の Orchestrator ログインのみを取得するように結果をフィルター処理します。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-25T07:00:00' は、2022 年 1 月 25 日に 07.00 時間以前のすべての Orchestrator ログインを返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

戻り値

名前 パス 説明
オーケストレーターログイン履歴 JSON
OrchestratorLoginHistoryJSON string

指定したフィルターを満たすすべての Orchestrator ログインの一覧 (JSON 形式)。

Orchestrator ログインの数
NumberOfOrchestratorLogins integer

返された Orchestrator ログインの数。

Orchestrator からワーカー フローの使用ヒートマップを取得する

IA-Connect Orchestrator からワーカー フロー使用状況の日次ヒートマップを返します。 レポートの目的で使用されます。 必要に応じて、1 つ以上のフィルターを使用して、返される結果を制限できます。

パラメーター

名前 キー 必須 説明
フロー開始時刻の開始ウィンドウ
SearchStartDateStartWindow True date-time

指定した開始日より後のワーカー フロー使用状況ヒートマップのみを取得するように結果をフィルター処理します (時刻コンポーネントは無視されます)。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-24T00:00:00' は、2022 年 1 月 24 日以降に開始されたフローのワーカー ヒートマップを返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

フロー開始時刻の終了ウィンドウ
SearchStartDateEndWindow True date-time

指定した開始日より前のワーカー フロー使用状況ヒートマップのみを取得するように結果をフィルター処理します (時刻コンポーネントは無視されます)。 フィルター処理しない場合は空白に設定します。 たとえば、'2022-01-25T00:00:00' は、2022 年 1 月 25 日以前に開始された Flow のワーカー ヒートマップを返します。 すべての日時は UTC (GMT+0) であるため、[DateTime の変換] アクションを使用して現地時刻を UTC に変換できます。

UTC からのタイム ゾーン分オフセット
TimeZoneMinutesOffsetFromUTC integer

1 日のヒートマップを揃える UTC からのタイム ゾーン オフセット (分)。 たとえば、60 分を指定した場合、毎日のヒートマップは 01:00 UTC から 01:00 UTC まで実行されます。

ワーカー名の IA-Connect
WorkerNames string

ヒートマップを返す IA-Connect Worker の名前の一覧 (JSON または CSV 形式)。 空白のままにすると、Orchestrator に現在認識されているすべてのワーカーに対してヒートマップが生成されます。 例: [{"WorkerName": "Worker1"}、{"WorkerName": "Worker2"}] (JSON テーブル形式)、["Worker1"、"Worker2"] (JSON 配列形式)、Worker1、Worker2 (CSV 形式)。

戻り値

名前 パス 説明
ワーカー フローの使用ヒートマップ JSON
WorkerFlowUsageHeatmapJSON string

JSON 形式のワーカー フロー使用ヒートマップ。

ワーカー フロー使用状況ヒートマップアイテムの数
NumberOfWorkerFlowUsageHeatmapItems integer

返されたワーカー フロー使用状況ヒートマップ項目の数。 ワーカーごとに 1 日に 1 つのアイテム。

Orchestrator から汎用資格情報を取得する

IA-Connect Orchestrator に格納されている汎用資格情報を取得します。 資格情報には、ユーザー名、パスワード、ホスト名、URL、およびその他の汎用データを保持できます。

パラメーター

名前 キー 必須 説明
フレンドリーな名前
FriendlyName string

Orchestrator に格納されている資格情報のフレンドリ名。

プレーンテキスト パスワードを取得する
RetrievePlainTextPassword boolean

オンにすると、Orchestrator の汎用資格情報設定 "パスワードを公開しない" が無効になっている場合 (パスワードの取得を許可する) 場合、指定した Orchestrator 汎用資格情報のパスワードがプレーン テキストとして返されます。 パスワードをプレーン テキストとして取得せず、代わりに、保存されたパスワードをサポートする IA-Connect アクション (例: "UIA アクションへのパスワードの入力") を使用することをお勧めします。このアクションでは、Orchestrator が実行時にアクションに直接パスワードを挿入します。

戻り値

名前 パス 説明
ユーザー名
Username string

汎用資格情報に保持されているユーザー名。

プレーンテキスト パスワード
PlainTextPassword string

プレーン テキスト文字列として汎用資格情報に保持されているパスワード。 オーケストレーター パスワードは暗号化されて保存されますが、プレーン テキストとして返され、必要なアクションに渡すことができます。

ホスト名
Hostname string

汎用資格情報に保持されているホスト名またはドメイン名 (使用されている場合)。

URL
Url string

汎用資格情報に保持されている URL (使用されている場合)。

ジェネリック プロパティ 1
GenericProperty1 string

汎用資格情報に保持されているジェネリック プロパティ (使用されている場合)。 これは、資格情報に関連付けられている可能性があるデータを格納するために使用できます。

ジェネリック プロパティ 2
GenericProperty2 string

汎用資格情報に保持されているジェネリック プロパティ (使用されている場合)。 これは、資格情報に関連付けられている可能性があるデータを格納するために使用できます。

ジェネリック プロパティ 3
GenericProperty3 string

汎用資格情報に保持されているジェネリック プロパティ (使用されている場合)。 これは、資格情報に関連付けられている可能性があるデータを格納するために使用できます。

Orchestrator の 1 回限りシークレットを作成する

1 回限りのシークレットは、一度取得できるシークレットを、一意の URL を使用して格納する機能を提供します。 これは通常、サード パーティとシークレットを共有するために使用されます。 Orchestrator UI、REST API、またはフローから 1 回限りのシークレットを作成できます。

パラメーター

名前 キー 必須 説明
フレンドリーな名前
FriendlyName True string

これは、この 1 回限りのシークレットを識別するために純粋に使用されるわかりやすい名前です。 この名前の唯一の目的は、Orchestrator UI のシークレットの一覧で表示することです。

シークレット値
SecretValue password

共有し、1 回限りの URL を介して使用できるようにする 1 回限りのシークレット値。

検索語句 1
RetrievalPhrase1 password

これは、一意の URL を使用して 1 回限りのシークレットを取得するために必要なフレーズです。 空白のままにした場合、取得語句は必要ありません。 取得フェーズでは、大文字と小文字が区別されます。

検索語句 2
RetrievalPhrase2 password

これは、一意の URL を使用して 1 回限りのシークレットを取得するために必要な 2 番目のフレーズです。 空白のままにした場合、取得語句は必要ありません。 取得フェーズでは、大文字と小文字が区別されます。

削除前の最大取得数
MaximumRetrievalsBeforeDeletion integer

オーケストレーターから削除される前に、この 1 回限りのシークレットを何回取得できますか? 既定では、これは 1 (1 回限り) に設定されます。 複数のユーザーがこのシークレットにアクセスする必要がある場合にのみ、より高い値に設定します。

シークレットに開始日がある
SecretHasAStartDate boolean

特定の日時までシークレットを取得できない場合に有効にします。

シークレットの開始日時
SecretStartDateTime date-time

このシークレットが取得可能になる日時。 日付と時刻は dd/MM/yyyy HH:mm 形式で入力され、UTC/GMT+0 で格納および処理されます。 たとえば、'2022-01-24T07:00:00' は、2022 年 1 月 24 日 (404) に 07.00 時間 UTC (GMT+0) より前にワンタイム シークレットが取得されないようにします。 または、"シークレットの開始時刻までの時間" 入力を使用します。 この入力を使用する場合は、'Secret has a start date' を true に設定する必要があります。または、入力は無視されます。

シークレットの開始時刻までの時間
HoursUntilSecretStartTime integer

このシークレットが取得できるようになるまでの時間数。 または、"シークレットの開始日と時刻" の入力を使用します。 この入力を使用する場合は、'Secret has a start date' を true に設定する必要があります。

シークレットに有効期限があります
SecretHasAnExpiryDate boolean

シークレットが取得されたかどうかに関係なく、一定期間後にシークレットを自動的に削除する必要がある場合に有効にします。

シークレットの有効期限の日付と時刻
SecretExpiryDateTime date-time

このシークレットが取得されたかどうかに関係なく、このシークレットが自動的に削除される日時。 日付と時刻は yyyy-MM-ddTHH:mm:ss 形式で入力され、UTC/GMT+0 で格納および処理されます。 たとえば、'2022-01-24T07:00:00' は、2022 年 1 月 24 日の 07.00 時間 UTC (GMT+0) に 1 回限りのシークレットを削除します。 または、[シークレットの有効期限が切れるまでの時間] 入力を使用します。 この入力を使用する場合は、'Secret has an expiry date' を true に設定する必要があります。または、入力は無視されます。

シークレットの有効期限が切れるまでの時間
HoursUntilSecretExpiry integer

このシークレットが取得されたかどうかに関係なく、このシークレットが自動的に削除されるまでの時間数。 または、"シークレットの有効期限の日付と時刻" の入力を使用します。 この入力を使用する場合は、'Secret has an expiry date' を true に設定する必要があります。

戻り値

名前 パス 説明
取得 URL
RetrievalURL string

ワンタイム シークレットの取得に使用される 1 回限りの URL。

取得 ID
RetrievalId string

一意の取得 ID。この 1 回限りの URL は、この一意の ID から構築されます。この ID は、カスタム シナリオで独自の URL を作成する必要がある場合に便利です。

Orchestrator の状態を取得する

基本的なオーケストレーターの状態を取得します。 これを使用して、Orchestrator が使用可能であり、応答していることを確認できます。

戻り値

名前 パス 説明
オーケストレーターのバージョン
OrchestratorVersion string

Orchestrator ソフトウェアのバージョン。

オーケストレーターの起動エラー
NumberOfStartupErrors integer

オーケストレーターの起動エラーの数。

オーケストレーターのアップタイム (秒単位)
UptimeInSeconds integer

オーケストレーターが実行されている秒数。

Orchestrator の自動化タスク操作を取得する

一意のタスク操作 ID を指定して、特定の Orchestrator オートメーション タスクを取得します。

パラメーター

名前 キー 必須 説明
操作 ID
OperationId True string

取得するオーケストレーター タスクの操作 ID。

戻り値

名前 パス 説明
Automation 名
AutomationName string

取得した Orchestrator タスクの名前。

延期日時
DeferralDateTime string

取得したオーケストレーター タスクの準備がスケジュールされている日時。 これは UTC で文字列として返されます。

保存されたデータの遅延
DeferralStoredData string

タスクが延期されたときに格納された省略可能なデータ。 これは通常、プロセス/フローを続行するために必要なデータです。

遅延数
DeferralCount integer

このタスクが延期された頻度。 これは通常、延期されなかった新しいタスクの場合は 0、遅延タスクの場合は 1 以上になります。 遅延タスクが再び延期されるたびに、Orchestrator はこの数を自動的に増やします。

タスク入力データ
TaskInputData string

タスクの作成時に格納された省略可能なデータ。 これは通常、プロセス/フローを開始するために使用されたデータですが、このフィールドは任意の目的で使用できます。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

タスク出力データ
TaskOutputData string

タスクの処理時にオートメーションによって格納された省略可能なデータ。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

Priority
Priority integer

このオーケストレーター タスクの優先度レベル (1 は最高レベル)。

Automation タスクの状態
AutomationTaskStatus string

取得した Orchestrator タスクの状態。

プロセス ステージ
ProcessStage string

遅延後に自動化プロセス/フローを続行するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。 たとえば、遅延後に "Exchange" ステージでプロセス/フローを続行する場合は、値 「Exchange」を入力します。

受信日時
ReceivedDateTime string

オーケストレーターによってタスクが最初に受信された日時。 これは UTC で文字列として返されます。

延期日までの分数
MinutesUntilDeferralDate integer

このタスクの延期日 (つまり、このタスクを実行する準備ができたら) までの分数。 このタスクを実行する準備ができた場合、分数は 0 になります。

保留中
OnHold boolean

タスクが保留中の場合は true に設定されます。 保留タスクは "Get next Orchestrator automation task" アクションによって取得されることはないため、一般的なタスク ワークフローでは処理されません。

機構
Organisation string

このタスクが関連付けられている組織。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

このタスクが関連付けられている部署。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

このタスクの説明。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てられている 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

Orchestrator オートメーション タスクにメモを追加する

選択した Orchestrator オートメーション タスクにメモを追加します。 このメモは、この自動化タスク (ServiceNow など) にリンクされているソース システムに渡され、最も一般的にチケットに詳細を追加するために使用されます。 Orchestrator 自動化タスクがソースにリンクされていない場合は、例外が発生します。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

メモを追加する Orchestrator タスクの ID。

テキストをメモする
NoteText True string

メモ テキスト メッセージ。

注の種類
NoteType string

ソース システムで異なるノートタイプ (作業メモ、クロージャノート、コメントなど) がサポートされている場合は、ここにノートタイプを入力します。 これは、ソース システムに応じて、異なる方法で解釈されます。 現在サポートされている型は、'WorkNote' (既定)、'CloseNote'、'Comment' です。 メモの種類が 1 つしかない場合は、「WorkNote」と入力します。 カスタム作業メモがある場合は、「その他」と入力します。

注: その他
NoteTypeOther string

ユーザー設定のメモの種類がある場合は、[その他] の [メモの種類] を選択し、このフィールドにユーザー設定の種類を入力します。

戻り値

名前 パス 説明
コマンドの結果
TasksAddNoteResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator オートメーション タスクの出力データを設定する

Orchestrator オートメーション タスクの出力データを設定します。 タスクを完了し、タスクを作成したプロセスによって収集される出力データを提供する場合に一般的に使用されます。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

メモを追加する Orchestrator タスクの ID。

タスク出力データ
TaskOutputData string

出力データ文字列。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。 出力データ文字列は、Orchestrator UI で表示することも、TasksGetTask REST API を使用してアクセスすることもできます。

戻り値

名前 パス 説明
コマンドの結果
TasksSetOutputDataResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator フロー統計から最後に失敗したアクションを取得する

IA-Connect Orchestrator を介してワーカーに渡された最後のアクションの詳細を取得します (そのアクションが失敗した場合)。 このアクションは、エラー処理時に最も一般的に使用されます。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
フロー実行に割り当てられたワーカー
WorkerAllocatedToFlowRun boolean

このフロー実行に割り当てられたワーカーがある場合は true を返します。そのため、最後のアクション エラーに関する情報を提供できます。 このフロー実行に割り当てられたワーカーがない (1 つが割り当てられていないか、ワーカーが別のフロー実行で使用可能になった) 場合は false を返します。そのため、最後のエラーに関する情報を提供できません。

最後のアクションが失敗しました
LastActionFailed boolean

このフロー実行の最後のアクション (このフロー実行に割り当てられたワーカーで実行される) が失敗した場合は true を返します。このアクションの他の出力には詳細が保持されます。 このフロー実行の最後のアクションが失敗しなかった場合は false を返します。他の出力は空白になります。

最後に失敗したアクション要求パス
LastFailedActionRequestPath string

このフロー実行の最後のアクション (このフロー実行に割り当てられたワーカーで実行) が失敗した場合、この出力にはアクション要求パスが含まれます。 これを使用して、失敗したアクションを特定できます。 このフロー実行の最後のアクションが失敗しなかった場合、この値は空白になります。

最後に失敗したアクションのエラー メッセージ
LastFailedActionErrorMessage string

このフロー実行の最後のアクション (このフロー実行に割り当てられたワーカーで実行) が失敗した場合、この出力にはエラー メッセージが含まれます。 このフロー実行の最後のアクションが失敗しなかった場合、この値は空白になります。

Orchestrator 自動化タスクの削除

延期された Orchestrator 自動化タスクを削除します。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

削除する Orchestrator オートメーション タスクの ID。

ソース システムを更新する
UpdateSourceSystem boolean

true (既定値) に設定され、Orchestrator タスクがソース システム (ServiceNow など) にリンクされている場合、Orchestrator は Orchestrator のソース システム構成で指定されたすべてのアクションを実行します (たとえば、チケットを閉じます)。 false に設定されている場合、またはタスクがソース システムにリンクされていない場合、タスクは Orchestrator からのみ削除されます。

戻り値

名前 パス 説明
コマンドの結果
TasksDeleteTaskResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator 自動化タスクの状態を変更する

選択した Orchestrator オートメーション タスクの状態、またはその他のタスク プロパティを変更します。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

変更するオーケストレーター タスクの ID。

Automation タスクの新しい状態
AutomationTaskStatus string

指定した自動化タスクの新しいタスクの状態。既存のタスクの状態を変更しない場合は空白のままにします。 既存のタスクを延期する場合は、代わりにアクション 'Defer existing Orchestrator automation task' を使用します。

タスクを保留にする
TaskOnHold boolean

タスクの [保留中] 状態を指定します。 保留にできるのは新しいタスクまたは遅延タスクのみであるため、他のタスクの状態を保留にしようとすると例外が発生します。

タスク入力データを消去する
EraseTaskInputData boolean

この値を true に設定すると、タスク入力データは消去されます。 これは通常、未加工データが不要になったため、完了または失敗したタスクの記憶域領域を節約するために使用されます。

遅延保存データを消去する
EraseDeferralStoredData boolean

この値を true に設定すると、遅延保存されたデータは消去されます。 これは通常、未加工データが不要になったため、完了または失敗したタスクの記憶域領域を節約するために使用されます。

ソース システムを更新する
UpdateSourceSystem boolean

この値を true に設定し、Orchestrator タスクがソース システム (ServiceNow など) にリンクされている場合、Orchestrator は Orchestrator のソース システム構成で指定されたすべてのアクションを実行します (たとえば、チケットを閉じます)。

タスクの終了の理由
TaskClosureReason string

タスクに格納される '完了' または "失敗" タスクのタスク終了の理由を指定します。 さらに、Orchestrator タスクがソース システム (ServiceNow など) にリンクされている場合、状態を変更し、[ソース システムの更新] が true に設定されている場合、その理由もソース システムに渡されます (たとえば、ServiceNow 作業メモとして)。 完了したタスクまたは失敗したタスクのみが終了の理由を持つ可能性があるため、他のタスクの状態に対して終了理由を設定しようとすると例外が発生します。

戻り値

名前 パス 説明
コマンドの結果
TasksChangeTaskStatusResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator 自動化タスクを割り当てる

選択した Orchestrator オートメーション タスクを、指定したユーザーまたはグループに割り当てます。 この割り当ては、この自動化タスク (ServiceNow など) にリンクされているソース システムに渡され、最も一般的に、追加処理のために別のユーザーまたはユーザーのグループにチケットを渡すために使用されます。 Orchestrator 自動化タスクがソースにリンクされていない場合は、例外が発生します。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

割り当てる Orchestrator タスクの ID。

ユーザー ID に割り当てる
AssignToUserId string

タスクを割り当てるユーザーの ID。 ユーザーにタスクを割り当て、ユーザー ID がわかっている場合は、この入力を使用します。両方ではなくユーザー ID またはユーザー名の入力を使用するか、グループに割り当てる場合は、この入力を空白のままにします。

ユーザー名に割り当てる
AssignToUserName string

タスクを割り当てるユーザーの名前。 ユーザーにタスクを割り当て、ユーザー名がわかっている場合は、この入力を使用します。 両方ではなく、ユーザー ID またはユーザー名の入力を使用するか、グループに割り当てる場合は、この入力を空白のままにします。

グループ ID に割り当てる
AssignToGroupId string

タスクを割り当てるグループの ID。 この入力は、タスクをグループに割り当て、グループ ID がわかっている場合に使用します。両方ではなくグループ ID またはグループ名の入力を使用するか、ユーザーに割り当てる場合は、この入力を空白のままにします。

グループ名に割り当てる
AssignToGroupName string

タスクを割り当てるグループの名前。 この入力は、タスクをグループに割り当て、グループ名がわかっている場合に使用します。 両方ではなく、グループ ID またはグループ名の入力を使用するか、ユーザーに割り当てる場合は、この入力を空白のままにします。

空白の場合はユーザー割り当てを削除する
RemoveUserAssignmentIfBlank boolean

ユーザー割り当てフィールドが空白で、このフィールドが true に設定されている場合、現在割り当てられているユーザーは削除され、それ以外の場合はユーザーの割り当ては変更されません。

空白の場合はグループの割り当てを削除する
RemoveGroupAssignmentIfBlank boolean

グループ割り当てフィールドが空白で、このフィールドが true に設定されている場合、現在割り当てられているグループはすべて削除され、それ以外の場合、グループの割り当ては変更されません。

戻り値

名前 パス 説明
コマンドの結果
TasksAssignTaskResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

Orchestrator 自動化タスクを取得する

特定の Orchestrator オートメーション タスクを取得します。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

取得する Orchestrator タスクの ID。

状態を次に変更する
StatusChange string

[取得済み] に設定されている場合: タスクを取得すると、タスクの状態が [取得済み] に変わり、他のアクションが同じタスクを実行できなくなります。 [Do nothing]\(何もしない\) に設定すると、タスクの状態は変更されません。

戻り値

名前 パス 説明
Automation 名
AutomationName string

取得した Orchestrator タスクの名前。

操作 ID
OperationId string

取得したオーケストレーター タスクの操作 ID。 この操作 ID (またはタスク ID) を使用して、後でタスクを取得できます。 操作 ID は一意の、重複しない文字列であり、サード パーティが作成しなかった操作の ID を推測する機能を制限します。

延期日時
DeferralDateTime string

取得したオーケストレーター タスクの準備がスケジュールされている日時。 これは UTC で文字列として返されます。

保存されたデータの遅延
DeferralStoredData string

タスクが延期されたときに格納された省略可能なデータ。 これは通常、プロセス/フローを続行するために必要なデータです。

遅延数
DeferralCount integer

このタスクが延期された頻度。 これは通常、延期されなかった新しいタスクの場合は 0、遅延タスクの場合は 1 以上になります。 遅延タスクが再び延期されるたびに、Orchestrator はこの数を自動的に増やします。

タスク入力データ
TaskInputData string

タスクの作成時に格納された省略可能なデータ。 これは通常、プロセス/フローを開始するために使用されたデータですが、このフィールドは任意の目的で使用できます。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

タスク出力データ
TaskOutputData string

タスクの処理時にオートメーションによって格納された省略可能なデータ。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

Priority
Priority integer

このオーケストレーター タスクの優先度レベル (1 は最高レベル)。

Automation タスクの状態
AutomationTaskStatus string

取得した Orchestrator タスクの状態。

プロセス ステージ
ProcessStage string

遅延後に自動化プロセス/フローを続行するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。 たとえば、遅延後に "Exchange" ステージでプロセス/フローを続行する場合は、値 「Exchange」を入力します。

受信日時
ReceivedDateTime string

オーケストレーターによってタスクが最初に受信された日時。 これは UTC で文字列として返されます。

延期日までの分数
MinutesUntilDeferralDate integer

このタスクの延期日 (つまり、このタスクを実行する準備ができたら) までの分数。 このタスクを実行する準備ができた場合、分数は 0 になります。

保留中
OnHold boolean

タスクが保留中の場合は true に設定されます。 保留タスクは "Get next Orchestrator automation task" アクションによって取得されることはないため、一般的なタスク ワークフローでは処理されません。

ソースの種類名
SourceTypeName string

タスクのソースの名前。 'Web UI' は、UI を介して手動で入力されたタスクを表します。 "REST API" は、Orchestrator の REST API を使用して作成されたタスクを表します。 'ServiceNow' は、Orchestrator の内部 'Sources' ServiceNow 統合から作成されたタスクを表します。

ソースフレンドリ名
SourceFriendlyName string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、そのソースのフレンドリ名が保持されます。

ソース チケット ID
SourceTicketId string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、これはソース チケットの ID を保持します。 ServiceNow の場合、これはカタログ タスク sys_idを保持します。

ソース チケットサブ ID
SourceTicketSubId string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、これはソース チケットの ID を保持します。 ServiceNow の場合、これは要求項目のsys_idを保持します。

機構
Organisation string

このタスクが関連付けられている組織。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

このタスクが関連付けられている部署。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

このタスクの説明。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てられている 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

PowerShell プロセスを実行する

ディスク上の既存のスクリプトを実行するか、実行するスクリプトの内容を指定して、PowerShell プロセスを起動します。 代わりに "PowerShell スクリプトの実行" アクションを使用することを検討してください。これははるかに強力であり、PowerShell スクリプトからの出力のデータ テーブルを提供します。 PowerShell スクリプトが標準出力または標準エラーに出力する場合 (たとえば、テーブルを返す代わりに Write-Host を使用する)、PowerShell 7 が必要な場合、または代替ユーザーとして Active Directory アクションを実行していて、WinRM 経由の CredSSP が使用できない場合は、このアクションを使用します。

パラメーター

名前 キー 必須 説明
PowerShell 実行可能ファイル
PowerShellExecutable string

PowerShell 実行可能ファイルへのパス。 Windows パスで定義されている既定の PowerShell 実行可能ファイルを実行するには、既定の 'PowerShell.exe' のままにします。 PowerShell 5.x には '%SYSTEMROOT%\system32\WindowsPowerShell\v1.0\PowerShell.exe' を使用します。 PowerShell 7 には 'C:\Program Files\PowerShell\7\pwsh.exe' を使用します。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

PowerShell スクリプト ファイルのパス
PowerShellScriptFilePath string

実行する既存の PowerShell スクリプトへのパス。 PowerShell スクリプトには、IA-Connect エージェントからアクセスできる必要があります (つまり、エージェントがリモート セッションで実行されている場合、スクリプトはリモート システム上にあるか、リモート システムからアクセスできる必要があります)。 または、この入力を空白のままにし、入力 "PowerShell スクリプトの内容" に PowerShell スクリプトの内容を指定します。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

PowerShell スクリプトの内容
PowerShellScriptContents string

既存の PowerShell スクリプトへのパスを指定するのではなく、実行する PowerShell スクリプトの内容。

作業フォルダー
WorkingDirectory string

PowerShell スクリプトの作業フォルダー/ディレクトリ。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

ウィンドウを作成しない
CreateNoWindow boolean

true (既定値) に設定すると、PowerShell スクリプトは目に見えない方法で実行されます。 false に設定すると、PowerShell スクリプト ウィンドウが表示されます。 これは、PowerShell スクリプトで入力を求めるメッセージが表示され、UIA とグローバル マウスとキーボードの操作を使用して操作する予定の場合に便利です。

ウィンドウ スタイル
WindowStyle string

PowerShell スクリプトが目に見えて実行するように構成されている場合は、ウィンドウ スタイル (通常、最大化、最小化、非表示) を指定します。

プロセスを待つ
WaitForProcess boolean

IA-Connect エージェントは PowerShell スクリプトが完了するまで待機する必要がありますか? 既定では、IA-Connect エージェントがスクリプトから出力を取得できるように、これは true に設定されます。 fire-and-forget の場合は false に設定します。

標準出力のリダイレクト
RedirectStandardOutput boolean

true (既定値) に設定すると、スクリプトの標準出力がリダイレクトされ、エージェントは StandardOutput 変数で返されます。 これは、スクリプトからエージェント (Write-Hostからの出力など) に出力を返す場合に便利です。

リダイレクト標準エラー
RedirectStandardError boolean

true に設定すると、スクリプトの標準エラーがリダイレクトされ、エージェントは StandardError 変数で返されます。

標準エラーを出力にリダイレクトする
RedirectStandardErrorToOutput boolean

true に設定すると、スクリプトの標準エラーが標準出力にリダイレクトされ、1 つの出力にマージされます。

標準出力エンコード
StandardOutputEncoding string

標準出力エンコード (UTF8、UTF7、UTF16、ASCII、またはUTF16BE) を指定します。

標準エラー エンコード
StandardErrorEncoding string

標準エラー エンコード (UTF8、UTF7、UTF16、ASCII、またはUTF16BE) を指定します。

RunAs ドメイン名
RunAsDomain string

ユーザーとしての実行のドメイン。 ドメインが指定されていない場合、ユーザー名はusername@domainFQDN形式にする必要があります。

RunAs ユーザー名
RunAsUsername string

ユーザーとしての実行のユーザー名。

RunAs パスワード
RunAsPassword password

ユーザーとしての実行のパスワード。

RunAs 読み込みユーザー プロファイル
RunAsLoadUserProfile boolean

実行の Windows ユーザー プロファイルをユーザーとして読み込む必要がありますか?

RunAs elevate
RunAsElevate boolean

PowerShell スクリプトは管理者特権で実行する必要がありますか? 昇格要求を受け入れるのに非常に困難な場合があります。

タイムアウト (秒)
TimeoutInSeconds integer

PowerShell スクリプトが完了するまで待機する最大秒数。

PowerShell スクリプトの一時フォルダー
PowerShellScriptTempFolder string

既定では、入力 'PowerShell スクリプトの内容' に PowerShell スクリプトを指定した場合、IA-Connect エージェントは -File 入力を介してスクリプトをファイル%TEMP%\IA-Connect\TempPowerShell-{Date}-{Time}.ps1', passes it to PowerShell.exe に保存し、スクリプトの完了時にファイルを削除します。 RunAs ユーザーは、IA-Connect エージェントを実行しているアカウントのプロファイルにアクセスできない可能性があるため、RunAs ユーザー名を使用している場合、この既定のパスは受け入れられない場合があります。 この入力を使用して、別のフォルダーを指定します。 例: '%SYSTEMDRIVE% emp'。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセスの開始
ProcessStarted boolean

PowerShell スクリプト プロセス (PowerShell.exe) が開始された場合は true を返します。

終了コード
ExitCode integer

PowerShell スクリプト プロセス (PowerShell.exe) 終了コードを返します。

プロセスがタイムアウトしました
ProcessTimedOut boolean

PowerShell スクリプト プロセス (PowerShell.exe) がタイムアウトした場合は true を返します。

プロセス ID
ProcessId integer

開始された PowerShell スクリプト プロセス (PowerShell.exe) のプロセス ID。

標準出力
StandardOutput string

標準の出力内容。

標準エラー
StandardError string

標準エラーの内容。

TCP ポートが応答中か

ネットワーク TCP ポートが、IA-Connect エージェントによる接続試行に応答しているかどうかを報告します。 これは、IA-Connect エージェントが実行されているコンピューター (リモート ホストの場合は「localhost」と入力) または任意のリモート コンピューター上の TCP ポートである可能性があります。 IA-Connect エージェントは、TCP ポートに正常に接続すると、すぐに TCP 接続を閉じます。

パラメーター

名前 キー 必須 説明
リモート ホスト
RemoteHost True string

接続するコンピューターの IPv4 アドレス、DNS アドレス、またはホスト名。 「localhost」と入力して、IA-Connect エージェントが実行されているコンピューター上の TCP ポートを確認します。 例: 192.168.1.10 または www.test.com または vm-server19。

TCP ポート
TCPPort True integer

指定されたリモート (またはローカル) ホストで接続する TCP ポート番号。 TCP ポートは 1 以上、65535 以下である必要があります。 一般的な既知のポートの例としては、80 (HTTP)、443 (HTTPS)、445 (SMB/ファイル共有) があります。

タイムアウト (秒)
TimeoutInSeconds integer

TCP 接続を待機する最大秒数。 これは既定で 10 秒ですが、ほとんどの動作する接続は数秒以内 (インターネット経由) または 1 秒未満 (ローカル ネットワーク) で接続することが予想されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
接続されている TCP ポート
TCPPortConnected boolean

TCP ポートが接続されている場合は true、TCP ポートの接続に失敗した場合は false に設定します。

接続エラー メッセージ
ConnectionErrorMessage string

TCP ポートの接続に失敗した場合のエラー メッセージ。 これは通常、DNS/名前参照エラーまたはタイムアウトになります。

UnZIP ファイル

ZIP 圧縮を使用して圧縮されたファイルを解凍します。

パラメーター

名前 キー 必須 説明
ZIP ファイル パス
ZIPFilename True string

解凍する ZIP ファイルへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

フォルダーの抽出
ExtractFolder string

ZIP を抽出するフォルダーのフォルダー パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

すべてのファイルを 1 つのフォルダーに抽出する
ExtractAllFilesToSingleFolder boolean

True に設定すると、ZIP 内のフォルダー構造は無視され、すべてのファイルが指定したフォルダーに抽出されます。

インクルード ファイルの正規表現
IncludeFilesRegEx string

抽出するファイルを指定するための省略可能な正規表現。 ファイル名のみと一致します。

ファイルを除外する正規表現
ExcludeFilesRegEx string

抽出から除外するファイルを指定するための省略可能な正規表現。 ファイル名のみと一致します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
正常に抽出されたファイルの数
FilesExtractedSuccessfully integer

ZIP から正常に抽出されたファイルの数。

抽出に失敗したファイルの数
FilesFailedToExtract integer

ZIP から抽出できなかったファイルの数。

除外されたファイルの数
FilesExcluded integer

除外されたファイルの数 ('Exclude files 正規表現' 入力を使用している場合)。

Web API にメッセージを送信する

Web API にメッセージを送信し、応答を受信します。 これは任意の Web API で使用できますが、一般的な使用方法は REST API です。 IA-Connect では、仮想マシンから Web API へのメッセージの送信 (つまり、オンプレミスのリソースにアクセスするため) または Citrix または Microsoft リモート デスクトップ セッション (分離された環境からのみアクセスできる API へのアクセスなど) をサポートします。

パラメーター

名前 キー 必須 説明
URL
URL string

メッセージを送信する API の完全な URL。 たとえば、 https://myapi.remotesystem.com/path/actionと指定します。

メソッド
Method string

HTTP メソッドを使用します。 これは、リモート API から期待されているものと一致する必要があります。

タイムアウト (秒)
TimeoutInSeconds integer

応答を待機する秒数。 HTTP 応答を受信する前にタイムアウトに達すると、例外が発生します。

コンテンツの種類
ContentType string

メッセージ本文の送信データのコンテンツ タイプ (存在する場合)。 これは、リモート API で想定されているものと一致する必要があります。 本文に JSON ペイロードが必要な REST API を呼び出す場合、コンテンツ タイプは application/json である可能性があります。charset=utf-8。

Accept
Accept string

応答データに使用できる形式。 これは、リモート API で想定されているものと一致する必要があります。 JSON ペイロードを返す REST API を呼び出す場合、受け入れ値はおそらく application/json になります。 応答を受け入れるには、「 /」と入力します。

メッセージ本文
MessageBody string

メッセージ本文のデータ (PUT、POST、PATCH と共通) を必要とする Web API を呼び出す場合は、本文の内容をこの入力に入力します。 REST API を呼び出す場合、これには JSON データが含まれている可能性があります。 JSON データを必要とする REST API を呼び出すが、データが送信されていない場合は、この入力に {} を入力する必要がある場合があります。 既定では UTF-8 エンコードが使用されますが、これは "エンコード" 入力を使用して変更できます。

送信エンコード
TransmitEncoding string

送信されたメッセージ本文のエンコード (存在する場合)。 UTF エンコードは、Unicode データを送信するために使用されます。 BE はビッグ エンディアンです。

応答のエンコード
ResponseEncoding string

応答本文の応答データのエンコード (存在する場合)。 応答エンコードが送信エンコードと一致する可能性が高くなります。 UTF エンコードは、Unicode データを送信するために使用されます。 BE はビッグ エンディアンです。

バッファー サイズ
BufferSize integer

出力ストリームから読み取られた各個々のサイズ。 これを変更する必要がある可能性は非常に低いです。 これは応答のサイズを制限しません。ブロック サイズです。

プロパティ
Property string
価値
Value string
TLS 1.0 のネゴシエート
NegotiateTLS10 boolean

HTTPS および TLS 1.0 セキュリティを使用してリモート システムとネゴシエートする必要がある場合は true に設定します。 複数の TLS セキュリティ レベルをネゴシエートでき、クライアントとリモート システムの間で最も一般的なネゴシエーション レベルが使用されます。 警告: TLS 1.0 は非推奨であるため、リモート システムがより高いレベル (場合によっては古く、パッチが適用されていない可能性がある) をサポートせず、セキュリティ リスクを理解して受け入れる場合を除き、有効にしないでください。

TLS 1.1 のネゴシエート
NegotiateTLS11 boolean

HTTPS と TLS 1.1 のセキュリティをリモート システムとネゴシエートする必要がある場合は、true に設定します。 複数の TLS セキュリティ レベルをネゴシエートでき、クライアントとリモート システムの間で最も一般的なネゴシエーション レベルが使用されます。 警告: TLS 1.1 は非推奨であるため、リモート システムがより高いレベル (場合によっては古く、パッチが適用されていない可能性がある) をサポートせず、セキュリティ リスクを理解して受け入れない限り、有効にしないでください。

TLS 1.2 のネゴシエート
NegotiateTLS12 boolean

HTTPS および TLS 1.2 セキュリティを使用してリモート システムとネゴシエートする必要がある場合は true に設定します。 複数の TLS セキュリティ レベルをネゴシエートでき、クライアントとリモート システムの間で最も一般的なネゴシエーション レベルが使用されます。 TLS 1.2 は、推奨される最低限のセキュリティ レベルです。

TLS 1.3 のネゴシエート
NegotiateTLS13 boolean

HTTPS および TLS 1.3 セキュリティを使用してリモート システムとネゴシエートする必要がある場合は、true に設定します。 複数の TLS セキュリティ レベルをネゴシエートでき、クライアントとリモート システムの間で最も一般的なネゴシエーション レベルが使用されます。 TLS 1.3 は、Windows 11 以降と Server 2022 以降でのみサポートされています。

キープ アライブ
KeepAlive boolean

キープアライブを有効にする必要がある場合は true に設定します。 これにより、短い期間 (1 分未満) 内に同じエンドポイントに複数の API 要求を行う場合に TCP 接続が再利用されるため、パフォーマンスが向上します。 1 つの API 呼び出しのみを行う場合、または API 呼び出しの間隔が 1 分を超える場合は false に設定します。 これを正しく構成しない場合は、パフォーマンスにのみ影響を与えるので、最小限の害があります。

100 件の継続が予想されます
Expect100Continue boolean

POST 要求を使用し、大量のデータを送信していて、サーバーがデータを送信する前に要求を受け入れるかどうかを判断する場合は true に設定します。 False は、サーバーに送信されるパケットの数が減り、応答時間が向上するため、ほとんどのシナリオで最適です。

応答ヘッダーを返す
ReturnResponseHeaders boolean

IA-Connect エージェントがリモート システムから受信した HTTP ヘッダーを応答で返す場合は、true に設定します。 応答は JSON 形式になります。 この機能は、応答のサイズが大きくなるため、情報 (返された Cookie など) の応答ヘッダーを処理する場合にのみ使用します。

スレッドとして実行
RunAsThread boolean

false に設定すると、IA-Connect エージェントはアクションを直ちに実行し、アクションの完了時に結果を返しますが、worker/RPA コマンドのタイムアウトよりも時間がかかる場合は失敗します。 true に設定すると、IA-Connect エージェントはこのアクションをエージェント スレッドとして実行し、完了するまで監視します。 これにより、アクションをワーカー/RPA コマンドタイムアウトよりも長く実行できます。

スレッドを待つ
WaitForThread boolean

'スレッドとして実行' が true に設定されている場合にのみ使用されます。 エージェント スレッドが完了するまで待機するには、この入力を true に設定します。エージェントは、'Timeout in seconds' で指定されている限り待機します。 待機をバイパスするには false に設定します。エージェントは引き続きバックグラウンドでアクションを実行しますが、次のアクションにも使用できます。 その後、"エージェント スレッドが正常に完了するまで待機する" アクションを使用してエージェント スレッドが完了するのを待ってから、"スレッド ID の出力データを取得する" という入力をエージェント スレッド ID に設定して、このアクションを再実行することで、後で結果を取得できます。

スレッド ID の出力データを取得する
RetrieveOutputDataFromThreadId integer

以前に 'スレッドの待機' を false に設定した場合 (エージェントがバックグラウンド スレッドで待機を実行する原因となります)、結果を取得するエージェント スレッド ID を指定します。 このエージェント スレッド ID は、このアクションに対する以前の呼び出しによって提供されます。 それ以外の場合は、0 (既定値) に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
応答状態コード
ResponseStatusCode integer

HTTP 応答コード。 成功した一般的な応答は、200 (OK)、201 (作成)、202 (承認済み) です。 3xx 応答コードはリダイレクト・メッセージです。 4xx 応答コードは、クライアント エラー メッセージです (たとえば、要求に問題がある場合)。 5xx 応答コードは、サーバー エラー メッセージです。 代わりに例外が発生するため、通常、この出力には 4xx と 5xx の応答コードは表示されません。

応答メッセージ
ResponseMessage string

HTTP 応答本文からの応答メッセージの内容。

応答コンテンツ タイプ
ResponseContentType string

応答本文のコンテンツ タイプ(応答本文がある場合)、および型が指定された場合。

応答ヘッダー JSON
ResponseHeadersJSON string

入力 'Return response headers' が true に設定されている場合、この出力には JSON 形式の HTTP 応答ヘッダーが含まれます。 この機能は、応答のサイズが大きくなるため、情報 (返された Cookie など) の応答ヘッダーを処理する場合にのみ使用します。

スレッド ID
ThreadId integer

"スレッドの待機" を false に設定した場合 (エージェントがバックグラウンド スレッドで待機を実行する原因となります)、この出力にはエージェント スレッド ID が保持されます。この ID は、アクションのプロセスを監視し、後でスレッドが完了したときに結果を取得するために使用できます。

ZIP にファイルを追加する

ファイルを ZIP 圧縮します (ファイルを圧縮アーカイブに格納します)。

パラメーター

名前 キー 必須 説明
ZIP に追加するソース ファイル のパス
SourceFilenameToAddToZIP True string

zip に追加するファイルのファイル パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

出力 ZIP ファイルパス
OutputZIPFilename True string

ZIP を出力するファイル パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

ZIP のフォルダーにファイル名を追加する
AddFilenameToFolderInZIP string

ZIP ファイル内のフォルダーにソース ファイルを追加する場合は、ここにフォルダー名を入力します。

ZIP コメントに追加するソース ファイル名
SourceFilenameToAddToZIPComment string

ZIP に追加されたこのファイルの省略可能なコメント。

圧縮する
Compress boolean

zip 圧縮時にファイルを圧縮する必要がありますか?

既存の ZIP ファイルに追加する
AddToExistingZIPFile boolean

既存の ZIP ファイルに追加するには、True に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

ZIP にフォルダーを追加する

フォルダー内の ZIP ファイルを ZIP ファイルに圧縮します (圧縮アーカイブにファイルを格納します)。

パラメーター

名前 キー 必須 説明
ZIP に追加するソース フォルダー
SourceFolderToAddToZIP True string

zip に追加するフォルダーへのパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

出力 ZIP ファイルパス
OutputZIPFilename True string

ZIP を出力するファイル パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

ZIP のフォルダーにファイルを追加する
AddFilesToFolderInZIP string

ZIP ファイル内のフォルダーにソース ファイルを追加する場合は、ここにフォルダー名を入力します。

圧縮する
Compress boolean

zip 圧縮時にフォルダーを圧縮する必要がありますか?

既存の ZIP ファイルに追加する
AddToExistingZIPFile boolean

既存の ZIP ファイルに追加するには、True に設定します。

サブフォルダーを含める
IncludeSubfolders boolean

ソース フォルダー内のサブフォルダーも ZIP に追加する必要がありますか?

インクルード ファイルの正規表現
IncludeFilesRegEx string

抽出するファイルを指定するための省略可能な正規表現。 ファイル名のみと一致します。

ファイルを除外する正規表現
ExcludeFilesRegEx string

抽出から除外するファイルを指定するための省略可能な正規表現。 ファイル名のみと一致します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
正常に追加されたファイルの数
FilesAddedSuccessfully integer

ZIP に正常に追加されたファイルの数。

除外されたファイルの数
FilesExcluded integer

除外されたファイルの数 ('Exclude files 正規表現' 入力を使用している場合)。

すべての IA-Connect コマンド統計情報を取得する

IA-Connect エージェントが現在のセッションで実行したコマンドに関して、現在保存されているすべての統計情報を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンド統計 JSON
CommandStatsJSON string

現在のセッションで IA-Connect エージェントによって実行されるコマンドの一覧 (JSON 形式)。 この一覧には、各アクションの名前と、実行された回数が含まれます。

すべての Orchestrator 自動化タスクを取得する

フィルターに一致するすべての Orchestrator オートメーション タスクを取得します。

パラメーター

名前 キー 必須 説明
オートメーション名フィルター
AutomationName string

このオートメーション名を持つタスクのみを取得する値を入力します。 任意の名前の Orchestrator オートメーション タスクを返すには、空白のままにします (つまり、このフィルターを無効にします)。

Automation タスクの状態フィルター
AutomationTaskStatus string

指定したオートメーション タスクの状態でオートメーション タスクをフィルター処理します。 すべてのオートメーション タスクの状態を返すには、フィールドを空白のままにします (つまり、このフィルターを無効にします)。

プロパティ クエリでフィルター処理する
FilterByPropertyQuery string

クエリ文字列を使用してオートメーション タスクをフィルター処理します。 これは、Orchestrator タスク UI の [プロパティでフィルター] 入力と同じです。 プロパティでフィルター処理しない (つまり、このフィルターを無効にする) には、フィールドを空白のままにします。 検索フィルターは、"プロパティ条件値" の形式である必要があります。 サポートされている検索フィルターは 1 つだけです (または、使用することはできません)。 サポートされているプロパティは、name、org、dept、tags、stage、ticketid です。 サポートされる条件は、等しい、含む、等しくない、含まないです。 たとえば、名前は新しいスターター、名前にはスターター、Org は Acme、Dept には売上が含まれます。

延期日までの分数
MinutesUntilDeferralDate integer

指定した数分以内に実行する準備ができている Orchestrator 自動化タスクのみを返します。 今すぐ実行できる自動化タスクのみが必要な場合は、0 に設定します。 遅延に関係なくタスクを取得する場合は、空白のままにします。

最小優先度レベル
MinimumPriorityLevel integer

指定された優先度レベル以上の Orchestrator オートメーション タスクのみを返します。 たとえば、2 を設定すると、優先度レベルが 1 と 2 のタスクが返されます。

延期日で並べ替える
SortByDeferralDate boolean

遅延日時で並べ替えられたデータを返すには、true に設定します。 false に設定すると、データが格納された順序で返されます。

保留中のタスクを取得する
RetrieveOnHoldTasks boolean

true に設定した場合 (下位互換性のために既定)、タスクは保留されている場合でも取得されます。 false に設定すると、保留タスクは取得されません。

スキップ
Skip integer

何百もの結果を取得する場合は、Skip と MaxResults を使用して結果のブロックを取得できます。 Skip は、ブロック内の最初の項目を返す前に、スキップする結果の数を指定します。 Skip を 0 に設定すると、最初から結果が返されます。

最大結果
MaxResults integer

何百もの結果を取得する場合は、Skip と MaxResults を使用して結果のブロックを取得できます。 MaxResults は、Skip 入力の処理後に返される結果の最大数、またはすべての結果を返す場合は 0 を指定します。

タスク データを除外する
ExcludeTaskData boolean

true に設定すると、タスク データのプロパティ (TaskData、DeferralStoredData、TaskOutputData) は応答で返されません。 これにより、タスクに大量のデータが格納されている場合、応答のサイズが大幅に削減される可能性があります。

戻り値

名前 パス 説明
Automation タスク
AutomationTasks array of object

指定された検索条件を満たすすべての Orchestrator オートメーション タスクを含むデータテーブル。 データテーブルは一般的な .NET データ形式ですが、null は DbNull として格納されます。 IA-Connect PowerShell モジュールは、ほとんどの DbNull 文字列を '' に変換することでこれに対処します。 Orchestrator からの Datetime 応答は文字列形式になります。

items
AutomationTasks object
自動化タスクの数
NumberOfAutomationTasks integer

返される自動化タスクの数。

ウィグル マウス

指定した座標数だけマウスを前後に移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。

パラメーター

名前 キー 必須 説明
X ウィグル
XWiggle integer

マウスを水平方向に移動するピクセル数。

Y ウィグル
YWiggle integer

マウスを垂直方向に移動するピクセル数。

ウィグル遅延 (秒単位)
WiggleDelayInSeconds double

マウスの動き間の秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント GUI IA-Connect 前面に移動する

IA-Connect エージェント GUI を前面に表示し、画面に表示されるようにします。

パラメーター

名前 キー 必須 説明
フォーカス
Focus boolean

IA-Connect エージェント GUI に焦点を当てる必要がありますか?

マウスのグローバル左クリック
GlobalLeftMouseClick boolean

グローバルマウスの左クリックを使用してエージェントを前面に移動する必要がありますか? これにより、アプリケーションが前面に移動することを妨げるオペレーティング システムによってフォーカス メソッドが制限される可能性があるシナリオで、フロント イベントへの取り込みを保証します。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント GUI の不透明度 IA-Connect 設定する

IA-Connect エージェントの不透明度を 1 (表示) から 0 (透明) に設定します。

パラメーター

名前 キー 必須 説明
不透明度
Opacity True double

設定する不透明度の値。1 (表示) から 0 (透明) の間です。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント GUI の位置 IA-Connect 設定する

IA-Connect エージェント GUI の画面上の位置を、指定した場所に設定します。

パラメーター

名前 キー 必須 説明
X
X True integer

エージェントを設定する X 座標 (ピクセル単位)。

ジー
Y True integer

エージェントを設定する Y 座標 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント GUI の最上位 IA-Connect 設定

IA-Connect エージェントを最上位に設定します。 つまり、IA-Connect エージェントは常に画面に表示され、他のアプリケーション ウィンドウの背後に非表示にすることはできません。

パラメーター

名前 キー 必須 説明
最 上位
TopMost boolean

IA-Connect エージェントを最上位 (true) に設定するか、最上位を無効にする必要がありますか (false)

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント IA-Connect プロセス数を取得する

ユーザー セッションで現在実行中の IA-Connect エージェントのインスタンスの数を返します。 これは、IA-Connect エージェントの複数のインスタンスが実行されているかどうかを検出するのに役立ちます。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセスの数
NumberOfProcesses integer

ユーザー セッションで現在実行中の IA-Connect エージェント プロセスの数。

エージェント IA-Connect 現在のライセンス状態を取得する

IA-Connect エージェントが現在ライセンスされているかどうかを返し、ライセンスが付与されている場合はライセンスのプロパティを返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ライセンスが付与されています
IsLicensed boolean

IA-Connect エージェントが現在ライセンスされている場合は true、ライセンスが付与されていない場合は false を返します。

ライセンスのタイプ
LicenseType string

使用されている IA-Connect ライセンスの種類。

エージェント ドメイン名
CustomerNETBIOSDomainName string

IA-Connect エージェントが実行されているコンピューターの NetBIOS ドメイン名 (ドメイン名 (IA-Connect 7.0 または 7.1) でライセンスされている場合)。

ディレクターのホスト名
DirectorHostnameCSV string

IA-Connect Director をインストールできるマシンのホスト名 (ホスト名でライセンスされている場合) (IA-Connect 7.2 の後)。

顧客の表示名
CustomerDisplayName string

IA-Connect エージェントのタイトル バーに表示される顧客名。

ベンダー名
VendorName string

IA-Connect ベンダー名。

ライセンスの有効期限
LicenseExpiryDate string

IA-Connect ライセンスの有効期限。

ライセンスの有効期限が切れるまでの日数
DaysUntilLicenseExpires integer

IA-Connect ライセンスの有効期限が切れるまでの残りの日数。

ライセンス機能
LicenseFeatures string

追加のライセンス機能。通常は、追加機能へのアクセスを提供します。

JML ライセンス
IsJMLLicense boolean

このライセンスは JML 機能へのアクセスを提供します。

エージェント IA-Connect 閉じる

IA-Connect エージェントを閉じます。 これは、IA-Connect エージェントが実行されていたユーザー セッションには影響しません。

パラメーター

名前 キー 必須 説明
待機する秒数
SecondsToWait integer

IA-Connect エージェントがコマンドの完了を報告できるように、close コマンドを発行するまでの待ち時間。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント コマンド タイムアウト IA-Connect 設定する

IA-Connect エージェントが実行される各コマンドに使用するコマンド タイムアウトを設定します。

パラメーター

名前 キー 必須 説明
コマンド タイムアウト (秒)
CommandTimeoutInSeconds True integer

IA-Connect エージェントが使用するコマンド タイムアウト。 大量のデータを読み取りまたは書き込む場合は、タイムアウト期間を長くすることができます。

タイムアウト RPA コマンド スレッドを終了する
TerminateTimedoutRPACommandThreads boolean

タイムアウトした場合、コマンド スレッドを終了する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェント スレッドが正常に完了するまで待ちます

エージェント スレッドが完了するまで待機し、必要に応じてスレッド出力データを取得します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドが完了しても失敗した場合は、例外が発生します。

パラメーター

名前 キー 必須 説明
スレッド ID
ThreadId True integer

以前にエージェント アクションをスレッドとして実行した場合は、スレッド ID を指定してスレッドの状態を取得します。 このスレッド ID は、以前にスレッドとして実行されたアクションの出力として提供されます。

スレッドを待機する秒数
SecondsToWaitForThread True integer

スレッドが完了するまで待機する秒数。 この時点でスレッドが完了していない場合は、例外が発生します ('スレッドが完了していない場合は例外を発生させる' が false に設定されていない場合)。

スレッド出力データを取得する
RetrieveThreadOutputData boolean

JSON 形式でスレッド出力データを取得するには、true に設定します。 スレッドの作成に使用したものと同じアクションを呼び出し、入力 'スレッド ID の出力データの取得' をスレッド ID に設定してスレッド出力データを取得することをお勧めしますが、このオプションを使用すると、スレッド出力データを直接取得し、必要に応じてデータを削除することはできません。

出力データの取得後にスレッドを削除する
ClearOutputDataFromMemoryOnceRead boolean

スレッドが正常に完了し、出力データが取得された場合 (「スレッド出力データの取得」の入力を参照)、結果が返された後にスレッドを削除するには、この入力を true に設定します。 これにより、スレッド出力データとスレッド自体が削除されるため、スレッドに再度クエリを実行できなくなります。

スレッドが完了していない場合は例外を発生させる
RaiseExceptionIfThreadNotCompleted boolean

true に設定され、指定した時間内にスレッドが完了していない場合は、例外が発生します。 false に設定すると、このアクションは要求された時刻 (スレッドが完了するまで) まで待機し、スレッドの状態を報告します (出力 'Thread is running' などを参照)。 スレッドが完了した場合は常に例外が発生しますが、失敗します。

スレッド エラーが発生した場合に例外を発生させる
RaiseExceptionIfThreadError boolean

true (既定の動作) に設定され、スレッドにエラー条件 (スレッドが完了したが成功していない) がある場合は、例外が発生し、スレッドが削除されます。 false に設定すると、エラーは出力 'スレッド エラー メッセージ' に格納され、スレッドは削除されません (必要に応じて、アクション "エージェント スレッドの削除" を使用してスレッドを削除する必要があります)。

呼び出しごとに待機する秒数
SecondsToWaitPerCall integer

"スレッドを待機する秒数" は、タイムアウトを回避するために、小さなタイム スライスに分割されます。 この省略可能な入力を使用すると、小さいタイム スライスのサイズを指定できます。 RPA タイムアウトの 80% を超える値に設定しないか、タイムアウト エラーが発生する可能性があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
スレッドが開始されました
ThreadStarted boolean

スレッドが開始されている場合は True。 False スレッドがまだ開始されていない場合は、スレッドがすぐに開始されてから何かが間違っていることを示唆します。 'スレッドが完了していない場合に例外を発生させる' が false に設定されている場合にのみ役立ちます。それ以外の場合は、指定された待機時間でスレッドが完了していない場合に例外が発生します。

スレッドが実行されている
ThreadRunning boolean

スレッドが現在実行中の場合は True。 False の場合、スレッドが開始されたことがない (非常に可能性が低い) か、スレッドが完了した場合。 'スレッドが完了していない場合に例外を発生させる' が false に設定されている場合にのみ役立ちます。それ以外の場合は、指定された待機時間でスレッドが完了していない場合に例外が発生します。

スレッドが完了しました
ThreadCompleted boolean

スレッドが完了した場合は True。 False の場合、スレッドが開始されない (非常に可能性が低い) 場合、またはスレッドがまだ実行されている場合。 'スレッドが完了していない場合に例外を発生させる' が false に設定されている場合にのみ役立ちます。それ以外の場合は、指定された待機時間でスレッドが完了していない場合に例外が発生します。

スレッドが成功しました
ThreadSuccess boolean

スレッドが正常に完了した場合は True。 False スレッドが開始されていない場合 (非常に可能性が低い)、スレッドがまだ実行されているか、スレッドが失敗した場合。 'スレッドが完了していない場合に例外を発生させる' が false に設定されている場合にのみ役立ちます。それ以外の場合は、指定された待機時間でスレッドが完了していない場合に例外が発生します。

スレッド ランタイム (秒単位)
ThreadRuntimeInSeconds integer

スレッドが実行されている合計秒数。

IA-Connect アクション名
IAConnectActionName string

スレッドとして実行されている IA-Connect エージェント アクションの内部名。

スレッドの状態メッセージ
ThreadStatusMessage string

スレッドの状態を説明するテキスト文字列。 このメッセージは、ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess プロパティから計算されます。 このテキスト文字列は言語に依存しません (ロケールに合わせて変更されません)。

スレッド エラー メッセージ
ThreadErrorMessage string

スレッドが失敗した場合、この出力にはエラー メッセージが含まれます。 'スレッド エラーが発生した場合に例外を発生させる' が false に設定されている場合にのみ役立ちます。それ以外の場合は、スレッドにエラーがある場合に例外が発生するためです。

スレッド出力データ JSON
ThreadOutputJSON string

'スレッド出力データの取得' が true に設定されている場合、この出力は JSON 形式の生スレッド出力データを保持します。

エージェント スレッドの状態を取得する

エージェント スレッドの状態を取得し、必要に応じてスレッド出力データを取得します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。

パラメーター

名前 キー 必須 説明
スレッド ID
ThreadId True integer

以前にエージェント アクションをスレッドとして実行した場合は、スレッド ID を指定してスレッドの状態を取得します。 このスレッド ID は、以前にスレッドとして実行されたアクションの出力として提供されます。

スレッド出力データを取得する
RetrieveThreadOutputData boolean

JSON 形式でスレッド出力データを取得するには、true に設定します。 スレッドの作成に使用したものと同じアクションを呼び出し、入力 'スレッド ID の出力データの取得' をスレッド ID に設定してスレッド出力データを取得することをお勧めしますが、このオプションを使用すると、スレッド出力データを直接取得し、必要に応じてデータを削除することはできません。

出力データの取得後にスレッドを削除する
ClearOutputDataFromMemoryOnceRead boolean

スレッドが正常に完了し、出力データが取得された場合 (「スレッド出力データの取得」の入力を参照)、結果が返された後にスレッドを削除するには、この入力を true に設定します。 これにより、スレッド出力データとスレッド自体が削除されるため、スレッドに再度クエリを実行できなくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
スレッドが開始されました
ThreadStarted boolean

スレッドが開始されている場合は True。 False スレッドがまだ開始されていない場合は、スレッドがすぐに開始されてから何かが間違っていることを示唆します。

スレッドが実行されている
ThreadRunning boolean

スレッドが現在実行中の場合は True。 False の場合、スレッドが開始されたことがない (非常に可能性が低い) か、スレッドが完了した場合。

スレッドが完了しました
ThreadCompleted boolean

スレッドが完了した場合は True。 False の場合、スレッドが開始されない (非常に可能性が低い) 場合、またはスレッドがまだ実行されている場合。

スレッドが成功しました
ThreadSuccess boolean

スレッドが正常に完了した場合は True。 False スレッドが開始されていない場合 (非常に可能性が低い)、スレッドがまだ実行されているか、スレッドが失敗した場合。

スレッド ランタイム (秒単位)
ThreadRuntimeInSeconds integer

スレッドが実行されている合計秒数。

IA-Connect アクション名
IAConnectActionName string

スレッドとして実行されている IA-Connect エージェント アクションの内部名。

スレッドの状態メッセージ
ThreadStatusMessage string

スレッドの状態を説明するテキスト文字列。 このメッセージは、ThreadStarted、ThreadRunning、ThreadCompleted、ThreadSuccess プロパティから計算されます。 このテキスト文字列は言語に依存しません (ロケールに合わせて変更されません)。

スレッド エラー メッセージ
ThreadErrorMessage string

スレッドが失敗した場合、この出力にはエラー メッセージが含まれます。

スレッド出力データ JSON
ThreadOutputJSON string

'スレッド出力データの取得' が true に設定されている場合、この出力は JSON 形式の生スレッド出力データを保持します。

エージェント スレッドを削除する

実行中の場合は、エージェント スレッド、またはすべてのエージェント スレッドを削除し、スレッドを最初に強制終了 (終了、中止) します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドを監視しているプロセスまたはフローは、"エージェント スレッド ID が存在しません" というエラーを受け取ります。

パラメーター

名前 キー 必須 説明
スレッド ID
ThreadId integer

以前にエージェント アクションをスレッドとして実行した場合は、スレッド ID を指定してスレッドを終了および削除します。 このスレッド ID は、以前にスレッドとして実行されたアクションの出力として提供されます。 指定したエージェント スレッド ID が存在しない場合は、例外が発生します。

すべてのエージェント スレッドを削除する
DeleteAllAgentThreads boolean

すべてのエージェント スレッドを削除するには、true に設定します。 "スレッド ID" 入力で指定された単一のエージェント スレッドを削除するには、false (既定値) に設定します。

エージェント スレッドが削除に失敗した場合に例外を発生させる
RaiseExceptionIfAgentThreadFailsToDelete boolean

エージェント スレッドが削除に失敗した場合に例外を発生させる場合は true に設定します。 このアクションの発行中にエージェント スレッドが完了すると、例外が発生する可能性があることに注意してください (削除時点では存在しなくなります)。 エージェント スレッドの削除中にエラーを無視するには、false (既定値) に設定します。 "削除されたエージェント スレッドの数" という出力は、削除されたエージェント スレッドの数を報告します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
削除されたエージェント スレッドの数
NumberOfAgentThreadsDeleted integer

[すべてのエージェント スレッドの削除] が true の場合、この出力には削除されたエージェント スレッドの数 (0 以上) が保持されます。 "すべてのエージェント スレッドを削除する" が false で、エージェント スレッド ID が指定された場合、この出力は 0 または 1 に設定されます。

エージェント スレッドを取得する

エージェント スレッドの一覧を返します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 通常、エージェント スレッドが完了し、そのデータが取得されると、エージェント スレッドは削除され、スレッドの一覧には表示されません。

パラメーター

名前 キー 必須 説明
並べ替え順序
SortOrder string

エージェント スレッドの出力リストの並べ替え順序。 サポートされている並べ替え順序は、'None'、'ThreadStartTime'、'ThreadStartTime_Desc'、'ThreadEndTime'、'ThreadEndTime_Desc'、'ThreadId'、'ThreadId_Desc'、'ThreadActionName'、'ThreadActionName_Desc'、'ThreadRuntime'、'ThreadRuntime_Desc' です。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
エージェント スレッドの数
NumberOfAgentThreads integer

まだ実行中または取得可能なエージェント スレッドの数。 通常、エージェント スレッドが完了し、そのデータが取得されると、エージェント スレッドは削除され、スレッドの一覧には表示されません。

エージェント スレッド
AgentThreads array of object

エージェント スレッドと使用可能なすべてのスレッド情報の一覧 (内部スレッド データを除く)。

ThreadId
AgentThreads.ThreadId integer
IAConnectActionName
AgentThreads.IAConnectActionName string
ThreadStartDateTimeUTC
AgentThreads.ThreadStartDateTimeUTC date-time
ThreadCompletedDateTimeUTC
AgentThreads.ThreadCompletedDateTimeUTC date-time
ThreadRuntimeInSeconds
AgentThreads.ThreadRuntimeInSeconds integer
ThreadStarted
AgentThreads.ThreadStarted boolean
ThreadRunning
AgentThreads.ThreadRunning boolean
ThreadCompleted
AgentThreads.ThreadCompleted boolean
ThreadSuccess
AgentThreads.ThreadSuccess boolean
ThreadStatusMessage
AgentThreads.ThreadStatusMessage string
ThreadErrorMessage
AgentThreads.ThreadErrorMessage string

エージェント スレッドを強制終了する

エージェント スレッドを強制終了 (終了、中止) します。 エージェント スレッドを使用すると、スレッド内の特定のアクションを実行したり、アクションを長時間 (RPA タイムアウトより長く) 実行したり、他のアクションと並行して実行したりできます。 エージェント スレッドは削除されません ("エージェント スレッドの削除" アクションを使用してスレッドを削除します)、エージェント スレッドを監視しているプロセスまたはフローが "エージェント スレッドが中止されましたIA-Connect" エラーを受信できるようにします。

パラメーター

名前 キー 必須 説明
スレッド ID
ThreadId True integer

以前にエージェント アクションをスレッドとして実行した場合は、スレッド ID を指定してスレッドを終了します (スレッドの実行を完全に停止します)。 このスレッド ID は、以前にスレッドとして実行されたアクションの出力として提供されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
KillAgentThreadResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

エージェント セッション情報 IA-Connect 取得する

IA-Connect エージェント ユーザー セッションに関する情報を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
セッション ID
SessionId integer

現在のリモート ユーザー セッション ID。

セッションの種類
SessionType integer

リモート セッションの種類 (1 (Citrix)、2 (RDP)、または 0 (コンソール) のいずれか)。

セッションの種類名
SessionTypeName string

ICA (Citrix)、RDP、またはコンソールのいずれかのリモート セッションの種類。

エージェント メモリにパスワードを格納する

エージェント メモリ (暗号化) にパスワードを格納します。このメモリは、保存されたパスワードをサポートするアクションから使用できます。 パスワードはメモリにのみ格納され、エージェントを閉じると失われます。

パラメーター

名前 キー 必須 説明
識別子
Identifier True string

パスワードの一意識別子。 識別子が既に使用されている場合は、上書きされます。 例: SAPGUILogon。 パスワードは、{IAConnectPassword:Identifier} という語句を使用して取得されます。

パスワード
Password True password

保存するパスワード。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
StorePasswordInAgentMemoryResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

エージェント メモリ内のパスワードを削除する

エージェント メモリに格納されているパスワードを削除するか、エージェントに格納されているすべてのパスワードを削除します。

パラメーター

名前 キー 必須 説明
すべてのパスワードを削除する
DeleteAllPasswords boolean

エージェント メモリに格納されているすべてのパスワードを削除するには、true に設定します。 指定された識別子に一致する 1 つのパスワードを削除するには、false (既定値) に設定します。

識別子
Identifier string

削除するパスワードの一意識別子。 例: SAPGUILogon。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
DeletePasswordInAgentMemoryResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

エージェント ログ IA-Connect 取得する

ファイルとして、または内容を読み取って出力変数に返すことによって、現在の IA-Connect エージェント ログを返します。

パラメーター

名前 キー 必須 説明
圧縮する
Compress boolean

代替 IA-Connect エージェント実行可能ファイルは、アップロード中に圧縮する必要がありますか?

最後のコマンド ログのみを返す
ReturnLastCommandOnly boolean

IA-Connect エージェント ログは、ログ全体ではなく、最後のコマンドの結果に制限する必要がありますか?

ログをファイルに保存する
SaveLogToFile boolean

IA-Connect エージェント ログはファイルとして保存する必要がありますか?

データ項目にログ コンテンツを配置する
PlaceLogContentInDataItem boolean

ログの内容を出力変数で返す必要がありますか?

ローカル保存フォルダー
LocalSaveFolder string

IA-Connect エージェントのログイン先フォルダーへのファイルパス。

エージェント ログ ファイル名を使用する
UseAgentLogFilename boolean

ログ ファイルには、エージェント上のログ ファイルの名前と同じ名前を付ける必要がありますか? false に設定すると、'Local save filename' を設定してファイル名を指定できます。

ローカル保存ファイル名
LocalSaveFilename string

IA-Connect エージェント ログのローカル保存ファイルのみのファイル名。 これは、"エージェント ログ ファイル名の使用" が false に設定されている場合にのみ使用されます。

読み取る最大バイト数
MaxBytesToRead integer

エージェント ログから読み取る最大バイト数 (末尾から後方)。 これは 0 に設定することも、ログ全体を取得する -1 に設定することもできます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
エージェント ログの内容
IAConnectAgentLogContentsBase64 string

IA-Connect エージェント ログの内容。

ローカルに保存されたログ ファイル名
IAConnectAgentLogFilenameOnly string

保存されたログ ファイル名へのパス。

エージェント ログ レベル IA-Connect 取得する

現在の IA-Connect エージェント ログ レベルを返します。 ログ 記録レベルは 1 から 4 に設定され、1 は最も低いレベル、4 は最も高くなります。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ログ レベル
LoggingLevel integer

IA-Connect エージェントの現在のログ 記録レベル。

IA-Connect エージェントのログ ファイル名
IAConnectAgentLogFilename string

IA-Connect エージェントのログ ファイル名。 この値は、ファイル名に起動日時があるため、IA-Connect エージェントの起動ごとに一意です。

エージェント ログ レベル IA-Connect 設定する

IA-Connect エージェントのログ 記録レベルを指定した値に設定します (1 は最低レベル、4 は最も高いレベル)。

パラメーター

名前 キー 必須 説明
ログ レベル
LoggingLevel True integer

IA-Connect エージェントを設定する必要があるログ 記録レベル。

Workflow
Workflow True string

workflow() に次の式を追加します。

エージェントのグローバル座標構成 IA-Connect 取得する

IA-Connect Agent グローバル座標系構成の構成を取得します。この構成は、要素の位置 (たとえば、マウス検査中) を表示し、マウス位置を計算するために使用されます (たとえば、グローバル マウス アクションを実行する場合)。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
マルチモニター機能
MultiMonitorFunctionality string

IA-Connect エージェントが現在、要素の強調表示とプライマリ ディスプレイ デバイスでのグローバル マウス 操作の実行のみをサポートするように構成されている場合は、'PrimaryMonitor' を返します。 IA-Connect エージェントがすべてのモニターの要素を強調表示する場合は 、"MultiMonitor" を返します (IA-Connect 9.4 以降の既定値)。

マウス検査の乗数を自動設定する
AutoSetMouseInspectionMultiplier boolean

IA-Connect エージェントの起動時にプライマリ ディスプレイ デバイスでマウス検査の乗数が自動的に計算され、マウス検査が実行されるたびに true が返されます (IA-Connect 9.4 以降の既定値)。 IA-Connect エージェントでマウス検査の乗数を手動で設定する必要がある場合は false を返します (IA-Connect 9.3 以前で使用可能な唯一のオプション)。 このオプションは、マルチモニター モードが無効になっている場合にのみ有効です。

グローバル マウス乗数の自動設定
AutoSetGlobalMouseMultiplier boolean

IA-Connect エージェントの起動時にプライマリ ディスプレイ デバイスでグローバル マウス移動乗数が自動的に計算され、マウス検査が実行されるたびに true が返されます (既定値は IA-Connect 9.4 以降)。 IA-Connect エージェントでグローバル マウス移動乗数を手動で設定する必要がある場合は false を返します (IA-Connect 9.3 以前で使用可能な唯一のオプション)。 このオプションは、マルチモニター モードが無効になっている場合にのみ有効です。

マウス検査 X 乗数
MouseInspectionXMultiplier double

現在の水平 (X) マウス検査乗数 (エージェントがマウスの下にあるものを強調表示する場合)。 たとえば、IA-Connect が実際のマウス X 位置の半分に検査の四角形を表示している場合、この値は 0.5 になります。 乗数は、IA-Connect エージェントがマルチモニターに対応するように構成されている場合に動的に計算されるため、"マルチモニター機能" が無効になっている場合にのみ有効になります。

マウス検査 Y 乗数
MouseInspectionYMultiplier double

現在の垂直 (Y) マウス検査乗数 (エージェントがマウスの下にあるものを強調表示する場合)。 たとえば、IA-Connect が実際のマウス Y 位置の半分に検査の四角形を表示している場合、この値は 0.5 になります。 乗数は、IA-Connect エージェントがマルチモニターに対応するように構成されている場合に動的に計算されるため、"マルチモニター機能" が無効になっている場合にのみ有効になります。

グローバル マウス X 乗数
GlobalMouseXMultiplier double

現在の水平 (X) グローバル マウス移動乗数 (エージェントがマウスを移動したとき)。 乗数は、IA-Connect エージェントがマルチモニターに対応するように構成されている場合に動的に計算されるため、"マルチモニター機能" が無効になっている場合にのみ有効になります。

グローバル マウス Y 乗数
GlobalMouseYMultiplier double

現在の垂直 (Y) グローバル マウス移動乗数 (エージェントがマウスを移動した場合)。 乗数は、IA-Connect エージェントがマルチモニターに対応するように構成されている場合に動的に計算されるため、"マルチモニター機能" が無効になっている場合にのみ有効になります。

グローバル マウス移動メソッド
GlobalMouseMoveMethod string

現在のグローバル マウス移動メソッド (mouse_eventまたは setcursorpos) を返します。

Java 座標系
JavaCoordinateSystem string

'Virtual' (既定値) または 'Physical' (IA-Connect 9.4 の新機能) の現在の Java 座標系を返します。 仮想座標は DPI スケーリングされますが、物理座標はピクセルに直接マップされます。 この値は、Java Access Bridge によって提示されている座標系に設定する必要があります。

SAP GUI 座標系
SAPGUICoordinateSystem string

'Virtual' (既定値) または 'Physical' (IA-Connect 9.4 の新機能) の現在の SAP GUI スクリプト API 座標系を返します。 仮想座標は DPI スケーリングされますが、物理座標はピクセルに直接マップされます。 この値は、SAP GUI スクリプト API によって提示されている座標系に設定する必要があります。

エージェントのグローバル座標構成 IA-Connect 設定する

IA-Connect Agent グローバル座標系を構成します。このシステムは、要素の位置 (たとえば、マウス検査中) を表示し、マウスの位置を計算するために使用されます (たとえば、グローバル マウス 操作を実行する場合)。 既定値では最新の機能が提供されますが、このアクションを使用して、以前のバージョンのエージェントの動作に戻したり、API が別の座標系を使用していることを指定したりできます。

パラメーター

名前 キー 必須 説明
マルチモニター機能
MultiMonitorFunctionality string

[Primary display only] (PrimaryMonitor) に設定すると、以前の動作に戻ります。これは、要素の強調表示とプライマリ ディスプレイ デバイスでのグローバル マウス 操作の実行のみをサポートします (IA-Connect 9.3 以前で使用可能なモードのみ)。 [すべてのディスプレイ] (MultiMonitor) に設定すると、すべてのモニターで要素の強調表示とグローバル マウス 操作が有効になり、各モニターで DPI スケーリングが自動的に検出されます (IA-Connect 9.4 以降の既定値)。 変更を加えない場合は、'Not set' (NotSet) に設定します。

マウス検査の乗数を自動設定する
AutoSetMouseInspectionMultiplier string

[自動] (1) (IA-Connect 9.4 以降の既定値) に設定すると、エージェントの起動時およびマウス検査が実行されるたびに、プライマリ ディスプレイ デバイスのマウス検査乗数が自動的に計算されます。 検査乗数を手動で設定する必要がある場合は、"手動" (0) に設定します (IA-Connect 9.3 以前の唯一のオプション)。 このオプションを変更しない場合は、空白または 'NotSet' に設定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

グローバル マウス乗数の自動設定
AutoSetGlobalMouseMultiplier string

エージェントの起動時およびマウス検査が実行されるたびに、プライマリ ディスプレイ デバイスのグローバル マウス移動乗数を自動的に計算するには、"Auto" (1) (IA-Connect 9.4 以降の既定値) に設定します。 グローバル マウス移動乗数を手動で設定する必要がある場合は、"手動" (0) に設定します (IA-Connect 9.3 以前の唯一のオプション)。 このオプションを変更しない場合は、空白または 'NotSet' に設定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

マウス検査 X 乗数
MouseInspectionXMultiplier double

設定する水平 (X) マウス検査乗数 (エージェントがマウスの下にあるものを強調表示する場合)。 たとえば、IA-Connect が実際のマウス X 位置の半分に検査の四角形を表示している場合は、値 0.5 を設定します。 現在の値を変更しない場合は、0 に設定します。 このオプションは、[マルチモニター機能] が無効で、[マウス検査乗数の自動設定] が無効になっている場合にのみ有効です。

マウス検査 Y 乗数
MouseInspectionYMultiplier double

設定する垂直 (Y) マウス検査乗数 (エージェントがマウスの下にあるものを強調表示する場合)。 たとえば、IA-Connect が検査の四角形を実際のマウスの Y 位置の半分に表示している場合は、値 0.5 を設定します。 現在の値を変更しない場合は、0 に設定します。 このオプションは、[マルチモニター機能] が無効で、[マウス検査乗数の自動設定] が無効になっている場合にのみ有効です。

グローバル マウス X 乗数
GlobalMouseXMultiplier double

設定する水平 (X) グローバル マウス移動乗数 (エージェントがマウスを移動した場合)。 現在の値を変更しない場合は、0 に設定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

グローバル マウス Y 乗数
GlobalMouseYMultiplier double

設定する垂直 (Y) グローバル マウス移動乗数 (エージェントがマウスを移動したとき)。 現在の値を変更しない場合は、0 に設定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

mouse_eventに適用
GlobalMouseMultiplierApplyToMouseEvent boolean

これは、グローバル マウス乗数の値を mouse_event メソッドに適用するかどうかを指定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

SetCursorPos に適用
GlobalMouseMultiplierApplyToSetCursorPos boolean

この引数は、グローバル マウス乗数の値を SetCursorPos メソッドに適用するかどうかを指定します。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

現在のマウス移動方法に適用
GlobalMouseMultiplierApplyToCurrentMouseMoveMethod boolean

この引数は、現在のマウス移動メソッドにグローバル マウス乗数の値を適用するかどうかを指定します (たとえば、SetCursorPos が現在のマウス移動メソッドの場合、乗数は SetCursorPos に適用されます)。 これが true に設定されている場合、入力 'Apply to mouse_event' と 'Apply to SetCursorPos' は無視されます。 このオプションは、[マルチモニター機能] が無効になっている場合にのみ有効です。

Java 座標系
JavaCoordinateSystem string

Java Access Bridge が仮想 (DPI スケール) 座標を提供していることをエージェントに通知するには、"Virtual" (既定で、IA-Connect 9.3 以前で使用可能な唯一のオプション) に設定します。 Java Access Bridge が物理座標 (ピクセルに直接マップ) を提供していることをエージェントに通知するには、"物理" に設定します。 変更を加えない場合は、'Not set' (NotSet) に設定します。

SAP GUI 座標系
SAPGUICoordinateSystem string

SAP GUI スクリプト API が仮想 (DPI スケール) 座標を提供していることをエージェントに通知するには、"Virtual" (既定で、IA-Connect 9.3 以前で使用可能な唯一のオプション) に設定します。 SAP GUI スクリプト API が物理座標 (ピクセルに直接マップ) を提供していることをエージェントに通知するには、"物理" に設定します。 変更を加えない場合は、'Not set' (NotSet) に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
SetAgentGlobalCoordinateConfigurationResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

エージェント情報 IA-Connect 取得する

バージョン番号とエージェント実行可能ファイルへのパスを含む、IA-Connect エージェントのプロパティを返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect エージェントのバージョン
IAConnectAgentVersion string

IA-Connect エージェントの完全なバージョン番号。

DotNet CLR バージョン
DotNetCLRVersion string

DotNet 共通言語ランタイム (CLR) バージョン。

IA-Connect エージェントをユーザー名として実行する
IAConnectAgentRunAsUsername string

IA-Connect エージェントが実行されているユーザー セッションのユーザー名。

IA-Connect エージェントを userdomain として実行する
IAConnectAgentRunAsUserdomain string

IA-Connect エージェントが実行されているユーザー セッションのユーザー ドメイン。

IA-Connect エージェント パス
IAConnectAgentPath string

IA-Connect エージェント実行可能ファイルへの完全なパス。

IA-Connect エージェントは 64 ビット プロセスです
IAConnectAgentIs64bitProcess boolean

IA-Connect エージェントが 64 ビット プロセスの場合は true、そうでない場合は false を返します。

IA-Connect エージェントのリリース バージョン
IAConnectAgentReleaseVersion string

IA-Connect エージェントのリリース バージョン (例: 8.0)。

IA-Connect エージェント RPA コマンドのタイムアウト
IAConnectAgentRPACommandTimeout integer

IA-Connect エージェント RPA コマンドのタイムアウト。 既定値は 30 秒で、"Set IA-Connect Agent command timeout" アクションを使用して設定できます。

IA-Connect エージェントのログ ファイル名
IAConnectAgentLogFilename string

IA-Connect エージェントのログ ファイル名。 この値は、ファイル名に起動日時があるため、IA-Connect エージェントの起動ごとに一意です。

オーケストレーター フロー統計の結果を更新する

IA-Connect Orchestrator の現在のワーカー フローの結果統計を更新します。 これは、IA-Connect オーケストレーターのフロー統計の最終的な結果を変更するために使用されます。これは通常、レポートの目的で使用されます。 これは、現在のフローに対してのみ機能します (オーケストレーターはフロー実行 ID を検出します)。 他のフローの統計を変更することはできません。

パラメーター

名前 キー 必須 説明
フローの最後のアクションの成功
FlowLastActionSuccess boolean

オーケストレーター フロー統計の最後のアクションが成功であることを指定するには、true に設定します。 オーケストレーター フロー統計の最後のアクションが失敗であることを指定するには、false に設定します。 フローの最後のアクションの状態を更新しない場合は、このフィールドを空白のままにします (たとえば、最後のアクション コードのみを更新する場合)。

フローの最後のアクションのエラー メッセージ
FlowLastActionErrorMessage string

フローの最後のアクションが失敗であることを指定する場合は、ここにエラー メッセージを入力します。

フローの最後のアクション コード
FlowLastActionCode integer

Flow 統計に割り当てる省略可能なコード。これは通常、エラー コード (たとえば、システムとビジネスの例外を区別するために) として使用されますが、成功コードとして使用できます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
UpdateOrchestratorFlowStatsResultResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

オーケストレーターの自動化タスク操作を削除する

一意のタスク操作 ID を指定して、特定の Orchestrator 自動化タスクを削除します。

パラメーター

名前 キー 必須 説明
操作 ID
OperationId True string

削除するオーケストレーター タスクの操作 ID。

ソース システムを更新する
UpdateSourceSystem boolean

true (既定値) に設定され、Orchestrator タスクがソース システム (ServiceNow など) にリンクされている場合、Orchestrator は Orchestrator のソース システム構成で指定されたすべてのアクションを実行します (たとえば、チケットを閉じます)。 false に設定されている場合、またはタスクがソース システムにリンクされていない場合、タスクは Orchestrator からのみ削除されます。

戻り値

名前 パス 説明
コマンドの結果
TasksDeleteTaskOperationResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

キー イベントを送信する

低レベルのキーボード ドライバーを使用して、グローバル キー押下イベントを IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パラメーター

名前 キー 必須 説明
テキスト
Text True string

キーを押すと、低レベルのキーボード ドライバーを使用して、IA-Connect エージェント ユーザー セッションに入ります。 キー コードについては、「UI ユーザー ガイド」の「キー イベントの送信構文」を参照してください。 エスケープを押して離す例: {Escape}。 Win + D キーを押してデスクトップを表示する例 (左の Windows キーを押し、d キーを押して離し、左の Windows キーを離す): <{LWin}d>{LWin}。 Ctrl キーを押しながら C キーを押す (左のコントロールを押し、c キーを押しながら離し、左コントロールを離す) 例: <{Ctrl}c>{Ctrl}。 押されたキーを解放することを忘れないでください。または、押したままにします (たとえば、 < を使用して修飾子キーを押し下ける場合は、 > を使用して解放します)。

間隔 (ミリ秒)
Interval integer

各キー押下イベントの間のミリ秒数。

パスワードです
IsPassword boolean

入力はパスワード値ですか? その場合は、代替の "パスワード キー イベントの送信" アクションを使用する必要があります。

シンボルを解釈しない
DontInterpretSymbols boolean

テキスト内の記号は、特殊なキー (たとえば、Shift の場合は {Shift}、Ctrl の場合は {Ctrl}) と解釈しないでください。 実際のシンボルを入力する場合は、この値を true に設定する必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

キーの送信

グローバル キー押下を IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パラメーター

名前 キー 必須 説明
テキスト
Text True string

キーが押されると、IA-Connect エージェント ユーザー セッションでシミュレートされます。 キー コードについては、「UI ユーザー ガイド」の「キーの送信構文」を参照してください。 英数字を入力するには、テキスト as-isを入力するだけです。 Ctrl キーを押しながら C キーを押す例: ^c。 Alt キーを押しながら F キーを押す例: %fします。

間隔 (ミリ秒)
Interval integer

各キーが押されるまでのミリ秒数。

パスワードです
IsPassword boolean

入力はパスワード値ですか? その場合は、代替の "パスワード キーの送信" アクションを使用する必要があります。

シンボルを解釈しない
DontInterpretSymbols boolean

テキスト内の記号を特殊なキーとして解釈しないでください (例: + (Shift の場合)、^ (Ctrl の場合) など)。 実際のシンボルを入力する場合は、この値を true に設定する必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

クライアント ホスト名を取得する

IA-Connect Director が実行されているクライアントのホスト名を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
クライアント ホスト名
ClientHostname string

IA-Connect Director が実行されているクライアントのホスト名。

クライアントからサーバーにファイルをコピーする

(IA-Connect Director を実行している) ローカル コンピューターからリモート コンピューター (IA-Connect エージェントを実行している) にファイルをコピーします。

パラメーター

名前 キー 必須 説明
クライアント ファイルのパス
ClientFilePath True string

ファイルのコピー元のファイル パス (IA-Connect Director を実行しているローカル コンピューター上)。

サーバー ファイルのパス
ServerFilePath True string

ファイルのコピー先のファイル パス (IA-Connect エージェントを実行しているコンピューター上)。

圧縮する
Compress boolean

コピー時にファイルを圧縮する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

クリップボードのクリア

IA-Connect エージェント ユーザー セッションのクリップボードの内容をクリアします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

クリップボードの設定

IA-Connect エージェント ユーザー セッションのクリップボードの内容を設定します。

パラメーター

名前 キー 必須 説明
新しいクリップボード データ
NewClipboardData string

クリップボードに設定するデータ。

Workflow
Workflow True string

workflow() に次の式を追加します。

クリップボードを取得する

IA-Connect エージェント ユーザー セッションのクリップボードの現在のコンテンツを取得します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
クリップボード のデータ
ClipboardData string

クリップボードに含まれるデータ。

コマンド統計 IA-Connect リセットする

IA-Connect エージェントが現在のセッションで実行したコマンドに関して、現在保存されているすべての統計情報をリセットします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

コンピューター ドメインを取得する

IA-Connect エージェント ユーザー セッションを実行しているコンピューターのドメインを返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ドメイン名
DomainName string

IA-Connect エージェント ユーザー セッションを実行しているコンピューターの NetBIOS ドメイン名。

DNS ドメイン名
DNSDomainName string

IA-Connect エージェント ユーザー セッションを実行しているコンピューターの DNS ドメイン名。

コンピューター名を取得する

IA-Connect エージェント ユーザー セッションを実行しているコンピューターの名前を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コンピューター名
MachineName string

IA-Connect エージェント ユーザー セッションを実行しているコンピューターの名前。

スクリーン リーダーが有効になっているか

IA-Connect エージェント ユーザー セッションでスクリーン リーダーが有効になっているかどうかを返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
スクリーン リーダーが有効
ScreenReaderEnabled boolean

スクリーン リーダーが有効になっている場合は true を返します。

スクリーン リーダーの設定

IA-Connect エージェント ユーザー セッションでスクリーン リーダーを有効または無効にします。

パラメーター

名前 キー 必須 説明
スクリーン リーダーを有効にする
EnableScreenReader boolean

true に設定すると、スクリーン リーダーが有効になります。 false に設定すると、スクリーン リーダーは無効になります。

Workflow
Workflow True string

workflow() に次の式を追加します。

スクリーンショットを撮る

IA-Connect エージェント ユーザー セッションのスクリーンショットを取得し、Base64 でエンコードされた文字列として返します。

パラメーター

名前 キー 必須 説明
全画面表示
Fullscreen boolean

スクリーンショットには画面全体を含める必要がありますか?

左 X ピクセル
LeftXPixels integer

画面全体のスクリーンショットを取得しない場合は、スクリーンショットの開始位置の X 値 (ピクセル単位)。 1 つのディスプレイでは、左端の X ピクセルは 0 です。 マルチモニター ディスプレイでは、左端の X ピクセルが負の値になる可能性があります (どのディスプレイがプライマリとしてマークされ、他のディスプレイに対して相対的であるかによって異なります)。

上位 Y ピクセル
TopYPixels integer

画面全体のスクリーンショットを取得しない場合は、スクリーンショットの開始位置の Y 値 (ピクセル単位)。 1 つのディスプレイでは、最上位の Y ピクセルは 0 です。 マルチモニター ディスプレイでは、最上位の Y ピクセルが負の値になる可能性があります (どのディスプレイがプライマリとしてマークされているか、他のディスプレイとの相対位置によって異なります)。

幅ピクセル
WidthPixels integer

画面全体のスクリーンショットを取得しない場合は、開始位置からのスクリーンショットの幅。

高さピクセル
HeightPixels integer

画面全体のスクリーンショットを取得しない場合は、開始位置からのスクリーンショットの高さ。

イメージ形式
ImageFormat string

画像形式 (PNG、JPG、BMP、GIF) を指定します。

ディスプレイ デバイスを使用する
UseDisplayDevice boolean

IA-Connect エージェントは、ディスプレイ デバイス情報を考慮する必要がありますか? これは DPI スケーリングの方が適切に機能し、複数のディスプレイをサポートします。

エラー時に例外を発生させる
RaiseExceptionOnError boolean

true を設定した場合: スクリーンショットが失敗した場合 (たとえば、セッションがロックされている場合) は、IA-Connect エージェントによって例外が発生します。 false を設定した場合: スクリーンショットが失敗した場合、IA-Connect は空白のビットマップを返し、"スクリーンショット成功" と "スクリーンショット エラー メッセージ" の出力を設定します。

エージェントを非表示にする
HideAgent boolean

エージェントを自動的に非表示にして (表示されている場合)、スクリーンショットを隠さない場合は true に設定します。

物理座標を使用する
UsePhysicalCoordinates boolean

指定した座標が物理的であることを指定する場合は true に設定します (DPI スケールされないため、ディスプレイ上の物理ピクセルと一致します)。 指定された座標が仮想 (DPI スケール) であることを指定するには、false (既定値) に設定します。 UIA、Java、および Web アクションでは、通常、仮想座標が使用されます。

ディスプレイ デバイス ID
DisplayDeviceId integer

この入力は、入力 'ディスプレイ デバイスの使用' が true に設定されている場合にのみ機能します。 すべてのモニターを含めるには、0 (既定値) に設定します。 プライマリ モニターのみを含めるには、1 に設定します。 関連するセカンダリ モニターのみを含めるには、2 以上に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
Base64 としての画面イメージ
ScreenBitmapBase64 string

Base64 でエンコードされた文字列としての画面イメージ。 これは、提供されたユーティリティ 'Base64 to bitmap' を使用して表示できます。

成功したスクリーンショット
ScreenshotSuccessful boolean

スクリーンショットが成功した場合は true に設定します。 スクリーンショットが失敗し、[エラー時に例外を発生させる] が false に設定されている場合は false に設定されます。 スクリーンショットが失敗し、[エラー時に例外を発生させる] が true に設定されている場合、例外が発生します。

スクリーンショットのエラー メッセージ
ScreenshotErrorMessage string

スクリーンショットが失敗し、[エラー時に例外を発生させる] が false に設定されている場合、この出力フィールドにはエラー メッセージが保持されます。 これは、"エラー時に例外を発生させる" を true に設定する代わりに、スクリーンショットの実行中にエラーが発生した場合に例外が発生します。

セッション IA-Connect 名前で存在するか

指定した IA-Connect Director セッションが存在する場合に返します。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

パラメーター

名前 キー 必須 説明
IA-Connect セッション名
IAConnectSessionName True string

確認する IA-Connect セッションの名前。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect セッションが存在する
IAConnectSessionExists boolean

指定した名前のセッションが存在する場合は true、存在しない場合は false を返します。

セッションがロックされている

IA-Connect エージェントが実行されているセッションがロックされているかどうかを報告します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
セッションがロックされている
SessionIsLocked boolean

IA-Connect エージェントが実行されているセッションがロックされている場合は true に設定します。

セッションのロック

IA-Connect エージェントが実行されているセッションをロックします。

パラメーター

名前 キー 必須 説明
操作が非アクティブな時間 (分) 後にロックする
LockAfterMinutesOfActionInactivity integer

0 より大きい値に設定した場合、エージェントはすぐにロックされませんが、代わりに、指定した数分間のアクションが非アクティブになるとロックされます (エージェントはアクションを受け取りません)。 これにより、多数のフローが連続して実行されている場合に、エージェントのロックとロック解除が継続的に停止されます。 すぐにロックするには、0 に設定します。 既定値は 5 分です。

ロック後に待機する秒数
SecondsToWaitAfterLock integer

ロック後、指定した秒数待ちます。 これにより、セッションが完全にロックされる時間が与えます。 これは、ロック解除イベント (つまり、別のセッションが開始) がロック解除された直後に発生する可能性がある場合に一般的に使用されます。これは、前のセッションがまだロックされている場合に失敗する可能性があります。 'アクションの非アクティブな分後にロックする' が 0 に設定されている場合にのみ使用されます (即時ロックの原因)。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
LockSessionResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

セッションのロック解除

IA-Connect エージェントが実行されているセッションのロックを解除します。 これにより、資格情報プロバイダーのみがコンピューターのロックを解除できるため、IA-Connect Unlocker 資格情報プロバイダーをセッションをホストしているコンピューターにインストールする必要があります。

パラメーター

名前 キー 必須 説明
パスワードのロック解除
UnlockPassword True string

現在のセッションのロックを解除するためのパスワード。 これは、現在ロックされているセッションにログインしているアカウントの Windows ユーザー パスワードです。 これが 'Stored' パスワードの場合は、{IAConnectPassword:StoredPasswordIdentifier} という形式で入力し、'stored password' の入力を true に設定します。 これが Orchestrator の汎用資格情報の場合は、{OrchestratorCredential:FriendlyName} の形式を入力し、"保存されたパスワード" 入力を true に設定します。

パスワードに保存されたパスワードが含まれている
PasswordContainsStoredPassword boolean

パスワードが IA-Connect 保存されているパスワード識別子 (例: [パスワードの生成] アクションによって生成される) または IA-Connect Orchestrator の汎用資格情報 (たとえば、PA フローで IA-Connect を使用している場合) の場合は true に設定します。

ロックされているかどうかを検出する
DetectIfLocked True boolean

IA-Connect エージェントがセッションがロックされているかどうかを検出しようとした場合。 true に設定され、セッションがロックされていることが検出されない場合、このアクションは (何もする必要がないため) 何も行いません。 セッションがロックされているかどうかを IA-Connect 誤って検出し、ロック解除を強制する場合にのみ false に設定します (セッションがロックされていない場合は失敗します)。

資格情報プロバイダーの検出
DetectCredentialProvider True boolean

IA-Connect エージェントがロック解除要求を送信する前に、IA-Connect Unlocker 資格情報プロバイダーの存在を検出しようとした場合。 IA-Connect 資格情報プロバイダーが存在し、実行されているが、何らかの理由で IA-Connect エージェントが検出していない場合にのみ、これを無効にする必要があります。

ロック解除を待機する秒数
SecondsToWaitForUnlock integer

デスクトップのロック解除状態を検出して、IA-Connect エージェントがデスクトップのロックが正常に解除されたことを示す証拠を待機する時間 (秒単位)。 既定では、これは最大 5 秒です。 この機能を無効にし、デスクトップのロックが解除されたことを確認せずに続行するには、0 に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
セッションのロック解除が実行されました
SessionUnlockPerformed boolean

セッションがロックされ、ロック解除アクションが実行された場合は true に設定されます。 セッションがロックされていない場合は false に設定され、'ロックされている場合は検出' が true に設定され、アクションは実行されません。

セッションをキープ アライブを停止する

IA-Connect エージェント ユーザー セッションのキープ アライブを停止します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
StopKeepSessionAliveResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

セッションを維持する

指定した間隔でマウスを動かして IA-Connect エージェント ユーザー セッションを維持し、セッションがアイドル状態にならないようにします。

パラメーター

名前 キー 必須 説明
X ウィグル
XWiggle integer

マウスを水平方向に移動するピクセル数。

Y ウィグル
YWiggle integer

マウスを垂直方向に移動するピクセル数。

ウィグル遅延 (秒単位)
WiggleDelayInSeconds double

マウスの動きを切り替えるときの秒数。

アイドルしきい値 (秒単位)
IdleThresholdInSeconds integer

マウスを動かす前の最後の入力から経過した秒数。

アイドル チェック期間 (秒単位)
IdleCheckPeriodInSeconds integer

最後の入力時刻を確認するまでの秒数 (アイドルしきい値が渡されたかどうかを確認するため)。

キープアライブ ランタイムの合計 (秒単位)
TotalKeepaliveRuntimeInSeconds integer

セッションを維持する秒数の合計。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
KeepSessionAliveResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

テキスト ファイルを書き込む

IA-Connect エージェントが実行されているコンピューターにテキスト ファイルを作成し、そのファイルにテキストを書き込みます。

パラメーター

名前 キー 必須 説明
ファイルパス
Filename True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

書き込むテキスト
TextToWrite string

ファイルに書き込むテキストの内容。

既存のファイルを追加する
AppendExistingFile boolean

ファイルが既に存在する場合は、書き込む新しいテキストを既存のファイルの末尾に追加する必要がありますか?

Encoding
Encoding string

ファイル エンコード (Unicode、UTF8、UTF7、または ASCII) を指定するか、既定値 (UTF8) には空白のままにします。

必要に応じてフォルダーを作成する
CreateFolderIfRequired boolean

'File path' パラメーターに指定されたファイルを格納するフォルダーが存在しない場合は、このフォルダーを作成する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

ディスクの空き領域を取得する

IA-Connect エージェントが実行されているコンピューター上の指定したディスクの空き領域の量を返します。

パラメーター

名前 キー 必須 説明
ドライブ文字
DriveLetter True string

確認するディスクのドライブ文字。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ディスク空き領域のバイト数
FreeSpaceBytes integer

空きディスク領域の量 (バイト単位)。

ディスク空き領域 KB
FreeSpaceKB integer

空きディスク領域の量 (KB 単位)。

ディスク空き領域 MB
FreeSpaceMB integer

空きディスク領域の量 (メガバイト単位)。

ディスク空き領域 GB
FreeSpaceGB integer

空きディスク領域の量 (ギガバイト単位)。

ディレクター IA-Connect アップタイムを取得する

この IA-Connect ディレクターの稼働時間を秒単位で返します (つまり、ディレクターの実行時間)。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ディレクターの稼働時間 (秒単位)
UpTimeInSeconds integer

IA-Connect ディレクターが実行されている秒数。

ディレクター クライアントの種類とセッション情報を取得する

階層 1 ディレクターによって処理されているローカルまたはリモート セッションの詳細を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
リモート クライアントの種類
RemoteClientType string

リモート クライアントの種類 ('Local'、'Citrix ICA'、または 'Microsoft RDP')。

接続されている仮想チャネル
VirtualChannelConnected boolean

仮想チャネルが接続されている場合は、ディレクターとエージェントの間で True。

ディレクター バージョン
DirectorVersion string

IA-Connect Director DLL のバージョン。 例: 1.67.21.0。

ディレクターリリースバージョン
DirectorReleaseVersion string

IA-Connect ディレクターの IA-Connect リリース バージョン。 例: 9.4。

エージェントのバージョン
AgentVersion string

このディレクターが接続されている IA-Connect エージェント EXE のバージョン。 例: 1.74.21.0。

エージェントのリリース バージョン
AgentReleaseVersion string

このディレクターが接続されている IA-Connect エージェントの IA-Connect リリース バージョン。 例: 9.4。

エージェントのライセンスが付与されている
AgentIsLicensed boolean

True の 場合、このディレクターが接続されている IA-Connect エージェントがライセンスされます。 false(IA-Connect エージェントがライセンスされていない場合)。 エージェント ライセンスの状態が不明な場合は Null。

エージェント ライセンス機能
AgentLicenseFeatures string

このディレクターが接続されている IA-Connect エージェントに割り当てられている IA-Connect ライセンス機能のコンマ区切りの一覧。 例: JML、DEV。

ディレクターのホスト名
DirectorHostname string

ディレクターが実行されているコンピューターのホスト名。 例: vmrpa1。

ディレクター NetBIOS ドメイン名
DirectorNetBIOSDomainName string

ディレクターが実行されているコンピューターの NetBIOS ドメイン名。 例: domain1。 コンピューターがドメインのメンバーでない場合、通常はホスト名が返されます。

ディレクター DNS ドメイン名
DirectorDNSDomainName string

ディレクターが実行されているコンピューターの DNS ドメイン名。 例: domain1.myorg.local。 コンピューターがドメインのメンバーでない場合、通常はホスト名が返されます。

次ホップ ディレクターにアタッチ
AttachedToNextHopDirector boolean

IA-Connect セッションがこのディレクターが接続されているエージェントに現在アタッチされている場合は false に設定されます。 ディレクターが別のディレクター (別のエージェントに接続されている) にすべてのアクション (アタッチ済み) を転送する場合は true に設定します。 たとえば、このディレクターがローカル エージェントと通信しているローカル ディレクターで、IA-Connect セッションが現在 Citrix にアタッチされている場合、この値は true になります。

次ホップ ディレクター セッションの種類
NextHopDirectorSessionType string

このディレクターが次ホップ ディレクターにアタッチされている場合、この値は次ホップ セッションの種類を保持します。 たとえば、このディレクターがローカル エージェントと通信しているローカル ディレクターで、IA-Connect セッションが現在 Citrix にアタッチされている場合、この値は "Citrix ICA" になります。一方、"リモート クライアントの種類" の値は "Local" になります (Citrix へのローカル ディレクター転送アクションを表します)。

ディレクター ログ レベル IA-Connect 設定する

IA-Connect Director のログ 記録レベルを指定した値に設定します。 ログ 記録レベルは 0 から 4 に設定されます。 0 は無効です。 1 は最も低いログ レベル (および既定値) です。 4 は最も高いログ レベルです。

パラメーター

名前 キー 必須 説明
ログ レベル
LoggingLevel True integer

IA-Connect ディレクターを設定する必要があるログ 記録レベル。

Workflow
Workflow True string

workflow() に次の式を追加します。

ディレクターから送信された代替 IA-Connect エージェントを実行する

IA-Connect Director から代替エージェントをアップロードし、代替エージェント実行可能ファイルを読み込んで、代替 IA-Connect エージェント (新しいバージョンなど) を実行します。

パラメーター

名前 キー 必須 説明
ローカル ファイル名
LocalFilename True string

IA-Connect ディレクターからアクセスできる代替 IA-Connect Agent.exe への完全なパス。

リモート ファイル名
RemoteFilename string

代替 IA-Connect Agent.exe をコピーする場所への完全パス (リモート システム上)。 指定しない場合は、一時ファイル名が選択されます。 代替 IA-Connect エージェントがメモリに読み込まれている場合、[メモリから実行されている場合でもディスクに保存する] を true に設定しない限り、このファイルは作成されません (不要であるため)。 これは、"アセンブリを実行する参照" を必要とする IA-Connect の動的コード アクション (たとえば、内部メソッド IA-Connect アクセスする) を使用する場合にのみ true に設定します。

圧縮する
Compress boolean

代替 IA-Connect エージェント実行可能ファイルは、アップロード中に圧縮する必要がありますか?

論争
Arguments string

実行時に IA-Connect Agent.exe に渡す省略可能な引数。

ダウングレードを許可する
PermitDowngrade boolean

以前のバージョンの IA-Connect エージェントを許可する必要がありますか?

バージョン チェックをスキップする
SkipVersionCheck boolean

IA-Connect エージェントのバージョン (既存と新規) をまったくチェックしないでください。その結果、すべてのシナリオで新しいバージョンが使用されます (同じバージョンでも)。

メモリへの読み込み
LoadIntoMemory boolean

代替 IA-Connect エージェントをメモリ内で実行する必要がありますか? true に設定すると、新しいエージェントがメモリに読み込まれ、既存のエージェントのアセンブリ内で実行されます。 false に設定すると、新しいエージェントが通常のプロセスとして実行され、既存のエージェント EXE が終了します。

メモリから実行されている場合でもディスクに保存する
SaveToDiskEvenIfRunningFromMemory boolean

代替 IA-Connect エージェントは、メモリ内で実行されている場合でもディスクに保存する必要がありますか? これは、"アセンブリを実行する参照" を必要とする IA-Connect の動的コード アクション (たとえば、内部メソッド IA-Connect アクセスする) を使用する場合にのみ true に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コピーされた代替ファイル
AlternativeFileCopied boolean

代替 IA-Connect エージェントが使用されたかどうかを報告します。

ディレクターのログ レベル IA-Connect 取得する

現在の IA-Connect Director ログ レベルを返します。 ログ 記録レベルは 0 から 4 に設定されます。 0 は無効です。 1 は最も低いログ レベル (および既定値) です。 4 は最も高いログ レベルです。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ログ レベル
LoggingLevel integer

IA-Connect ディレクターの現在のログ 記録レベル。

IA-Connect Director のログ ファイル名
IAConnectDirectorLogFilename string

IA-Connect Director のログ ファイル名。 この値は、ファイル名に起動日時があるため、起動ごとに一意です。

ディレクター情報 IA-Connect 取得する

バージョン番号と Director 実行可能ファイルへのパスを含む、IA-Connect Director のプロパティを返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect Director バージョン
IAConnectDirectorVersion string

IA-Connect ディレクターの完全なバージョン番号。

DotNet CLR バージョン
DotNetCLRVersion string

DotNet 共通言語ランタイム (CLR) バージョン。

IA-Connect Director をユーザー名として実行する
IAConnectDirectorRunAsUsername string

IA-Connect Director が実行されているユーザー セッションのユーザー名。

IA-Connect Director を userdomain として実行する
IAConnectDirectorRunAsUserdomain string

IA-Connect Director が実行されているユーザー セッションのユーザー ドメイン。

IA-Connect ディレクター パス
IAConnectDirectorPath string

IA-Connect Director 実行可能ファイルへの完全なパス。

IA-Connect ディレクターは 64 ビット プロセスです
IAConnectDirectorIs64bitProcess boolean

IA-Connect Director が 64 ビット プロセスの場合は true、そうでない場合は false を返します。

IA-Connect Director リリース バージョン
IAConnectDirectorReleaseVersion string

IA-Connect Director リリース バージョン (例: 8.0)。

IA-Connect Director のログ ファイル名
IAConnectDirectorLogFilename string

IA-Connect Director のログ ファイル名。 この値は、ファイル名に起動日時があるため、IA-Connect Director の起動ごとに一意です。

ディレクトリにアクセス可能か

ディレクトリ (フォルダー) にアクセスできるかどうか、およびアクセス許可によって、IA-Connect エージェントが存在するコンピューターでのアクセスが制限されているかどうかを返します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アクセス可能なディレクトリ
DirectoryAccessible boolean

ディレクトリにアクセスできる場合は true、アクセスできない場合は false を返します。

ディレクトリ アクセスが承認されていない
DirectoryAccessUnauthorised boolean

アクセス許可によってアクセスが制限されているため、ディレクトリにアクセスできない場合は true を返し、アクセスできない場合は false を返します。

ディレクトリの削除

IA-Connect エージェントが実行されているコンピューター上のディレクトリ (フォルダー) を削除します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

リカーシブ
Recursive boolean

サブディレクトリ (サブフォルダー) とディレクトリ内のファイルも削除する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

ディレクトリの消去

IA-Connect エージェントが実行されているコンピューター上のディレクトリ (フォルダー) を消去し、ディレクトリ内に格納されているすべてのファイルを削除します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

リカーシブ
Recursive boolean

すべてのサブフォルダーも削除する必要がありますか?

最上位レベルを削除する
DeleteTopLevel boolean

最上位フォルダーも削除する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

ディレクトリは存在しますか

IA-Connect エージェントが実行されているコンピューターにディレクトリ (フォルダー) が存在するかどうかについて、true または false を報告します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ディレクトリが存在する
DirectoryExists boolean

ディレクトリ (フォルダー) が存在する場合は true、存在しない場合は false を返します。

ディレクトリを作成する

IA-Connect エージェントが実行されているコンピューターにディレクトリ (フォルダー) を作成します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

既に存在する場合はエラー
ErrorIfAlreadyExists boolean

ディレクトリ (フォルダー) が既に存在する場合、IA-Connect エラーが発生する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

ドライブの一覧を取得する

IA-Connect エージェントが実行されているコンピューター上のドライブの一覧を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
JSON をドライブする
DrivesJSON string

IA-Connect エージェントが実行されているコンピューター上のドライブの一覧 (JSON 形式)。

パスワード キー イベントを送信する

グローバル キー押下イベントを、特に低レベルのキーボード ドライバーを使用してパスワードを入力するために、IA-Connect エージェント ユーザー セッションに送信します。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パラメーター

名前 キー 必須 説明
パスワード
Password True password

低レベルのキーボード ドライバーを使用して、IA-Connect エージェント ユーザー セッションに入力するパスワード。 キー コードについては、「UI ユーザー ガイド」の「キー イベントの送信構文」を参照してください。 これが 'Stored' パスワードの場合は、{IAConnectPassword:StoredPasswordIdentifier} という形式で入力し、'stored password' の入力を true に設定します。 これが Orchestrator の汎用資格情報の場合は、{OrchestratorCredential:FriendlyName} の形式を入力し、"保存されたパスワード" 入力を true に設定します。

間隔 (ミリ秒)
Interval integer

各キー押下イベントの間のミリ秒数。

シンボルを解釈しない
DontInterpretSymbols boolean

パスワード内の記号は、特殊なキー (Shift の場合は {Shift}、Ctrl の場合は {Ctrl} など) として解釈しないでください。 実際のシンボルを入力する場合は、この値を true に設定する必要があります。

パスワードに保存されたパスワードが含まれている
PasswordContainsStoredPassword boolean

パスワードが IA-Connect 保存されているパスワード識別子 (例: [パスワードの生成] アクションによって生成される) または IA-Connect Orchestrator の汎用資格情報 (たとえば、PA フローで IA-Connect を使用している場合) の場合は true に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

パスワード キーを送信する

グローバル キー押下を IA-Connect エージェント ユーザー セッションに送信します。これは、特にパスワードを入力するためです。 これにより、ユーザーがキーボードでこれらのキーを押すのをシミュレートします。 ターゲットの Window 要素がフォーカスされているか、キー押下が間違ったアプリケーションによって受信されるか、無視されることを確認します。

パラメーター

名前 キー 必須 説明
パスワード
Password True password

IA-Connect エージェント ユーザー セッションでシミュレートされたキー押下を使用して入力するパスワード。 キー コードについては、「UI ユーザー ガイド」の「キーの送信構文」を参照してください。 これが 'Stored' パスワードの場合は、{IAConnectPassword:StoredPasswordIdentifier} という形式で入力し、'stored password' の入力を true に設定します。 これが Orchestrator の汎用資格情報の場合は、{OrchestratorCredential:FriendlyName} の形式を入力し、"保存されたパスワード" 入力を true に設定します。

間隔 (ミリ秒)
Interval integer

各キーが押されるまでのミリ秒数。

シンボルを解釈しない
DontInterpretSymbols boolean

パスワード内の記号を特殊なキーとして解釈しないでください (例: + (Shift の場合)、^ (Ctrl の場合) など)。 実際のシンボルを入力する場合は、この値を true に設定する必要があります。

パスワードに保存されたパスワードが含まれている
PasswordContainsStoredPassword boolean

パスワードが IA-Connect 保存されているパスワード識別子 (例: [パスワードの生成] アクションによって生成される) または IA-Connect Orchestrator の汎用資格情報 (たとえば、PA フローで IA-Connect を使用している場合) の場合は true に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

パスワードの生成

テンプレート形式で定義されている辞書の単語、数字、記号、文字を含むパスワードを生成します。

パラメーター

名前 キー 必須 説明
パスワードの形式
PasswordFormat True string

シンボルを使用して記述された生成されたパスワードの形式。 記号 'w' は辞書の単語を表し、'u' は大文字の辞書単語を表し、'n' は数字を表し、's' は記号を表し、'l' は小文字を表し、'L' は大文字を表し、'z' は何も表しません (組み合わせて使用できます)。 たとえば、wnnwsl によって Pluto35Marmite!b が生成される場合があります。 数値の後に中かっこで囲まれた 2 つ以上の記号が続くと、その数のシンボルのランダムな組み合わせが作成されます。 たとえば、8(Lln) は 6hP2AxP0 および 4(Lsz) を生成する場合や、S!-A (LssL シンボル) を生成したり、J$ (Lszz シンボル) を生成したりする場合があります。 単一引用符内の文字は、as-is使用されます。 たとえば、w'--'w'_'nn は Jersey--Mountain_64 を生成する場合があります。

最小長
MinimumLength integer

生成されたパスワードの最小長。 生成されたパスワードが短すぎる場合は、長さが満たされるまで辞書の単語が追加されます。 最小長要件がない場合は 0 に設定します。

プレーン テキストとして返す
ReturnAsPlainText boolean

パスワードをプレーン テキストとして返すには、true に設定します。

パスワードを識別子として保存する
StorePasswordAsIdentifier string

識別子が指定されている場合、このパスワードは、保存されている資格情報を使用できるコマンドで後で取得/使用するために、Orchestrator またはエージェント内に暗号化されて格納されます (「Generate at」を参照)。 エージェントによって生成された場合、これらのパスワードはメモリにのみ格納され、エージェントが閉じられると失われます。 たとえば、MyExchangePassword は {IAConnectPassword:MyExchangePassword} を使用して取得できます。

サポートされているシンボル
SupportedSymbols string

シンボル 's' が生成されたパスワードの形式で使用されている場合にランダムに使用されるシンボルの一覧を提供できます。 指定しない場合は、組み込みリストが使用されます。 例: !$()*。

一意のパスワードを試す
AttemptUniquePasswords boolean

乱数シーケンスの重複を回避するため、生成されたパスワードが特定のセッション内で可能な限り一意になるように、Orchestrator またはエージェントの true (既定値) に設定します (「生成先」を参照)。 エージェントによって生成された場合、個別のエージェント間で一意のパスワードが保証されたり、エージェントが閉じられたり再起動されたりしても保証されないため、複雑なパスワードを使用してパスワードが非常にランダムであることを常に確認する必要があります (たとえば、wnnws は wnw よりもランダムです)。

Generate at
GenerateAt string

パスワードを生成するコンポーネント IA-Connect 指定します。

最小小文字
MinimumLowercase integer

パスワードに存在する必要がある小文字の最小数。 これができない場合 (たとえば、パスワード形式に十分な l、w、または u 記号がない場合)、例外が発生します。 最小値を指定しない場合は 0 に設定します。

最小大文字
MinimumUppercase integer

パスワードに存在する必要がある大文字の最小数。 これができない場合 (たとえば、パスワード形式に十分な L、w、または u 記号がない場合)、例外が発生します。 最小値を指定しない場合は 0 に設定します。

最小数値
MinimumNumbers integer

パスワードに存在する必要がある数値の最小数。 これが不可能な場合 (たとえば、パスワード形式に十分な n 個のシンボルがない場合)、例外が発生します。 最小値を指定しない場合は 0 に設定します。

最小シンボル
MinimumSymbols integer

パスワードに存在する必要があるシンボルの最小数。 これが不可能な場合 (パスワード形式に十分な記号がない場合など)、例外が発生します。 最小値を指定しない場合は 0 に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プレーンテキスト パスワード
PlainTextPassword string

要求された場合のプレーン テキストのパスワード。 パスワードは SMS または電子メール (たとえば) 経由で送信されることを意図したワンタイム パスワードであるため、プレーン テキストで要求される可能性があるため、as-is表示する必要があります。

パスワード文字列を展開する

格納されているパスワードへの参照を含む入力文字列 IA-Connect 受け入れ、その文字列を、格納されているパスワードに置き換えられた参照で返します。

パラメーター

名前 キー 必須 説明
入力文字列
InputString string

格納されているパスワード識別子 IA-Connect 含む入力文字列。 例: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}' where 'GeneratedPassword' is the name of a stored IA-Connect password.

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
出力文字列
OutputString string

実際のパスワードに置き換えられたパスワード識別子を含む入力文字列を含む出力文字列。 たとえば、"Welcome new starter, your new account password is Fantastic12Monkeys!" などです。

ファイル サイズを取得する

IA-Connect エージェントが実行されているコンピューター上のファイルのサイズ (バイト単位) を返します。

パラメーター

名前 キー 必須 説明
ファイルパス
Filename True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ファイル サイズ
FileSize integer

ファイル サイズ (バイト単位)。

ファイル セキュリティから ID を削除する

IA-Connect エージェントが実行されているコンピューター上のファイルのセキュリティアクセス許可から ID (ユーザー、グループ、コンピューターなど) を削除します。

パラメーター

名前 キー 必須 説明
ファイルパス
FilePath True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

削除する ID
IdentityToRemove True string

削除するユーザーまたはグループの ID。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アクセス許可が削除されました
PermissionWasRemoved boolean

アクセス許可が正常に削除された場合は true を返します。

ファイル セキュリティのアクセス許可を取得する

IA-Connect エージェントが実行されているコンピューター上のファイルに現在設定されているアクセス許可の一覧を返します。

パラメーター

名前 キー 必須 説明
ファイルパス
FilePath True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
セキュリティアクセス許可 JSON
SecurityPermissionsJSON string

指定されたファイルに現在設定されているアクセス許可 (JSON 形式)。

ファイルからすべてのテキストを読み取る

IA-Connect エージェントが実行されているコンピューター上のファイルのテキスト コンテンツを読み取ります。

パラメーター

名前 キー 必須 説明
ファイルパス
Filename True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ファイル テキストの内容
FileTextContents string

ファイルのテキストコンテンツ。

ファイルにアクセス許可を追加する

IA-Connect エージェントが実行されているコンピューター上のファイルにアクセス許可を追加します。

パラメーター

名前 キー 必須 説明
ファイルパス
FilePath True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

アイデンティティ
Identity True string

アクセス許可を割り当てるユーザーまたはグループの ID。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

権限
Permission True string

割り当てるアクセス許可 (Read、ReadAndExecute、Modify または FullControl) を指定するか、既定値 (読み取り) を空白のままにします。

Deny
Deny boolean

アクセス許可が拒否されていますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

ファイルのコピー

IA-Connect エージェントが実行されているコンピューターにファイルをコピーします。

パラメーター

名前 キー 必須 説明
ソース ファイルのパス
SourceFilePath True string

ソース ファイルへの完全パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

変換先ファイルのパス
DestFilePath True string

ファイルのコピー先の完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

ファイルの内容を Base64 として取得する

指定したファイルの内容を Base64 形式で取得します。これは、API 経由の転送に適した形式で、元のテキストまたはバイナリ形式に簡単に変換できます。

パラメーター

名前 キー 必須 説明
ファイルパス
FilePath True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

圧縮する
Compress boolean

True に設定すると、Base64 に変換する前にファイルの内容が圧縮されます。 ファイルは手つかずで、すべての操作がメモリ内で実行されます。 この機能は、Base64 を取得した後にファイルの内容を GUnzip できる場合にのみ役立ちます (元のファイル コンテンツのテキストまたはバイナリ データにデコードする場合)。 Base64 を入力として受け入れ、GUnzip 機能を持たないアクションに Base64 を直接渡す場合は false に設定します。

最大ファイル サイズ
MaxFileSize integer

ファイルの最大サイズ。ファイルの内容を取得する代わりに例外が発生します。 これにより、エージェントが巨大なファイルを取得するように求められる状況を回避できます。これにより、最終的にアクションがタイムアウトになります。ファイル サイズチェックを無効にするには、-1 に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
Base64 としてファイルの内容
FileContentsAsBase64 string

Base64 形式のファイルの内容。

ファイルの所有者を設定する

IA-Connect エージェントが実行されているコンピューター上のファイルの所有者を設定します。

パラメーター

名前 キー 必須 説明
ファイルパス
FilePath True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

ユーザー ID
UserIdentity True string

所有権を割り当てるユーザーの ID。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

Workflow
Workflow True string

workflow() に次の式を追加します。

ファイルの移動

IA-Connect エージェントが実行されているコンピューター上のファイルを移動します。

パラメーター

名前 キー 必須 説明
ソース ファイルのパス
SourceFilePath True string

ソース ファイルへの完全パス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

変換先ファイルのパス
DestFilePath True string

ファイルの移動先への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

ファイルは存在しますか

IA-Connect エージェントが実行されているコンピューターにファイルが存在するかどうかについて、true または false を報告します。

パラメーター

名前 キー 必須 説明
ファイルパス
Filename True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ファイルが存在する
FileExists boolean

ファイルが存在する場合は true、存在しない場合は false を返します。

ファイルをクリップボードにコピーする

指定したローカル ファイルを、IA-Connect エージェント ユーザー セッションのクリップボードにコピーします。

パラメーター

名前 キー 必須 説明
ファイル名
Filepath True string

クリップボードにコピーするローカル ファイルへのファイル パス。

切り取り
Cut boolean

true に設定すると、ファイルはコピーされるのではなく切り取られます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
CopyFileToClipboardResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

ファイルを削除する

IA-Connect エージェントが実行されているコンピューター上のファイルを削除します。

パラメーター

名前 キー 必須 説明
ファイルパス
Filename True string

ファイルへの完全なパスです。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

ファイルを削除する

IA-Connect エージェントが実行されているコンピューター上のパターンに一致する指定したフォルダー内のファイルを削除します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

パターン
Pattern string

削除するファイルと照合するパターン 。たとえば、すべてのファイルの場合 は . 、拡張子が .txt のファイルの場合は *.txt。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
削除されたファイルの数
NumberOfFilesDeleted integer

正常に削除されたファイルの数。

削除に失敗したファイルの数
NumberOfFilesFailedToDelete integer

削除できなかったファイルの数。

ファイルを取得する

IA-Connect エージェントが実行されているコンピューター上のフォルダー (パターンの CSV リストに一致する) 内のファイルの一覧を返します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

パターン CSV
PatternsCSV True string

一致するファイル パターンのコンマ区切りのリスト。たとえば、すべてのファイルの場合は . 拡張子が .txt または拡張子が .docx のファイルの場合は.docx'.txt。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ファイル JSON
FilesJSON string

フォルダー内に含まれるファイルの一覧 (JSON 形式)。

正常に読み取られたファイルの数
NumberOfFilesReadSuccessfully integer

正常に読み取られたファイルの数。

読み取りに失敗したファイルの数
NumberOfFilesFailedToRead integer

読み取りできなかったファイルの数。

フォルダーにアクセス許可を追加する

IA-Connect エージェントが実行されているコンピューター上のフォルダーにアクセス許可を追加します。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

アイデンティティ
Identity True string

アクセス許可が割り当てられる ID (ユーザー、グループ、コンピューターなど)。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

権限
Permission True string

割り当てるアクセス許可 (Read、ReadAndExecute、Modify または FullControl) を指定するか、既定値 (読み取り) を空白のままにします。

フォルダーに適用
ApplyToFolder boolean

アクセス許可はフォルダー自体に適用する必要がありますか?

サブフォルダーに適用する
ApplyToSubFolders boolean

アクセス許可はサブフォルダーに反映される必要がありますか?

ファイルに適用する
ApplyToFiles boolean

フォルダー内のファイルにアクセス許可を適用する必要がありますか?

Deny
Deny boolean

アクセス許可が拒否されていますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

フォルダーに所有者を設定する

IA-Connect エージェントが実行されているコンピューター上のフォルダーの所有者を設定します。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

ユーザー ID
UserIdentity True string

所有権を割り当てるユーザーの ID。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

Workflow
Workflow True string

workflow() に次の式を追加します。

フォルダーのセキュリティから ID を削除する

IA-Connect エージェントが実行されているコンピューター上のフォルダーのセキュリティアクセス許可から ID (ユーザー、グループ、コンピューターなど) を削除します。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

削除する ID
IdentityToRemove True string

削除するユーザーまたはグループの ID。 これは、'username'、'DOMAIN\username' または 'username@domainfqdn' の形式にすることができます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アクセス許可が削除されました
PermissionWasRemoved boolean

アクセス許可が正常に削除された場合は true を返します。

フォルダーのセキュリティの継承を解除する

IA-Connect エージェントが実行されているコンピューター上のフォルダーのセキュリティ継承を解除します。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

継承を明示的に変換する
ConvertInheritedToExplicit boolean

現在継承されているアクセス許可を明示的なアクセス許可に変換する必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

フォルダーのセキュリティアクセス許可を取得する

IA-Connect エージェントが実行されているコンピューター上のフォルダーに現在設定されているアクセス許可の一覧を返します。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
セキュリティアクセス許可 JSON
SecurityPermissionsJSON string

指定したフォルダーに現在設定されているアクセス許可 (JSON 形式)。

フォルダーのセキュリティ継承を有効にする

IA-Connect エージェントが実行されているコンピューター上のフォルダーでセキュリティ継承を有効にします。

パラメーター

名前 キー 必須 説明
フォルダー パス
FolderPath True string

フォルダーへの完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

フォルダーを取得する

IA-Connect エージェントが実行されているコンピューター上の指定したフォルダー内のすべてのサブフォルダーを返します。

パラメーター

名前 キー 必須 説明
ディレクトリ パス
DirectoryPath True string

ディレクトリ (フォルダー) への完全なパス。 これは、IA-Connect エージェントが実行されているセッションからアクセスできる必要があります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
フォルダー JSON
FoldersJSON string

フォルダー内に含まれるサブフォルダーの一覧 (JSON 形式)。

正常に読み取られたフォルダーの数
NumberOfFoldersReadSuccessfully integer

正常に読み取られたサブフォルダーの数。

読み取りに失敗したフォルダーの数
NumberOfFoldersFailedToRead integer

読み取りできなかったサブフォルダーの数。

フローの結果 JSON から失敗したアクションのエラー メッセージを取得する

1 つ以上のフロー result() 式の JSON 出力をデテリアリスし、失敗したアクションから最初に見つけたエラー メッセージを取得します。 エラー メッセージは、さまざまな形式で JSON に格納できます。 このアクションは既知の形式を処理し、最初に見つかっているエラー メッセージを返します。

パラメーター

名前 キー 必須 説明
フローの結果 JSON
PowerAutomateResultJSON True array of string

1 つ以上のフロー result() 式からの出力を含む JSON の配列。 1 つのフロー result() 式の出力のみを処理する場合は、最初の配列項目に入力します。

検索の状態
SearchStatus string

エラー メッセージを含むアクションの状態。 これは、既定の 'Failed' とは異なる状態を検索する場合にのみ変更する必要があります。

戻り値

名前 パス 説明
アクションのエラー メッセージ
ActionErrorMessage string

結果の JSON から抽出されたアクション エラー メッセージを返します。 エラー メッセージが見つからない場合は、空白の値が返されます。

アクション名
ActionName string

エラー メッセージに関連付けられているアクションの名前を返します。

アクション コード
ActionCode string

エラー メッセージに関連付けられているアクションの結果コードを返します。

フローを完了としてマークする

フローを完了としてマークします。これにより、割り当てられたワーカー マシンが他のフローを処理できるようになりました IA-Connect Orchestrator に通知されます。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

プリンターの一覧を取得する

IA-Connect エージェント セッションで使用可能なすべてのプリンターの一覧を返します。

パラメーター

名前 キー 必須 説明
ローカル プリンターを一覧表示する
ListLocalPrinters boolean

ローカル プリンターを返す必要がありますか?

ネットワーク プリンターを一覧表示する
ListNetworkPrinters boolean

ネットワーク プリンターを返す必要がありますか?

詳細情報を返す
ReturnDetailedInformation boolean

場所、ポート名、ドライバー名、各プリンターの状態などの詳細情報を返す必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
Printers JSON
PrintersJSON string

見つかったすべてのプリンターの一覧 (JSON 形式)。

プリンターの数
NumberOfPrinters integer

見つかったプリンターの数。

プロセス ID でプロセスを取得する

指定したプロセス ID を持つプロセスが、IA-Connect エージェント ユーザー セッションで実行されているかどうかを返します。 プロセス ID は一意であるため、ID と一致できるプロセスは 1 つだけです。プロセス ID は動的であり、アプリケーションを起動するたびに異なります。

パラメーター

名前 キー 必須 説明
プロセス ID
ProcessId True integer

取得するプロセスのプロセス ID。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
実行中のプロセス
ProcessRunning boolean

指定されたプロセス ID を持つプロセスが見つかった場合は true を返します。

プロセス ID のコマンド ライン プロパティを取得する

指定したプロセス ID を持つ IA-Connect エージェント ユーザー セッションで実行中のすべてのプロセスのコマンド ライン プロパティを返します。

パラメーター

名前 キー 必須 説明
プロセス ID
ProcessId True integer

コマンド ライン プロパティを取得するプロセスのプロセス ID。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセス コマンド ライン
ProcessCommandLine string

プロセスのコマンド ライン プロパティ。

引数を処理する
ProcessArguments string

プロセスの開始時に使用された引数。

現在の作業ディレクトリを処理する
ProcessCurrentWorkingDirectory string

プロセスの現在の作業ディレクトリ。

プロセス イメージ パス名
ProcessImagePathName string

プロセスを開始した実行可能ファイルへのパス。

プロセスの実行

プロセス、コマンド、またはアプリケーションを起動します。

パラメーター

名前 キー 必須 説明
プロセス名
ProcessName True string

実行するプロセス。 たとえば、notepad.exe や C:\windows\system32\notepad.exeなどです。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

論争
Arguments string

アプリケーションの起動時に使用するコマンド ライン引数。

作業フォルダー
WorkingDirectory string

プロセスの作業フォルダー/ディレクトリ。 IA-Connect エージェントは、パス内のすべての環境変数を展開します。

シェル実行を使用する
UseShellExecute boolean

オペレーティング システム シェルを使用してプロセスを開始する必要がありますか?

ウィンドウを作成しない
CreateNoWindow boolean

プロセスはウィンドウなしで開始する必要がありますか?

ウィンドウ スタイル
WindowStyle string

ウィンドウ スタイル (通常、最大化、最小化、非表示) を指定します。

プロセスを待つ
WaitForProcess boolean

プロセスが完了するまで待つ必要がありますか? これは、続行する前に完了する必要があるプログラムまたはスクリプトを実行する場合にのみ使用される可能性があります。

標準出力のリダイレクト
RedirectStandardOutput boolean

標準出力をリダイレクトする必要がありますか?

リダイレクト標準エラー
RedirectStandardError boolean

標準エラーをリダイレクトする必要がありますか?

標準エラーを出力にリダイレクトする
RedirectStandardErrorToOutput boolean

標準エラーを出力にリダイレクトする必要がありますか?

標準出力エンコード
StandardOutputEncoding string

標準出力エンコード (UTF8、UTF7、UTF16、ASCII、またはUTF16BE) を指定します。

標準エラー エンコード
StandardErrorEncoding string

標準エラー エンコード (UTF8、UTF7、UTF16、ASCII、またはUTF16BE) を指定します。

RunAs ドメイン名
RunAsDomain string

ユーザーとしての実行のドメイン。 ドメインが指定されていない場合、ユーザー名はusername@domainFQDN形式にする必要があります。

RunAs ユーザー名
RunAsUsername string

ユーザーとしての実行のユーザー名。

RunAs パスワード
RunAsPassword password

ユーザーとしての実行のパスワード。

RunAs 読み込みユーザー プロファイル
RunAsLoadUserProfile boolean

実行の Windows ユーザー プロファイルをユーザーとして読み込む必要がありますか?

RunAs elevate
RunAsElevate boolean

プロセスは管理者特権で実行する必要がありますか?

タイムアウト (秒)
TimeoutInSeconds integer

プロセスが完了するまで待機する最大秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセスの開始
ProcessStarted boolean

プロセスが開始された場合は true を返します。

終了コード
ExitCode integer

プロセス終了コードを返します。

プロセスがタイムアウトしました
ProcessTimedOut boolean

プロセスがタイムアウトした場合は true を返します。

プロセス ID
ProcessId integer

開始されたプロセスのプロセス ID。

標準出力
StandardOutput string

標準の出力内容。

標準エラー
StandardError string

標準エラーの内容。

プロセスを取得する

IA-Connect エージェント ユーザー セッションで実行中のプロセスの一覧を返します。 必要に応じて、プロセス名を指定してフィルター処理できます。

パラメーター

名前 キー 必須 説明
プロセス名
ProcessName string

プロセス名の省略可能なフィルター。

プロセスのコマンドラインを取得する
GetProcessCommandLine boolean

true に設定すると、プロセスのコマンド ラインの詳細が返されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセスの数
NumberOfProcesses integer

ユーザー セッションで実行されているプロセスの数。

JSON を処理する
ProcessesJSON string

ユーザー セッションで実行されているプロセスの一覧 (JSON 形式)。

マウス カーソルの位置を設定する

IA-Connect エージェント ユーザー セッションのマウス カーソルを指定した位置に設定します。 setcursorpos API は、選択したアクティブなマウス移動 API に関係なく、マウスの移動に使用されます。

パラメーター

名前 キー 必須 説明
X ピクセル
X True integer

X 座標値 (ピクセル単位)。

Y ピクセル
Y True integer

Y 座標値 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウス ホイールを回す

IA-Connect エージェント ユーザー セッションでマウス ホイール (正または負の切り欠き) をオンにします。

パラメーター

名前 キー 必須 説明
ホイールの回転
WheelTurns True integer

実行するホイールターンの数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの中央クリック

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンをクリックします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの中央ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンを離します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの中央ボタンを下へ

IA-Connect エージェント ユーザー セッションでマウスの中央ボタンを押します (離しません)。 マウスを離すには、マウスの中央ボタンアップアクションを使用します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの右ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの右ボタンを離します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの右ボタンを下に移動

IA-Connect エージェント ユーザー セッションでマウスの右ボタンを押します (離しません)。 マウスを離すには、マウスの右ボタンアップアクションを使用します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの左クリック

IA-Connect エージェント ユーザー セッションでマウスの左ボタンをクリックします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの左クリックをダブルクリック

IA-Connect エージェント ユーザー セッションでマウスの左ボタンをダブルクリックします。

パラメーター

名前 キー 必須 説明
ミリ秒単位の遅延
DelayInMilliseconds integer

各クリック間の遅延 (ミリ秒単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの左ボタンを上へ

IA-Connect エージェント ユーザー セッションでマウスの左ボタンを離します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの左ボタンを下に移動

IA-Connect エージェント ユーザー セッションでマウスの左ボタンを押します (離しません)。 マウスを離すには、マウスの左ボタンアップ アクションを使用します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスの移動方法を設定する

現在のマウス移動メソッドを mouse_event または setcursorpos に設定します。

パラメーター

名前 キー 必須 説明
マウスの移動方法を設定する
MouseMoveMethod True string

マウス移動メソッド (mouse_eventまたは setcursorpos) を指定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを中央に押し続けます

IA-Connect エージェント ユーザー セッションのマウスの中央ボタンを、指定した秒数保持します。

パラメーター

名前 キー 必須 説明
保持する秒数
SecondsToHold True double

マウスの中央ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを右クリック

IA-Connect エージェント ユーザー セッションでマウスの右ボタンをクリックします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを右長押し

IA-Connect エージェント ユーザー セッションのマウスの右ボタンを、指定した秒数保持します。

パラメーター

名前 キー 必須 説明
保持する秒数
SecondsToHold True double

マウスの右ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを左に押し続けます

IA-Connect エージェント ユーザー セッションのマウスの左ボタンを、指定した秒数保持します。

パラメーター

名前 キー 必須 説明
保持する秒数
SecondsToHold True double

マウスの左ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを座標で中央に保持する

IA-Connect エージェント ユーザー セッションの指定した座標で、指定した秒数、マウスの中央ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

保持する秒数
SecondsToHold True double

マウスの中央ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを座標で右に押し続けます

IA-Connect エージェント ユーザー セッションの指定した座標で、指定した秒数、マウスの右ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

保持する秒数
SecondsToHold True double

マウスの右ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを座標で左に押し続けます

IA-Connect Agent ユーザー セッションの指定した座標で、指定した秒数、マウスの左ボタンを押したままにします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

保持する秒数
SecondsToHold True double

マウスの左ボタンを押したままにする秒数。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを座標に移動する

IA-Connect エージェント ユーザー セッション内のマウスを指定したピクセル座標に移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

マウスの移動先となる X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

マウスの移動先となる Y 座標値 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウスを相対的に移動する

IA-Connect エージェント ユーザー セッション内のマウスを、現在の位置を基準にして、指定したピクセル数だけ移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

現在位置からマウスを移動する X ピクセルの数。

Y ピクセル
YCoord True integer

マウスを移動する Y ピクセルの数 。現在位置から始まります。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウス乗数を取得する

IA-Connect エージェント ユーザー セッションのグローバル マウス乗数を取得します。 既定値は (1, 1) ですが、[マウス乗数の設定] アクションによって変更された可能性があります。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
X 乗数
MouseXMultiplier double

現在の水平 (X) グローバル マウス乗数 (エージェントがマウスを移動したとき)。 乗数は、"マルチモニター機能" が無効になっている場合にのみ有効になります。

Y 乗数
MouseYMultiplier double

現在の垂直 (Y) グローバル マウス乗数 (エージェントがマウスを移動した場合)。 乗数は、"マルチモニター機能" が無効になっている場合にのみ有効になります。

マウス移動方法
MouseMoveMethod string

現在のグローバル マウス移動メソッド (mouse_eventまたは setcursorpos) を返します。

マウス乗数を設定する

IA-Connect エージェント ユーザー セッションのグローバル マウス乗数を設定します。 これは、リモート デスクトップのスケーリングで問題が発生した場合に、開発中に役立ちます。

パラメーター

名前 キー 必須 説明
X 乗数
MouseXMultiplier double

設定する水平 (X) グローバル マウス乗数 (エージェントがマウスを移動した場合)。 乗数は、"マルチモニター機能" が無効になっている場合にのみ有効になります。

Y 乗数
MouseYMultiplier double

設定する垂直 (Y) グローバル マウス乗数 (エージェントがマウスを移動したとき)。 乗数は、"マルチモニター機能" が無効になっている場合にのみ有効になります。

mouse_eventに適用
ApplyToMouseEvent boolean

この引数は、グローバル マウス乗数の値を mouse_event メソッドに適用するかどうかを指定します。

SetCursorPos に適用
ApplyToSetCursorPos boolean

この引数は、グローバル マウス乗数の値を SetCursorPos メソッドに適用するかどうかを指定します。

現在のマウス移動方法に適用
ApplyToCurrentMouseMoveMethod boolean

この引数は、現在のマウス移動メソッドにグローバル マウス乗数の値を適用するかどうかを指定します (たとえば、SetCursorPos が現在のマウス移動メソッドの場合、乗数は SetCursorPos に適用されます)。 これが true に設定されている場合、入力 'Apply to mouse_event' と 'Apply to SetCursorPos' は無視されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

マウス移動メソッドを取得する

現在のマウス移動メソッドを取得します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
マウス移動方法
MouseMoveMethod string

現在のマウス移動メソッド (mouse_eventまたは setcursorpos) を返します。

ユーザー資格情報からの読み取り

IA-Connect エージェント セッションで、ユーザーのプロファイルの資格情報からユーザー名とパスワードを読み取ります。 資格情報は、Windows コントロール パネルから表示できます。 ユーザー名とパスワードの両方を汎用資格情報から取得できますが、Windows 資格情報から取得できるのはユーザー名のみです。

パラメーター

名前 キー 必須 説明
資格情報アドレス
CredentialAddress True string

資格情報の名前/アドレス。

資格情報の種類
CredentialType True string

資格情報の種類: Windows または Generic。

対称暗号化キー
SymmetricKey string

資格情報パスワードの暗号化を解除するために使用するオプションの対称暗号化キー (資格情報がキーで暗号化されている場合に使用)。 Windows 資格情報のパスワードを取得できないため、汎用資格情報でのみ使用できます。

パスワードを識別子として保存する
StorePasswordAsIdentifier string

識別子が指定されている場合、取得した資格情報パスワードはエージェント内に暗号化されて格納され、保存された資格情報を使用できるコマンドで後で取得/使用できるようになります。 これらのパスワードはメモリにのみ格納され、エージェントを閉じると失われます。 Windows 資格情報のパスワードを取得できないため、汎用資格情報でのみ使用できます。 例: MyExchangePassword。

パスワードを返さない
DontReturnPassword boolean

true に設定すると、資格情報パスワードは返されません。 これは、追加のコマンドで使用するためにエージェント内にパスワードを格納する場合に便利です (つまり、'識別子としてパスワードを格納' は true です)、実際にはワークフロー内でパスワードを知る必要はありません。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ユーザー名
UserName string

資格情報ユーザー名。

パスワード
Password string

資格情報のパスワード。

ユーザー資格情報への書き込み

IA-Connect エージェント セッションでユーザーのプロファイルの資格情報にユーザー名とパスワードを書き込み、存在しない場合はその資格情報を作成します。 資格情報は、Windows コントロール パネルから表示できます。

パラメーター

名前 キー 必須 説明
資格情報アドレス
CredentialAddress True string

資格情報の名前/アドレス。

ユーザー名
UserName True string

資格情報ユーザー名。

パスワード
Password True string

資格情報のパスワード。

資格情報の種類
CredentialType True string

資格情報の種類: Windows または Generic。

資格情報の永続化
CredentialPersistence string

資格情報の永続化: セッション (このログイン セッションの場合のみ)、LocalMachine (セッション間でこのユーザーに対して保持され、このコンピューターでのみ再起動されます)、または Enterprise (マシン間でローミングできます)。

対称暗号化キー
SymmetricKey string

資格情報の暗号化に使用されるオプションの対称暗号化キー。 この資格情報は、キーがわかっている場合にのみ取得できます。 汎用資格情報でのみ使用できます。

パスワードを識別子として保存する
StorePasswordAsIdentifier string

識別子が指定されている場合、このパスワードは、後で保存された資格情報を使用できるコマンドによる取得/使用のために、エージェント内に暗号化されて格納されます。 これらのパスワードはメモリにのみ格納され、エージェントを閉じると失われます。 例: MyExchangePassword。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
CredentialWriteResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

ユーザー資格情報を削除します

IA-Connect エージェント セッションでユーザーのプロファイルの資格情報を削除します。 資格情報は、Windows コントロール パネルから表示できます。

パラメーター

名前 キー 必須 説明
資格情報アドレス
CredentialAddress True string

資格情報の名前/アドレス。

資格情報の種類
CredentialType True string

資格情報の種類: Windows または Generic。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
CredentialDeleteResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

ライセンス キー IA-Connect 設定する

ライセンス キーを使用して IA-Connect エージェントにライセンスを付与します。 これには、IA-Connect Orchestrator に保持されているライセンスのライセンス文字列またはフレンドリ名を指定できます。

パラメーター

名前 キー 必須 説明
ライセンス キー
LicenseString True string

IA-Connect ライセンス キー文字列、または IA-Connect Orchestrator に保持されているライセンスのフレンドリ名 (IA-Connect Orchestrator 経由で IA-Connect を制御する場合)。

レジストリに格納する
StoreInRegistry boolean

IA-Connect ライセンスをレジストリに一時的に格納する必要がありますか? これにより、エージェントが閉じられ、再起動された場合でも、IA-Connect エージェントはユーザー セッションの期間中ライセンスが付与されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
ライセンスの有効期限が切れるまでの日数
DaysUntilLicenseExpires integer

IA-Connect ライセンスの有効期限が切れるまでの残りの日数。

ライセンス コード IA-Connect 設定する

古いスタイル (7.0 および 7.1) のエージェント ドメイン ライセンスを IA-Connect エージェントにアップロードします。

パラメーター

名前 キー 必須 説明
顧客 NetBIOS ドメイン名
CustomerNETBIOSDomainName True string

IA-Connect エージェントが実行されているコンピューターの NetBIOS ドメイン名。

顧客の表示名
CustomerDisplayName True string

IA-Connect エージェントのタイトル バーに表示される顧客名。

ベンダー名
VendorName True string

IA-Connect ベンダー名。

ライセンスの有効期限
LicenseExpiryDate True string

IA-Connect ライセンスの有効期限。

アクティブ化コード
ActivationCode True string

IA-Connect ライセンスのアクティブ化コード。

レジストリに格納する
StoreInRegistry boolean

IA-Connect ライセンスをレジストリに一時的に格納する必要がありますか? これにより、エージェントが閉じられ、再起動された場合でも、IA-Connect エージェントはユーザー セッションの期間中ライセンスが付与されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

リモート セッションの切断

IA-Connect エージェントがリモート セッションで実行されている場合、このアクションはリモート セッションを切断します。 これはログオフと同じではなく、リモート セッションは切断された状態で実行されたままになります。 このアクションは、新しいセッションを開始するのではなく、後でリモート セッションに接続し、同じ状態から続行する場合に使用できます。 IA-Connect エージェントがローカルで実行されている場合、このアクションによってセッションがロックされます。

パラメーター

名前 キー 必須 説明
待機する秒数
SecondsToWait integer

IA-Connect エージェントが (リモート セッションでのみ発生する) 連絡先を失う前にコマンドの完了を報告できるように、オペレーティング システムに disconnect コマンドを発行するまでの待ち時間。

ローカル エージェントの場合は切断しない
DoNotDisconnectIfLocalAgent boolean

true に設定され、IA-Connect エージェントがローカル セッション (つまりワーカーで直接) で実行されている場合、このアクションは自動的に無視されます。 これは、ローカル エージェントを切断するとセッションがロックされ、セッションのロックが解除されるまで RPA 関数が制限されるため便利です。

Workflow
Workflow True string

workflow() に次の式を追加します。

リモート デスクトップ セッション (RDS) を起動する

RDP 起動ファイルを使用してリモート デスクトップ セッション (RDS) を起動します。

パラメーター

名前 キー 必須 説明
RDP ファイル パス
RDPFilePath True string

RDP ファイルへの完全なパス ("Create Remote Desktop Session (RDS) launch file" (リモート デスクトップ セッション (RDS) 起動ファイルの作成) アクションを使用して事前に存在するか、作成できます)。

リモート コンピューターを信頼する
TrustRemoteComputer boolean

リモート アドレス (RDP ファイルに設定) を信頼済み (Windows レジストリ内) としてマークする場合は true に設定します。主にデバイス リダイレクトの目的で、RDP ファイルの起動時に表示されるポップアップが表示されなくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
LaunchRemoteDesktopSessionResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

リモート デスクトップ セッション (RDS) 起動ファイルを作成する

リモート デスクトップ クライアント UI の自動化を必要とするのではなく、指定したパラメーターを使用してリモート デスクトップ セッションを自動的に起動するために使用できるリモート デスクトップ セッション (RDS) 起動ファイルを作成します。 RDS 起動ファイルの拡張子は '.rdp' で、RDP ファイルと呼ばれることがよくあります。

パラメーター

名前 キー 必須 説明
リモート アドレス
RemoteAddress True string

接続先のリモート システムのアドレス。 IP アドレス、ホスト名、完全修飾ドメイン名 (FQDN) を指定できます。

出力フォルダーのパス
OutputFolderPath True string

RDP ファイルを保存するフォルダー。

RDP ファイル名
RDPFileName True string

出力フォルダー パスに作成される RDP ファイルの名前。

RDP ファイルが既に存在する場合は上書きする
OverwriteRDPFileIfAlreadyExists boolean

同じフォルダー/ファイル名で RDP ファイルを自動的に上書きするには、true に設定します。 同じフォルダー/ファイル名を持つ既存の RDP ファイルが既に存在する場合は、新しい RDP ファイルを作成しない場合は false に設定します。

リモート コンピューターを信頼する
TrustRemoteComputer boolean

リモート アドレスを信頼済み (Windows レジストリ内) としてマークする場合は true に設定し、主にデバイスリダイレクトの目的で、RDP ファイルを起動するときに表示される可能性のあるポップアップを排除します。

資格情報を格納する
StoreCredentials boolean

リモート デスクトップ認証の詳細を保持するユーザー資格情報を作成するには、true に設定します。 これにより、認証を求められることなくリモート デスクトップ システムに接続できます。

UserName
UserName string

リモート デスクトップ認証の詳細を保持する資格情報を格納する場合は、資格情報に格納するユーザー名を指定できます。

パスワード
Password string

リモート デスクトップ認証の詳細を保持する資格情報を格納する場合は、資格情報に格納するパスワードを指定できます。

資格情報の種類
CredentialType string

リモート デスクトップ認証の詳細を保持する資格情報を格納する場合は、資格情報の種類 (Windows または汎用) を指定できます。 RDP 資格情報を保存する場合、通常は Windows 資格情報を作成します。

資格情報の永続化
CredentialPersistence string

リモート デスクトップ認証の詳細を保持する資格情報を格納する場合は、資格情報の永続化を指定できます。セッション (このログイン セッションの場合のみ)、LocalMachine (セッション間でこのユーザーに対して保持され、このコンピューターでのみ再起動されます)、または Enterprise (マシン間でローミングできます)。 RDP ファイルの作成時の既定値は "セッション" です。

プリンターをリダイレクトする
RedirectPrinters boolean

ローカル セッション内のプリンターをリモート デスクトップ セッションにマップする必要がありますか? この設定はリモート 側で適用される可能性があるため、有効になりません。

すべてのドライブをリダイレクトする
RedirectAllDrives boolean

ローカル セッション内のすべてのドライブ文字 (C:など) をリモート デスクトップ セッションにマップする必要がありますか? この設定はリモート 側で適用される可能性があるため、有効になりません。

クリップボードのリダイレクト
RedirectClipboard boolean

クリップボードをローカル システムとリモート システム間で共有し、2 つのシステム間でコピーと貼り付けを許可する必要がありますか? この設定はリモート 側で適用される可能性があるため、有効になりません。

全画面表示
Fullscreen boolean

リモート デスクトップ セッションが全画面表示の場合。

デスクトップの幅
DesktopWidth integer

リモート デスクトップ セッションが全画面表示でない場合の、リモート デスクトップ セッションの幅 (ピクセル単位)。

デスクトップの高さ
DesktopHeight integer

リモート デスクトップ セッションが全画面表示でない場合の、リモート デスクトップ セッションの高さ (ピクセル単位)。

マルチ モニターを使用する
UseMultiMonitor boolean

全画面表示のリモート デスクトップ セッションで 1 つのモニターのみを使用する必要がある場合は false に設定します。 全画面表示のリモート デスクトップ セッションですべてのモニターを使用する必要がある場合は true に設定します。 単一モニター システム (そのため、ほとんどの仮想マシン) には影響しません。

セッションの色の深さ
SessionBPP integer

リモート デスクトップ セッションの色の深さ (ピクセルあたりのビット数 (BPP)。 数値が大きいほど、色が多くなります。 サポートされる値は 15、16、24、32 です。

スマート サイズ設定
SmartSizing boolean

ローカル コンピューターがリモート セッションの内容をウィンドウ サイズに合わせて自動的にスケーリングするには、true に設定します。 自動的にスケーリングしない場合は false に設定します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
RDP ファイル パス
RDPFilePath string

生成された RDP ファイルの完全パス。

ログオフ リモート セッション

IA-Connect エージェントが実行されているリモート セッションをログオフします。

パラメーター

名前 キー 必須 説明
待機する秒数
SecondsToWait integer

IA-Connect エージェントがコマンドの完了を報告できるように、オペレーティング システムにログオフ コマンドを発行した後に待機する時間。

Workflow
Workflow True string

workflow() に次の式を追加します。

他のすべての IA-Connect エージェントを強制終了する

ユーザー セッションで現在実行中の IA-Connect エージェントの他のインスタンスをすべて強制終了します。 これにより、IA-Connect エージェントのインスタンスが 1 つだけ実行されるようになります。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
強制終了されたエージェントの数
NumberOfAgentsKilled integer

強制終了された IA-Connect エージェント プロセスの数。

強制終了に失敗したエージェントの数
NumberOfAgentsFailedToKill integer

強制終了できなかった IA-Connect エージェント プロセスの数。

代替 IA-Connect エージェントを実行する

ファイルの場所からエージェント実行可能ファイルを読み込んで、別の IA-Connect エージェント (新しいバージョンなど) を実行します。

パラメーター

名前 キー 必須 説明
Filename
Filename True string

実行する代替 IA-Connect Agent.exe への完全なパス。 このパスには、IA-Connect エージェントが現在実行されているセッションからアクセスできる必要があります。

論争
Arguments string

実行時に IA-Connect Agent.exe に渡す省略可能な引数。

メモリへの読み込み
LoadIntoMemory boolean

代替 IA-Connect エージェントをメモリ内で実行する必要がありますか? true に設定すると、新しいエージェントがメモリに読み込まれ、既存のエージェントのアセンブリ内で実行されます。 false に設定すると、新しいエージェントが通常のプロセスとして実行され、既存のエージェント EXE が終了します。

Workflow
Workflow True string

workflow() に次の式を追加します。

使用可能な IA-Connect セッションを取得する

IA-Connect Director セッションの一覧を取得します (ローカル、Microsoft RDP、Citrix ICA など、IA-Connect エージェントが実行されているセッションへの使用可能な接続)。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect セッション JSON
IAConnectSessionsJSON string

JSON 形式のすべての IA-Connect セッションの一覧。

IA-Connect セッションの数
NumberOfIAConnectSessions integer

開いている IA-Connect セッションの合計数。

ローカル IA-Connect セッションの数
NumberOfLocalIAConnectSessions integer

開いているローカル IA-Connect セッションの数。

Citrix ICA IA-Connect セッションの数
NumberOfCitrixICAIAConnectSessions integer

開いている Citrix ICA IA-Connect セッションの数。

Microsoft RDP IA-Connect セッションの数
NumberOfMicrosoftRDPIAConnectSessions integer

開いている Microsoft RDP IA-Connect セッションの数。

例外を発生させる

入力例外が空白でない場合は、指定されたメッセージで例外を発生させます。 これは、フロー (HTTP 400) で例外メッセージをトリガーする場合に役立ちます。これは、以前のアクションでエラーが発生した場合に、エラー処理ステージによってキャッチされます。 この例外は、IA-Connect Orchestrator フローの実行統計には記録されません。

パラメーター

名前 キー 必須 説明
入力例外
InputException string

この入力例外が空の文字列でない場合は、指定された "例外メッセージ" で例外が発生します。 この入力例外が空白の場合、このアクションは何も行いません。

例外メッセージ
ExceptionMessage string

発生させる例外メッセージ。

戻り値

名前 パス 説明
コマンドの結果
RaiseExceptionResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

保存されたパスワードを取得する

以前に生成または保存されたパスワードを取得します。

パラメーター

名前 キー 必須 説明
パスワード識別子
PasswordIdentifier string

保存されているパスワードの識別子。 これらのパスワードはメモリにのみ格納され、エージェントを閉じると失われます。 例: MyExchangePassword。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プレーンテキスト パスワード
PlainTextPassword string

プレーン テキストのパスワード。 パスワードが SMS または電子メール (たとえば) 経由で送信されることを意図したワンタイム パスワードであるため、as-is表示する必要がある場合は、プレーン テキストでパスワードが必要になる場合があります。

名前で IA-Connect セッションにアタッチする

指定した IA-Connect Director セッションに名前でアタッチします。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

パラメーター

名前 キー 必須 説明
IA-Connect セッション名
IAConnectSessionName True string

接続する IA-Connect セッションの名前。

仮想チャネルが接続されている必要があります
VirtualChannelMustBeConnected boolean

IA-Connect Director は、セッションにアタッチするときに仮想チャネルが接続されていることを検証する必要がありますか? これにより、IA-Connect エージェントが指定されたセッションで実行されるようになります。

Workflow
Workflow True string

workflow() に次の式を追加します。

名前でセッション IA-Connect 強制終了する

指定した IA-Connect Director セッションが存在する場合は強制終了します。 これは、IA-Connect エージェントにコマンドを送信するセッションです。 この名前は、以前の 'Attach' アクションから認識されます。

パラメーター

名前 キー 必須 説明
IA-Connect セッション名
IAConnectSessionName True string

強制終了する IA-Connect セッションの名前。

成功した場合に階層 1 IA-Connect セッションにアタッチする
AttachToTier1IAConnectSessionOnSuccess boolean

セッション IA-Connect 正常に終了した場合、階層 1 IA-Connect セッション (SOAP または REST メッセージを受信しているディレクターの IA-Connect Director セッション) に接続し直す必要がありますか?

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
IA-Connect セッションが強制終了されました
IAConnectSessionKilled boolean

指定した名前のセッションが強制終了された場合は true、そうでない場合は false を返します。

アタッチされた階層 1 IA-Connect セッション名
AttachedTier1IAConnectSessionName string

接続された階層 1 IA-Connect セッションの名前。

名前でプロセス数を取得する

指定したプロセス名を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスの数を返します。

パラメーター

名前 キー 必須 説明
プロセス名
ProcessName True string

プロセス名。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
プロセスの数
NumberOfProcesses integer

指定されたプロセス名と一致するプロセスの数。

四角形の座標を変換する

四角形のピクセル座標を仮想から物理または物理から仮想に変換します。 ポイントを変換する場合は、Right=Left と Bottom=Top を設定するだけです。 物理座標は、モニター上のピクセルに直接マップされます。 仮想座標は DPI スケーリングされます。 すべてのディスプレイ デバイスの基になるディスプレイ スケーリングが 100%の場合、物理座標と仮想座標の両方が同じです。

パラメーター

名前 キー 必須 説明
四角形の左端画面ピクセル X 座標
RectangleLeftPixelXCoord True integer

変換する四角形の左端のピクセル端。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の上端画面ピクセル Y 座標
RectangleTopPixelYCoord True integer

変換する四角形の上端。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の右端の画面ピクセル X 座標
RectangleRightPixelXCoord True integer

変換する四角形の右端のピクセル。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の下端の画面ピクセル Y 座標
RectangleBottomPixelYCoord True integer

変換する四角形の下のピクセルエッジ。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換の種類
ConversionType True string

変換の種類: 物理から仮想 (PhysicalToVirtual または P2V) または仮想から物理 (VirtualToPhysical または V2P)。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
変換された四角形の左端画面ピクセル X 座標
ConvertedRectangleLeftPixelXCoord integer

変換された四角形の左端のピクセル端。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換された四角形の上端画面ピクセル Y 座標
ConvertedRectangleTopPixelYCoord integer

変換された四角形の上端。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換された四角形の右端の画面ピクセル X 座標
ConvertedRectangleRightPixelXCoord integer

変換された四角形の右端のピクセルエッジ。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換された四角形の下端画面ピクセル Y 座標
ConvertedRectangleBottomPixelYCoord integer

変換された四角形の下端。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換された四角形の幅
ConvertedRectangleWidth integer

変換された四角形の幅 (ピクセル単位)。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

変換された四角形の高さ
ConvertedRectangleHeight integer

変換された四角形の高さ (ピクセル単位)。 変換の種類に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

座標でのマウスのダブルクリック

指定した座標の IA-Connect Agent ユーザー セッションでマウスの左ボタンをダブルクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

ミリ秒単位の遅延
DelayInMilliseconds integer

各クリック間の遅延 (ミリ秒単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標でのマウスの中央クリック

指定した座標の IA-Connect Agent ユーザー セッションでマウスの中央ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標でピクセルカラーを取得する

指定した座標でのピクセルの RGB 色を返します。

パラメーター

名前 キー 必須 説明
左 X ピクセル
LeftXPixels True integer

読み取るピクセルの X 位置。 1 つのディスプレイでは、左端の X ピクセルは 0 です。 マルチモニター ディスプレイでは、左端の X ピクセルが負の値になる可能性があります (どのディスプレイがプライマリとしてマークされ、他のディスプレイに対して相対的であるかによって異なります)。

上位 Y ピクセル
TopYPixels True integer

読み取るピクセルの Y 位置。 1 つのディスプレイでは、最上位の Y ピクセルは 0 です。 マルチモニター ディスプレイでは、最上位の Y ピクセルが負の値になる可能性があります (どのディスプレイがプライマリとしてマークされているか、他のディスプレイとの相対位置によって異なります)。

エージェントを非表示にする
HideAgent boolean

エージェントを自動的に非表示にして (表示されている場合)、読み取るピクセルが隠されないようにするには、true に設定します。

物理座標を使用する
UsePhysicalCoordinates boolean

指定した座標が物理的であることを指定する場合は true に設定します (DPI スケールされないため、ディスプレイ上の物理ピクセルと一致します)。 指定された座標が仮想 (DPI スケール) であることを指定するには、false (既定値) に設定します。 UIA、Java、および Web アクションでは、通常、仮想座標が使用されます。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
赤い値
RedValue integer

0 (赤なし) から 255 (完全な赤) までのピクセルの赤の値を返します。

緑の値
GreenValue integer

ピクセルの緑の値を 0 (緑なし) から 255 (緑全体) に返します。

青い値
BlueValue integer

0 (青なし) から 255 (フル ブルー) までのピクセルの青の値を返します。

アルファ値
AlphaValue integer

ピクセルのアルファ値を 0 (完全に透明) から 255 (完全に不透明) に返します。

RRGGBB 16 進値
RRGGBBHexValue string

ピクセルの RRGGBB 16 進値を返します。 たとえば、FF0000 は赤、00FF00 は緑、0000FF は青、000000 は黒、FFFFFF は完全な白です。

AARRGGBB 16 進値
AARRGGBBHexValue string

RRGGBB と同じであるが、先頭に 16 進アルファ値が含まれるピクセルの AARRGGBB 16 進値を返します。 完全に不透明なピクセル (最も一般的なピクセル) の場合、これは FFRRGGBB 値を保持します。 たとえば、FFFF0000は完全に不透明な完全な赤です。

座標でマウスを右クリックする

指定した座標にある IA-Connect Agent ユーザー セッションでマウスの右ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標でマウスを左クリックする

指定した座標にある IA-Connect Agent ユーザー セッションのマウスの左ボタンをクリックします。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。

パラメーター

名前 キー 必須 説明
X ピクセル
XCoord True integer

X 座標値 (ピクセル単位)。

Y ピクセル
YCoord True integer

Y 座標値 (ピクセル単位)。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標間でのマウスの中央ドラッグ

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの中央ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

パラメーター

名前 キー 必須 説明
X ピクセルの開始
StartXCoord True integer

開始 X 座標値 (ピクセル単位)。

開始 Y ピクセル
StartYCoord True integer

開始 Y 座標値 (ピクセル単位)。

終了 X ピクセル
EndXCoord True integer

終了 X 座標値 (ピクセル単位)。

終了 Y ピクセル
EndYCoord True integer

終了 Y 座標値 (ピクセル単位)。

ステップの数
NumberOfSteps integer

ドラッグ アクションを分割する必要があるステップの数。

合計時間 (秒)
TotalTimeInSeconds double

ドラッグ アクションが最初から最後まで実行する合計時間。

最大移動ピクセル ジッター
MaximumMovementPixelJitter integer

ドラッグ 操作の実行中の最大ピクセル ジッター。 値が 1 以上の場合、移動ジッターが有効になります。 ジッターは、動きの急増を避けるために、各ステップで平滑化されます。 この入力値は、任意の特定のポイントで可能なジッターの最大値を制御し、マウスがパスからどれだけ離れるかを制限します。 値が大きいほど、ドラッグ アクションが表示される "スムーズ" が少なくなります。 各ポイントのジッターは、-2 と 2 (既定) の間で前のジッター値からのみ逸脱できるため、最大ジッターの最大値は、最大値の設定に関係なく、2 x NumberOfSteps です。

最大エンド ピクセル ジッター
MaximumEndPixelJitter integer

ドラッグ アクションの最後の最大ピクセル ジッター。 値が大きいほど、終了座標に到達したときのドラッグの精度が低くなります。

最大移動ピクセル ジッター デルタ
MaximumMovementPixelJitterDelta integer

マウスの移動ジッター (最大移動ピクセル ジッターが 1 以上) を使用する場合、各ポイントの最大ジッターが前のポイントから逸脱する可能性があります。 これは、ジッターがスムーズであることを保証するために使用されます。 値を大きくすると、滑らかさが少なくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標間でのマウスの左ドラッグ

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの左ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

パラメーター

名前 キー 必須 説明
X ピクセルの開始
StartXCoord True integer

開始 X 座標値 (ピクセル単位)。

開始 Y ピクセル
StartYCoord True integer

開始 Y 座標値 (ピクセル単位)。

終了 X ピクセル
EndXCoord True integer

終了 X 座標値 (ピクセル単位)。

終了 Y ピクセル
EndYCoord True integer

終了 Y 座標値 (ピクセル単位)。

ステップの数
NumberOfSteps integer

ドラッグ アクションを分割する必要があるステップの数。

合計時間 (秒)
TotalTimeInSeconds double

ドラッグ アクションが最初から最後まで実行する合計時間。

最大移動ピクセル ジッター
MaximumMovementPixelJitter integer

ドラッグ 操作の実行中の最大ピクセル ジッター。 値が 1 以上の場合、移動ジッターが有効になります。 ジッターは、動きの急増を避けるために、各ステップで平滑化されます。 この入力値は、任意の特定のポイントで可能なジッターの最大値を制御し、マウスがパスからどれだけ離れるかを制限します。 値が大きいほど、ドラッグ アクションが表示される "スムーズ" が少なくなります。 各ポイントのジッターは、-2 と 2 (既定) の間で前のジッター値からのみ逸脱できるため、最大ジッターの最大値は、最大値の設定に関係なく、2 x NumberOfSteps です。

最大エンド ピクセル ジッター
MaximumEndPixelJitter integer

ドラッグ アクションの最後の最大ピクセル ジッター。 値が大きいほど、終了座標に到達したときのドラッグの精度が低くなります。

最大移動ピクセル ジッター デルタ
MaximumMovementPixelJitterDelta integer

マウスの移動ジッター (最大移動ピクセル ジッターが 1 以上) を使用する場合、各ポイントの最大ジッターが前のポイントから逸脱する可能性があります。 これは、ジッターがスムーズであることを保証するために使用されます。 値を大きくすると、滑らかさが少なくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標間でマウスを右にドラッグする

IA-Connect エージェント ユーザー セッションで、指定した 2 つの座標間でマウスの右ボタンドラッグを実行します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

パラメーター

名前 キー 必須 説明
X ピクセルの開始
StartXCoord True integer

開始 X 座標値 (ピクセル単位)。

開始 Y ピクセル
StartYCoord True integer

開始 Y 座標値 (ピクセル単位)。

終了 X ピクセル
EndXCoord True integer

終了 X 座標値 (ピクセル単位)。

終了 Y ピクセル
EndYCoord True integer

終了 Y 座標値 (ピクセル単位)。

ステップの数
NumberOfSteps integer

ドラッグ アクションを分割する必要があるステップの数。

合計時間 (秒)
TotalTimeInSeconds double

ドラッグ アクションが最初から最後まで実行する合計時間。

最大移動ピクセル ジッター
MaximumMovementPixelJitter integer

ドラッグ 操作の実行中の最大ピクセル ジッター。 値が 1 以上の場合、移動ジッターが有効になります。 ジッターは、動きの急増を避けるために、各ステップで平滑化されます。 この入力値は、任意の特定のポイントで可能なジッターの最大値を制御し、マウスがパスからどれだけ離れるかを制限します。 値が大きいほど、ドラッグ アクションが表示される "スムーズ" が少なくなります。 各ポイントのジッターは、-2 と 2 (既定) の間で前のジッター値からのみ逸脱できるため、最大ジッターの最大値は、最大値の設定に関係なく、2 x NumberOfSteps です。

最大エンド ピクセル ジッター
MaximumEndPixelJitter integer

ドラッグ アクションの最後の最大ピクセル ジッター。 値が大きいほど、終了座標に到達したときのドラッグの精度が低くなります。

最大移動ピクセル ジッター デルタ
MaximumMovementPixelJitterDelta integer

マウスの移動ジッター (最大移動ピクセル ジッターが 1 以上) を使用する場合、各ポイントの最大ジッターが前のポイントから逸脱する可能性があります。 これは、ジッターがスムーズであることを保証するために使用されます。 値を大きくすると、滑らかさが少なくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

座標間でマウスを移動する

IA-Connect Agent ユーザー セッションで、指定した 2 つの座標間でマウスを移動します。 現在アクティブなマウス移動 API (mouse_eventまたは setcursorpos) を使用してマウスを移動します。 座標を計算するときに、DPI スケーリングと複数のディスプレイが考慮されます。 マウスの動きではオプションのジッターがサポートされ、人間の手の動きのようにすることができます。

パラメーター

名前 キー 必須 説明
X ピクセルの開始
StartXCoord True integer

開始 X 座標値 (ピクセル単位)。

開始 Y ピクセル
StartYCoord True integer

開始 Y 座標値 (ピクセル単位)。

終了 X ピクセル
EndXCoord True integer

終了 X 座標値 (ピクセル単位)。

終了 Y ピクセル
EndYCoord True integer

終了 Y 座標値 (ピクセル単位)。

ステップの数
NumberOfSteps integer

移動アクションを分割する必要があるステップの数。

合計時間 (秒)
TotalTimeInSeconds double

移動アクションが最初から最後まで実行する必要がある合計時間。

最大移動ピクセル ジッター
MaximumMovementPixelJitter integer

ドラッグ 操作の実行中の最大ピクセル ジッター。 値が 1 以上の場合、移動ジッターが有効になります。 ジッターは、動きの急増を避けるために、各ステップで平滑化されます。 この入力値は、任意の特定のポイントで可能なジッターの最大値を制御し、マウスがパスからどれだけ離れるかを制限します。 値が大きいほど、ドラッグ アクションが表示される "スムーズ" が少なくなります。 各ポイントのジッターは、-2 と 2 (既定) の間で前のジッター値からのみ逸脱できるため、最大ジッターの最大値は、最大値の設定に関係なく、2 x NumberOfSteps です。

最大エンド ピクセル ジッター
MaximumEndPixelJitter integer

ドラッグ アクションの最後の最大ピクセル ジッター。 値が大きいほど、終了座標に到達したときのドラッグの精度が低くなります。

最大移動ピクセル ジッター デルタ
MaximumMovementPixelJitterDelta integer

マウスの移動ジッター (最大移動ピクセル ジッターが 1 以上) を使用する場合、各ポイントの最大ジッターが前のポイントから逸脱する可能性があります。 これは、ジッターがスムーズであることを保証するために使用されます。 値を大きくすると、滑らかさが少なくなります。

Workflow
Workflow True string

workflow() に次の式を追加します。

強制終了プロセス

指定したプロセス名を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスをすべて強制終了します。

パラメーター

名前 キー 必須 説明
プロセス名
ProcessName True string

強制終了するプロセス。 メモ帳など。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
強制終了されたプロセスの数
NumberOfProcessesKilled integer

強制終了されたプロセスの数。

強制終了プロセス ID

指定したプロセス ID を持つ IA-Connect エージェント ユーザー セッションで実行中のプロセスを強制終了します。プロセス ID は一意であるため、1 つのプロセスのみが ID と一致します。プロセス ID は動的であり、アプリケーションを起動するたびに異なります。

パラメーター

名前 キー 必須 説明
プロセス ID
ProcessID True integer

強制終了するプロセスのプロセス ID。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
強制終了されたプロセスの数
NumberOfProcessesKilled integer

強制終了されたプロセスの数。

新しい Orchestrator 自動化タスクを追加する

フローから監視できるキューに新しい Orchestrator 自動化タスクを追加します。 タスクは、すぐに実行できる状態にすることも、後で実行できるように延期することもできます。

パラメーター

名前 キー 必須 説明
オートメーション名を設定する
SetAutomationName string

フロー名をタスク名として使用する場合は [自動] を選択し、[手動] を選択し、[Automation 名] フィールドに名前を入力してその名前を使用します。

Automation 名
AutomationName string

これは、[オートメーション名の設定] フィールドで [手動] が選択されている場合にのみ使用されます。 後でタスクを識別したり、特定のフローに関連付けたりするために役立つフレンドリ名。 複数のタスクで同じオートメーション名を使用できます。 タスクが外部ポーラーまたはオーケストレーター トリガーによって処理されている場合は、特定のタスク名が必要です。

タスク入力データ
TaskInputData string

タスクの開始時に使用できるようにする省略可能なデータ。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

自動化プロセス/フローが開始するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、次に実行するステップを決定するために、プロセス/フロー内の条件によって使用されます。 たとえば、プロセス/フローを "Exchange" ステージで開始する場合は、値 「Exchange」を入力します。

Priority
Priority integer

この自動化タスクの優先度レベルを設定します (1 は最高レベル)。

分単位の SLA
SLA integer

SLA に必要な分数を設定します。 SLA がない場合は、これを 0 に設定します。 既定では、SLA の最後に近い自動化タスクは、他のタスクよりも優先されます。

タスクを保留にする
TaskOnHold boolean

タスクの [保留中] 状態を指定します。 [保留中] に設定されたタスクは、[Get next Orchestrator automation task]\(次のオーケストレーター自動化タスクの取得\) アクションでは取得されないため、一般的なタスク ワークフローでは処理されません。

機構
Organisation string

必要に応じて、このタスクが関連付けられている組織を指定します。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

必要に応じて、このタスクが関連付けられている部門を指定します。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

必要に応じて、このタスクの説明を指定します。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てる 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
タスク ID
TaskId integer

作成された Orchestrator オートメーション タスクの ID。 このタスク ID は、後日タスクを取得するために使用できます。

新しい Orchestrator 自動化タスク操作を追加する

新しい Orchestrator 自動化タスクを追加し、操作 ID を受け取ります。タスクが外部ポーラーまたはオーケストレーター トリガーによって処理されている場合は、特定のタスク名が必要です。 このアクションは、推測可能なタスク ID ではなく、否定できない操作 ID で応答するという点で、"新しいオーケストレーター自動化タスクの追加" (TasksAddNewTaskOperation) とは異なります。

パラメーター

名前 キー 必須 説明
Automation 名
AutomationName string

後でタスクを識別したり、特定のフローに関連付けたりするために役立つフレンドリ名。 複数のタスクで同じオートメーション名を使用できます。

タスク入力データ
TaskInputData string

タスクの開始時に使用できるようにする省略可能なデータ。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

自動化プロセス/フローが開始するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、次に実行するステップを決定するために、プロセス/フロー内の条件によって使用されます。 たとえば、プロセス/フローを "Exchange" ステージで開始する場合は、値 「Exchange」を入力します。

Priority
Priority integer

この自動化タスクの優先度レベルを設定します (1 は最高レベル)。

分単位の SLA
SLA integer

SLA に必要な分数を設定します。 SLA がない場合は、これを 0 に設定します。 既定では、SLA の最後に近い自動化タスクは、他のタスクよりも優先されます。

機構
Organisation string

必要に応じて、このタスクが関連付けられている組織を指定します。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

必要に応じて、このタスクが関連付けられている部門を指定します。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

必要に応じて、このタスクの説明を指定します。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てる 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

戻り値

名前 パス 説明
操作 ID
OperationId string

作成された Orchestrator オートメーション タスクの操作 ID。 この操作 ID は、後でタスクを取得するために使用できます。 操作 ID は一意の、重複しない文字列であり、サード パーティが作成しなかった操作の ID を推測する機能を制限します。

新しい Orchestrator 遅延タスクを追加する

フローから監視できるキューに新しい Orchestrator 遅延タスクを追加します。 タスクは、今後指定した時間に延期されます。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

パラメーター

名前 キー 必須 説明
オートメーション名を設定する
SetAutomationName string

フロー名をタスク名として使用する場合は [自動] を選択し、[手動] を選択し、[Automation 名] フィールドに名前を入力してその名前を使用します。

Automation 名
AutomationName string

これは、[オートメーション名の設定] フィールドで [手動] が選択されている場合にのみ使用されます。 後でタスクを識別したり、特定のフローに関連付けたりするために役立つフレンドリ名。 複数のタスクで同じオートメーション名を使用できます。

遅延時間 (分)
DeferralTimeInMinutes integer

自動化タスクを遅延させる必要がある時間 (分)。

タスク入力データ
TaskInputData string

タスクの開始時に使用できるようにする省略可能なデータ。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

保存されたデータの遅延
DeferralStoredData string

このタスクで格納する省略可能なデータ。 遅延から続行すると、プロセス/フローで使用できるようになります。 これは一般に、プロセス/フロー中に計算したデータを格納するために使用されます。このデータは、遅延後に再び使用可能になる必要があります。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

遅延後に自動化プロセス/フローを続行するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。 たとえば、遅延後に "Exchange" ステージでプロセス/フローを続行する場合は、値 「Exchange」を入力します。

Priority
Priority integer

このタスクの優先度レベルを設定します (1 は最高レベル)。

タスクを保留にする
TaskOnHold boolean

タスクの [保留中] 状態を指定します。 [保留中] に設定されたタスクは、[Get next Orchestrator automation task]\(次のオーケストレーター自動化タスクの取得\) アクションでは取得されないため、一般的なタスク ワークフローでは処理されません。

機構
Organisation string

必要に応じて、このタスクが関連付けられている組織を指定します。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

必要に応じて、このタスクが関連付けられている部門を指定します。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

必要に応じて、このタスクの説明を指定します。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てる 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
タスク ID
TaskId integer

作成された遅延タスクの ID。

新しい Orchestrator 遅延タスク操作を追加する

新しい Orchestrator 遅延タスクを追加し、操作 ID を受け取ります。タスクは、今後指定した時間に延期されます。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。 タスクが外部ポーラーまたはオーケストレーター トリガーによって処理されている場合は、特定のタスク名が必要です。 このアクションは、推測可能なタスク ID ではなく、繰り返し不可能な操作 ID で応答するという点で、"新しいオーケストレーター遅延タスクの追加" (TasksAddNewDeferral) とは異なります。

パラメーター

名前 キー 必須 説明
Automation 名
AutomationName string

後でタスクを識別したり、特定のフローに関連付けたりするために役立つフレンドリ名。 複数のタスクで同じオートメーション名を使用できます。

遅延時間 (分)
DeferralTimeInMinutes integer

自動化タスクを遅延させる必要がある時間 (分)。

タスク入力データ
TaskInputData string

タスクの開始時に使用できるようにする省略可能なデータ。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

保存されたデータの遅延
DeferralStoredData string

このタスクで格納する省略可能なデータ。 遅延から続行すると、プロセス/フローで使用できるようになります。 これは一般に、プロセス/フロー中に計算したデータを格納するために使用されます。このデータは、遅延後に再び使用可能になる必要があります。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

自動化プロセス/フローが開始するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、次に実行するステップを決定するために、プロセス/フロー内の条件によって使用されます。 たとえば、プロセス/フローを "Exchange" ステージで開始する場合は、値 「Exchange」を入力します。

Priority
Priority integer

この自動化タスクの優先度レベルを設定します (1 は最高レベル)。

機構
Organisation string

必要に応じて、このタスクが関連付けられている組織を指定します。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

必要に応じて、このタスクが関連付けられている部門を指定します。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

必要に応じて、このタスクの説明を指定します。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てる 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

戻り値

名前 パス 説明
操作 ID
OperationId string

作成された Orchestrator 遅延タスクの操作 ID。 この操作 ID は、後でタスクを取得するために使用できます。 操作 ID は一意の、重複しない文字列であり、サード パーティが作成しなかった操作の ID を推測する機能を制限します。

既存の Orchestrator 自動化タスクを延期する

キューに既に存在する既存の Orchestrator タスクを延期します。 タスクは、今後指定した時間に延期されます。 これは一般的に、既存のタスクを再延期するために使用されます (つまり、タスクは以前に延期されており、ここでもう一度延期する必要があります)。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

パラメーター

名前 キー 必須 説明
タスク ID
TaskId True integer

延期する (または再び延期する) 既存の Orchestrator 自動化タスクの ID。

遅延時間 (分)
DeferralTimeInMinutes integer

自動化タスクを遅延させる必要がある時間 (分)。

保存されたデータの遅延
DeferralStoredData string

このタスクで格納する省略可能なデータ。 遅延から続行すると、プロセス/フローで使用できるようになります。 これは一般に、プロセス/フロー中に計算したデータを格納するために使用されます。このデータは、遅延後に再び使用可能になる必要があります。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

遅延後に自動化プロセス/フローを続行するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。 たとえば、遅延後に "Exchange" ステージでプロセス/フローを続行する場合は、値 「Exchange」を入力します。

Priority
Priority integer

このタスクの優先度レベルを設定します (1 は最高レベル)。

タスクを保留にする
TaskOnHold boolean

この値を true に設定すると、タスクは保留になり、遅延日に達した場合でも、一般的なタスク ワークフローでは処理されません。 "保留中" の状態は、後で "Orchestrator 自動化タスクの状態の変更" アクションを使用して変更できます。

戻り値

名前 パス 説明
コマンドの結果
TasksDeferExistingTaskResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

既存の Orchestrator 自動化タスク操作を延期する

キューに既に存在する既存の Orchestrator タスクを延期します。 タスクは、今後指定した時間に延期されます。 これは一般的に、既存のタスクを再延期するために使用されます (つまり、タスクは以前に延期されており、ここでもう一度延期する必要があります)。 このアクションを使用して、タスクを一時的に一時的に一時停止します (たとえば、何かを待っている場合など)。

パラメーター

名前 キー 必須 説明
操作 ID
OperationId True string

延期する (または再び延期する) オーケストレーター タスクの操作 ID。

遅延時間 (分)
DeferralTimeInMinutes integer

自動化タスクを遅延させる必要がある時間 (分)。

保存されたデータの遅延
DeferralStoredData string

このタスクで格納する省略可能なデータ。 遅延から続行すると、プロセス/フローで使用できるようになります。 これは一般に、プロセス/フロー中に計算したデータを格納するために使用されます。このデータは、遅延後に再び使用可能になる必要があります。 任意の形式でデータを自由に格納できますが、JSON は一般的に使用される形式です。

プロセス ステージ
ProcessStage string

遅延後に自動化プロセス/フローを続行するポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。 たとえば、遅延後に "Exchange" ステージでプロセス/フローを続行する場合は、値 「Exchange」を入力します。

Priority
Priority integer

このタスクの優先度レベルを設定します (1 は最高レベル)。

戻り値

名前 パス 説明
コマンドの結果
TasksDeferExistingTaskOperationResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

既定のプリンターを取得する

IA-Connect エージェント セッションのユーザーの既定のプリンターの名前を取得します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
既定のプリンター名
DefaultPrinterName string

ユーザーの既定のプリンターの名前。

既定のプリンターを設定する

IA-Connect エージェント セッションのユーザーの既定のプリンターを設定します。

パラメーター

名前 キー 必須 説明
既定のプリンター名
DefaultPrinterName True string

ユーザーの既定のプリンターの名前。

Workflow
Workflow True string

workflow() に次の式を追加します。

最後の入力情報を取得する

IA-Connect エージェント ユーザー セッションで最後のユーザー入力が受信されてからの時間を取得します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
最後の入力合計秒数
LastInputTotalSeconds integer

最後の入力から経過した秒数。

最後の入力合計時間 (分)
LastInputTotalMinutes integer

最後の入力から経過した分数。

最後の入力合計時間
LastInputTotalHours integer

最後の入力から経過した時間数。

最新の IA-Connect セッションにアタッチする

最近接続した IA-Connect Director セッションにアタッチします (必要に応じて、指定した種類)。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

パラメーター

名前 キー 必須 説明
セッションの種類 IA-Connect 検索
SearchIAConnectSessionType string

検索するセッションの種類 ("ローカル エージェント"、"Microsoft RDP"、"Citrix ICA"、"リモート" など)。 任意のセッションの種類を検索するには、空白のままにします。

秒単位で待機する時間
TimeToWaitInSeconds integer

指定した型のセッションがない場合 (特定の型が指定された場合)、待機 IA-Connect 時間はどのくらい必要ですか?

タイムアウトした場合に例外を発生させる
RaiseExceptionIfTimedout boolean

タイムアウト期間が経過する前に新しいセッションが接続されていない場合は、IA-Connect 例外を発生させる必要がありますか?

仮想チャネルが接続されている必要があります
VirtualChannelMustBeConnected boolean

IA-Connect Director は、セッションにアタッチするときに仮想チャネルが接続されていることを検証する必要がありますか? これにより、IA-Connect エージェントが指定されたセッションで実行されるようになります。

前に表示されていないセッションのみをカウントする
OnlyCountSessionsNotSeenBefore boolean

true に設定すると、以前に実行した "使用可能な IA-Connect セッションの取得" アクション (または IA-Connect Inspector の表示セッション) によって表示されたセッションはインデックスにカウントされません。 これにより、"新しい" セッションのみをカウントできます (たとえば、最初の新しい Citrix セッションにアタッチする)。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アタッチされた IA-Connect セッション名
AttachedIAConnectSessionName string

アタッチされた IA-Connect セッションの名前。

セッションにアタッチ済み
AttachedToSession boolean

IA-Connect がセッションにアタッチされている場合は true、アタッチされていない場合は false を返します。

次の Orchestrator 自動化タスクを取得する

指定された検索条件に一致する次の Orchestrator 自動化タスクを取得します。 取得できるのは、(延期日に達した) 'New' タスクと 'Deferred' タスクだけです。 保留タスクは取得されません。

パラメーター

名前 キー 必須 説明
Automation 名
AutomationName string

任意の名前の Orchestrator オートメーション タスクを返すには、空白のままにします。 このオートメーション名を持つタスクのみを取得する値を入力します。

オートメーション名
AutomationNames array of string

2 つ以上のオートメーション名のいずれかに一致する Orchestrator タスクを返す必要がある場合は、"Automation 名" 入力に入力するのではなく、この一覧に名前を入力します。

最小優先度レベル
MinimumPriorityLevel integer

指定された優先度レベル以上の Orchestrator オートメーション タスクのみを返します。 たとえば、2 を設定すると、優先度レベルが 1 と 2 のタスクが返されます。

状態を次に変更する
StatusChange string

[取得済み] に設定されている場合: タスクを取得すると、タスクの状態が [取得済み] に変わり、他のアクションが同じタスクを実行できなくなります。 [Do nothing]\(何もしない\) に設定すると、タスクの状態は変更されません。

延期日までの分数
MinutesUntilDeferralDate integer

指定した数分以内に実行する準備ができている Orchestrator 自動化タスクのみを返します。 今すぐ実行できる自動化タスクのみが必要な場合は、0 に設定します。

SLA を無視する
IgnoreSLA boolean

タスクに設定されている SLA を無視する場合は、これを true に設定します。 既定では、すぐに違反する SLA を持つタスクは、他のすべてのタスクよりも優先されます。

タスク ID を除外する
ExcludeTaskIds array of integer

処理から排除するタスク ID の一覧。

戻り値

名前 パス 説明
取得されたタスク
TaskRetrieved boolean

タスクが取得された場合は true に設定されます。 検索条件に一致するタスクがない場合は false に設定します。

タスク ID
TaskId integer

取得した Orchestrator オートメーション タスクの ID。

操作 ID
OperationId string

取得したオーケストレーター タスクの操作 ID。 この操作 ID (またはタスク ID) を使用して、後でタスクを取得できます。 操作 ID は一意の、重複しない文字列であり、サード パーティが作成しなかった操作の ID を推測する機能を制限します。

Automation 名
AutomationNameOutput string

取得したオートメーション タスクの名前。

延期日時
DeferralDateTime string

取得したオーケストレーター タスクの準備がスケジュールされている日時。 これは UTC で文字列として返されます。

保存されたデータの遅延
DeferralStoredData string

タスクが延期されたときに格納された省略可能なデータ。 これは通常、プロセス/フローを続行するために必要なデータですが、このフィールドは任意の目的で使用できます。

遅延数
DeferralCount integer

このタスクが延期された頻度。 これは通常、延期されなかった新しいタスクの場合は 0、遅延タスクの場合は 1 以上になります。 遅延タスクが再び延期されるたびに、Orchestrator はこの数を自動的に増やします。

タスク入力データ
TaskInputData string

タスクの作成時に格納された省略可能なデータ。 これは通常、プロセス/フローを開始するために使用されたデータですが、このフィールドは任意の目的で使用できます。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

タスク出力データ
TaskOutputData string

タスクの処理時にオートメーションによって格納された省略可能なデータ。 これは、任意のテキスト形式 (JSON、XML、生テキストなど) として書式設定できます。

Priority
Priority integer

このオーケストレーター タスクの優先度レベル (1 は最高レベル)。

Automation タスクの状態
AutomationTaskStatus string

取得した Orchestrator タスクの状態。

プロセス ステージ
ProcessStage string

遅延プロセス/フローが遅延後に続行されるポイント。 これは、特定のプロセス/フローに固有の省略可能な文字列値です。 これは、遅延プロセス/フロー内の条件によって使用され、次に実行するステップを決定します。

受信日時
ReceivedDateTime string

オーケストレーターによってタスクが最初に受信された日時。 これは UTC で文字列として返されます。

延期日までの分数
MinutesUntilDeferralDateOutput integer

このタスクの延期日 (つまり、このタスクを実行する準備ができたら) までの分数。 このタスクを実行する準備ができた場合、分数は 0 になります。

ソースの種類名
SourceTypeName string

タスクのソースの名前。 'Web UI' は、UI を介して手動で入力されたタスクを表します。 "REST API" は、Orchestrator の REST API を使用して作成されたタスクを表します。 'ServiceNow' は、Orchestrator の内部 'Sources' ServiceNow 統合から作成されたタスクを表します。

ソースフレンドリ名
SourceFriendlyName string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、そのソースのフレンドリ名が保持されます。

ソース チケット ID
SourceTicketId string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、これはソース チケットの ID を保持します。 ServiceNow の場合、これはカタログ タスク sys_idを保持します。

ソース チケットサブ ID
SourceTicketSubId string

タスクが Orchestrator の内部 'Sources' 統合 (ServiceNow など) から作成された場合、これはソース チケットの ID を保持します。 ServiceNow の場合、これは要求項目のsys_idを保持します。

機構
Organisation string

このタスクが関連付けられている組織。 通常、タスクの検索とフィルター処理に使用されます。

部署
Department string

このタスクが関連付けられている部署。 通常、タスクの検索とフィルター処理に使用されます。

Description
Description string

このタスクの説明。 通常、タスクの検索とフィルター処理に使用されます。

タグ
Tags string

このタスクに割り当てられている 1 つ以上のタグの省略可能なリスト。 通常、検索とフィルター処理のタスクを分類するために使用されます。 大文字と小文字は区別されません。 1 行につき 1 つ。

次ホップ IA-Connect Director を構成する

ダブルホップ シナリオで次ホップ ディレクターを構成します。 これは、既定の IA-Connect 次ホップ ディレクター設定が適していない場合にのみ必要です。

パラメーター

名前 キー 必須 説明
SOAP 対応
SOAPEnabled boolean

次ホップ ディレクターで SOAP インターフェイスを有効にする必要がありますか?

REST が有効
RESTEnabled boolean

次ホップ ディレクターで REST インターフェイスを有効にする必要がありますか?

Web サーバーが有効になっている
WebServerEnabled boolean

次ホップ ディレクターで Web サーバー (IA-Connect Inspector をホストする場合) を有効にする必要がありますか。

ディレクターは localhost のみ
DirectorIsLocalhostOnly boolean

ディレクター SOAP および REST インターフェイスは 'localhost' でのみリッスンする必要がありますか? 他のコンピューターがこれらのインターフェイスと通信する必要がないため、これは true に設定する必要があります。

SOAP TCP ポート
SOAPTCPPort integer

SOAP インターフェイスが有効になっている場合、どの TCP ポートで実行する必要がありますか (既定値は 8002)。

REST TCP ポート
RESTTCPPort integer

REST インターフェイスが有効になっている場合、どの TCP ポートで実行する必要がありますか (既定値は 8002)。

SOAP は HTTPS を使用します
SOAPUsesHTTPS boolean

SOAP インターフェイスは HTTPS (HTTP ではなく) を使用していますか? True に設定すると、HTTPS を容易にするために、最初のホップ コンピューターで証明書が必要になります。 これは、REST に使用される証明書と共有できます。

REST では HTTPS が使用されます
RESTUsesHTTPS boolean

REST インターフェイスは HTTPS (HTTP ではなく) を使用していますか? True に設定すると、HTTPS を容易にするために、最初のホップ コンピューターで証明書が必要になります。 これは、SOAP に使用される証明書と共有できます。

SessionId によるディレクター TCP ポートの増分
IncrementDirectorTCPPortBySessionId boolean

ディレクター TCP ポートが一意であることを確認するために (同じ最初のホップ ホストからのダブルホップを使用する複数の並列セッションがある場合)、最初のホップ セッション ID をディレクター TCP ポートに追加できます。 これは、最初のホップ ディレクターで SOAP または REST が有効になっていて、名前付きパイプが既定で使用されるため、通常は有効になっていない場合にのみ必要です。

SOAP でユーザー認証を使用する
SOAPUsesUserAuthentication boolean

HTTP SOAP TCP ポートでユーザー認証を使用する場合は、True に設定します。 これを設定する方法については、IA-Connect インストール ガイドを参照してください。

REST でユーザー認証を使用する
RESTUsesUserAuthentication boolean

HTTP REST TCP ポートでユーザー認証を使用する場合は、True に設定します。 これを設定する方法については、IA-Connect インストール ガイドを参照してください。

コマンド名付きパイプが有効
CommandNamedPipeEnabled boolean

ファーストホップ エージェントは、名前付きパイプを使用してファーストホップ ディレクターと通信する必要がありますか? これが既定の通信方法です。

Workflow
Workflow True string

workflow() に次の式を追加します。

次ホップ IA-Connect ディレクターの設定をリセットする

設定されているカスタム IA-Connect Director の設定をリセットし、既定の設定を復元します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

次ホップ IA-Connect 有効にする

次ホップ セッションで実行されている IA-Connect エージェントに受信したすべてのコマンドを転送する次ホップを有効にします。

パラメーター

名前 キー 必須 説明
次ホップ・ディレクター・アドレス
NextHopDirectorAddress string

"Next hop Director address is localhost"、"Next hop Director address is hostname"、"Next hop Director address is FQDN"、または "Next hop Director address is named pipe" パラメーターが true に設定されていない場合にコマンドを転送する次ホップ IA-Connect Director の省略可能なアドレス。

次ホップ ディレクター TCP ポート
NextHopDirectorTCPPort integer

次ホップ ディレクターがリッスンしている TCP ポート (エージェントが実行されているコンピューター上のディレクター)。

次ホップ ディレクターが HTTPS を使用する
NextHopDirectorUsesHTTPS boolean

次ホップ ディレクターが HTTPS を使用している場合は True、使用しない場合は false に設定します。

次ホップ ディレクター アドレスは localhost です
NextHopDirectorAddressIsLocalhostname boolean

次ホップ ディレクター アドレス (エージェントに対する相対アドレス) は "localhost" です。

次ホップ ディレクター アドレスはホスト名です
NextHopDirectorAddressIsHostname boolean

次ホップ ディレクター アドレスは、エージェントを実行しているコンピューター (つまり、エージェントとディレクターを実行しているコンピューター) のホスト名です。

次ホップ ディレクター アドレスは FQDN です
NextHopDirectorAddressIsFQDN boolean

次ホップ ディレクター アドレスは、エージェントを実行しているコンピューターの完全修飾ドメイン名 (FQDN) です (つまり、エージェントとディレクターを実行しているコンピューター)。

セッション ID で次ホップ ディレクター TCP ポートをインクリメントする
IncrementNextHopDirectorTCPPortBySessionId boolean

次ホップ ディレクター TCP ポートが一意であることを確認するには (同じホストからの次ホップを使用する並列セッションが複数ある場合)、セッション ID を次ホップ ディレクター TCP ポートに追加できます。

有効にする前に無効にする
DisableBeforeEnable boolean

再度有効にする前に、ダブルホップを無効にする必要がありますか (現在アクティブな場合) true (既定値) に設定すると、新しいダブルホップ有効化命令によって前の二重ホップの有効化命令が置き換えられます。 false に設定すると、ダブルホップ IA-Connect エージェントによって命令が受信されるため、トリプルホップが有効になります。

次ホップ ディレクターが実行されていることを確認する
CheckNextHopDirectorIsRunning boolean

次ホップには、エージェントと同じコンピューターで実行中の IA-Connect Director が必要です。 この設定が true の場合、エージェントは説明に従って次ホップ ディレクターが実行されていることを確認し、次ホップ ディレクターが実行されていない場合は次ホップを有効にできません。 この設定が false の場合、エージェントはチェックを実行せず、単に次ホップを有効にします。

次ホップ エージェントが実行されていることを確認する
CheckNextHopAgentIsRunning boolean

次ホップでは、エージェントと同じコンピューターで実行中の IA-Connect Director と、次ホップ セッションで実行中の IA-Connect エージェントが必要です。 この設定が true の場合、エージェントは次ホップ エージェントが実行されていることを確認し、次ホップ エージェントが実行されていない場合は次ホップの有効化に失敗します。 この設定が false の場合、エージェントはチェックを実行せず、単に次ホップを有効にします。

次ホップ ディレクター アドレスが名前付きパイプである
NextHopDirectorAddressIsNamedPipe boolean

次ホップ ディレクター アドレス (エージェントに対する相対アドレス) は、TCP/IP Web サービスの代わりに名前付きパイプを使用しています。 これは、最初のホップで TCP/IP ポートを使用しないようにするための既定値です。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アクティブな次ホップ ディレクターのアドレス
ActiveNextHopDirectorAddress string

アクティブな次ホップ ディレクターのアドレス (使用されている場合)。

アクティブな次ホップ ディレクター TCP ポート
ActiveNextHopDirectorTCPPort integer

アクティブな次ホップ ディレクターの TCP ポート (使用されている場合)。

アクティブな次ホップ ディレクターが HTTPS を使用する
ActiveNextHopDirectorUsesHTTPS boolean

アクティブな次ホップ ディレクターが HTTPS を使用している場合は true を返します。

アクティブな次ホップ ディレクターの URL
ActiveNextHopDirectorURL string

アクティブな次ホップ ディレクターの URL。

次ホップ IA-Connect 無効にする

(次ホップ エージェントに転送されるのではなく) それを受け取るエージェントによって今後のすべてのコマンドが処理されるように、次ホップを無効にします。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

次ホップ IA-Connect 状態を取得する

このコマンドを受信するエージェントの次ホップ ディレクターの状態を報告します。 次ホップが有効になっている場合、そのエージェントはコマンドを次ホップ (次ホップ ディレクター経由) に転送します。 次ホップが無効になっている場合、そのエージェントはコマンド自体を処理します (既定)。

パラメーター

名前 キー 必須 説明
次ホップ ディレクターが実行されていることを確認する
CheckNextHopDirectorIsRunning boolean

次ホップには、エージェントと同じコンピューターで実行中の IA-Connect Director が必要です。 この設定が true の場合、エージェントは次ホップ ディレクターが実行されていることを確認します。 この設定が false の場合、エージェントはチェックを実行せず、単に次ホップの状態を確認します。

次ホップ エージェントが実行されていることを確認する
CheckNextHopAgentIsRunning boolean

次ホップでは、エージェントと同じコンピューターで実行中の IA-Connect Director と、次ホップ セッションで実行中の IA-Connect エージェントが必要です。 この設定が true の場合、エージェントは次ホップ エージェントが実行されていることを確認します。 この設定が false の場合、エージェントはチェックを実行せず、単に次ホップの状態を確認します。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
次ホップが有効
NextHopEnabled boolean

次ホップが現在有効になっている場合は true を返します。

アクティブな次ホップ ディレクターのアドレス
ActiveNextHopDirectorAddress string

アクティブな次ホップ ディレクターのアドレス (使用されている場合)。

アクティブな次ホップ ディレクター TCP ポート
ActiveNextHopDirectorTCPPort integer

アクティブな次ホップ ディレクターの TCP ポート (使用されている場合)。

アクティブな次ホップ ディレクターが HTTPS を使用する
ActiveNextHopDirectorUsesHTTPS boolean

アクティブな次ホップ ディレクターが HTTPS を使用している場合は true を返します。

アクティブな次ホップ ディレクターが実行されている
ActiveNextHopDirectorIsRunning boolean

アクティブな次ホップ ディレクターが実行されている場合は true、実行されていない場合は false を返します。

アクティブな次ホップ ディレクターの URL
ActiveNextHopDirectorURL string

アクティブな次ホップ ディレクターの URL。

アクティブな次ホップ エージェントが実行されている
ActiveNextHopAgentIsRunning boolean

アクティブな次ホップ エージェントが実行されている場合は true、実行されていない場合は false を返します。

次ホップ セッション IA-Connect 接続するまで待ちます

次ホップ セッションが接続し、IA-Connect エージェントが次ホップ セッションで実行されるまで待機します。

パラメーター

名前 キー 必須 説明
次ホップ・ディレクター・アドレス
NextHopDirectorAddress string

"Next hop Director address is localhost"、"Next hop Director address is hostname"、"Next hop Director address is FQDN"、または "Next hop Director address is named pipe" パラメーターが true に設定されていない場合にコマンドを転送する次ホップ IA-Connect Director の省略可能なアドレス。

次ホップ ディレクター TCP ポート
NextHopDirectorTCPPort integer

次ホップ ディレクターがリッスンしている TCP ポート (エージェントが実行されているコンピューター上のディレクター)。

次ホップ ディレクターが HTTPS を使用する
NextHopDirectorUsesHTTPS boolean

次ホップ ディレクターが HTTPS を使用している場合は True、使用しない場合は false に設定します。

次ホップ ディレクター アドレスは localhost です
NextHopDirectorAddressIsLocalhostname boolean

次ホップ ディレクター アドレス (エージェントに対する相対アドレス) は "localhost" です。

次ホップ ディレクター アドレスはホスト名です
NextHopDirectorAddressIsHostname boolean

次ホップ ディレクター アドレスは、エージェントを実行しているコンピューター (つまり、エージェントとディレクターを実行しているコンピューター) のホスト名です。

次ホップ ディレクター アドレスは FQDN です
NextHopDirectorAddressIsFQDN boolean

次ホップ ディレクター アドレスは、エージェントを実行しているコンピューターの完全修飾ドメイン名 (FQDN) です (つまり、エージェントとディレクターを実行しているコンピューター)。

セッション ID で次ホップ ディレクター TCP ポートをインクリメントする
IncrementNextHopDirectorTCPPortBySessionId boolean

次ホップ ディレクター TCP ポートが一意であることを確認するには (同じホストからの次ホップを使用する並列セッションが複数ある場合)、セッション ID を次ホップ ディレクター TCP ポートに追加できます。

待機時間 (秒単位)
SecondsToWait double

次ホップ セッションが接続されるまで待機する最大秒数。

次ホップ ディレクター アドレスが名前付きパイプである
NextHopDirectorAddressIsNamedPipe boolean

次ホップ ディレクター アドレス (エージェントに対する相対アドレス) は、TCP/IP Web サービスの代わりに名前付きパイプを使用しています。 これは、最初のホップで TCP/IP ポートを使用しないようにするための既定値です。

既存の次ホップを無効にする
DisableExistingNextHop boolean

再度有効にする前に、ダブルホップを無効にする必要がありますか (現在アクティブな場合) true (既定値) に設定すると、新しいダブルホップ有効化命令によって前の二重ホップの有効化命令が置き換えられます。 false に設定すると、ダブルホップ IA-Connect エージェントによって命令が受信されるため、トリプルホップが有効になります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
接続されている次ホップ セッション
NextHopSessionConnected boolean

待機する最大時間を超える前に接続された次ホップ セッションの場合は true を返します。

汎用 IA-Connect Agent コマンドを実行する

引数を JSON として渡し、出力データを JSON として返す汎用 IA-Connect Agent コマンドを実行します。 ディレクターとインスペクターがエージェントより古いバージョンであるため、コマンドを理解していない場合にエージェント コマンドを実行するために使用されます。

パラメーター

名前 キー 必須 説明
IA-Connect エージェントのコマンド名
CommandName True string

IA-Connect Agent コマンドの内部名。 コマンド名の一覧は、アクション 'GetAgentActionsInClass' で指定できます。

入力 JSON
InputJSON string

JSON 形式の IA-Connect Agent コマンドへの入力。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
出力 JSON
OutputJSON string

json 形式の IA-Connect Agent コマンドからの出力。

現在のマウス座標を取得する

setcursorpos API を使用して、IA-Connect エージェント ユーザー セッション内の現在のマウス カーソル位置を取得します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
X ピクセル
X integer

X 座標値 (ピクセル単位)。

Y ピクセル
Y integer

Y 座標値 (ピクセル単位)。

環境変数を展開する

IA-Connect エージェント ユーザー セッションの環境変数 (%USERPROFILE% や %TEMP%など) を含む文字列を展開します。

パラメーター

名前 キー 必須 説明
入力文字列
InputString True string

環境変数を含む入力文字列。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
出力文字列
OutputString string

環境変数が展開された文字列。

環境情報を取得する

IA-Connect エージェント ユーザー セッションが実行されている環境に関する情報を返します。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
OS メジャー バージョン
OSVersionMajor integer

オペレーティング システムのメジャー バージョン。

OS マイナー バージョン
OSVersionMinor integer

オペレーティング システムのマイナー バージョン。

OS ビルド バージョン
OSVersionBuild integer

オペレーティング システムのビルド バージョン。

OS は 64 ビット
OSIs64Bit boolean

オペレーティング システムが 64 ビットの場合は true を返します。

プロセッサ数
ProcessorCount integer

プロセッサ数。

物理 RAM の合計 (MB)
TotalPhysicalRAMInMB integer

物理 RAM の量 (MB 単位)。

仮想 RAM の合計 (MB)
TotalVirtualRAMInMB integer

仮想 RAM の量 (MB 単位)。

使用可能な物理 RAM (MB)
AvailablePhysicalRAMInMB integer

現在使用可能な物理 RAM の量 (MB 単位)。

使用可能な仮想 RAM (MB)
AvailableVirtualRAMInMB integer

現在使用可能な仮想 RAM の量 (MB 単位)。

OS の完全な名前
OSFullName string

オペレーティング システムのフル ネーム (Microsoft Windows Server 2019 Standard など)。

インストールされている UI カルチャ名
InstalledUICultureName string

オペレーティング システムにインストールされているユーザー インターフェイス言語 (例: en-US.

現在の UI カルチャ名
CurrentUICultureName string

既定のユーザー インターフェイス言語 (例: en-US)。

現在のカルチャ名
CurrentCultureName string

既定のユーザー ロケール (例: en-GB)。

画面に四角形を描画する

画面座標の識別、または画面座標を報告するアクションの出力を支援する四角形を画面上に描画します。 四角形は、5 秒後に自動的に削除されます。

パラメーター

名前 キー 必須 説明
四角形の左端画面ピクセル X 座標
RectangleLeftPixelXCoord True integer

表示する四角形の左端のピクセル端。 入力 「座標は物理」に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の右端の画面ピクセル X 座標
RectangleRightPixelXCoord True integer

表示する四角形の右端のピクセル。 入力 「座標は物理」に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の上端画面ピクセル Y 座標
RectangleTopPixelYCoord True integer

表示する四角形の上端。 入力 「座標は物理」に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

四角形の下端の画面ピクセル Y 座標
RectangleBottomPixelYCoord True integer

表示する四角形の下のピクセルエッジ。 入力 「座標は物理」に応じて、仮想ピクセルまたは物理ピクセルで指定できます。

ペンの色
PenColour string

描画する四角形の色 (赤、緑、青、黄、紫、オレンジなど) または文字列の 16 進コード (例: #FF0000)。

ペンの太さピクセル
PenThicknessPixels integer

強調表示四角形の境界線の太さ (ピクセル単位)。

表示する秒数
SecondsToDisplay integer

四角形を表示する秒数。

座標は物理的
CoordinatesArePhysical boolean

指定する座標が物理画面座標の場合は true に設定します。 指定されている座標が仮想である場合は false に設定します。 基になるディスプレイのスケーリングが 100%の場合、物理座標と仮想座標の両方が同じです。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
コマンドの結果
DrawRectangleOnScreenResult boolean

コマンドの結果 (成功または失敗)。

エラーメッセージ
ErrorMessage string

コマンドが成功しなかった場合は、返されたエラー メッセージが含まれます。

画面の解像度を取得する

IA-Connect エージェント ユーザー セッションの画面解像度を返します。 物理デスクトップまたはノート PC で実行されている IA-Connect ローカル エージェントの場合、これにより、すべてのディスプレイ デバイスとそのスケーリングに関する情報が提供されます。 仮想マシンでは、仮想マシンが複数のディスプレイを表示するように構成されていない限り、通常は 1 つのディスプレイのみが報告されます (一般的ではありません)。 通常、リモート セッションでは 1 つの仮想ディスプレイが作成されるため、リモート セッションでは複数のローカル ディスプレイにまたがる場合でも、通常は 1 つのディスプレイのみが報告されます。

パラメーター

名前 キー 必須 説明
Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
水平解像度
HorizontalResolution integer

プライマリ画面の水平方向の物理的解像度。 物理座標は、モニター上のピクセルに直接マップされます。

垂直方向の解像度
VerticalResolution integer

プライマリ画面の垂直方向の物理的解像度。 物理座標は、モニター上のピクセルに直接マップされます。

画面の数
NumberOfScreens integer

このセッションの画面の数。

2 番目のディスプレイの水平解像度
SecondDisplayHorizontalResolution integer

2 番目の画面の水平方向の物理的な解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

2 番目のディスプレイの垂直方向の解像度
SecondDisplayVerticalResolution integer

2 番目の画面の垂直方向の物理的解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

3 番目のディスプレイの水平解像度
ThirdDisplayHorizontalResolution integer

3 番目の画面の水平方向の物理的な解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

3 番目のディスプレイの垂直方向の解像度
ThirdDisplayVerticalResolution integer

3 番目の画面の垂直方向の物理的解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

4 番目のディスプレイの水平解像度
FourthDisplayHorizontalResolution integer

4 番目の画面の水平方向の物理的な解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

4 番目のディスプレイの垂直方向の解像度
FourthDisplayVerticalResolution integer

4 番目の画面の垂直方向の物理的な解像度 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

仮想画面の左端のピクセル
VirtualScreenLeftEdgePixels integer

仮想ディスプレイ全体の左端 (検出されたすべてのディスプレイ)。 仮想座標は DPI スケーリングされます。

仮想画面の上端ピクセル
VirtualScreenTopEdgePixels integer

仮想ディスプレイ全体の上端 (検出されたすべてのディスプレイ)。 仮想座標は DPI スケーリングされます。

仮想画面の幅ピクセル
VirtualScreenWidthPixels integer

仮想ディスプレイ全体の幅 (検出されたすべてのディスプレイ)。 仮想座標は DPI スケーリングされます。

仮想画面の高さピクセル
VirtualScreenHeightPixels integer

仮想ディスプレイ全体の高さ (検出されたすべてのディスプレイ)。 仮想座標は DPI スケーリングされます。

プライマリ ディスプレイのスケーリング
PrimaryDisplayScaling double

プライマリ ディスプレイの DPI スケーリング乗数を 10 進数として指定します。 たとえば、100% は 1.0 として返され、125% は 1.25 として返されます。

2 番目の表示スケーリング
SecondDisplayScaling double

2 番目のディスプレイの DPI スケーリング乗数を 10 進数として表示します。 たとえば、100% は 1.0 として返され、125% は 1.25 として返されます。

3 番目のディスプレイのスケーリング
ThirdDisplayScaling double

3 番目のディスプレイの DPI スケーリング乗数 (10 進数)。 たとえば、100% は 1.0 として返され、125% は 1.25 として返されます。

4 番目の表示スケーリング
FourthDisplayScaling double

4 番目のディスプレイの DPI スケーリング乗数を 10 進数として指定します。 たとえば、100% は 1.0 として返され、125% は 1.25 として返されます。

物理画面の左端のピクセル
PhysicalScreenLeftEdgePixels integer

物理ディスプレイ全体の左端 (検出されたすべてのディスプレイ)。 物理座標は、モニター上のピクセルに直接マップされます。

物理画面の上端ピクセル
PhysicalScreenTopEdgePixels integer

物理ディスプレイ全体の上端 (検出されたすべてのディスプレイ)。 物理座標は、モニター上のピクセルに直接マップされます。

物理画面の幅ピクセル
PhysicalScreenWidthPixels integer

物理ディスプレイ全体の幅 (検出されたすべてのディスプレイ)。 物理座標は、モニター上のピクセルに直接マップされます。

物理画面の高さピクセル
PhysicalScreenHeightPixels integer

物理ディスプレイ全体の高さ (検出されたすべてのディスプレイ)。 物理座標は、モニター上のピクセルに直接マップされます。

プライマリ ディスプレイの左端のピクセル
PrimaryDisplayLeftEdgePixels integer

プライマリ ディスプレイの左端。 物理座標は、モニター上のピクセルに直接マップされます。

プライマリディスプレイの上端ピクセル
PrimaryDisplayTopEdgePixels integer

プライマリ ディスプレイの上端。 物理座標は、モニター上のピクセルに直接マップされます。

2 番目のディスプレイの左端のピクセル
SecondDisplayLeftEdgePixels integer

2 番目のディスプレイの左端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

2 番目のディスプレイの上端ピクセル
SecondDisplayTopEdgePixels integer

2 番目のディスプレイの上端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

3 番目のディスプレイの左端のピクセル
ThirdDisplayLeftEdgePixels integer

3 番目のディスプレイの左端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

3 番目のディスプレイの上端ピクセル
ThirdDisplayTopEdgePixels integer

3 番目のディスプレイの上端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

4 番目の表示左端ピクセル
FourthDisplayLeftEdgePixels integer

4 番目のディスプレイの左端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

4 番目の表示上端ピクセル
FourthDisplayTopEdgePixels integer

4 番目のディスプレイの上端 (検出された場合)。 物理座標は、モニター上のピクセルに直接マップされます。

親プロセス ID を取得する

指定されたプロセス ID を持つ IA-Connect Agent ユーザー セッションで実行中のすべてのプロセスの親プロセスのプロセス ID を返します。

パラメーター

名前 キー 必須 説明
プロセス ID
ProcessId True integer

子プロセスのプロセス ID。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
親プロセス ID
ParentProcessId integer

親プロセスのプロセス ID。

まだ実行中の親プロセス
ParentProcessStillRunning boolean

親プロセスがまだ実行中で、終了していない場合は true を返します。

親プロセス名
ParentProcessName string

親プロセスのプロセス名。

階層 1 IA-Connect セッションにアタッチする

SOAP メッセージまたは REST メッセージを受信するディレクターの IA-Connect Director セッションにアタッチします。 これは、IA-Connect エージェントにコマンドを送信するセッションです。

パラメーター

名前 キー 必須 説明
仮想チャネルが接続されている必要があります
VirtualChannelMustBeConnected boolean

IA-Connect Director は、セッションにアタッチするときに仮想チャネルが接続されていることを検証する必要がありますか? これにより、IA-Connect エージェントが指定されたセッションで実行されるようになります。

Workflow
Workflow True string

workflow() に次の式を追加します。

戻り値

名前 パス 説明
アタッチされた階層 1 IA-Connect セッション名
AttachedTier1IAConnectSessionName string

接続された階層 1 IA-Connect セッションの名前。