Maximo Programming

- All your base are belong to MAXIMO - Yasutaka Nishimura [email protected] IBM Maximo Asset Managementの技術情報を中心にEAM, RCMなどの情報を紹介します。 このサイトの掲載内容は私自身の見解であり、必ずしも会社の立場、戦略、意見を代表するものではありません。

[maximopro]

3桁区切り数字を4桁に変換する [Maximo]

Maximoの数値フィールドは基本的に欧米と同じ3桁区切りで表示されるのがデフォルトです。こちらはロケールを変更しても変わりません。

慣れの問題ではありますし、基本的に企業のシステムであれば問題になることは少ないと思います。ただし金額など、慣れ親しんだ4桁区切りの方が直感的に分かりやすいということはあると思います。今回は4桁区切り表示の方法について解説します。

まず4桁区切り数字を表示するための属性を追加します。当然ながら漢字が入る場合は数値型ではなく文字列型になります。従って、数値属性から非永続の文字列型属性へ変換した値を格納し、それを表示することにします。では対象の属性 (今回はPURCHASEPRICE) に対する非永続属性をASSETに追加します。

追加後はデータベースの構成変更を行ってください。分からない方は過去の記事を参考にしてください。次に自動化スクリプトを作成します。今回は特に特定の属性に限ったスクリプトではないのでスクリプトから作成します。自動化スクリプトのオプション・メニューからウィザードを起動します。

以下のように値を埋めます。バインディング値は後から変更するので適当な値を入力します。

スクリプトはこちらになります。ダウンロードはGitHub Gistから可能です。スクリプトは数値を4桁毎に分割し、それぞれの桁に対して単位を挿入し、対象の非永続属性へ保存します。

convert_to_kanji.py

GitHub Gist: instantly share code, notes, and snippets.

次に属性起動ポイントを作成します。上と同様に自動化スクリプトから作成します。イベントは値の初期化です。非永続属性は値を入力しても保存されないため、属性が読み取られるときに値を入力します。

次へを進むとバインディング値の設定になります。「グローバル・バインディング値」はこのスクリプトのデフォルト値です。「起動ポイントのバインディング値」はこの起動ポイント固有の値を設定できます。起動ポイント毎にリテラル・データを変更したい場合はこちらに値を埋めます。dest_attrには保存先の属性を入力します。

src_attrには数値変換元の属性を入力します。

起動ポイントを作成すれば完了です。表示が可能になっているか確認します。アプリケーション・デザイナーでASSETに対して上記で追加したデータのテキスト・フィールドを追加します。以下のように表示されれば良いでしょう。

価格を表示するためであれば最後に「円」をつけるのも良いでしょうし、逆変換を実装して表示だけではなく入力も可能にすると面白いと思います。

[maximopro]

Maximo Manage 8でログやファイル名が文字化けする場合の対応方法

MAS および Maximo ManageでPodの日本語のログやファイル名などが???などで表示されてしまう場合があります。この場合、以下の方法で修正することができます 1. OpenShiftコンソールにログインする

2. 右のメニューから Administration > CustomResourceDefinitions を開く

3. ManageWorkspaceを開く

4. Instancesタブを開き対象のインスタンスを選択する

5. YAML タブを開き serverBundles: を検索

6. すべてのバンドルに jvmOptions: '-Dfile.encoding=UTF-8' を追加または既存のjvmOptionsを編集

7. Podsの更新が始まるのですべて終わるまで待機 これで文字化けが解消されます。

[maximopro]

Maximo Manage 8 におけるKafkaキュー処理のアップデート

以前の記事でMaximoにおけるKafka キューの構成方法を掲載しましたが、Maximo Manage 8で一部変更が入っています。

https://maximopro.tumblr.com/post/643078893011697664/apache-kafka%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%97%E3%81%9Fmaximo%E7%B6%99%E7%B6%9A%E3%82%AD%E3%83%A5%E3%83%BC-%E8%A8%AD%E5%AE%9A%E6%96%B9%E6%B3%95

最後のバランスさせる方法の項ですが、7.6.1.2で有効だったプロパティは無効になり、代わりにMAXQUEUEオブジェクトに新しくMULTIPARTという属性が追加され、そちらで制御されます。以前はシステム全体でのみ有効無効が制御されていましたが、キューごとに構成できるようになりました。

外部システムの設定ではデフォルトでは表示されていないので、自分で追加する必要があります。

[maximopro]

画面XMLや自動化スクリプトの履歴を保存する

単純ですが開発時に非常に役に立つtipsを紹介します。画面XMLや自動化スクリプトの管理は外部のSCMやファイルサーバーなどで行われることが多いと思います。そのためバックアップの取得などは手動になるため管理が煩雑になる場合が多いかと思います。Maximoには「監査」という機能があり、保存時に自動的に別テーブルへ履歴を残すことが可能です。

画面XMLの自動履歴保存を有効にする手順 データベース構成より詳細検索をクリックしてオブジェクトに”MAXPRESENTATION”を入力して内部？の値をクリアします。

MAXPRESENTATIONを開いて監査の項目をチェックします。

属性タブを開いてPRESENTATIONに対して監査の有効化をチェックします。

後は管理モードに入りデータベースの構成を完了させれば有効になります。これ以降は”A_MAXPRESENTATION“に履歴が自動的に残るようになります。

自動化スクリプトの自動履歴保存を有効にする手順 データベース構成より詳細検索をクリックしてオブジェクトに”AUTOSCRIPT”を入力して内部？の値をクリアします。

AUTOSCRIPTを開いて監査の項目をチェックします。

属性タブを開いてSOURCE, COMMENTに対して監査の有効化をチェックします。ここでコメントの履歴を有効にすることでコミットログのように変更に対するコメントを入力できるようになります。

後は管理モードに入りデータベースの構成を完了させれば有効になります。これ以降は”A_AUTOSCRIPT“に履歴が自動的に残るようになります。

参考: https://www.keegosysit.com/audit-tracking-in-maximo-by-keegosys/

[maximopro]

OAuth2のリソースを自動化スクリプトのエンドポイントを使ってアクセスする

IBM Maximo CommunityにてOAuthハンドラーについての質問が挙がっていました。標準のOAuthエンドポイントはOAuth 1プロトコルのみサポートしており、かつOSLCアプリケーションからのみアクセスできるようです。Maximo 7.6.1.2ではE-mail リスナーでOAuth2のサポートが追加されています。こちらはGMailなどの認証に使われるもので統合IF (MIF) で使われることは想定していないようです。MIFでOAuth2リソースにアクセスするには自前で実装する必要があります。

OAuth2 認証フロー

OAuth2にはフロート呼ばれるいくつかの認証プロトコルが規定されています。こちらのサイトにはOAuth2 フローが解説されています。どのフローをサポートすべきかはどのフローがアクセスしたいリソースで提供されているかに依ります。例えば、GmailなどのGoogle APIではAuthorization code flowが提供されています。また、Microsoft Identity platformではサーバー間やデバイス・サーバー間で主に使用されるClient credential flowがサポートされています。本記事では多くのサービスで提供されている Authorization code flow の リフレッシュ・トークン・フローを実装してみたいと思います。

自動化スクリプトを使ったエンドポイント

OAuth2プロトコルではHTTPアクセスの際にリフレッシュ・トークン・フローによってトークンを取得する必要があります。これを自動化スクリプトを使ったエンドポイントを利用して標準のHTTPHandlerの実行前にスクリプトを挟み込む形で実装します。自動化スクリプトを使ったエンドポイントの実装はこちらのブログが参考になります。エンドポイントの定義にはハンドラー定義にScriptRouteHandlerを追加し、それを指定したエンドポイントのプロパティに自動化スクリプト名を入力します。スクリプトではrequestDataとresponseDataという特別な変数が定義されており、それぞれエンドポイントがMaximoから受け取るデータと返すデータに該当します。エンタープライズ・サービスなどからデータをこのエンドポイントにデータを送信すると、requestDataにはXMLのバイト列が入力されます。自動化スクリプトではエンドポイントを呼び出すことができますので、この要求・応答を使って標準のHTTPhandlerに流し込むことが可能です。

実装方法

OAuth2を実装するには以下の3つが必要になります。

OAuth2のClient IDとRefresh Tokenを格納するテーブル

Refresh token flowを実行する自動化スクリプト

自動化スクリプトのHTTPエンドポイント

エンドポイントには静的な情報のみ入力できるので、リクエストごとに認証情報をキャッシュしておくようなテーブルが必要になります。OAuth2のアクセス・トークンとそのリフレッシュ・トークンは変更される可能性があるため、エンドポイントのプロパティーに格納しておくことはできません。

まずはテーブルを定義しましょう。

属性定義は以下になります。アクセストークンは期限 (EXPIREAT) が切れるまで再利用されます。

次に自動化スクリプトの実装になります。

スクリプトはこちらです。

https://gist.github.com/nishi2go/e7f97032eaac2d741c4526aa4c99829a

最後に、自動化スクリプトの定義になります。上記で作成したスクリプト名をSCRIPTプロパティーにセットしてください。ハンドラーの作成はこちらを参考にしてください。

