find channel(a,b,[c,d])

Returns the ID of a partner communication channel that has been found using an additional ID with name a and value b.

If the optional parameter c is set, the search will be restricted to partner channels of a given type. Following all valid values.

  • ftp

  • smtp

  • mail

  • oftp

  • ssh

  • as2

  • x400

  • sftp

  • ftps

If d is true, the search will be restricted to active channels only. If no fitting channel is found, an empty string will be returned.

Description of Parameters

Parameter

Description

a

Name of additional ID. See section Additional IDs (central).

b

Value of additional ID.

c

(optional) Type of the partner channel to restrict the search. Default: No restriction.

d

(optional) true if only active partner channels should be used. Default: false

Examples

The partner channel administration should contain two partner channels for partner Lobster with the following attributes (simplified).

Partner Channel ID

Channel Name

Channel Type

Active?

1

Lobster:FTP

ftp

true

2

Lobster:AS2

as2

false

The following additional references are defined.

Partner Channel ID

Name of Additional ID

Value of Additional ID

1

custid

4711

1

account

12345

2

custid

4712

2

account

23456

This will lead to the following results.

Parameter a

Parameter b

Parameter c

Parameter d

Result

custid

4711

ftp

1

account

23456

as2

2

custid

4712

ftp

custid

4713

ftp

custid

4711

ftp

true

1

custid

4712

as2

true

You can, for example, store the result in system variable VAR_SYS_CHANNEL_RESPONSE[1..n] (explanation see there), to exchange the channel of a Response Route. Note: See also VAR_SYS_TRIGGER_CHANNEL_ID for exchanging time-driven Input Agents.