クラウドまたはオンプレミス版の IBM TM1® をチェーンの一部として自動化するには、IBM® Planning Analytics 接続コマンドを含むステップを追加します。例：
- TM1の雑用とプロセスの自動化
- TM1のログファイルを照会する
- リレーショナルデータベース、Workday®、NetSuite®、Namely®、Salesforce®など、さまざまなアプリケーションと双方向にデータを交換できます。
これらのコマンドを有効にするには、IT 管理者がまずIBM Planning Analytics TM1 コネクタ を作成します。
雑用をアクティブにする
家事をアクティブにするには、Activate a chore コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | アクティベートする家事の名前を入力する。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
雑用を無効にする
家事を無効にするには、Deactivate a chore コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | 停止する家事の名前を入力してください。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
雑用を削除する
家事を削除するには、Delete a chore コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | 削除する家事の名前を入力してください。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
キューブの削除
キューブを削除するには、Delete a cube コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | 削除するキューブの名前を入力します。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
キューブビューの削除
キューブ・ビューを削除するには、キューブ・ビューの削除 コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | 削除するキューブの名前を入力します。 |
| 名前を見る | 削除するビューの名前を入力します。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
プロセスの削除
TM1 でプロセスを削除するには、Delete a process コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| プロセス名 | プロセス名を入力する。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
雑用を実行する
TM1で家事を実行するには、家事の実行 コマンドを使用します。
注： 手動で家事を実行するには、その家事をアクティブにしないでください。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | 実行する家事の名前を入力する。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
プロセスを実行する
TM1 でプロセスを実行するには、Execute a process コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| プロセス名 | 実行するプロセス名を入力する。 |
| プロセスパラメータ | プロセスを実行するパラメータを入力する。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
| 10 | エラー | 無効なパラメータ |
| 53 | エラー | プロセスの実行に失敗しました |
| 55 | エラー | プロセスの実行に失敗しました |
MDXの実行
多次元式（MDX）関数を実行して CSV にエクスポートするには、Execute MDX コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| MDX関数 | 実行する MDX 関数を入力します。 |
| 出力タイプ | 生成されるCSVファイルの形式を選択します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| セルデータ | ファイル |
| セルセットID | 文字列 |
| 処理された細胞総数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
メッセージログをフィルタリングする
サーバーのメッセージ・ログを一覧表示するには、Filter message logs コマンドを使用する。
プロパティ
| プロパティ | 詳細 |
|---|---|
| 開始日 | ログの開始日フィルタを入力します。 |
| 終了日 | ログの終了日フィルタを入力します。 |
| 最高成績 | 取得するログエントリーの最大数を入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| ログファイル | ファイル |
| ログエントリー数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
トランザクションログのフィルタリング
サーバーのトランザクション・ログを一覧表示するには、Filter transaction logs コマンドを使用する。
プロパティ
| プロパティ | 詳細 |
|---|---|
| 開始日 | ログの開始日フィルタを入力します。 |
| 終了日 | ログの終了日フィルタを入力します。 |
| 最高成績 | 取得するログエントリーの最大数を入力します。 |
| キューブ・フィルター | トランザクション・ログを取得するキューブのフィルタ条件を入力します。 |
| ユーザーフィルター | トランザクションログを取得するユーザーのフィルタ条件を入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| ログファイル | ファイル |
| ログエントリー数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
プロセスエラーログの取得
プロセス・エラー・ログのZIPファイルを取得するには、Get process error logs コマンドを使用する。
プロパティ
| プロパティ | 詳細 |
|---|---|
| 開始日 | ログの開始日フィルタを入力します。 |
| 終了日 | ログの終了日フィルタを入力します。 |
| プロセス名 | プロセス名を入力する。 |
出力
| 出力 | 出力タイプ |
|---|---|
| ジップ・ログ | ファイル |
| ログファイル数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
家事タスクのリスト
家事で利用可能なタスクをリストアップするには、List chore tasks コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | タスクをリストアップする家事の名前を入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| コア・タスク・ステップ | 配列 |
| 雑用タスク数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
家事リスト
利用可能な雑用をリストアップするには、List chores コマンドを使用する。
プロパティ
なし
出力
| 出力 | 出力タイプ |
|---|---|
| 雑用名 | 配列 |
| 家事アクティブ設定 | 配列 |
| 家事カウント | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
キューブ寸法のリスト
キューブのディメンジョンをリストするには、List cube dimensions コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | 寸法をリストするキューブの名前を入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| ディメンション名 | 配列 |
| 次元固有の名前 | 配列 |
| 寸法数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
リストキューブビュー
キューブのビューをリストするには、List cube views コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | ビューをリストするキューブの名前を入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| 名前を見る | 配列 |
| カウントを見る | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
リストキューブ
キューブをリストするには、List cubes コマンドを使用する。
プロパティ
なし
出力
| 出力 | 出力タイプ |
|---|---|
| キューブ名 | 配列 |
| キューブ数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
プロセス一覧
利用可能なプロセスを一覧表示するには、List processes コマンドを使用する。
プロパティ
なし
出力
| 出力 | 出力タイプ |
|---|---|
| プロセス名 | 配列 |
| プロセス数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
ユーザー一覧
TM1 サーバー上のユーザーを一覧表示するには、List users コマンドを使用します。
プロパティ
なし
出力
| 出力 | 出力タイプ |
|---|---|
| ユーザー固有名 | 配列 |
| ユーザー名 | 配列 |
| ユーザータイプ | 配列 |
| ユーザー使用可能 | 配列 |
| ユーザー活動 | 配列 |
| ユーザー数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
セルを読む
ビュー内のすべてのセル値のヘッダーとして階層を持つCSVを生成するには、Read view cells コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | キューブの名前を入力します。 |
| 名前を見る | ビューの名前を入力します。 |
| 出力タイプ | 生成されるCSVファイルの形式を選択します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| データを見る | ファイル |
| コールセットID | 文字列 |
| 処理された細胞総数 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
雑用タスクパラメータの更新
指定された家事タスクに設定されたパラメータを変更するには、家事タスクパラメータの更新 コマンドを使用します。
プロパティ
| プロパティ | 詳細 |
|---|---|
| コアー名 | 家事の名前を入力する。 |
| タスク番号 | パラメータを更新するタスクの番号を入力する。 |
| パラメータ | タスクの新しいパラメータ値を入力する。 |
出力
なし
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
| 10 | エラー | 無効な雑用タスクパラメータ |
| 13 | エラー | 指定された雑用タスクにはパラメータがありません。 |
| 17 | エラー | 家事にはアクティブなスケジュールがある |
立方体のセルを書く
キューブに値を書き込むには、Write cube cells コマンドを使用します。このコマンドには、カンマ区切りの値（CSV）ファイルが必要です：
- ヘッダーとしての階層一意名
- キューブに書き込む値を含む列ヘッダの Value
プロパティ
| プロパティ | 詳細 |
|---|---|
| キューブ名 | キューブの名前を入力します。 |
| ファイル形式 | CSVファイルの形式を選択します。 |
| CSVファイル | CSVソースファイルを入力します。 |
出力
| 出力 | 出力タイプ |
|---|---|
| セル数更新 | 整数 |
| セルの書き込み失敗 | 整数 |
終了コード
| コード | タイプ | 詳細 |
|---|---|---|
| 0 | 成功 | 成功 |
| 1 | エラー | 無効な引数 |
| 2 | エラー | TM1との通信に失敗しました |
| 3 | エラー | コマンドの実行に失敗 |
| 16 | エラー | キューブへの書き込みに失敗したセルがある |