FCS with Custom JSPs

Using FCS with custom JSP pages requires specific steps to enable the flow of checkin/checkout operations.

Custom JSP pages must include several HTTP parameters in order to be FCS enabled. All HTTP parameters must be wrapped in a special function prior to being set. In addition, the checkin form allows page designers to specify any other additional parameters, which should not be wrapped in the special function.

For example, the page sent to the FCS would have these sections:

<form name...>
<!-FCS aware parameters->
<input name="<%=McsBase.resolveFcsParam("failurePage")%>" 
value="<%=errorPage%>" size="90"><br>
<input name="<%=McsBase.resolveFcsParam("jobTicket")%>" 
value="" size="90"><br>
<!-user parameters that are optional ->
<input name="param_1">
<select name="select_1">
<option value="a">
</select>
</form>

The section commented as "FCS aware parameters" contains the special function that is required for all custom JSPs to be FCS enabled. The section commented as "User parameters" contains optional parameters outside of the special function.

Following are additional considerations for making JSP pages FCS enabled:

  • All JSP pages must have a jobTicket parameter, which must proceed any "input type file" fields in the checkin pages.
  • All JSP pages must have a failurePage parameter, which allows specification of the error page. The Job ticket typically contains the same error page; however, if FCS cannot read the job ticket, the failurePage parameter is used.
  • For checkin pages, since tickets can be processed only once, create your applications to use single-click checkin. Double-click checkin will cause an exception.
  • For checkout operations only, in addition to the above parameters, the attachment parameter is examined during checkout. If attachment is set to "true", the file contents are sent as an attachment, and the browser displays the "Save As" dialog box.