コンテンツにスキップ

帳票定義

帳票定義画面では、Create!Form Designで作成した帳票定義を管理できます。
※作業ディレクトリおよび帳票定義は、利用中のテナントに登録されているものが表示されます。


作業ディレクトリ一覧
登録されている作業ディレクトリを一覧で確認できます。
この一覧では、作業ディレクトリのアップロード、ダウンロード、および削除を行うことができます。
また、作業ディレクトリごとに編集保護を設定して、更新や削除を防止できます。

帳票定義一覧
作業ディレクトリごとに帳票定義を一覧で確認できます。
この一覧では、削除や帳票出力可否の設定など、帳票定義に対する操作を行うことができます。

作業ディレクトリ一覧

帳票定義画面を開くと、作業ディレクトリ一覧が表示されます。
作業ディレクトリ一覧では、作業ディレクトリのアップロード、ダウンロード、削除、内容の確認を行います。

作業ディレクトリ一覧

図1：作業ディレクトリ一覧

一覧は作業ディレクトリ名の昇順で表示されます。

アップロード

作業ディレクトリをアップロードし、新規追加または更新を行います。
複数の作業ディレクトリを一括でアップロードできます。
作業ディレクトリは、Create!Form Designで作成したものをそのままアップロードしてください。

Warning

すでに登録されている作業ディレクトリをアップロードすると、既存の作業ディレクトリが更新されます。
（同名の作業ディレクトリを新規に追加することはできません。）
作業ディレクトリ内の同名のファイルは新しいファイルで上書きされ、元の内容には戻せません。
一方、アップロードで上書きされないファイルはそのまま残り、自動的に削除されることはありません。
また、かんたんレイアウトの帳票定義をアップロードした場合、klsフォルダーに既にあるExcelテンプレートファイルは新しいファイルで置き換えられ、元のファイルは削除されます。

制限事項

帳票定義をアップロードする場合の制限事項は「1.概要・制限事項」の帳票定義の制限事項を参照ください。

ステータスの確認

アップロード時に表示されるモーダル画面で、各作業ディレクトリのステータスが表示されます。
ステータスは、アップロード処理において各作業ディレクトリに対して実行される処理を示します。
各ステータスの処理内容は以下のとおりです。

ステータス 処理内容
新規追加 新しい作業ディレクトリとして登録されます。
更新 既存の作業ディレクトリが更新されます。
編集保護のため更新なし 編集保護が有効になっているため、作業ディレクトリは更新されません。
新規追加（帳票定義ファイルがありません） 新しい作業ディレクトリとして登録されますが、帳票定義ファイルが含まれていないため帳票定義は登録されません。
更新（帳票定義ファイルがありません） 既存の作業ディレクトリが更新されますが、帳票定義ファイルが含まれていないため帳票定義は登録されません。

Warning

帳票定義ファイル（.sty）のない帳票定義をアップロードした場合、帳票定義一覧には表示されません。
帳票定義ファイルは帳票の設定情報を保持するファイルであり、このファイルが存在しない場合、帳票定義として認識されません。
ただし、作業ディレクトリ内のファイルはアップロードされます（アップロード対象の拡張子に限ります）。

エラー発生時の動作

アップロード中にエラーが発生した場合、その時点でアップロード処理は終了します。
残りの作業ディレクトリはアップロードされません。

ダウンロード

アップロード済みの作業ディレクトリをZIPファイルとしてダウンロードします。
ダウンロードされるファイル名は、「cfc_resources_YYYYMMDD.zip」（YYYYMMDDはダウンロード実行日）です。

Warning

ダウンロードされるZIPファイルには、削除済みの帳票定義のファイルも含まれます。
※帳票定義の削除の詳細は、削除を参照してください。

削除

作業ディレクトリを削除します。
削除すると、作業ディレクトリ内の帳票定義はすべて削除されます。
編集保護が有効な作業ディレクトリは削除できません。

Warning

削除後は、削除された作業ディレクトリの内容を参照したり復元したりすることはできません。

詳細情報（右ペイン）

作業ディレクトリを選択すると、右ペインに詳細情報が表示されます。

作業ディレクトリ一覧の右ペイン

図2：作業ディレクトリ一覧の右ペイン

作業ディレクトリの情報の確認や、編集保護の設定ができます。
複数の作業ディレクトリを選択した場合は、編集保護の設定のみ変更できます。

作業ディレクトリ名

作業ディレクトリ名が表示されます。

設定

  • 編集保護
    作業ディレクトリを編集保護する場合は[保護する]、編集保護しない場合は[保護しない]を設定します。
    初期値は[保護しない]です。
    [保護する]に設定された作業ディレクトリは、更新および削除ができません。
    複数の作業ディレクトリを選択すると、編集保護を一括で設定できます。

詳細情報

項目 表示内容
更新日時 作業ディレクトリに対して最後に操作を行った日時が表示されます。
作業ディレクトリをアップロードした（新規追加・更新いずれの場合も）または編集保護の設定を変更した場合、更新日時が最新の状態に更新されて表示されます。

帳票定義一覧

作業ディレクトリ一覧で作業ディレクトリ名をクリックすると、帳票定義一覧が表示されます。
帳票定義一覧では、帳票定義の削除や内容の確認を行います。

帳票定義一覧

図3：帳票定義画面の帳票定義一覧

一覧は帳票名の昇順で表示されます。
帳票定義単位でアップロードやダウンロードはできません。

表示モード切り替え

