CallProfileAndPassBackDataResponse (Responder)

Prev Next

The CallProfileAndPassBackDataResponse (Responder) can be assigned to a profile in Phase 6 for a response path. It transfers the content defined for the response path to another profile (e.g. a cron job), waits for its response (e.g. via CronPassBackDataResponse (Responder)) and then transfers it as a return value to the profile caller (e.g. an HTTP or portal profile).

When creating the response path the category Custom class must be selected so that the CallProfileAndPassBackDataResponse (Responder) is selectable under Class:

images/download/attachments/201674343/image2020-11-3_14-52-28-version-1-modificationdate-1747059784582-api-v2.png

In the Additional parameters field, a parameter list with the parameters listed below must be specified. Only the first parameter (Profile name) is 'required'.

Parameter

Designation

Required?

Default

Description

1

Profile name

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg

Profile name or a message queue with profile name (Notation: context:queue:profile name).

2

Backup change

true

true specifies that the backup time should be set to 0. Then the input file of the called profile is not available as backup.

3

Error change

true

true specifies that no e-mail notification should be generated if an error occurs in the called profile.

4

Force trigger cron job

true

true specifies that the cron job should be triggered in any case.

5

Use direct trigger job

true

true specifies that the cron job should be executed in the same thread as the calling profile.

6

Apply result vars

true

true specifies that variables defined in the profile but empty should be overwritten with the content of the result variable.

7

Fail on inner error

true

true specifies that the current response path should fail if the profile call ended with an error.

Examples

Parameter list with direct profile call

The following parameter list calls a profile named CronFetchDB. The further parameters define that:

  • The input file is kept as backup (Backup change: false).

  • An e-mail notification is sent in cases of error (Error change: false).

  • The response path is still considered error-free in cases of error in the called profile (Fail on inner error: false).

â–ºNOTEâ—„ For all parameters 'without value' the default value is true (see table above for meaning).

Example parameter list with profile name:

CronFetchDB;false;false;;;false

Parameter list with profile call via a message queue

The following parameter list calls a profile with the name my_profile in context my_context using the Message Queue my_queue.

Example parameter list with profile name:

my_context:my_queue:my_profile

â–ºNOTEâ—„ For the optional parameters 2 to 7 ('without value') the default value is true (see table above for meaning).