SAP コネクタのメソッド
SAP コネクタは、SAP グラフィカルユーザーインターフェイス (GUI) のインターフェイス上のワークフローを自動化するために使用できるさまざまなメソッドを提供します。SAP コネクタメソッドは、コネクタ、画面、および要素のさまざまなレベルで使用できます。
SAP コネクタのメソッド
SAP コネクタのメソッドは 3 つのレベルで使用できます。
- アプリケーション：これらのメソッドは、SAP コネクタオブジェクトをダブルクリックすると見つけることができます。これらのメソッドにアクセスするには、次の手順を実行します。
- [プロジェクトエクスプローラー (Project Explorer)] ペインの [グローバルオブジェクト] の下に SAP コネクタを追加します。
詳細については、「SAP コネクタの設定」を参照してください。
- SAP コネクタオブジェクトをダブルクリックします。
メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。
- [プロジェクトエクスプローラー (Project Explorer)] ペインの [グローバルオブジェクト] の下に SAP コネクタを追加します。
- 画面：これらのメソッドを使用して、追加した SAP アプリケーション画面のタスクを自動化します。たとえば、アプリケーションウィンドウの最大化を自動化します。これらのメソッドにアクセスするには、次の手順を実行します。
- 1 つ以上の SAP アプリケーション画面を追加します。構成方法については、「SAP コネクタの設定」を参照してください。
- 追加された画面をダブルクリックします。
メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。
- 要素：これらのメソッドを使用して、SAP 画面の UI 要素 (ボタンやチェックボックスなど) のアクションを自動化します。たとえば、ボタンの選択を自動化します。これらのメソッドにアクセスするには、次の手順を実行します。
- 1 つ以上の SAP アプリケーション画面を追加します。構成方法については、「SAP コネクタの設定」を参照してください。
- 1 つ以上の画面要素をキャプチャします。キャプチャする方法については、「[要素をキャプチャ] ダイアログの使用」を参照してください。
画面要素は、キャプチャされた SAP 画面に表示されます。
- 画面要素をダブルクリックします。
メソッドが [オブジェクトエクスプローラー (Object Explorer)] ペインに表示されます。
メソッドを使用する
メソッドを使用して自動化を作成するには、[オブジェクトエクスプローラー (Object Explorer)] ペインから [デザイン面 (Design surface)] にメソッドをドラッグして接続します。
アプリケーションレベルのメソッド
- OpenConnection
- コネクタと SAP アプリケーション間の接続を確立します。自動化を実行する前に、まずこのメソッドを使用する必要があります。
表 : 1. OpenConnection メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ name 接続の名前。 データ入力 文字列 なし はい username 接続を確立するためのユーザー名。 データ入力 文字列 なし はい password 接続を確立するためのパスワード。 データ入力 文字列 なし はい - SetDefaultSession
- 選択したセッションをデフォルトのセッションにします。
表 : 2. SetDefaultSession メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ sessionId デフォルトとして設定するセッションの一意の ID。 データ入力 文字列 なし はい - CloseConnection
- コネクタと SAP アプリケーション間の接続を閉じます。
画面レベルのメソッド
- ClickMenuItem
- SAP 画面で の ID を指定するメニュー項目を選択します。
表 : 3. ClickMenuItem メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ menuId 選択する必要があるメニューの ID。 データ入力 文字列 なし はい - Close
- SAP 画面のセッションを閉じます。
- CreateSession
- SAP 画面のセッションを作成します。
表 : 4. CreateSession メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ tCode SAP アプリケーションの特定の部分にアクセスできるようにするトランザクションコード。 データ入力 文字列 NA はい Return 作成したセッションの ID を返します。 データ出力 文字列 NA NA - EndSession
- 開いているセッションを終了します。
- EndTransaction
- トランザクションを終了します。
- Focus
- 開いているセッションにフォーカスを設定します。
- GetMenuItem
- 指定されたメニュー項目の名前を取得します。
表 : 5. GetMenuItem メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ menuId 名前を取得するメニュー項目の ID。 データ入力 文字列 なし あり Return メニュー項目の名前を返します データ出力 文字列 なし NA - GetMenuItemsIdsByName
- 名前で指定したメニューの ID を取得します。
表 : 6. GetMenuItemsIdsByName メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ menuItemName メニュー項目の名前。 データ出力 リスト なし NA - GetWindowHandle
- SAP アプリケーション画面のウィンドウハンドルを返します。
- IsCreated
- セッションが作成された場合は
trueを返し、セッションが作成されていない場合はfalseを返します。 - IsSessionBusy
- セッションがビジー状態の場合は
trueを返し、セッションがビジー状態でない場合はfalseを返します。 - Maximise
- SAP 画面を最大化します。
- Minimise
- SAP 画面を最小化します。
- Resize
- 指定した寸法に従って SAP 画面のサイズを変更します。
表 : 7. Resize メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ xPos 画面上の X 軸方向の位置です。 データ入力 整数 なし はい yPos 画面上の Y 軸方向の位置です。 データ入力 整数 なし はい Width 画面の幅。 データ入力 整数 なし はい Height 画面の高さ。 データ入力 整数 なし はい - Restore
- 画面を元のサイズに戻します。
- ScreenId
- SAP アプリケーション画面の ID を文字列として返します。
- SendKeys
-
キーボードストロークを SAP アプリケーション画面に送信します。
表 : 8. SendKeys メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ Keys SAP 画面に送信するキーボードストローク。 データ入力 文字列 NA はい - StartTransaction
- トランザクションを開始します。
表 : 9. StartTransaction メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ tCode SAP アプリケーションの特定の部分にアクセスできるようにするトランザクションコード。 データ入力 文字列 NA はい - WaitForCreate
- 画面の作成中、指定された時間待機します。これにより、画面の作成後にすべての動的コントロールをロードできます。
表 : 10. WaitForCreate メソッドのパラメーター パラメーター 説明 データポートエントリタイプ データタイプ デフォルト値 必須？ timeoutInSeconds メソッドがタイムアウトするまでの時間です。 データ入力 整数 なし はい MatchAllChildren 画面がロードされる前に、メソッドがキャプチャされたすべての子画面および要素を画面と照合するかどうかを示すオプションです。 データ入力 ブール False いいえ
要素レベルのメソッド
SAP コネクタでは、これらの要素レベルのメソッドを使用して、要素を識別したり、画面上での存在を確認したり、要素に対して実行するアクションを定義したりできます。
次の表に、要素とその使用可能なメソッドを示します。これらのメソッドとそのパラメーターの説明については、「SAP コネクタのメソッド」を参照してください。
| 要素 | メソッド |
|---|---|
| GuiButton | Click |
| Highlight | |
| IsCreated | |
| MouseClick | |
| SendKeys | |
| Setfocus | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiCheckBox | Check |
| Highlight | |
| IsChecked | |
| IsCreated | |
| SendKeys | |
| Setfocus | |
| Uncheck | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiComboBox | Get |
| GetIconName | |
| GetList | |
| Highlight | |
| IsCreated | |
| SendKeys | |
| Set | |
| Setfocus | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiLabel | GetText |
| Highlight | |
| IsCreated | |
| MouseClick | |
| SendKeys | |
| Setfocus | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiPassword | Highlight |
| IsCreated | |
| SendKeys | |
| SetCaretPosition | |
| Setfocus | |
| SetText | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiRadioButton | Highlight |
| IsChecked | |
| IsCreated | |
| Select | |
| SendKeys | |
| Setfocus | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiStatusBar | GetStatus |
| Highlight | |
| IsCreated | |
| MouseClick | |
| SendKeys | |
| Setfocus | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiTab | Highlight |
| IsCreated | |
| SelectTab | |
| SendKeys | |
| Setfocus | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiTextBox | GetText |
| Highlight | |
| IsCreated | |
| SendKeys | |
| SetCaretPosition | |
| Setfocus | |
| SetText | |
| MouseClick | |
| WaitForCreate |
| 要素 | メソッド |
|---|---|
| GuiUserArea | Highlight |
| IsCreated | |
| MouseClick | |
| ScrollToNextPage | |
| ScrollToPreviousPage | |
| SendKeys | |
| Setfocus | |
| SetHorizontalScroll | |
| SetVerticalScroll | |
| WaitForCreate |