How To Guide X3 Patching

Transcription

1 How To Guide X3 Patching Patching Overview... 2 Patch Inquiry... 2 Patch Scenarios... 2 Before Patching... 4 Test of Patch... 4 Code Review... 4 Patch Installation... 5 Transaction Validation... 6 Menu Validation... 7 October 2008 Sage Page 1 of 7

2 Patching Overview Patching is the process of installing application updates to one or more X3 folders. A patch may install issue fixes or custom modifications. It is important to read and understand any documentation provided with the patch. The patch documentation will include information about the purpose of the patch but it may also include instructions to be performed before and after the patch. The X3 patching process is a sequential process. That means patches must be installed in the order specified. If you have a problem with a patch, it is important that the problem be resolved or determined to be inconsequential before additional patches may be installed. Patch Inquiry The Patch Inquiry function (GESAPT) is located on the Admin menu at Development / Utilities / Patch / Patch Inquiry. The function allows you to view the patch history of the current folder. Patch Scenarios When patching, you need to know the type of folder you will be patching. There are two types of folders: Non - Test Folder : This is the most common scenario. This folder does not have its test flag set. When patches are installed on a non-test folder, it is important to also patch the X3 folder at the same time. Both folders must be patched is because patches may contain different types of elements and depending on the type of element it may be installed at the X3 folder level or at the lower folder level. All production folders should be set as non-test folders. Test Folder : A test folder allows all elements to be installed at the test folder level. The advantage is that the folder is self-contained, meaning all patch elements applied to a test folder are installed at this folder s level. A test folder allows patches to be installed that will only affect the test folder itself. The patches can then be tested in the test folder without affecting other folders within the same runtime. Do not select any other folders when patching a test folder. October 2008 Sage Page 2 of 7

3 How to tell if a folder is set as a Test folder. Run the Folders function (GESADS), using the Admin menu, Parameters / General Parameters / Folders. Click on one of the available folders. On the General Tab, you will see a checkbox labeled Test Folder. If checked, the folder is a test folder. In most cases, the checkbox will be an accurate indication as to the folder s test status. However, a more reliable method is to check the setting of the TEST parameter in the ADOVAL table. To do this run Table Maintenance function (GMAINT). Using the Admin menu it is found at Development / Utilities / Table Maintenance. You are then prompted with the screen below. The folder will default to the current folder. Enter ADOVAL in the Table field and click OK. Next you will be taken to table maintenance screen. Go to the menu bar at the top of the screen and click on option Selection and Selection. Enter the following as the Selection Criterion: PARAM= TEST Click OK. Check the value of the VALEUR field: 2 = TEST folder, otherwise it is not a TEST folder. October 2008 Sage Page 3 of 7

4 Before Patching The following steps should be done before attempting to install any patch. Test of Patch If you have custom modifications or are unsure if you have custom modifications, run the Test of Patch function (PATCHT). The Test of Patch function will display any conflicts with the patch being tested against the modifications in place on the folder you intend to patch. Custom modifications are protected by an activity code and the Test of Patch function will show the X3 element (screen, table, window, ) along with the activity code when a potential conflict is present. To run the Test of Patch function from the Admin menu, go to Development / Utilities / Patch / Test of Patch. The function appears almost identical to the Patch Integration function. Specify the folder containing the patch or specific patch to be tested. You then must select the Folder(s) you wish to have the patch tested against. The resulting trace file will include any conflicts. The specific action to be taken when a conflict is reported requires additional analysis. This topic is also covered in X3 Admin training. Code Review All patches include the new or modified elements contained in the patch including any source files. If any standard programs have been modified on your system, those modified source files will be saved under your X3 folder in a directory called TRT_Change. Before patching, check to see if this folder exists. If it does not exist you may skip this step in your patching process. If the folder does exist you must compare the files contained in the TRT_Change directory to the list of source files contained in the patch(es) you intend to install. For each file you find your TRT_Change directory that is also included in one or more of the patches you plan to install, you should do the following for each file: First, ensure the most recent version of the file currently in use on your system is copied to the TRT_Change directory. After the patch(es) have been installed, you must analyze each file and reintegrate your specific modifications into the new file installed during the patch process. Once all files have the changes integrated, they must be recompiled. This topic is also covered in X3 Admin training. October 2008 Sage Page 4 of 7

5 Patch Installation The following are general patch installation guidelines. Any patch may have specific requirements so all patch documentation should be read and understood before attempting to install. 1. Review all patch installation instructions. Carry out any pre-installation instructions if any. Also, review any source code modifications that may need to be reintegrated (see page 4 Code Review). If you have any custom modifications, you should also run the Test of Patch function (see page 4). 2. Patches may be delivered in a patchset which may contain many patch files or may be delivered individually. Patches may come zipped or unzipped but regardless of how they are delivered, the patches must be made available on the X3 server. X3 patch files have either a.dat extension or no extension. You will need to locate the file or directory containing the patch files. 3. Create a temporary folder on the X3 server. Unzip or simply move the patch files to this new temporary folder. 4. Logon to the X3 Folder with the admin username. Run the Patch Integration function (PATCH). Using the Admin menu the Patch Integration function is found at Development / Utilities / Patch / Patch Integration. In the Patch File Directory box enter the full path and folder name of the folder containing the patches. By specifying a folder, all patch files contained in the folder will be installed. Again, all patch files have a.dat extension or no extension. To install a single patch, specify the patch file name. Check both the Patch Integration and Comment Overwrite checkboxes. In the Folder Selection list box, delete any folders that you wish to exclude from receiving the patches. Normally you will either want to apply the patch to all folders or to a single folder that has been set up as a Test folder. 5. To install a patch once all information has been entered, click OK. To exit without installing the patch, click End. 6. When the patching process completes, review the displayed trace file. Be sure to review all pages, using the arrows if necessary. If a problem was encountered during the patch installation, an error message will be written to the trace file. 7. Review patch installation instructions again and carry out any After Installation instructions if they exist. After installation, instructions usually ask that one or more X3 transaction types be revalidated. Time saving tip: If you are installing more than one patch or patchset, note all the transactions that need to be revalidated and revalidate the noted transactions after all patches have been installed. October 2008 Sage Page 5 of 7

6 8. Integrate any modifications made to the files contained in the TRT_Change directory. See the above section Code Review for more details. Transaction Validation There are two methods for validating a transaction either individually or as a group. 1. Individual validation to validate a transaction individually you would go to the specific transaction type maintenance function, select a specific transaction and then click the Validation button. Below is an example of a Sales Order transaction. October 2008 Sage Page 6 of 7

7 2. Group validation To validate all transactions of a particular type or all transactions of multiple types you can run the Transaction Generation function (GENMSKTRT). Using the Admin menu it is found at Development / Utilities / Dictionary / Transaction Generation. When selected the following screen is displayed. For each module you wish to have its transactions generated, select Yes in the Validation column. Set to No for the modules you do not wish to have transactions generated. Menu Validation Occasionally a patch may require that menus be validated. To validate a menu, run the Menu Validation function (VALMENU). In the Menu Profiles box, enter the menu name to be validated and click OK. October 2008 Sage Page 7 of 7