Wiki source code of WebserviceCOM
Version 23.1 by Achraf El Kari on 2022/11/04 17:27
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = __**Definition:**__ = | ||
| 2 | |||
| 3 | |||
| 4 | Webservice is a connector used to send data with other web applications. | ||
| 5 | |||
| 6 | = __**Icon:**__ = | ||
| 7 | |||
| 8 | |||
| 9 | [[image:1667487132740-653.png]] | ||
| 10 | |||
| 11 | = __**Configuration:**__ = | ||
| 12 | |||
| 13 | |||
| 14 | There is 2 parts in configuring of the webservice connector: | ||
| 15 | |||
| 16 | |||
| 17 | * ((( | ||
| 18 | ===== **Configuring the Webservice in the ConfigurationCOM menu:** ===== | ||
| 19 | |||
| 20 | |||
| 21 | ))) | ||
| 22 | |||
| 23 | [[image:1667487261988-482.png]] | ||
| 24 | |||
| 25 | |||
| 26 | 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. | ||
| 27 | |||
| 28 | |||
| 29 | [[image:1667487553991-372.png]] | ||
| 30 | |||
| 31 | |||
| 32 | There are many parameters to configure for the WebService connector: | ||
| 33 | |||
| 34 | |||
| 35 | ((( | ||
| 36 | * __**Name**__: The name of the distant Webservice used | ||
| 37 | |||
| 38 | * __**IP/host**__: The domain name of the servor or the IP address used | ||
| 39 | |||
| 40 | * __**URI**__: The path in the IP/host used to send the files | ||
| 41 | |||
| 42 | * __**Method**__: signifies the method used to get the data( GET, POST, PUT, DELETE) | ||
| 43 | |||
| 44 | * __**Port**__: The port of the listening | ||
| 45 | |||
| 46 | * __**Protocol**__: The protocole used (HTTP ou HTTPS) | ||
| 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 | * __**Timeout**__: is the max time acceptable to connect to the WS and get the result. | ||
| 53 | |||
| 54 | * __**Charset**__: is the encodage of the json file that will be sent to WS and of the result file | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | * ((( | ||
| 59 | ===== **Configuring the Webservice connector in the scenario:** ===== | ||
| 60 | |||
| 61 | |||
| 62 | ))) | ||
| 63 | |||
| 64 | Second, you have to configure the connector in the Scenario menu. | ||
| 65 | |||
| 66 | |||
| 67 | [[image:1667492134946-717.png]] | ||
| 68 | |||
| 69 | |||
| 70 | For this configuration, you have to fill these parameters: | ||
| 71 | |||
| 72 | * __**Destinataire**__: The environment where the distant configuration exists | ||
| 73 | |||
| 74 | * __**Config**__: The name of the distant configuration in the chosen environment | ||
| 75 | |||
| 76 | * __**Dyn.enveloppe**__: is a Yes or No value that mentions if the enveloppe is dynamic | ||
| 77 | |||
| 78 | * __**Enveloppe**__: if the enveloppe is fixed, this parameter is for uploading the enveloppe file or the connector's name that contains the file and if it is dynamic, you mention the connector's name that contains the enveloppe. | ||
| 79 | |||
| 80 | * __**Data**__: the connector's name that contains the data | ||
| 81 | |||
| 82 | * __**Output FileName**__: The output file name | ||
| 83 | |||
| 84 | ==== __**Elements of the WS:**__ ==== | ||
| 85 | |||
| 86 | |||
| 87 | * ((( | ||
| 88 | ====== __**The enveloppe:**__ ====== | ||
| 89 | |||
| 90 | |||
| 91 | It contains the enveloppe of the informations that will be transferred to the WS. | ||
| 92 | |||
| 93 | The enveloppe can be linked to the message data in this way. | ||
| 94 | |||
| 95 | * **%DATA%** : Le content of the file mentionned in the parameter DATA will the same in the message | ||
| 96 | |||
| 97 | * **%DATA64%** : the message file linked to DATA will be encoded in base 64 and inserted | ||
| 98 | |||
| 99 | * **%DATAZIP%** : the message file linked to DATA will be zipped and inserted | ||
| 100 | |||
| 101 | * **%DATAZIP64%** : the message file linked to DATA will be encoded in base 64 and zipped then inserted | ||
| 102 | |||
| 103 | __**Note**__: The enveloppe may be: | ||
| 104 | |||
| 105 | * uploaded in the enveloppe parameter of the WS as a file or as a connector name that contains the file | ||
| 106 | |||
| 107 | * inserted with a reference to the message | ||
| 108 | |||
| 109 | |||
| 110 | ))) | ||
| 111 | * ((( | ||
| 112 | ====== __**The message:**__ ====== | ||
| 113 | |||
| 114 | |||
| 115 | 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. | ||
| 116 | |||
| 117 | |||
| 118 | ))) | ||
| 119 | ))) | ||
| 120 | |||
| 121 | ==== __**Example:**__ ==== | ||
| 122 | |||
| 123 | |||
| 124 | * **Scenario:** | ||
| 125 | |||
| 126 | [[image:1667577279879-137.png]] | ||
| 127 | |||
| 128 | |||
| 129 | * **Enveloppe:** | ||
| 130 | |||
| 131 | [[image:1667577352836-357.png]] | ||
| 132 | |||
| 133 | |||
| 134 | * **Result: **is the encoded file that exists in the connector FileDetection1 in base 64. | ||
| 135 | |||
| 136 | [[image:1667577508288-967.png]] | ||
| 137 | |||
| 138 |