Remote data store descriptor

The remote data store descriptor is a Java™ properties file that contains the information necessary for the z/TPF system to connect to a remote data store.

This descriptor defines the remote data store to the z/TPF system and contains the information that is required by the z/TPF tpfrdsClient JAM to read and write data from a remote MongoDB instance.

To define a remote data store descriptor, use the tpfrds_template.rds.properties template in the base/tpf-fdes/templates directory.

Last updated

Added in 2020.

Requirements and restrictions

  • Name the remote data store descriptor file according to the descriptor_name.rds.properties format, where descriptor_name is a unique name. The full file name, including the file extension, must be less than 250 characters in length.

    Consider creating the descriptor file with a meaningful file name that describes the function of this remote data store descriptor. For example, you might use a file name of Far_Away.rds.properties for a remote data store descriptor that describes a remote data store called Far_Away.

  • The format of the remote data store descriptor is defined in the tpfrds.lib.dfdl.xsd schema file that is shipped with the z/TPF system. Ensure that the schema file is loaded to the /sys/tpf_pbfiles/tpf-fdes directory on the z/TPF system. The properties in the remote data store descriptor are not order dependent; that is, you can specify the individual properties in any order.
  • Before you load a remote data store descriptor to your z/TPF system, you must create the MongoDB databases and collections in the remote MongoDB data store for this descriptor. You need to create the MongoDB databases and collections only for the file IDs that will have subfiles stored in the remote data store.
  • Use the E-type loader or the image loader to load this deployment descriptor to the /sys/tpf_pbfiles/tpf-fdes directory.
  • After a new remote data store descriptor is loaded to the z/TPF system, you must deploy the deployment descriptor by entering the ZMDES command with the DEPLOY parameter specified. If needed, you can undeploy the deployment descriptor by entering the ZMDES command with the UNDEPLOY parameter specified.

Property details

Table 1. Remote data store descriptor properties
Property name Description Type Required
rds.name A 1- to 32-character unique name of the remote data store. The name can contain uppercase or lowercase letters, numbers, periods (.), or underscore (_) characters.

Do not specify a name of ALL or LOCAL in uppercase, lowercase, or mixed case.

 String Yes
rds.description A 1- to 256-character description of the remote data store. String No
rds.mongodb.URI The connection string URI that is used to connect to the remote MongoDB instance for this remote data store.

For more information about the connection string URI format, see the MongoDB driver documentation.

 String Yes

Programming considerations

  • You can include comment lines in the descriptor by starting a line with the number sign (#) or exclamation point (!).
  • Unrecognized property names are ignored.
  • If the remote data store is configured to use Secure Sockets Layer (SSL) for secure connections or client certificates for client authentication, you must install security certificates for the remote data store.

Examples

The following example defines the Far_Away remote data store and defines the connection string URI that is used by the tpfrdsClient JAM to connect to the remote MongoDB instance.

rds.name = Far_Away
rds.description = Test remote data store configuration
rds.mongodb.URI = mongodb://testlinux.mycompany.com:27017
The following example defines the Farther_Away remote data store and defines the connection string URI that is used by the tpfrdsClient JAM to connect to the remote MongoDB instance. This remote MongoDB instance requires that clients use SSL to connect to the instance, so the MongoDB connection string URI must contain the ssl=true option.
rds.name = Farther_Away
rds.description = Test remote data store SSL connection
rds.mongodb.URI = mongodb://testlinux.mycompany.com:27018/?ssl=true