Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The process works by first transferring one environment, and testing a development integration with that one environment. Once the development integration is cleared to work, all other environments are transferred, and the integration is upgraded to handle the new SaaS endpoints. Finally, the integration is scheduled to cutover from on-prem to GraFx Publisher, one final transfer is planned to synchronize files, and the entire production site is switched to GraFx Publisher.

Typically, this requires one business day of downtime for the final cutover, but the actual time depends on the size and number of the environments being transferred.

Transfer Each

Best for an integration where there are multiple sites for each environment.

The process works by planning to transfer one environment at a time and testing a development integration with each environment. For each environment, once the development integration is cleared to work with that environment, a cutover is planned. During that cutover, one last transfer is made to synchronize, and then the production site is switched to GraFx Publisher.

Typically, this requires half a business day to one business day of downtime for the final cutover for each environment.

Note

 Cutover

The cutover is when testing is done and your site is ready to switch all API endpoints from your on-prem install to CHILI publish Online.

At this point, you typically want to do another data transfer from your on-prem environment to your

...

GraFx Publisher environment so all the files are synchronized. This cutover day must be planned with the CHILI publish support team, and will usually require a few hours to one business day of downtime. 

Each Cutover Will Cause Downtime!!! 

Determine your plan or create a new plan of your own. The Customer Success team will help as best they can, but keep in mind that the choice is ultimately up to your team. Also keep in mind that no matter what you do, there will be scheduled downtime. The final cutover requires files to be transferred and that takes time.

...

It requires four simple steps:

  1. Getting a dropzone from CHILI publishPrepare the data the environment ID and request a transfer

  2. Transfer with the Data Migration ToolkitTransfer data to the dropzone

  3. Notify the Customer Success team when the transfer is complete

Step 1: Getting the environment ID and request a

...

transfer

You will first need to create a ticket on https://mysupport.chili-publish.com/ requesting a dropzone for data transfer.

If you are transferring one environment at a time, then you will need to request multiple dropzone URLs. If you are transferring all environments, then you will only need one dropzone URL. Keep in mind that if you transfer all your environments, but you own less CHILI publish Online environments, you need to note which environments you want to be ignored after the transfer.

The Customer Success team will reply back with a URL for your dropzone — like the link below — with in 1 to 3 business daysWhen you make this ticket, please include the environment ID or IDs that you are wishing to transfer. You can find the IDs by clicking on an environment in the https://chiligrafx-dev.com/environments and finding the ID in the URL.

https://chilitennatmigration.blob.core.windows.net/migration-cstest?sv=2019-02-02&si=migration-cstest-72B725F20C&sr=c&sig=ctaDl%2BrzrWQEKsh6Hxs%3df

 

This URL points to an Azure blob storage. We use blob storage as a temporary space to store your data until you notify the Customer Success team that your transfer is complete. Once notified, one of our SaaS team members will transfer the data from the blob storage to the final environment.

Note

 If this transfer is for production, where you are planning to do a cutover, then you need to notify the Customer Success team in your ticket and schedule the transfer from blob to the environment.

Without scheduling, it takes 1 to 4 business days, after you notify the Customer Success team, for our SaaS team to transfer blob to the environment. 

The dropzone URL will only be active for a short period. Therefore it is best to make this ticket within a few days before you are ready to do the transfer.

Step 2: Data Migration Toolkit

With the Data Migration Toolkit, you can prepare your local data before you send it to the dropzone.

The tool also has a built in command "CopyEnvironmentToDropzone" to copy data to the Dropzone.

Download the Migration Toolkit (exe file for windows CLI)

https://stchilireleases.blob.core.windows.net/cli/CHILI.Migration.CLI_win-x64.zip

Step 3: Notify the Customer Success team when the transfer is complete

After all the data has transferred with no failures, then you will notify the Customer Succes team via the original ticket that all data has transferred.

If you have not scheduled the transfer, it will take 1 to 4 business days for the data to be transferred from the dropzone blob storage to your environment (or environments).

The Customer Success team will reply back with the environment is ready. 

 Data Migration Toolkit

The "Data Migration Tool Kit CLI" is a command-line application designed to simplify data migration for CHILI publisher. It various commands to facilitate the migration process:

...

chiligrafx-dev.com/environments and select an environment

...

Grab the ID from the URL

image-20240522-172133.pngImage Added

If you are having trouble getting the IDs, please share the environment name or BackOffice URL.

In your ticket, if you are looking to setup a transfer date for a production cutover, please make sure to ask at least 10 days in advance.

The Client Success team may ask you about your environment size, you get this from Windows native tools like file explorer or using the Data Migration Tool.

Step 2: Transfer with the Data Migration Toolkit

Download the Data Migration Toolkit

Panel
panelIconId1f6a8
panelIcon:rotating_light:
panelIconText🚨
bgColor#FFBDAD

Be sure to stop all services (Web and ChiliService) before using the CLI. Otherwise you risk damaging your data.xml files or causing errors during file transfer.

Panel
panelIconId26a0
panelIcon:warning:
panelIconText⚠️
bgColor#FFFAE6

We strongly suggest backing up the data.xml files found in the Resources/Documents and Resources/Assest and Resources/Fonts before the transfer.

You can use this tool to run a report which will gives you environment statistics such as file size, number of files, and average script execution time. This is done by running the command CreateEnvironmentReport and specifying your environment's path.

