6.3.2 フォルダ構成作成コマンドで使用するファイル

<この項の構成>
(1) 登録情報ファイル

(1) 登録情報ファイル

フォルダ構成作成コマンドを実行してフォルダを作成する場合に,作成するフォルダの情報を定義します。

(a) ファイルの形式

登録情報ファイルには,ヘッダ行とレコード行を記述します。登録情報ファイルの形式を次の図に示します。

図6-5 登録情報ファイルの形式(フォルダ構成作成コマンドの場合)

[図データ]

(b) ファイルの記述規則
(c) ヘッダ行の記述規則
(d) ヘッダ行とレコード行の指定形式

カラム名およびデータの指定内容とカラム番号の対応を次の表に示します。

表6-19 カラム名およびデータの指定内容とカラム番号の対応(フォルダ構成作成コマンド)

カラム番号カラム名※1の指定内容データの指定内容省略可否省略時仮定値
1登録結果ログファイルの出力に使用するフィールドのため,値は記述しません。空文字を指定します。
引数「-l」を指定してフォルダ構成作成コマンドを実行した場合,ログファイルのこの位置にコマンドの実行結果を示す値が出力されます。
出力される値を次に示します。
  • 1:フォルダの作成が成功しました。
  • 2:フォルダの作成でエラーが発生しました。
  • 空文字:作成処理は実行されませんでした。
2~11フォルダ名_<n>※21階層目から作成するフォルダまでのフォルダ名を記述します。フォルダ名は1~255バイト※3で記述してください。
注意
作成済みのフォルダの下位にフォルダを作成する場合,作成済みのフォルダについてもレコード行の指定が必要です。
どのフォルダの下位にフォルダを作成するかを識別するためです。
作成済みのフォルダの下位にフォルダを作成する場合の記述例について説明します。次の構成で,フォルダBの下位にフォルダCを作成します。
 フォルダA(作成済み)
  └フォルダB(作成済み)
    └フォルダC
登録情報ファイルには,次の3つのレコードを記述します。
  1. フォルダAのレコード行
    2カラム目にフォルダAのフォルダ名を記述します。3~11カラム目は空文字を指定します。
  2. フォルダBのレコード行
    2カラム目にフォルダA,3カラム目にフォルダBのフォルダ名を記述します。4~11カラム目は空文字を指定します。
  3. フォルダCのレコード行
    2カラム目にフォルダA,3カラム目にフォルダB,4カラム目にフォルダCのフォルダ名を記述します。5~11カラム目は空文字を指定します。
フォルダ名の指定方法の詳細は,「(e) フォルダ名の指定形式1」,または「(f) フォルダ名の指定形式2(直前のレコード行と作成先フォルダが同じ場合)」を参照してください。
不可
12フォルダ種別作成するフォルダのフォルダ種別を,次に示す値で記述します。
  • 1:ノードフォルダ
  • 2:文書フォルダ
  • 3:公開フォルダ
不可
13所有者IDフォルダの所有者のIDを記述します。
ただし,記述したIDが妥当かどうかはチェックされません。
不可
14ユーザの表示名称フォルダの所有者の名称を記述します。
ただし,記述した名称が妥当かどうかはチェックされません。
不可
15コメントフォルダのコメントを0~1,024バイト※3で記述します。改行コードは記述できません。空文字
16文書作成可否文書フォルダを作成する場合に,作成したフォルダに文書が作成できるかどうかを,次に示す値で記述します。
  • 0:文書が作成できない
  • 1:文書が作成できる
ノードフォルダまたは公開フォルダを作成する場合は,空文字を指定します。
文書フォルダを作成する場合:
不可
ノードフォルダまたは公開フォルダを作成する場合:
なし
17アクセス権限方式文書フォルダを作成する場合のアクセス権限方式を,次に示す値で記述します。
  • 1:個別に設定
  • 2:同じ権限を共有
