IBM App Connect Enterprise での Toggl Track の利用

Toggl Trackは企業やフリーランサーのためのタイムトラッキングソフトウェアです。 プロジェクトに費やした時間を追跡し、生産性を分析することができる。

このタスクの概要

IBM® App Connect Enterprise Windows、 AIX、および Linux® システムで利用可能な「 Toggl Track Input 」および 「Toggl Track Request 」ノードを介して、 Toggl Track と同期通信を行います。

メッセージフローでToggl Track Inputノードを使用すると、Toggl Track からの入力を受け付けることができます。 例えば、Toggl Track Inputノードを使用して、新しいワークスペース・プロジェクトのToggl Trackをモニターすることができます。 新しいワークスペース・プロジェクトが作成されると、Toggl Track Inputノードは、新しいワークスペース・プロジェクトの詳細を含むビジネス・オブジェクトを表すメッセージ・ツリーを生成します。 メッセージツリーはOut端末に伝搬され、メッセージフローの残りの部分は、他のシステムを更新したり、変更を監査したりするためにデータを使用することができる。 Toggl Track Inputノードの設定については、Toggl Track Inputノードを参照してください。

Toggl Track Requestノードを使用してToggl Trackに接続し、以下のオブジェクトに対してアクションを実行できます:
クライアント
クライアントの取得または作成
タグ
タグの取得と作成
時間エントリー
時間エントリーの作成、取得、更新、削除
ワークスペース招待
ワークスペースの招待状を作成する
ワークスペース・プロジェクト
ワークスペース・プロジェクトの作成または取得
ワークスペース・ユーザー
ワークスペース・ユーザーの取得
ワークスペース
ワークスペースの作成または取得
Toggl Track Requestノードの設定については、Toggl Track Requestノードを参照してください。

手順

