Back Forward Connect Java form
Completing the Method tab

About Connect Java rules

Identify the parameters and return value of the method to be called. Use a Map From mapping for the parameters and a Map To mapping for the return value.

Field

Description

Parameters

zzzOrder the entries in this array to match the method signature — the types and order of method parameters.

Data Type

Enter a Java data type for each parameter.

Map From

SmartPromptSelect how the system creates the request parameter values. The choice you make for this field depends on the Data Type:

  • Clipboard — The system maps the data value to the scalar property specified in the Map From Key field.
  • Constant — The system sends a fixed value.
  • HTML Stream — The system composes a stream of HTML text formatted according to an HTML rule.
  • XML Stream — The system composes a stream of HTML text formatted according to an HTML rule.

If more choices appear, they identify a custom function rule in a MapFrom library. Review the function rule to determine what it does.

Map From Key

SmartPromptEnter a source for the Map From value:

Clipboard Enter the property name from which the data is to be mapped. This data is passed by value; the external Java code may change the value of a property passed as input, but the updated value is not automatically or visible. Only properties listed in the Return Value array contain results.
Constant Enter a literal text string. To include blank spaces in your text string, surround the string with double quotes.
HTML Stream Enter the Stream Name key part of HTML rule that is to generate the data. The system uses the Applies To class of this Connect Java rule as the Applies To class of the HTML rule.
XML Stream Enter the Stream Name key part of XML rule that is to generate the data. The system uses the Applies To class of this Connect Java rule as the Applies To class of the XML Stream rule.
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.
Return Value  
Data Type

SmartPromptEnter the external Java data type of the return value, or void. Both primitive Java types (int, boolean, char, String, and so on) and arrays of primitive types are supported.

You can map complex return values. For example, the return value may have data type:

com.sun.j2ee.blueprints.shoppingcart.cart.model.ShoppingCartModel

Map To

SmartPromptSelect how the system creates the response parameter values. The choice you make for this field depends on the Data Type.

  • Clipboard — Maps the data value from the scalar property specified by the Map To key.
  • XML ParseRule — Indicates that the incoming data value is a stream of XML, to be parsed using the data mappings specified in a rule of the Rule-Parse-XML rule type.
  • Delimited ParseRule — Indicates that the incoming data value is a text value to be parsed with a Parse Delimited rule.
  • Structured ParseRule — Indicates that the incoming data value is a text value to be parsed with a Parse Structured rule.

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

Map To Key

SmartPromptIdentify a destination for the Map To value:

  • If the Map To value is Clipboard, enter a destination property reference.
  • If the Map To value is XML Parse Rule, enter the Namespace name (second key part) and the Element Name name — third key part — of the appropriate XML parse rule. Separate the Namespace from the Element Name with a space. That is, use the syntax "NamespaceName ElementName" and not "NamespaceName.ElementName." The system uses the Applies To class of this connector rule as the first key part of the parse rule.

    OldTo maintain backward compatibility for connector rules created in releases before V5.2, you can specify a data mapping with only a Namespace value. In that case, the system at runtime determines the Element Name key from the root element of the incoming XML document. However, this mapping works only if the Parser Type of the XML parse rule is set to DOM and validation is not enabled. As a best practice, specify both the Namespace Name and the Element Name of the rule.

  • For Delimited ParseRule, enter the Namespace key part, a period, and the Record Type key part of the Parse Delimited rule that the system is to use to parse the data in the Map To Key field. The system uses the Applies To class of this Connect Java rule as the Applies To class of the parse rule.
  • For Structured ParseRule, enter the Record Type key part of the Parse Structured rule that the system is to use to parse the data in the Map To Key field. The system uses the Applies To class of this Connect Java rule as the Applies To class of the parse rule.
  • If the Map To value is a Rule-Utility-Function function from a MapTo library, either select a property to hold the results of the function or leave this field blank, as appropriate for the function.

zzz About Connect Java rules