Cy Think Survey

Programmer's Guide to CMS Programming (3)  

These are the steps for merging the core CMS code with the code on an individual client website. The core CMS code is common to all client websites. In a perfect world this code would be completely stable and reliable. Obviously, this procedure is needed to transfer needed changes and improvements to the clients.

These steps must be completed for each client when changes and enhancements are made to the core CMS code. These steps are designed to minimize the chance that the client will experience negative consequences during the update process.

This procedure is for programmers for several reasons. Program code from each client site must be reviewed and compared to the core CMS code. This review requires general systems knowledge and also requires knowledge of specific details of the Cy Think CMS. It is also helpful to have some knowledge of the Cy Think methodology that keeps everything working reliably. This procedure is included with the general system help files because all the players involved the development process, including the customer, need to be reassured that the programming that is running their website is the most reliable and up-to-date code that is possible.

Most of the steps in this procedure require password-protected access. These steps should be followed closely. Any deviation from this procedure should be done with utmost care.

Preliminary Procedure

1. Use the Merge Changes / Log to determine which website you will update next.
2. Note the update start time in the Start Merge column of the log.
3. Review the type and impact of the changes that are being merged into the target website.
4. Check the client's website, to make sure it is functioning. Check pages that will change with the update.
5. Connect to the website using FTP, create a backup of the remote configuration and files.
   1. Log on with the FTP client.
   2. Go up one level to the local parent directory for the site.
   3. Click MkDir and create a directory named "backup YYYY-MM-DD".
   4. Go to the new directory.
   5. Copy the files from the remote website to the local backup directory.
   6. Copy selected remote folders to the local backup directory as needed.
6. See what files have changed since the last merge.
   1. Remember to not update the client site with the new files until the tasks in the next section are done.
   2. Go to the root folder on the remote site. Go to D:/CyThink/coreCMS on the local side.
   3. Sort remote by date. What is the date of the most recent change to a core file? (e.g., .pl)
   4. Sort local by date. What coreCMS files have changed since then? Any surprises?
7. Review any database table changes.

Initial Changes Preparing for Main Upload

1. Use MySQL Admin to compare the client's tables with the current database tables. If new fields are added at the end of the rows, it should be safe to update the tables, where needed. The SQL code to do these updates should be in D:/CyThink/coreCMS/sql. Update the tables.
2. Fix any data problems that can be fixed at this time. E.g. Are any changes needed to the code table?
3. Determine from notes whether any new text files are required or need to be sent ahead to the client's website. FTP any such new files.
4. Review configuration files for any needed changes. Update these files, as needed: bodypart.txt, menuctrl.txt, menudata.txt, picrings.txt, robots.txt.
5. Determine if JshPARM.pm needs to be sent ahead of the other core files. If so, FTP the file to the client and set the appropriate parameters.
6. Determine if JshGUI.pm needs to be sent ahead of the other core files. If so, FTP the file to the client.

Main FTP Upload of Changes

1. FTP new and changed files to the client's website.
   1. Log in to the client website host using FTP.
   2. Source is D:/CyThink/coreCMS/ on the local system.
   3. Destination is normally the root folder on the client site. Be alert for the exceptions.
   4. Sort Source by Date and note the number of files that have changed.
   5. You may update all core files or only those that have changed. If you choose to update only the files that have changed, it may help to sort them by date.
2. Fix any remaining data problems. Some problems may be hidden until after core files are changed. E.g. Are any changes needed to the code table?
3. Again, review configuration files for any needed changes. Review these files, as needed: bodypart.txt, menudata.txt, picrings.txt, robots.txt.
4. Check the client's website, to make sure it is functioning. Check pages that will change with the update.
5. If you notice any problems, fix them or report them before you continue on to the next client.
6. Log the time when the merge was completed in the App Layer OK column of the Merge Changes / Log.

This procedure is abbreviated and high level. Programmers should apply their knowledge and experience to supply any missing details.