InstallProperties
Description
The InstallProperties action instructs the HandlerController to ensure the specified entity.properties file is installed.
Parameters
| Attribute | Description | Required |
|---|---|---|
| if | Takes a property name and if it is set true, will update the entity.properties file. If the entity.properties does not exist, they will be installed in any case. | No. |
| basedir | Specifies the directory where the updated entity properties will be stored. If basedir directory does not exist the action will fail. | Yes. |
Parameters specified as nested elements
Context
A context element specifies which object to get the entity.properties for. If the object does not exist in workbench, the request will fail.
Examples
The example below shows a typical use of the installProperties action for a command handler. It specifies to install an updated entity.properties file, if the property framework.metadata.autoupdate property is set true and to install the updated properties in the object's own directory, ${entity.instance.dir}/var. It uses the information in the current context (e.g., context.depot, context.type, context.name) to specify the object.
<installProperties
if="framework.metadata.autoupdate"
basedir="${entity.instance.dir}/var">
<context
depot="${context.depot}"
entityClass="${context.type}"
entityName="${context.name}"
proximity="1"
direction="internal"/>
</installProperties>