NVelocity Information class
This class supports the NVelocity action to pass parameters in.
| Reference Information |
| Release Status : |
Beta |
| Alias Name : |
Entity.NVelocityInfo |
| Full Reference Name : |
Collaboris.Saf.Actions.Entities.NVelocityInfo |
| Assembly Name : |
Collaboris.Saf |
| Properties |
| Name |
Description |
Example Value |
Output |
Required |
| OutputText |
String. Contains the rendered output from the NVelocity process.
Note :
This is useful if you wish to feed the text into a subsequent action.
|
No example supplied.
|
true
|
false
|
| OutputFile |
String. The full name and path to where the outputted file will be saved.
Note :
To replace the file, set 'ReplaceOutputFile' to 'True'
|
${CurrentDirectory}\HelloWorld.vm
|
false
|
false
|
| TemplateFile |
String. The full name and path to NVelocity template file.
|
${CurrentDirectory}\NvelocityTemplate.vm
|
false
|
false
|
| Properties |
SerializableObjectDictionary`1. Specifies the key and objects to use as properties within your NVelocity templates.
Note :
Properties contained used in this dictionary can then be referred to in the NVelodity template by prefixing with a dollar e.g. '$From' notation.
|
|
false
|
true
|
| IncludeSafProperties |
Nullable`1. Defaults to 'True'. Specifies whether to include the SAF (contextual) properties passed in to the Macro by the adapter.
Note :
This is particularly useful if you wish to consume placeholder values within the NVelocity template.
|
true
|
false
|
false
|
| ReplaceOutputFile |
Nullable`1. Defaults to 'True'. Specifies whether to overwrite the outputted file that NVelocity creates.
|
true
|
false
|
false
|