Return of entire temp folder with output

CCMS Output Generator includes the include.temp parameter to allow inclusion of the entire temp folder when generating an output, typically for troubleshooting purposes.

Normally, when you generate an output, IXIA CCMS Output Generator includes only the output itself and the build logs in the zip file that the user receives or downloads from IXIA CCMS Web.

You can include the entire temp folder by choosing from one of two methods:

  1. Add the parameter to an output target: Add it directly to an output target with a hard-coded value that applies to all cases with that output type selection
  2. Add the parameter to a preprocessor: Add a user parameter to a preprocessor so that users can request inclusion of the entire temp folder on an output-by-output basis

Add the parameter to an output target

Possible property values for outgen.job.userparam.include.temp are:

  • true returns the temp folder to the user
  • false returns only the output and logs to the user

In the target that is called by the appropriate output type, you could add the highlighted line:

<target name="client.pdfwrapper" depends="default_dependencies, flatten, resolve_container_keyref, extract_HiRes_images">
	<echostart>client.pdfwrapper</echostart>

	<property name="outgen.job.userparam.include.temp" value="true"/>

	...
	
</target>

You do not need to restart CCMS Output Generator.

Add the parameter to a preprocessor

In the preprocessor that is called by the appropriate output type, add the highlighted lines:

<preprocessor name="pdfwrapper" class="com.ixiasoft.outputgenerator.preprocessor.AntProcessor" >
	<parameters>
		<system>
			<parameter name="buildfile" value="/conductor-client.xml"/>
			<parameter name="target" value="client.pdfwrapper"/>
			<parameter name="clean" value="job_postprocess"/>
			<parameter name="keep.log.files" value="true"/>
		</system>
		<user>
			<parameter label="Return temp folder?" name="include.temp" mandatory="false" type="choice">
				<value name="false" _default="true">No</value>
				<value name="true">Yes</value>
			</parameter> 
		</user>
	</parameters>
</preprocessor>
Note: (If the <user> section is already present, you must add the parameter to it. Do not add a second <user> section.)

When the parameter is specified in the preprocessor, the conductor file does not need to be modified.

You do not need to restart CCMS Output Generator.