2.1.1 サンプルの業務コンテンツ
ここでは,サンプルの業務コンテンツについて次の内容を説明します。
-
サンプルの業務コンテンツの概要
-
サンプルの業務コンテンツのインポート手順
-
サンプルの静的ファイル
-
サンプルの業務コンテンツの注意事項
なお,サンプルの業務コンテンツの見映えは,次の環境を想定して最適化しています。
-
Webブラウザ:Microsoft EdgeおよびGoogle Chrome
-
ディスプレイのサイズ:17インチ以上
-
解像度:1,280×1,024ピクセル
- 〈この項の構成〉
(1) サンプルの業務コンテンツの概要
サンプルの業務コンテンツの概要を次の表に示します。
項番 |
名称 |
概要 |
---|---|---|
1 |
Webアプリバージョンアップ |
Webアプリケーションのシステムをバージョンアップする場合に実施する手順です。 |
2 |
停電時サーバ起動 |
停電によって停止したサーバを起動する手順です。 |
3 |
障害発生時初動対処 |
システムの停止をJP1/IMで検知した時,現状の把握と担当者への情報の引き継ぎを行う場合に実施する手順です。JP1/IMが障害によるシステムの停止を検知した場合に実施します。 |
4 |
JP1/IM自動アクション遅延解消 |
JP1/IMの自動アクションで実行されるコマンドの遅延について対処し,その対処の結果を管理者へ報告する手順です。JP1/IMがコマンドの遅延を示すエラーを検知した場合に実施します。 |
5 |
手動セキュリティパッチ適用 |
セキュリティパッチの自動更新を設定していないサーバに対し,セキュリティパッチをサーバに手動で適用する場合の手順です。 |
6 |
データベース再編成時期判定 |
データベースの再編成が必要かどうかの判断に使う情報の取得,および判断に応じた対処を実施する手順です。ログファイルにデータベースのページ利用効率の悪化を知らせるメッセージが出力された場合に実施します。 |
(2) サンプルの業務コンテンツのインポート手順
サンプルの業務コンテンツは,ZIPファイルでも提供しています。サンプルの業務コンテンツを誤って削除してしまった場合や編集後に元の状態に戻したい場合などに,次のパスのZIPファイルをインポートしてください。インポートの作業はシステム管理者に依頼してください。
- サンプルの業務コンテンツのパス
-
ナビゲーション プラットフォームインストールディレクトリ\sample\contents\sample_contents.zip
(3) サンプルの静的ファイル
サンプルの業務コンテンツで使用している装飾用の画像(静的ファイル)は,ほかの業務コンテンツでもそのまま利用できます。サンプルの静的ファイルを利用したい場合は,[属性の設定]画面で,次のように画像のURLを指定してください。
/ucnp/sample/contents_item/00_common/ファイル名
サンプルの静的ファイルを次に示します。括弧内がファイル名です。
(a) 区切り線(line.png)
- サンプルの業務コンテンツでの利用例
-
概要と詳細を区切り,説明文を見やすくしています。
- 応用例
-
見出しや重要個所を強調するためのアンダーラインとしても利用できます。
(b) 背景(background.png)
- サンプルの業務コンテンツでの利用例
-
説明文の背景に色を付けることで,文字を読みやすくしています。
(c) 三角のアイコン(icon_branch.png)
- サンプルの業務コンテンツでの利用例
-
分岐条件を示しています。
- 応用例
-
個条書きのアイコンとしても利用できます。
(d) 吹き出しのアイコン(icon_talk.gif)
- サンプルの業務コンテンツでの利用例
-
連絡先を示しています。
(e) 強調のアイコン(icon_point.gif)
- サンプルの業務コンテンツでの利用例
-
確認事項を示しています。
(f) ファイルのアイコン(icon_doc.gif)
- サンプルの業務コンテンツでの利用例
-
システムや資料を示しています。
(g) 見出しのアイコン(icon_button.png)
- サンプルの業務コンテンツでの利用例
-
連絡先や確認事項以外の項目を示しています。
- 応用例
-
個条書きのアイコンとしても利用できます。
(h) 吹き出し(balloon1.png,balloon2.png)
- サンプルの業務コンテンツでの利用例
-
2種類の画像を組み合わせることで吹き出しを作成し,業務コンテンツ作成のTIPSの説明を目立たせています。
- 応用例
-
balloon1.png単独で背景画像として利用することもできます。
(4) javascriptプラグインを含むサンプルコンテンツ
javascriptプラグインを含む次のサンプルコンテンツについて説明します。
-
文字列連結サンプルコンテンツ
-
コマンド実行サンプルコンテンツ
-
ファイルアップロードサンプルコンテンツ
(a) 文字列連結サンプルコンテンツ
パラメタに入力された文字列を連結し,結線したガイドパーツに出力するサンプルコンテンツです。
- 入力パラメタ
-
InputData1〜10:連結する文字列を入力するパラメタ
- 出力パラメタ
-
Output:連結した文字列を出力するパラメタ
- 利用方法
-
このサンプルコンテンツでは,JavaScriptプラグインStringConcatの入力パラメタに入力された文字列を,画面遷移時に連結し,出力パラメタと結線したガイドパーツへ出力します。
次の説明では,遷移前に文字列を入力するガイド画面をA画面とし,遷移後に連結した文字列を出力するガイド画面をB画面としています。
- ■編集者の操作
-
-
必要に応じて,A画面のJavaScriptプラグインStringConcatを自分のコンテンツにコピー&ペーストします。
-
必要に応じて,A画面でJavaScriptプラグインStringConcatの入力パラメタに結線していたガイドパーツを,自分のコンテンツにコピー&ペーストします。または,任意のガイドパーツを選択します。
-
ガイドパーツを入力パラメタと結線します。
-
必要に応じて,B画面のJavaScriptプラグインStringConcatを自分のコンテンツにコピー&ペーストします。
-
同様に,B画面でJavaScriptプラグインStringConcatの出力パラメタに結線していたガイドパーツを,自分のコンテンツにコピー&ペーストします。または,任意のガイドパーツを選択します。
-
ガイドパーツを出力パラメタと結線します。
-
必要に応じて,JavaScriptプラグインStringConcatの入力パラメタを追加します。追加する場合,JavaScriptプラグインStringConcatのソースを修正します。
例 入力パラメタにInputData11を追加した場合,InputData1〜10を連結している箇所に,InputData11を加える
var sumStr = InputData1 + InputData2 + InputData3 + InputData4 + InputData5 + InputData6 + InputData7 + InputData8 + InputData9 + InputData10 + InputData11;
-
- ■実行者の操作
-
-
コンテンツを実行し,A画面で文字列を入力します。
-
B画面へ遷移します。
-
B画面で連結後の文字列が出力されます。その文字列をコピー&ペーストでメールなどに貼り付けて利用します。
-
- エラー一覧
-
このサンプルコンテンツは,提供時にエラーメッセージを表示しません。
- 制限事項
-
-
利用方法で記載した以外のJavaScriptプラグインStringConcatのソース修正は,保証しません。
-
JavaScriptプラグインStringConcatの入力パラメタは,ASCIIコードの0x00〜0x08,0x0B〜0x0C,0x0E〜0x1Fを使用できません。
-
(b) コマンド実行サンプルコンテンツ
ナビゲーション プラットフォームのサーバ上のコマンドを実行し,標準出力,標準エラー出力,戻り値などの結果を確認できるサンプルコンテンツです。
- 入力パラメタ
-
JavaScriptプラグインCommandExecの入力パラメタを次に示します。
パラメタ名
パラメタの説明
パーツとの結線
指定できる値
commandName
コマンド名を入力するパラメタ
必須
環境変数は指定できません。
arg1〜arg10※
コマンドの引数を入力するパラメタ
任意
制限はありません。
syncOption
同期実行と非同期実行を切り替えるパラメタ
必須
同期実行する場合,半角小文字の文字列"true"を指定してください。
encoding
標準出力,標準エラー出力取得時の文字コードを指定するパラメタ
必須
"Shift-JIS"または"UTF-8"
timeOutSec
コマンド同期実行時のタイムアウトの時間指定用パラメタ
(タイムアウトの時間の単位:秒)
任意
次のどちらかです。
・指定無し
・0以上の数値
指定無し,または,0以下の数値を指定した場合は,タイムアウトによる中断を行わず,コマンド実行完了まで待ちます。
タイムアウトによる中断を行わない場合または大きい値を指定した場合,コマンド実行時間が長いと応答なしになることがあります。
- 出力パラメタ
-
JavaScriptプラグインCommandExecの出力パラメタを次に示します。
パラメタ名
パラメタの説明
standardOutput
標準出力のパラメタ
standardErrorOutput
標準エラー出力のパラメタ
returnCode
戻り値を出力するパラメタ
errMessage
エラーが発生した場合に,エラーの発生と発生条件,対処内容を出力するパラメタ
stackTrace
エラーが発生した場合に,スタックトレースを出力するパラメタ
- 利用方法
-
このサンプルコンテンツでは,画面遷移時に,JavaScriptプラグインCommandExecがコマンドを実行します。
次の説明では,遷移前にコマンド,引数,同期実行オプション,標準出力・標準エラー出力取得時の文字コード,同期実行時のタイムアウト時間を入力するガイド画面をA画面とし,遷移後に実行結果を出力するガイド画面をB画面としています。
- ■編集者の操作
-
-
A画面のJavaScriptプラグインCommandExecを自分のコンテンツにコピー&ペーストします。
-
A画面でJavaScriptプラグインCommandExecの入力パラメタに結線していたガイドパーツを,必要に応じて,自分のコンテンツにコピー&ペーストします。または,任意のガイドパーツを選択します。
-
入力パラメタcommandName,arg,syncOption,encoding,timeOutSecとガイドパーツを結線します。syncOption,encoding,timeOutSecに結線したガイドパーツに,必要に応じて,初期値を設定します。
-
B画面のJavaScriptプラグインCommandExecを自分のコンテンツにコピー&ペーストします。
-
B画面でJavaScriptプラグインCommandExecの出力パラメタに結線していたガイドパーツを,必要に応じて,自分のコンテンツにコピー&ペーストします。または,任意のガイドパーツを選択します。
-
出力パラメタstandardOutput,standardErrorOutput,returnCode,errMessage,stackTraceとガイドパーツを結線します。
-
必要に応じて,JavaScriptプラグインCommandExecのコマンド引数を入力する入力パラメタ(arg1〜arg10)を追加します。追加する場合,JavaScriptプラグインCommandExecのソース内で,コマンド引数の配列要素も追加します。
例 入力パラメタにarg11を追加した場合,inputValuesArrayの[]内に、パラメタ名を半角コンマ(,)で区切り追加する
// 入力パラメータ数を増やす場合、以下の配列要素に追加してください。
var inputValuesArray = [arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11];
-
- ■実行者の操作
-
-
コンテンツを実行し,A画面でコマンドや引数などを入力します。
-
B画面へ遷移します。
-
同期実行でない場合,B画面にコマンドを実行した結果は表示されません。編集者がB画面で結果を出力する状況にしており,同期実行の場合は,コマンドの実行でエラーが発生しなかった場合,B画面に結果が出力されます。編集者がB画面で結果を出力する状況にしており,同期実行の場合は,コマンドの実行でエラーが発生した場合も,B画面に結果が出力されます。
-
- エラー一覧
-
項番
要因
メッセージ
画面遷移
対処
1
コマンド実行時にエラーが発生しました。
エラー:サブプロセスの作成が失敗したため,コマンドの実行に失敗しました。
する
例外の内容を確認して対処してください。
2
コマンド実行時に入出力エラーが発生しました。
エラー:入出力エラーが発生し,コマンドの実行に失敗しました。
する
例外の内容を確認して対処してください。
3
コマンド実行時,不正なコマンド(commandName)が実行されました。
エラー:コマンド文字列が不正です。
する
例外の内容を確認して対処してください。
4
コマンド実行時,実行するコマンドが存在せずエラーが発生しました。
エラー:コマンド文字列が存在しません。
する
例外の内容を確認して対処してください。
5
コマンド名(commandName)が空白でした。
エラー:コマンド名は省略できません。コマンド名を入力してください。
しない
コマンド名を入力し,再度実行してください。
6
指定されたタイムアウト時間(timeoutSec)内にコマンド実行が完了しませんでした。
エラー:指定されたタイムアウト時間内にコマンド実行が完了しませんでした。
する
指定するタイムアウトの時間を変更し,再度実行してください。
7
標準出力,標準エラー出力取得時に,指定するエンコード(encoding)に,サポートしていないエンコードが指定されました。
エラー:標準出力,標準エラー出力取得時のエンコードにサポート外のエンコードが指定されています。
しない
Shift-JISまたはUTF-8を指定して再実行してください。
8
標準出力,標準エラー出力取得時に,入出力エラーが発生しました。
エラー:標準出力,標準エラー出力の取得に失敗しました。
する
例外の内容を確認して対処してください。
9
標準出力,標準エラー出力取得中,エラーが発生しました。
エラー:標準出力,標準エラー出力の取得中,スレッドの割り込みが発生しました。
する
例外の内容を確認して対処してください。
10
戻り値の取得に失敗しました。
エラー:戻り値の取得に失敗しました。
する
例外の内容を確認して対処してください。
- 制限事項
-
-
引数は1つの入力パラメタにつき1つ指定してください。複数の引数を空白や""などで区切って,1つの入力パラメタに指定しないでください。
-
実行するコマンドで環境変数は使用しないでください。
-
コマンド実行のJavaScriptプラグインのソース内は,入力パラメタからの入力値を格納する配列inputValuesArrayの要素数の修正だけを許します。
-
標準出力,標準エラーを読み込む際のエンコードとして指定できるエンコードは,Shift-JISとUTF-8だけです。それ以外は、保証しません。
-
標準出力,標準エラーにバイナリファイルを出力した場合,文字化けした文字列が出力されるため,バイナリファイルの出力は推奨しません。
-
標準出力,標準エラーの出力サイズが6MB以上になる場合,実行時エラーまたは表示不正が発生する場合があります。また,出力先パーツにテキストボックスを使用する場合,標準出力,標準エラーの出力サイズが4MB以上になる場合,標準出力,標準エラーの文字列が出力先のテキストボックスに表示されない場合があります。
-
(c) ファイルアップロードサンプルコンテンツ
パラメタで指定されたパスに,実行時にファイルまたはクリップボードの画像をアップロードするサンプルコンテンツです。
- 入力パラメタ
-
- ・parentDir
-
型:文字列
内容:アップロード先フォルダです。%環境変数%と記載した部分は環境変数の値に置換されます。
- ・fileHtmlPart
-
型:HTMLパーツ
内容:次の要素を持ったHTMLパーツです。
-
/ucnp/template/sampleFileUploader.htmlへのハイパーリンク:ファイルアップロードページ表示用
-
<input type="text" name="fileName">要素:ファイル名格納用
コンテンツ実行時にfileName要素が不正な場合(¥か/を含む場合)は,「Invalid filename.」のエラーとなり,fileHtmlPartに接続されたパーツが赤枠で強調されます。
-
<textarea name="fileContent" style="display:none" />要素:ファイルコンテンツ格納用
コンテンツ実行時にfileContent要素がファイル未指定の場合は,「No file is specified.」のエラー,不正なデータの時は「Invalid content.」のエラーとなり,fileHtmlPartに接続されたパーツが赤枠で強調されます。
-
- ・errorMessage
-
型:文字列
内容:デフォルトのエラーメッセージです。
- 出力パラメタ
-
- ・uploadPath
-
型:文字列
内容:%環境変数%を環境変数の値に置換したアップロード先フォルダです。
- ・fileName
-
型:文字列
内容:アップロードされたファイル名です。画像をペーストした場合は「pastedimage0.<拡張子>」という名前になります。<拡張子>は画像のmediatypeのimage/より後の文字列です。
例 image/pngの場合:<拡張子>はpng
例 image/gifの場合:<拡張子>はgif
- ・errorMessage
-
型:文字列または例外オブジェクト
内容:エラーや例外が発生していない場合は,入力パラメタerrorMessageの値が出力されます。例外発生時は,例外オブジェクトが出力されます。
- 利用方法
-
このサンプルコンテンツでは,画面遷移時にファイルをアップロードします。
次の説明では,遷移前のガイド画面をA画面とし,遷移後のガイド画面をB画面としています。
- ■編集者の操作
-
-
必要に応じて,A画面のJavaScriptプラグインFileUploadを自分のコンテンツにコピー&ペーストします。
-
必要に応じて,A画面の結線先のガイドパーツも自分のコンテンツにコピー&ペーストします。
-
入力パラメタparentDirにアップロード先フォルダ文字列をもつガイドパーツを結線します。
-
入力パラメタfileHtmlPartに所定の要素を持ったHTMLパーツを結線します。
-
必要に応じて,B画面のJavaScriptプラグインFileUploadを自分のコンテンツにコピー&ペーストします。
-
同様に,B画面でJavaScriptプラグインFileUploadの出力パラメタに結線していたガイドパーツも,必要に応じて,自分のコンテンツにコピー&ペーストします。
-
出力パラメタuploadPath,fileName,errmsgと出力先のガイドパーツを結線します。
-
- ■実行者の操作
-
-
コンテンツを実行し,A画面でハイパーリンクをクリックし,ファイルアップロード画面を開きます。
-
ファイルアップロード画面でアップロードするファイルを選択するか,画像をペーストします。
-
A画面に戻り,[次へ]ボタンをクリックしてB画面に遷移します。
-
ファイルがアップロードされ,B画面が表示されます。
-
- エラー一覧
-
項番
要因
メッセージ
画面遷移
対処
1
fileHtmlPartのfileName要素の値が正しくありません。
Invalid fileName.
しない
正しくない操作によって発生します。アップロード操作をやり直してください。
2
fileHtmlPartのfileContent要素の値が指定されていません。
No file is specified.
しない
ファイルアップロード画面からファイルを選択せずに[次へ]ボタンを押した場合などに発生します。アップロード操作をやり直してください。
3
fileHtmlPartのfileContent要素の値が正しくありません。
Invalid content.
しない
正しくない操作によって発生します。アップロード操作をやり直してください。
4
ファイルアップロード処理で例外が発生しました。
例外内容
する
例外の内容を確認して対処してください。
- 制限事項
-
-
クリップボードの画像アップロードは,Microsoft EdgeおよびGoogle Chromeでだけサポートします。
-
ファイルアップロード画面のHTMLで,「Do not modify. #NP」とコメントのついている部分は変更しないでください。
-
このサンプルでは実行者が自由にファイルをアップロードできるので,セットアップ後のデフォルト状態では,デザインテンプレートフォルダ下に非公開で配置されます。
-
このサンプルでアップロードするファイルの上限は10MBまでです。
-
(5) サンプルの業務コンテンツの注意事項
サンプルの業務コンテンツについての注意事項を次に示します。
-
利用者が誤って業務コンテンツを操作することを防ぐため,ナビゲーション プラットフォームの運用を開始する際には,サンプルの業務コンテンツは削除するか,非公開に設定することをお勧めします。
-
サンプルの業務コンテンツに記載されている内容は,特定の条件のシステムを想定しており,汎用的な運用手順を保証するものではありません。サンプルの業務コンテンツを流用する場合,実際の運用を十分考慮して編集してください。
-
デフォルトの設定で構築された環境の場合,業務実行画面ではターミナルノードは表示されません。一部のサンプルの業務コンテンツでは,ターミナルノードが表示されていないと,業務フローの完了位置がわかりにくいことがあります。業務実行画面でターミナルノードを表示させたい場合は,システム管理者に依頼してください。