SUISUI-ETLヘルプ

はじめに
表記について
マークについて
稼働環境
ヘルプの起動
ヘルプの構成について
全文検索機能について
ツールバーについて
仕様制限

はじめに

本ヘルプには、SUISUI-ETLに関する情報が記述されています。
左ペインのツリー上の各項目を選択すると、右ペインに対応したページが表示されます。
ヘルプには、ウェブブラウザで参照する「ブラウザヘルプ」と、SUISUI-ETL Studio上で参照する「Studioヘルプ」の2種類が存在します。(内容は同一となります。)

表記について

ヘルプ中で使用している表記についての説明は以下の通りです。

SUISUI-ETLの画面に表示されるメニュー名・タブ名・プロパティ項目名および値・ボタン名は[]で囲んで太字で表します。
また、それ以外の機能名や画面のタイトル、名称のないものは「」で囲んで前者と区別しています。

$SUISUI-ETL_HOMEはSUISUI-ETLをインストールしたディレクトリを表します。
デフォルトでは、Windows版の場合は「C:\Program Files\SUISUI-ETL」、UNIX/Linux版の場合は「<ユーザのホームディレクトリ>/SUISUI-ETL」となります。

x86版とは、32bit OSを表します。
x64版とは、64bit(Intel 64/AMD64) OSを表します。

本ヘルプ内で、サポートプラットフォームとして記載している各OSのサービスパックレベルのサポートについては、SUISUI-ETL Serverの稼働環境に準拠します。

<と>で囲まれた名称は、可変であることを表します。
例:$SUISUI-ETL_HOME/server/logs/<日付ディレクトリ>

スキーマの要素、または属性は太字で表します。
例:root要素のname属性

本ヘルプ内に記載しているウェブサイトのURLは2021年12月現在のものです。ウェブサイトの都合などにより、予告なしにURLが変更になる場合があります。

「Studio」とは「SUISUI-ETL Studio」を、「Studio for Web」とは「SUISUI-ETL Studio for Web」を指します。

マークについて

ヘルプ中で使用しているマークについての説明は以下の通りです。

マーク	説明
	管理者専用の機能であることを表します。
	操作や設定に関するヒントであることを表します。
	操作や設定に関する注意事項であることを表します。
	詳細な説明が別のページに記載されていることを表します。
	SUISUI-ETL Studio専用の説明であることを表します。
	SUISUI-ETL Studio for Web専用の説明であることを表します。

稼働環境

ブラウザヘルプのサポートプラットフォームおよびサポートウェブブラウザ

サポートプラットフォームおよびサポートウェブブラウザについては、こちらを参照してください。

Studioヘルプのサポートプラットフォーム

SUISUI-ETL Studioのサポートプラットフォームに準拠します。

ヘルプの起動

SUISUI-ETLヘルプを起動する方法は、以下の通りです。

ブラウザヘルプ

ツール		方法	備考
ウェブブラウザ	Windows版	Windowsのスタートメニューから「すべてのプログラム」-「SUISUI-ETL <バージョン>」-「ヘルプ」を選択する。ウェブブラウザから以下のURLにアクセスする。 http://<SUISUI-ETL Server稼働OSのホスト名またはIPアドレス>:<SUISUI-ETL Serverのポート番号>/suisui-etl/doc/help/index.html	事前にSUISUI-ETL Serverを起動する必要があります。
ウェブブラウザ	UNIX/Linux版	ウェブブラウザから以下のURLにアクセスする。 http://<SUISUI-ETL Server稼働OSのホスト名またはIPアドレス>:<SUISUI-ETL Serverのポート番号>/suisui-etl/doc/help/index.html	事前にSUISUI-ETL Serverを起動する必要があります。

Studioヘルプ

ツール		方法	備考
SUISUI-ETL Studio		Studioメニューから[ヘルプ]を選択する。デスクトップにあるヘルプアイコンをダブルクリックする。デザイナのメニューから[ヘルプ]を選択する。デザイナ上でF1キーを打鍵する。

ヘルプの構成について

本ヘルプは、以下の内容で構成されています。

SUISUI-ETL概要	製品の概要について説明します。
サービスガイド	サービスの基本知識をはじめ、サービスの開発やサービスの運用時に必要となる情報について説明します。サービスの開発を始める前に一読することをお勧めします。
運用ツール	サービスの運用時に必要となる実行ツール群(トリガー、ScriptRunner、CLI Consoleなど)について説明します。
開発ツール	サービスの開発時に必要となる開発ツール群(Studio、デザイナなど)について説明します。
アーキテクチャ	SUISUI-ETLのアーキテクチャについて詳しく説明します。
アダプタ	各種アダプタについて詳しく説明します。
Mapper	MapperエディタやMapperロジックについて詳しく説明します。

全文検索機能について

SUISUI-ETLヘルプでは、全ページの文言を対象とした全文検索を行うことができます。

ブラウザヘルプ

ツリー左上にある[検索]フィールドに検索対象文字列を入力し、[検索]ボタンを押下してください。

Studioヘルプ

ツリー左上にある[検索]タブを選択して、[検索]フィールドに検索対象文字列を入力してください。

ツールバーについて

Studioヘルプのみの機能です。

ツールバーでは、以下の機能を提供しています。

アイコン	名前	説明	備考
	戻るボタン	直前に参照していたページに戻ります。
	進むボタン	直前に参照していたページに進みます。
	印刷(単一ページ)ボタン	目次ツリーで選択しているページを印刷します。
	印刷(フォルダ内のすべてのページ)ボタン	目次ツリー内のフォルダを選択した場合に、フォルダ内のすべてのページを再帰的に印刷します。
	ページ設定ボタン	印刷ページの設定を行います。
	常に最前面化ボタン	ヘルプを常に手前に表示するかどうかを選択します。 (オン状態): 常にほかのツールよりも手前に表示します。 (オフ状態):(デフォルト) 選択したツールが手前に表示されます。
	同期ボタン	ヘルプとデザイナを同期させるかどうかを選択します。 (オン状態):(デフォルト) デザイナ上で選択したオペレーションのヘルプを同期して表示します。 (オフ状態): ヘルプで開いたページを表示します。(デザイナとは同期しません。)

仕様制限

全文検索機能で、[検索]フィールドに設定した検索対象文字列によっては、以下の事象が発生する場合があります。その場合は、ほかの検索対象文字列を設定し、再度検索を実行してください。
- 検索結果のハイライト表示が正しく行われない
- マウスカーソルが砂時計の表示のままになり、検索結果が表示されない