Using the Publishing Definition Type
The Publishing definition type allows you to publish content into a Report2Web catalog, which can be used as an archive. Content published into a catalog can also follow an approval workflow, where reports can be approved or rejected.
You specify the Report2Web Catalog, the Report Name, which is the name of the report within Report2web including its path, and the Source file. Optionally, you specify if the report requires to follow an approval workflow.
Specifying Files in the Source Field
You can specify files using the following syntaxes:
<step_name>, Job <n>:<file>
- specify a chain process in a final state; the publishing job must be part of the same chain.- Example:
Step 1, Job 1:stdout.log
- Example:
Job <ID>:<file>
- specify a process or chain process and the output- Example:
Job 123:stdout.log
- Example:
parent:<file>
- specify the output file of the parent of the current process; note that the parent of a call in a chain is the step, and steps have no output.
Metadata
You specify Metadata that will be visible in Report2Web and which is used to describe and locate the document with ease.
Variables and Parameters
The following parameters are available:
Name | Description |
---|---|
Publish_Comment | approval comment |
Publish_DeleteTemporaryFile | Should the temporary file be deleted? |
Publish_Status | approval status |
You specify variables like ${<variable_name>}
and parameters like ${Publisher.parameters.<parameter_name>}
Variable Name | Data Type | Description |
---|---|---|
${description} | String | The description of this process. |
${file.index} | Number | The index of the file in the list of files. |
${file.name} | String | The name of the file. |
${finishtime} | Date | The time when this process finished. |
${jobdefinition} | String | The name of this process. |
${jobid} | Number | The ID of this process. |
${jobname} | String | The name of this process. |
${jobowner} | String | The owner of this process. |
${processserver} | String | The process server this process is running on. |
${publisher.description} | String | The description of the publisher process. |
${publisher.jobdefinition} | String | The name of the publisher process. |
${publisher.jobid} | Number | The ID of the publisher process. |
${publisher.jobname} | String | The name of the publisher process. |
${publisher.jobowner} | String | The owner of the publisher process. |
${publisher.processserver} | String | The process server the publisher process is running on. |
${publisher.queue} | String | The queue the publisher process is running on. |
${publisher.requestedstarttime} | Date | The requested start time of the publisher process. |
${publisher.starttime} | Date | The start time of the publisher process. |
${queue} | String | The queue the process is running on. |
${requestedstarttime} | Date | The requested start time of this process. |
${starttime} | Date | The start time of this process. |
Example
The following example illustrates the use of Variables and for metadata:
<reportmetadata>
<pubprofilename>${Publisher.parameters.Profile}</pubprofilename>
<docproperties>
<description>${Description}</description>
<title>${JobDefinition}</title>
<subject>${Description}</subject>
<author>${JobOwner}</author>
<date>${StartTime}</date>
<keywords />
</docproperties>
</reportmetadata>