Service dotNet form
Completing the Response tab
  1. About 
  2. New 
  3. Service 
  4. Request 
  5. Response 
  6. Faults 
  7. XML Page 
  1. History 
  2. More... 

Use the Response tab to specify the data sent as part of the outgoing response message. Data is mapped from the clipboard to fields of the message header or data values in the message buffer.

C-2165By default, the response message uses UTF-8 character set encoding. However, if the request message HTTP header contains a Content-Type value, the response message uses the same encoding as the request message. Alternatively, you can override this behavior and establish a single character encoding (for all SOAP responses from the system) by defining a servlet initialization parameter named CharacterEncoding for the PRSOAPServlet servlet. The system uses the value of that parameter in the Content-Type of every Service dotNet and Service SOAP response message.

Response Headers

Field

Description
Name

Enter the external name of the response header.
Description

Enter a text description.
Map From

Select how the system maps the output data from the clipboard data:

  • Clipboard — The system maps the data value from the scalar property specified by the Map From Key field.
  • Constant — The system returns a fixed value.
Map From Key

If the Map From value is Clipboard, enter the property name from which the data is to be mapped.

If the value is Constant, enter a literal string. To include blank spaces in your text string, surround the string with double quotes.

Response Parameters

Field

Description
Data Type

Select the external data type of the response parameter. For a complex parameter, select XML Page for a complex parameter, to cause the system to convert a clipboard page containing the elements of a portion of the XML document. (Complete the
XML Page tab in this case.)
Name

Enter the external name of the response parameter, with no spaces. B-15793
Description

Enter a text description.
Map From

Select how system maps the output data from the clipboard data. The choice you make for this field depends on what you select for Data Type:

  • Clipboard — The system maps the data value from the Single Value property specified by the Map From Key value (or Page property, for XML Page).
  • Constant — The system returns a fixed value.
  • XML Stream — The system composes a stream of XML text formatted by an XML Stream rule.
  • HTML Stream — The system composes a stream of HTML text formatted by an HTML rule.
  • HTML Frame — The system returns a stream of HTML data generated by the service activity.

If more choices appear, they each identify a custom function rule in a MapTo library. Review the function rule to determine what it does.
Map From Key

Identify a source for the Map From field:

  • If the Map From value is Clipboard, enter the Single Value or Page property name from which the data is to be mapped.
  • If the Map From value is Constant, enter a literal string. To include blank spaces in your text string, surround the string with double quotes.
  • If you selected XML Stream, enter the Stream Name key part of the XML Stream rule that is to generate the data. The system uses the Primary Page Class of the service — entered on the Service tab — as the Applies To key part, and the literal value MapFrom (with capitalization as shown) as the final key part. LACOD 1/8/03 Alternatively, enter a page name followed by a period and the Stream Name key part. When this form is used, the system uses the class of that page as the Applies To key part.
  • For HTML Stream, enter the Stream Name key part of the HTML rule that is to generate the data stream. The system uses the Primary Page Class of the service as the Applies To key part.
  • If the Map From value is HTML Frame, enter the name of the Frame specified in the Show-HTML step of the service activity. Use this to return data from activities that were originally written for interactive browser clients and use the Show-HTML method.
  • If the Map From value is a Rule-Utility-Function from a MapFrom library, either select the property that holds the value to be processed by the function or leave this field blank, as appropriate for the function.

Up About Service dotNet rules

Open topic with navigation