Text Configuration Documents

A text configuration document is an text document with a format that is known to the content developer, but it is not a properties configuration document or an XML configuration document. You can use regular expressions to write search expressions in text configuration documents.

To state that a configuration document is a text file type, use the <TextConfigurationDocument> element. For example:

<Dependency name="some_reference" providerCiType="oracle" scope="default">
   <TextConfigurationDocument name="tnsnames.ora">
      ...
ClosedDefining Conditions

The only search conditions allowed in text configuration documents are regular expressions. If the pattern matches, the condition returns True.

The regular expressions may contain one or more variables as part of a condition. Variables are replaced with their actual values during runtime, when generating the concrete search expressions.

If the variable contains a list of values, an expression similar to the following is generated:

^SomeText(Value1 | Value2 | Value3)MoreText$

Either value returns True for the condition.

Example of conditions in a text configuration document

<TextConfigurationDocument name="MyConfig.txt"> 
   <Condition> 
      <Operator type="or"> 
         <RegExpCondition>
            <RegExp>^HTTPS?://(${HOSTNAME)/${SITE_NAME}/.*$</RegExp>
         </RegExpCondition>
         <RegExpCondition>
            <RegExp>^HTTPS?://(${IP_ADDRESS)/${SITE_NAME}/.*$</RegExp>
         </RegExpCondition>
      </Operator>
   </Condition>
</TextConfigurationDocument>

This example shows that the MyConfig.txt text configuration document must have all of the following:

  • \URL\Protocol\@name must have the value HTTP or HTTPS.
  • \URL\Host\@name must contain either the provider’s IP address (or one of its IP addresses) or its hostname.
  • \URL\Site\text() must starts with a /, continue with the provider’s SITE_NAME, contain another /, and then contain any string.
ClosedInjecting Variable Values

You can use regular expressions with groups to inject a value into a variable for text documents. The groups mark the text that should be injected. In a dedicated <Variables> section, use the following syntax:

<RegExpVariable variable=”VARIABLE_NAME” expression=”REGULAR_EXPRESSION” group=”GROUP_NUMBER” />

In this case, GROUP_NUMBER is the index (starting with 0) of the group in the regular expression defined by REGULAR_EXPRESSION.

For example, for a file containing the line

This is part of a configuration document

and the statement

<RegExpVariable variable=”VAR” expression=”(.*)configuration (.*)” group=”1” />

puts the value “document” into the variable VAR. You may use variables that were defined in different documents together in the same document. For example:

<RegExpVariable variable=”VAR” expression=”.*${PREV_VAR} (.*)” group=”0” />

If PREV_VAR has the value “configuration”, VAR is injected with the string “document”.

You can use <RegExpVariable> as part of a <RegExpCondition> tag, by using the following syntax:

<RegExpCondition>
   <RegExp>REGULAR_EXPRESSION</RegExp>
   <Variables>
      <RegExpVariable variable="VARIABLE_NAME" group="GROUP_NUMBER" />
   </Variables> 
</RegExpCondition>

The regular expressions that the variable’s “group” attribute refers to is the same as the one in <RegExp>.

The injected variable is always injected with a single value.