Merge pull request #20 from Bertievh/main

Version 25.0.0 Documentation Updates

Author: rweesner

docs/administration/settings.md

@@ -49,4 +49,18 @@ If this rule is enabled, the definition will be deleted when a schedule from an
 
 ### Package update unchanged Schedules
 
-During package deployment, a check is made to see if the schedule version of the target schedule within the package matches the schedule version of the schedule to be deployed. If the versions match, only the schedule deployment information is updated on the target schedule. If this rule is selected, the target schedule contents will be overwritten. 
+During package deployment, a check is made to see if the schedule version of the target schedule within the package matches the schedule version of the schedule to be deployed. If the versions match, only the schedule deployment information is updated on the target schedule. If this rule is selected, the target schedule contents will be overwritten. 
+
+### Exclude Script from Schedule Deployment
+
+When enabled, this rule will split the deployment of schedules and scripts. 
+* Script definitions are no longer imported into the Deploy database during schedule import.
+* Script definitions are no longer deployed along with schedules / packages.
+
+When using this rule, script definitions must be imported and deployed separately using the SCripts Menu. Schedule definitions will only contain a reference to an embedded script in job definition.
+There is also no attempt made to ensure that version numbers are consistent across OpCon systems.
+It is therefore up to the users to ensure that a script and its version is available during the deployment process. If the script, runner or version is not available in the target OpCOn database, the deployment will terminate with an appropriate error message.
+
+As the version numbering may be inconsistent across OpCon systems, it is suggested that the 'Latest Version' is used in the embedded script job definition.
+
+When the Script_Name transformation rule is used, the users must ensure that the required script is available in the script repository of target OpCon database. 

docs/index.md

@@ -7,7 +7,7 @@ sidebar_label: 'OpCon Deploy'
 
 OpCon Deploy is a separate application working on a central repository that contains the schedule definitions, transformation rules, and all the required configuration information to deploy the schedule definitions between OpCon environments in a controlled and consistent manner.
 
-The current version is **23.3**.
+The current version is **25.0**.
 
 ## Overview
 

docs/release-notes.md

@@ -4,14 +4,68 @@ sidebar_label: 'Release notes'
 
 # OpCon Deploy Release Notes
 
-The Deploy Client is not paired with a specific OpCon Release. 
+The Deploy Client is not generally paired with a specific OpCon Release. 
+If specific OpCon versions are required, they are noted in the release information.
 
 There are no Deploy patch releases as corrections are applied to the main software and a new version is released on a regular basis.  
 
 Deploy contains compatibility checks to ensure that features supported in newer OpCon Releases are not deployed to older opCon Releases.
 
-The ImpEx2 Server portion of Deploy is paired with each specific OpCon release and is part of the OpCon Release. The ImpEx2 
-server for each release are patched and released within the OpCOn release cycles.   
+The ImpEx2 Server portion of Deploy is paired with each specific OpCon release and is part of the OpCon Release. Therefore the ImpEx2 
+server for each release is patched and released within the OpCon release cycles.   
+
+## Version 25.0
+
+2025 January
+
+**Migration COnsiderations**
+
+This release of Deploy requires matching OpCon versions 25.0.0, version 23.0.8, version 22.0.19.
+
+New rule **Exclude scripts from schedule deployment** separates the deployment of schedules and scripts. The default value for the rule is false, so it will not have an
+impact on existing installations. Once this rule is enabled, the script definitions will no longer be included in the schedule definitions in the **scriptList** section. 
+
+* If the **Exclude scripts from schedule deployment** rule is not selected, the appropriate script / version will be created as part of the schedule deployment process. 
+* If the **Exclude scripts from schedule deployment** rule is selected, the appropriate script / version will need to be created before the schedule deployment process.   
+
+Transformation **Environment** changes have been added to facilitate the duplication of schedules within a single OpCon system to create a unique execution environment.
+The defined environment value will now be prefixed to the machine name as well as the script name. This means that a unique instance of the script will be created during the deployment process.
+
+**New Features**
+
+:eight_spoked_asterisk: **OPCDEPLOY-1390**: Implemented new transformation rules for Job, OS2200 Element Name and OS2200 Runid definitions. The additional rules support the changing of names using masking (wild cards ? and * - P* to change first character of name, P?????N to change the first and last characters of the name). 
+The following rules have been included
+
+    * Job_Name_Mask           used to transform the Job Name using a mask.
+    * OS2200_Elementname_Mask used to transform the OS2200 Elementname using a mask.
+    * OS2200_Runid_Mask       used to transform the OS2200 Runid using a mask.
+
+:eight_spoked_asterisk: **OPCDEPLOY-1392**: Implemented new a new feature to split the importing and deployment of schedules and scripts. 
+When this feature is enabled, scripts are no longer included in the schedule import and deployment processes. 
+Scripts must therefore be imported and deployed using the Deploy **Scripts Import / Deploy** processes. 
+It should be noted that individual Script deployment does not currently support transformation.
+ 
+  * When specific script versions are required during the schedule deployment process, the script version must be available on the target system.
+  * When using the **Script Name** transformation during Schedule / Package deployment, the script name must already exist on the target OpCon System. 
+  * Simulation has been updated to include the checking for scripts and versions.
+
+For more information see **Exclude Script from Schedule Deployment** rule in **settings** section.
+
+To enable this feature, select the **Exclude scripts from schedule deployment** rule using the **Settings** section. The default value of this rule is false (not enabled).  
+
+**Fixes**
+
+:eight_spoked_asterisk: **OPCDEPLOY-1389**: Fixed a problem when deploying scripts, roles are not set correctly. During Import process extracts role names and inserts them into the deploy_script tables.
+During deployment, role names are included in deployment object, resulting in script having the required roles assigned. 
+  
+  * This change has database updates adding a new column roles to the deploy_script table (Null values are allowed so there is no impact to existing records).
+
+:eight_spoked_asterisk: **OPCDEPLOY-1393**: Fixed a problem when importing a script which has a new version and additional roles, the additional roles are not added to the deploy_script table. 
+
+**OpCon Fixes**
+:eight_spoked_asterisk: **OPCON-25833**: Fixed a problem during the script extract process to include a list of roles associated with the script. Fixed a problem during the script deployment process to assign the roles associated with the script.
+
+:eight_spoked_asterisk: **OPCON-25933**: Made enhancements to Windows and Unix job import to support splitting Deploy script and schedule / package deployments. Import routines need to check local OpCon database for script information (script, script type, runner ids) as the script information is no longer part of the OpConExtract object.
 
 ## Version 23.3
 
