ターミナル セッション

UiPath.Terminal.Activities.TerminalSession

ターミナルに接続するコンテナーであり、その中で複数のアクションを実行できます。 アクティビティをワークフロー デザイナーにドラッグすると、[ 接続設定 ] ウィンドウが開きます。 このウィンドウを閉じた場合に再度開くには、アクティビティの本体にある [接続を構成... ] ボタンを使用します。

接続を設定したら、[レコーダーを開始] ボタンを使用してターミナルに接続し、必要なアクションを記録できます。このボタンはアクティビティの本体に配置されます。

プロパティ

共通

• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でもオートメーションを続行するかどうかを指定します。このフィールドは Boolean 値 (True、False) のみをポートします。既定値は False です。結果として、フィールドが空白であり、エラーが返された場合、プロジェクトの実行は停止されます。値が True に設定されている場合、エラーが発生したとしても、プロジェクトの実行は続行されます。

  注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。
• 表示名 - アクティビティの表示名です。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

新しいセッション

• ConnectionString - 接続詳細を含む文字列です。このフィールドは、文字列と String 型変数のみをサポートします。
• 出力接続 - TerminalSession 変数に格納されている確立済みの接続です。既に確立されている接続を再利用したい場合は、この変数を [既存のコネクション] プロパティ フィールドの他の [ターミナル セッション] アクティビティに渡すことができます。このフィールドでは TerminalSession 型の変数のみがサポートされています。

オプション

• 待機 (ミリ秒) - アクティビティが任意の操作の実行を開始するまでの遅延時間 (ミリ秒)。既定値は 1000 ミリ秒 (1 秒) です。
• タイムアウト (ミリ秒) - アクティビティの実行を待機できる時間 (ミリ秒単位) を指定します。この時間を超えるとエラーがスローされます。 既定値は 50,000 ミリ秒 (50 秒) です。

SSH 接続プロパティ

• SSH パスワード - 指定したターミナルへの接続に使用する SecureShell のパスワードです。SecureString 変数に格納されます。このフィールドでは SecureString 型の変数のみがサポートされています。
• SSH ユーザー名 - 指定したターミナルへの接続に使用する SecureShell ユーザー名です。String 変数に格納されます。このフィールドでは、文字列と String 型変数のみがサポートされています。

既存の接続を使用

• 接続を閉じる - このチェック ボックスをオンにした場合、アクティビティの実行が停止した後、既存の接続が閉じられます。 既定では、このチェック ボックスはオンになっています。 [出力接続] プロパティが設定されている場合、このプロパティは無視されることに注意してください。
• ExistingConnection - このプロパティ フィールドに TerminalSession 変数を供給し、端末に接続するために変数に格納された接続を使用します。このフィールドでは TerminalSession 型変数のみがサポートされています。

[接続を設定] ウィンドウ

[接続を設定] ウィンドウに含まれる各種の設定オプションは、ターミナル環境に接続するために選択したプロバイダーの種類に応じて変わります。

選択したプロバイダーに依存しないプロパティ:

• クライアント アプリケーションを表示 – オンにすると、実行時にターミナル画面が表示されます。

直接接続プロバイダー

直接接続プロバイダーは UiPath の内部プロバイダーであり、ロボット端末にサード パーティのターミナル エミュレーション ソフトウェアは必要ありません。エミュレーションは実行時にロボットによって行われます。

設定プロパティ:

• アドレス - ターミナル環境のシステムの IP アドレスまたはホスト名です。
• ポート - ターミナル環境のシステムが接続を受け入れるポート番号です。

• 種類 - 必要なターミナル エミュレーションの種類です。

  • TN3270 - 一般的に IBM Z Series システムで使用されます。
  • TN5250 - 一般的に IBM iSeries システム (AS-400) で使用されます。
  • VT - DEC VT 互換ターミナルです。
  • HP シリーズ - HP 固有のターミナル エミュレーションです。
  • Tandem - Tandem Systems のターミナル エミュレーションです。
  • Wyse - Wyse シリーズのターミナル エミュレーションです。
  • ANSI - ANSI 仕様に基づくターミナル エミュレーションです。
  • Sco ANSI - SCO Unix システムで使用される ANSI 仕様の拡張です。

• プロトコル - 接続に使用する通信プロトコルです。

  • Telnet - Telnet プロトコルです。
  • SSH - ほとんどの Unix/Linux システムで使用される SSH プロトコルです。
  • HPVT - HP シリーズのターミナル エミュレーションと組み合わせて使用される、HP 固有のプロトコルです。
