Endpoints

An endpoint is the entry point to a service, a process, or a queue or topic destination in service-oriented architecture. In PortX, an endpoint defines the protocol, address, and other details specific to an exchange of messages between partners.

  1. Start PortX. The Transaction Monitoring Page appears.

  2. In the left-hand navigation pane, in the CONFIGURATION section, click Partners and Applications. The Partners and Applications Page appears.

img-partners-and-applications
Figure 1. Partners and Applications Page

  1. In the CONFIGURATION section of the left-hand navigation pane on the Company Information Page, click Endpoints.

    The Endpoints Page appears.

    img-endpoints
    Figure 2. Endpoints Page

  2. From this page, you can:

Edit an Existing Endpoint

  1. On the Endpoints Page, in the Name column, click the endpoint you want to edit.

    The Endpoint Page appears. The settings that appear depend on the values for Protocol and Type.

    img-endpoint-settings
    Figure 3. Endpoint Page

  2. To edit the Endpoint Name, Protocol, or Type, go to Choose Endpoint Name, Protocol, and Type.

    To edit settings specific to the existing Name, Protocol, and Type, go to the appropriate Protocol-Type combination in Protocol/Type-Specific Endpoint Settings.

Add a New Endpoint

  1. On the Endpoints Page, click New.

    The Add New Endpoint Page appears.

img-endpoint-add
Figure 4. Add New Endpoint Page

  1. Go to Choose Endpoint Name, Protocol, and Type.

    If you are working with other partners, you can change an existing endpoint, but you cannot add a new endpoint.

Choose Endpoint Name, Protocol and Type

  1. On the Add New Endpoint Page, enter the appropriate settings.

    When you have entered settings for Name, Protocol and Type, the Add New Endpoint Page becomes the Endpoint Page.

    For information about Protocol- and Type-specific settings, go to the corresponding section in To Enter Protocol/Type-Specific Endpoint Settings.

    Setting Description

    Name

    Name for this endpoint

    Required

    Yes

    Default

    Auto-populates based on the following values:

    If you choose to change the default, then subsequently want to revert to it, click Auto Fill.

    Protocol

    Protocol for this endpoint

    Required?

    No

    Valid values

    • 'AS2'

    • 'FTP'

    • 'FTPS'

    • 'SFTP'

    • 'HTTP'

    • 'JMS'

    • 'SMTP'

    • 'POP3'

    • 'IMAP'

    • 'RNIF'

    Default

    None

    Type

    Type of endpoint

    Required?

    No

    Valid values

    • 'SEND'

    • 'RECEIVE'

    Default

    None

    Default for partner checkbox

    Select this box if you want the choices you make for this endpoint to apply to all endpoints for this partner.

    When you have entered settings for Name, Protocol and Type, additional settings specific to the protocol-type combination appear; the Add New Endpoint Page becomes the Endpoint Page. For information about the additional settings, go to the appropriate Protocol-Type combination in To Enter Protocol/Type-Specific Endpoint Settings.

    img-endpoint-settings
    Figure 5. Endpoint Page

Protocol/Type-Specific Endpoint Settings

For a given endpoint, the values you select for Protocol and Type determine which additional settings appear. These additional settings are a subset of the settings provided in the corresponding connector.

To Enter Protocol/Type-Specific Endpoint Settings

Choose the section that corresponds to the Protocol-Type of the Endpoint for which you are entering settings.

To Save Endpoint Settings

See Saving Settings.

To Add an Endpoint Property

  1. Click Add Endpoint Property.

    The Add Property box appears. Refer to the table that follows for adding property settings.

    Setting Description

    Property Type

    Dropdown listbox that includes types of properties you can track

    Required?

    Yes

    Default

    None

    Property Source Type

    Dropdown listbox that includes valid sources of trackable properties

    Required?

    Yes

    Valid values

    Inbound Properties

    Outbound Properties

    Constant

    MEL Expression

    Default

    None

    Property Source

    Identifies source for this property

    Required?

    Yes

    Valid values

    • Valid XPath expression (for XML documents)

    • Valid JSONPath expression (for JSON or EDI documents)

AS2 Send Settings

AS2 Send Settings pertain to trading partner-specific AS2 settings such as certificate and URL.

Setting Description

URL

URL to which you will send AS2 transmissions for this partner, including port

Required?

Yes, if AS2 is the transport protocol

Valid values

Alphanumeric

Default

None

