HandbookUpdateSection - セクションの更新
指定したHandbookのセクションを更新します。
Handbookとの連携の概要や必要な設定については、Handbookとの連携についてを参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 無制限 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名を使用するかどうか選択します。
|
||||||
| コネクション名 | connection | - | Handbookサーバーへの接続情報を定義した汎用コネクションを指定します。 | ||||||
| コネクション情報 | group | - | コネクションを使用が「いいえ」の場合の場合に使用されるプロパティ群です。 | ||||||
| URL | string | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、HandbookサーバーのWebAPIのURLを指定します。 ex) https://<Handbookサーバー>/ |
||||||
| ユーザー名 | string | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、Handbookサーバーにログインするユーザー名を指定します。 ユーザーには管理者権限が付与されている必要があります。 |
||||||
| パスワード | password | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、Handbookサーバーにログインするユーザーのパスワードを指定します。 | ||||||
| プロキシー設定を使用 | boolean | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、プロキシー設定を指定します。 FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |
||||||
| Handbookタイトル | string | 入力＆出力 | セクションを更新するHandbookのタイトルを指定します。 | ||||||
| セクションタイトル | string | 入力＆出力 | 更新対象のセクションのタイトルを指定します。 | ||||||
| 新セクションタイトル | string | 入力＆出力 | 新しいセクションのタイトルを指定します。 | ||||||
| 対象ファイル | remoteFile | 入力＆出力 |
セクション更新用ファイルを指定します。 ファイルはHandbookのコンテンツメディア対応ファイルである必要があります。 |
||||||
| 相対パスの起点 | pathResolver | - |
相対パス指定の場合にベースディレクトリを指定します。
|
||||||
| 絶対パスを許可 | boolean | - | 絶対パスを許可するかどうか選択します。 | ||||||
| 「..」を許可 | boolean | - | 上のフォルダへ移動する記述に「..」を許可するかどうか選択します。 |
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | 1 | コネクションの定義項目が不足している場合 |
| 3 | 指定されたURLが異常な場合 | |||
| 5 | レスポンスの解析に失敗した場合 | |||
| 接続エラー | なし | コンポーネントの入力ストリーム | 2 | Web APIの接続時にエラーが発生した場合 |
| APIエラー | なし | コンポーネントの入力ストリーム | 4 | Web APIの実行でエラーコードを受け取った場合 |
| 対象ファイルエラー | なし | コンポーネントの入力ストリーム | 6 | 指定ファイルが存在しない場合 |
| 7 | 指定したファイルがHandbookのコンテンツメディア対応ファイルでない場合 |
■コネクション設定
Handbookコンポーネントを使用するためにはあらかじめ汎用コネクションにHandbookサーバー接続用の設定をしておく必要があります。コネクション設定では以下のパラメータを定義します。
| パラメータ名 | 設定内容 |
|---|---|
| url |
HandbookサーバーのWebAPIのURLを指定します。 ex) https://<Handbookサーバー>/ |
| user | Handbookサーバーにログインするユーザー名を指定します。 |
| password | Handbookサーバーにログインするユーザーのパスワードを指定します。 |
| useProxy |
FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |