Instead of requiring users to enter metadata after creating a map from a template, you
can configure parameters that enable users to easily enter the metadata directly on the
Create Map dialog. These template parameters are available in CCMS Desktop only.
About this task
This procedure is the second of two required to make template parameters function
within a map template. For a fuller understanding of the whole process, start with
Using template parameters.
These steps use the template variable examples in Add custom variables to a map template.
Important: Make configuration changes in a test
environment and confirm they work before copying them to a production
environment.
Procedure
-
Open the TEXTML Administration perspective and connect to the
server.
-
Navigate to system/conf/templateparameters.xml.
-
Check out and open the file in a text editor.
This file might include a number of examples. You can add your own parameters
either before or after those examples, or you can comment out the examples
for more visual clarity.
-
Inside the
<parameters>
element, define the first new
parameter.
Here is a definition for a parameter that corresponds to the
{{acme.authorname}}
variable:
<parameter name="acme.authorname" label="Author" type="TEXT" mandatory="true"/>
This is a basic text field, where the author can simply type their name. There is no
specific formatting. It is required.
-
Repeat step 4 to add each template parameter you require.
For example, to add the remaining example parameters:
<parameter name="acme.copyright" label="Copyright year" type="TEXT" regex="(19|20)\d{2}" mandatory="true"/>
This is a text field with a regular expression that checks to ensure the date begins with 19
or 20 and contains four digits. It is required.
Note: It does not have the DATE type because in this case, we do not want the
pop-up calendar. We just want to enter a four-digit year.
<parameter name="acme.productname" label="Product name" type="LIST" mandatory="true">
<value>IXIA CCMS</value>
<value>MadCap Flare</value>
<value>MadCap Central</value>
<value>Xyleme LCMS</value>
</parameter>
This is a list field which presents the user with a pick list of the items
shown. It is required.
<parameter name="acme.prodversion" label="Product version" type="TEXT" regex="\d{1,2}\.\d" mandatory="true"/>
This is a text field with a regular expression that checks to ensure the
version is entered as one or two digits followed by a period followed by one
digit. It is required.
-
Save, close, and check in the templateparameters.xml
file.
-
Inform users of the changes.
The changes are automatically applied once users close
and then reopen their IXIA CCMS Desktop. Users can also
apply the changes without restarting their CCMS Desktop by clicking .