2017.05.23

仕様書生成機能についに対応!

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

はじめに

ご無沙汰しております。製品開発本部 開発部の奴賀(ぬか)です。
今回は去る3月26日にバージョンアップされたSkyOnDemand V4.0で利用可能となりました、仕様書生成機能をご紹介させて頂きます。
本記事がスクリプトの品質改善や生産性向上の一助になれば幸いでございます。


仕様書生成機能とは?

スクリプトの内容をHTML形式で仕様書としてクライアントに出力することができる機能です。仕様書はスクリプト単位、プロジェクト単位のどちらでも出力することが可能です。
一例として下記のような用途に利用されます。

  • スクリプトレビュー
  • 成果物・納品物
  • 引き継ぎ資料

使用方法

早速、前回ご紹介した チャットもいいけど電話もね!(障害通知編) のプロジェクトを利用して、仕様書生成機能の使用方法を見ていきたいと思います。

  1. マイプロジェクトから障害通知プロジェクトを展開します。
  2. プロジェクト単位で出力したい場合はプロジェクトを右クリック⇒プロジェクト仕様書の生成を押下、
    若しくはプロジェクトを選択した状態で、メニュー⇒プロジェクト仕様書の生成を押下からも可能です。
    スクリプト単位で出力したい場合はスクリプトを右クリック⇒スクリプト仕様書の生成を押下します。
    (今回はプロジェクト単位で出力したいと思います)
    20170411_プロジェクト仕様書生成.jpg
  3. 基本情報タブに必要な情報を入力します。
    20170411_プロジェクト仕様書生成_基本情報.jpg
    • 出力先
      必須項目です。参照ボタンを押下し、仕様書出力先となるクライアントOSのローカルファイルシステム上のファイルパスを入力してください。
    • PSPデータフローを表示して出力する
      PSPデータフローを表示して出力するかどうかの選択です。チェックありの場合は黄色の太線でPSPデータフローとして出力され、チェックなし(デフォルト)の場合は黄色の破線でデータフローとして出力されます。
    • マッピングリンクの引かれていないノードを展開して出力する
      マッピングキャンバスの画面で、「入力データ」、「入力ドキュメント」および「出力データ」の子ノードのうち、マッピングリンクの引かれていないノードを展開して出力するかどうかの選択です。チェックあり(デフォルト)の場合はマッピングリンクの引かれていないノードを展開して、チェックなしの場合はマッピングリンクの引かれていないノードを展開せずに出力します。

      変数Mapperの「入力ドキュメント」については、「チェックあり」であってもマッピングリンクの引かれているノードを含むスキーマだけを展開して出力します。

      「コンポーネント変数」および「スクリプト変数」の子ノードについては、チェックの有無にかかわらず、マッピングリンクの引かれているノードだけを展開して出力します。

  4. 作成者情報タブに必要な情報を入力します。
    20170411_プロジェクト仕様書生成_作成者情報.jpg
    • 会社名
      任意項目です。会社名を入力してください。入力した情報は仕様書に出力されます。
    • プロジェクト名
      任意項目です。プロジェクト名を入力してください。入力した情報は仕様書に出力されます。
    • 氏名
      任意項目です。氏名を入力してください。入力した情報は仕様書に出力されます。
  5. プロジェクト仕様書の出力に必要な情報の入力が完了したら、完了ボタンを押下します。

無事プロジェクト仕様書が出力されました。
次項では出力されたプロジェクト仕様書を見ていきたいと思います。


生成されたプロジェクト仕様書

出力先に指定したZIPファイルを展開し、プロジェクトフォルダの下の index.html をWebブラウザで開きます。
20170411_プロジェクト仕様書_0_1.jpg

  • 左ペインには概要と各スクリプトの仕様書へのリンクが表示されます。
  • 右ペインには実際の仕様書が表示されます。

すべての仕様書をご覧いただくには量が多すぎるので、一部抜粋して雰囲気だけでも感じて頂ければと思います。

概要

20170411_プロジェクト仕様書_1_1.jpg

プロジェクトの名前や作成者情報タブに入力した作成者情報、スクリプト一覧などが確認できます。

M_メイン処理実行

20170411_プロジェクト仕様書_2_1.jpg

スクリプトのバージョンや更新日時、スクリプト変数やトランザクション属性、大容量データ処理などの基本的な情報が確認できます。
その後、スクリプトの画面やコンポーネント一覧でスクリプトのフローといった概要が確認できます。
最後に、各コンポーネント内部で値がどのように設定されているかなどのスクリプトの詳細な情報が確認できます。

仕様書には各コンポーネントのコメントタブの内容やメモコンポーネントの内容も出力されます。
例えば、パフォーマンスチューニングや連携先のI/Fとの兼ね合いで複雑なスクリプトになった場合の「何故」や、変数名やスクリプト名、コンポーネントの設定値などだけでは表現することが難しい場合の「なにか」等を、コンポーネントのコメントタブやメモコンポーネントに残しておくとレビューや引き継ぎの際に有用になるかと思われます。

02_障害通知/S02_02_障害通知_チャット

20170411_プロジェクト仕様書_3.jpg

こちらもM_メイン処理実行と同様に基本的な情報や概要がまず確認できます。
その後の各コンポーネントの詳細な情報で、入力スキーマの内容やマッピングの内容などが確認できます。

2本のスクリプトの仕様書をご覧いただきましたが、如何でしたでしょうか。
個人的には流れるようにレビューを行えるような出力順で仕様書が出力されていたり、スクリプトの内容を確認するのには十分な情報が出力されているのではないかと思っています。


最後に

今回はSkyOnDemand V4.0で利用可能になりました仕様書生成機能に関してご紹介させて頂きました。
SkyOnDemand V4.0では マッピングを速く正確に行うための一括リンク や 連携サーバの設定移行やバックアップに使えるSkyOnDemandServerの設定 などの便利な機能が数多く実装されました。
今後も、みなさまの問題の解決に繋がる魅力的で信頼性のある機能をご提供できればと考えておりますので、どうぞご期待頂ければと思います。

1 件

関連する記事