Creating a WCS Patch: Difference between revisions
(Initial Creation) |
(Updated) |
||
Line 50: | Line 50: | ||
When complete, you can click '''Save Page'''. You will be prompted to enter an editing summary - enter one and click '''Save Page'''. | When complete, you can click '''Save Page'''. You will be prompted to enter an editing summary - enter one and click '''Save Page'''. | ||
=== Sections === | |||
The programs included in the patch should be added to the Release Components section. | |||
* Ensure that the version numbers of each program are added. | |||
* Any programs not included can be removed from the section (the row deleted). | |||
* If there is a database script, add the ID of the script here (no version is required). | |||
* If there are multiple scripts, add them here. | |||
The cases resolved in this release should be added to the Issues/Changes section. | |||
* Internal Ref is DevOps reference | |||
* External Ref is SalesForce reference | |||
* Description should be the description of what is resolved. | |||
Any WCS database changes or additional rules should be added here: | |||
* For database changes, this is optional. You can add the table and field name, the default value and a description of what this is for in the notes. You may reference the Internal Reference above. | |||
* For Rule changes, list the rule level (system, Warehouse, User Group, etc), the rule name, the default value, and the description of the rule. | |||
The Installation Instructions section does not necessarily need changes. However, if your release includes WMS or CTMS releases, and the ER/PATCH number is known, please enter it here for cross reference. If you have release notes created for this ER or PATCH, then include them as a link e.g. ''<nowiki>[[ER CTMS 047-001]]</nowiki>'' in source editing or <code>CTRL-K</code> ''ER CTMS 047-001'' in visual editing. | |||
=== Result === | === Result === |
Latest revision as of 10:44, 15 July 2025
This guide covers creating a new WCS Patch, using the automated facilities available through the new page creation utilities, the WCS PATCH template and variables to pre-set titles and categories.
Creating a new WCS PATCH
Note: you must be logged in.
Go to the main page and click on Create New Pages from Templates
Enter your WCS PATCH ID in the correct area of the screen e.g. UP250715
Click Create New WCS PATCH
The system will take you to the page with everything you need for creating a WCS PATCH, editing in source mode.
You can edit in source mode, or you can flip to visual editing. Either:
- Click Create instead of Create Source at the top
- Click the pencil icon and select Visual Editing.
You will then be editing in Visual Editor.
Source Editing
Change the following at the top of the page
- #vardefine:SystemVersion - the system and version e.g. WCS 3.4
- #vardefine:BuildNo - the patch ID e.g. UP250715
- #vardefine:ConnectedTo - the system that the WCS is connected to e.g. WMS, CTMS
This will set the title, system, version, and Build number automatically from what was entered. If you have Preview turned on, it will change a few seconds after you make the changes.
You can then continue editing, adding rows to the different sections, adding or removing unwanted sections, etc.
When complete, enter an editing summary at the bottom of the page and click Save Changes.
Visual Editing
Under the header, greyed out, there are 3 variables, used by the page for the titles, version and (importantly) the categorisation of the page.
- #vardefine:SystemVersion
- #vardefine:BuildNo
- #vardefine:ConnectedTo
Click on the variable to change and click the Edit button - an edit popup will show. Enter the value you want here:
- #vardefine:SystemVersion - the system and version e.g. WCS 3.4
- #vardefine:BuildNo - the patch ID e.g. UP250715
- #vardefine:ConnectedTo - the system that the WCS is connected to e.g. WMS, CTMS
This will set the title, system, version, and Build number automatically from what was entered. It won't change immediately - it will change when you save the page.
You can then continue editing, adding rows to the different sections, adding or removing unwanted sections, etc.
When complete, you can click Save Page. You will be prompted to enter an editing summary - enter one and click Save Page.
Sections
The programs included in the patch should be added to the Release Components section.
- Ensure that the version numbers of each program are added.
- Any programs not included can be removed from the section (the row deleted).
- If there is a database script, add the ID of the script here (no version is required).
- If there are multiple scripts, add them here.
The cases resolved in this release should be added to the Issues/Changes section.
- Internal Ref is DevOps reference
- External Ref is SalesForce reference
- Description should be the description of what is resolved.
Any WCS database changes or additional rules should be added here:
- For database changes, this is optional. You can add the table and field name, the default value and a description of what this is for in the notes. You may reference the Internal Reference above.
- For Rule changes, list the rule level (system, Warehouse, User Group, etc), the rule name, the default value, and the description of the rule.
The Installation Instructions section does not necessarily need changes. However, if your release includes WMS or CTMS releases, and the ER/PATCH number is known, please enter it here for cross reference. If you have release notes created for this ER or PATCH, then include them as a link e.g. [[ER CTMS 047-001]] in source editing or CTRL-K
ER CTMS 047-001 in visual editing.
Result
Your page will be created. The categories will be set from the variables entered as well. Assuming we entered the following
- #vardefine:SystemVersion - WCS 3.4
- #vardefine:BuildNo - UP250715
- #vardefine:ConnectedTo - WMS
The title will default to:
- Software Release - WCS 3.4 for WMS
- BUILD NUMBER UP250715
The categories will default to:
- WCS WMS PATCH
Now, if you go to category "WCS", you will see the sub categories
- WCS WMS PATCH
- WCS CTMS PATCH
In this example UP250715 will exist in WCS WMS PATCH. Example below:
Note that these patch categories also exist under the parent system's categories:
- WCS WMS PATCH -
- WCS CTMS PATCH -