Systemwalker Software Configuration Manager Reference Guide

2.2.8 Configuration Modification Template Definition Files

File name

Any name

Description

The XML file that contains the definition of a configuration modification template.

Use this file to create, update, and display the definitions of configuration modification templates. When creating or updating a configuration modification template using this XML file, refer to "Creating a Configuration Modification Template" in the Operator's Guide to create the XML file.

File format

<?xml version="1.0" encoding="UTF-8"?>
<template>
  <parameters>
    <parameter>
      <parameterName>Parameter name</parameterName>
      <parameterType>Parameter type</parameterType>
      <parameterDescription>Parameter description</parameterDescription>
    </parameter>
    ...
  </parameters>
  <processes>
    <process>
      <processName>Process name</processName>
      <processType>[Process type]</processType>
      <processParameters>
      - Server operation check:
      <target>Target</target>
      <monitorTime>Monitoring time</monitorTime>
      - Script execution:
      <target>Target</target>
      <script>Script</script>
      <argument>Argument</argument>
      <successValues>Normal return value</successValues>
     <singleUserMode>Single user mode</singleUserMode>
      - OS restart:
      <target>Target</target>
      - Command execution:
      <target>Target</target>
      <command>Command</command>
      <argument>Argument</argument>
      <successValues>Normal return value</successValues>
      <singleUserMode>Single user mode</singleUserMode>
      -File Distribution:
      <target>Target</target>
      <distributionFile>File to be distributed</distributionFile>
      <destinationDirectory>Distribution destination</destinationDirectory>
      - File Collection:
      <target>Target</target>
      <collectionFile>File to be collected</collectionFile>
      <storageDirectory>Storage location</storageDirectory>
      </processParameters>
    </process>
    ...
  </processes>
</template>

A description and the setting contents for each item (element) are shown below.

Modify the configuration modification template if necessary, referring to this information.

Element names that are enclosed in square brackets, "[ ]", can be omitted.

Element	Type	Setting Range	Description	Required	Setting Content
parameters	-	-	Specify multiple parameters of the template.	No
[parameter]	-	Zero or more	Specify a parameter of the template.	No	When defining multiple parameters, use multiple entries of the relevant element.
processes	-	-	Specify multiple processes of the template.	No
process	-	One or more	Specify a process of the template.	No	When executing multiple processes, specify the elements for each process in the order that they are to be executed.

The contents to specify for the "parameter" element are shown below. Element names that are enclosed in square brackets, "[ ]", can be omitted from each "parameter" element.

Element	Type	Setting Range	Description	Required	Setting Content
parameterName	ASCII string	Up to 256 characters	Parameter name.	Yes	Alphanumeric characters, ".", "_", and "-" can be used. Specify an alphabetical character for the beginning of the parameter name.
[parameterDescription]	UTF-8 string	Up to 256 characters	The description of the parameter.	Yes (*)
parameterType	ASCII string	Selection	An option of the parameter.	Yes	Specify one of the following: server: Server file: File string: Character string number: Number boolean: Boolean value password: Password

The contents to specify for the "process" element are shown below.

Element	Type	Setting Range	Description	Required	Setting Content
processName	UTF-8 string	Up to 85 characters	The name of the process.	Yes	< > & " ' | , cannot be specified.
processType	ASCII string	Selection	The type of the process.	Yes	Specify one of the following: checkServer: Server operation check scriptExecution: Script execution reboot: OS restart commandExecution: Command execution fileDistribution: File distribution fileCollection: File collection
processParameters	-	-	Setting information of the process.	No

The contents to specify for the "processParameters" element are shown below. The contents to specify for the "processParameters" element differ depending on the process type. Element names that are enclosed in square brackets, "[ ]", can be omitted from each process. For details on how to specify a value for setting information, refer to "Definition of Setting Information" in the Operator's Guide for details).

Process Type	Element	Setting Information	Required	Setting Content
Server operation check	target	Target	Yes
	[monitorTime]	Monitoring time	Yes	When the element is omitted, "0" is set.
Script execution	target	Target	Yes
	script	Script	Yes	When specifying an asset, specify it in the following format: Asset version can be omitted. When omitted, the latest version is specified when the configuration modification job is executed. media://[Asset ID]/[Asset version]
	[argument]	Argument	Yes (*)	When the element or the value is omitted, an empty string is set and the script is executed without arguments.
	[successValues]	Normal return value	Yes	When the element is omitted, "0" is set.
	[singleUserMode]	Single-user mode	Yes	When the element is omitted, "false" is set.
OS restart	target	Target	Yes
Command execution	target	Target	Yes
	command	Command	Yes
	[argument]	Argument	Yes (*)	When the element or the value is omitted, an empty string is set and the script is executed without arguments.
	[successValues]	Normal return value	Yes	When the element is omitted, "0" is set.
	[singleUserMode]	Single-user mode	Yes	When the element is omitted, "false" is set.
File distribution	target	Target	Yes
	distributionFile	File to be distributed	Yes	When specifying an asset, specify it in the following format: Asset version can be omitted. When omitted, the latest version is specified when the configuration modification job is executed. media://[Asset ID]/[Asset version]
	[destinationDirectory]	Distribution destination	Yes	When the element is omitted, "#{work.directory}" is set and distributed to the work directory.
File collection	target	Target	Yes
	collectionFile	File to be collected	Yes
	storageDirectory	Storage location	Yes

The symbols in the Required column indicate the following:

Y: When specifying the element, ensure a value is specified.

Yes (*): The value can be omitted.

No: Setting of the value is not necessary. Specify the element only.

Examples

<?xml version="1.0" encoding="UTF-8"?>
<template>
  <parameters>
    <parameter>
      <parameterName>target.server</parameterName>
      <parameterType>server</parameterType>
      <parameterDescription>Installation target server. </parameterDescription>
    </parameter>
    <parameter>
      <parameterName>msi.file</parameterName>
      <parameterType>file</parameterType>
      <parameterDescription>MSI file. </parameterDescription>
    </parameter>
  </parameters>
  <processes>
    <process>
      <processName>Server operation check</processName>
      <processType>checkServer</processType>
      <processParameters>
        <target>{{target.server}}</target>
        <monitorTime>0</monitorTime>
      </processParameters>
    </process>
    <process>
      <processName>MSI file distribution</processName>
      <processType>fileDistribution</processType>
      <processParameters>
        <target>{{target.server}}</target>
        <distributionFile>{{msi.file}}</distributionFile>
        <destinationDirectory>#{work.directory}</destinationDirectory>
      </processParameters>
    </process>
    <process>
      <processName>Installation execution</processName>
      <processType>commandExecution</processType>
      <processParameters>
        <target>{{target.server}}</target>
        <command>msiexec</command>
        <argument>/I "#{work.directory}\{{msi.file}}" /qn ALLUSERS=1 REBOOT=ReallySuppress</argument>
        <successValues>0,1641,3010</successValues>
        <singleUserMode>false</singleUserMode>
      </processParameters>
    </process>
  </processes>
</template>