ノードフォルダまたは公開フォルダを作成する場合は,空文字を指定します。
文書フォルダを作成する場合:
不可
ノードフォルダまたは公開フォルダを作成する場合:
なし
18公開範囲公開フォルダを作成する場合のフォルダの公開範囲を,次に示す値で記述します。
  • 1:全員に公開する
  • 2:公開範囲を限定する
ノードフォルダまたは文書フォルダを作成する場合は,空文字を指定します。
公開フォルダを作成する場合:
不可
ノードフォルダまたは文書フォルダを作成する場合:
なし
19文書種別フォルダに設定する文書種別の名称を記述します。
文書種別名は,[文書種別一覧]画面の表示名と一致させてください。
文書種別を設定しない
20フォルダ下に登録可能な容量最上位の階層に文書フォルダまたはノードフォルダを作成する場合で,そのフォルダに対して容量制限をするときに指定する項目です。
作成するフォルダ下に登録可能な文書ファイルの容量を,数値と単位を続けて記述します。
数値は1~9999の範囲で記述します。
単位にはMB(メガバイト),GB(ギガバイト)またはTB(テラバイト)を記述します。
指定例を次に示します。
指定例
500MB
容量制限をしない
21全てのユーザに対するアクセス権限アクセス権限方式が「個別に設定」の文書フォルダを作成する場合に,「全てのユーザ」に設定するアクセス権を指定します。次に示す値で記述します。
  • FULL_CONTROL:「全て」を設定します。
  • READ_WRITE:「更新」を設定します。
  • LINK:「リンク」を設定します。
  • READ:「参照」を設定します。
  • NONE:「なし」を設定します。
なお,「全てのユーザに対するアクセス権限」が指定できないフォルダに対して指定した場合,この指定を無視してフォルダが作成され,警告メッセージが出力されます。
NONE
22アクセス権限リスト次のフォルダを作成する場合に,フォルダに設定するアクセス権を指定します。
  • アクセス権限方式が「個別に設定」の文書フォルダ
  • アクセス権限方式が「同じ権限を共有」の権限を共有する最上位の文書フォルダ
  • 公開範囲が「公開範囲を限定する」の公開フォルダ
次に示す形式で値を記述します。
<アクセス権指定>/<アクセス権指定>/…
<アクセス権指定>※4を「/(スラント)」で区切って記述します。<アクセス権指定>は複数記述できます。ただし,記述できる数は配置ディスクリプタ(web.xml)のapp.ACLObjNumパラメタに設定した値までです。NO_ACLを指定した場合,アクセス権は設定されません。
なお,「アクセス権限リスト」が指定できないフォルダに対して指定した場合,この指定を無視してフォルダが作成され,警告メッセージが出力されます。
上位のフォルダに設定されているアクセス権を継承
(凡例)
-:該当しません。
注※1
登録情報ファイルのカラム名には,次の内容をコピーして使用してください。
登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,フォルダ種別,所有者ID,ユーザの表示名称,コメント,文書作成可否,アクセス権限方式,公開範囲,文書種別,フォルダ下に登録可能な容量,全てのユーザに対するアクセス権限,アクセス権限リスト
注※2
<n>はフォルダの階層を示す1~10の半角の整数値です。
注※3
文字コード種別がUTF-8の場合のバイト数です。
バイト数を確認するときは,UTF-8形式で文字列長を調べてください。
注※4
<アクセス権指定>の記述形式を次に示します。「設定対象ID」,「種別」,「アクセス権」を「:(コロン)」で区切って指定します。
設定対象ID:種別:アクセス権
各項目の記述内容を次に示します。
設定対象ID
アクセス権を設定するユーザ,組織,またはグループのIDを記述します。
ただし,記述したIDが妥当かどうかはチェックされません。なお,不正なIDを記述した場合,不正なIDがフォルダのアクセス権に設定されたままになります。このときは,システム管理者が[フォルダのアクセス権]画面からIDを削除してください。
種別
設定対象IDの種別を次に示す値で記述します。
  • U:ユーザの場合
  • G:組織またはグループの場合
