Channels
If possible, always use channels to centrally manage connection parameters. In addition to the increased clarity that also facilitates maintenance. If the connection parameters change, you only have to adjust the data in one place and you do not forget a profile.
Context menu partner/channel
Edit partner |
Self-explanatory. |
Export partner |
The partner can be exported with/without local certificates. |
Export multiple partners |
Several partners with/without their local certificates can be exported. |
Delete partner |
Self-explanatory. |
Create Datasheets |
Creates datasheets for all channels of a partner (with or without passwords). |
Create new channel |
Self-explanatory. |
Import partner |
Import a previously exported partner. |
Create new partner |
Self-explanatory. |
Edit channel |
Self-explanatory. |
Used in |
Opens a new dialogue with a list of profiles, Content Inspection, ASM entries and ENGDAT entries, in which the channel is used. ETL/ELT and workflow entries are also displayed if the channel ID is used as a parameter in a function. For profiles, it is also specified whether the channel is used in the Input Agent → (input) and the Responses that use the channel are explicitly listed with number → #. Inactive entries are grey and in italics. Entries can be opened directly via the context menu. Note: See also class ChannelReportCron. |
Display as Data Flow |
Display in add-on module Data Flow. |
Datasheet without/with passwords |
A (zipped) PDF report can be created (in German or English), which contains the essential parameters (with or without passwords) of the channel. In a further dialogue, the contact information that comes from the client by default can be overwritten. Note: You can define the server URL in configuration file ./etc/admin/datawizard/defaults.properties. |
Delete channel |
Self-explanatory. |
Copy channel |
Self-explanatory. Note: All fields that are unique to a channel (partner name, partner ID) are deleted in a copy and must be entered again. |
Testing channels
With the Simulator (Data Flow), the add-on module Data Flow offers a very good way to test the behaviour of partner channels.
Additionally, for many channel types, a connection test is available to check your settings.
System variables
Useful in connection with channels are, for example, the following system:
Functions
Overwriting channel values
If you have selected a channel, the use of channel values in fields is marked in colour. If you want to use different values for certain fields, you can enter them as usual in the corresponding field. This value will then be used to overwrite the channel value (see field Port). For non-overwritten fields, the values still come from the selected channel (see field User).
General channel settings
A channel bundles the essential parameters of a communication connection to a partner. For example, the URL of the server, the login name, the password, etc. for an FTP connection. The name of a channel must be unique.
Bundling in a channel has the advantage that this connection data can be managed centrally. This provides an overview and also facilitates adjustments to the connection data. If a partner server has a new URL/IP, for example, you only have to change it once centrally in the channel and it will automatically be applied to all your profiles, ASM entries and Content Inspection entries if they use the channel. This saves work and also prevents corrupt/inconsistent connection data.
All general configuration areas are shown below (using an exemplary FTP channel).
Settings
(1) Channel ID: The channel ID is assigned when the channel is stored for the first time. See also function find channel(partner a, name b, [c]) and system variable VAR_SYS_CHANNEL_RESPONSE[1..n].
(2) Active: If this checkbox is not set, the channel is not active and cannot be used for communication. Even if a channel is active, it cannot be used if the partner to which the channel belongs is not active. See partner list, item (3). See also function de/activate partner channel().
(3) Invisible to DMZ: If this checkbox is set, the data of this channel will not be passed on to the DMZ server (if it exists). The channel then does not exist for a DMZ server, so to speak. This can be used to define channels that are not to be accessible to external users and are only used internally. For channel types AS2, X.400, HTTP(S) and all subtypes of "FTP" also see section Sending via dynamically assigned alternative DMZ. Note: This setting is not available for channel type "SMB".
(4) Direction: The data direction of the channel. "Outgoing (me to partner)" means that data can be transferred to the partner. "Incoming (partner to me)" means that data from the partner can be transferred to you.
(5) Use Comm Log: If this checkbox is set, the individual steps of the communication with the partner system are additionally logged for this channel. In addition, the messages for the MDNs are logged if the respective partner channel supports MDNs (e.g. channel type AS2). These messages can be viewed in a separate area of the Control Center. Each generated Comm Log entry triggers an event that can be intercepted by the Comm Log Input Agent. Note: The behaviour is slightly different for HTTP channels. Comm Log events are only triggered in the Response "HTTP"and for ASM transmissions via HTTP (MDN for HTTP code >= 200 and < 300, otherwise NDN). However, these are not displayed in the Control Center, but can be intercepted by the Comm Log Inbound Agent. Note: See also option "No processing of files already treated".
(6) Retain days: See section Retention periods of backup files, logs, crashed jobs.
Own ID (Me towards partner)
Here you enter your ID and password for the remote server and its address (in this case an FTP server). Note: The protocol (ftp:// in this example) must be specified in the address, but there will also be a hint if you enter the address incorrectly. Note: The port can optionally be specified (as in the screenshot), otherwise, the respective default port is used. See also section Services.
Specific features
Channel Type "Fax": This configuration area does not exist for this channel type.
Channel Type "HTTP": For details, see section HTTP(S) (channel).
Channel Type "OFTP": The ID is also called SSID in OFTP.
Channel Type "SMB": This configuration area does not exist for this channel type.
Partner ID (Partner towards me)
Enter the ID and password for the partner. This access data is then sent to your partner so he can access your server. So by configuring this area, you are creating a user on your server for your partner.
Specific features
Channel Type "Fax": This configuration area does not exist for this channel type.
Channel Type "OFTP": The ID is also called SSID in OFTP.
Channel Type "SMB": This configuration area does not exist for this channel type.
Partner contact
Here, the contact information of a contact person can be stored for each partner channel.
Additional IDs (in channel)
The channel-specific values for central additional IDs of the Partner Administration are created here. Please read the explanation there.
Specific features
Channel Type "OFTP": If a value is set in a channel of type "OFTP" for the additional ID with key ENGDAT_SFID, this stored value is set as SFID during the transmission when sending in the additional module "ENGDAT" (and only there). Note: A partner sends a 'start file' command (SFID) indicating that it has a file to send. An SFID contains, among other things, information about originator, destination, OFTP Virtual File Name, file format, and options for file compression, file encryption and signed EERP.
Channel Type "HTTP": You can recognise an Access Token by an entry with the name SYS_HTTP_OAUTH2 (or SYS_HTTP_OAUTH1) and a Refresh Token by an entry with the name SYS_HTTP_OAUTH2_REFRESH. Additional IDs of the form SYS_HTTP_<HEADERNAME> can be used to generate HTTP request headers. However, if a header with the same name is set in the profile, this one will be used, see sections HTTP (Input Agent cron) and Response "HTTP". Note: This can be used, for example, to create a header for an API key.
Type-specific channel settings
See subsections.