...

Preparing for Migration: Before using the tool, it's important to stop all related services to prevent changes in certain resource files. After running the tool, a report file is generated in the same folder, highlighting key environment data and any absolute paths in resource files.

...

Code Block
.\CHILI.Migration.CLI CreateEnvironmentReport -d "C:\chili_data\Environments\test"

-d is the path to your environment

Before Transfer

If you are doing a production transfer (not just testing). You need to fix potential absolute paths in the resource files can cause issues post-migration, especially in cloud environments. To avoid this, the

...

FixDataXmlFiles command converts absolute paths to relative ones

...

.

Code Block
.\CHILI.Migration.CLI FixDataXmlFiles -d "C:\chili_data\Environments\test"

-d is the path to your environment

Run this command immediately before copying data. Because after changes in data.xml files, some resources may not work correctly locally. That is why we suggest it only for a production transfer.

If you backed up your data.xml files, you can just restore them to undo the changed made by FixAbsolutePathsInDataXml

Transferring Data

Info

It’s important to note that you are transferring to a temporary cloud-based storage and not directly to your environment. This is due to infrastructure.

Single Environment Transfer

To migrate a single environment to the cloud-based storage, use the CopyEnvironmentToDropzone command. This requires the path to your environment and

...

the environment ID. It's recommended to perform this operation when your system is under minimal load and has sufficient free RAM (at least 4GB).

In essence, this tool kit provides a streamlined way to prepare and execute data migration, addressing specific needs such as environment analysis, path conversion, and safe data transfer to cloud storage.

Generate report

To generate a report with environment statistics, run the executable file with the CreateEnvironmentReport command and specify the path to the environment on your disk

Example

...

.\CHILI.Migration.CLI

...

CopyEnvironmentToDropzone -d

...

"C:\chili_data\Environments\test

...

Update absolute paths

To update absolute paths to relative paths for all resources, run the executable file with the FixAbsolutePathsInDataXml command and specify the path to the environment on your disk

Example

...

" -e "45bbcd53-6334-48a9-8394-0cf4821d7bbc"

-d is the path to your environment

-e is your environment ID

Note

By default, the history of documents and assets will not be transferred. This decision is aimed at increasing the speed of transfer, especially in large environments where these files can number in the hundreds of thousands. Since very few clients utilize this feature for any real production use-case, the transfer of history files is disabled by default.

The history files are used in the BackOffice to display changes to a file including preview errors and file update dates.

image-20240708-191331.pngImage Added

If you need to transfer history files, you can re-enable this feature by using the -i parameter and setting it to true.

For example:

CopyEnvironmentToDropzone -d "C:\chili_data\Environments\test" -e "45bbcd53-6334-48a9-8394-0cf4821d7bbc"

...

Run this command immediately before copying data. Because after changes in data.xml files, some resources will not work correctly locally.

Copy data to Dropzone

To copy the environment into a blob container, run the executable file with the CopyEnvironmentToDropzone command and specify the path to the environment on your disk and the Dropzone link URL that was provided to you by CHILI publish earlier.

...

-i true

Multi Environment Transfer

Alternatively, the Data Migration Toolkit now supports a multi-environment transfer option. If you are planning to utilize this option, it is important to inform the support team prior to your cutover day.

Open the below to see full instructions.

Expand
titleMulti-Environment Transfer Instructions

First you will create a JSON file to define the environment ID, which is called a DeploymentGuid and the name of the environment (folder name) on your local system EnvironmentName.

Example of JSON

[

    {

        "DeploymentGuid": "c999ab9d-be99-9999-b99c-d99f99f99999",

        "EnvironmentName": "Environment1"

    },

    {

        "DeploymentGuid": "c888ab9d-be99-8888-b99c-d99f99f88888",

        "EnvironmentName": "Environment2"

    },

    {

        "DeploymentGuid": "c777ab9d-be99-7777-b99c-d99f99f77777",

        "EnvironmentName": "Environment3"

    }

]

To migrate multiple environments to the cloud-based storage, use the CopyEnvironmentToDropzone command but instead of -e you use -c. It's recommended to perform this operation when your system is under minimal load and has sufficient free RAM (at least 4GB).

.\CHILI.Migration.CLI

CopyEnvironmentToDropzone

-d

"C:\chili_data\Environments\

test

"

-u "

-c "C:\MyFolder\EnvironmentsToMigrate.json"

-d is the base path to the environments directory

-c is the path to the configuration json

Note

See https://

stchilimigrationeuwest.blob.core.windows.net/migration-test?sv=2021-10-04&si=upload-to-dropzone&sr=c&sig=BJLxnBSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

chilipublishdocs.atlassian.net/wiki/spaces/CPDOC/pages/edit-v2/1525055493#Single-Environment-Transfer about transferring history files

Step 3: Notify the Customer Success team when the transfer is complete

After all the data has transferred, then you will notify the Customer Success team via the original ticket that all data has transferred.

If there are failures, notify the Customer Success team. In rare cases, a small number of documents will fail to transfer, which usually is small enough to handle manually.

If you did not set a date in Step1, it will take 1 to 4 business days for the data to be transferred from the dropzone to your environment (or environments).

The Customer Success team will reply back with the environment is ready.