[機能]
Navigatorクライアントで作成した問い合わせファイルを使用して、List Creatorで利用できるカンマ区切りのCSV形式のデータファイルを生成します。
[記述形式]
以下に、コマンドの記述形式を示します。
[ ]は、省略できることを示します。
オプション1、オプション2、オプション3…には、naviexecコマンドのオプションを記述します。
naviexec [ オプション1 ] [ オプション2 ] [ オプション3 ] …
以下に、naviexecコマンドのオプション一覧を示します。
オプション | 【アプリケーションサーバのオペレーティングシステム】 | |||
---|---|---|---|---|
W | S | L | ||
"問い合わせファイル名" (*1) | ○ | ○ | - | |
"出力データファイル名" (*1) | ○ | ○ | - | |
"帳票名" | ○ | ○ | - | |
○ | ○ | - | ||
"DB接続ユーザ名" (*2) | ○ | ○ | - | |
"DB接続パスワード" (*2) | ○ | ○ | - | |
"DBサーバ名" (*3) | ○ | ○ | - | |
○ | ○ | - | ||
"Database Direct接続パスワード" (*1) | ○ | ○ | - | |
"Database Direct接続サーバ名" (*1) | ○ | ○ | - | |
データ項目名:[項目識別番号]:[条件指定]: ["一致キー[,一致キー]"]:[検索方法]:[一致処理方式]: [指定範囲]:[下限値包含指定]:["下限値"]:[上限値包含指定]:["上限値"] | ○ | ○ | - | |
○ | ○ | - |
*1:
省略できません。
*2:
データベースの種別が「SymfoWARE/RDB」(-dbtypeオプションで「SYMFORDB」を指定)で、SymfoWARE/RDBとList Manager Database Directが同一サーバに実装されている場合(-cserverオプションでDBサーバ名を指定しない場合)のみ省略できます。これ以外の場合は、必ず指定してください。
*3:
データベースの種別が「SymfoWARE/RDB」(-dbtype オプションで「SYMFORDB」を指定)で、SymfoWARE/RDB とList Manager Database Direct が別サーバに実装されている場合にだけ指定します。
オプションについて説明します。
なお、オプションは、使用するオペレーティングシステムによって機能範囲や留意事項などが異なる場合があります。オペレーティングシステムによって記載内容が異なる場合は、それぞれの場合に分けて説明します。
List Manager Database Directと連携し、データベース内のデータを検索して取り出す場合に、Navigatorクライアントで生成した問い合わせファイル名(拡張子「rne」)を指定します。
問い合わせファイル名は、全体を「ダブルクォーテーション(")」で囲み、英数字259文字以内のフルパスで指定します。このオプションは省略できません。
注意
問い合わせファイルは、Navigatorクライアントを使用して事前に作成しておく必要があります。
List Manager Database Directと連携し、データベース内のデータを検索して取り出す場合に、Navigatorクライアントで生成した問い合わせファイル名(拡張子「rne」)を指定します。
問い合わせファイル名は、全体を「ダブルクォーテーション(")」で囲み、英数字259文字以内のフルパスで指定します。このオプションは省略できません。
注意
問い合わせファイルは、Navigatorクライアントを使用して事前に作成しておく必要があります。
生成するデータファイル(CSVファイル)名を指定します。
CSVファイル名は、全体を「ダブルクォーテーション(")」で囲み、259バイト以内のフルパスで指定します。生成されるCSVファイルは、List Creatorの入力データ(データファイル)として利用可能な形式で出力されます。
生成するデータファイル(CSVファイル)名を指定します。
CSVファイル名は、全体を「ダブルクォーテーション(")」で囲み、1023バイト以内のフルパスで指定します。生成されるCSVファイルは、List Creatorの入力データ(データファイル)として利用可能な形式で出力されます。
生成するCSVファイルを入力データ(データファイル)として使用する帳票名を指定します。帳票名は、全体を「ダブルクォーテーション(")」で囲んで指定します。
マルチフォーム用のデータファイルとしてこのオプションで指定された帳票名がCSVファイルの各行の先頭に付加されて生成されます。このデータファイルが利用できるのは、以下の形式の帳票のみです。
入力データ形式 =「CSV形式」
区切り文字 =「カンマ(,)」
DBタイプ =「データファイル」
このオプションを省略すると、生成されるCSVファイルの各行の先頭には何も付加されません。
生成するCSVファイルを入力データ(データファイル)として使用する帳票名を指定します。帳票名は、全体を「ダブルクォーテーション(")」で囲んで指定します。
マルチフォーム用のデータファイルとしてこのオプションで指定された帳票名がCSVファイルの各行の先頭に付加されて生成されます。このデータファイルが利用できるのは、以下の形式の帳票のみです。
入力データ形式 =「CSV形式」
区切り文字 =「カンマ(,)」
DBタイプ =「データファイル」
このオプションを省略すると、生成されるCSVファイルの各行の先頭には何も付加されません。
接続するデータベースの種別を指定します。
SymfoWARE/RDB
Oracle
SQL Server
Shunsakuと連携する場合は、接続するデータベース種別および資源名を、「DB種別:資源名」の形式で指定します。
このオプションを省略すると、「SYMFORDB」が指定されたものとして動作します。
注意
このオプションに「DB種別:資源名」の形式でデータベース種別を指定した場合は、必ずShunsaku連携を行います。このとき、「ORACLE:」のように":"で終わる文字列を指定すると、パラメタエラーとなります。
このオプションに「DB種別:資源名」の形式で指定する場合、資源名は以下のとおり指定してください。
・資源名として指定できる文字/指定できない文字
指定できる文字/指定できない文字は、以下のとおりです。
指定できる文字 | 全角文字 | 全角文字すべて |
半角文字 |
| |
指定できない文字 |
|
・資源名の名称規則
以下の規則に該当する名称は、指定できません。
‐全角文字と半角文字が混在した名称
資源名は、必ず全角文字のみ、または半角文字のみで指定してください。
‐数字で始まる名称
必ず半角英文字、または指定できる記号から始まる名称を指定してください。
‐Database Direct(Navigator)の予約語
‐半角のKVRで始まる名称
以下に指定例を示します。この例では、Oracleを使用して、資源名「ResourceName」でShunsaku連携を行います。
-dbtype ORACLE:ResourceName
接続するデータベースの種別を指定します。
SymfoWARE/RDB
Oracle
SQL Server(Windows上のSQL Serverに接続する場合に指定)
Shunsakuと連携する場合は、接続するデータベース種別および資源名を、「DB種別:資源名」の形式で指定します。
このオプションを省略すると、「SYMFORDB」が指定されたものとして動作します。
注意
このオプションに「DB種別:資源名」の形式でデータベース種別を指定した場合は、必ずShunsaku連携を行います。このとき、「ORACLE:」のように":"で終わる文字列を指定すると、パラメタエラーとなります。
このオプションに「DB種別:資源名」の形式で指定する場合、資源名は以下のとおり指定してください。
・資源名として指定できる文字/指定できない文字
指定できる文字/指定できない文字は、以下のとおりです。
指定できる文字 | 全角文字 | 全角文字すべて |
半角文字 |
| |
指定できない文字 |
|
・資源名の名称規則
以下の規則に該当する名称は、指定できません。
‐全角文字と半角文字が混在した名称
資源名は、必ず全角文字のみ、または半角文字のみで指定してください。
‐数字で始まる名称
必ず半角英文字、または指定できる記号から始まる名称を指定してください。
‐Database Direct(Navigator)の予約語
‐半角のKVRで始まる名称
以下に指定例を示します。この例では、Oracleを使用して、資源名「ResourceName」でShunsaku連携を行います。
-dbtype ORACLE:ResourceName
データベースに接続する際のユーザ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別が「SymfoWARE/RDB」で、SymfoWARE/RDBとList Manager Database Directが同一サーバに実装されている場合(-cserver オプションでDBサーバ名を指定しない場合)のみ省略できます。これ以外の場合は、必ず指定してください。
データベースに接続する際のユーザ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別が「SymfoWARE/RDB」で、SymfoWARE/RDBとList Manager Database Directが同一サーバに実装されている場合(-cserver オプションでDBサーバ名を指定しない場合)のみ省略できます。これ以外の場合は、必ず指定してください。
データベースに接続する際のユーザパスワードを「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別が「SymfoWARE/RDB」で、SymfoWARE/RDBとList Manager Database Directが同一サーバに実装されている場合(-cserver オプションでDB サーバ名を指定しない場合)のみ省略できます。これ以外の場合は、必ず指定してください。
データベースに接続する際のユーザパスワードを「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別が「SymfoWARE/RDB」で、SymfoWARE/RDBとList Manager Database Directが同一サーバに実装されている場合(-cserver オプションでDB サーバ名を指定しない場合)のみ省略できます。これ以外の場合は、必ず指定してください。
データベースエンジンを実装するサーバ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別がSymfoWARE/RDBで、SymfoWARE/RDBとList Manager Database Directが別サーバに実装されている場合にだけ指定します。
データベースエンジンを実装するサーバ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは、データベースの種別がSymfoWARE/RDBで、SymfoWARE/RDBとList Manager Database Directが別サーバに実装されている場合にだけ指定します。
List Manager Database Directに接続するユーザ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
List Manager Database Directに接続するユーザ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
List Manager Database Directに接続する際のパスワードを「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
List Manager Database Directに接続する際のパスワードを「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
List Manager Database Directが稼動しているサーバ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
List Manager Database Directが稼動しているサーバ名を「ダブルクォーテーション(")」で囲んで指定します。このオプションは省略できません。
[ ]は、省略できることを示します。
問い合わせファイルに定義されている問い合わせ条件を動的に変更する場合に、その条件を指定します。1つの項目に対し、いくつかの検索条件を1セットとしてグループ化して指定します。指定する1セット内の各オプションは、「コロン(:)」で区切って指定します。1セット内で指定しないオプション(条件)がある場合でも、「コロン(:)」は省略できません。
また、一度に複数の項目に対して条件を指定する場合は、検索条件のセットと次のセットの間を「カンマ(,)」で区切って指定します。
注意
複数の検索条件を同時に指定した場合、その条件が論理積(AND)、または論理和(OR)のどちらで処理されるのかについては、このオプションで動的に変更することはできません。Navigatorクライアントで検索条件を設定する(問い合わせファイルを作成する)際にあらかじめ設定しておく必要があります。
以下に、-conditionオプションの各パラメータでの指定について説明します。
Navigatorクライアントで問い合わせファイルを作成する場合(問い合わせ表のレイアウト指定時)に、検索条件として指定されたデータ項目名を指定します。問い合わせファイルの検索条件を動的に変更する場合は、このオプションは省略できません。
「データ項目名」オプションで指定したデータ項目名が、問い合わせファイル内で検索条件の設定項目として複数個登録されていた場合に、どの指定を処理対象とするかを指定します。
問い合わせファイルを作成する登録画面で、同一名の項目のうち画面の左側から最初に出現したものを0番として項目識別番号を指定します。また、同一名のデータ項目名が他に存在しない場合も0番として指定します。
省略すると、「0」が指定されたものとして動作します。
指定したデータ項目を検索する場合の条件の判定種別を指定します。
文字列を指定して一致するものを検索します。
範囲を指定して一致するものを検索します。
NULL値を検索します。
NULL値以外のすべてのデータを検索します。
「MATCH」、「RANGE」、および「NULL」の各項目は、「バーティカルバー(|)」を利用して「MATCH|NULL」のように組み合わせて同時に指定することもできます。
省略すると、「MATCH」が指定されたものとして動作します。
検索条件を判定する場合の左辺値となるキー値を指定します。対象となるデータ項目が数値型の場合、数値を文字で指定します。複数のキーを指定する場合は、各文字列を「カンマ(,)」で区切って指定し、項目全体を「ダブルクォーテーション(")」で囲んで指定します。キーの値にカンマを指定することはできません。
「条件指定」に「MATCH」が指定された場合は、このオプションは省略できません。
条件の一致・不一致を判定する場合の検索条件にあたる文字列の判定方法を指定します。
指定された文字列と完全に一致するデータを検索します。
先頭が指定された文字列と一致するデータを検索します。
指定された文字列と一部が一致するデータを検索します。
末尾が指定された文字列と一致するデータを検索します。
検索対象のデータ項目が数値型の場合は、「COMPLETE」のみ指定できます。
このオプションは、「条件指定」に「MATCH」が指定された場合にのみ有効となります。
省略すると、「COMPLETE」が指定されたものとして動作します。
一致しないデータを処理対象とするかどうかを指定します。
一致するデータを対象とします。
一致しないデータを対象とします。
このオプションは、「条件指定」に「MATCH」が指定された場合にのみ有効となります。
省略すると、「MATCH」が指定されたものとして動作します。
範囲を指定して検索を行う場合において、対象とする範囲の種別を選択します。
下限値より小さい値を示します。
下限値より大きく、上限値より小さい範囲を示します。
上限値より大きい値を示します。
「UNDER」と「OVER」は、「バーティカルバー(|)」を利用して「UNDER|OVER」のように組み合わせて同時に指定することもできます。
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「BETWEEN」が指定されたものとして動作します。
「指定範囲」オプションの設定において、対象範囲に下限値の値を含むかどうかを指定します。
含む
含まない
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「INCLUDE」が指定されたものとして動作します。
「指定範囲」オプションの設定において、下限値部分に相当する値を指定します。下限値は、全体を「ダブルクォーテーション(")」で囲んで指定します。
「条件指定」に「RANGE」が指定され、「指定範囲」に「UNDER」または「BETWEEN」が指定された場合は、このオプションの指定は省略できません。「RANGE」以外を指定した場合、このオプションの指定は無効となります。
「指定範囲」オプションの設定において、対象範囲に上限値の値を含むかどうかを指定します。
含む
含まない
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「INCLUDE」が指定されたものとして動作します。
「指定範囲」オプションの設定において、上限値部分に相当する値を指定します。上限値は、全体を「ダブルクォーテーション(")」で囲んで指定します。
「条件指定」に「RANGE」が指定され、「指定範囲」に「OVER」または「BETWEEN」が指定された場合は、このオプションの指定は省略できません。「RANGE」以外を指定した場合、このオプションの指定は無効となります。
問い合わせファイルに定義されている問い合わせ条件を動的に変更する場合に、その条件を指定します。1つの項目に対し、いくつかの検索条件を1セットとしてグループ化して指定します。指定する1セット内の各オプションは「コロン(:)」で区切って指定します。1セット内で指定しないオプション(条件)がある場合でも、「コロン(:)」は省略できません。
また、一度に複数の項目に対して条件を指定する場合は、検索条件のセットと次のセットの間を「カンマ(,)」で区切って指定します。
注意
複数の検索条件を同時に指定した場合、その条件が論理積(AND)、または論理和(OR)のどちらで処理されるのかについては、このオプションで動的に変更することはできません。Navigatorクライアントで検索条件を設定する(問い合わせファイルを作成する)際にあらかじめ設定しておく必要があります。
以下に、各オプションでの指定について説明します。
Navigatorクライアントで問い合わせファイルを作成する場合(問い合わせ表のレイアウト指定時)に、検索条件として指定されたデータ項目名を指定します。問い合わせファイルの検索条件を動的に変更する場合は、このオプションは省略できません。必ず指定してください。
「データ項目名」オプションで指定したデータ項目名が、問い合わせファイル内で検索条件の設定項目として複数個登録されていた場合に、どの指定を処理対象とするかを指定します。
問い合わせファイルを作成する登録画面で、同一名の項目のうち画面の左側から最初に出現したものを0番として項目識別番号を指定します。また、同一名のデータ項目名が他に存在しない場合も0番として指定します。
省略すると、「0」が指定されたものとして動作します。
指定したデータ項目を検索する場合の条件の判定種別を指定します。
文字列を指定して一致するものを検索します。
範囲を指定して一致するものを検索します。
NULL値を検索します。
NULL値以外のすべてのデータを検索します。
「MATCH」、「RANGE」、および「NULL」の各項目は、「バーティカルバー(|)」を利用して「MATCH|NULL」のように組み合わせて同時に指定することもできます。
省略すると、「MATCH」が指定されたものとして動作します。
検索条件を判定する場合の左辺値となるキー値を指定します。対象となるデータ項目が数値型の場合、数値を文字で指定します。複数のキーを指定する場合は、各文字列を「カンマ(,)」で区切って指定し、項目全体を「ダブルクォーテーション(")」で囲んで指定します。キーの値にカンマを指定することはできません。
「条件指定」に「MATCH」が指定された場合は、このオプションは省略できません。
条件の一致・不一致を判定する場合の検索条件にあたる文字列の判定方法を指定します。
指定された文字列と完全に一致するデータを検索します。
先頭が指定された文字列と一致するデータを検索します。
指定された文字列と一部が一致するデータを検索します。
末尾が指定された文字列と一致するデータを検索します。
検索対象のデータ項目が数値型の場合は、「COMPLETE」のみ指定できます。
このオプションは、「条件指定」に「MATCH」が指定された場合にのみ有効となります。
省略すると、「COMPLETE」が指定されたものとして動作します。
一致しないデータを処理対象とするかどうかを指定します。
一致するデータを対象とします。
一致しないデータを対象とします。
このオプションは、「条件指定」に「MATCH」が指定された場合にのみ有効となります。
省略すると、「MATCH」が指定されたものとして動作します。
範囲を指定して検索を行う場合において、対象とする範囲の種別を選択します。
下限値より小さい値を示します。
下限値より大きく、上限値より小さい範囲を示します。
上限値より大きい値を示します。
「UNDER」と「OVER」は、「バーティカルバー(|)」を利用して「UNDER|OVER」のように組み合わせて同時に指定することもできます。
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「BETWEEN」が指定されたものとして動作します。
「指定範囲」オプションの設定において、対象範囲に下限値の値を含むかどうかを指定します。
含む
含まない
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「INCLUDE」が指定されたものとして動作します。
「指定範囲」オプションの設定において、下限値部分に相当する値を指定します。下限値は、全体を「ダブルクォーテーション(")」で囲んで指定します。
「条件指定」に「RANGE」が指定され、「指定範囲」に「UNDER」または「BETWEEN」が指定された場合は、このオプションの指定は省略できません。「RANGE」以外を指定した場合、このオプションの指定は無効となります。
「指定範囲」オプションの設定において、対象範囲に上限値の値を含むかどうかを指定します。
含む
含まない
このオプションは、「条件指定」に「RANGE」が指定された場合にのみ有効となります。
省略すると、「INCLUDE」が指定されたものとして動作します。
「指定範囲」オプションの設定において、上限値部分に相当する値を指定します。上限値は、全体を「ダブルクォーテーション(")」で囲んで指定します。
「条件指定」に「RANGE」が指定され、「指定範囲」に「OVER」または「BETWEEN」が指定された場合は、このオプションの指定は省略できません。「RANGE」以外を指定した場合、このオプションの指定は無効となります。
CSVファイルを生成する際に、既存のファイルの末尾に追加する形式で書き込みする場合に指定します。このオプションを指定すると、-csvオプションで指定されたCSVファイルが存在するかどうかを検索し、存在した場合はそのファイルの末尾に結果を追加形式で書き込みます。存在しない場合は、新規にファイルを生成して書き込みます。
省略すると、該当するファイルの存在の有無にかかわらず、新規にファイルを生成して書き込みを行います。
CSVファイルを生成する際に、既存のファイルの末尾に追加する形式で書き込みする場合に指定します。このオプションを指定すると、-csvオプションで指定されたCSVファイルが存在するかどうかを検索し、存在した場合はそのファイルの末尾に結果を追加形式で書き込みます。存在しない場合は、新規にファイルを生成して書き込みます。
省略すると、該当するファイルの存在の有無にかかわらず、新規にファイルを生成して書き込みを行います。
[記述例]
naviexecコマンドの記述例は、以下を参照してください。
⇒“4.4.1.2 naviexecコマンドの記述例”
[復帰値]
以下に復帰値を示します。
復帰値 | 意味 |
---|---|
0 | CSV出力処理の実行が正常に終了した。 |
1 | CSV出力処理を実行した結果、CSVファイルに出力するデータが存在しなかった。 |
-1 | CSV出力処理の実行中にエラーが発生した。 |
エラー発生時は、イベントログにエラー内容の詳細が出力されます。
以下に復帰値を示します。
復帰値 | 意味 |
---|---|
0 | CSV出力処理の実行が正常に終了した。 |
1 | CSV出力処理を実行した結果、CSVファイルに出力するデータが存在しなかった。 |
-1 | CSV出力処理の実行中にエラーが発生した。 |
エラー発生時は、システムログにエラー内容の詳細が出力されます。
[注意]
生成されるCSVファイルは、帳票出力用のデータファイルとして使用します。
出力データファイルは、-wオプションを指定すると、指定した帳票名が付加され、マルチフォーム出力用の形式で作成されます。