このセクションの記事

もっと見る

[toc] 
 

概要

このページでは、帳票DX for Salesforceのエクスポート・インポート機能を使用して、Sandbox環境から本番環境へテンプレートや設定を移行する手順を説明します。 
あわせて、本番環境へ安全に移行するための注意点、およびボタン・Visualforceページの移行に関する注意点も掲載しています。


 

Sandboxから本番環境に移行する流れ

 

対象範囲

本機能はPDF、Excel、Word、PowerPointで使用が可能です。 
同じ組織間でのエクスポート・インポートも対応しています。

 

前提条件

  • 帳票DX for Salesforceを利用していること
  • Sandbox環境と本番環境の両方のSalesforce組織にアクセス可能であること

 

エクスポート・インポート機能

帳票DX for Salesforceの「設定」画面にあるエクスポート・インポートボタンを使用して、テンプレートと設定を別環境にコピーすることができます。

 

対応機能

対象 説明
テンプレート PDF、Excel、Word、PowerPointのテンプレートを移行できます。
設定 テンプレートに関連する設定情報も同時にコピーされます。

 

操作手順

エクスポート方法

  1. エクスポートしたい設定の「エクスポート」ボタンをクリックします。


     

  2. .datファイルがダウンロードされます。

 

インポート方法

  1. 「インポート」ボタンをクリックします。


     

  2. インポートしたい設定ファイル（.dat）を選択します。
  3. 設定名を入力します。

  4. 「インポート」ボタンをクリックします。

    ⚠️
    注意

    設定名（テンプレート名）の注意点

    設定名に使用できない文字

    以下の文字は、設定名に使用することはできません。

    \\ / < > # : * ? " | , ; + % & ' [ ]
制御文字（U+0000～U+001F、U+007F～U+009Fの範囲の文字）
先頭や末尾の空白文字

     

    自動調整機能（docutizeXA v1.102.0以降）

    docutizeXA v1.102.0以降を使用している場合、設定名を命名する際に以下が自動的に調整されます。

    • 空白文字（全角スペース含む）とゼロ幅スペースが半角スペース（U+0020）に置換される
    • 文字列の両端の空白文字が除去される
    • \\ / < > # : * ? " | , ; + % & ' [ ]が全角文字に置換される
    • 制御文字（U+0000～U+001F、U+007F～U+009F の範囲の文字）が除去される
    • NFCでUnicode正規化が行われる

     

  5. 別タブで確認画面が表示されます。

     

  6. 設定画面を更新すると、設定がインポートされていることが確認できます。

 

1. Sandbox環境から本番環境への移行

パターン1：新規で移行する場合

本番環境に設定やテンプレートが存在しない状態で新規に移行する場合の手順です。

  1. Sandbox環境から該当の設定を「エクスポート」します。

     

  2. 本番環境の組織にログインします。

  3. 「インポート」ボタンをクリックします。


     

  4. 設定ファイルを選択し、設定名を入力して「インポート」をクリックします。

    設定名（テンプレート名）に入力できない文字については、本記事の上記セクション「インポート方法」の注意をご確認ください。

     

  5. 新規の場合、設定が追加されます。

 

パターン2：修正内容を本番環境に反映させる場合

既に本番環境に同じテンプレートと設定が存在している場合の手順です。 インポートの際に上書きを行います。

 

  1. Sandbox環境で修正した該当設定を「エクスポート」します。

     

  2. 本番環境にログインします。

  3. 「インポート」ボタンをクリックします。

     

  4. 設定ファイルを選択し、設定名を入力します。

  5. 「上書き」にチェックを入れ、「インポート」をクリックします。

     

  6. 画面をリロードすると、テンプレートの上書きが反映されます。

 

参照先バケットの注意点

Sandbox環境と本番環境を使用する際は、各環境で参照するバケットを正しく設定することが重要です。

帳票DX for Salesforceは、「カスタム設定」の「XA Bucket」で指定しているXAバケットを使用します。 
そのため、使用している環境のバケットと参照しているXAデザイナーのバケットが一致している必要があります。

 

⚠️
注意

Sandbox環境と本番環境で同じバケットを参照している場合、一方の環境で設定を変更するともう一方の環境の設定も変更されてしまいます。

 

推奨設定

弊社から発行直後のテナントでは、デフォルトで以下の2つのバケットが作成されています。

  • 「開発」バケット
  • 「運用（本番）」バケット

 

各環境で以下のように設定してください。

環境 指定するバケット 説明
Sandbox環境 「開発」バケット 開発・テスト環境用のバケットを指定します。
本番環境 「運用（本番）」バケット 本番運用用のバケットを指定します。

 

Sandbox環境 開発

本番環境 運用

 

⚠️
注意

Sandbox環境と本番環境で異なるバケットを参照するよう設定してください。 同じバケットを参照するとエラーが発生する可能性があります。

 

正しい例

 

エラーが発生する例

 

バケット設定方法

バケット設定の詳細については、【帳票DX for Salesforce】セットアップガイド（1.インストール）の「2.カスタム設定」セクションを参照してください。 
開発用で修正した内容を本番環境に適用させる場合は、本記事の「Sandbox環境から本番環境への移行手順」セクションの手順で設定を上書きしてください。

 

2. ボタン（アクション・Visualforceページ）の移行

Sandboxに作成済みのボタン（アクション・Visualforceページ）は、本番組織に変更セット機能等でリリースすることで、利用可能となります。

移行前確認

本番環境で以下の設定がされているかをご確認ください。

  • 帳票DX for Salesforce がインストール済み
  • 「OPROARTS（帳票DX）」タブの「XLA」（もしくは「LA」「ALA」「AXLA」のいずれか）レコードの「CID」の値が、Sandboxの「XLA」（もしくは「LA」「ALA」「AXLA」のいずれか）レコードの「CID」の値と同じ
  • 「XLA」（もしくは「LA」「ALA」「AXLA」のいずれか）レコードに、帳票出力するSalesforceユーザが登録されていて、Sandboxと同じUID/UPWで登録されている

 

変更セットを用いたリリース手順

変更セットを用いたリリース手順の詳細は下記を参照ください。

Salesforce Help：変更セット

 

変更セットで使用可能なコンポーネント

変更セットで使用可能なコンポーネントについては下記を参照ください。

Salesforce Help：変更セットで使用可能なコンポーネント

💡
補足
  • 帳票に使用している項目の項目名・API参照名を変更した等で、組織によって項目名・API参照名が異なっていた場合に帳票出力エラーが発生します。本番組織にも項目が存在していることをご確認ください。

  • 本番組織へのその他のリリース手段については以下をご参照ください。

    Salesforce Help：変更の作成ツールとリリースツールの選択


 

関連

関連記事