テスト

自動化スクリプトで呼び出す先のエンドポイントを作成します。以下の例ではMaximoのPingサービスにアクセスします。

OAuth2のフローをテストするにはOAuth Toolsを使用します。以下のようにAuthorization codeを取得します。

こちらのコードを上記で作成したテーブルに入力します。テーブル入力はSQLで直接書き込むか、カスタムアプリを作成します。以下はカスタムアプリの例です。

実際に実行した結果はこちらになります。OAuth Toolsにより取得されたアクセストークンはログに出力されています。フローでエラーが出ている場合は何らかのエラーメッセージが表示されているはずです。

今回は自動化スクリプトを使ってOAuth2リソースにアクセスできるエンドポイントの作成方法について解説しました。この他にも特殊なアクセス方法を要求するHTTPリソースなどにも応用できると思います。

[maximopro]

Maximo ManageをRed Hat CodeReady Containersに導入する

Maximo Application Suite (MAS) 8.4がリリースされ、ついにMaximo Manage (旧Maximo Asset Management)もKubernetes環境で動作するようになりました。しかし、MASの動作要件は厳しく、容易に個人のPCに入れられるものではありません。環境見積もりを計算するシートが公開されていますが、Maximo Manageの最小構成でも16 CPU, 128GBメモリーが要求されています。これでは個人の環境で開発・デモ目的でインストールすることは厳しいので、スタンドアローンのOpenShift環境であるCodeReady Containerを使ってインストールに挑戦してみたいと思います。

* MASのCodeReady Containersでの動作を保証するものではありません。導入にあたってはOCP/Kubernetesの知識が前提となります。

Red Hat CodeReady Containersは開発・デモ目的で利用できるOpenShift (OCP) のディストリビューションです。以前はminishiftという仕組みで提供されていましたが、OCP 4からはCRCに変わっています。CRCは4 CPU, 9 GBで動作します。

CRCのインストールガイドはこちらです。CRCはWindows, Mac, Linuxで動作します。MASはOCP 4.6までサポートされていますので、それが含まれるCRC 1.22.0をローカルのUbuntuマシンにインストールします。デフォルトの構成ではMASを入れるには心もとないため、6 CPU、32GBで構成します。ラップトップで動作させるにはギリギリの線になります。CRCのセットアップ時のログは以下になります。

https://gist.github.com/nishi2go/0d34ae4a365a3549263965c655a032ad

これで https://console-openshift-console.apps-crc.testing/ からOCP Consoleにアクセスできるはずです。

次にMASのインストールに必要な前提サービスを導入します。これらのサービスはMASを導入するOCPの外に導入しても構いません。注意点としてはCRCはデフォルトでストレージ・クラスを提供していません。従って、サービス導入にあたってReadWriteOnce用にlocal-pathを、ReadWriteMany用にnfsを導入します。もし、CRCではなくCloud環境に導入する場合は、それぞれが提供しているストレージ・クラスを利用するのがおすすめです。

必要な前提サービスを導入するにあたって、IBMのドキュメントでは詳細な導入手順を提供していません。これでは不便なので、集めた情報をこちらのGitHubで公開しています。こちらでは前提サービスを一気にインストールできるスクリプトも公開しています。こちらのスクリプトを実行するために必要なEntitlement Keyはこちらから取得してください。

https://gist.github.com/nishi2go/fb2425ebe6f4c63f9d55ef315b876e33

次にMASを導入します。こちらは特にエラーなく、スムーズに導入できると思います。ドメイン名にはapps-crc.testingを指定してください。CRCはこちらのドメインをすべてCRCのVMに流すように構成してくれます。

https://gist.github.com/nishi2go/712bc23cbfc4c9cf85c967f8f1faf2b1

初期セットアップを実行します。初期セットアップに必要な情報は先程の前提サービスの導入スクリプトで取得することができます。

https://gist.github.com/nishi2go/5c3b7dfc754a4188392a8e102e509957

初期セットアップはhttps://admin.apps-crc.testing/initialsetupから行うことができます。自己署名のSSLを利用している場合は先にhttps://api.apps-crc.testing/にアクセスする必要があります（404が表示されますが気にしなくて大丈夫です）。

こちらに関してはYouTubeに動画があがっているので参考になると思います。初期セットアップが完了しない場合は何らかのプロセスで構成が失敗している可能性があります。

これでMaximo Manageを導入することができるようになりました。こちらの動画を参考に導入できると思います。当初CP4D上のDb2 Warehouseを導入しようとしましたが、リソース不足で断念しました。Maximo Manageだけで2 CPUを消費し、CP4Dも3 CPU以上を消費しますので、導入するには10 core以上、64GB以上の環境が必要になると思います。私の環境ではローカルにDb2を導入することでこの問題を回避しています。

注意点は2点ほどあります。

MASではMongoDBが非常に重要なコンポーネントになります。SLSや初期セットアップなどでたびたびMongoDBの接続エラーが発生しました。その場合、Podのrestartで問題は解消しました。しかし、こちらが止まるとMASの認証などに影響を与えるため、外部のマネージド・サービスを利用できるならそちらを使用したほうが良いと思います。

次にリソース不足によってCRCの再起動が難しいことです。Kubernetesのスケジューラーはラップトップで動くことを前提にしていないため、クラスター立ち上げ時に一気にPodが起動してしまいリソース不足によってPod起動エラーが生じて再起動を繰り返すという現象に見舞われました。やはり再起動を繰り返すような仕組みではないため、VMのサスペンド機能を使って一時停止することをおすすめします。その場合、データベースとのコネクションが切れてしまいManageにアクセスできなくなるので、以下のコマンドでManageのみ再起動を行います。

https://gist.github.com/nishi2go/d110b816ede47ce4e94e15e715f60f2e

解説は以上です。手元の環境で動作させることはできましたが、課題は多いと思います。手軽に試せる環境が簡単に提供されるようになることを祈ります。

[maximopro]

ダイアログボックスで自動化スクリプトを実行する方法

Maximoのアプリケーションではメインのフォームの他にダイアログボックスを作成することができます。しかし、ダイアログボックスで何らかのコードを実行させるにはJavaカスタマイズが必要でした。JavaカスタマイズはMaximoで最も自由度の高いツールですが、EARの再デプロイなど開発の複雑さが難点となります。Maximo V7.6.1以降では、自動化スクリプトの機能拡張によりダイアログボックスでのコード実行がより簡単になりました。

ダイアログボックスの基本

ダイアログボックスとはメインの画面とは別にユーザーの入力を促すウィンドウのことを指します。Maximoでダイアログボックスを作成するにはアプリケーションXMLを直接編集する必要があります。XMLをインポートした後には、アプリケーション・デザイナーによりGUIから変更可能です。アプリケーションXMLをダウンロードし以下のようなダイアログボックスを追加します。

<dialog id="dialog_sample" label="Sample dialog box" datasrc="MAINRECORD" savemode="ONUNLOAD"> <section id="dialog_sample_section" /> <buttongroup id="dialog_sample_btngrp"> <pushbutton default="true" id="dialog_sample_btn1" label="OK" mxevent="dialogok"/> <pushbutton id="dialog_sample_btn2" label="Cancel" mxevent="dialogcancel"/> </buttongroup> </dialog>

インポート後にアプリケーション・デザイナーで上記のダイアログボックスを開くと、以下のように表示されるはずです。

XMLのdialog要素に使用される属性を簡単に説明します。ダイアログボックスの範囲で指定されるオブジェクト(レコード)はdatasrc、relationshipのどちらかに入力します。

属性名 説明 id ダイアログのID。すべての要素でユニークにする必要があります。 label ダイアログのタイトル。 datasrc 値にMAINRECORDと指定することでアプリケーションで選択中のレコードがダイアログに指定されます。 relationship 値に関係名を指定することで、呼び出し元から関係を元にレコードが検索されダイアログに指定される。関係名はデータベースの構成アプリケーションで追加可能です。 savemode ダイアログを開くとき閉じるときにレコードを保存します。ONLOADの場合開いたときに、UNLOADの場合閉じたときに、ONUNLOADの場合、両方のときに保存されます。 beanclass Javaカスタマイズのみ有効です。psdi.webclient.system.beans.DataBeanを継承してexecute()をオーバーライドしたクラスを指定します。

ボタングループのmxeventにdialogokとdialogcancelがそれぞれ指定されていることに気づくかと思います。dialogokの場合はsavemodeやBeanクラスのexecute()などが実行されますが、dialogcancelの場合は実行されずにダイアログが閉じます。dialogcloseとdialogcancelは多少の差はあれど、効果は同じです。

作成したダイアログボックスをアプリケーションで表示するためには、プッシュボタンか署名オプションの設定が必要です。プッシュボタンの場合、アプリケーションの任意の場所にmxevent="dialogboxのID"を設定したボタンを作成するだけで呼び出すことができます。

