Service Wizard: Configure Data Records
Complete each field on this form, then click Next.
New Service Package
This section displays if you selected Configure a new service package or
Copy an existing service package on the Select Service Resources form.
| Field | Description |
|---|---|
| Service Package Name | Enter a unique name for the new service package. This name acts as the key for the service package record. The wizard suggests a name that you can modify. Validation prevents selecting a name that matches the name of an existing service package. |
| Processing mode | Select a processing mode for the package:
The effect that these processing modes have differs depending upon the type of service that you are creating. For complete information about processing modes, see the documentation for your service type, located in the Integration section of Pega Community. |
| Service access group | Select an access group to use for looking up service rules at runtime. |
| Requires authentication | Select this check box if the service needs to authenticate the service client at runtime. |
| Authentication type | This field only displays when Requires Authentication is selected. Select an authentication type:
|
| Use TLS/SSL (REST only) | This field only displays when Requires Authentication is selected and you are
using Basic authentication. Select the check box to use TLS/SSL authentication. |
| Authentication service | This field only displays when Requires Authentication is selected and you are
using Custom authentication. This field is only required for LDAP authentication.
Select an authentication service (a Data-Admin-AuthService instance) when the service type is SOAP ( Rule-Service-SOAP ) or HTTP ( Rule-Service-HTTP ). |
| Suppress Show-HTML | Select the check box to suppress Show-HTML. |
Requestor Pooling
| Field | Description |
|---|---|
| Maximum idle requestors | Enter the maximum number of idle requestors allowed. |
| Maximum active requestors | Enter the maximum number of active requestors allowed. |
| Maximum wait (in seconds) | Enter the maximum wait time for requestors in seconds. |
New Service Listener
This section displays if your service type requires a listener and you also selected
Configure a new service listener on the Select Service Resources form. It
contains the required fields for the service to be valid.
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Listener Type | Read-only. Displays the listener type. | ||||||||
| Listener Name | This form displays for services of the type File,
JMS, and MQ. Enter a unique name for the service listener. This name acts as the key for the service listener data instance. The wizard suggests a name that you can modify. Validation prevents selecting a name that matches the name of an existing service listener. |
||||||||
| Source Location (File only) | Enter the source location for your file listener. The Pega Platform node running this listener requires read and write access to the directory. | ||||||||
| Source Name Mask (File only) | Enter a string to use as the filter that identifies the files to be processed. For example, if you enter*.txt, the file listener processes all files with a .txt extension. If you enter*.*, the file listener processes all files in the source directory. | ||||||||
| Container-managed transaction (JMS only) | If this is an MDB listener, select this check box if you want the transaction
to be container managed. If this is not an MDB listener, select this check box only for the condition described in the Pega Community article Using MQ and JMS services with Enterprise Application deployment. |
||||||||
| Messaging Model (JMS only) | Select the messaging model that the listener uses:
|
||||||||
| Resource Name Resolution (JMS only) | Read-only. Indicates whether you are using a JNDI server data object (direct JNDI lookup) or resource references to locate the JMS resources (connection factory and destination). | ||||||||
| Connection Factory (JMS, listener not MDB) | Enter the name of the JMS connection factory to use to connect to the JMS provider. | ||||||||
| Request Destination (JMS, listener not MDB) | If you selected Point to Point as the messaging model, enter
the name of the JMS queue that the listener will listen for. If you selected
Publish and Subscribe as the messaging model, enter the name of
the JMS topic that the listener will listen for. |
||||||||
| Response Destination (JMS, listener not MDB) | If you selected Point to Point as the messaging model and the
listener will send responses, enter the name of the JMS queue that the listener will
respond to. If you selected Publish and Subscribe, enter the name
of the JMS topic that the listener will respond to. |
||||||||
| Destination Name (JMS, with MDB listener) | If you selected Point to Point as the messaging model, enter
the name of the JMS queue that the listener will listen for. If you selected
Publish and Subscribe as the messaging model, enter the name of
the JMS topic that the listener will listen for. |
||||||||
| Response Connection Factory (JMS, with MDB listener) | If the listener sends responses, enter the name of the JMS connection factory to use for the reply connection. | ||||||||
| Response Destination Name (JMS, with MDB listener) | If you selected Point to Point as the messaging model and the
listener will send responses, enter the name of the JMS queue that the listener will
respond to. If you selected Publish and Subscribe, enter the name
of the JMS topic that the listener will respond to. |
||||||||
| Queue Name (MQ only) | Specify the name of the WebSphere MQ queue that the listener listens to. | ||||||||
| Queue Manager (MQ only) | Specify the name of the WebSphere MQ manager that maintains the queue. By leaving this field blank, you indicate that the default queue manager maintains the queue. | ||||||||
| New Data Source | This section displays if your service type is MQ and you
selected Configure a new service listener on the Select Service
Resources form, or, if your service type is JMS, you selected Configure a
new service listener and you selected Direct JNDI Lookup
in the Resource Name Resolution field on the Select Service Purpose form. |
||||||||
| Field | Description | ||||||||
| Server Name | Enter the name of the server. | ||||||||
| Initial Context Factory (JMS only) | Enter the fully qualified Java class name of the factory class that creates an
initial context. Choose a class that is present in the Pega Platform system's CLASSPATH Environment variable.
|
||||||||
| Provider URL (JMS only) | Optional. Enter the URL for the JNDI service provide. For example:
The format for this value depends on the application server supporting the
service:
|
||||||||
|
Security Principal (JMS only) |
Optional. Identify the principal for authenticating the caller to the service. The format of the principal depends on the authentication scheme. If you leave this field blank, the service provider determines the behavior. | ||||||||
|
Security Credentials
(JMS only) |
Optional. Specify the credentials of the principal for authenticating the caller to the service. The value you enter depends on the authentication scheme. It can be a hashed password, clear-text password, key, certificate, and so on. If you leave this field blank, the service provider determines the behavior. | ||||||||
| Host Name (MQ only) | Enter the host name of your MQ server. | ||||||||
| Port Number (MQ only) | Enter the port number of your MQ server. | ||||||||
| Channel (MQ only) | If you want to connect to the MQ server through an MQ channel, enter the
channel name. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| Username (MQ only) | Enter the username of a valid user on the MQ server. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| Password (MQ only) | Enter the password for the username you entered in the Username field. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| MQ bindings transport (MQ Only) | Select if your MQ server is on the same system that hosts the Pega Platform, and you want to use bindings transport to connect with
the MQ server. Do not select this option if you plan to connect using an MQ channel. |
New Data Source
This section displays if your service type is MQ and you selected
Configure a new service listener on the Select Service Resources form,
or, if your service type is JMS, you selected Configure a new service
listener and you selected Direct JNDI Lookup in the Resource
Name Resolution field on the Select Service Purpose form.
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Server Name | Enter the name of the server. | ||||||||
| Initial Context Factory (JMS only) | Enter the fully qualified Java class name of the factory class that creates an
initial context. Choose a class that is present in the Pega Platform system's CLASSPATH Environment variable.
|
||||||||
| Provider URL (JMS only) | Optional. Enter the URL for the JNDI service provide. For example:
The format for this value depends on the application server supporting the
service:
|
||||||||
|
Security Principal (JMS only) |
Optional. Identify the principal for authenticating the caller to the service. The format of the principal depends on the authentication scheme. If you leave this field blank, the service provider determines the behavior. | ||||||||
|
Security Credentials
(JMS only) |
Optional. Specify the credentials of the principal for authenticating the caller to the service. The value you enter depends on the authentication scheme. It can be a hashed password, clear-text password, key, certificate, and so on. If you leave this field blank, the service provider determines the behavior. | ||||||||
| Host Name (MQ only) | Enter the host name of your MQ server. | ||||||||
| Port Number (MQ only) | Enter the port number of your MQ server. | ||||||||
| Channel (MQ only) | If you want to connect to the MQ server through an MQ channel, enter the
channel name. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| Username (MQ only) | Enter the username of a valid user on the MQ server. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| Password (MQ only) | Enter the password for the username you entered in the Username field. Do not enter a value for this field if you selected the MQ bindings transport check box. |
||||||||
| MQ bindings transport (MQ Only) | Select if your MQ server is on the same system that hosts the Pega Platform, and you want to use bindings transport to connect with
the MQ server. Do not select this option if you plan to connect using an MQ channel. |