SAP コネクタのメソッド

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:11分
  • SAP コネクタは、SAP グラフィカルユーザーインターフェイス (GUI) のインターフェイス上のワークフローを自動化するために使用できるさまざまなメソッドを提供します。SAP コネクタメソッドは、コネクタ、画面、および要素のさまざまなレベルで使用できます。

    SAP コネクタのメソッド

    SAP コネクタのメソッドは 3 つのレベルで使用できます。
    • アプリケーション:これらのメソッドは、 SAP コネクタオブジェクトをダブルクリックすると見つかります。これらのメソッドにアクセスするには、次の手順を実行します。
      1. [プロジェクトエクスプローラー (Project Explorer)] ペインの [グローバルオブジェクト] の下に SAP コネクタを追加します。

        詳細については、「SAP コネクタの設定」を参照してください。

      2. SAP コネクタオブジェクトをダブルクリックします。

        メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。

    • 画面:これらのメソッドを使用して、追加した SAP アプリケーション画面のタスクを自動化します。たとえば、アプリケーションウィンドウの最大化を自動化します。これらのメソッドにアクセスするには、次の手順を実行します。
      1. 1 つ以上の SAP アプリケーション画面を追加します。構成方法については、「SAP コネクタの設定」を参照してください。
      2. 追加された画面をダブルクリックします。

        メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。

    • 要素:これらのメソッドを使用して、 SAP 画面の UI 要素 (ボタンやチェックボックスなど) のアクションを自動化します。たとえば、ボタンの選択を自動化します。これらのメソッドにアクセスするには、次の手順を実行します。
      1. 1 つ以上の SAP アプリケーション画面を追加します。構成方法については、「SAP コネクタの設定」を参照してください。
      2. 1 つ以上の画面要素をキャプチャします。キャプチャする方法については、「[要素をキャプチャ] ダイアログの使用」を参照してください。

        画面要素は、キャプチャされた SAP 画面に表示されます。

      3. 画面要素をダブルクリックします。

        メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。

    メソッドを使用する

    メソッドを使用して自動化を作成するには、[オブジェクトエクスプローラー (Object Explorer)] ペインから [デザイン面 (Design surface)] にメソッドをドラッグして接続します。

    接続されたメソッド。

    アプリケーションレベルのメソッド

    OpenConnection
    コネクタと SAP アプリケーション間の接続を確立します。自動化を実行する前に、まずこのメソッドを使用する必要があります。
    表 : 1. OpenConnection メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    name 接続の名前。 データ入力 文字列 なし はい
    ユーザー名 ユーザー名 確立用 接続。 データ入力 文字列 なし はい
    パスワード 接続 ための パスワード。 データ入力 文字列 なし はい
    SetDefaultSession
    選択したセッションをデフォルトのセッションにします。
    表 : 2. SetDefaultSession メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    sessionId デフォルトとして設定するセッションの一意の ID。 データ入力 文字列 なし はい
    CloseConnection
    コネクタと SAP アプリケーション間の接続を閉じます。

    画面レベルのメソッド

    ClickMenuItem
    SAP画面で) 指定した ID のメニューアイテムを選択します
    表 : 3. ClickMenuItem メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    menuId 選択する必要があるメニューの ID。 データ入力 文字列 なし はい
    閉じる
    SAP画面のセッションを閉じます。
    CreateSession
    SAP画面のセッションを作成します。
    表 : 4. CreateSession メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    tCode SAP アプリケーションの特定の部分にアクセスできるようにするトランザクションコード。 データ入力 文字列 NA はい
    戻る 作成されたセッションの Id を返します。 データ出力 文字列 NA NA
    EndSession
    開いているセッションを終了します。
    EndTransaction
    トランザクションを終了します。
    重点
    オープンセッションにフォーカスを設定します。
    GetMenuItem
    指定されたメニューアイテムの名前を取得します。
    表 : 5. GetMenuItem メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    menuId 名前を取得するメニューアイテムの ID。 データ入力 文字列 なし あり
    戻る メニューアイテムの名前を返します データ出力 文字列 なし NA
    GetMenuItemsIdsByName
    名前で指定したメニューの ID を取得します。
    表 : 6. GetMenuItemsIdsByName メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    menuItemName メニューアイテムの名前。 データ出力 リスト なし NA
    GetWindowHandle
    SAPアプリケーション画面のウィンドウハンドルを返します。
    IsCreated
    セッションが作成された場合は true を返し、セッションが作成されていない場合は false を返します。
    IsSessionBusy
    セッションがビジー状態の場合は true を返し、セッションがビジー状態でない場合は false を返します。
    最大化
    SAP画面を最大化します。
    最小化
    SAP画面を最小化します。
    サイズを変更
    指定した寸法に従って SAP 画面のサイズを変更します。
    表 : 7. Resize メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    xPos X 軸方向の画面の位置。 データ入力 整数 なし はい
    yPos Y 軸方向の画面の位置。 データ入力 整数 なし はい
    画面の幅。 データ入力 整数 なし はい
    高さ 画面の高さ。 データ入力 整数 なし はい
    復元
    画面を元のサイズに戻します。
    ScreenId
    SAPアプリケーション画面の ID を文字列として返します。
    SendKeys

    キーボードストロークを SAP アプリケーション画面に送信します。

    表 : 8. SendKeys メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    キー SAP画面に送信するキーボードストローク。 データ入力 文字列 NA はい
    StartTransaction
    トランザクションを開始します。
    表 : 9. StartTransaction メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    tCode SAP アプリケーションの特定の部分にアクセスできるようにするトランザクションコード。 データ入力 文字列 NA はい
    WaitForCreate
    画面の作成中に指定された期間待機します。これにより、画面の作成後にすべての動的コントロールをロードできます。
    表 : 10. WaitForCreate メソッドのパラメーター
    パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須?
    timeoutInSeconds メソッドがタイムアウトするまでの時間です。 データ入力 整数 なし はい
    MatchAllChildren 画面をロードする前に、メソッドがキャプチャされたすべての子画面および要素を画面と照合するかどうかを示すオプションです。 データ入力 ブール False いいえ

    要素レベルのメソッド

    SAP コネクタでは、これらの要素レベルのメソッドを使用して、要素の識別、画面上のプレゼンスの確認、または要素に対して実行するアクションの定義を行うことができます。

    次の表に、要素と使用可能なメソッドを示します。これらのメソッドとそのパラメーターの説明については、「 SAP コネクタのメソッド」を参照してください。

    表 : 11. GuiButton メソッド
    要素 メソッド
    GUIボタン クリック
    特徴
    IsCreated
    MouseClick
    SendKeys
    Setfocus
    WaitForCreate
    表 : 12. GuiCheckBox メソッド
    要素 メソッド
    Guiチェックボックス チェック
    特徴
    IsChecked
    IsCreated
    SendKeys
    Setfocus
    Uncheck
    MouseClick
    WaitForCreate
    表 : 13. GuiComboBox メソッド
    要素 メソッド
    Guiコンボボックス 取得
    GetIconName
    GetList
    特徴
    IsCreated
    SendKeys
    セット
    Setfocus
    MouseClick
    WaitForCreate
    表 : 14. GuiCtrlGridView メソッド
    要素 メソッド
    GuiCtrlGridView ClickButtonCell
    ClickCell
    DeselectAllRows
    GetCellType
    GetCellValue
    GetColumns
    GetColumnsKeyValuePair
    GetRowCount
    GetRows
    GetRowsByColumn
    GetSelectedColumns
    GetSelectedRows
    GetSingleRow
    GetVisibleRows
    特徴
    IsCreated
    MouseClick
    SendKeys
    Setfocus
    SelectAllRows
    SelectCell
    SelectContextMenuItemById
    SelectContextMenuItemByPosition
    SelectContextMenuItemByText
    SelectSingleRow
    SelectToolbarMenuItemById
    SelectToolbarMenuItemByPosition
    SelectToolbarMenuItemByText
    SetCellValue
    WaitForCreate
    表 : 15. GuiLabel メソッド
    要素 メソッド
    GuiLabel GetText
    特徴
    IsCreated
    MouseClick
    SendKeys
    Setfocus
    WaitForCreate
    表 : 16. GuiPassword メソッド
    要素 メソッド
    GuiPassword 特徴
    IsCreated
    SendKeys
    SetCaretPosition
    Setfocus
    SetText
    MouseClick
    WaitForCreate
    表 : 17. GuiRadioButton メソッド
    要素 メソッド
    GUIラジオボタン 特徴
    IsChecked
    IsCreated
    選択
    SendKeys
    Setfocus
    MouseClick
    WaitForCreate
    表 : 18. GuiStatusBar メソッド
    要素 メソッド
    GuiStatusBar GetStatus
    特徴
    IsCreated
    MouseClick
    SendKeys
    Setfocus
    WaitForCreate
    表 : 19. GuiTab メソッド
    要素 メソッド
    GuiTab 特徴
    IsCreated
    SelectTab
    SendKeys
    Setfocus
    MouseClick
    WaitForCreate
    表 : 20. GuiTableControl メソッド
    要素 メソッド
    GuiTableControl DeselectAllVisibleRows
    DeselectRow
    DeselectVisibleRow
    GetAllVisibleRows
    GetColumnNames
    GetMaximumScrollOffset
    GetScrollPosition
    GetSingleRow
    GetTable
    GetVisibleRowCount
    特徴
    IsCreated
    MouseClick
    ScrollDownByOneRow
    ScrollToHorizontalPosition
    ScrollToNextPage
    ScrollToPreviousPage
    ScrollToVerticalPosition
    ScrollUpByOneRow
    SelectAllRows
    SelectSingleRow
    SelectVisibleRow
    SendKeys
    Setfocus
    WaitForCreate
    表 : 21. GuiTextBox メソッド
    要素 メソッド
    GuiTextBox GetText
    特徴
    IsCreated
    SendKeys
    SetCaretPosition
    Setfocus
    SetText
    MouseClick
    WaitForCreate
    表 : 22. GuiTree メソッド
    要素 メソッド
    GuiTree チェック
    ClickNodeItem
    CollapseNodeItem
    DoubleClickNode
    DoubleClickNodeItem
    GetColumnsKeyValuePair
    GetTreeType
    GetNodeKeyByPath
    GetNodeKeyByText
    GetNodeItemText
    GetSelectedNode
    GetNodeItemCheckBoxState
    特徴
    IsCreated
    PressNodeItemButton
    SelectTab
    SendKeys
    Setfocus
    MouseClick
    SelectNodeItem
    SelectNode
    SelectContextMenuItemById
    SelectContextMenuItemByText
    SelectContextMenuItemByPosition
    Uncheck
    WaitForCreate
    表 : 23. GuiUserArea メソッド
    要素 メソッド
    GuiUserArea 特徴
    IsCreated
    MouseClick
    ScrollToNextPage
    ScrollToPreviousPage
    SendKeys
    Setfocus
    SetHorizontalScroll
    SetVerticalScroll
    WaitForCreate