Cy Think Survey

Programmer's Guide to CMS Programming (2)  

This procedure picks up after code has been created and tested for a single client. It covers the process of integrating the new code into the core CMS code prior to distributing the code to the remaining Cy Think clients.

The reliability, consistency and maintainability of the Cy Think websites depend on consistently following these steps. This procedure is for programmers because program code from the various sites must be reviewed and compared to achieve optimum results.

Recheck that All is Ready For the Merge

1. Look in the Merge Changes / Log and note which website is the source.
2. The merge target is D:\CyThink\coreCMS.
3. Look in the site folder of the source client. Make sure the changed files have been recorded in the Data Layer Change Log and the Application Layer Change Log.
4. Use ExamDiff, Files.xls, file dates, etc. as needed, to confirm what files have changed and that what was changed should be merged into the core code.
   1. Verify the scope and extent of the changes. Use ExamDiff. In ExamDiff, put the file from D:\CyThink\coreCMS in file 1 and put the file from the client site folder in file 2.
   2. Note and record the number of files to be merged.
   3. Make notes about what has changed so adequate testing can be done.
5. The program code in the core files should be made flexible and parameter driven so it will be able to handle any and all variations from website to website. All code changes should be made with this in mind. If any additional coding is required to implement this, it should be done in this step, as part of the merge process. DO IT NOW! Here are some tips and guidelines in this regard.
   1. Be sure to clearly track which website is the "test" website for the feature being coded. This can depend on the situation, but will likely be the source website.
   2. Re-compare, as necessary, using ExamDiff.
   3. If necessary, create a new CMS Parm to control the effectivity of a feature.
   4. Consider potential alternate control techniques.
   5. Change the code in the source file so it depends on the Parm setting.
   6. Describe the test procedure in the Merge Changes / Log.
6. If there are more than a few changes, make a summary list to know what to keep an eye on. Ask these questions.
   1. Were there any database changes? What tables are involved?
   2. Were there any JshPARM changes? What is affected?
   3. Were there any JshGUI changes? What functions are involved?

Update the Core CMS Code

1. Copy the source file(s) to D:\CyThink\coreCMS replacing the old files with the new files.
2. Delete the file(s) from the client site folder, e.g. D:/customer/site.
3. Update the procedures and features documentation.
4. Propagate the changes to all the other CMS sites. See this link.
   Programmer's Procedure to Update a Client's Website

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