9.10 npimportコマンド(業務コンテンツのインポート)
機能
ナビゲーション プラットフォームのコマンドでエクスポートした業務コンテンツ,およびアクセス権の設定情報(アクセス権グループまたはJP1資源グループ)をインポートします。
このコマンドは,セットアップ完了後,システムが起動している状態で実行する必要があります。コマンドプロンプトは管理者として開いてください。
npupdatesearchdataコマンドを実行すると,インポートした最新の業務コンテンツが検索の対象になります。コマンドの詳細は,「9.20 npupdatesearchdataコマンド(検索用データの更新)」を参照してください。
なお,このコマンドで業務コンテンツを更新する場合,過去に公開した版も含めて,すべての業務コンテンツの版を更新します。公開中の業務コンテンツの内容だけを更新したい場合は,nppubimportコマンド(公開版業務コンテンツのインポート)を使用してください。コマンドの詳細は,「9.13 nppubimportコマンド(公開版業務コンテンツのインポート)」を参照してください。
業務実行画面の[検索]タブを表示している場合は,このコマンドを実行したあとに,npupdatesearchdataコマンド(検索用データの更新)を実行することを推奨します。
- メモ
-
ディレクトリサーバによるユーザ認証を利用している場合は,アクセス権グループおよび標準アクセス権限によって業務コンテンツのアクセス権が決まります。JP1/Baseによるユーザ認証を利用している場合は,JP1資源グループの設定によって業務コンテンツのアクセス権が決まります。ただし,このコマンドでは,JP1資源グループの設定は変更されません。JP1資源グループの設定は,業務編集画面から変更する必要があります。
デフォルトではインポート対象の業務コンテンツを既存の業務コンテンツに追加します。同一グループ内の既存の業務コンテンツの中に,同じ名称の業務コンテンツがすでに存在していた場合はエラーとなります。
既存データへの追加ではなく,既存データをインポートするデータに置き換える場合には,-dオプションを指定してください。既存データを強制上書きするには,-fオプションを指定します。また,アクセス権グループをインポートする必要がない場合は,-xオプションを指定すると,業務コンテンツだけをインポートできます。
JP1/Baseによるユーザ認証以外の環境で,すべての業務コンテンツをまとめてエクスポートしている場合(-cオプション指定なしでnpexportコマンドを実行),インポート時には-dオプション,-fオプション,または-xオプションを必ず指定してください。
ディレクトリサーバによるユーザ認証を使用している場合は,次のどちらかの条件を満たすと,インポートした業務コンテンツに標準アクセス権限が設定されます。ただし,IDが同じ既存の業務コンテンツを上書きする場合(-fオプション指定)は,既存の業務コンテンツのアクセス権の設定情報が有効となります。
-
アクセス権グループをインポートしないで,業務コンテンツだけをインポート対象とした(-xオプション指定ありでnpimportコマンドを実行した)
-
特定の業務コンテンツだけをエクスポートした(-cオプション指定ありでnpexportコマンドを実行した)ファイルをインポート対象とした
インポート時に公開開始待ちの業務コンテンツを公開した状態でインポートしたい場合には,-oオプションを指定してください。例えば,公開開始待ちの業務コンテンツをテスト環境(実行環境)へインポートし,業務コンテンツの内容確認を行う場合などに利用します。
形式
npimport△[-d|--delete-force]△[-f]△[-x]△[-o]△[-l△インポート一覧ファイルのパス]△インポートしたいファイルのパス
インポートしたいファイルのパスは,絶対パスまたは相対パスで指定します。ナビゲーション プラットフォームのコマンドで取得したファイルを指定してください。それ以外のファイルは,指定できません。
オプション
- -d|--delete-force
-
インポートする前に,すべての業務コンテンツおよびアクセス権の設定情報を削除します。
既存の業務コンテンツをインポートした業務コンテンツで置き換える場合は,このオプションを指定してください。このオプションを指定しない場合は,既存のデータにインポートしたデータを追加します。
-d オプションを指定した場合は,ユーザプロパティファイル(ucnp_user.properties)のucnp.base.server.command.import.delete.confirm.enableプロパティの設定によって,削除の実行を確認するメッセージ(KDCZ10156-Q)の表示有無が変わります。
・「false」が指定されている場合
メッセージは表示されません。
・「true」が指定されている場合
メッセージが表示されます。Y(続行)かN(中止)を応答してください。
ucnp.base.server.command.import.delete.confirm.enableプロパティの設定にかかわりなく,確認メッセージを表示しない場合には,-d オプションの代わりに--delete-forceオプションを指定してください。
- ヒント
-
-
このオプションを指定して,npexportコマンド(業務コンテンツのエクスポート)の-xオプションでエクスポートしたファイルをインポートした場合,追加した業務コンテンツには標準アクセス権限が設定されます。上書きする業務コンテンツのアクセス権の設定情報は変更されません。
-
このオプションを指定して,業務コンテンツ数が0のファイルをインポートすると,登録されているすべての業務コンテンツが削除されます。多数の業務コンテンツを一括で削除したい場合に便利です。
-
- -f
-
インポート先に,インポート元と同じ名称のアクセス権グループ,または,同じIDの業務コンテンツがすでに保存されている場合は,必ずこのオプションを指定してください。インポート元のアクセス権グループと業務コンテンツをインポート先に上書きします(強制登録)。
業務コンテンツにアクセス権グループを設定する場合は,-dオプションまたは-fオプションを指定してください。
-fオプションを指定しないと,同じ名称のアクセス権グループまたは同じIDの業務コンテンツがすでに保存されている場合はエラーとなり,インポートできません。オプション「-d」「-f」を同時に指定した場合,「-f(強制登録)」は実行されないので,注意してください。
オプション「-f」「-x」を同時に指定した場合,インポート先のアクセス権グループを業務コンテンツに設定します。業務コンテンツに設定するアクセス権グループがインポート先に一つも存在しない場合は,標準アクセス権限を設定します。
- ヒント
-
npimportコマンドを実行する場合は,業務コンテンツの名称だけではなく,IDも意識する必要があります。業務コンテンツのIDは,次の方法で確認できます。
-
オプション「-l」を指定してnpexportコマンドを実行して,出力される一覧ファイルを確認する。
-
業務編集画面でIDを確認したい業務コンテンツを選択して,メニュー領域の[ID取得]メニューをクリックする。
-
- -x
-
アクセス権グループをインポートしないで,業務コンテンツだけをインポートします。業務コンテンツにアクセス権グループを設定しない場合に指定してください。
このオプションを指定してインポートした業務コンテンツには,インポート元のアクセス権グループの設定にかかわらず,インポート先ではすべて標準アクセス権限が設定されます。ただし,-fオプションも同時に指定している場合で,IDが同じ業務コンテンツを上書きするときは,インポート先のアクセス権グループが有効となります。
なお,npexportコマンドで-xオプションを指定してエクスポートした業務コンテンツをインポートする場合,-xオプションの指定有無に関係なく,業務コンテンツだけがインポートされます。
オプション「-d」「-x」を同時に指定した場合,すべての業務コンテンツに標準アクセス権限を設定します。また,すべてのアクセス権グループを削除して,標準アクセス権限の定義をセットアップ時の状態にリセットします。
オプション「-f」「-x」を同時に指定した場合,インポート先のアクセス権グループを業務コンテンツに設定します。業務コンテンツに設定するアクセス権グループがインポート先に一つも存在しない場合は,標準アクセス権限を設定します。
オプション「-x」「-l」を同時に指定した場合,アクセス権グループはインポート一覧ファイルに出力されません。
なお,JP1/Baseによるユーザ認証を利用している場合は,このオプションを指定しても無視されます。
- -o
-
インポート時に公開開始待ちの業務コンテンツを公開した状態でインポートします。公開開始待ちの業務コンテンツをテスト環境(実行環境)へインポートし,業務コンテンツの内容確認を行う場合などに利用します。
- -l インポート一覧ファイルのパス
-
追加,更新,または削除された業務コンテンツの一覧をテキストファイルとして出力します。
インポート一覧ファイルのパスは,絶対パスまたは相対パスで指定します。
インポート一覧ファイルの形式
ファイルの先頭にヘッダ情報が出力され,続いて,次の形式でメッセージが出力されます。
[結果種別]<T>[業務コンテンツID]<T>[業務コンテンツバージョンID]<T>[更新日時([タイムゾーン])]<T>[公開日時([タイムゾーン])]<T>[公開状態]<T>[公開予約状態]<T>[公開開始日時([タイムゾーン])]<T>[公開終了日時([タイムゾーン])]<T>[業務コンテンツ名称]<T>[グループ名]<T>[アクセス権グループ名またはJP1資源グループ名1]<T> … [アクセス権グループ名またはJP1資源グループ名10]<CR><LF> [結果種別][アクセス権グループ名1]<T>[アクセス権グループID1]<CR><LF> … [結果種別][アクセス権グループ名10]<T>[アクセス権グループID10]<CR><LF>
<T>:タブ文字
<CR><LF>:終端文字(0x0D,0x0A)
メッセージの詳細を次の表に示します。
項目 |
説明 |
---|---|
結果種別 |
npimportコマンド(業務コンテンツのインポート)の実行結果の種別が出力されます。
|
業務コンテンツID |
インポートした業務コンテンツIDが出力されます。 |
業務コンテンツバージョンID |
インポートした業務コンテンツの版のIDが出力されます。 |
更新日時 |
インポートした業務コンテンツの版を最後に更新した日時が出力されます。 日付の形式は,次のユーザプロパティの設定によって変わります。
業務編集画面で,業務コンテンツの保存または編集完了の操作をした日時が出力されます。 |
公開日時 |
インポートした業務コンテンツの版を最後に公開した日時が出力されます。 日付の形式は,次のユーザプロパティの設定によって変わります。
なお,インポート時には非公開となっている業務コンテンツでも,最後に公開した日時が出力されます。一度も公開されていない業務コンテンツの場合は,「-」(半角ハイフン)が出力されます。 |
公開状態 |
インポートした業務コンテンツの公開状態が出力されます。公開状態には次の2種類があります。
|
公開予約状態 |
業務コンテンツの公開予約状態が出力されます。
|
公開開始日時 |
インポートした業務コンテンツが公開される日時が出力されます。 日付の形式は,次のユーザプロパティの設定によって変わります。
公開開始日時を設定していない場合は,「-」(半角ハイフン)が出力されます。 |
公開終了日時 |
インポートした業務コンテンツの公開が終了する日時が出力されます。 日付の形式は,次のユーザプロパティの設定によって変わります。
公開開始日時を設定していない場合は,「-」(半角ハイフン)が出力されます。 |
業務コンテンツ名称 |
インポートした業務コンテンツの名称が出力されます。 |
グループ名 |
インポートした業務コンテンツのグループ名が出力されます。 |
アクセス権グループ名 |
業務コンテンツ名称と同じ行には,インポートした業務コンテンツに設定されているアクセス権グループ名が出力されます。それ以外の行には,インポートしたアクセス権グループ名が出力されます。 アクセス権グループは,はじめに標準アクセス権限が出力されたあと,名称の昇順で出力されます。 |
JP1資源グループ名 |
業務コンテンツ名称と同じ行には,インポートした業務コンテンツに設定されているJP1資源グループ名が出力されます。 |
アクセス権グループID |
インポートしたアクセス権グループのIDが出力されます。 |
- 注※
-
-
-dオプションを指定すると,業務コンテンツはいったん削除されてからインポートされますが,結果種別は「modified」または「merged」となります。「deleted」または「added」は表示されません。
-
次に示す項目だけを変更した場合,業務コンテンツの結果種別は「modified」または「merged」にはなりません。
業務コンテンツ名称
業務コンテンツのグループ名
業務コンテンツに設定するアクセス権グループ(またはJP1資源グループ)
-
タイムゾーンは,ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.timezoneプロパティで設定したタイムゾーンの短縮名が表示されます。
-
インポート一覧ファイルの出力例を次に示します。
結果種別 業務コンテンツID 業務コンテンツバージョンID 更新日時(JST) 公開日時(JST) 公開状態 公開予約状態 公開開始日時(JST) 公開終了日時(JST) 業務コンテンツ名称 グループ名 modified 268e3592-0133-1000-8002-00000ad23cbb-0 fe6dcb35-0145-1000-8000-0000ac11510b 2014/05/15 14:49:39.524 - 予約中 2016/04/01 08:00:00.000 2016/9/30 18:00:00.000 [sample01]Webアプリバージョンアップ サンプルコンテンツ modified 268e3592-0133-1000-8002-00000ad23cbb-0 fe6db084-0145-1000-8000-0000ac11510b 2014/05/15 14:49:37.793 - 予約中 2016/04/01 08:00:00.000 2016/9/30 18:00:00.000 [sample01]Webアプリバージョンアップ サンプルコンテンツ modified 268e3592-0133-1000-8002-00000ad23cbb-0 fe6cfabc-0145-1000-8000-0000ac11510b 2014/05/15 14:48:48.979 2014/05/15 14:49:26.935 公開中 - - [sample01]Webアプリバージョンアップ サンプルコンテンツ modified 268e3592-0133-1000-8002-00000ad23cbb-0 fa07860b-0145-1000-8000-0000ac11510b 2012/08/21 14:15:56.940 2014/05/14 18:19:28.283 - - [sample01]Webアプリバージョンアップ サンプルコンテンツ merged 357a2f3a-0133-1000-8001-00000ad23cbb-0 fe6cbed5-0145-1000-8000-0000ac11510b 2014/05/15 14:48:36.094 - - - [sample01解説]Webアプリバージョンアップ サンプルコンテンツ merged 357a2f3a-0133-1000-8001-00000ad23cbb-0 fa078688-0145-1000-8000-0000ac11510b 2012/08/21 14:16:02.550 2014/05/14 18:19:28.408 公開中 [sample01解説]Webアプリバージョンアップ サンプルコンテンツ deleted fe6eb084-0145-1000-8000-0000ac11510b-0 fe6eb0c2-0145-1000-8000-0000ac11510b 2014/05/15 14:50:38.227 - - - 新規入会 新規手順
注意事項
-
このコマンドを実行する前に,npexportコマンド(業務コンテンツのエクスポート)で自環境の業務コンテンツのバックアップを取得しておくことを推奨します。
-
業務コンテンツで使用している画像やHTMLなどの静的ファイルは,このコマンドではインポートされません。静的ファイルは手動でコピーし,移動させてください。静的ファイルの取り扱いの詳細は,「6.9 業務コンテンツで使用する静的ファイルの管理」を参照してください。
-
ファイルのパスには,ネットワークドライブを指定しないでください。
-
インポートする業務コンテンツの容量に対して,インポート先のディスクの空き容量が不十分だった場合,このコマンドは異常終了します。
また,コマンド実行中は作業フォルダとして環境変数TMPまたはTEMPのフォルダを使用します。このため,環境変数TMPおよびTEMPのフォルダのディスク容量に余裕を持たせてからコマンドを実行するようにしてください。
-
サーバ運用中にこのコマンドを実行すると,コマンドのデータ処理がサーバのデータ処理をブロックするため,性能が低下します。
-
コマンド実行時にエラーが発生した場合は,インポート処理が一部だけ反映された状態になっています。エラーの原因を取り除いて再度コマンドを実行してください。
-dオプション,-fオプションを指定してコマンドを実行した場合は,同じオプションを指定して,再度コマンドを実行してください。-dオプション,-fオプションの両方とも指定していなかった場合は,-fオプションを指定して,再度コマンドを実行してください。
-
-lオプションを指定してコマンドを実行し,エラーが発生した場合は,次のファイルの内容を合わせて,インポート一覧ファイルとして利用してください。
-
エラー発生時に出力されたインポート一覧ファイル
-
エラーの原因を取り除いて再度コマンドを実行したときに出力されたインポート一覧ファイル
-
-
同一グループ内で業務コンテンツの名称が一意にならないときはエラーとなります。
-
npexportコマンド(業務コンテンツのエクスポート)で-xオプションを指定してエクスポートしたファイルをインポートした場合,追加した業務コンテンツには標準アクセス権限を設定します。上書きする業務コンテンツのアクセス権は変更されません。
-
Hitachi Navigation Platform 10-10またはJP1/Navigation Platform 11-10より前の環境で作成した業務コンテンツは,JP1/Navigation Platform 12-10以降の環境にインポートできません。
-
JP1/Navigation Platform 12-50より前のバージョンのJP1/Navigation Platformでエクスポートされた業務コンテンツをインポートする場合,業務コンテンツが所属するグループ名に「\」の文字が含まれるときは,「\\」に変換されてインポートされます(表示上の変化はありません)。
戻り値
戻り値 |
説明 |
---|---|
0 |
コマンドが正常終了した。または警告終了した。 |
1 |
コマンドが異常終了した。 |
2 |
コマンドの排他エラーが発生した。 |
9 |
実行権限のエラーが発生した。 |
- 注
-
コマンド制御外のタイミングで終了した場合(<Ctrl>キーと<C>キーを同時に押して強制終了した場合など)の戻り値は不定となります。
使用例
- 例1
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
インポート先に同じ名称のアクセス権グループ,または同じIDの業務コンテンツが保存されている場合,強制登録しない。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport C:\work\repository.zip
-
- 例2
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
インポート先に同じ名称のアクセス権グループ,または同じIDの業務コンテンツが保存されている場合,強制登録する。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport -f C:\work\repository.zip
-
- 例3
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
すべてのアクセス権グループと業務コンテンツを削除してからインポートする。
-
業務コンテンツを削除してもよいかどうかを確認するメッセージを出力する。なお,ユーザプロパティファイル(ucnp_user.properties)のucnp.base.server.command.import.delete.confirm.enableプロパティの設定値が「true」の場合に,メッセージが出力される。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport -d C:\work\repository.zip
-
- 例4
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
すべてのアクセス権グループと業務コンテンツを削除してからインポートする。
-
業務コンテンツを削除してもよいかどうかを確認するメッセージを出力しない。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport --delete-force C:\work\repository.zip
-
- 例5
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
インポート後に出力するインポート一覧ファイルのパスを「C:\work\list.txt」とする。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport -l C:\work\list.txt C:\work\repository.zip
-
- 例6
-
次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
-
インポートしたいファイルのパスが「C:\work\repository.zip」である。
-
アクセス権グループをインポートしない。
-
インポート先にIDが同じ業務コンテンツが保存されている場合,強制登録しない。
> ナビゲーション プラットフォームインストールディレクトリ\bin\npimport -x C:\work\repository.zip
-