z/OS Cryptographic Services PKI Services Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


What are substitution variables?

z/OS Cryptographic Services PKI Services Guide and Reference
SA23-2286-00

A substitution variable holds a value that HTML code can reference. At run time, the actual value replaces a substitution variable.

You use square brackets to delineate a substitution variable.

Example:
[base64cert] 
Note:
  1. Substitution variables are case-sensitive.
  2. Depending on the section where a substitution variable is present, it might not have a valid meaning. For example, the [base64cert] substitution variable is meaningless before the certificate is retrieved. Therefore, in this case, the value of [base64cert] would be the null string (an empty string).
Table 1 summarizes valid substitution variables:
Table 1. Substitution variables
Substitution variable Description
altrawvalue The concatenated value of the AltOther fields.
base64cert The requested certificate, base64-encoded.
browsertype A special substitution variable to qualify named fields only. It enables Mozilla-based browsers and Internet Explorer to perform browser-specific operations, such as generating a public and private key pair. To generate a key pair, a Mozilla-based browser uses a KEYGEN HTML tag, while Internet Explorer uses ActiveX controls.

For example, suppose you specify %%PublicKey[browsertype]%% in a TEMPLATE CONTENT section. If the user referencing this section uses the Mozilla Firefox browser, INSERT PublicKeyNS is included. If the user's browser is Microsoft Internet Explorer, INSERT PublicKeyIE is included.

cadomain The CA domain name used to examine the preregistration record in the Simple Certificate Enrollment Protocol (SCEP).
errorinfo Information such as the return code and reason code related to a failing SAF call.
iecert The requested certificate in a form that Microsoft Internet Explorer accepts.
keyid The SHA1 hash of the generated public key.
optfield A special substitution variable that should be placed in any certificate field name INSERT where the end user can supply the value. It makes the input field optional.
p12cert A PKCS #12 package in DER encoded format, containing a certificate and the private key that PKI Services generated for the certificate.
printablecert This variable contains the certificate details so that the end user can confirm that the certificate is the correct one to renew or revoke. The displayed data is extracted from the ICL entry.
readonly This substitution variable is converted to a null string when the INSERT is used for input purposes, such as when requesting a certificate. It is substituted with the string readonly when the INSERT is used for output purposes, such as when displaying request or certificate information.
requestor The requestor's e-mail address, when the keys for the certificate were generated by PKI Services.
serialno The serial number of a certificate.
tmplname A certificate template name. This is primed from the HTML tag <SELECT NAME="Template"> in the <APPLICATION NAME=PKISERV> section. The end user selects it on the first Web page.
transactionid A unique value returned from a certificate request.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014