Example

www.midsizesupplier.com:8080

Content Type

Content type for messages sent over AS2.

If you choose Custom, a Custom content type box appears that accepts an alphanumeric string. Be sure that the string is known to your trading partner.
Valid values

  • 'application/edi-x12'

  • 'application/edi-consent'

  • 'Custom'

Default

  • 'application/edi-x12'

Digest Algorithm

MIC algorithm for use in signing the returned receipt

Required?

No

Valid values

  • 'SHA1'

  • 'MD5'

Default

  • 'SHA1'

Fallback Digest Algorithm

Digest algorithm the receiver uses to create the MIC and signature

Required?

No

Valid values

  • 'None'

  • 'SHA1'

  • 'MD5'

Default

'None'

Subject

Subject of the message being sent

Required?

No

Valid values

Alphanumeric

Default

AS2 Message

Filename

Name of file to send

Required

No

Valid values

Alphanumeric

Default

'File name'

Encoding

Type of encoding to use when sending a message with AS2

Required

Yes

Default

Binary

Valid values

  • Binary
    A method of encoding in which a message is represented using a combination of 0s and 1s.

  • 7-bit

    Data that is all represented as relatively short lines with 998 bytes or less between CRLF line separation sequences. No bytes with decimal values greater than 127 are allowed and neither are NULLs (bytes with decimal value 0). CR (decimal value 13) and LF (decimal value 10) bytes only occur as part of CRLF line separation sequences.

  • 8-bit

    Data that is all represented as relatively short lines with 998 bytes or less between CRLF line separation sequences, but bytes with decimal values greater than 127 may be used. As with "7bit data" CR and LF bytes only occur as part of CRLF line separation sequences and no NULLs are allowed.

  • Quoted-Printable

    Intended to represent data that largely consists of bytes that correspond to printable characters in the US-ASCII character set. It encodes the data in such a way that the resulting bytes are unlikely to be modified by mail transport. If the data being encoded are mostly US-ASCII text, the encoded form of the data remains largely recognizable by humans. A body which is entirely US-ASCII may also be encoded in Quoted-Printable to ensure the integrity of the data should the message pass through a character-translating, and/or line-wrapping gateway.

Encryption Algorithm

3DES is an encryption that uses 3 different keys, or encryptions, to encrypt the messages. No other choices are available at this time.

Checkbox options:
Compress

Compresses message-size

Message Encrypted

Adds an encryption wrapper around the document, signature, and compression payloads

Message Signed

Adds a signature wrapper around the document payload

MDN Signed

Ensures trading partner validation and security

MDN Async

Allows AS2 MDNs to be returned to the AS2 message sender’s server at a later time. Typically used when large files are involved, or when a trading partner’s AS2 server has poor Internet service. If this checkbox is selected the MDN Async URL box appears.

MDN Async URL

An Async Message Disposal Notification (MDN) returns the MDN to this URL at a later time for files sent if an MDN is required. If you are using Async MDN, enter the URL and port to which it should be sent.

Required

No

Valid values

Alphanumeric

Default

None

MDN Required

An Async MDN will return the MDN to the URL at a later time for files sent if an MDN is required. If you are using Async MDN, enter the URL and port to which it should be sent.

If this checkbox is selected, the Require Receipt for Unsupported Digest Algorithm and Require Receipt for Unsupported Signature Format checkboxes appear.

AS2 Receive Settings

Setting Description

URL

URL you expose in MuleSoft to receive messages from a trading partner. Enter the URL, including the port.

Required?

Yes, if AS2 is the transport protocol.

Example

www.midsizesupplier.com:8080

MDN Subject

Subject of the MDN (Message Disposition Notification) sent

Required?

Yes

Valid values

Alphanumeric

Default

Message Disposition Notification

Preferred Digest Algorithm

MIC algorithm for use in signing the returned receipt.

Required?

Yes

Valid values

None
SHA1
MD5

Default

None

Checkbox options
Compress

Compresses message-size

Message Encrypted

Adds an encryption wrapper around the document, signature, and compression payloads

Message Signed

Adds a signature wrapper around the document payload

FTP Send Settings

Setting Description

Server Address

Address from which outbound documents are sent.

Required?

Yes

Valid values

Alphanumeric

Default

localhost

Port

Specific outbound port to be used with this trading partner. Set the host of the partner’s FTP server; this can be an IP address or a host name.

Required?

Yes

Valid values

