Differences

This shows you the differences between two versions of the page.

--- rest_server_integration_guide [2020/05/12 22:43] – wikiadmin
+++ rest_server_integration_guide [2023/03/20 10:43] (current) – wikiadmin
@@ Line 1: / Line 1: @@
-Deploying TransSECS with a REST interface allows the reading and writing of values over http.  The default port for the server is 7220, so, for example the url may start with http://localhost:7220
+==== TransSECS as a REST Server ====
+Deploying TransSECS with a REST interface allows the reading and writing of values over http.  The "REST Module" must be installed to do this.
+The default port for the server is 7220, so, for example the url may start with http://localhost:7220
 All REST requests return a JSON object.
@@ Line 10: / Line 15: @@
 <code javascript>
-{"ReadOnlyVariables":["gemtool.alids.gasflowproblem.alcd","gemtool.vids.controlstate", ... "gemtool.vids.spoolfulltime","gemtool.vids.spoolstarttime"],
+{
-"ReadWriteVariables":["gemtool.alids.gasflowproblem.enable","gemtool.alids.gasflowproblem.set"..."gemtool.vids.timeformat","gemtool.vids.wafercount"]}
+"ReadOnlyVariables":["gemtool.alids.gasflowproblem.alcd","gemtool.vids.controlstate", ... "gemtool.vids.spoolfulltime","gemtool.vids.spoolstarttime"],
+"ReadWriteVariables":["gemtool.alids.gasflowproblem.enable","gemtool.alids.gasflowproblem.set"..."gemtool.vids.timeformat","gemtool.vids.wafercount"]
+}
 </code>
@@ Line 21: / Line 28: @@
 <code javascript>
 {"gemtool.vids.controlstate":"3","Errors":"NONE"}
+</code>
+==== REST Server in TransSECS ====
+It's also possible to deploy a RESTServiceManager inside TransSECS rather than wrapping at deployment.  After adding the REST module to TransSECS, edit the ErgoTechConfiguration.properties file.  Add this line to the end of the file:
+serversdevicemanager.additionalservers=com.ergotech.vib.servers.rest.RESTServiceManager
+Then add "UtilityServers" to the deviced node and right-click to add the "RESTServiceManager" from the list. Configure the server and then rebuild the application and go LIVE to test the configuration by going to the URL:
+http://localhost:7220/LIST
+That should give you a list of all the servers in the "UtilityServers" node.
+For broader access, set //Publish// and //All Application//
+{{:pasted:20230315-181304.png}}
+Now LIST will now give you many additional tags.  For example, if you are using the GEMHost sample application, one tag will be "GEMHost.variables".  Going to this URL:
+http://localhost:7220/VALUES/GEMHost.variables
+will give you a list of all the variables in the system.  After some events (CEIDs) have been received by your system you will see JSON representations of the messages and reports.
+You can also update values and send messages.  Here are two curl commands.  The first sets the value of the PPIDParamValue in the HostCommandPPSELECT message.  The second sends the message.  The value of the PPIDParamValue in the message will be "TestRecipe" as set by the first command.
+<code>
+curl -X POST -H "Content-Type: application/json" -d '{"/gemhost/HostCommandPPSELECT>PPIDParamValue":"TestRecipe"}' http://localhost:7220/UPDATE
+curl -X POST -H "Content-Type: application/json" -d '{"/gemhost/HostCommandPPSELECT>sendMessage": "1"}' http://localhost:7220/UPDATE
 </code>