署名オプションを設定すれば、アクションの選択メニューまたはツールバーから呼び出すことが可能です。以下のようにダイアログボックスのIDと同じ署名オプションをアプリケーション・デザイナーから追加します。アクションの選択メニューに表示したい場合は、同じくアプリケーション・デザイナーより追加できます。署名オプションを有効化するには、セキュリティ・グループより行うことができます。

非永続オブジェクトを使用してダイアログの実行時に自動化スクリプトを実行する方法

非永続オブジェクトにオブジェクト起動の自動化スクリプトを作成することで、ダイアログを開いたときまたは閉じたときにスクリプトを実行させることができます。ダイアログを開いたときにスクリプトを実行するにはオブジェクト起動で値の初期化イベントを指定します。閉じるときは同様にオブジェクト起動の保存時を指定します。それぞれBeanクラスでは前者がsetup()、後者がexecute()に相当します。

では例として、作業指示書の複数の資産、ロケーション、CIにある進捗のマーク付けをすべて一括でチェックするダイアログを作成したいと思います。まずは以下のようにデータベースの構成アプリケーションより、非永続のオブジェクトを作成します。こちらが自動化スクリプトの対象となります。

属性の例はこちらです。CLEARがtrueのときは進捗マーク付けをすべてクリアします。

自動化スクリプトを作成します。自動化スクリプト・アプリケーションのアクションの選択メニューから作成 > オブジェクト起動ポイントを選択します。

スクリプト名とスクリプト言語をjython(python)に指定して次へ進みます。

スクリプトの内容を以下のように作成し、保存します。

mbo = mboset.getMbo(0) value = not mbo.getBoolean('clear') malcset = mbo.getOwner().getMboSet('MULTIASSETLOCCI') malc = malcset.moveFirst() while malc is not None: malc.setValue('progress', value) malc = malcset.moveNext()

最後にダイアログボックスをアプリケーションに追加します。以下のXMLをWOTRACKアプリケーションに追加してインポートします。

<dialog id="dialogactnp" label="Dialog action NP" relationship="DIALOGACTNP" savemode="ONUNLOAD"> <section id="dialogactnp_sec"> <statictext align="left" id="dialogactnp_1" label="Update all progress in MULTIASSETLOCCI"/> <checkbox dataattribute="clear" id="dialogactnp_2"/> </section> <buttongroup id="dialogactnp_btngrp"> <pushbutton default="true" id="dialogactnp_btn1" label="OK" mxevent="dialogok"/> <pushbutton id="dialogactnp_btn2" label="Cancel" mxevent="dialogcancel"/> </buttongroup> </dialog>

最後に署名オプション等の追加を行い、正しく設定できた場合、以下のように実行可能になります。

アクションを使用してダイアログの実行時に自動化スクリプトを実行する方法

永続オブジェクトが対象になる場合や、CLEARなどのオプションが不要な場合はアクション起動ポイントからスクリプトを実行することができます。こちらの方法はアクション起動ポイントの自動化スクリプトを作成し、アクションをプッシュボタンに割り当てます。スクリプト内でservice.closeDialog()を実行することによってダイアログを閉じます。これで上記で行った方法と同様に自動化スクリプトを実行することができます。

上記の例と同様に進捗のマーク付けを一括チェックするスクリプトを作成します。今回は非永続オブジェクトの作成は不要です。その代わり値は常にtrueで埋めることになります。自動化スクリプトを、自動化スクリプト・アプリケーションのアクションの選択メニューから作成 > アクション起動ポイントを選択します。

スクリプト名とスクリプト言語をjython(python)に指定して次へ進みます。スクリプトの内容を以下のように作成し、保存します。

malcset = mbo.getMboSet('MULTIASSETLOCCI') malc = malcset.moveFist() while malc is not None: malc.setValue('progress', 1) malc = malcset.moveNext() service.closeDialog()

最後にダイアログボックスをアプリケーションに追加します。以下のXMLをWOTRACKアプリケーションに追加してインポートします。

<dialog id="dialogact1" label="Dialog action" datasrc="MAINRECORD" savemode="ONUNLOAD"> <section id="dialogact1_sec"> <statictext align="left" id="dialogact1_1" label="Update all progress in MULTIASSETLOCCI"/> </section> <buttongroup id="dialogact1_btngrp"> <pushbutton default="true" id="dialogact1_btn1" label="OK" mxevent="DIALOGACT"/> <pushbutton id="dialogact1_btn2" label="Cancel" mxevent="dialogcancel"/> </buttongroup> </dialog>

次にプッシュボタンに割り当てたアクションを有効にするために署名オプションを追加します。アクション名と同じオプション名を指定し、高度な署名オプションで以下のように選択することでこのアプリケーション内でアクションが有効になります。

最後にアクションの選択メニュー等の追加を行い、正しく設定できた場合、以下のように実行可能になります。

最後に

ダイアログボックスでのコード実行は最後までJavaカスタマイズが必要とされる部分でしたが、V7.6.1からは自動化スクリプトの大幅な機能拡張により実現が可能になりました。自動化スクリプトのservice.webclientsession()ではより高度なUI操作も可能です。自動化スクリプトで実装することで、すべての構成をデータベースに一元化することもでき、ロジック変更時の可用性も上がります。今までダイアログを実装してこなかった方にもおすすめです。

[maximopro]

Apache Kafkaを使用したMaximo継続キュー 設定方法

Apache Kafkaに正式対応したMaximo V7.6.1.2

Maximo V7.6.1.2ではJMSキューの代わりにApache Kafkaをメッセージプロバイダーとして利用することができるようになりました。これによって外部システムからのKafka Topicの入出力や連続キュー・継続キューでKafkaが選択できます。

https://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.1.2/com.ibm.mif.doc/providers/c_mssg_providers_op.html

MaximoにはKafkaのBrokerは付属していないため、別途外部に用意する必要があります。AWS, Azure, IBM Cloudなどのマネージドサービスを利用するか、オンプレミスに自前で立てる必要があります。Kafkaを採用する利点としては、スケールアウトが容易であること、Java EEの複雑な構成(web.xmlなど)が不要で構成が簡単、OSSのサポートツールが充実していることなどが挙げられます。特にMaximo Application Suiteで提供される予定のMaximo Manageではこちらの方式が主流になるのではないかと思われます。MASにはKafka Operatorが標準で組み込まれています。

https://www.ibm.com/support/knowledgecenter/SSRHPA_current/appsuite/admin/manage_configuration.html

Apache Kafkaのキュー処理の仕組み

Kafkaキュー (Topic) を使って正しくスケールさせるには、Kafkaの仕組みを理解することが重要です。Kafkaには入出力が分離されており入力はProducer, 出力側はConsumerが処理します。キューの処理はBrokerが担当します。Topicにはパーティションが区切られており、Brokerはそれぞれのパーティションを担当します。パーティションを複数個用意することでスケールアウトを実現します。ProducerはBrokerのパーティション情報を取得して、メッセージをどのパーティションに送信するか決定します。Consumerはそれぞれのパーティションに１つ割り当てられ、処理します。従ってConsumerは最低でもパーティションの数だけ用意しなければ正しく処理されません。

MaximoでKafkaを使うための知識としてはこれで十分です。キューの構成はKafka上で行う必要があるので、継続キューと連続キューの追加はあらかじめ行っておきます。こちらは各サービスのガイドを参照するといいでしょう。

MaximoのKafka キュー設定のアーキテクチャ

MaximoのKafka設定はJMSとほぼ同等です。JMSとの違いはJava EEではなくKafka独自の仕組みによって構成されることです。Maximo Integration Framework (MIF)を使う場合には、エンドユーザーはKafkaかJMSかを意識することなく利用することができます。Web ServicesもしくはEnterprise Servicesのesqueueからキューへ送信することが可能です。Kafka ConsumerはCron taskで実装されています。構成をKafkaのアーキテクチャを当てはめると以下のようになります。

構成での注意点はConsumerです。パーティションとレプリケーションの数によって用意するConsumerの数が変わります。従って、キューを処理するのに必要な数のCron taskインスタンスを作成しなければ、意図通りの性能を出すことはできません。パーティションとConsumerの数はどのような性能を目標とするかによって変わります。重要なことはConsumerはProducerやBrokerよりも常に遅いということです。秒間でどれほどの数のメッセージを処理したいかによって並列度がきまり、それによってパーティションとBrokerの数が決定されます。また、継続キューの場合でもCron taskで実行されるため、MIFクラスターではなくCron taskクラスターの数の調整が必要になります。それらを意識してベンチマークすると良いでしょう。

Kafkaキューの設定方法

具体的にKafkaを構成していきます。まず外部システムのメッセージ・プロバイダーにKafkaを追加します。「外部システム」の「メッセージプロバイダーの追加・変更」より設定を行います。セキュリティ設定は使用しているサービスや構成に従います。

次にキューの登録を行います。こちらは「外部システム」の「キューの追加・変更」から設定を行います。キューが選択できない場合は、Kafkaへの接続が失敗しているか、キューが登録されていません。Kafkaの設定を再確認してください。

保持期間などの詳細はKnoledge Centerを参照してください。

https://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.1.2/com.ibm.mif.doc/extsystem/t_add_kafka_queues_ext_sys_op.html