Numeric

Default

990

User Name
Required?

Yes

Valid values

Alphanumeric

Default

None

Password
Required?

Yes

Valid values

Alphanumeric

Default

None

Transfer Mode

For ease of client use, use passive mode when possible.

Required?

Yes

Valid values

Active|Passive

Default

Passive

Path
Required?

No

Valid values

Alphanumeric

Default

/

Filename
Required?

No

Valid values

Numeric

Default

None

Upload Temporary Directory
Required?

No

Valid values

Alphanumeric

Default

None

FTPS Send Settings

Setting Description

Server Address

Address from which outbound documents are sent.

Required?

Yes

Valid values

Alphanumeric

Default

localhost

Port

Specific outbound port to be used with this trading partner. Set the host of the partner’s FTP server; this can be an IP address or a host name.

Required?

Yes

Valid values

Numeric

Default

990

User Name
Required?

Yes

Valid values

Alphanumeric

Default

None

Password
Required?

Yes

Valid values

Alphanumeric

Default

None

Transfer Mode

For ease of client use, use passive mode when possible.

Required?

Yes

Valid values

Active|Passive

Default

Passive

SSL Mode
Required?

Yes

Valid values

Explicit|Implicit

Default

Implicit

Enable Server Validation (Checkbox)

Selecting this checkbox validate the servers identity; only JKS format is supported at this time.

Default

Not selected

Path
Required?

No

Valid values

Alphanumeric

Default

/

Filename
Required?

No

Valid values

Numeric

Default

None

Upload Temporary Directory
Required?

No

Valid values

Alphanumeric

Default

None

FTPS Receive Settings

Setting Description

Server Address

Server address to which inbound B2B documents are delivered.

Required?

Yes

Valid values

Alphanumeric

Default

localhost

Port

Specific inbound port to be used with this trading partner. Set the host of your FTP server, this can be an IP address or a host name.

Required?

Yes

Valid values

Numeric

Default

990

User Name

The user name you specify for this FTPS instance.

Required?

Yes

Valid values

Alphanumeric

Default

None

Password

The password you are using with this trading partner.

Required?

Yes

Valid values

Alphanumeric

Default

None

Transfer Mode

For ease of client use, use passive mode when possible.

Required?

Yes

Valid values

  • 'Active'

  • 'Passive'

Default

Passive

SSL Mode

Method of invoking client security

Required?

Yes

Valid values
Explicit

Uses standard FTPS commands and replies.

Implicit

Requires a Transport Layer Security to be established at the beginning of the connection.

Default

Implicit

Enable Server Validation (Checkbox)

Selecting this checkbox validates the servers identity; only JKS format is supported at this time.

Default

Not selected

Path

Specific FTPS file location where inbound documents will reside.

Required?

No

Valid values

Alphanumeric

Default

/

Filename
Required?

No

Valid values

Numeric

Default

None

Move to directory

Places the files in the specified directory until they complete uploading.

Required?

No

Valid values

Alphanumeric

Default

None

Polling frequency
Required?

No

Valid values

Alphanumeric

Default

1000

Maximum Number of Download Threads

Controls the concurrency level at a given time.

Required?

No

Valid values

Numeric

Default

None

SFTP Send Settings

Server information

Name Description

Host

Enter the Fully Qualified Domain Name (FQDN) or IP address of the server on your host machine that connects to the external SFTP server.
Type: string
Required: Yes
Default: None

Port

The port that connects to the local (host) server. (Commonly 22)
Type: integer
Required: Yes
Default: None

Path

Specify a path that facilitates connection to the local server
Type: string
Required: Yes
Default: None

Username

 
Type: string
Required: Yes
Default: None

Password

 
Type: string
Required: Yes
Default: None

Timing

Name Description

Polling frequency

Frequency in milliseconds to check the read directory. The read directory is specified by the endpoint of the listening component.
Type: integer
Required: No
Default: None

File Age

Minimum age in milliseconds for Mule to wait before consuming a file. This allows a file write to complete before processing.
Type: integer
Required: No
Default: None

Size Check Wait Time

Wait time in milliseconds between size checks to determine if a file is ready to be processed. This allows a file write to complete before processing. You can disable this feature by setting to a negative number or omitting a value. When enabled, Mule performs two size checks waiting the specified time between calls. If both checks return the same value, the file is ready to process.
Type: integer
Required: No
Default: None

SFTP Receive Settings

