HandbookCreateFromFolder - 指定フォルダーからHandbookを作成しアップロード
指定したフォルダーよりHandbookを作成してHandbookサーバーにアップロードします。
Handbookとの連携の概要や必要な設定については、Handbookとの連携についてを参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 無制限 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名を使用するかどうか選択します。
|
|||||||||
| コネクション名 | connection | - | Handbookサーバーへの接続情報を定義した汎用コネクションを指定します。 | |||||||||
| コネクション情報 | group | - | コネクションを使用が「いいえ」の場合の場合に使用されるプロパティ群です。 | |||||||||
| URL | string | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、HandbookサーバーのWebAPIのURLを指定します。 ex) https://<Handbookサーバー>/ |
|||||||||
| ユーザー名 | string | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、Handbookサーバーにログインするユーザー名を指定します。 ユーザーには管理者権限が付与されている必要があります。 |
|||||||||
| パスワード | password | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、Handbookサーバーにログインするユーザーのパスワードを指定します。 | |||||||||
| プロキシー設定を使用 | boolean | 入力＆出力 | コネクションを使用が「いいえ」の場合に処理に使用する、プロキシー設定を指定します。 FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |
|||||||||
| 対象ディレクトリ | remoteFile | 入力＆出力 |
Handbook作成対象フォルダーパスを指定します。 指定したフォルダーの直下にあるフォルダーがHandbookのチャプターとなり、フォルダー名がチャプター名となります。 チャプターフォルダー内のHandbookのコンテンツメディア対応ファイルがセクションとなり、ファイル名がセクション名となります。 指定したフォルダー内にcover.pngファイルがある場合、その画像ファイルをレイアウトページの表示画像として使用します。 指定したフォルダー内にicon.pngファイルがある場合、その画像ファイルを情報端末の画面で見た場合のHandbookリストのアイコンとして使用します。 |
|||||||||
| 相対パスの起点 | pathResolver | - |
相対パス指定の場合にベースディレクトリを指定します。
|
|||||||||
| 絶対パスを許可 | boolean | - | 絶対パスを許可するかどうか選択します。 | |||||||||
| 「..」を許可 | boolean | - | 上のフォルダーへ移動する記述に「..」を許可するかどうか選択します。 | |||||||||
| タイトル | string | 入力＆出力 |
Handbookの名前を指定します。50文字以下の長さの文字列が指定できます。 指定しない場合は、対象ディレクトリで指定したフォルダー名がHandbookの名前として使用されます。 |
|||||||||
| キーコード | string | 入力＆出力 | Handbookのキーコードを指定します（他のグループが使用しているキーコードで登録しようとする と、自動で連番が振られます）。255文字以下の長さの文字列が指定できます。 | |||||||||
| カテゴリー | string | 入力＆出力 | カテゴリー文字列を指定します。 | |||||||||
| 有効期限開始日時 | datetime | 入力＆出力 | 有効期限の開始日時を指定します。値フィールドに表示されるボタンをクリックして表示されるカレンダーで、開始日時を選択して設定します。または「yyyy-MM-dd'T'HH:mm:ss」の形式で直接入力して設定します。 | |||||||||
| 有効期限終了日時 | datetime | 入力＆出力 | 有効期限の終了日時を指定します。値フィールドに表示されるボタンをクリックして表示されるカレンダーで、終了日時を選択して設定します。または「yyyy-MM-dd'T'HH:mm:ss」の形式で直接入力して設定します。 | |||||||||
| 説明 | string | 入力＆出力 | Handbookの詳細を指定します。 | |||||||||
| 著作権情報 | string | 入力＆出力 | Handbookの著作権情報を指定します。 | |||||||||
| 著作権情報レイアウト | choice | 入力＆出力 |
Handbookの著作権情報表示の画面のレイアウトを指定します。 レイアウトの詳細は、Handbook Studio ユーザーズガイドを参照してください。
|
|||||||||
| ダウンロードを許可 | choice | 入力＆出力 |
Handbookのダウンロードを許可するかを指定します。
|
|||||||||
| 外部アプリで添付ファイルを開くのを許可 | choice | 入力＆出力 |
外部アプリで添付ファイルを開くのを許可するかを指定します。
|
|||||||||
| セクションの表示レイアウト | choice | 入力＆出力 |
セクションの表示レイアウトを指定します。 レイアウトの詳細は、Handbook Studio ユーザーズガイドを参照してください。
|
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | 1 | コネクションの定義項目が不足している場合 |
| 3 | 指定されたURLが異常な場合 | |||
| 5 | レスポンスの解析に失敗した場合 | |||
| 8 | アップロード用ZIPファイルの作成に失敗した場合 | |||
| 接続エラー | なし | コンポーネントの入力ストリーム | 2 | Web APIの接続時にエラーが発生した場合 |
| APIエラー | なし | コンポーネントの入力ストリーム | 4 | Web APIの実行でエラーコードを受け取った場合 |
| ディレクトリが存在しない | なし | コンポーネントの入力ストリーム | 6 | 対象フォルダーが存在しない場合 |
| 7 | 一時フォルダーが存在しない場合 |
■コネクション設定
Handbookコンポーネントを使用するためにはあらかじめ汎用コネクションにHandbookサーバー接続用の設定をしておく必要があります。コネクション設定では以下のパラメータを定義します。
| パラメータ名 | 設定内容 |
|---|---|
| url |
HandbookサーバーのWebAPIのURLを指定します。 ex) https://<Handbookサーバー>/ |
| user | Handbookサーバーにログインするユーザー名を指定します。 |
| password | Handbookサーバーにログインするユーザーのパスワードを指定します。 |
| useProxy |
FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。 |