今回は外部システムに「KAFKA」を登録してエンタープライズ・サービスにMXASSETInterfaceを継続キューを有効にして登録します。

最後のCron taskを設定します。「クーロン・タスク・セットアップ」からKafkaを選択し、継続キュー用のインスタンスを追加します。プロパティーのMESSAGEHUBに上記で追加したプロバイダー名を、TOPICに継続キュー(cqin)のKafka トピックを指定します。同様の設定を行ったインスタンスをパーティションの数以上に追加します。

以下のようにKafka側でConsumerが登録されていれば大丈夫です。

外部システムのesqueueを使ってキューへ送信することができます。もちろんKafkaのクライアントから直接インプットすることもできます。

https://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.0/com.ibm.mt.doc/gp_intfrmwk/c_cluster_message_processing.html

https://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.1.2/com.ibm.mif.doc/kafka/c_mssg_processing_kafka_op.html

エンタープライズ・サービスで各パーティションへバランスする方法

ここまで設定が終わった段階で、エンタープライズ・サービスに入力したメッセージがうまくパーティションにバランスされていないことがわかると思います。これはMaixmoがデフォルトでKafkaに送信するメッセージに “key“ を付与しているためです。Keyは 「<外部システム>~<エンタープライズ・サービス>」で設定されています。送信されるパーティションはkeyのhashから計算されるため、一つのパーティションに偏ってしまいます。調べたところ、Maximoのキー設定の箇所でプロパティ mxe.int.kafkausenullkey を参照していることがわかりました。こちらを有効にすることでkeyが設定されず各パーティションにバランスされることが確認できました。この設定は特にドキュメントされていませんので、取り扱いには注意してください。

終わりに

今回は新しく追加されたKafkaの設定方法について解説しました。次世代のMaximoではKafkaがメッセージプロバイダーの主流になる可能性があるため、今から学んでおくのも悪くないと思います。

[maximopro]

MaximoでSlack通知を行う

Maximoでユーザーに通知を行う場合、多くの場合メールが使用されます。また、Twillioを使うことによってSMSへのメッセージ送信も実現できます。最近ではコミュニケーション手段も多様化し、SlackやMicrosoft Teamsなどを使う例も増えています。今回はMaximoからSlackへ通知する方法を実現してみたいと思います。こちらを実装するにあたっての前提として、JMSキューの構成とメールサーバーの設定は完了しているものとします。

MIFを用いたメール・Slack同時送信のイメージ

Maximoでの通知には通信テンプレートを用いた方法が一般的です。こちらはTwillioかメールのみ対応しています。今回は通信ログ機能を使って、Slackへの同時送信を行うように設定します。通信テンプレートよりメール送信する際に、通信ログ・エントリーにチェックがついているとCOMMLOGテーブルに通信履歴が保存されます。こちらに保存されたデータをパブリッシュ・チャネルを用いて外部送信するようにしたいと思います。Slack APIはJSONフォーマットですが、最近のMaximoではREST APIやJSONフォーマットに対する機能が増えているので、なるべく標準の機能を使って実現してみたいと思います。

通信テンプレートからメールが送信されCOMMLOGに保存されます。保存時に自動化スクリプトをつかってSendToからPersonを取得し、Slack IDをCOMMLOGに入力します。COMMLOGからパブリッシュ・チャネルを通じてEventが発行され、JMSキューに保存されます。その時、JSONマッピング機能によってXMLフォーマットからJSONフォーマットへ変換します。エンドポイントに記載されたSlack APIよりHTTPでメッセージがポストされます。

Slack appの作成

MaximoからSlackへメッセージを送信するにあたってAPIキーを作成します。権限はchat:writeがあれば十分です。まず初めにこちら https://api.slack.com/apps?new_app=1 よりSlack appを作成します。

次にScopesより権限を割り当てます。Bot/Userにchat:writeを追加してください。

次にInstall App to WorkspaceボタンよりWorkspaceにアプリをインストールします。

ボタンをクリックするとPermissionを聞かれるので、許可してください。

最後にAPIキーを確認してください。使用するのはBot User OAuth Tokenです。こちらは後にMaximoで使用します。

担当者にSlack IDを割り当て、通信ログに入力する方法

PERSONテーブルとCOMMLOGテーブルにSlack IDを入力する属性を作成します。データベースの構成より以下のように属性を追加します。

COMMLOGにも同様に追加し、構成の適用を行ってください。

次に担当者アプリケーションにアプリケーション・デザイナーよりSlack IDを入力するフィールドを追加します。こちらは通常のテキストボックスでよいでしょう。追加したイメージはこちらです。

最後に自動化スクリプトを設定します。これはCOMMLOGのSENDTOにあるメールアドレスを抽出し、そこから担当者テーブルを検索してSlack IDをCOMMLOGへコピーします。自動化スクリプトの設定は以下のとおりです。

COMMLOG保存時をトリガーにスクリプトを発火します。

Pythonスクリプトを実行するように設定します。

以下のようにコードを入力します。

https://gist.github.com/nishi2go/da23fe21f9ae4debf6e5ce9bb83f180a

スクリプトを保存すれば完了です。

JSON Mappingとパブリッシュチャネルの構成

次にパブリッシュチャネルとJSONマッピングの構成を行います。まず、COMMLOGに対するオブジェクト構造は標準では無いので、こちらを以下のように作成します。

次にパブリッシュチャネルを作成します。先程のCOMMLOGをオブジェクト構造に割り当てます。JSONマッピングを使用する場合には処理クラスに “com.ibm.tivoli.maximo.fdmbo.JSONMapperExit”を指定します。そしてCOMMLOGにSlack IDが入力されている場合のみ発火するように処理ルールを記述します。

処理ルールの条件式は以下のように設定します。

アクションの選択メニューよりリスナーの有効化を実行します。こちらを行わないとパブリッシュチャネルよりJMSキューに保存されません。

次にJSONマッピングの設定です。SlackのAPIでは”channel”フィールドにユーザー名、’text’フィールドにメッセージを入力しHTTP Postで送信します。channelにはCOMMLOGのSlack ID, textにはCOMMLOGのMESSAGEを割り当てます。これで通信ログに書かれた内容を特定のユーザーにメンションできます。JSONマッピングには命名規則があります。パブリッシュ・チャネルで使用するには<外部システム>.<パブリッシュチャネル>.OUTと設定してください。

次にプロパティータブよりマッピングを設定します。前のパネルのJSONデータはいわゆる雛形で実際のデータをどのように割り当てるかはこちらで設定します。

HTTPエンドポイントと外部システムの作成

Slack用のHTTP エンドポイントと外部システムを作成します。エンドポイントではSlack appで作成したOAuthトークンをHTTPヘッダーに入力します。標準フィールドのUSERNAME, PASSWORDは使用できませんので注意してください。HEADERSにはカンマ区切りで複数の値が入力可能です。Content-Typeもここで入力します。

Slackのchat.postmessageの使用はこちら https://api.slack.com/methods/chat.postMessage です。

設定例は以下のとおりです。

次に外部システムを作成します。アウトバウンドの連続キューを設定し、エンドポイントとパブリッシュチャネルを割り当てます。

テスト

実際に送信してみます。作業指示書管理より作成→通信からメールを送信します。

送信が完了すると以下のようにSlackへメッセージが表示されます。RICH TEXTタグを消すにはRich Text機能を無効にしてください。https://www.ibm.com/support/pages/disabling-rich-text-editor-long-description-maximo-76

終わりに

JSONマッピング機能を使ってSlackにメッセージを送信する方法を解説しました。シンプルなRESTであれば自動化スクリプト内でHTTPコールをしなくても実装可能です。その場合、非同期でのメッセージ送信やリトライなど標準のMIFの機能を享受することができます。

[maximopro]

カレンダー・アプリを作成する

Maximoでは標準でカレンダー表示をするアプリケーションがあります。しかしカレンダー表示のコンポーネントはこのアプリでのみ動作し、再利用可能なUIコンポーネントではありません。Maximo Schedulerを使えばより柔軟なガントチャートが使用できますが、より単純なカレンダー表示が必要な場面が多々あります。Google Calendarとの連携することで実現することを模索している例もあります。今回はカレンダー・コンポーネントを使ってカスタム・アプリケーションを構築してみようと思います。

今回のアプリケーションは作業指示書をカレンダー表示します。通常のカレンダーは”CALENDAR“オブジェクトを使用しています。しかし、カレンダー表示するだけであれば非永続オブジェクトで十分です。コンポーネントはCALENDARオブジェクトに特化されているように見えますので、属性などの設定は同じにした新規の非永続オブジェクトを作成します。

次にカレンダーにどのように作業指示書を表示させるかですが、カスタムオブジェクトをそのままカレンダー・コンポーネントで表示させた場合、”getMonthsAvailableHours()“へのアクセスでエラーになります。このメソッドを実装することで表示ができそうです。また、こちらへのアクセスはReflectionを使っているので、CalendarRemoteインターフェースを実装する必要はありません。

