How to create a patch in CSIDE?

Hi,

I was looking into how to create a patch in CSIDE. In the builder, it was pretty straightforward: create a new ospace, orphan object, apply changes and use patchutils to dump a patch. However, with the changed module structure in the CSIDE it is unclear to me what the best way is on how to approach this. Any input on this would be much appreciated.

Olivier De Pooter

Find more posts tagged with

Comments

Darcy_Casselman

Hi Olivier,

You create a patch in CSIDE the same way you do in Builder. Most of the Open Text OScript developers create the ospace in Module Explorer, because it's temporary, but you can just as easily do it in the OScript Explorer and work with and save the source code.

The "best" way is open to debate. We're looking to improve the patch generation process in a future version.

Darcy.

TSystemsKMOps

Hi Everyone,

I'm still unclear of how to create the patch on CSIDE. I see that we have now the customizationsrt 10.5 but it's not the same as the old one where we can have the "Make a patch" menu (of course). But I'm wondering how to utilize this new module. There's no documentation provided.

Appreciate any lead.

Thanks.

Jiwen_Huang

Hi,

I am also trying to create a patch in a .pat file if possible using CSIDE from eclipse. Could you please help me with your finding for the same. Could you please point me to some documentation if available?

Thanks.

Darcy_Casselman

The documentation I have assumes you already know how to create a patch (without customizationsrt, of course). The basic steps haven't changed. And they are:

Create a patch ospace.
Orphan the object you want to patch into the ospace.
Override the features you want to patch and make your changes.
Run $PatchUtils.Dump('<name of ospace>').

Bingo! Patch. How you create ospaces and orphans have changed slightly in CSIDE, of course. You have a choice between whether you create your ospace in the OScript Explorer (with source) or in the Module Explorer (more like Builder). It doesn't matter as far as PatchUtils is concerned. It's probably easier to use the Module Explorer for this, especially if the patch isn't something you want to get back to (for which having the source would be helpful). If you want to use the OScript Explorer, we wrote up a few notes:

The process for creating a patch in CSIDE is similar to the process in Builder, with only a few small differences.

New module vs using an existing module

