Linkage properties file

If the callLink element remoteBind property for a called program was set to runtime in the linkage options part, EGL looks for the linkage properties file at run time; the source of the file name is determined in the following ways:

• A Java™ program checks the cso.linkageOptions.LO Java™ runtime property, where LO is the name of the linkage options part used for generation. If the property is not present, the EGL runtime code seeks a linkage properties file named LO.properties. Again, LO is the name of the linkage options part used for generation.

  In this case, if the EGL runtime code seeks a linkage properties file but is unable to find that file, an error occurs on the first call statement that requires use of that file. For details on the result, see Exception handling.

• The Java™ wrapper stores the name of the linkage properties file in the program object variable callOptions, which is of type CSOCallOptions. The generated name of the file is LO.properties, where LO is the name of the linkage options part used for generation.

  In this case, if the Java™ Virtual Machine seeks a linkage properties file but is unable to find that file, the program object throws an exception of type CSOException.

The primary entry is of type cso.serverLinkage and can include any property-and-value pair that you can set in a callLink element of the linkage options part, with the following exceptions:

• The remoteBind property is necessarily runtime and is ignored.
• The type property cannot belocalCall, because linkage for local calls must be established at generation time.

In the most elementary case, each entry in the linkage properties file is of type cso.serverLinkage. The format of the entry is as follows:

  cso.serverLinkage.programName.property=value

programName

In most cases, the name of the called program. If the called program is generated by EGL, the name you specify is that of a Program part, not the value of an alias property that is specific to the Program part.

A special case applies if your call statement includes the linkageKey property. Here is an example call statement:

call "MyProgram01" {linkageKey = "MyProgram02"};

In this situation, set the programName qualifier in the linkage properties file to the linkageKey value; in this case, to MyProgram02.

property

Any of the properties appropriate for a Java™ program, except for properties remoteBind and pgmName. For details, see callLink element. Use externalName for the alias property, not alias.

value

A value that is valid for the specified property.

An example for called program Xyz is as follows, where xxx refers to a case-sensitive string:

  cso.serverLinkage.Xyz.type=remoteCall
  cso.serverLinkage.Xyz.remoteComType=TCPIP
  cso.serverLinkage.Xyz.remotePgmType=EGL
  cso.serverLinkage.Xyz.externalName=xxx
  cso.serverLinkage.Xyz.package=xxx
  cso.serverLinkage.Xyz.conversionTable=xxx
  cso.serverLinkage.Xyz.location=xxx
  cso.serverLinkage.Xyz.serverID=xxx
  cso.serverLinkage.Xyz.parmForm=COMMDATA
  cso.serverLinkage.Xyz.providerURL=xxx
  cso.serverLinkage.Xyz.luwControl=CLIENT

The format of a cso.application entry is as follows:

  cso.application.wildProgramName=appName

wildProgramName

A valid name, an asterisk, or the beginning of a valid name followed by an asterisk. The asterisk is the wild card equivalent of one or more characters and provides a way to identify a set of names. Two special cases apply:

• If a linkageKey property is in a call statement, the value that is tested against wildProgramName is the value of the linkageKey property.
• If no linkageKey property is in a call statement and the called program is generated by EGL, the value that is tested against wildProgramName is the name of the Program part, not the value of the alias property for that part.

appName

A series of characters that conforms to the EGL naming conventions. The value of appName is used in subsequent cso.serverLinkage entries.

The following example show use of an asterisk as a wild card character. The cso.serverLinkage entries in this example handle any call to a program whose name begins with Xyz:

  cso.application.Xyz*=myApp
  cso.serverLinkage.myApp.type=remoteCall
  cso.serverLinkage.myApp.remoteComType=TCPIP
  cso.serverLinkage.myApp.remotePgmType=EGL
  cso.serverLinkage.myApp.externalName=xxx
  cso.serverLinkage.myApp.package=xxx
  cso.serverLinkage.myApp.conversionTable=xxx
  cso.serverLinkage.myApp.location=xxx
  cso.serverLinkage.myApp.serverID=xxx
  cso.serverLinkage.myApp.parmForm=COMMDATA
  cso.serverLinkage.myApp.luwControl=CLIENT

The following example shows use of the same cso.serverLinkage entries to handle calls to any of several programs, even though the names of those programs do not begin with the same characters:

  cso.application.Abc=myApp
  cso.application.Def=myApp
  cso.application.Xyz=myApp
  cso.serverLinkage.myApp.type=remoteCall
  cso.serverLinkage.myApp.remoteComType=TCPIP
  cso.serverLinkage.myApp.remotePgmType=EGL
  cso.serverLinkage.myApp.externalName=xxx
  cso.serverLinkage.myApp.package=xxx
  cso.serverLinkage.myApp.conversionTable=xxx
  cso.serverLinkage.myApp.location=xxx
  cso.serverLinkage.myApp.serverID=xxx
  cso.serverLinkage.myApp.parmForm=COMMDATA
  cso.serverLinkage.myApp.luwControl=CLIENT