Use the Action Processor editor to define an action processor entity. In the Studio Projects view, double-click an action processor entity to open the Action Processor editor. You can create the editor using the Action Processor Wizard.
When working with the Action Processor editor, see the following topics:
Use the Editor tab to define the properties and generate the code for an action processor.
| Field | Use |
|---|---|
| Description | Specify a description for the Action Processor editor. |
| Vendor, Technology, and Software Load | Displays the vendor, technology, and software version for the action processor entity in the cartridge project. |
| Action | Select an action from the list of actions or enter an action not in the list. |
| Type | Select the type of action processor:
|
| Class and Method | The Java Action Processor (with Code Generation) and the CLI Code Generation options display the class and method names mapped to the action processor after the code is generated by clicking the New button.
Java Action Processor displays the default values of myProcessor and execute respectively. The code for the default values does not exist. You must change these values to existing class and method names and map them using Select. |
| State Table and Program | Displays the default values of S_MY_STATE_TABLE and doAction respectively.
Note: The code for the default values does not exist. You must change values to existing state table and program names and map them using Select. |
| Open | Click to see the code. This button is enabled only when the code is available. |
| New | Click to create the action processor implementation.
Note: Enabled only for Java Action Processor (with Code Generation) and CLI Code Generation action processors. |
| Select | Select Java implementation or state table implementation. Use this button to map the class and method to the Java Action Processor or to map the state table and program to the State Table action processor.
Note: Enabled only for Java Action Processor and State Table action processors. |
| Command Overview | Enter documentation in the Command Overview area for the MML commands. |
| Output | Enter comments in the output area from the action processor (for example, return the following parameters as INFO or CSDL) in the Output area. |
| Development Notes | Enter comments provided by the cartridge developer in the Development Notes area. |
Use the Request tab in the Action Processor editor to define the parameters for a CLI command request messages. In the Command Definition Area area, you can define:
Separators: In this area, you can specify command parameter separators that override the CLI command structure you defined in the Action Project editor Command Structure tab.
Command: In this area, you can parse sample CLI commands and generate CLI code for the action processor.
Parameters: In this area, the elements are either automatically generated from the sample CLI command you parsed in the Commands area or you can manually add elements.
| Field | Use |
|---|---|
| Overwrite | Select to override the default command structure defined in the Activation Project editor Command Structure tab. You must select this check box to make the separator fields editable.
For more information about the fields in the Separators area, see the field definitions in "Activation Project Editor Command Structure Tab". |
| Command Auto-Parse Override | Select if you want to automatically parse sample CLI input commands. This enables the Parse Input Command button. |
| Input Command | Enter a sample CLI command that represents the CLI command elements you want to use in the action processor. |
| Command Parameter | Click to designate the CLI parameter you entered in Input Command as a command parameter. If you designate a parameter as a Command Parameter, then you must choose the following:
After you make your selection, the highlighted parameter appears in the Element Name list. When you select one of the auto-generated parameters from the Element Name list, the associated atomic action parameters appear in the Maps To field (except for StaticString parameters). |
| Command Header | Specifies the command header. You can:
|
| Parse Input Command | Click to automatically Parse Input Command button after you have entered a sample CLI command that you want to tokenize. |
| Element Name | Lists the parameters that you want to use in the action processor. You can automatically generate these parameters by parsing a sample command or manually add them. |
| Type | When you select an parameter from the Element Name list, you can apply one of the following parameter types from the Type list.
|
| Maps To | When you designate a parameters from the Element Name list as Name Value Pairs or ValueOnly, you must map the parameter to an atomic action parameter in the Maps To field. The action processor includes the value of the atomic action parameter in the request message. |
| Parameter Logic | In the Parameter Logic field, you can add one line logic for Name Value Pairs and ValueOnly parameters that further specifies how a atomic action parameter maps to a parameter in the Element Name list.
This field calls the methods defined in the Utils.java file that Design Studio generates when you add a sample command to the Input Command field. All methods defined in Utils.java throw exceptions defined in the ProvCartridgeException.java file, which is auto-generated when you add a sample command. For more information about the methods contained in the Utils.java file, see ASAP Cartridge Development Guide. You can also nest two or more command together in the Parameter Logic field. For example the following uses the encloseWith method within the concat method:
concat("*",encloseWith(MCLI,"#","#"),MY_TEST)
Design Studio also generates the ReusableMethods.java file where you can define your own one line utility methods that you can use in the Parameter Logic field. The methods you define in this Java file should throw exceptions defined in the ProvCartridgeException.java file. |
| Edit Parameter Logic | Click to modify or add logic for a particular parameter. For example, if you have a parameter that maps to more one compound parameter, you must enter additional logic. Clicking this button generates additional Java files where you can make these modifications. For more information about the files generated when you click the Edit Parameter Logic button, see ASAP Cartridge Development Guide. |
| Preview | Displays a preview of the structure of the CLI command as you map CLI command elements to atomic action parameters.
For example, the following command shows a header named HSDPA, a value-only parameter, two value-pair parameters, two static parameters, and ends with the COMMIT control character: HSDPA:<mcliVal>,LCC_CODE=<user_routingVal>,LINE=<lineVal>,static, program,;COMMIT |
Use the Response tab to defining the parameters for a CLI-based action processor CLI command response message.
| Field | Use |
|---|---|
| Response | You can enter a description of the response message. |
| Response Header | You can enter a response header. |
| Exit Type Pattern | Specify a response snippet that the code searches for in response messages. You use the Mark Positions button to specify what part of the response snippet to verify before sending the response to the user defined exit type code you have written. For more information about exit types, see ASAP Cartridge Development Guide. |
| Edit Response Logic | Click to open the auto-generated ResponseHandlerImplementation.java file in which you must enter response handling logic. For more information, see ASAP Cartridge Development Guide. |
Use the Blueprint tab to view the generated documentation for the action processor entity. This tab is read only.