• ターミナル モード - ターミナル エミュレーションの固有のフレーバーです。ここで利用可能な値は、[種類] フィールドで選択した値によって異なります。
• エンコード - ターミナル環境のシステムで使用されるコード ページです。既定値は、IBM ファミリのターミナルの場合は [IBM037]、他の種類のターミナルの場合は [ASCII] です。
• SSL/TLS を有効化 - Telnet プロトコルと組み合わせて使用し、ターミナル環境のシステムで SSL または TLS 暗号化接続を使用するよう指定します。
• LU 名 - IBM ファミリー・ターミナル・タイプとともに使用される論理装置名です。
• アンサーバック - ターミナルが ENQ 制御文字を受信したときにホスト・システムに送信されるテキスト・メッセージです。メッセージには、^M として文字列値にエンコードされた Enter コントロール キーを含めることができます。 この構成オプションは、選択したターミナルの種類が VT である場合にのみ使用できます。

IBM EHLLAPI プロバイダー

IBM EHLLAPI プロバイダーは、EHLL API を実装するサードパーティのターミナル・エミュレーション・ソフトウェアと組み合わせて使用できます。EHLL API の実装に関する詳細は、サードパーティのターミナル エミュレーター ソフトウェアのドキュメントに記載されている必要があります。

注: EHLLAPI を介して接続する前に、ターミナル エミュレーション・ソフトウェアを起動して接続する必要があります。

設定プロパティ:

• EHLL dll - サードパーティのターミナル エミュレーター ソフトウェアに EHLLAPI を実装するために使用する dll へのパスです。
• EHLL 関数 - EHLL dll のエントリ ポイント関数の名前です。通常は「hllapi」です。
• EHLL セッション - ターミナル エミュレーション・ソフトウェアに表示されるセッションの名前です。通常は「A」ですが、複数の同時セッションを使用する場合、異なる値になる可能性があります。
• EHLL エンコード - 特定の接続用の端末エミュレーション・ソフトウェアで使用されるエンコードです。
• EHLL 拡張 - サードパーティのターミナル エミュレーターに EHLL API の標準バージョンまたは拡張バージョンが実装されているかどうかを指定するために使用されます。
• エンコード - ターミナル環境のシステムで使用されるコード ページです。既定値は、IBM ファミリのターミナルの場合は [IBM037]、他の種類のターミナルの場合は [ASCII] です。
• ベーシック モード - フィールド レベルの処理を無効化してパフォーマンスを向上させるモードです。このモードでは、フィールド レベルのアクティビティ ([フィールドを取得]、[フィールドを設定] など) は機能しないことに注意してください。
• プロセス内で実行 - サードパーティのターミナル エミュレーションの通信方法は EHLL API を介して行われます。既定では無効化されています。この場合、通信はプロキシ プロセスを介して行われます。プロキシ プロセスは、ターミナル アクティビティ パッケージに含まれる別の実行可能ファイルです。実行時に、プロキシ プロセスは IPC (プロセス間通信) を介して UiPath Executor プロセスと通信します。 有効化すると、サードパーティのターミナル エミュレーション ソフトウェアとの通信が UiPath Executor プロセス内で行われます。このオプションは、ウイルス対策ソフトウェアまたはソフトウェア セキュリティ ポリシーによってプロキシ プロセスの適切な機能が防止されている場合にのみ有効化してください。

注: EHLLAPI の仕様の制限のため、EHLLAPI の拡張バージョンでは、[プロセス内で実行] オプションをオンにすると複数の EHLLAPI セッションを使用できません。このようなシナリオは EHLLAPI の標準実装でのみサポートされています。つまり、[EHLL 拡張] オプションはオフで、[EHLL dll] フィールドにリストされる DLL ファイルは標準の EHLLAPI 仕様を実装するバージョンです。

Attachmate Reflection プロバイダー

Attachmate Reflection プロバイダーは、Attachmate Reflection のターミナル エミュレーターで動作します。

設定プロパティ:

• 既存のセッションにアタッチ - このモードでは、ターミナル エミュレーターが既に開始および接続されている必要があります。この場合、設定プロファイルは使用されません。
• 既存のプロファイルを使用 - このモードでは、設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

• アドレスを手動で指定 - このモードでは、構成プロファイルは使用されません。構成プロパティを手動で指定する必要があります。

  • アドレス - ターミナル環境のシステムの IP アドレスまたはホスト名です。
  • ポート - ターミナル環境のシステムが接続を受け入れるポート番号です。

  • 種類 - 必要なターミナル エミュレーションの種類です。

    • TN3270
    • TN5250
    • VT

