Call a robot - eMagiz

{{container}}{{container layoutStyle="columns"}}(((

In this microlearning, we'll explore how to use Robot Process Automation (RPA) technology to extract information from websites that aren’t accessible through traditional methods like APIs or (S)FTP. Specifically, we’ll focus on how to trigger and manage robots built with the dexi.io platform from within eMagiz. While we won't delve into the details of building these robots, we'll guide you through the steps to execute them, handle authentication, and retrieve the output effectively.

4

5

Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].

6

7

== 1. Prerequisites ==

8

9

* Expert knowledge of the eMagiz platform

10

* An additional license on the platform is needed

11

12

== 2. Key concepts ==

13

14

* In case you need information from a party that is only available on a website and not via traditional methods, you can use robot process automation (RPA) technology

15

* From eMagiz, you can execute the robot and retrieve the output of the robot when it is built via the dexi.io platform

16

* Building robots via this platform requires an additional license on the platform

17

* Using robots to retrieve information should be considered a last resort.

18

* We will not explain how to build robots in this microlearning. For this see the dexi.io [[documentation>>https://dexi.document360.io/||target="blank"]].

19

20

== 3. Call a robot ==

21

22

Sometimes you need to retrieve information from a specific website that cannot be accessed via any traditional integration method (i.e., API, Kafka, SOAP, (S)FTP). In these circumstances, you can use robot process automation (RPA) technology to your advantage. Robots built via the dexi.io platform can be triggered (i.e., executed) via an API call. Depending on the use case of the robot, you can either wait for the result or just run the robot and retrieve the output at a different time.

23

24

In the remainder of this course, we will focus on the option you want to wait for the results of your call. To call a robot, we need a trigger point in eMagiz (which can be done via a "Standard inbound channel adapter"), authentication (in the form of two headers), and an HTTP outbound gateway that triggers the execution of the robot. Optionally, additional logic is needed when the robot requires specific input values (i.e., username/password to log in on a website).

25

26

=== 3.1 Trigger point ===

27

28

As a trigger point you can either use a standard JMS component (JMS message driven channel adapter) if you want another system to start the executing of the robot (and retrieve its output) or you can use a standard inbound channel adapter that triggers based on a specific schedule. An example of this is shown below.

29

30

[[image:Main.Images.Microlearning.WebHome@expert-robotic-process-automation-call-a-robot--trigger-point-example.png]]

31

32

=== 3.2 Authentication ===

33

34

Once the process is started the next step within the context of the flow will be the authentication towards dexi.io. Dexi requires two authentication headers called X-DexiIO-Access and X-DexiIO-Account. Subsequently, an additional header is needed to define the contentType which can be filled hardcoded with the value "application/json". With the help of a standard header enricher component you can add this information to your message to use it in the next step to call the dexi API.

35

36

[[image:Main.Images.Microlearning.WebHome@expert-robotic-process-automation-call-a-robot--authentication-example.png]]

37

38

=== 3.3 Trigger robot execution ===

39

40

When all headers are defined the last step to trigger the execution of the robot is to call an endpoint of dexi.io with the help of an HTTP outbound component. Most logical component to select in this case is the HTTP outbound gateway. With the help of this HTTP outbound gateway you can call the correct endpoint of dexi.io to trigger the execution and wait for the results (this last part is optional) which you can then handle in the best way for you.

41

42

[[image:Main.Images.Microlearning.WebHome@expert-robotic-process-automation-call-a-robot--http-outbound-example.png]]

43

44

{{info}}Note that you need a header mapper support object to send the correct headers towards dexi.

45

[[image:Main.Images.Microlearning.WebHome@expert-robotic-process-automation-call-a-robot--header-mapper-example.png]]{{/info}}

46

47

== 4. Key takeaways ==

48

49

* In case you need information from a party that is only available on a website and not via traditional methods, you can use robot process automation (RPA) technology

50

* From eMagiz, you can execute the robot and retrieve the output of the robot when it is built via the dexi.io platform

51

* Building robots via this platform requires an additional license on the platform

52

* Using robots to retrieve information should be considered a last resort.

53

* We will not explain how to build robots in this microlearning. For this see the dexi.io [[documentation>>https://dexi.document360.io/||target="blank"]].

54

55

== 5. Suggested Additional Readings ==

56

57

To learn more about dexi.io and the API of dexi.io, please check out the following additional readings.

58

59

* [[General documentation (External)>>https://dexi.document360.io/||target="blank"]]

60

* [[API documentation (External)>>https://app.dexi.io/#/api||target="blank"]]

61

* [[Call robot (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=call+robot||target="blank"]]

62

)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Call a robot

Navigation