Adding a Custom Action
Solution Elements
|
Element
|
Type
|
Description
|
|---|---|---|
|
Custom action definition file
|
XML
|
XML file for holding the definition of the custom action.
Location in the module: <customizationRootDirectory>/<module>/main/resources
|
|
Custom action model definition file
|
XML
|
XML file for holding the definition of the custom action model
Location in the module:<customizationRootDirectory>/<module>/main/resources
|
|
com.ptc.netmarkets.util.misc.customActions, com.ptc.netmarkets.util.misc.customActionModels properties
|
XCONF
|
Property that contains a list of action and action models customization XML files relative to <customizationRootDirectory>/<module>/main/resources folder respectively
|
|
Form Processor class
|
Java
|
Java class that defines the form processor
|
|
Resource bundle class
|
Java
|
Java class that defines the custom labels for the custom action
|
|
Your action filter class
|
Java
|
Java class that defines your filter
|
|
*service.properties.xconf
|
XCONF
|
Registry for the action filter or action validator
Location in the module: <customizationRootDirectory>/<module>/main/xconf
|
Modular Structure for Customization
<customizationRootDirectory>
├── configurations
│ └── xconf
│ └── custom.site.xconf
└── module1
├── descriptor.xml
├── main
├── xconf
| └── acme.service.properties.xconf (Optional)
├── src
│ └── com
│ └── acme
│ ├── forms
│ │ └── YourFormProcessor.java(Optional)
│ ├── resource
│ | └── YourResource.java(Optional)
│ └── filter
│ └── YourActionFilter.java (Optional)
└── resources
└── acme
└── module1
├── module1-actionModels.xml
└── module1-actions.xml
├── configurations
│ └── xconf
│ └── custom.site.xconf
└── module1
├── descriptor.xml
├── main
├── xconf
| └── acme.service.properties.xconf (Optional)
├── src
│ └── com
│ └── acme
│ ├── forms
│ │ └── YourFormProcessor.java(Optional)
│ ├── resource
│ | └── YourResource.java(Optional)
│ └── filter
│ └── YourActionFilter.java (Optional)
└── resources
└── acme
└── module1
├── module1-actionModels.xml
└── module1-actions.xml
Procedure
1. Create the action customization XML file if it is not already created.
 |
You can define customizations for multiple OOTB actions in the same file.
|
2. Define your action in this XML file. For more information, see Defining a New Custom Action, Customizing OOTB Action.
3. If you created other artifacts, like Java files for this custom action, organize the artifacts in the main/src directory within the module. For more information, see Package Structure.
4. Add the action to an action model.
◦ To add the action to a new custom action model, create a new action model and add the action. For more information, see Defining a New Custom Action Model.
◦ To add the action to an OOTB action model, see Customizing OOTB Action Model.
5. Deploy your action. For more information, see Deploying Action and Action Model Customizations.