以下の手順では、Toggl Trackアカウントに接続し、コネクタ検出を使用してToggl Track Requestノードを構成する方法を示します。 同様の手順で、Toggl Track 入力ノードを設定し、Toggl Track の入力を監視するには、Toggl Track 入力ノードを含むフローを作成し、コネクターディスカバリーで設定します。

  1. IBM App Connect Enterprise 」ツールキットで、 Toggl Track Request ノードを含むフローを作成します。
  2. フロー内の「トグル トラックリクエストノードを選択し、エディタにノード・プロパティを表示する。
  3. 基本タブで、Launch Connector Discovery をクリックします。
    コネクターのディスカバリー中に使用するポリシー・プロジェクトの名前とボールトの詳細を指定するパネルが表示されます。
  4. コネクターのディスカバリー中に使用するポリシー・プロジェクトとボールトの詳細を指定します。
    1. ポリシー プロジェクト]フィールドで、コネクタ検出中に作成されるポリシーを格納するために使用されるポリシー プロジェクトを指定します。
      あるいは、「新規」をクリックし、新規ポリシー・プロジェクトの名前を指定して、新規ポリシー・プロジェクトを作成することもできます。 次に、「完了」をクリックします。
    2. コネクタ検出時に使用するボールトを指定します。 デフォルトでは、コネクタ検出時に使用される資格情報は、どの統合サーバーでも使用できるApp Connect Enterpriseデータ保管庫である外部ディレクトリデータ保管庫に保存されます。 これは、統合サーバーの作業ディレクトリに作成され、その特定の統合サーバーでのみ使用できます。
      資格情報の格納に使用するデータ保管庫を指定するには、以下のトピックのいずれかの「Using Connector Discovery ウィザード」セクションの手順を完了します:
    3. 保管庫キーフィールドに、保管庫に格納されている資格情報へのアクセスに使用される保管庫キーを入力します。 ボールト鍵の長さは 8 文字以上でなければなりません。
    4. オプション:'デフォルトでは、指定されたデータ保管庫の場所とデータ保管庫キーは、Connector Discovery を起動したときに値がプリセットされるように、ツールキットの環境設定として保存されます。 設定を保存しない場合は、ボールト設定に保存 を選択解除します。
  5. Launch Discovery をクリックして、Toggl Trackコネクタのコネクタ検出ウィザードを開始します。
    Connector Discoveryウィンドウが表示されます。 既存のToggl Track接続(アカウント)が利用可能な場合、それらの接続のリストが表示されます。 既存の接続がない場合、Toggl Trackコネクタのステータスは「Not connected」と表示されます。
    • 1つ以上のToggl Track接続(アカウント)が利用可能な場合は、以下の手順を実行します:
      1. 使用する接続(アカウント)をクリックして選択します。
      2. 必要なオブジェクト・タイプをクリックし、オブジェクトに対して実行するアクションを選択します。 例えば、Toggl Trackからバグを取得するには、Time entriesをクリックし、Retrieve time entriesをクリックします。
    • 既存の接続 (アカウント) がない場合は、以下のステップを実行します。
      1. 必要なオブジェクト・タイプをクリックし、そのオブジェクトに対して実行するアクションを選択します。 例えば、Toggl Trackからバグを取得するには、Time entriesをクリックし、Retrieve time entriesをクリックします。
      2. Connectをクリックするとメニューが表示されるので、そこから以下のAuthorizationタイプのいずれかを選択する:
        • App Connectが使用する認証情報を提供する(BASIC)
        • App Connectが使用する認証情報(API KEY)を提供する。
      3. 認証タイプを選択し、「Continue」をクリックします。 アカウントの詳細を入力するためのウィンドウが表示されます。
      4. 認証タイプとしてProvide credentials forApp Connectto use(BASIC)を選択した場合は、以下の詳細を入力します:
        • サーバ URL :実行時呼び出しを行うAPIサーバの URL を指定します。
        • ユーザー名Toggl Trackへのアクセスを許可するユーザー名を指定します。
        • パスワード:ユーザー名のパスワードを指定する。
        • 自己署名証明書を許可する:ドロップダウン・メニューから「True」 または「False」を選択する。
        • オーバーライドサーバー URL :プライベートネットワーククライアントを使用してプライベートネットワーク内のエンドポイントに接続する場合、またはサーバー URL をオーバーライドする場合に必要です。 コネクタのホストとポートのオーバーライド値を '<http or https>://<host_name>:<port>形式で指定します。 プライベートネットワーククライアントを使用しない場合、またはオーバーライドを必要としない場合は、このフィールドを空白のままにしてください。
        • プロキシ名 : App Connect がコネクタへの呼び出しを転送するために使用するプロキシの名前を選択または指定します。 このフィールドは、呼び出しをプロキシ経由で行う必要がある場合にのみ必須となります。 IBM App Connect Enterprise ツールキットを使用する際は、プロキシ名を次の形式で指定する必要があります: {PolicyProjectName}:HTTPProxyPolicyName
      5. 認証タイプとしてProvide credentials forApp Connectto use (API KEY)を選択した場合は、以下の詳細を入力します:
        • サーバ URL :実行時呼び出しを行うAPIサーバの URL を指定します。
        • APIトークンToggl Trackへのアクセスに使用するアクセストークンを指定します。
        • 自己署名証明書を許可する:ドロップダウン・メニューから「True」 または「False」を選択する。
        • オーバーライドサーバー URL :プライベートネットワーククライアントを使用してプライベートネットワーク内のエンドポイントに接続する場合、またはサーバー URL をオーバーライドする場合に必要です。 コネクタのホストとポートのオーバーライド値を '<http or https>://<host_name>:<port>形式で指定します。 プライベートネットワーククライアントを使用しない場合、またはオーバーライドを必要としない場合は、このフィールドを空白のままにしてください。
        • プロキシ名 : App Connect がコネクタへの呼び出しを転送するために使用するプロキシの名前を選択または指定します。 このフィールドは、呼び出しをプロキシ経由で行う必要がある場合にのみ必須となります。 IBM App Connect Enterprise ツールキットを使用する際は、プロキシ名を次の形式で指定する必要があります: {PolicyProjectName}:HTTPProxyPolicyName
      6. 「接続」 をクリックします。

      Toggl Track への接続に関する詳細については、『 IBM 』の 「Toggl Track での IBM の使用方法」 App Connect および「継続的デリバリー(CD)」のドキュメント App Connect in containers を参照してください。

  6. ウィザードで必要なコネクター・プロパティーを設定します。

    検索アクションや更新アクションに条件を追加する場合、オプションで条件フィルタリングを使用して適用する条件を絞り込むことができます。 条件フィルタリングを使用するには、「閉じる」ボタン(X)をクリックしてコネクタ検出ウィザードを終了し、「 条件フィルタリングの使用 」の手順に従ってください。

    また、取得するレコードの最大数や、その制限を超えた場合に実行されるアクションを指定するプロパティを設定することもできます。
  7. Connector Discovery ウィザードでプロパティの指定が完了したら、Save をクリックします。
    Toggl Trackへの接続に使用される認証情報はVaultに保存され、その他の接続情報はToggl Trackポリシーに保存されます。 ウィザードで設定したプロパティの値は、 IBM App Connect Enterprise Toolkit の「 Toggl Track Request 」ノードに返されます。
  8. 検出を終了し、プロパティ値を保存したら、ウィンドウの右上隅にある X をクリックするか、Alt+F4 を押して Connector Discovery ウィザードを終了します。
  9. IBM App Connect Enterprise Toolkit 」の 「Toggl Track Request 」ノードの編集画面に戻る。
    Connector Discovery ウィザード(ステップ6)で設定されたコネクタプロパティが、プロパティエディタのToggl Track Requestノードに表示されるようになりました。 Basicタブには、ウィザードで設定したActionプロパティとObjectプロパティの値が表示されます。 たとえば、ウィザードで 「タイムエントリー 」> 「タイムエントリーを取得」 を選択した場合、ノードの 「基本 」タブには以下のプロパティが表示されます:
    • 処置 - RETRIEVEALL
    • オブジェクト - getMeTimeEntries_model

    処置 プロパティーおよび オブジェクト プロパティーの値は、読み取り専用形式で表示されます。 これらの値を変更するには、「コネクター・ディスカバリーの起動」を再度クリックし、「コネクター・ディスカバリー」ウィザードで新しい値を設定します。

    Schema base nameプロパティは、Toggl Trackコネクタから送受信されるリクエストメッセージとレスポンスメッセージのフォーマットを記述するスキーマファイルのベース名を指定します。 スキーマ・ベース名は、ノードに対してディスカバリを最初に実行したときに自動的に設定され、現在のフロー名とノード名に基づいている。 ディスカバリーを初めて実行する前にこのプロパティを手動で設定した場合、設定した値が使用される。 検出後にスキーマの名前を変更する場合は、このプロパティを編集して、プロジェクト内で名前を変更したスキーマが使用するスキーマ・ベース名と一致させる必要があります。 ディスカバリー後にこのプロパティを変更した場合は、スキーマ名を一致するように変更するか、ディスカバリーを再度実行する必要がある。

    検出中に選択されたアクションに応じて、Connector Discovery ウィザードは要求スキーマと応答スキーマ、または応答スキーマのみを生成します。 リクエストスキーマは、選択されたアクションとオブジェクトがリクエスト メッセージを必要とする場合にのみ生成される。 生成されたリクエストスキーマは、リクエストメッセージの検証に使われる。 アクションが 'RETRIEVEまたは 'DELETE の場合、レスポンススキーマのみがコネクタから返される。

    生成されたスキーマ・ファイルはプロジェクトに追加され、マッピング・ノードが入力データや出力データを変換するために使用することができます。 スキーマの完全なファイル名は、スキーマのベース名('gen/MyMessageFlow.Toggl_Track_Requestなど)に'response.schema.jsonまたは'request.schema.jsonを接尾辞として付けたものである。 リクエストスキーマを開く]または[レスポンススキーマを開く]をクリックしてスキーマを開くことができます。

  10. Toggl Track Requestノードのプロパティ設定が正しいことを確認し、メッセージフローを保存します。
  11. Toggl Track RequestノードのConnectionタブでは、Policyプロパティに、接続に使用するセキュリ ティ ID の詳細を含むポリシーの名前が表示されます。 ポリシーのタイプは 'Toggl Track.
    詳細については、 Toggl Trackのポリシー をご覧ください。
  12. オプション: '接続タブの'タイムアウトプロパティを設定し、ノードが'トグル トラック処理を待つ時間(秒)を指定する。
  13. Toggl Track RequestノードのFilterタブには、メッセージフローがデータを選択する方法を制御するプロパティが含まれている。 これらのプロパティの初期値は、Connector Discovery ウィザードでToggl Trackコネクタに設定されたプロパティ値(フィルタオプションプロパティや(ステップ6 で説明した)指定された条件を含む)から取得されます。 その後、Connector Discovery ウィザードに戻り、プロパティの値を変更すると(新しい条件を追加するなど)、その更新はノードに設定されたプロパティに反映されます。

    Filter Optionsプロパティは、Toggl Track Requestノードの実行時に操作するオブジェクトを制御します。 Filter Limitプロパティは、取得するアイテムの最大数と、制限を超えた場合に実行されるアクションを制御します。

    値を変更するには、Filter Optionsセクションで変更したい値の横にあるEditをクリックし、Filter Limitセクションで設定されているプロパティ値を変更します。

    プロパティ値はテキスト値か、実行時にToggl Track Requestノードに渡されるメッセージの内容から解決される ESQL または XPATH 式です。

  14. Requestタブで、Data locationプロパティを設定して、Toggl Track で作成するオブジェクトデータを含む受信メッセージツリーの場所を指定します。 このデータは、Toggl Track RequestノードからToggl Trackシステムに送信されるリクエストを形成する。
  15. Resultタブで、Output data locationプロパティを設定し、Toggl Track で作成されるレコードのデータを含む出力メッセージツリーの場所を指定します。
  16. デフォルトでは、リクエストメッセージはコネクタ発見時に生成されたリクエストスキーマに対して検証されます。 リクエストのバリデーションをオフにしたり、バリデーション設定を変更するには、Toggl Track RequestノードのValidationプロパティを使用します。
  17. セーブメッセージの流れ。