Creating EsiObjects Cache Datasets

This procedure assumes that you are making both the kit ESI and USER databases for Cache. Follow the instructions below to make Cache kits.

Setting Up the Kit Area

First you must export all the routines and globals from your development environment needed to populate the new kit. To do this follow the steps below:

1. Make sure the EsiObjects listener serving the ESI development environment is shut down.
2. Creating the GTM and Cache kits require using the Cache system at this point. Bring the Cache Terminal interface up.
3. Use the ZN command to switch to the development ESI namespace that contains the software you want to kit.
4. Now, execute Do CacheKit^VESOUGSV. This saves all VES* routines to the CACHE_KIT_VES.RSA and the ^VESO* globals in the KIT_VESO.GSA file. They will reside in the ESI development (default) directory.
5. Shut down the Terminal interface.

Ceating New Cache Databases and Namespaces

1. If you already have a kitting database and namespace, proceed to the next section.
2. Bring up the System Management Portal.
3. Create two directories on a drive for the USER and ESI datasets. Take the Cache directory default.
4. From the Home page, click on the Configuration link and then the Local Databases.
5. Click on the Create New Database link. Enter the ESI database. Take the default directory. Uncheck the CSP checkbox.
6. Repeat steps 3 through 5 for the USER database.
7. Create the Namespaces and map the globals and routines:
   • Go back to the Configuration page. Click on the Namespace link and then click on the Create New Namespace link. Enter the ESI namespace. Repeat this step for the USER namespace.
   • Go back to the Namespace page. For the USER namespace, ensure that the globals beginning with VESO* will be mapped to the ESI database when it is mounted. 
   • Go back to the Namespace page. Now click on the Routine Mapping link. Insure that the VESO* and VESo* routines are mapped to the ESI namespace.

Loading the New Kit into the newDatabases

1. Move the CACHE_KIT_VES.RSA and KIT_VESO.GSA files from the ESI (default) directory to the new ESI Kitting directory.
2. From the Terminal interface of the Cache system, use the ZN command to make sure you are in the new kit ESI namespace.
3. Now, using the %RI utilitiy, import the KIT_VES.RSA file. Make sure you import the routines as Cache routines.
4. Next, import all VESO* globals to the new space from the KIT_VESO.GSA file by executing Do Load^VESOUGLD.
5. Now, delete the VESOUGLD routine since it deletes all VES* globals. You can easily do this by entering ZR ZS VESOUGLD at the programming prompt. Note that there are two spaces between the ZR and ZS commands.
6. Next, set the new version number in the ESI namespace by: Set ^VESOL("S","Version")="Major.Minor.Release.Build" where Major is the major version number, Minor is the minor version number, Release is the current release of the version and Build is the build number. This forces an upgrade when the user brings up the EsiObjects UI.
7. Now, set the new version number in the VESoL global: Set ^VESoL("S","Version")="Major.Minor.Release.Build"

Preparing the Kit Databases

1. Now from the Terminal window, switch to the USER namespace and execute the ^VESOTCMN routine. Start up the listener on the default port.
2. From the EsiObjects IDE, create a session and connect to it. Once the session connects, it will start the Upgrade. This will take only as short time.
3. Within the Session Browser, expand the session and click on one of the classes to give it focus.
4. Bring up Xecute Shell by executing Object|Xecute Shell. You should be in the $Environment object.
5. Execute the following commands to prepare the kit:
   1. Create I%P=ESI$Packager
   2. Do I%P.PrepDist
6. Execute the following commands to verify linkages, purge all code bodies to the last 3 versions and remove debug compiles for the ESI and Base libraries.
   1. Create I%RM=ESI$ReleaseManagement
   2. Do I%RM.PrepCore
7. Now, disconnect the EsiObjects UI session.
8. Return to the terminal interface and use the ^VESOTCMN utility to shut down the listener.
9. To enable turning security off and on through VESOTCMN, execute the following command. This must be set in the USER namespace.
   • Set ^VESoTCP("P",0,"AllowDisable")=1
10. The ESI and USER files are ready for inclusion in the kit.

Zipping the Kit

At this point you have the EsiObjects kit databases loaded and prepared.

1. First, using the Terminal interface, change to the kitting USER namespace using the ZN command.
2. If you have the EsiObjects UI connected to the kitting port - shut it down.
3. Use the ^VESOTCMN routine to shut down the TCP listener.
4. Now, return to the Cache Home page of the Management Portal. Click on the Databases link of the Operations column.
5. Dismount the kitting ESI and USER databases.
6. Prepare a working directory on your computer to collect the kit files.
7. Using Windows Explorer, copy the ESI cache.dat file to the directory and then change its name to Cache_ESI.dat
8. Next, copy the USER cache.dat to the directory and then change its name to Cache_USER.dat
9. Return to the Database page of the Management Portal and remount the kitting ESI and USER databases.
10. Copy in the License.txt and License Explained.txt files from the previous released version.
11. Copy in the readme_cache.txt file from the previous released version and modify it to reflect the current release.
12. Now, using the WinZip or comprable product, zip these files into a file named eo_server_cache_Major_Minor_Release_Build.

Once the EsiObjects UI is kitted, put these files on SourceForge.