Profile suspensions


Suspension versus inactivation


An active profile can be suspended at runtime. The goal is to temporarily prevent the profile from starting new jobs, while it can still receive data. However, this only applies to suspended profiles with event-driven Input Agents. Suspended profiles with time-driven Input Agents do not fetch any data. An inactive profile, on the other hand, does never fetch any data.

An example of when to use the suspension of profiles is the following scenario. A profile uses an "FTP" Response to transfer data to an FTP server. The FTP server is unavailable at certain times due to maintenance. Without the possibility of suspending the profile, two approaches are possible.

  • The profile is set to inactive for the duration of the unavailability of the FTP server. This solution has the disadvantage that the profile does not receive any data during this time and therefore data may be lost.

  • If no data is to be lost, the profile is not deactivated, in the hope that few or no jobs will be started during the unavailability of the FTP server. This solution has the disadvantage that all jobs that are started during the non-availability of the FTP server run into an error and then have to be restarted manually.

By suspending the profile for the duration of the unavailability of the FTP server, you achieve that the data is still accepted and is processed automatically after the expiration of the suspension. As already mentioned, a suspended profile, in contrast to an inactive profile, still accepts incoming data. A job is created, but it is not started. Instead, it is sent to the queue for suspended jobs. This queue can contain any number of jobs. It is possible to delete individual jobs from this queue. The jobs removed from the queue can be restarted at any time. As soon as the suspension of a profile is undone, all jobs belonging to this profile that are currently in the queue are started. Note: Suspended profiles with Input Agent "AMQP" and "JMS "do not accept data. See note there.

Errors caused by suspended profiles


If a suspended profile is executed, the following constellations lead to an error.


  • The following checkbox is set in the settings for the profile: "Error when profile is called in suspended state".

  • The profile is called by another profile via a Response of type "Message" and message type "Synchronous".

Suspending and unsuspending with functions


Editing suspended profile


As long as a profile is suspended, it cannot be edited.

Suspension settings


Profile search


There are several ways to search for a profile you want to suspend.


images/download/attachments/189440837/Suspendierung_1.0_EN-version-2-modificationdate-1744017172638-api-v2.png

Profile tree

Here you can manually search the profile in a tree structure.

Already suspended profiles

Only manually suspended profiles will be displayed.

Already scheduled for suspension

Only profiles suspended via the timer will be displayed.

Cron job profiles

Only profiles with a time-driven Input Agent will be displayed.

Advanced search

See separate section Advanced Search below.

Suspension


The following explanations cover search options (1) to (4) of the first screenshot. Of course, the profile tree is only displayed for (1).


images/download/attachments/189440837/Suspendierung_2.0_EN-version-2-modificationdate-1744017182153-api-v2.png


(1) For this search setting here (see (1) in the screenshot above), the profiles are displayed in a tree (arranged in groups).

(2) The filter field can be used to search for a specific profile name. The wildcard * can also be used, e.g. Company*AS2*send.

(3) Profile name: The found profile.

(4) Immediately: The marked profile is instantly suspended after a click on (6). Such profiles are displayed in orange.

(5) Scheduled: You can specify a time frame in which to suspend the profile. Such profiles are displayed in normal colours (so white for active profiles and grey for inactive profiles), however, they can be recognised by the time information in (5) and are listed in (3) of the first screenshot.

(6) Suspend: Instant (4) or timed (5) suspension of the marked profile.

(7) Cancel suspension: You can cancel a suspension here.

(8) This is where parked jobs are displayed.

Advanced search


Using the advanced search, profiles can be searched based on the channels they are using (AS2, FTP, HTTP, OFTP, SMTP, SSH and X.400). However, other criteria can also be used, e.g. the alias ("DB" and "SAP"), the URL ("WebDAV") or the host ("AS400").


images/download/attachments/189440837/Suspendierung_3.0_EN-version-2-modificationdate-1744017218954-api-v2.png


(1) Conditions: All conditions (the channels) listed in the field below are logically linked with "OR".

(2) Further conditions can be added via the context menu (right-click). Another window opens (the following screenshot is for an "FTP" condition).


images/download/attachments/189440837/Suspendierung_4.0_EN-version-2-modificationdate-1744017229633-api-v2.png


(1) Partner name: Select a partner from the list of all available partners.

(2) Type: The type of the channel.

(3) Name: The name of the channel.

(4) Partner ID: The "Partner ID" set in the channel.

(5) Last modified: The time when the last change was made to the channel.

(6) List of all channels of the partner.