サンプルファイルを編集してプラグイン情報プロパティファイルを作成する際の注意事項を次に示します。

• プロパティファイルの文字は，ISO 8859-1（Latin1）でエンコードされます。ISO 8859-1以外の文字コードの文字は使用できません。
• Windowsの予約デバイス名（CON，AUX，COMn（nは1〜9），LPTn（nは1〜9），PRN，NUL，CLOCK$）は使用できません。
• 行頭文字に「#」または「!」を指定した場合，行全体がコメントと見なされます。
• 行頭に続く空白文字（半角スペース，タブまたは改行）は無視されます。

プロパティファイルの記述形式の例を次に示します。なお，説明中の「空白文字」は半角スペース，タブまたは改行を指します。

プロパティキー=値

• プロパティキーと値の間には「:」または「=」を記述してください。プロパティキー，「:」または「=」，値の間に空白文字を指定しても無視されます。
• プロパティキーの次の文字（空白文字を除く）が「:」または「=」の場合，その次の文字（空白文字を除く）から行末文字までが値として解釈されます。
• プロパティキーの次の文字（空白文字を除く）が「:」または「=」でない場合，その文字から行末文字までが値として解釈されます。
• 値の後ろに空白文字を付加した場合，値の一部と解釈されます。
• 値の中に「:」，「=」，「#」，または「!」が使用されている場合，値の一部と解釈されます。

プラグイン情報プロパティファイルに指定するプロパティキーを次に示します。

• すべてのプラグインで使用するプロパティキー
  
  • userplugin.id
  • userplugin.name
  • userplugin.version
  • userplugin.java.package
• 入出力プラグインで使用するプロパティキー
  
  • userplugin.server.controller.ioaction
  • userplugin.server.controller.ioaction.type
• 中断再開プラグインで使用するプロパティキー
  userplugin.server.controller.suspend
  

各プロパティキーの詳細を次に示します。

(a)　userplugin.id

プラグインIDを指定します。プラグインIDはシステム内でユニークになるようにしてください。なお，中断再開プラグインの場合，必ず固定値「ucnp.plugin.suspend」を指定してください。

使用できる文字

• 半角英数字
• 半角ピリオド（.）
• 半角アンダースコア（_）
  

  注意

  使用できる文字の組み合わせの制限を次に示します。

  • 中断再開プラグインはシステム内で一つしか登録できないため，固定値「ucnp.plugin.suspend」で指定する必要があります。「ucnp.plugin.suspend」以外の値を設定した場合，中断再開プラグインではなく，入出力プラグインとして識別されます。
  • 入出力プラグインの場合，末尾にピリオドは指定しないでください。また，「ucnp」で始まるIDは指定できません。なお，「ucnp」の大文字，小文字は区別されないため，「UCNP」や「uCnp」も指定できません。

指定できる文字列長

1〜64バイト

指定する値の例

userplugin

(b)　userplugin.name

プラグイン名を指定します。プラグイン名はシステム内でユニークになるようにしてください。

使用できる文字

• 半角英数字

ただし，「ucnp」で始まるプラグイン名は指定できません。なお，「ucnp」の大文字，小文字は区別されないため，「UCNP」や「uCnp」も指定できません。また，「env」および「AppName」はプラグイン名として指定できません。

指定できる文字列長

1〜31バイト

指定する値の例

userplugin

(c)　userplugin.version

プラグインのバージョンを指定します。

使用できる文字

• 半角英数字
• 半角ピリオド（.）
• 半角アンダースコア（_）
• 半角ハイフン（-）

指定できる文字列長

1〜32バイト

指定する値の例

00.01

(d)　userplugin.java.package

Javaパッケージ名を指定します。

使用できる文字

• 半角英数字
• 半角ピリオド（.）
• Javaパッケージ名称として有効な文字列
• Windowsの予約デバイス名となるディレクトリが作られないような文字列

ただし，「jp.co.hitachi.soft.ucnp」から始まるパッケージ名は指定しないでください。

指定できる文字列長

1バイト以上

ただし，「Javaパッケージ名＋プラグインID＋入出力アクションコントローラクラス名」または「Javaパッケージ名＋プラグインID＋中断再開アクションコントローラクラス名」の合計が128バイト以内になるよう指定してください。

指定する値の例

sample.userplugin

(e)　userplugin.server.controller.ioaction

入出力アクションコントローラクラス名を指定します。「3.1.2　ひな形プラグイン作成コマンドの実行」では，このクラス名を基にコントローラクラスが生成されます。

使用できる文字

• 半角英数字
• 半角アンダースコア（_）
• Javaクラス名称として有効な文字列
• Windowsの予約デバイス名を含まない文字列
• Javaパッケージ名と組み合わせた値がシステム内でユニークになる文字列

指定できる文字列長

1バイト以上

ただし，「Javaパッケージ名＋プラグインID＋入出力アクションコントローラクラス名」の合計が128バイト以内になるよう指定してください。

指定する値の例

IoPluginController

(f)　userplugin.server.controller.ioaction.type

入出力アクションコントローラクラスを識別する文字列を指定します。システム内でユニークになるようにしてください。「3.1.2　ひな形プラグイン作成コマンドの実行」では，この文字列を基に入出力プラグイン用XMLファイル（ioaction.xml）が生成されます。なお，入出力プラグイン用XMLファイルとは，業務編集画面に表示される［Plugins］パレットおよびプラグインパーツの表示内容を定義したファイルです。一般には，生成するひな形プラグインのIDと同じ値を指定しますが，異なる値も指定できます。

使用できる文字

• 半角英数字
• 半角ピリオド（.）
• 半角アンダースコア（_）
• 半角ハイフン（-）

指定できる文字列長

1〜64バイト

指定する値の例

userplugin

(g)　userplugin.server.controller.suspend

中断再開アクションコントローラクラス名を指定します。

使用できる文字

• 半角英数字
• 半角アンダースコア（_）
• Javaクラス名称として有効な文字列
• Windowsの予約デバイス名を含まない文字列
• Javaパッケージ名と組み合わせた値がシステム内でユニークになる文字列

指定できる文字列長

1バイト以上

ただし，「Javaパッケージ名＋プラグインID＋中断再開アクションコントローラクラス名」の合計が128バイト以内になるよう指定してください。

指定する値の例

SuspendActionController

プラグイン情報プロパティファイルの記述例を次に示します。

入出力プラグインの場合

userplugin.id = userplugin userplugin.name = userplugin userplugin.version = 00.01 userplugin.java.package = sample.userplugin userplugin.server.controller.ioaction = IoPluginController userplugin.server.controller.ioaction.type = userplugin

中断再開プラグインの場合

userplugin.id = ucnp.plugin.suspend userplugin.name = userplugin userplugin.version = 00.01 userplugin.java.package = sample.userplugin userplugin.server.controller.suspend = SuspendActionController