パレット定義ファイル書式ガイド

  1. パレット定義ファイルについて
  2. 名前空間と文書要素
  3. リファレンス
    1. PaletteDefine
    2. Palette
    3. PartsTab
    4. Parts
  4. 新規コンポーネント/マッパー関数の追加
  5. サンプル

1 パレット定義ファイルについて

フローデザイナーは初回起動時に「DESIGNER_HOME/conf/PaletteDefine.xconf」というファイルを読み込んでコンポーネントやマッパー関数の パレットを作成します。
(2回目以降はこのファイルは「Document and setting/USER/.asteria/PaletteDefine.xconf」にコピーされ、ユーザーのパレット編集内容はこちらに保存されます。)
ここではその定義ファイルの書式について説明します。

2 名前空間と文書要素

パレット定義ファイルの要素は全て上記の名前空間に属します。

3 リファレンス

3.1 PaletteDefine

文書要素です。
PaletteDefine要素は複数のPalette要素を持ちます。

3.2 Palette

パレットの種別を示す要素です。
name属性に「Component」または「Function」を指定します。

属性
name 必須 パレット種別を指定します。
  • Component - コンポーネント
  • Function - マッパー関数

3.3 PartsTab

パレットのタブを示す要素です。

属性
name 必須 パレットのタブ名を指定します。
visible タブを表示状態を指定します。
  • true - タブは表示されています。
  • false - タブは非表示です。(メニューから表示させることができます。)
  • never - タブは隠されていて表示されることはありません。

3.4 Parts

コンポーネント/マッパー関数を示す要素です。
同じコンポーネント/マッパー関数(nameが同じParts要素)を複数同時に別タブに配置することもできます。

属性
name 必須 コンポーネント/マッパー関数の名前を指定します。
名前はComponentDefine.xconfのComponent/@name(FunctionDefine.xconfのFunction/@name)の値です。

4 新規コンポーネント/マッパー関数の追加

フローデザイナーは起動時にflowlibにあるjarファイルからコンポーネント/マッパー関数の一覧を作成します。
この時に存在するコンポーネント/マッパー関数がPaletteDefne.xconfのParts要素として存在しない場合は、 新規に追加されたものとして新たにパレットにインストールされます。
(インストール先のタブはComponentDefine.xconfのComponent/@category(FunctionDefine.xconfのFunction/@category)で指定されたタブになります。)

つまり、あるコンポーネント/マッパー関数をパレット上から完全に非表示にする場合は、該当するParts要素を削除する のではなく、visible="never"のPartsTabへ移動させる必要があります。
(Parts要素自体を削除した場合は次回起動時に再度インストールされることになります。)

起動時にPaletteDefine.xconfが存在しなかった場合は、全てのコンポーネント/マッパー関数がインストールされた状態で 新たにPaletteDefine.xconfが作成されます。

5 サンプル


