Technical information

Kompiraの機能 Kompira上でWikiページを作成する

運用チームでKompiraを共有して利用する場合、作業手順などの情報をKompiraで共有して閲覧できるようにするために、Wikiを作成することが出来ます。例えばオペレータ向けに確認事項やジョブフローへのリンクをまとめておくと重宝するでしょう。
またジョブフローを実行して得られた情報などもWikiに自動的に記録しておくこともできます。

 
Wikiの作成

新規のジョブフローを作成する場合と同様に、Wikiページ型のKompiraオブジェクトを作成します。ここでは「作業手順」という名前で作成してみましょう。
Wikiの作成

次のような編集画面が表示されます。
Wiki編集画面

Wikiでメモを書いていくには、単純にテキストを書いていく他に、「スタイル」と呼ばれる一定の記法に従って書くと、太字、イタリックなどの表示、表の作成、外部リンクの作成などが出来るようになります。
「スタイル」では(1) Creole(デフォルト) (2) Markdown (3) Textileの三種類のWiki記法から選択する事が出来ます。各記法の詳細については、画面の「Wikiテキスト」欄の下に、それぞれリンクがありますので参照してください。
ここでは昔からWikiに利用されているCreole記法を使っていきます。

簡単な例として、Wikiテキスト欄に次の様に記載してみます。

保存ボタンをクリックすると、次の様に表示されます。

Wiki画面

上記の例では、行の先頭に “#” を記載すると番号付きリストになり、[[ ]] で囲んだパスはリンクになるCreole記法の例です。
このようにして手順の解説とジョブフローへのリンクをまとめておくと便利でしょう。

 
ジョブフローからWikiに保存する方法

Wikiオブジェクトのフィールドを調べると、”wikitext”フィールドがwikiページのテキストを格納します。
Wikiオブジェクト

さて既存のWikiオブジェクト “Wikiページ”が存在しているとして、この”Wikiページ”の内容をジョブフローから変更するのは、次の様にします。

“Wikiページ”にメッセージを追記していくのは次の様に、いったん内容を変数に保存して、追記文字列を結合した後に、改めてwikitextフィールドに書き戻します。(下記の例で’\n’は改行を表します。)

上記のように、ジョブフローより既存のWikiページの内容を書き換える事が出来ます。取得したシステムの情報や、作業記録を追記していくような用途などでご利用ください。