WebserviceCOM

In order to use the Webservice, you have first to configure it in the ConfigurationCOM menu in the portal in the distant tab. This configuration is unique to the environment, and cannot be reused in another environment.

22

23

24

[[image:1667487553991-372.png]]

25

26

27

There are many parameters to configure for the WebService connector:

28

29

(((

30

* __**Name**__: The name of the distant Webservice used

31

32

33

* __**IP/host**__: The domain name of the servor or the IP address used

34

35

36

* __**URI**__: The path in the IP/host used to send the files

37

38

39

* __**Method**__: signifies the method used to get the data( GET, POST, PUT, DELETE)

40

41

42

* __**Port**__: The port of the listening

43

44

45

* __**Protocol**__: The protocole used (HTTP ou HTTPS)

46

47

48

* __**Authentification Mode**__: There is 2 different ways for the authentification mode

49

** __**Basic**__: is a mode that needs 3 attributes(**header**: the header'name, **user **encoded in base64, **password **encoded in base64)

50

** __**Token**__: is a mode that consists on putting a token in the header. This mode uses 2 parameters: The **header** and the **token** is an encoded and encrypted data with a unique key using the HASHMAC algorithm.

51

52

53

* __**Timeout**__: is the max time acceptable to connect to the WS and get the result.

54

55

56

* __**Charset**__: is the encodage of the json file that will be sent to WS and of the result file

57

58

* (((

59

===== **Configuring the Webservice connector in the scenario:** =====

60

)))

61

62

Second, you have to configure the connector in the Scenario menu.

63

64

[[image:1667492134946-717.png]]

65

66

67

For this configuration, you have to fill these parameters:

68

69

* __**Destinataire**__: The environment where the distant configuration exists

70

* __**Config**__: The name of the distant configuration in the chosen environment

71

* __**Dyn.enveloppe**__: is a Yes or No value that mentions if the enveloppe is dynamic

72

* __**Enveloppe**__:if the enveloppe is not dynamic, this parameter is for uploading the file of the enveloppe or the connector's name that contains the file for the enveloppe.

73

* __**Data**__:the connector's name ythat contains the data

74

* __**Output FileName**__: The output file name

75

76

==== __**Elements of the WS:**__ ====

77

78

* (((

79

====== __**The enveloppe:**__ ======

80

81

It contains the enveloppe of the informations that will be transferred to the WS.

82

83

The enveloppe can be linked to the message data in this way.

84

85

* **%DATA%** : Le content of the file mentionned in the parameter DATA will the same in the message

86

* **%DATA64%** : the message file linked to DATA will be encoded in base 64 and inserted

87

* **%DATAZIP%** : the message file linked to DATA will be zipped and inserted

88

* **%DATAZIP64%** : the message file linked to DATA will be encoded in base 64 and zipped then inserted

89

90

__**Note**__: The enveloppe may be:

91

92

* uploaded in the enveloppe parameter of the WS as a file or as a connector name that contains the file

93

* inserted with a reference to the message

)))

* (((

====== __**The message:**__ ======

99

100

It contains the content of the message that will be transferred to the WS, it will be inserted inside the enveloppe of the connector. The message can be uploaded dynamically using the elements of the scenario or can be fixed and uploaded inside the WS connector.

)))

)))

==== __**Example:**__ ====

* **Scenario:**