帳票定義一覧の表示モードを、[リスト]モードリストモード切り替えアイコンまたは[プレビュー]モードプレビューモード切り替えアイコンに切り替えます。
初期状態では[リスト]モードが表示されます。
表示モードを切り替えた場合、選択した表示モードはブラウザに一定期間保存されます。

プレビューモードでは、帳票定義のサムネイル画像が表示されます。
マルチフォームの場合は、最初のフォームのみが表示されます。

削除

帳票定義を削除します。
削除した帳票定義は、帳票出力に使用できません。
編集保護が有効な作業ディレクトリでは、帳票定義を削除できません。

Warning

削除した帳票定義と同名の帳票定義（帳票定義ファイル名が同じ）を再度アップロードしても、新しい帳票IDが割り当てられます。
削除対象の帳票定義で帳票出力している場合は、呼び出し元の帳票IDの変更要否をご確認ください。

Warning

帳票定義を削除しても、作業ディレクトリ内のファイルは削除されません。
作業ディレクトリをダウンロードすると、削除した帳票定義のファイルも含まれます。
現時点では、作業ディレクトリ内の一部のファイルを削除する機能はありません。
特定のファイルの削除が必要な場合は、恐れ入りますが、サポートサイトのお問い合わせよりご連絡ください。

詳細情報（右ペイン）

帳票定義を選択すると、右ペインに詳細情報が表示されます。

帳票定義一覧の右ペイン-1

図4：帳票定義一覧の右ペイン

帳票定義の情報の確認や、有効/無効、テスト/本番の設定ができます。
複数の帳票定義を選択した場合は、有効/無効とテスト/本番の設定のみ変更できます。

Warning

帳票定義のデータタイプがDB、TIFF、または帳票種別がオーバーレイの場合は、次の操作が実行できません。

  • プレビュー実行
  • サンプルコード生成
  • 有効/無効の設定
  • テスト/本番の設定

プレビュー

帳票定義のサムネイル画像が表示されます。

プレビュー実行

帳票定義をプレビュー実行します。
プレビュー実行では、あらかじめ用意したデータソースを使用して帳票を出力し、出力結果を確認できます。
プレビュー実行ではコストは発生しません（Castランタイムではページ数、Expageランタイムではブック数が消費されません）。

Warning

Castランタイムでは、透かし入りのPDFが出力されます。
Expageランタイムでは、読み取り専用のExcelファイルが出力されます。

サンプルコード生成

帳票出力を実行するためのサンプルコードを生成します。
生成したコードを利用して、各言語から帳票出力APIを呼び出すことができます。
対応言語とバージョンは以下のとおりです。

言語 対応バージョン 必要なライブラリ（標準ライブラリを除く）
Node.js 22以降 axios,
form-data
Fetch API - 不要
Python 3.10以降 requests,
requests_toolbelt
Java 17以降 Apache HttpClient（org.apache.httpcomponents:httpclient）,
Apache HttpMime（org.apache.httpcomponents:httpmime）,
JSON-Java（org.json）

Warning

Fetch APIを使用する場合、APIトークンはフロントエンド（ブラウザ）で扱われます。
そのため、フロントエンドにアクセスできる第三者がAPIトークンを確認できる可能性があります。
不正利用を防ぐため、APIトークンの管理には十分ご注意ください。
帳票出力APIを利用する場合は、API画面で接続許可IPを設定し、特定のIPからのみ帳票出力を実行できるようにすることを推奨します。

設定

  • 有効/無効
    帳票定義を有効にする場合は[有効]、無効にする場合は[無効]を設定します。
    初期値は[有効]です。
    [有効]に設定された帳票定義は、帳票出力APIを使用して帳票出力できます。
    [無効]に設定された帳票定義は、帳票出力APIを使用して帳票出力できません。
    帳票定義の運用を停止する場合や、一時的に帳票出力を停止したい場合に設定します。

    複数の帳票定義を選択すると、有効/無効を一括で設定できます。

  • テスト/本番
    帳票定義をテスト用として利用する場合は[テスト]、本番運用で利用する場合は[本番]を設定します。
    初期値は[テスト]です。
    [テスト]に設定された帳票定義は、帳票出力実行時にコストが発生しません。

    Warning

    [テスト]に設定された帳票定義で帳票出力を実行すると、次の形式で出力されます。

    • Castランタイム：透かし入りのPDFが出力されます
    • Expageランタイム：読み取り専用のExcelファイルが出力されます

    複数の帳票定義を選択すると、テスト/本番を一括で設定できます。

詳細情報

項目 表示内容
帳票定義ファイル名 Create!Form Designで設定された帳票定義ファイル名が表示されます。
記述 Create!Form Designで設定された記述が表示されます。
フォームタイプ Create!Form Designで設定されたフォームタイプが表示されます。
帳票種別 Create!Form Designで設定された帳票種別が表示されます。
更新日時 帳票定義に対して最後に操作を行った日時が表示されます。
帳票定義ファイルをアップロードした（新規追加・更新いずれの場合も）または有効/無効、テスト/本番の設定を変更した場合、更新日時が最新の状態に更新されて表示されます。
更新ユーザー名 帳票定義に対して最後に操作を行ったユーザー名が表示されます。

データマップ一覧

データマップの一覧が表示されます。
各行には、データマップ名と、対応するデータタイプが表示されます。
帳票種別がオーバーレイの場合、データマップは作成されないため、一覧には何も表示されません。