Cancel Process JPO for an Editable Form Page

You can define a JPO to execute if the user cancels out of a form.

The cancelProcessJPO parameter specifies the name of the JPO program and method to invoke during cancel processing. This example shows how to invoke the emxForm.jsp with a cancelProcessJPO: 

${COMMON_DIR}/emxForm.jsp?mode=Edit&form=<form_name>
&cancelProcessJPO=<JPO Name>:<Method Name>

If you specify both a cancelProcessURL and cancelProcessJPO, the cancelProcessURL executes first followed by the cancelProcessJPO.

The cancel process JPO specifies the programMap as an argument for the cancel processing. The programMap contains the following HashMaps:


  • requestMap contains all the request parameters
  • paramMap contains these key parameters and expected values:
    Parameter Description

    objectId

    Object ID

    relId

    Relationship ID of the object
  • formMap contains all the field information

The above maps are packed using the packArgs method supported by JPO and passed to the cancel process JPO being invoked. The cancel process JPO can unpack this input parameter and use it for custom coding.

You can use the code sample in Pre-Process JPO for an Editable Form Page to retrieve paramater values and the field information. It includes a code sample that illustrates most of the pre/post/cancel processing features.

The cancel process JPO returns a HashMap or nothing. The HashMap contains a single key, Message, that contains either a string resource key or an original text message to display to the user.

If the cancel Process JPO does not need to communicate to the form, it can return nothing (void) or an empty HashMap. In this case, the form unloads the page after completing the cancel process.