ConfiguratorUI Actions
AnswerQuestionAction
Description – the action is used when a user answers a form property. The answer is submitted and handled by the action. The sent answer is set to the form property by the Configurator engine.
URL relative to the web application - /answer.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_questionId – the CPE corresponding to the form property
- S_questionComment – the comment of the form property
- answer[i] – answer of a form property. It is indexed by i (an integer number starting from zero) because a value selector can have multiple values sent to the server on submit. All the provided answers should be added to the request. These parameters are handled by an action form.
- qty[i] – quantity of the answer value, corresponding to index i (an integer number starting from zero)
On success the tiles marked for refresh are updated. On failure an error message is shown.
Tip: Pre-processing / Post-processing
AnswerQuestionAction processes the answer from the Form Property. You have the ability to extend this action to pre and or post process the answer handled by the action.
Once the AnswerQuestionAction extended, you can implement two methods:
preProcessAnswer: take as input the HTTP request and a wrapper containing the list of answers and quantities. You can modify the values contained in the wrapper that will then be returned to the action to perform the valuation.postProcessAnswer: take the HTTP request as input and allows additional processing after the valuation.By default, these methods are empty.
CopyAction
Description – Copy a form or a configurable product. The target is a current nested CP instance or current nested Form instance.
URL relative to the web application - /copy.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
PasteAction
Description – Complete a form or a configurable product with the values that have been previously copied on another loop. Copied and Pasted forms or CPs must be of the same model. The target is a current nested CP instance, current nested Form instance.
(The content of the current object is replaced by the pasted content)
URL relative to the web application - /paste.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
CutAction
Description – Copy a form or a configurable product and delete it. The target is a current nested CP instance or current nested Form instance.
URL relative to the web application - /cut.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
DeleteAction
Description – Delete a nested form or a nested configurable product. The target is a current nested CP instance or a current nested Form instance.
URL relative to the web application - /delete.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
NewAction
Description – Create a new loop for a nested form or a nested configurable product. The created instance is inserted after the current instance.
URL relative to the web application - /new.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
ResetAction
Description – Reset a CP, a Form or a Form Property. The target is a Root CP, a current CP, a current Form or a current Form Property.
URL relative to the web application - /reset.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
AutocompleteAction
Description – Auto answer to all the questions of a CP or a Form, or auto answer the form property. The target is a Root CP, a current CP, a current Form or a current Form Property.
URL relative to the web application - /autocomplete.do
Parameters - has to be provided for the action in order to be completed correctly.
- K_CPE_objId – request parameter holding the String representation of the CPE of the selected object
On success the tiles marked for refresh are updated. On failure an error message is shown.
NextAction
Description – Focuses on the next form property depending on the current one. The next form property is determined by the Configurator engine, using the navigation policy, configured in the ConfiguratorUI.xml. Sample:
<settings>
<nextPolicy useCurrentCPE="true" useParentCPE="true" mustExist="true"
mustBeVisible="true" mustBeUpdateable="true"
mustBeMandatory="false" mustBeWithoutFailure="true"
mustBeWithoutUnrecommended="true" mustBeUncompleted="false"
mustBeNotComputed="false"/>
…
</settings>
configuration is used when next form property is retrieved.
- useCurrentCPE – shows whether getting the next form property will take in account the current form property, or the first form property in the configuration box will be retrieved.
- useParentCPE – shows whether when retrieving the next form property only the current form will be used. If the value is “true” only the form in which the form property is found will be used for the search, otherwise next form property can be a form property in the next form box.
The other attributes represent the state of the form property that should be true to take the form property in account when searching for the next one.
**URL relative to the web application **- /next.do
Parameters - has to be provided for the action in order to be completed correctly.
- S_currentFormPropertyHtmlId – request parameter holding the HTML tile id of the current form property
On success the tiles marked for refresh are updated. On failure an error message is shown.
PreviousAction
Description – Focuses on the previous form property depending on the current one. The previous form property is determined by the Configurator engine, using the navigation policy, configured in the ConfiguratorUI.xml. Sample:
configuration is used when previous form property is retrieved.
<settings>
…
<previousPolicy useCurrentCPE="true" useParentCPE="true"
mustExist="true" mustBeVisible="true" mustBeUpdateable="true"
mustBeMandatory="true" mustBeWithoutFailure="true"
mustBeWithoutUnrecommended="true" mustBeUncompleted="true" mustBeNotComputed="true"/>
</settings>
- UseCurrentCPE – shows whether getting the previous form property will take in account the current form property, or the first form property in the configuration box will be retrieved.
- UseParentCPE – shows whether when retrieving the previous form property only the current form will be used. If the value is “true” only the form in which the form property is found will be used for the search, otherwise previous form property can be a form property in the previous form box.
The other attributes represent the state of the form property that should be true to take the form property in account when searching for the previous one.
URL relative to the web application - /previous.do
Parameters - has to be provided for the action in order to be completed correctly.
- S_currentFormPropertyHtmlId – request parameter holding the HTML tile id of the current form property on success the tiles marked for refresh are updated.
On failure, an error message is shown.
Trademarks
All other brands and their products are trademarks or registered trademarks of their respective holders and should be noted as such. This product includes software developed by the Apache Software Foundation https://www.apache.org/