@@ -75,7 +129,7 @@ server for each release are patched and released within the OpCOn release cycles
     * SQL_Script_User           used to transform the user name field of the MS SQL Script Job Action.
     * SQL_Script_Filename       used to transform the script file name field of the MS SQL Script Job Action.
     * SQL_Job_Server            used to transform the server name field of the MS SQL JOB Job Action.
-    * SQL_Job_Jobname           used to transform the jobname field of the MS SQL JOB Job Action.
+    * SQL_Job_Jobname           used to transform the job name field of the MS SQL JOB Job Action.
     * SQL_Job_User              used to transform the user name field of the MS SQL JOB Job Action.
     * SQL_DTExec_Server         used to transform the server name field of the MS SQL DTExec Job Action.
     * SQL_DTExec_Package_Path   used to transform the package field of the MS SQL DTExec Job Action.

docs/transformations/transformation-tag-definitions.md

@@ -499,6 +499,22 @@ This tag is used to change the Job Name value of the job definition and is chang
 
     * Indicates if the match to be performed is the complete definition or a partial definition (value is true or false; default is false).
 
+### Job_Name_Mask
+
+This tag is used to change the Job Name value of the job definition using a mask that supports wild card characters (? and *). When using the mask ? characters indicates which character in the name should not be changed, while the * characters indicates all following characters should not be changed. 
+To change the first character of the name the currentValue should be T* and newValue should be P*. To change the first and last characters of the name, the currentValue should be T?????A and the newValue should be P????B. The Job_Name_Mask tag supports the following tags:
+
+* currentValue	
+
+    * (*Required*): Contains the value to check .
+
+* newValue	
+
+    * (*Required*): Contains the new value to be applied.
+
+* partialUpdate	
+
+    * Not used.
 
 ### Job_Tag
 
@@ -664,6 +680,23 @@ This tag is used to change the value of an OS2200 element associated with the jo
 
     * Indicates if the match to be performed is the complete definition or a partial definition (value is true or false; default is false).
 
+### OS2200_Elementname_Mask
+
+This tag is used to change the OS2200 Element Name value of the job definition using a mask that supports wild card characters (? and *). When using the mask ? characters indicates which character in the name should not be changed, while the * characters indicates all following characters should not be changed. 
+To change the first character of the name the currentValue should be T* and newValue should be P*. To change the first and last characters of the name, the currentValue should be T?????A and the newValue should be P????B. The Job_Name_Mask tag supports the following tags:
+
+* currentValue	
+
+    * (*Required*): Contains the value to check .
+
+* newValue	
+
+    * (*Required*): Contains the new value to be applied.
+
+* partialUpdate	
+
+    * Not used.
+
 ### OS2200_Filename
 
 This tag is used to change the value of OS2200 file name associated with the job and supports the following tags:
@@ -744,6 +777,23 @@ This tag is used to change the value of an OS2200 Runid associated with the job
 
     * Indicates if the match to be performed is the complete definition or a partial definition (value is true or false; default is false).
 
+### OS2200_Runid_Mask
+
+This tag is used to change the OS2200 Runid value of the job definition using a mask that supports wild card characters (? and *). When using the mask ? characters indicates which character in the name should not be changed, while the * characters indicates all following characters should not be changed. 
+To change the first character of the name the currentValue should be T* and newValue should be P*. To change the first and last characters of the name, the currentValue should be T?????A and the newValue should be P????B. The Job_Name_Mask tag supports the following tags:
+
+* currentValue	
+
+    * (*Required*): Contains the value to check .
+
+* newValue	
+
+    * (*Required*): Contains the new value to be applied.
+
+* partialUpdate	
+
+    * Not used.
+
 ### OS2200_Userid
 
 This tag is used to change the value of an OS2200 userid associated with the job and supports the following tags:

docs/transformations/transformations-special-definitions.md

@@ -14,7 +14,7 @@ Within OpCon, a schedule name must be unique within an OpCon instance. There may
 
 **environment**	
 
-(*Required*): This tag is defined in the Transformations object and consists of a value that will be prefixed to schedule, property, resource, and threshold definitions.
+(*Required*): This tag is defined in the Transformations object and consists of a value that will be prefixed to schedule, property, resource, threshold machines and script definitions.
 
 ![Environment Sample](../../static/img/environment-sample.png)