CSIDE doesn't make it easy to create OSpaces in arbitrary locations, so you'll want to decide whether to place it in an existing module (possibly that of the OSpace you're patching), or its own module (or even a dedicated module for patches).

The OSpace you're patching has been previously converted

If the module you're patching has been converted to the new source format, your job becomes a bit easier. Just create a new OSpace in the OScript Explorer, orphan the objects you want to patch via the New Object context menu option, and override the features as normal.

The OSpace you're patching hasn't been previously converted

If the module you're patching hasn't been converted to the new source format, you'll need to do everything via the Module Explorer. Since the object you're patching doesn't have new-style object names, you can't refer to them in source code (yet). In the Module Explorer, right-click on the module you want to create your patch OSpace in, and select Create OSpace. Select the first object you want to patch, choose New | Orphan from the context menu, choose your new patch OSpace, and edit the new orphan's name appropriately. Repeat for each other object you want to patch. Modify the values of these orphans in the Module Explorer.

Once you're finished

As before, you want to dump your new patch via $PatchUtils.Dump(). Just create a new one-off script to do that.

Christopher_Meyer

Hi Darcy,

How does one open an OSpace created in the "Module Explorer" view (similar to "OSpace :: Open Ospace..." in Builder)? After creating the patch and restarting CSIDE I'd like to open the OLL again to do further edits.

Thanks
Chris

Olivier_De_Pooter

In the module explorer, right click on the root (<projectname>_server)and click open ospace. If you created the patch ospace in the core (which I would recommend since creating ospaces may break modules), it will be located in <othome>/ospace folder.

Greg_Griffiths

While the approach works, there is a small issue for me, I've traditionally named the OSpace after the patch file name - e.g. PAT666 - to make thing easier, but the new IDE does not allow that, so I've got to rename the generated file - and its comments - and it makes keeping the OSpaces in a backup slightly more complex.

Raymond Tsui

I created an ospace in Module Explorer, did my patching in that ospace. I exited Eclipse. The ospace disappeared when I reopened Eclipse.

What are the steps to save my ospace?

André_Roy

You probably just created an Ospace without creating/installing a module, then your work is gone when you restart Eclipse or the service.

If you want to save your work, then you need to use the OScript Explorer. You can create a new module and add your “patch” OSpace inside of it. If you want to create a quick and simple patch, then it is fine to do it in the Module Explorer. Although the Oscript Explorer is still the recommended approach. If your patch is more complicated or you want to save it for future reference, then again, use the Oscript Explorer.

Regards,

André Roy
Principal Technical Analyst

HFCDev

Hi I'm trying to follow these instructions for the case of creating a dedicated module for any patch I want to create in my sandbox environment. I initially created a module called 'patches'. In the oscript explorer it looks like this:

I then attempted to create my own patch Ospace in here that would be named for the patch ID, in this case, pat201604210. When I went into my newly created module, selected new-->Other-->Ospace and gave it that name, I got an error saying that the ospace already exists. Here is the error log:

In my Oscript view, there is no new module, but strangely in my module view, it's there:

Restarting Eclipse and the patch module disappears (probably because it was never installed....fine). But since the ospace I was trying to create never got created as source, I'm unable to place my changes in an ospace with the fixes I want. I'd rather not have to do a patch module for every patch, and my first round of pathes is to fix core modules while I'm waiting for the OT fix - just so I can keep our project moving.

-Hugh

eLink User

Create your patch ospace in the core. The oll file Will appear in Othome/ospace.

Mvg

Olivier De Pooter

Verstuurd vanaf mijn iPhone

Op 21 apr. 2017 om 19:57 heeft eLink Entry: Content Server IDE Development Forum <contentserver-ide@elinkkc.opentext.com> het volgende geschreven:

eLink : RE How to create a patch in CSIDE? 3
RE How to create a patch in CSIDE? 3 Posted by Ferguson, Hugh On 04/21/2017 01:43 PM

Hi I'm trying to follow these instructions for the case of creating a dedicated module for any patch I want to create in my sandbox environment. I initially created a module called 'patches'. In the oscript explorer it looks like this:I then attempted to create my own patch Ospace in here that would be named for the patch ID, in this case, pat201604210. When I went into my newly created module, selected new-->Other-->Ospace and gave it that name, I got an error saying that the ospace already exists. Here is the error log:In my Oscript view, there is no new module, but strangely in my module view, it's there:Restarting Eclipse and the patch module disappears (probably because it was never installed....fine). But since the ospace I was trying to create never got created as source, I'm unable to place my changes in an ospace with the fixes I want. I'd rather not have to do a patch module for every patch, and my first round of pathes is to fix core modules while I'm waiting for the OT fix - just so I can keep our project moving.-Hugh
[To post a comment, use the normal reply function]
Topic: How to create a patch in CSIDE?
Forum: Content Server IDE Development Forum
Content Server: Knowledge Center CS16

Eric_Hohnbaum

I have a few tips to add.

When creating patches, I use the Module explorer and here are a few tips to address some of the concerns voiced previously:

1) If you have CSIDE in read only mode to create the OSpace and patch, when you restart it doesnt modify the opentext.ini file to include you temporary OSpace in the load list, which becomes a problem when you delete it later.

2) You can reopen a patch OSpace manually from the context menu of the ROOT node of the Module Explorer. It will open the OSpace in the CORE project, not where you originally created it.

Here is a sample run:

1) Start OClipse in read only mode (use Continue rather than Shut Down)

2) From the Module Explorer, right click the module you wish to produce a patch for, in this example CRT in the CRT Project. Select New OSpace.

3) Follow the wizard, creating the new OSpace. Call it TwentyEighteenOhTwoOhNine

4) Make your orphans and other changes.

5) In the OScript explorer, add a new Script file.

6) In that script file add the line $PatchUtils.Dump("TwentyEighteenOhTwoOhNine")

6) Right click on the editor window and run the script.

7) Retrieve the output from the <OTHome> folder "twentyeighteenohtwoohnine.txt" rename and do what you need to do with it.

If you restart OClipse the Ospace wil be gone as the OpenText.ini file wont have been modified. However you can open it for further editing by:

1) Right click on the ROOT node in Module Explorer, select Open OSpace

2) Navigate to where you created it. In this example <OTHome>\modlues\CRT<version>\ospace\twentyeighteenohtwoohnine.oll

This will open the OSpace in the ROOT namespace. When OClispe prompts, select Unlocked so you can edit as needed.

Eric_Hohnbaum

Darn it, it's the Core namespace, not the ROOT namespace