アプリパッケージ/サイトパッケージエクスポート・インポート
目次
機能概要
アプリ/サイトエクスポート・インポートは、作成したアプリやサイトをそれぞれパッケージ化し、ローカル環境へエクスポートおよびアカウントへインポートできる機能です。
作成したアプリを自アカウントおよび他アカウントへ複製できるようになることで、以下のようなユースケースが実現できるようになります。
・自アカウントでテンプレートとなるアプリやサイトを作成し、複数のアカウントへ複製することでアプリ開発生産性を向上させたい。
・作成したアプリやサイトの設定情報を一時的に保存しておきたい。（レコードは含まれません）
※ サービス負荷軽減のため、アプリ/サイトエクスポート・インポートそれぞれに同時並列処理数制限を設けています。
詳しくは各種上限値をご確認ください。
機能仕様
（１）共通
・アプリ/サイトの管理画面よりエクスポートを依頼すると、設定がパッケージ化されたファイルが生成されダウンロードできます。
※ブラウザの機能によりパッケージファイルのダウンロードがブロックされることがあります。その場合はダウンロードメニューからパッケージファイルを保存してください。
生成したパッケージファイルはアプリ/サイトの管理画面よりインポートすることができます。
・アプリとサイトをまとめてエクスポートすることはできません。個別にエクスポートしてください。
・エクスポート中のアプリ/サイトはロックされ、対象のアプリ配下の設定の書き込み処理を禁止します。
・インポートすることにより設定数の上限が設けられている機能の上限を超える場合、インポートを中止します。
・エクスポート/インポート中にエラーが発生した場合、エクスポート/インポートを中止しロールバックします。
・インポート依頼の履歴はアプリ一覧/サイト一覧の上部に表示されます。履歴の保持期間は3日間です。
パッケージファイル名フォーマット
・アプリパッケージファイル：appPackage_{app識別名}_{yyyyMMdd}.spl
・サイトパッケージファイル：sitePackage_{site識別名}_{yyyyMMdd}.spl
セキュリティ
・生成したパッケージファイルはエクスポート/インポート時にウィルススキャンを実施し、ウイルスを含んだサイト等が含まれていないかチェックします。
・生成したパッケージファイルは暗号化され、インポート時に改ざんを検知することができます。
バージョン・環境による制限
・エクスポートしたパッケージファイルはSPIRAL ver.2の異なるバージョンや環境には原則インポートできません。
例）Ver.2.x.yでエクスポートしたパッケージファイルは、バージョン（「x」部分）が上がった場合、原則インポートできなくなります。
ベータ環境をご利用の場合、ベータ環境でエクスポートしたパッケージファイルは本番環境のアカウントにはインポートできません。
※パッケージファイルの外見からエクスポート時のバージョンを確認することはできません。
エクスポート後パッケージファイル名の末尾にバージョン情報を付与する等、お手元でパッケージファイルとエクスポート時のバージョンを管理ください。
※バージョンの確認方法は利用規約/バージョンを確認したいをご参照ください。
通知メール
アプリ/サイトのエクスポートまたはインポート失敗時にメインメールアドレス宛に通知メールを配信できます。
通知に必要なユーザの権限や設定方法は通知メール設定をご確認ください。
（２）アプリエクスポート/インポート時の注意事項
・インポート先のアカウントでアプリの識別名と表示名が重複していた場合、以下の表示形式で作成します。
識別名：{識別名}_copy{count}
表示名：{表示名}_copy{count}
・ count の部分は同じ識別名/表示名が存在するとカウントアップされます。
・_copy{count}を追加したことで識別名/表示名の文字数制限を超過した場合、末尾を削除して_copy{count}を追加します。
・以下の設定はエクスポートされません。
-アイコン
-メール配信、PHP実行のログ情報
-アプリ利用者
-アプリ管理者
・パッケージファイルにメール配信設定が含まれる場合、以下の設定はインポート先へ引き継がれません。
インポート画面で指定した内容が一律反映されます。
-宛先が固定メールアドレスのメール設定の宛先メールアドレス
-差出人メールアドレス
-差出人名
・以下の設定はインポート後に調整が必要になる場合があります。
| 機能 | 注意点 |
|---|---|
|
条件抽出 |
レコードおよびユーザはエクスポート対象外のため、レコードIDまたはユーザIDを指定して抽出している場合、意図しない抽出条件になります。 |
| メール配信設定 | クリックログインの差し替えキーワードは対象のサイトやページが存在しない場合、{{@_url.cl._unauthorized}} に変換されてインポートされるためメール配信がエラーになります。 |
| スケジュールトリガ | メールアクションとPHP実行アクションはステータスが無効の状態でインポートされます。 |
|
DBトリガ （非同期アクション） |
メールアクションとPHP実行アクションはステータスが無効の状態でインポートされます。 |
| PHP | ソースコード内でハードコードされているDB IDやAPIキーはそのままインポートされるためPHP実行時にエラーになる可能性があります。 |
| アプリロール | ユーザはエクスポート対象外のため、フィールド権限の選択ユーザ制限設定は「制限しない」という設定でインポートされます。 |
| グループはエクスポート対象外のため、アプリロールに利用グループが設定されない状態でインポートされます。 |
（３）サイトエクスポート/インポート時の注意事項
・サイトパッケージを他アカウントへインポートするには、先んじてサイト構築に必要なアプリのインポートが必要です。
・インポート先のアカウントでサイトの識別名と表示名が重複していた場合、以下の表示形式で作成します。
識別名：{識別名}_copy{count}
表示名：{表示名}_copy{count}
・ count の部分は同じ識別名/表示名が存在するとカウントアップされます。
・_copy{count}を追加したことで識別名/表示名の文字数制限を超過した場合、末尾を削除して_copy{count}を追加します。
・ページ単位でパッケージに含めるか選択できます。
選択したページに紐づく認証エリア、ブロック、レコード公開範囲（※）なども纏めてパッケージされます。
※エリア認証時公開範囲が含まれるレコード公開範囲がエクスポート対象 かつ その認証エリアがエクスポート対象外 の場合、レコード公開範囲からエリア認証時公開範囲が除去されてエクスポートされます。
またそれによりレコード公開範囲が空になる場合(一般公開範囲がなく認証エリア公開範囲設定が全て除外された場合)は、そのレコード公開範囲はエクスポートされません。
例）部門マスタDBと部門マスタDBを参照先とする社員マスタDBがあり、社員マスタDBには認証エリアA、B、部門マスタDBにはレコード公開範囲が設定されている。
認証エリアBをエクスポートする場合、部門マスタDBのレコード公開範囲の設定により部門マスタDBのレコード公開範囲が除去されエクスポートされないことがある。
| 部門マスタDB レコード公開範囲 |
認証エリアB 依存設定エクスポート対象 （部門マスタDBのレコード公開範囲のみ抜粋） |
|---|---|
|
一般およびエリア認証時公開 （認証エリアA） |
あり 一般公開範囲 ※エリア認証時公開範囲が除去され一般公開範囲のみエクスポートされる |
|
エリア認証時公開のみ （認証エリアA） |
なし レコード公開範囲はエクスポートされない |
・以下の設定はエクスポートされません。
-アイコン
-本番環境の設定
-reCAPTCHA設定
-メール配信、PHP実行のログ情報
-サイトファイル
-サイト管理者
-サイト認証API利用者
-外部アクセス制御
・パッケージファイルにメール配信設定が含まれる場合、以下の設定はインポート先へ引き継がれません。
インポート画面で指定した内容が一律反映されます。
-差出人メールアドレス
-差出人名
・以下の設定はインポート後に調整が必要になる場合があります。
| 機能 | 注意点 |
|---|---|
|
条件抽出 |
レコードおよびユーザはエクスポート対象外のため、レコードIDまたはユーザIDを指定して抽出している場合、意図しない抽出条件になります。 |
| 自動登録 | レコードがエクスポート対象外のため、参照フィールドの自動登録で値タイプ：固定を指定している場合、指定したレコードが存在せず、レコード登録時にエラーになります。 |
| 外部サイトURL | フォームブロックの完了ステップ表示・認証エリアのログアウト時のリダイレクト先URLやページのセキュリティから外部サイトへの埋め込みを一部許可にしてURLを設定している場合、URLは https://example.com に変換されてインポートされます。 |
| メール配信設定 | クリックログインの差し替えキーワードは対象のサイトやページが存在しない場合、{{@_url.cl._unauthorized}} に変換されてインポートされるためメール配信がエラーになります。 |
| クリックカウントURLのドメインをサイトのドメインに設定していた場合、インポート時にはドメインが変更されるためクリックカウントURLのドメインをインポート先サイトのドメインへの変更が必要です。 | |
| メールアクション | メールアクションはステータスが無効の状態でインポートされます。 |
| サイト内ページリンク | 遷移先のページのIDが変わるため、意図しないページに遷移したり、リンク切れになることがあります。 |
| IPアドレス制限 | ページのIPアドレス制限で設定されているIPアドレスは 192.168.x.x に変換されてインポートされます。 |
| PHP | ソースコード内でハードコードされているDB IDやAPIキーはそのままインポートされるためPHP実行時にエラーになる可能性があります。 |
| reCAPTCHA | reCAPTCHA設定はエクスポート対象外のため、使用しているブロックではreCAPTCHAが機能しなくなります。 |
| PHP環境変数 | PHP環境変数の値は * に変換されてインポートされます。 |
その他
（１）同アカウント内に別アプリ/サイトとしてインポートしたい場合
下記の手順に従い設定してください。
1．アプリ/サイトパッケージをエクスポートする
2．既存アプリ/サイトの識別名を変更する
3．アプリパッケージをインポートする
4．サイトパッケージをインポートする
5．インポートしたアプリ/サイトの識別名を変更する
6．既存アプリ/サイトの識別名を元の識別名に変更する
（２）著作権について
パッケージ化してエクスポート/インポートするアプリの著作権についてはこちらをご参照ください。
UI：アプリエクスポート
「アプリ管理」の左メニューから「基本設定」を選択し「エクスポート」をクリックします。
モーダルが開きますので内容を確認の上「エクスポート」をクリックします。
パッケージファイルの生成後、ダウンロードアイコンよりファイルをダウンロードします。
UI：アプリインポート
「アプリ管理」のアプリ一覧から＋ボタンをクリックします。
インポートを選択し、ファイル参照よりインポートしたいパッケージファイルをアップロードします。
パッケージファイルにメール配信設定が含まれる場合、差出人の設定を行います。
差出人の設定が完了しましたら「インポート」をクリックします。
※有効な差出ドメインが無い場合、メール差出人ドメインより追加してください。
モーダルの内容を確認の上「OK」をクリックします。
インポートが完了しました。
アプリ一覧にインポートしたアプリが追加されます。
UI：サイトエクスポート
「サイト管理」の左メニューから「基本設定」を選択し「エクスポート」をクリックします。
エクスポート対象のページを選択し「次へ」をクリックします。
エクスポート対象のページを確認し「次へ」をクリックします。
モーダルの内容を確認の上「エクスポート」をクリックします。
パッケージファイルの生成後、ダウンロードアイコンよりファイルをダウンロードします。
UI：サイトインポート
「サイト管理」のサイト一覧から＋ボタンをクリックします。
インポートを選択し、ファイル参照よりインポートしたいパッケージファイルをアップロードします。
パッケージファイルにメール配信設定が含まれる場合、差出人の設定を行います。
差出人の設定が完了しましたら「インポート」をクリックします。
※有効な差出ドメインが無い場合、メール差出人ドメインより追加してください。
モーダルの内容を確認の上「OK」をクリックします。
インポートが完了しました。
サイト一覧にインポートしたサイトが追加されます。
