機能
ナビゲーション プラットフォームのコマンドでエクスポートした業務コンテンツ,およびアクセス権の設定情報(アクセス権グループまたはJP1資源グループ)をインポートします。
このコマンドは,セットアップ完了後,システムが起動している状態で実行する必要があります。Windows XP以外の場合,コマンドプロンプトは管理者として開いてください。
- 参考
- ディレクトリサーバによるユーザ認証を利用している場合は,アクセス権グループおよび標準アクセス権限によって業務コンテンツのアクセス権が決まります。一方,JP1/Baseによるユーザ認証を利用している場合は,JP1資源グループの設定によって業務コンテンツのアクセス権が決まりますが,このコマンドを実行しても,JP1資源グループの設定は変更されません。JP1資源グループの設定は,業務編集画面から変更する必要があります。
デフォルトではインポート対象の業務コンテンツを既存の業務コンテンツに追加します。
既存データへの追加ではなく,既存データをインポートするデータに置き換える場合には,-dオプションを指定してください。既存データを強制上書きするには,-fオプションを指定します。また,アクセス権グループをインポートする必要がない場合は,-xオプションを指定すると,業務コンテンツだけをインポートできます。
なお,すべての業務コンテンツをまとめてエクスポートしている場合(-cオプション指定なしでnpexportコマンドを実行),インポート時には-dオプション,-fオプション,または-xオプションを必ず指定してください。
ディレクトリサーバによるユーザ認証を使用している場合は,次のどちらかの条件を満たすと,インポートした業務コンテンツに標準アクセス権限が設定されます。ただし,IDが同じ既存の業務コンテンツを上書きする場合(-fオプション指定)は,既存の業務コンテンツのアクセス権の設定情報が有効となります。
- アクセス権グループをインポートしないで,業務コンテンツだけをインポート対象とした(-xオプション指定ありでnpimportコマンドを実行した)
- 特定の業務コンテンツだけをエクスポートした(-cオプション指定ありでnpexportコマンドを実行した)ファイルをインポート対象とした
形式
npimport△[-d]△[-f]△[-x]△[-l△インポート一覧ファイルのパス]△インポートしたいファイルのパス
インポートしたいファイルのパスは,絶対パスまたは相対パスで指定します。ナビゲーション プラットフォームのコマンドで取得したファイルを指定してください。それ以外のファイルは,指定できません。
オプション
- -d
- インポートする前に,すべての業務コンテンツおよびアクセス権の設定情報を削除します。
- 既存の業務コンテンツをインポートした業務コンテンツで置き換える場合は,このオプションを指定してください。このオプションを指定しない場合は,既存のデータにインポートしたデータを追加します。
- オプション「-d」「-f」を同時に指定した場合,「-f(強制登録)」は実行されません。
- 業務コンテンツにアクセス権グループを設定する場合は,-dオプションまたは-fオプションを指定してください。インポート先に同名のアクセス権グループが存在する場合,インポート時に-dオプションまたは-fオプションの指定がないとエラーになります。
- オプション「-d」「-x」を同時に指定した場合,すべての業務コンテンツに標準アクセス権限を設定します。また,すべてのアクセス権グループを削除して,標準アクセス権限の定義をセットアップ時の状態にリセットします。なお,npexportコマンド(業務コンテンツのエクスポート)実行時に-xオプションを指定して,このコマンドで-dオプションを指定した場合も同じ状態になります。
- ポイント
- このオプションを指定して,npexportコマンド(業務コンテンツのエクスポート)の-xオプションでエクスポートしたファイルをインポートした場合,追加した業務コンテンツには標準アクセス権限を設定します。上書きする業務コンテンツのアクセス権の設定情報は変更されません。
- このオプションを指定して,業務コンテンツ数が0のファイルをインポートすると,登録されているすべての業務コンテンツが削除されます。多数の業務コンテンツを一括で削除したい場合に便利です。
- -f
- インポート先に,インポート元と同じ名称のアクセス権グループ,または,同じIDの業務コンテンツがすでに保存されている場合は,必ずこのオプションを指定してください。インポート元のアクセス権グループと業務コンテンツをインポート先に上書きします(強制登録)。
- 業務コンテンツにアクセス権グループを設定する場合は,-dオプションまたは-fオプションを指定してください。
- -fオプションを指定しないと,同じ名称のアクセス権グループまたは同じIDの業務コンテンツがすでに保存されている場合はエラーとなり,インポートできません。オプション「-d」「-f」を同時に指定した場合,「-f(強制登録)」は実行されないので,注意してください。
- オプション「-f」「-x」を同時に指定した場合,インポート先のアクセス権グループを業務コンテンツに設定します。業務コンテンツに設定するアクセス権グループがインポート先に一つも存在しない場合は,標準アクセス権限を設定します。
- ポイント
- ucnp.base.client.contentsname.uniquecheck.enableプロパティの設定によっては,同じ名称の業務コンテンツが存在することがあります。その場合,業務コンテンツをIDで管理する必要があります。業務コンテンツのIDは,次の方法で確認できます。
- オプション「-l」を指定してnpexportコマンドを実行して,出力される一覧ファイルを確認する。
- 業務編集画面でIDを確認したい業務コンテンツを選択して,メニュー領域の[ID取得]メニューをクリックする。
- なお,ucnp.base.client.contentsname.uniquecheck.enableプロパティに「true」を設定すると,同じ名称の業務コンテンツを作成できなくなるため,名称によって業務コンテンツを管理しやすくなります。
- -x
- アクセス権グループをインポートしないで,業務コンテンツだけをインポートします。業務コンテンツにアクセス権グループを設定しない場合に指定してください。
- このオプションを指定してインポートした業務コンテンツには,インポート元のアクセス権グループの設定にかかわらず,インポート先ではすべて標準アクセス権限が設定されます。ただし,-fオプションも同時に指定している場合で,IDが同じ業務コンテンツを上書きするときは,インポート先のアクセス権グループが有効となります。
- なお,npexportコマンドで-xオプションを指定してエクスポートした業務コンテンツをインポートする場合は,-xオプションを指定していなくても,インポート結果は-xオプションを指定したときと同じです。
- オプション「-d」「-x」を同時に指定した場合,すべての業務コンテンツに標準アクセス権限を設定します。また,すべてのアクセス権グループを削除して,標準アクセス権限の定義をセットアップ時の状態にリセットします。
- オプション「-f」「-x」を同時に指定した場合,インポート先のアクセス権グループを業務コンテンツに設定します。業務コンテンツに設定するアクセス権グループがインポート先に一つも存在しない場合は,標準アクセス権限を設定します。
- オプション「-x」「-l」を同時に指定した場合,アクセス権グループはインポート一覧ファイルに出力されません。
- なお,JP1/Baseによるユーザ認証を利用している場合は,このオプションを指定しても無視されます。
- -l インポート一覧ファイルのパス
- 追加,更新,または削除された業務コンテンツの一覧をテキストファイルとして出力します。
- インポート一覧ファイルのパスは,絶対パスまたは相対パスで指定します。
インポート一覧ファイルの形式
ファイルの先頭にヘッダ情報が出力され,続いて,次の形式でメッセージが出力されます。
[結果種別]<T>[業務コンテンツID]<T>[業務コンテンツの更新日時]<T>[業務コンテンツ名称]<T>[グループ名]<T>[アクセス権グループ名またはJP1資源グループ名1]<T>
…
[アクセス権グループ名またはJP1資源グループ名10]<CR><LF>
[結果種別][アクセス権グループ名1]<CR><LF>
…
[結果種別][アクセス権グループ名10]<CR><LF>
<T>:タブ文字
<CR><LF>:終端文字(0x0D,0x0A)
メッセージの詳細を次の表に示します。
表8-5 インポート一覧ファイルに出力されるメッセージの詳細
項目 | 説明 |
---|
結果種別 | npimportコマンド(業務コンテンツのインポート)の実行結果の種別が出力されます。
- added
業務コンテンツまたはアクセス権グループが新規に追加されました。
- modified
内容に変更のある業務コンテンツが更新されました。※ 同じ名称のアクセス権グループが上書き,または-dオプションによって削除されたあとにインポートされました。
- deleted
業務コンテンツまたはアクセス権グループが削除されました。
|
業務コンテンツID | インポートした業務コンテンツIDが出力されます。 |
業務コンテンツの更新日時 | インポートした業務コンテンツの最終更新日時が出力されます。 形式:YYYY/MM/DD hh:mm:ss.SSS |
業務コンテンツ名称 | インポートした業務コンテンツの名称が出力されます。 |
グループ名 | インポートした業務コンテンツのグループ名が出力されます。 ただし,ucnp.base.client.menu.group.enableプロパティの設定によってはこの項目は出力されません。 |
アクセス権グループ名 | 業務コンテンツ名称と同じ行には,インポートした業務コンテンツに設定されているアクセス権グループ名が出力されます。それ以外の行には,インポートしたアクセス権グループ名が出力されます。 アクセス権グループは,はじめに標準アクセス権限が出力されたあと,名称の昇順で出力されます。 ただし,ucnp.base.server.command.legacyプロパティの設定によってはこの項目は出力されません。 |
JP1資源グループ名 | 業務コンテンツ名称と同じ行には,インポートした業務コンテンツに設定されているJP1資源グループ名が出力されます。 |
- 注※
- -dオプションを指定すると,業務コンテンツはいったん削除されてからインポートされますが,結果種別は「modified」となります。「deleted」または「added」は表示されません。
- 次に示す項目だけを変更した場合,業務コンテンツの結果種別は「modified」にはなりません。
業務コンテンツ名称
業務コンテンツのグループ名
業務コンテンツに設定するアクセス権グループ(またはJP1資源グループ)
インポート一覧ファイルの出力例を次に示します。
![[図データ]](figure/zu080200.gif)
注意事項
- このコマンドを実行する前に,npexportコマンド(業務コンテンツのエクスポート)で自環境の業務コンテンツのバックアップを取得しておくことを推奨します。
- 業務コンテンツで使用している画像やHTMLなどの静的ファイルは,このコマンドではインポートされません。静的ファイルは手動でコピーし,移動させてください。静的ファイルの取り扱いの詳細は,「6.9 業務コンテンツで使用する静的ファイルの管理」を参照してください。
- ファイルのパスには,ネットワークドライブを指定しないでください。
- インポートする業務コンテンツの容量に対して,インポート先のディスクの空き容量が不十分だった場合,このコマンドは異常終了します。
また,コマンド実行中は作業フォルダとして環境変数TMPまたはTEMPのフォルダを使用します。このため,環境変数TMPおよびTEMPのフォルダのディスク容量に余裕を持たせてからコマンドを実行するようにしてください。
- サーバ運用中にこのコマンドを実行すると,コマンドのデータ処理がサーバのデータ処理をブロックするため,性能が低下します。
- コマンド実行時にエラーが発生した場合は,インポート処理が一部だけ反映された状態になっています。エラーの原因を取り除いて再度コマンドを実行してください。
-dオプション,-fオプションを指定してコマンドを実行した場合は,同じオプションを指定して,再度コマンドを実行してください。-dオプション,-fオプションの両方とも指定していなかった場合は,-fオプションを指定して,再度コマンドを実行してください。
- -lオプションを指定してコマンドを実行し,エラーが発生した場合は,エラー発生時に出力されたインポート一覧ファイルの内容と,エラーの原因を取り除いて再度コマンドを実行したときに出力されたインポート一覧ファイルの内容を合わせて,インポート一覧ファイルとして利用してください。
- ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.contentsname.uniquecheck.enableプロパティ(一意の業務コンテンツ名称の指定可否)が「true」の場合,業務フローの名称が一意にならないときはエラーとなります。
- ユーザプロパティファイル(ucnp_user.properties)のucnp.base.client.menu.group.enableプロパティ(メニュー領域のグループ表示有無)が「false」の場合は,インポート一覧ファイルにグループ名は表示されませんが,グループ名の情報もインポートされています。そのため,プロパティの設定を「true」に変更すると,メニュー領域にグループ名が表示されるようになります。ただし,09-00より前のバージョンで作成した業務コンテンツをインポートすると,グループ名は空白となります。
- npexportコマンド(業務コンテンツのエクスポート)で-xオプションを指定してエクスポートしたファイルをインポートした場合,追加した業務コンテンツには標準アクセス権限を設定します。上書きする業務コンテンツのアクセス権は変更されません。
- バージョン09-50から,プラグインはプロセスノードに対して関連づけられるようになりますが,バージョン09-00以前で作成した業務コンテンツのプラグインについても自動的に処理されるため,バージョン09-00以前で作成した業務コンテンツのプラグインも使用できます。ただし,プラグインの配置のしかたによっては,npimportコマンドでインポートした業務コンテンツと,09-50以降で新たにプラグインを配置した業務コンテンツとでプラグインの動作が異なる場合があります。プラグインの動作の差異についてはマニュアル「Cosminexus V9 ナビゲーション プラットフォーム 開発ガイド」を参照してください。
戻り値
戻り値 | 説明 |
---|
0 | コマンドが正常終了した。 |
1 | コマンドが異常終了した。 |
- 注
- コマンド制御外のタイミングで終了した場合(<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」である。
- すべてのアクセス権グループと業務コンテンツを削除してからインポートする。
> ナビゲーション プラットフォームインストールディレクトリ¥bin¥npimport -d C:¥work¥repository.zip |
- 例4
- 次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
- インポートしたいファイルのパスが「C:¥work¥repository.zip」である。
- インポート後に出力するインポート一覧ファイルのパスを「C:¥work¥list.txt」とする。
> ナビゲーション プラットフォームインストールディレクトリ¥bin¥npimport -l C:¥work¥list.txt C:¥work¥repository.zip |
- 例5
- 次の条件で業務コンテンツをインポートする場合の使用例を次に示します。
- インポートしたいファイルのパスが「C:¥work¥repository.zip」である。
- アクセス権グループをインポートしない。
- インポート先にIDが同じ業務コンテンツが保存されている場合,強制登録しない。
> ナビゲーション プラットフォームインストールディレクトリ¥bin¥npimport -x C:¥work¥repository.zip |