Using the HEAT Development Project
|
This option is for on-premise users only. Refer to the Operations Console Guide for HEAT Service Management Release 2014.2 for complete information on this feature. |
HEAT Release 2014.2 contains a new feature called the HEAT Development Project feature (beta version). Use this feature to create packages to migrate data from one instance of a tenant (such as staging) to another instance of a tenant (such as UAT). In this way, you can pick and choose which data to migrate instead of migrating the entire system. The HEAT Development Project feature allows you to migrate metadata, validation data, and configuration data (settings), but not master data or transactional data.
Cautions About the HEAT Development Project (Beta Version)
|
|
The HEAT Development Project is a new feature. This feature is currently in a beta process, and we encourage you to use it with extreme caution.
This feature gives you the ability to update the production instance of your tenant with configuration changes made in the staging instance of the tenant. If these changes conflict in some way with your HEAT Service Management system, they cannot be undone.
We recommend that you plan and prepare for moving a package as described in this section. We strongly encourage you to make a complete backup of the target tenant instance and to create a procedure for restoring the backup if need be:
Before you enable and use the HEAT Development Project feature, check with FrontRange Solutions support by emailing support@FrontRange.com. |
About the HEAT Development Project Feature (Beta Version)
Limitations
- The HEAT Development Project feature does not track package dependencies. You need to ensure that if you make a change that depends on another change, you migrate both changes.
-
Before using the HEAT Development Project feature, determine whether the package is complete and self-contained. The package should contain all dependent changes. Not having all the required changes in the package may cause the system to fail when you migrate the package and you may have to restore the target system from the back-up system.
Terminology
The HEAT Development Project feature uses the following terms:
- Transaction: An individual change to the database.
- Transaction set: A group of transactions.
- Project: A group of transaction sets.
- Package: Contains the transaction sets from multiple projects.
About Using Your Named Account to Log In
The first time that you log into the HEAT system as an administrator, the system displays the message stating that you are logging in as an administrator.
We recommend that you no longer use the generic administrator account when you are in the Configuration Console. With the HEAT Development Project feature, the HEAT system tracks all the changes made and attributes them to the user who made the changes. If all users log in using the generic administrator account, there is no way to know who made the changes.
If you see the above message, press OK and then log out as an administrator and log back in using your named account.
Using the HEAT Development Project Feature (Beta Version) to Create a Data Package
Follow these steps to use the HEAT Development Project feature:
- Create a project. See Creating a Project.
- Make changes to the HEAT system. See Making Database Changes.
- Create a package. See Creating a Package.
- Assign transaction sets to a package. See Assigning Transaction Sets to a Package.
- Close the package. See Closing a Package.
After performing all of these steps, you can migrate the data to the target system.
For information about the packages that have been migrated, see the Patch Log.
Creating a Project
You must create a project before you make any configuration changes. If you do not make any projects, all changes are logged to the default project. Use projects to organize the changes made to the HEAT system.
Follow these steps, on the system (such as staging) on which you want to make changes, to create a project:
| 1. | Log in to the HEAT system using your named account and not as an administrator. See About Using Your Named Account to Log In. |
| 2. | Click Configure Application to go to the Configuration Console. |
| 3. | From the Settings menu, click Build > HEAT Development Project > Projects. The system displays the HEAT Release Project screen. |
| 4. | Click New Record. The system displays a blank project screen. |
| 5. | Enter a name and description for the project and click Save. |
| 6. | Click Refresh. You can now see the new project name under the Project drop-down menu in the top right section of the toolbar (next to the Help link). |
Making Database Changes
| 1. | Select the project to which the changes you are going to make will belong, from the Project drop-down menu in the toolbar. |
| 2. | Make changes to the HEAT system as normal. For example, you can create a new business object, form, or grid. |
All changes made to the HEAT system are logged. You can see these changes, which are also called transactions, by going to the Settings menu and clicking Build > HEAT Development Project > Transaction Sets.
Creating a Package
Follow these steps, on the system (such as staging) on which you have made changes, to create a package:
| 1. | CFrom the Configuration Console Settings menu, click Build > HEAT Development Package > Package (BETA). The system displays the HEAT Release Package screen. |
| 2. | Click New Record. The system displays a blank package screen. |
| 3. | Enter a descriptive name for the package and click Save. |
Assigning Transaction Sets to a Package
Follow these steps, on the system (such as staging) on which you have made changes, to assign transaction sets to a package:
| 1. | CFrom the Configuration Console Settings menu, click Build > HEAT Development Project > Transaction Sets. The system displays the HEAT Transaction Set screen. |
| 2. | Select the transaction sets to include in the package. |
| 3. | Click Assign To Package. |
| 4. | Use the drop-down menu to select the name of the package to which to assign the transaction sets and click OK. |
| 5. | To check that the transactions set are in the package, do the following: |
| a. | From the Settings menu, click Build > HEAT Development Package > Package (BETA). The system displays the HEAT Release Package screen. |
| b. | Select the package name. You may need to click Refresh. |
| c. | The transaction sets are listed under the Transaction Set tab. |
Closing a Package
You must close a package before you can migrate it from staging to production. Closing a package means that you cannot do any more work on it, such as adding items, removing items, or changing items.
We recommend that you only close a package after you have completed testing on it and you are ready to migrate it from either staging or UAT to production. After you close a package, you cannot reopen it.
Follow these steps to close a package.
| 1. | CFrom the Configuration Console Settings menu, click Build > HEAT Development Package > Package (BETA). The system displays the HEAT Release Package screen. |
| 2. | Highlight the name of the package to close. |
| 3. | Click Close Package on the right. |
| 4. | At the confirmation prompt, click OK. |
Using the HEAT Development Project Feature (Beta Version) to Migrate a Data Package
See the Operations Console Guide for HEAT Service Management Release 2014.2.1 for information about migrating data.