アクセス権
設定対象に設定するアクセス権を次に示す値で記述します。
  • FULL_CONTROL:「全て」を設定します。
  • READ_WRITE:「更新」を設定します。
  • LINK:「リンク」を設定します。
  • READ:「参照」を設定します。
  • NONE:「なし」を設定します。
なお,公開範囲が「公開範囲を限定する」の公開フォルダにアクセス権を設定する場合,指定できるのは「READ_WRITE」だけです。それ以外の値を指定するとエラーになります。
<アクセス権指定>を複数記述した場合の例を次に示します。
user01:U:READ/user02:U:FULL_CONTROL/grp01:G:READ_WRITE
(e) フォルダ名の指定形式1

カラム番号2番から11番までのデータには,1階層目から作成するフォルダまでのそれぞれのフォルダ名を記述します。フォルダ名は,フォルダ階層と対応させて記述する必要があります。また,作成済みのフォルダの下位にフォルダを作成する場合は,作成済みフォルダについてもレコード行を記述します。

登録情報ファイルにフォルダ名を指定する例を次の図に示します。

図6-6 登録情報ファイルの指定例1(フォルダ構成作成コマンドの場合)

[図データ]

例題
次に示すフォルダを作成します。なお,フォルダ「大阪府」および「大阪市」は作成済みとします。
  • 「大阪府」の下位に「堺市」を作成
  • 「大阪市」の下位に「中央区」および「浪速区」を作成
  • 最上位の階層に「兵庫県」,その下位に「神戸市」を作成
登録情報ファイル
登録情報ファイルには,ヘッダ行1行とレコード行7行を記述します。なお,図6-6の登録情報ファイルではカラム番号2番,3番,4番,および11番以外の記述を省略しています。
登録情報ファイルの各行に記述する内容を次に示します。
行数記述内容
1ヘッダ行を記述します。
22カラム目にフォルダ名「大阪府」を記述します。3~11カラム目は空文字にします。
32カラム目にフォルダ名「大阪府」,3カラム目にフォルダ名「大阪市」を記述します。4~11カラム目は空文字にします。
42カラム目にフォルダ名「大阪府」,3カラム目にフォルダ名「大阪市」,4カラム目にフォルダ名「中央区」を記述します。5~11カラム目は空文字にします。
52カラム目にフォルダ名「大阪府」,3カラム目にフォルダ名「大阪市」,4カラム目にフォルダ名「浪速区」を記述します。5~11カラム目は空文字にします。
62カラム目にフォルダ名「大阪府」,3カラム目にフォルダ名「堺市」を記述します。4~11カラム目は空文字にします。
72カラム目にフォルダ名「兵庫県」を記述します。3~11カラム目は空文字にします。
82カラム目にフォルダ名「兵庫県」,3カラム目にフォルダ名「神戸市」を記述します。4~11カラム目は空文字にします。
フォルダ構成作成コマンドの実行結果
登録情報ファイルを引数「-r」に指定してフォルダ構成作成コマンドを実行すると,図6-6のフォルダ階層に示す階層でフォルダが作成されます。
(f) フォルダ名の指定形式2(直前のレコード行と作成先フォルダが同じ場合)

直前のレコード行と作成先フォルダが同じ場合,次のレコード行では作成先フォルダの指定を省略できます。

図6-6の例では,フォルダ「中央区」の作成先フォルダ「大阪市」が直前のレコード行に記述されています。また,フォルダ「大阪市」の作成先フォルダ「大阪府」が直前のレコード行に指定されています。

そのため,フォルダ「中央区」を作成するレコード行では,「大阪府」と「大阪市」の記述を省略できます。

図6-6の例と同様のフォルダを作成する場合で,作成先フォルダの記述を省略した登録情報ファイルの例を次の図に示します。

図6-7 登録情報ファイルの指定例2(フォルダ構成作成コマンドの場合)

[図データ]