Connect dotNet form – Completing the Service tab

Use the Service tab to identify the properties of the remote Web service being called. Complete the Service tab first.

Important: Connect dotNet rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect dotNet rules does not follow Pega development best practices. Use Connect SOAP rules instead. For more information, see About Connect SOAP rules.

Service properties

Field Description
Style and use Specify the SOAP operation style for the messages:
  • Document/ literal
  • RPC/ encoded
  • RPC/ literal
If file already exists Select to control runtime results when a file already exists:
  • Fail — To end the connector operation.
  • Append — Append output to the end of the existing file.
  • Overwrite — Replace the existing file.
Namespace URI Optional. Enter the Uniform Resource Identifier for the namespace, starting with uri: or urn:. The URI does not need to not correspond to a file at that location.
SOAPaction header Optional. Enter the value of the SOAPaction HTTP header that is sent with the request message.
Request only By default the connector operates synchronously and waits for a response.

Select this check box to specify that the connector is to send the message and end the connection without waiting for a response (operate asynchronously).

Note: If you select this option, the connector does not wait for a response even if you configure data mappings on the Response tab.
Call is read-only Used for auditing of licensing, leave cleared in most cases.

Select this check box to to indicate that each use of this service is not to count as a service invocation under the terms of your license agreement.

Authentication

Field Description
Use authentication If selected, Pega Platform includes authentication credentials in the HTTP header of the dotNet request message.

If your application requires dotNet headers that conform to a WS-Security format rather than using HTTP Basic, NTLMv1 or NTLMv2 authentication, you can configure the header directly on the Request tab.

Note: If you open a Connect dotNet rule configured in a version prior to Version 6.2, the rule form contains a Username Property and Password Property field. To update the rule to use the Authentication Profile, save the rule and refresh rule form. The Username Property and Password Property fields are replaced with the Authentication Profile field populated with a new profile.
Authentication profile Required, if Use authentication is selected. Select the Authentication profile that contains the authentication details required by the remote service.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pyAuthenticationProfile. For more information, see Using the Global Resource Settings feature.

Connection

Field Description
Service endpoint URL Enter the URL of the remote service provider to which the request message is sent.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pySOAPURL. For more information, see Using the Global Resource Settings feature.

Response timeout Optional. Enter a number of milliseconds to wait for the server response. Enter zero or leave it empty to wait indefinitely.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pySOAPTimeout. For more information, see Using the Global Resource Settings feature.

Connection ID Optional. Use this field to maintain an HTTP connection to the Web service provider after the method is called. Enter an arbitrary text value (a group key identifier) here, and also in other Connect dotNet rules that are to share a single connection (for one requestor).

This capability can improve system performance, as the HTTP connection is saved and reused. In addition, this field is required for session maintenance through token passing.

If you leave this field blank, Pega Platform creates a new HTTP connection each time this Connect dotNet rule runs, and deletes it after the first use.

Maintain session Select to use HTTP token-passing as the mechanism for maintaining a stateful session with the Web service provider. Most public services are stateless, as maintaining correct state information can be complex and expensive in terms of computational resources. If selected, enter a Connection ID value in the previous field.

Error handling

Field Description
Error handling The properties in this section hold status and exception information returned by the Connect-dotNet method. To map SOAP fault messages returned by the external Web service to the clipboard, use the Faults tab.

The system places error details on a temporary clipboard page of the Log-Connect-Error class, including the Status value property and Status message property .

Status value property Optional. Specify a Single Value Identifier property to hold the status code that the Connect-dotNet method returns. When you generate a connector rule with Connector and Metadata wizard, this field is set to the standard property @baseclass.pyStatusValue. The literal value Good identifies success.
Status message property Optional. Specify a Single Value Text property to hold the status description for the status code that the Connect-dotNet method returns. When you generate a connector rule with Connector and Metadata wizard, this field is set to the standard property @baseclass.pyStatusMessage.
Error handler flow Optional. Identify a flow rule that is to be started when this connector rule is started by a flow rule but fails. The default flow rule Work-.ConnectionProblem provides one approach for handling such problems. See Handling connector exceptions.
Invocation exception property Optional. Specify a property of mode Java Object to contain the exception object, if any are thrown during the execution of the connector.

Test connectivity

Field Description
Test connectivity After you complete and save this rule, you can test connectivity to the host of the Web service by clicking this button. This action does not call the Web service.

Simulations

Field Description
Simulations Click to create a simulator for this connect rule. See Creating Connect Simulators.

You can use Tracer to trace and analyze connector and service events.