Server information

Name Description

Host

Enter the Fully Qualified Domain Name (FQDN) or IP address of the server on your host machine that connects to the external SFTP server.
Type: string
Required: Yes
Default: None

Port

The port that connects to the local (host) server. (Commonly 22)
Type: integer
Required: Yes
Default: None

Path

Specify a path that facilitates connection to the local server
Type: string
Required: Yes
Default: None

Username

 
Type: string
Required: Yes
Default: None

Password

 
Type: string
Required: Yes
Default: None

Timing

Name Description

Polling frequency

Frequency in milliseconds to check the read directory. The read directory is specified by the endpoint of the listening component.
Type: integer
Required: No
Default: None

File Age

Minimum age in milliseconds for Mule to wait before consuming a file. This allows a file write to complete before processing.
Type: integer
Required: No
Default: None

Size Check Wait Time

Wait time in milliseconds between size checks to determine if a file is ready to be processed. This allows a file write to complete before processing. You can disable this feature by setting to a negative number or omitting a value. When enabled, Mule performs two size checks waiting the specified time between calls. If both checks return the same value, the file is ready to process.
Type: integer
Required: No
Default: None

HTTP Send Settings

Global Config

Name Description

Protocol

Select HTTP or HTTPS
Type: Radio-button-selected value
Required: Yes
Default: HTTP

Use Persistent Connections

 
Type: Checkbox selection
Required: no
Default: Selected

Connection Idle Timeout (milliseconds)

 
Type: string
Required: yes
Default: 30000

Response Timeout (milliseconds)

 
Type: string
Required: no
Default: none

Operation Settings

Name Description

Host

 
Type:  
Required: no
Default: None

Port

 
Type:  
Required: no
Default: None

Path

 
Type:  
Required: no
Default: None

Method

 
Type: Listbox selection
Required: no
Default: None

Authentication Settings

Name Description

Type

Type: Listbox selection
Required: No
Default: None

HTTP Receive Settings

Global Config

Name Description

Protocol

HTTP or HTTPS
Type: Radio-button-selected value Required: yes
Default: HTTP

Use Persistent Connections

 + Type: Checkbox selection
Required: no
Default: Selected

Connection idle Timeout (milliseconds)

 
Type: string
Required: yes
Default: 30000

Response Timeout (milliseconds)

 
Type: string
Required: no
Default: none

Operation Settings

Name Description

Host

 
Type: string
Required: yes
Default: None

Port

 
Type: string
Required: no
Default: None

Path

 
Type: string
Required: yes
Default: None

Allowed Methods

 
Type: String
Required: no
Default: None

JMS Send Settings

Global Config Settings

Setting Description

JMS Connection Type

Select a connection type from the listbox. If you select Other, a box appears in which you can enter an alphanumeric connection type not in the listbox list. Required?: Yes
Type: Alphanumeric
Default: TIBCO EMS

URL Protocol

Populates based on the value selected for JMS Connection Type
Type: Read-only
Default: tibjmsnaming

Host

Required: Yes
Type: string
Default: None

Port

Required:Yes
Type: integer
Default: None

Username

Required?: Yes
Type: string
Default: None

Password

Required?: Yes
Type: string
Default: None

Operation Settings

Setting Description

Queue/Topic

Select the appropriate radio button
Type: Radio button
Default: Queue

Queue Name

Required?: Yes
Type:Standard APM field format
Default: None

Exchange Pattern

Select either the One-Way or the Request-Response radio button
Type: Radio button
Default: One-Way

JMS Receive Settings

Global Config Settings

Setting Description

JMS Connection Type

Select a connection type from the listbox. If you select Other, a box appears in which you can enter an alphanumeric connection type not in the listbox list. Required?: Yes
Type: Alphanumeric
Default: TIBCO EMS

URL Protocol

Populates based on the value selected for JMS Connection Type
Type: Read-only
Default: tibjmsnaming

Host

Required: Yes
Type: string
Default: None

Port

Required:Yes
Type: integer
Default: None

Username

Required?: Yes
Type: string
Default: None

Password

Required?: Yes
Type: string
Default: None

Operation Settings

Setting Description

Queue/Topic

Select the appropriate radio button
Type: Radio button
Default: Queue

Queue Name

Required?: Yes
Type:Standard APM field format
Default: None

Exchange Pattern

Select either the One-Way or the Request-Response radio button
Type: Radio button
Default: One-Way