Moving from Gen Host Encyclopedia to CSE
search cancel

Moving from Gen Host Encyclopedia to CSE


Article ID: 55168


Updated On:


Gen Gen - Workstation Toolset Gen - Host Encyclopedia Gen - Run Time Distributed


When there is a need to change encyclopedia repository from the z/OS Host Encyclopedia to the Client Server Encyclopedia (CSE) or just to offload models from the Host encyclopedia to CSE encyclopedia, here are some tips to consider.


Release: Any


The Gen Host encyclopedia software has built-in capabilities to move a model to the CSE as a child model but not as a "normal" parent model. A parent model has the characteristics that it is primary to the encyclopedia that it resides. It is not expected to be returned to the Host encyclopedia so there is no limitation on the process and functions that can be performed on the CSE. A child model is limited in its functionality e.g. Version Control. So when downloading models from the Host Encyclopedia, there are steps to be followed to ensure that the models are parent models. As always, the CA Gen Customer Support Representatives are available to answer any specific questions about this process for your environment.

There are two major reasons models loaded to the CSE from the Host must be parents. The destination model in version control must be a parent. An error will occur if the destination model is a child model. The second is if the models remained child models and developers do updates, extraneous objects and associations will be retained in deleted status needed to upload models back to the parent (Host). This situation will cause problems with processing other functions of the tool.


The download process from the Host Encyclopedia to the CSE will result in a child model on the CSE. There is not an automatic process such as the UNLOAD / LOAD function in DB2 for moving all models at one time from the Host encyclopedia data tables to a non-DB2 database on the CSE, e.g., Oracle. Models must be downloaded individually from the Host encyclopedia to the CSE. 

All subsets and models that will be moved to the CSE must be checked-in to the Host Encyclopedia before downloading to the CSE.  A full check-in of all models/subsets is a prerequisite action for transferring a model permanently to the CSE. 

The following steps will move a model from the Host to
the CSE with ancestry retained:

  1. From the Main Menu, select option 1. Host Encyclopedia functions.
  2. From the Host Encyclopedia function panel, select option
    3. Model management.
  3. From the Model management panel, select option 15. Download model.
  4. Instructions and an example for Running the download process on the mainframe is below.

    Download Model COMMAND ===>

    Type the Model name or request Prompt for list selection. Type the software version. Type the name of the download transaction file WITHOUT your TSOID prefix if you want to override the default. You may select the Upload option or Extract option but not both. For retaining ancestry, select Extract. Type the Child ency id. If the Child ency id is not known, sign-on to the Coordination Client of the destination CSE and select Encyclopedia, and detail. Type the Codepage. Select the No for Readonly option. Select execution mode of choice and then press enter.
    Model name . . . . . .   GEN SAMPLE MODEL________________________ +              Software version . . .   9.1.A5                                          Transaction file name.   IEF.TRAN________________________________       
    Upload option . . . . / No . Yes Extract option . . . . . No / Yes Child ency id . . . 1________
    Child model name . . GEN SAMPLE MODEL CSE____________________
      (blank if same as parent)
    Codepage . . . . . . . 1252_ Readonly option. . . . / No . Yes Execution mode . . . . / Online
      . Batch
    F1=Help F3=Exit F4=Prompt F12=Cancel

    The extract option will create a LOAD transaction file to be uploaded to the CSE. Again, this method will retain ancestry. Adoptions are not necessary before migrations.
  5. Transfer the <userid>.ief.tran file to the CSE in a directory of your choice.
  6. Use the following command on the CSE server to upload models to the CSE encyclopedia:

    upload -u <userid> -t load -d <directory>

    After a successful upload, the model on the CSE is now a child model. Remember the object of moving the models to the CSE repository is because the models are not intended to go back to the Host Encyclopedia, thus models on the CSE encyclopedia must be parent models to operate as designed with the CSE encyclopedia functions.
  7. No updates should be made to the models until it is made a parent model.  To change a child model into a parent model, copy the child model to a name of your choice.  The new model will be a parent model.  Once the copy has completed, you can delete the child model.

The following steps will move a model from the Host to
the CSE without retaining ancestry:

  1. Follow steps 1 through 3 above.
  2. On step 4 above, the only change would be to select UPLOAD and not EXTRACT.
  3. The upload option will create an UPDATE transaction file to be uploaded to the CSE. Again, this method will not retain ancestry.
  4. Use the following command on the CSE server to upload models to the CSE encyclopedia:

    upload -u <userid> -t update -d <directory>

    After a successful upload, the model on the CSE is now a parent model. Adoption may be required before migration can run successfully. If model ancestry is important in your environment, do not use this option. The models residing on the Host will not be marked as checked out. Models successfully downloaded to the CSE can be deleted on the Host encyclopedia because they will now be retained in the CSE repository.


If applications will continue to run on the Host Mainframe, e.g., CICS, IMS, then the z/OS IT tool is used to accomplish this. Once the models are on the CSE and have been correctly prepared for use, changes to the model can occur on the CSE or the workstation toolset. The model or subset can be downloaded to the workstation toolset for further object changes before remote generation. MVS bind properties to set collection Id, version, and owner can be set using the MVS Bind Options for Triggers or the Business System in the Construction Client. The dynamic link of procedures, action blocks and screens is set using the Environment Parameters window in the Construction Client.

A remote file can be generated from the Construction Client or the workstation toolset by setting the generation default parameters for DB2 z/OS . A remote file is created and is transferred to the Host in TEXT format for use with the z/OS IT. The z/OS IT will process and install applications as specified in the target, e.g., CICS, IMS, TSO. When using the z/OS IT, the same Host Construction datasets that were used when generating application on the Host encyclopedia can be used as location datasets in the z/OS IT.

For more detail information on using the Client Server Encyclopedia and the z/OS IT, refer to the CA Gen Client Server Construction guide and Gen z/OS Implementation Toolset guide.  The Gen Host Construction guide has instructions for downloading models.