Attachmate Extra プロバイダー

Attachmate Extra プロバイダーは、Attachmate Extra ターミナル エミュレーターで動作します。

設定プロパティ:

• 既存のプロファイルを使用 - 設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

Reflection for UNIX プロバイダー

Reflection for UNIX プロバイダーは、Reflection for Unix ターミナル エミュレーターで動作します。

設定プロパティ:

• 既存のプロファイルを使用 - 設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

Reflection for IBM プロバイダー

Reflection for IBM プロバイダーは、Reflection for IBM ターミナル エミュレーターで動作します。

設定プロパティ:

• 既存のプロファイルを使用 - このモードでは、設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

• アドレスを手動で指定 - このモードでは、構成プロファイルは使用されません。構成プロパティを手動で指定する必要があります。

  • アドレス - ターミナル環境のシステムの IP アドレスまたはホスト名です。
  • ポート - ターミナル環境のシステムが接続を受け入れるポート番号です。

  • 種類 - 必要なターミナル エミュレーションの種類です。

    • TN3270
    • TN5250
    • VT

Rocket BlueZone プロバイダー

Rocket BlueZone プロバイダーは、Rocket BlueZone ターミナル エミュレーターで動作します。

設定プロパティ:

• 既存のプロファイルを使用 - このモードでは、設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

• アドレスを手動で指定 - このモードでは、構成プロファイルは使用されません。構成プロパティを手動で指定する必要があります。

  • アドレス - ターミナル環境のシステムの IP アドレスまたはホスト名です。
  • ポート - ターミナル環境のシステムが接続を受け入れるポート番号です。

  • 種類 - 必要なターミナル エミュレーションの種類です。

    • TN3270
    • TN5250
    • VT

IBM パーソナル コミュニケーションズ プロバイダー

IBM パーソナル・コミュニケーションズ・プロバイダーは、IBM パーソナル・コミュニケーションズ・ターミナル・エミュレーターで動作します。

設定プロパティ:

• 既存のプロファイルを使用 - このモードでは、設定プロファイルのパスを指定する必要があります。ターミナル エミュレーターは自動的に起動します。

ターミナル アクティビティのベスト プラクティス

• [出力接続]/[既存の接続] プロパティを使用する場合は、必ず、ワークフロー/プロセスで不要になったターミナル セッションを閉じてください。ターミナル セッションを開いたままにしておくと、パフォーマンスや他のターミナル セッションの実行に悪影響を及ぼす可能性があります。以前に保存したターミナル セッションを正しく閉じるには、新しいターミナル セッションを (空の本文で) 次のプロパティでワークフローに追加します。
  • 接続を閉じる: True
  • 既存の接続: 保存されたセッションを格納した TerminalSession 変数
• IBM EHLLAPI プロバイダーと組み合わせて、[ 出力接続/既存の接続 ] プロパティの使用を避けてください。これらのオプションは、ワークフロー間の接続を確実に永続性で実現するために使用されます。 接続は既にターミナル エミュレーターで保持されるため、永続性の 2 番目のレイヤーは不要です。 また、前述のように接続を閉じるには余分な手順を実行する必要がなくなります。
• 他のターミナル セッションに入れ子になったターミナル セッションの使用は避けてください。 これは、間接的な入れ子にも適用されます。たとえば、同じコネクションを持つターミナル セッションを含むワークフローをターミナル セッションの本体から呼び出したり、同じコネクションを持つターミナル セッションを含むライブラリ関数を呼び出したりする場合を含みます。
• [フィールドを 取得/設定] などのフィールドベースのアクティビティの使用を避けます。 画面がフィールドにどのように分割されるかが明確であるとは限らないため、混乱を招く可能性があります。 また、異なる API が使用されるため、プロバイダーごとに同じ画面が分割される可能性があります。 [ カーソルを移動 ] または [コントロール キーを送信] アクティビティ に続いて [キーを 送信 ] アクティビティを使用して画面にデータを送信する場合など、人間が使用する方法に似た方法を使用した方が安全です。 画面からデータを取得する場合は、[ 画面領域を取得] または [ 指定位置でテキストを取得] を使用します。
• [画面のテキストを待機] アクティビティを使用して、正しい画面を読み込んでから、画面に対する操作を行うようにします。
• DataTable 形式の画面から表形式のデータを抽出する場合は、表を含む画面の部分に対して [画面領域を取得] アクティビティを使用し、このアクティビティの出力を UiPath.System.Activities パッケージの [データ テーブルを生成] アクティビティの入力として使用します。