MBO クラスの実装は以下のように行いました。２次元配列に月日と表示文字列を格納します。

com.tumblr.maximopro.app.calendar.virtual.WorkCalendar

package com.tumblr.maximopro.app.calendar.virtual; import java.rmi.RemoteException; import java.util.Date; import java.text.SimpleDateFormat; import com.ibm.tivoli.maximo.util.mbo.IterableMboSet; import psdi.mbo.MboRemote; import psdi.mbo.MboSet; import psdi.mbo.MboSetRemote; import psdi.mbo.NonPersistentMbo; import psdi.mbo.NonPersistentMboRemote; import psdi.mbo.SqlFormat; import psdi.server.MXServer; import psdi.util.MXException; public class WorkCalendar extends NonPersistentMbo implements NonPersistentMboRemote { static final String HTML_TEMPLATE = "%s [%s]"; public WorkCalendar(MboSet ms) throws RemoteException, MXException { super(ms); } /** * https://developer.ibm.com/static/site-id/155/maximodev/7609/maximocore/businessobjects/psdi/app/calendar/Calendar.html#getMonthsAvailableHours(com.ibm.icu.util.Calendar) */ public String[][] getMonthsAvailableHours(com.ibm.icu.util.Calendar cal) throws MXException, RemoteException { // Extract year and month from cal. Calendar has only one month per request. final int firstDay = cal.getActualMinimum(com.ibm.icu.util.Calendar.DAY_OF_MONTH); final int lastDay = cal.getActualMaximum(com.ibm.icu.util.Calendar.DAY_OF_MONTH); final com.ibm.icu.util.Calendar start = (com.ibm.icu.util.Calendar)cal.clone(); start.set(com.ibm.icu.util.Calendar.DAY_OF_MONTH, firstDay); final com.ibm.icu.util.Calendar end = (com.ibm.icu.util.Calendar)cal.clone(); end.add(com.ibm.icu.util.Calendar.MONTH, 1); for (com.ibm.icu.util.Calendar c : new com.ibm.icu.util.Calendar[] {start, end}) { c.set(com.ibm.icu.util.Calendar.HOUR, 0); c.set(com.ibm.icu.util.Calendar.MINUTE, 0); c.set(com.ibm.icu.util.Calendar.SECOND, 0); c.set(com.ibm.icu.util.Calendar.MILLISECOND, 0); } final String siteId = getUserInfo().getInsertSite(); final SqlFormat where = new SqlFormat("woclass = 'WORKORDER' and historyflag = 0 and istask = 0 and siteid = :1 and schedstart >= :2 and schedstart < :3"); where.setObject(1, "SITE", "SITEID", siteId); where.setTimestamp(2, start.getTime()); where.setTimestamp(3, end.getTime()); final MboSetRemote mboSet = MXServer.getMXServer().getMboSet("WORKORDER", getUserInfo()); mboSet.setUserWhere(where.format()); mboSet.reset(); // monthsAvailableHours Seems this 2D array has days (1st column) and text data (2nd column). final String[][] monthsAvailableHours = new String[lastDay][2]; for (MboRemote mbo : new IterableMboSet(mboSet)) { Date schedStartDate = mbo.getDate("schedstart"); java.util.Calendar schedStartCal = java.util.Calendar.getInstance(getUserInfo().getTimeZone()); schedStartCal.setTime(schedStartDate); SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm"); String schedStartStr = dateFormat.format(schedStartDate); String wonum = mbo.getString("wonum"); int day = schedStartCal.get(java.util.Calendar.DAY_OF_MONTH) - 1; String curStr = monthsAvailableHours[day][0]; String elm = String.format(HTML_TEMPLATE, wonum, schedStartStr); monthsAvailableHours[day][0] = curStr == null ? elm : curStr + "</br>" + elm; } return monthsAvailableHours; } }

com.tumblr.maximopro.app.calendar.virtual.WorkCalendarSet

package com.tumblr.maximopro.app.calendar.virtual; import java.rmi.RemoteException; import psdi.mbo.Mbo; import psdi.mbo.MboServerInterface; import psdi.mbo.MboSet; import psdi.mbo.NonPersistentMboSet; import psdi.mbo.NonPersistentMboSetRemote; import psdi.util.MXException; public class WorkCalendarSet extends NonPersistentMboSet implements NonPersistentMboSetRemote { public WorkCalendarSet(MboServerInterface ms) throws RemoteException, MXException { super(ms); } @Override protected Mbo getMboInstance(MboSet ms) throws MXException, RemoteException { return new WorkCalendar(ms); } }

こちらのJavaクラスをデプロイして、以下のオブジェクトをデータベースの構成から適用します。設定は以下の通りです。属性はORGID以外にはクラス定義を入れていません。

オブジェクト定義

属性定義

次に画面を作成します。カレンダーコンポーネントではカレンダーに表示されている文字をクリックするとダイアログが表示されますが、days.jspを確認すると”ThisDayWorkPeriods“というIDのダイアログのみ対応しているようです。こちらに作業指示書の一覧を表示させるようにします。その際にイベントから入力された日付から作業指示書を検索するようなBeanクラスが必要になります。”DataBean”の”getMboSetRemote()”をオーバーライドすることでカスタムのオブジェクト検索を行います。

com.tumblr.maximopro.beans.calendar.ViewWorkOrderBean

package com.tumblr.maximopro.beans.calendar; import java.rmi.RemoteException; import java.util.Calendar; import psdi.mbo.MboSetRemote; import psdi.mbo.SqlFormat; import psdi.server.MXServer; import psdi.util.MXException; import psdi.webclient.system.beans.DataBean; public class ViewWorkOrderBean extends DataBean { @Override protected MboSetRemote getMboSetRemote() throws MXException, RemoteException { if (creatingEvent.getValue() instanceof Calendar) { Calendar startDate = (Calendar) creatingEvent.getValue(); Calendar endDate = (Calendar) startDate.clone(); endDate.add(Calendar.DAY_OF_MONTH, 1); for (Calendar c : new Calendar[] {startDate, endDate}) { c.set(Calendar.HOUR, 0); c.set(Calendar.MINUTE, 0); c.set(Calendar.SECOND, 0); c.set(Calendar.MILLISECOND, 0); } MboSetRemote woSet = MXServer.getMXServer().getMboSet("WORKORDER", app.getWebClientSession().getUserInfo()); final SqlFormat where = new SqlFormat("woclass = 'WORKORDER' and historyflag = 0 and istask = 0 and siteid = :1 and schedstart >= :2 and schedstart < :3"); where.setObject(1, "SITE", "SITEID", app.getWebClientSession().getUserInfo().getInsertSite()); where.setTimestamp(2, startDate.getTime()); where.setTimestamp(3, endDate.getTime()); woSet.setUserWhere(where.format()); woSet.reset(); return woSet; } // In Application Designer app, the query results should be null. if(screenDesignMode) { MboSetRemote set = MXServer.getMXServer().getMboSet("WORKORDER", app.getWebClientSession().getUserInfo()); set.setUserWhere("0=1"); set.reset(); return set; } return null; } }

クラスをデプロイした後、アプリケーションを作成します。アプリケーション・デザイナーから以下のようにセルフサービスアプリケーションを作成してください。

次に以下のXMLをインポートします。

<?xml version="1.0" encoding="UTF-8"?> <presentation id="workcals" ismobile="false" mboname="WORKCAL" version="6.0.0"> <page id="mainrec" scroll="false"> <include controltoclone="selfServicePageHeader" id="INCLUDE-selfServicePageHeader"/> <clientarea id="clientarea"> <appbar id="desktopreqs"/> <tabgroup format="carddeck" id="maintabs"> <tab default="true" id="main"> <section id="maintab_section"> <wallcalendar dataattribute="WORKHOURS" dateattribute="WORKDATE" daycellmsgkey="workcal" id="display_wallcalendar"/> </section> </tab> </tabgroup> </clientarea> <include controltoclone="pageFooter" id="INCLUDE-pageFooter"/> </page> <dialog beanclass="com.tumblr.maximopro.beans.calendar.ViewWorkOrderBean" id="ThisDayWorkPeriods" label="Work Orders"> <table id="wo_table" label="Work Orders"> <tablebody displayrowsperpage="50" id="wo_table_tablebody2"> <tablecol dataattribute="wonum" id="wo_table_tablebody_1" inputmode="readonly"> <textbox id="wo_table_tablebody_1_hyper1" menutype="hyperlink"/> </tablecol> <tablecol dataattribute="description" id="wo_table_tablebody_2" inputmode="readonly"/> <tablecol dataattribute="status" id="wo_table_tablebody_3" inputmode="readonly"/> <tablecol dataattribute="statusdate" id="wo_table_tablebody_4" inputmode="readonly"/> <tablecol dataattribute="targstartdate" id="wo_table_tablebody_5" inputmode="readonly"/> <tablecol dataattribute="targcompdate" id="wo_table_tablebody_6" inputmode="readonly"/> <tablecol dataattribute="schedstart" id="wo_table_tablebody_7" inputmode="readonly"/> <tablecol dataattribute="schedfinish" id="wo_table_tablebody_8" inputmode="readonly"/> <tablecol dataattribute="actstart" id="wo_table_tablebody_9" inputmode="readonly"/> <tablecol dataattribute="actfinish" id="wo_table_tablebody_10" inputmode="readonly"/> </tablebody> </table> <buttongroup id="wotable_btns"> <pushbutton default="true" id="wotable_btn_1" label="Close" mxevent="dialogclose"/> </buttongroup> </dialog> <configurationblock id="datastore_configurationblock"> </configurationblock> </presentation>

wallcalendarコンポーネントは表示されるテキストに自動で”hours”と付与されてしまいます。これを回避するためにwallcalendarにdaycellmsgkeyを追加して値をオーバーライドします。メッセージは以下のように追加します。

動作を確認します。以下のように表示されれば完了です。

カレンダーの作成はJavaカスタマイズを必要とするためハードルは高いですが、いちいちGoogle CalendarやOutlookなどにアクセスする必要がないため有用性は大きいと思います。応用としてはダイアログボックス内にカレンダーを表示することでもできると思うので、挑戦してみるのもいいかもしれません。

[maximopro]

自動化スクリプトを使ったクーロン・タスクに引数を渡す方法

Maximoの自動化スクリプトを定期実行するにはいくつかの方法があります。何かのオブジェクト（レコード）を対象にして実行する場合は、アクション起動ポイントを作成してエスカレーションを実行することが簡単です。その他にもオブジェクトに結びつかない用途ではクーロン・タスクを使うことも可能です。クーロン・タスクでスクリプトを直接呼び出す仕組みが用意されていますので、カスタム・クラスをデプロイする必要はありません。

https://www.ibm.com/support/knowledgecenter/SSWT9A_7.6.1/com.ibm.mbs.doc/autoscript/t_cron_task_scripts.html

自動化スクリプトのクーロン・タスクでの問題はスクリプトに渡す引数(SCRIPTARG) が一つのテキストしか指定できないことです。複数の値を渡すための方法を３つ紹介します。

CSVを指定する方法

SCRIPTARGにCSVを入力してPythonでパースします。Pythonの文字列操作関数でsplit()が使えますので、こちらを使うことで複数の値を抽出することができます。ただ、名前付きの変数は使用できませんしリスト型などのハンドリングが容易ではないので、柔軟性はありません。SCRIPTARGはスクリプト内ではargでアクセスできます。

if arg is not None: args = arg.split(',') for option in args: service.log("arg: {}".format(option))

JSONを指定する方法

テキストフィールドにJSONテキストを入力します。Maximo標準の仕組みにserviceクラス (https://developer.ibm.com/static/site-id/155/maximodev/7609/maximocore/businessobjects/com/ibm/tivoli/maximo/script/ScriptService.html) があり、新しいMaximoバージョンではJSONをパースする関数が用意されています。パースされたオブジェクトはJava標準クラスではなくIBMのライブラリになります。詳細はこちらのJavaDoc (https://www.ibm.com/support/knowledgecenter/SSEUEX_3.0.8/com.ibm.javaeuc.doc/com/ibm/json/java/JSONObject.html)を参照してください。

if arg is not None: args = service.tojsonobject(arg) option = args.get('option') service.log('arg: {}'.format(option))

他のレコードのIDを指定する方法

引数の検査をスクリプ実行前に行ったり、入力するGUIを作成したい場合はSCRIPTARGにレコードのユニークIDを指定して以下のように取得します。以下の例ではSCRIPTOPTIONテーブルにOPTIONNUMをユニークIDとしてオプションを取得しています。当然事前にデータベースの構成からテーブルを作成しておく必要があります。

if arg is not None: option_set = service.getMboSet('SCRIPTOPTION', runAsUserInfo) option_set.setUserWhere("optionnum='{}'".format(arg)) option_set.reset() option = option_set.getString('option1') service.log('arg: {}'.format(option))

[maximopro]

Maximoで添付されたCSVファイルをプレビューするダイアログを作成する方法

今回は自動化スクリプトおよびテーラリングの応用として、添付されたCSVファイルをテーブルに展開しプレビューする方法を解説します。

実現にあたって必要なことは以下の通りです。

内容を格納するMBO（テーブル）の作成

CSVファイルを読み込む自動化スクリプトの作成

ダイアログボックスの定義

順に実装していきましょう。まずは内容を格納をするためのMBO定義を作成します。注意しなければならないことは永続MBOを作成するとファイルを開くたびにDBへ行が保存されてしまいます。したがってプレビューする場合は、非永続MBOを使ってメモリのみにデータを展開するようにします。非永続MBOはDBにテーブルを作成せずにMaximoのメモリ上にだけデータを格納します。非永続MBOを使うことによってMaximoアプリケーションからDBテーブルなしにデータへアクセスすることができるようになります。

非永続MBOは以下のように新規オブジェクト作成時に永続（Persistent）のチェックをオフにします。これによってオブジェクト全体が非永続になります。

次に属性の設定です。今回はプレビューということでC1からC20までの20カラムを作成します。残念ながら可変のデータを扱うことは難しいので、必要な数だけ用意してください。属性は以下のようにC20まで定義します。

最後にDOCLINKSオブジェクトからCSVPREVIEWオブジェクトへの関係を定義します。非永続MBOはDBアクセスでデータを取得しないため関係名だけ定義して他は空に設定します。

保存後、データベースの構成変更を行ってください。

自動化スクリプトの設定を行います。非永続MBOも自動化スクリプトを使って操作することが可能です。非永続MBOはデータが空の状態で始まります。データを展開するのは自動化スクリプトの役割です。そのため、起動ポイントはオブジェクトの初期化時に設定します。

しかし、ここで注意が必要になります。自動化スクリプト内でCSVファイルを読み込み、MBOにデータを挿入していきますが、行を挿入するたびに初期化の自動化スクリプトが起動してしまいます。そうなるとスクリプトの呼び出しが無限に続くことになります。これを防ぐには、以下のプロパティを1に設定します。非永続MBOは初期化時に内部でsetupというメソッドが呼び出されます。このプロパティはsetupが呼び出されたときに初期化時にセットした起動ポイントのスクリプトを呼ぶオプションです。これはオブジェクト起動時の1回のみ呼び出されるため、setupから呼び出されたときに処理を開始し、その他のときは処理しないようにすることで無限ループを回避します。設定を変更しLive Refreshをしてください。

自動化スクリプトを作成します。ポイントは2つです。添付ファイルへアクセスするためにFileAttachmentStorage (https://developer.ibm.com/static/site-id/155/maximodev/7609/maximocore/businessobjects/com/ibm/tivoli/maximo/oslc/provider/FileAttachmentStorage.html)を使用します。こちらのgetAttAchment(MboRemote) を使用すればファイルのデータ配列が取得できます。2つ目はCSVをパースする方法です。MaximoのJythonは標準ライブラリを提供していません。標準ライブラリを使用するには外部でライブラリを保存してアクセスしなければなりません（https://www.maximoscripting.com/using-external-libraries-in-jython/）。あとは自前で実装するかJavaライブラリを利用するかになりますが、psdi.app.bim.parser.cobie.CsvInputTokenizer (https://developer.ibm.com/static/site-id/155/maximodev/7609/maximocore/businessobjects/psdi/app/bim/parser/cobie/CsvInputTokenizer.html)がCSVのパーサーとして利用できそうです。今回はこちらを使った実装を試してみます。

以下のように起動ポイントはオブジェクトの初期化で設定します。

作成した自動化スクリプトは以下の通りです。

from java.io import ByteArrayInputStream from com.ibm.tivoli.maximo.oslc.provider import FileAttachmentStorage from psdi.app.bim.parser.cobie import CsvInputTokenizer if onsetup: doclink = mboset.getOwner() if doclink and doclink.getString('urlname').lower().split('.')[-1] == 'csv': # AttachmentStorage can get a byte array of local file. storage = FileAttachmentStorage() buf = storage.getAttachment(doclink) # remove a record because a mbo was inserted automatically by Maximo. mboset.deleteAll() mboset.save() tokenizer = CsvInputTokenizer(ByteArrayInputStream(buf)) row = tokenizer.getRow() try: while row: row_mbo = mboset.addAtEnd() col_index = 1 for col in row[0:20]: # loop until the max column size col_name = "c%d" % col_index row_mbo.setValue(col_name, col[0:20]) # subs to ALN length col_index = col_index + 1 row = tokenizer.getRow() finally: tokenizer.close()

最後にダイアログを設定します。アプリケーション・デザイナーの「システム設定のエクスポート」からLIBRARY.xmlをダウンロードし保存します。以下のダイアログを挿入します。

<dialog id="csv_preview" label="Preview" relationship="CSVPREVIEW"> <table id="csv_preview_table" inputmode="readonly" selectmode="single"> <tablebody displayrowsperpage="20" filterable="false" filterexpanded="true" id="csv_preview_tablebody" witdh="75%"> <tablecol dataattribute="c1" label="1" id="csv_preview_tablebody_col_1"/> <tablecol dataattribute="c2" label="2" id="csv_preview_tablebody_col_2"/> <tablecol dataattribute="c3" label="3" id="csv_preview_tablebody_col_3"/> <tablecol dataattribute="c4" label="4" id="csv_preview_tablebody_col_4"/> <tablecol dataattribute="c5" label="5" id="csv_preview_tablebody_col_5"/> <tablecol dataattribute="c6" label="6" id="csv_preview_tablebody_col_6"/> <tablecol dataattribute="c7" label="7" id="csv_preview_tablebody_col_7"/> <tablecol dataattribute="c8" label="8" id="csv_preview_tablebody_col_8"/> <tablecol dataattribute="c9" label="9" id="csv_preview_tablebody_col_9"/> <tablecol dataattribute="c10" label="10" id="csv_preview_tablebody_col_10"/> <tablecol dataattribute="c11" label="11" id="csv_preview_tablebody_col_11"/> <tablecol dataattribute="c12" label="12" id="csv_preview_tablebody_col_12"/> <tablecol dataattribute="c13" label="13" id="csv_preview_tablebody_col_13"/> <tablecol dataattribute="c14" label="14" id="csv_preview_tablebody_col_14"/> <tablecol dataattribute="c15" label="15" id="csv_preview_tablebody_col_15"/> <tablecol dataattribute="c16" label="16" id="csv_preview_tablebody_col_16"/> <tablecol dataattribute="c17" label="17" id="csv_preview_tablebody_col_17"/> <tablecol dataattribute="c18" label="18" id="csv_preview_tablebody_col_18"/> <tablecol dataattribute="c19" label="19" id="csv_preview_tablebody_col_19"/> <tablecol dataattribute="c20" label="20" id="csv_preview_tablebody_col_20"/> </tablebody> </table> <buttongroup id="csv_preview_buttons"> <pushbutton default="true" id="csv_preview_button_1" label="Close" mxevent="dialogclose"/> </buttongroup> </dialog>

添付ファイルのダイアログからプレビュー・ダイアログを呼び出せるように以下のように変更します。mxeventにダイアログのIDを指定します。

<dialog id="viewattachments" label="View Attachments" savemode="ONLOAD"> <table id="viewattachments_table" inputmode="readonly"> <tablebody id="viewattachments_tablebody"> <tablecol dataattribute="document" id="viewattachments_table_tablebody_4" label="Document" type="openurl" urlattribute="weburl"/> <tablecol dataattribute="docinfo.description" id="viewattachments_table_tablebody_6" label="Description" sortable="false"/> <tablecol dataattribute="doctype" id="viewattachments_table_tablebody_3" label="Document Folder"/> <tablecol dataattribute="docversion" id="viewattachments_table_tablebody_5" label="Document Version"/> <tablecol dataattribute="printthrulink" id="viewattachments_table_tablebody_9" label="Print"/> <tablecol dataattribute="ownertable" id="viewattachments_table_tablebody_1" label="Application"/> <tablecol filterable="false" hidden="false" id="csv_preview_viewattachments_table_tablebody_10" mxevent="csv_preview" mxevent_desc="CSV Preview" mxevent_icon="nav_icon_preview.gif" sortable="false" type="event"/> <tablecol filterable="false" hidden="false" id="viewattachments_table_tablebody_7" mxevent="linkproperties" mxevent_desc="Attachment Properties" mxevent_icon="img_information.gif" sortable="false" type="event"/> <tablecol filterable="false" hidden="false" id="viewattachments_table_tablebody_8" mxevent="instantdelete" mxevent_desc="Delete Row" mxevent_icon="btn_delete.gif" sortable="false" type="event"/> </tablebody> </table> <buttongroup id="viewattachments_2"> <pushbutton default="true" id="viewattachments_2_1" label="OK" mxevent="dialogok"/> </buttongroup> </dialog>

LIBRARY.xmlをアップロードして設定は終わりです。

機能を確認します。以下のサイトからテスト・データを取得し、こちらでテストします。

ファイルをアップロードし、添付ファイル・ダイアログのプレビューボタンを押すとこちらのようにCSVの内容が確認できます。

本記事では添付ファイルのCSVをダイアログにプレビューする方法を解説しました。内容を編集できるようにし保存時にCSVファイルを更新するようにも改変できますし、Excelファイルへの対応やJavaScriptのカスタマイズを使って埋め込みプレビューすることも可能です。添付ファイルへのアクセス方法を覚えて様々な応用を試してみてください。

[maximopro]

KeycloakでMaximoのOpenID Connect SSOを実装する

Maximoで標準サポートされているSingle Sign On (SSO)プロトコルはSAMLです。基本的にはAppServerSecurityと同様でMaximoの内部認証ではなくWeb サーバーの機能を使って認証を行います。WebSphere Application Server (WAS)ではtrust association interceptor (TAI)機能を使って、SAMLのプロトコルを処理しています。

現在主流となっているSSOプロトコルは他にもOpenID Connectがあります。こちらはOAuthをベースに認証プロトコルを拡張したもので、シンプルさから人気が高まっています。Maximoとしては認証自体を外部で処理している関係で、公式サポートの問題を除けば認証プロトコルは問わないはずです。今回はOpenID Connectで認証できるか試してみたいと思います。

OpenID Connect, SAML双方をサポートしたIdentity and Access Management (IAM)にKeycloakがあります。IAMとしては新興のOSSですが、こちらも設定の簡便さから人気が高まっています。同じIBMの製品とも言えますが、WASのサポートはそこまで手厚くありません。しかしWAS LibertyでもOpenIDのサポートはされていますので、標準に則ってる限りでは動作するはずです。今回はOpenID Connectの実装を試行してみますが、Maximoではまだ公式サポートされていないことをご注意ください。

ではKeycloakの設定を行ってみます。Keycloakの導入は以下のYAMLを使って、docker-compose upで立ち上げます。

https://github.com/keycloak/keycloak-containers/blob/master/docker-compose-examples/keycloak-postgres.yml

以下のコマンドを実行するといいでしょう。

curl https://github.com/keycloak/keycloak-containers/blob/master/docker-compose-examples/keycloak-postgres.yml --output keycloak.yml docker-compose up -d -f keycloak.yml

http://localhost:8080 からkeycloakにアクセスできるか確認します。adminでログインした後、クライアントとユーザーの設定を行います。

Realm SettingsでLoginタブを開きます。今回は開発環境なのでRequire SSLをnoneにします。

次にClientsからCreateボタンをクリックし、以下のようにMaximoクライアントを設定します。

URLなどはMaximoのURLを指定してください。次にCredentialsタブでSecretを確認して、こちらの値を保存しておきます。こちらは後でLibertyの設定で使用します。

次にMapperタブでAdd Builtinからusernameとgroupsを選択して保存します。

次にRolesメニュからmaximouserロールを以下のように作成します。

Groups メニューから maximouser グループを作成します。

Role Mappingsタブから maximouser ロールをアサインします。

Users からユーザーを作成します。管理ユーザーであるmaxadminを作成します。

次にGroupsタブから”maximouser“にjoinします。

以上でIAMの設定は終了です。次にMaximoの構成を行います。今回はWebSphere Libertyをつかった構成を試してみます。

Maximoをインストールした後、以下の手順の1を実行します。ただしLibertyのweb.xmlは/opt/IBM/SMP/maximo/deployment/was-liberty-default/config-deployment-descriptorsにあるので注意してください。

https://www.ibm.com/support/pages/sites/default/files/inline-files/$FILE/Configuring%20SAML%20Security.pdf

次にmaximo.propertiesに以下を挿入します。

mxe.useAppServerSecurity=1 mxe.webclient.skin=iot18 mxe.useSAML=0

server.xmlを以下のファイルのように編集します。場所は/opt/IBM/SMP/maximo/deployment/was-liberty-default/config-servers/maximo-ui/maximo-ui-server/以下にあります。

server.xml

http://192.168.128.222:8080 をKeycloakのホスト名に置き換えてください。

主なポイントを説明します。

MaximoではJava EEセキュリティに maximouser ロールを要求します。Keycloakに割り当てられたロールは access-id のような形に変換されるため、security-roleとマッピングする必要があります。

<security-role name="maximouser"> <group access-id="group:http://192.168.128.222:8080/auth/realms/master/maximouser"/> </security-role>

WebAppSecurityの設定ではssoUseDomainFromURLを有効にします。またSSLを使用しない場合は ssoRequireSSL を無効にします。

<webAppSecurity httpOnlyCookies="true" ssoUseDomainFromURL="true" ssoRequiresSSL="false"/>

OpenID Connect Clientの設定ですが、 clientSecret には上記で取得したSecretを指定します。 redirectToRPHostAndPort はMaximoのURLを設定してください。

<openidConnectClient id="RP" httpsRequired="false" redirectToRPHostAndPort="http://192.168.128.222" signatureAlgorithm="RS256" clientId="maximo-ui" clientSecret="5f042d71-722e-46a4-908e-bba2ffb690f3" userIdentifier="preferred_username" groupIdentifier="groups" issuerIdentifier="http://192.168.128.222:8080/auth/realms/master" jwkEndpointUrl="http://192.168.128.222:8080/auth/realms/master/protocol/openid-connect/certs" authorizationEndpointUrl="http://192.168.128.222:8080/auth/realms/master/protocol/openid-connect/auth" tokenEndpointUrl="http://192.168.128.222:8080/auth/realms/master/protocol/openid-connect/token">

WARファイルをリビルドし、Libertyを立ち上げます。URLにアクセスしKeycloakの認証を通しMaximoの画面が出れば成功です。

今回はKeycloakを使ってMaximoのSSOをOpenID Connectで実現してみました。OpenID Connectは様々なクラウドベンダーでもSaaS製品が提供いますので、Keycloakに限らず今回の方式は応用が可能です。また、Socialログインも同様のプロトコルを使用していますので、Googleアカウントなどの連携も可能であるはずです。

[maximopro]

Maximo Asset Management V7.6.1.2がリリースされました

Maximo Asset Management V7.6 Featurepack 2がリリースされました。

https://www.ibm.com/support/pages/node/6250007

変更点はこちらを参照ください。

https://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.1.2/com.ibm.mam.doc/overview/c_new_in_7.6.1.2.html

今回のバージョンは基本機能の強化がメインとなっている印象です。最近の機能強化のメインだったWork Centerは控えめで、監査機能の強化などが目立ちます。もう一つの目玉はDigital Twin Exchangeへのネイティブ対応が挙げられると思います。いくつかの変更点はこちらのブログで紹介していきたいと思います。

V7.6.1.2を簡単に試すには、Maximo on Dockerを使うのが簡単です。現時点でV7.6.1.2にすでに対応しています。以下の手順ですぐに試すことができます。

- 必須: docker, docker compose

git clone https://github.com/nishi2go/maximo-liberty-docker.git

以下のファイルをcloneしたimagesディレクトリにコピーする IED_V1.8.8_Wins_Linux_86.zip MAM_7.6.1_LINUX64.tar.gz wlp-nd-license.jar DB2_AWSE_REST_Svr_11.1_Lnx_86-64.tar.gz MAMMTFP7612IMRepo.zip v11.1.4fp4a_linuxx64_server_t.tar.gz

build.shを実行 (./build.sh -rt - p -v)

docker-compose upを実行

http://localhost/maximo へアクセス

[maximopro]

ワークフローの状態を一覧で表示する

Maximoの標準構成では、実行されいているワークフローを確認するにはレコードを選択してメニューより「ワークフローのルート」までたどる必要があります。今回は実行されているワークフローが存在する場合、一覧でひと目で確認できるようにアプリケーションを変更してみたいと思います。やることはそこまで難しくありませんが、Maximoのアプリケーション変更の簡便さを実感するケース・スタディの一種として捉えていただければと思います。

ワークフローのルートから新規にワークフローを実行したときに、ワークフローの管理レコードとしてWFINSTANCEテーブルにレコードが作成されます。ここで必要になる属性は以下のとおりです。属性は「データベースの構成」からWFINSTANCEを検索して「属性」タブより確認できます。

OWNERTABLE - 実行元のテーブル名「PO」「WORKORDER」など

OWNERID - 実行元レコードのユニークID 「WORKORDERID」など

ACTIVE - ワークフローが実行中かどうかを示すフラグ

ユニークIDについてはデータベースの構成より確認できます。

これにより、実行元のテーブルとID属性さえわかれば、実行元レコードとの関連付けが可能になります。例えばWORKORDERであれば、OWERTABLEはWORKDER, OWNERIDはWORKORDERIDを指定します。それらを関係を使って定義します。

「:yes」は特殊変数でクエリ時に「1」に変換されます。これによって実行中のインスタンスのみ選択されます。「:workorderid」は選択されたレコードの値に置換されます。ここでは数値ですが、文字種であってもクオーテーションで囲わないでください。Maximoが自動的に種別を判別してクオーテーションをつけてくれます。

次に「アプリケーション・デザイナー」よりWOTRACKを開き、一覧にテーブル・カラムを追加します。

「属性」フィールドには「WFINSTANCE.ACTIVE」と入力しています。WFINSTANCEは上記で設定した関係名でドット区切りでACTIVE属性を指定しています。最終的に一覧に現れる値はACTIVEの値です。ここで複数のワークフローが実行されていた場合やワークフローがなかった場合にどうなるのか疑問に思われるかもしれません。もし複数のレコードがあった場合、選択される値はクエリで最初に取得された行から得られます。今回はACTIVE=1のレコードのみ選択されるようにWhere文節を設定しているので、レコードがあった場合は必ず「1」が表示されます。レコードがなかった場合は、NULL値ではなくYORN型のデフォルト値「0」が選択されます。これによって実行しているワークフローが一つでも存在した場合は「1」が表示されることになります。

実際に実行した画面はこちらになります。ワークフローが実行されているレコードにはチェックマークがついています。これはMaximoが属性の型から自動判別してチェックマークを表示するようにUIを調節しています。

アプリケーションをスクラッチで作る場合、考慮しなければならない点をMaximoのアプリケーション・フレームワークが上手に解決しているため、開発者がスムーズに開発できることを実感していただけたと思います。

[maximopro]

統合インターフェースのメッセージを保存する

Maximoの統合インターフェース(MIF: Maximo Integration Framework)では「メッセージ・トラッキング」アプリケーションによって、JMSキューのデータをMaximoから参照することが可能です。しかし、HTTPやREST APIなどの同期インターフェースでは、その仕組みを利用できませんでした。Maximo V7.6.1.1より同期インターフェースに対してメッセージを保存するオプションが追加されました。

https://www.ibm.com/support/pages/node/6202512

利用方法は以下のプロパティ値を1に変更します。

mxe.int.trackrestrequests - REST APIのリクエストを保存

mxe.int.tracksoaprequests - SOAP (Web Service)のリクエストを保存

mxe.int.tracksynchttprequests - OS (XML), エンタープライズ・サービスのリクエストを保存

メッセージの内容(payload)まで保存したい場合は以下のオプションを有効にします。

mxe.int.storerestmsg

mxe.int.storesoapmsg

mxe.int.storesynchttppmsg

実際に保存した結果は「メッセージ・トラッキング」より、アクションの選択メニューから、「同期メッセージの追跡」より確認できます。

メッセージの内容を確認したい場合は、一番右にある鉛筆のアイコンをクリックしてください。

注意点としては、サポートページにも記載されていますがリクエストごとにメッセージが保存されるため、パフォーマンスが非常に悪くなります。本番環境で使用することはお勧めできません。ただし、loggerの種類を変更することによって解消されることもあります。こちらについては次回以降に解説します。

もう一つはこのオプションを有効にするとオブジェクト構造のHTTPリクエストで500: Internal Server Errorになることです。こちらは恐らく不具合なので、現象に当たった場合やオブジェクト構造で使用したい方は修正リクエストを出す方がいいでしょう。

同期メッセージも非同期メッセージのようにMaximo内でトラッキングできるようになったので、開発時などで活躍できる非常に有用な機能だと思います。

[maximopro]

SMB (Windows共有) やFTPをローカルにマウントせずに添付ファイル・ストレージとして使う方法

以前、添付ファイルの保存先にAmason S3を使う方法をご紹介しました。この機能の利点として実質無制限の容量を得られることと、ファイルシステムにマウントしなくても利用できる点があります。特に後者はファイル・サーバーとそれをマウントしているクライアントの両方の可用性を監視しなければいけないので、運用において考慮するポイントが増えることを防ぐことができます。この利点をEndpoint Collectionsを使って通常のWindowsファイル共有(SMB)を使った場合でも享受できる用にする方法を解説します。

Endpoint Collectionsは私謹製のオープンソースソフトウェアです。エンドポイントにSMBとFTPをサポートしています。今後はNFSやBox, Dropboxなどにも対応する予定です。まずはこちらをインストールします。

こちらよりzipをダウンロードします。

Maximoのディレクトリに解凍します。(C:¥IBM¥SMP¥maximoなど)

updatedb.[sh,bat] (C:¥IBM¥SMP¥maximo¥tools¥maximo)を実行します。

EARファイルの再デプロイを行います。

「統合」-「エンドポイント」から「BPMPRSMB」というレコードが見つかればインストールは成功しています。こちらの構成を例として以下のように行います。

テストボタンにより、接続テストを行うことができます。

次に「システム・プロパティ」アプリケーションより以下の項目を変更して保存します。

mxe.attachmentstorage=com.tumblr.maximopro.oslc.provider.MifEpAttachmentStorage

mxe.bpmpro.attachmentstorage.endpoint=BPMPRSMB

mxe.doclink.securedAttachment=true

最後にアプリケーション・サーバーを再起動します。これで設定は完了です。添付ファイルが保存されることを確認してください。

監視する項目を一つ減らすことで運用にかかる負担を減らすことができます。可用性の面で心配な場合はMinIOなどのS3互換ストレージを自分で運用することもできます。様々なオプションを検討することをおすすめします。