From 780571681d9ab5aecc836322b1a7ec891ce76aec Mon Sep 17 00:00:00 2001 From: dkatzz <86739416+dkatzz@users.noreply.github.com> Date: Thu, 12 Sep 2024 14:02:51 -0400 Subject: [PATCH] Add documentation for program migration (#502) * Create docs for program migration * Update program-migration.md * Update SUMMARY.md --- docs/SUMMARY.md | 1 + .../civiform-admin-guide/program-migration.md | 59 +++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 docs/user-manual/civiform-admin-guide/program-migration.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e5088de2..52c78c4d 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -36,6 +36,7 @@ * [Manage Trusted Intermediaries](user-manual/civiform-admin-guide/manage-trusted-intermediaries.md) * [Manage API keys](user-manual/civiform-admin-guide/manage-api-keys.md) * [Using Markdown](user-manual/civiform-admin-guide/using-markdown.md) + * [Migrating programs between environments](user-manual/civiform-admin-guide/program-migration) * [Program Admin Guide](user-manual/program-admin-guide/README.md) * [How to become a Program Admin](user-manual/program-admin-guide/how-to-become-a-program-admin.md) * [Review completed applications](user-manual/program-admin-guide/review-completed-applications.md) diff --git a/docs/user-manual/civiform-admin-guide/program-migration.md b/docs/user-manual/civiform-admin-guide/program-migration.md new file mode 100644 index 00000000..d6cabf41 --- /dev/null +++ b/docs/user-manual/civiform-admin-guide/program-migration.md @@ -0,0 +1,59 @@ +# Migrating programs between environments + +## Overview + +Program migration is a feature to allow programs and their associated questions to be moved between CiviForm environments. + +## Feature Flags + +There are two feature flags to be aware of for Program Migration: + +1. PROGRAM_MIGRATION_ENABLED + - You must enable this feature flag to use either version of program migration + - Use this flag when you want to import a program into an environment that already has existing programs. Programs imported using this flag will not affect any programs in the import environment. + - Using this flag will create duplicate questions if there are questions in the import environment that match questions being imported (match is determined by the question admin name). We suggest you replace the duplicate questions with existing ones after importing your program, so your applicants benefit from CiviForm’s shared question model. + - You can find questions that were duplicated, since their admin names will have -1 or another number attached to it. Once you replace duplicate questions in new imported programs, you can archive the duplicate questions that were created. + +2. NO_DUPLICATE_QUESTIONS_FOR_MIGRATION_ENABLED + - The PROGRAM_MIGRATION_ENABLED feature flag must also be enabled for this to work. + - Use this flag when you want to import many programs with overlapping questions into a fresh environment. + - If there are existing programs or questions in the import environment, they must be published before importing a new program. + - Importing a program with this flag enabled will put all programs into draft mode. + - Importing a program with this flag enabled will update any questions that already exist in the import environment, which means updating any programs that contain those questions. This is why we do not recommend using this flag if there are already programs in the import environment, especially if you are importing into a production environment. + +## Exporting a Program + +1. Once the PROGRAM_MIGRATION_ENABLED flag is enabled, you will see a new menu item for each program on the program dashboard page that says “Export program”. + Export program image +2. Click this to be taken to the program export page for that program. +3. From there you will have the option to download or copy a json representation of the program. +4. Program export works for programs that are in draft or active mode. Either way they will be imported as drafts into the new environment. + +## Importing a program + +1. Once the PROGRAM_MIGRATION_ENABLED flag is enabled, you will see a new link on the program dashboard page that says “Import existing program”. + Import program image +2. Click this link to be taken to the program import page and follow the instructions there to import a program. + +## Program Settings Not Migrated + +There are a few program and question settings that are not yet being migrated over. You will have to manually set these in your import environment after importing a new program: + +- Program images +- Program statuses (and their associated translations) +- Any categories assigned to the program +- Primary Applicant Info settings applied to questions +- TI groups associated with the program + +## Potential Errors + +Situations in which you might get an error include: + +- Attempting to import a program with an admin name that matches the admin name of an existing program. + - You can resolve this by editing the program admin name in the json, but please be careful when doing so and only use lowercase letters with dashes between words (validation for this will be added soon). +- Exporting a program from an environment that is on a different CiviForm version than the import environment. + - Please try to make sure environments are on the same CiviForm version before migrating programs between them. If they are on different versions, you might see an error about an expected field missing. +- Programs are in draft mode. + - With the NO_DUPLICATE_QUESTIONS_FOR_MIGRATION_ENABLED flag enabled, you must make sure all programs and questions are published before attempting to import a new program. +- Attempting to import a program with program visibility set to “Visible to selected trusted intermediaries only” (shows up as “SELECT_TI” in the program json) + - Since we don’t migrate ti groups with the program, you must select a different visibility for the program before migrating.