Patch-Manager

The patchmanager is a command line tool used to update an Orchestra installation on the basis of a given patch file.

How to Use

To use the tool, follow these steps:

1. Open your Command Prompt or Terminal.
2. Navigate to the directory where the patchmanager is located.
3. Enter the command patchmanager followed by the required parameters and options.

Create Patch

Creates a patch with a prepared patch file.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-target	Required	Directory where the patch is applied. br/ Can be defined multiple times if there are multiple targets.
-file	Required	Path to the zip file to create patch.
-confirm	Optional	Confirms the patch is ready for patching. br/ If not specified, the patch must later be confirmed using the confirm command.

Example:

create-patch -file C:\tmp\patch.zip -base D:/patching -target "lib|D:\ORC_HOME\Application\orchestra\WEB-INF\lib" -confirm

Confirm Patch

Confirms that the patch is ready for patching.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the patch to confirm (from get-patches command).

Example:

confirm -base D:/patching -name 568b7040-7993-4927-b472-9a5d8992b63b

Unconfirm Patch

Sets the patch as not ready for patching.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the patch to unconfirm (from get-patches command).

Example:

unconfirm -base D:/patching -name 568b7040-7993-4927-b472-9a5d8992b63b

Apply Patch

Applies the confirmed patches.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-target	Required	Directory where the patch is applied. br/ Can be defined multiple times if there are multiple targets.

Example:

apply-patches -base D:/patching -target "lib|D:\ORC_HOME\Application\orchestra\WEB-INF\lib"

Get Patches

Shows the list of all patches.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.

Example:

get-patches -base D:/patching

Result contains:

• Patch Name: Generated name for patch
• Uploaded At: Upload date and time
• Confirmed: "Y" if patch is ready for patching, otherwise "N"
• File Name: Patch zip file name

Get Histories

Shows the list of all patch histories.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.

Example:

get-histories -base D:/patching

Result contains:

• Patch Name: Generated name for history
• Applied At: Applied date and time
• File Name: Patch zip file name

Get Backups

Shows the list of all backups.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.

Example:

get-backups -base D:/patching

Result contains:

• Backup At: Backup date and time
• File Name: Backup name

Create Restore Patch

Creates a restore patch from a backup.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the backup to create the restore patch from.

Example:

create-restore-patch -base D:/patching -name 20231101_113704321_Backup

Delete Patch

Deletes a patch with the given patch name.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the patch to be deleted.

Example:

delete-patch -base D:/patching -name 568b7040-7993-4927-b472-9a5d8992b63b

Delete History

Deletes an applied patch with the given history name.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the history to be deleted.

Example:

delete-history -base D:/patching -name 568b7040-7993-4927-b472-9a5d8992b63b

Delete Backup

Deletes a backup with the given name.

Parameter	Type	Description
-base	Required	Directory that contains patches, history, and backup directory.
-name	Required	Name of the backup to be deleted.

Example:

delete-backup -base D:/patching -name 20231101_113704321_Backup