<PaletteDefine xmlns="http://www.infoteria.com/asteria/flowengine/palette">
	<Palette name="Component">
		<PartsTab name="Control">
			<Parts name="EndResponse"/>
			<Parts name="End"/>
			<Parts name="Abort"/>
			<Parts name="Break"/>
			<Parts name="Mapper2"/>
			<Parts name="Converter"/>
			<Parts name="LoopStart"/>
			<Parts name="RecordLoop"/>
			<Parts name="TextSplitLoop"/>
			<Parts name="EXE"/>
			<Parts name="Mutex"/>
			<Parts name="Log"/>
			<Parts name="StreamProperty"/>
			<Parts name="Ant"/>
			<Parts name="JavaClass"/>
			<Parts name="SubFlow2"/>
			<Parts name="InlineSubFlowStart"/>
			<Parts name="LoopEnd"/>
		</PartsTab>
		<PartsTab name="Branch" visible="false">
			<Parts name="BranchFilterStart"/>
			<Parts name="BranchFilterEnd"/>
			<Parts name="BranchByComponentProperty"/>
			<Parts name="BranchByException"/>
			<Parts name="BranchByStreamType"/>
		</PartsTab>
		<PartsTab name="Storage">
			<Parts name="FileSystem(Get)"/>
			<Parts name="CSV(Get)"/>
			<Parts name="FileSystem(Put)"/>
			<Parts name="FileList"/>
			<Parts name="RDB(Get)"/>
			<Parts name="RDB(Put)"/>
			<Parts name="SQLCall"/>
			<Parts name="Queue(Get)"/>
			<Parts name="Queue(Put)"/>
		</PartsTab>
		<PartsTab name="Network">
			<Parts name="HTTP(Get)"/>
			<Parts name="HTTP(Put)"/>
			<Parts name="FTP(Get)"/>
			<Parts name="FTP(Put)"/>
			<Parts name="FTPScript"/>
			<Parts name="FTPFileList"/>
			<Parts name="IMAP4"/>
			<Parts name="POP3"/>
			<Parts name="SimpleMail"/>
			<Parts name="AttachmentMail"/>
			<Parts name="SMTP"/>
		</PartsTab>
		<PartsTab name="Format">
			<Parts name="Excel(Input)"/>
			<Parts name="Excel(Output)"/>
			<Parts name="RecordFilter"/>
			<Parts name="HTML (Output)"/>
			<Parts name="PDF"/>
			<Parts name="PDF(Merge)"/>
			<Parts name="MIMEEncode"/>
			<Parts name="MIMEDecode"/>
			<Parts name="BodyDecode"/>
			<Parts name="Zip"/>
			<Parts name="UnZip"/>
			<Parts name="XSLT"/>
			<Parts name="XPathString"/>
			<Parts name="XPathNodeset"/>
			<Parts name="XMLMerge"/>
			<Parts name="XMLUpdate"/>
			<Parts name="RecordMatch"/>
			<Parts name="RecordJoin"/>
			<Parts name="RecordSort"/>
			<Parts name="RecordSQL"/>
		</PartsTab>
		<PartsTab name="Account">
			<Parts name="AACLogin"/>
			<Parts name="AACExistUser"/>
			<Parts name="AACRoleCheck"/>
			<Parts name="AACGetUserAttributes"/>
		</PartsTab>
		<PartsTab name="WebService">
			<Parts name="SOAPFault"/>
			<Parts name="SOAPRPCEncoder"/>
			<Parts name="SOAPDecoder"/>
			<Parts name="WebService"/>
			<Parts name="SOAPDocumentEncoder"/>
		</PartsTab>
		<PartsTab name="Schedule">
			<Parts name="TimerRequest"/>
			<Parts name="Sleep"/>
			<Parts name="SingleSchedule"/>
			<Parts name="IntervalSchedule"/>
			<Parts name="RegularSchedule"/>
			<Parts name="DeleteSchedule"/>
		</PartsTab>
		<PartsTab name="File">
			<Parts name="CopyFile"/>
			<Parts name="DeleteFile"/>
			<Parts name="MoveFile"/>
			<Parts name="MakeDirectory"/>
		</PartsTab>
		<PartsTab name="Hidden" visible="false">
			<Parts name="SOAP(Client)"/>
			<Parts name="ImageConverter"/>
		</PartsTab>
	</Palette>
	<Palette name="Function">
		<PartsTab name="文字列">
			<Parts name="ASC"/>
			<Parts name="CONCATENATE"/>
			<Parts name="CONST"/>
			<Parts name="EXTSTR"/>
			<Parts name="FILENAME"/>
			<Parts name="JIS"/>
			<Parts name="LEFT"/>
			<Parts name="LEN"/>
			<Parts name="LOWER"/>
			<Parts name="MID"/>
			<Parts name="REPT"/>
			<Parts name="RIGHT"/>
			<Parts name="TRIM"/>
			<Parts name="UPPER"/>
			<Parts name="UUID"/>
			<Parts name="REGEXP"/>
			<Parts name="REGEXPREPLACE"/>
			<Parts name="EMBED"/>
			<Parts name="TRUNCATE"/>
			<Parts name="RegexpMatch"/>
			<Parts name="RegexpFind"/>
			<Parts name="DeleteString"/>
			<Parts name="InsertString"/>
			<Parts name="StringReplace"/>
		</PartsTab>
		<PartsTab name="数値">
			<Parts name="ABS"/>
			<Parts name="ADD"/>
			<Parts name="AVERAGE"/>
			<Parts name="CALC"/>
			<Parts name="DIVIDE"/>
			<Parts name="MOD"/>
			<Parts name="MULTIPLY"/>
			<Parts name="RAND"/>
			<Parts name="ROUND"/>
			<Parts name="SUBTRACT"/>
			<Parts name="SUM"/>
		</PartsTab>
		<PartsTab name="日付">
			<Parts name="DATE"/>
			<Parts name="DATECALC"/>
			<Parts name="DATETIME"/>
			<Parts name="DAY"/>
			<Parts name="HOUR"/>
			<Parts name="MILLISECOND"/>
			<Parts name="MINUTE"/>
			<Parts name="MONTH"/>
			<Parts name="NOW"/>
			<Parts name="SECOND"/>
			<Parts name="STRTODATE"/>
			<Parts name="TIME"/>
			<Parts name="WEEKDAY"/>
			<Parts name="YEAR"/>
		</PartsTab>
		<PartsTab name="バイナリ">
			<Parts name="CONSTB"/>
			<Parts name="LENB"/>
			<Parts name="LEFTB"/>
			<Parts name="RIGHTB"/>
			<Parts name="MIDB"/>
			<Parts name="REPLACEB"/>
			<Parts name="TRUNCATEB"/>
			<Parts name="CONCATENATEB"/>
		</PartsTab>
		<PartsTab name="制御">
			<Parts name="IF"/>
			<Parts name="CHOICE"/>
			<Parts name="NullCheck"/>
			<Parts name="JavaInterpreter"/>
			<Parts name="SubFunction"/>
		</PartsTab>
		<PartsTab name="変換">
			<Parts name="FORMATDATE"/>
			<Parts name="FORMATDECIMAL"/>
			<Parts name="FORMATNUMBER"/>
			<Parts name="FORMATCURRENCY"/>
			<Parts name="FORMATPERCENT"/>
			<Parts name="TABLE"/>
			<Parts name="TABLEDB"/>
			<Parts name="ENCODE"/>
			<Parts name="DECODE"/>
			<Parts name="DIGEST"/>
			<Parts name="URLENCODE"/>
			<Parts name="URLDECODE"/>
			<Parts name="CONVERT"/>
		</PartsTab>
		<PartsTab name="Boolean">
			<Parts name="AND"/>
			<Parts name="OR"/>
			<Parts name="NOT"/>
			<Parts name="Equal"/>
			<Parts name="NotEqual"/>
			<Parts name="Greater"/>
			<Parts name="GreaterEqual"/>
			<Parts name="Less"/>
			<Parts name="LessEqual"/>
			<Parts name="SelectIndex"/>
			<Parts name="BoolIf"/>
		</PartsTab>
		<PartsTab name="MIME">
			<Parts name="MailAddressParser"/>
			<Parts name="MailAddressExclude"/>
			<Parts name="MailAddressCount"/>
			<Parts name="MIMEParameterParser"/>
		</PartsTab>
	</Palette>
</PaletteDefine>