node-red-trexmes-commands 1.1.0 → 1.1.1

package/README.md

@@ -9,7 +9,47 @@ Run the following command in the root directory of your Node-RED install
     npm install node-red-trexmes-commands
 
 # Usage
+The following operations can be performed with this node by communicating with the Trex-Mes system.
+ - Load Job Plan
+ - Finish Production
+ - Start Stoppage
+ - Change Stoppage
+ - Finish Stoppage
+ - Login Employee
+ - Logout Employee
+ - Shifted Shift
+ - Start Test Mode
+ - Finish Test Mode
+ - Create Deffect
 
+For configuration, first MS SQL server connection setting must be made. In addition, the "company" company identification id and the identification id of the personnel who will perform the transaction should be defined as default in the connection features, specifically for the Trex system.
+
+Then, the relevant operation is selected from the "Operation Type" combo contained in the node.
+The Json sample data requested as input is displayed on the node for each operation.
+
+For example, the input example for "Load Job Plan" should be as follows
+```sh
+{
+    "WorkstationId": 10,
+    "PlanId": 123
+}
+```
+
+When json data is sent in accordance with this sample data, the relevant operation is performed.
+
+As an operation return, for example, when the operation is successful for the "Loas Job Plan" operation, the following information is returned.
+```sh
+{ 
+    "COMMANDID":91,
+    "ISPROCESSED":true,
+    "ISSUCCESS":1,
+    "MESSAGE":"LoadPlan Success"
+}
+```
+
+The example can be found in the node-red import examples page.
+
+![trexMes-CMD Node image1](src/assets/1.jpg)
 
 # Requirements
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-trexmes-commands",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A node-red node to execute commands for Trex Mes Systems",
   "main": "trexcommands.js",
   "dependencies": {
@@ -16,6 +16,9 @@
   "files": [
     "src/"
   ],
+  "directories": {
+    "example": "examples"
+  },
   "keywords": [
     "node-red",
     "trex-mes",

package/src/locales/en-US/trexcommands.html

@@ -17,141 +17,7 @@
 <script type="text/html" data-help-name="trexMes-CMD">
     <p>Node for Node-RED to trexMes Commands</p>
 
-    <h3>Foreword</h3>
-    <dl class="message-properties">
-        Examples have been included to help you do some common tasks. 
-        <a onclick="RED.actions.invoke('core:show-examples-import-dialog')" href="#">Click here</a> to import an example or press the hamburger menu <a class="button" href="#"><i class="fa fa-bars"></i></a> select <b>import</b> then <b>examples</b> or press <kbd>ctrl+i</kbd>
-    </dl>        
-
-    <h3>Query Mode...</h3>
-    <div style="padding-left: 15px;">
-        <p>Select the execution mode, this can be "Query", "Stored procedure" or "Bulk Insert"</p>
-        <div class="form-tips" style="width: 100%">
-            TIP: Query mode can be set in the UI or dynamically via msg, flow, global or env. The value sent must be either "query", "execute" or "bulk"
-        </div>
-        <p>INFO: TVP variables are only supported in stored procedures. Some variable types are not supported by the underlying SQL driver.
-        </p>
-    </div>
-     
-    <h3>Query...</h3>
-    <div style="padding-left: 15px;">
-        <p>Enter the query or stored procedure name to execute. It is possible to use <i><a href="http://mustache.github.io/mustache.5.html" target="_new">mustache</a></i> format to access properties of the msg, flow context and global context.</p>
-        <div class="form-tips" style="width: 100%">
-            TIP: Query can be set in the UI or dynamically via msg, flow, global or env. The value sent can also contain mustache items.
-        </div>
-        <br>
-        <p>Query Examples (with mustache and parameters)...
-            <ul>
-                <li><code style="white-space: normal;">SELECT TOP {{{flow.maxRows}}} * FROM [MyTable] WHERE Name = @name AND quantity >= {{{global.minQty}}}</code></li>
-                <li><code style="white-space: normal;">INSERT INTO [MyTable] (id, name, quantity) VALUES (@id, '{{{payload.name}}}', {{{payload.qty}}})</code></li>
-                <li><code style="white-space: normal;">UPDATE [MyTable] SET quantity = @quantity WHERE id = {{{payload.id}}}</code></li>
-                <li><code style="white-space: normal;">DELETE FROM [MyTable] WHERE id = @id</code></li>
-            </ul>
-        </p>
-        <div class="form-tips" style="width: 100%">Query mode tips...
-            <ul>
-                <li>To access <code>msg</code> properties, just use the variable name. e.g.
-                    <code>SELECT top {{{payload}}} * from [MyTable]</code></li>
-                <li>To access <code>flow</code> and <code>global</code> properties,
-                    specify them in the mustache e.g. 
-                    <code>SELECT {{{flow.name}}} FROM {{{global.table_name}}}</code></li>
-                <li>To prevent certain characters being escaped, use triple curly brackets. e.g. 
-                    <code>{{{flow.my_string}}}</code> </li>
-            </ul>
-        </div>
-        <div class="form-tips" style="width: 100%">Execute tips...
-            <ul>
-                <li>The query should be just the name of the stored procedure (don't include <code>exec</code>)</li>
-                <li>Parameters can be entered in the procedure query 
-                    (but are not necessary - just enter the matching parameter name in the <code>Parameters</code> list) </li>
-            </ul>
-        </div>
-        <div class="form-tips" style="width: 100%">Bulk Insert tips...
-            <ul>
-                <li>The query should be just the name table to bulk insert into</li>
-                <li>Data to bulk insert must be provided to the <code>Rows (bulk data)</code> field as either ...
-                    <ul>
-                        <li>an array of array rows e.g. <code>[ [col1_value, col2_value], [col1_value, col2_value] ]</code></li>
-                        <li>an array of object rows e.g. <code>[ {col1:"value", col2:"value"}, {col1:"value", col2:"value"} ]</code></li>
-                    </ul>
-                </li>
-            </ul>
-        </div>
-
-        <br>
-        <p>INFO: When the 'Result type' is set to 'Driver output'...
-            <ul>
-                <li>Multiple results can be returned in the <code>recordsets</code> array if multiple queries are
-                    executed.</li>
-                <li>It is recommended the user checks the value(s) in the <code>rowsAffected</code> property to confirm
-                    operation - especially when performing INSERT, UPDATE and DELETE operations.</li>
-            </ul>
-        </p>
-    </div>
-    
-    <h3>Parameters...</h3>
-    <div style="padding-left: 15px;">
-        <p>Input and Output Parameters can be specified for a query or procedure. In bulk mode, the parameters represent the columns of the table</p>
-        <div class="form-tips" style="width: 100%">
-            TIP: Query can be set in the UI or dynamically via msg, flow, global in the following format...<br>
-            <code><pre style="white-space: pre;">[
-{
-    "output": false,
-    "name": "parameter name",
-    "type": "parameter type",
-    "value": "parameter value"
-},
-{
-    "output": true,
-    "name": "parameter name",
-    "type": "parameter type"
-}
-]</pre></code>
-        </div>
-        <br>
-        <p>Query Examples (with parameters)...
-            <div style="padding-left: 15px;">
-                <code style="font-weight: bold;">Query</code>
-                <div style="padding-left: 15px;">
-                    <code style="white-space: normal;">SELECT TOP {{{payload.maxRows}}} * FROM [MyTable] WHERE Name = @name AND quantity >= @minQty</code>
-                </div>
-            </div>
-            <div style="padding-left: 15px;">
-                <code style="font-weight: bold;">Parameters</code>
-                <ul>               
-                    <li>
-                        <span>In/Out </span><code style="white-space: normal;">input</code> 
-                        <span>, Name </span><code style="white-space: normal;">name</code>
-                        <span>, Type </span><code style="white-space: normal;">varchar(20)</code>
-                        <span>, Value </span><code style="white-space: normal;">stephen</code>
-                    </li>
-                    <li>
-                        <span>In/Out </span><code style="white-space: normal;">input</code> 
-                        <span>, Name </span><code style="white-space: normal;">minQty</code>
-                        <span>, Type </span><code style="white-space: normal;">int</code>
-                        <span>, Value </span><code style="white-space: normal;">5</code>
-                    </li>
-                </ul>
-            </div>
-        </p>
-    </div>
-    
-    <h3>Output options...</h3>
-    <div style="padding-left: 15px;">
-        <h4>Output property</h4>
-        <ul>
-            <li>The field to write the results to. Typically this is <code>msg.payload</code></li>
-        </ul>
-        <h4>Output type (not used for "Bulk Insert" mode)</h4>
-        <ul>
-            <li><b>Original output</b>: The property specified by 'Output property' will be populated with a single recordset (if
-                any). This is the same as earlier mssql-plus version - for compatibility</li>
-            <li><b>Driver output</b>: The property specified by 'Output property' will be populated with the result of the query
-                direct from the driver output. This format can return multiple recordsets and other information. Add a
-                debug node to see all available properties returned.</li>
-        </ul>
-    </div>
-   
+           
    <h3>Error Handling...</h3>
     <div style="padding-left: 15px;">
         <ul>
@@ -163,4 +29,4 @@
         </ul>
     </div>
 	
-</script>
+</script>

package/src/trexcommands.html

@@ -336,7 +336,13 @@
                     { value: '4|Finish Production', label: 'Finish Production', hasValue: false },                    
                     { value: '5|Start Stoppage', label: 'Start Stoppage', hasValue: false },
                     { value: '6|Change Stoppage', label: 'Change Stoppage', hasValue: false },
-                    { value: '7|Finish Stoppage', label: 'Finish Stoppage', hasValue: false }
+                    { value: '7|Finish Stoppage', label: 'Finish Stoppage', hasValue: false },
+                    { value: '9|Login Employee', label: 'Login Employee', hasValue: false },
+                    { value: '10|Logout Employee', label: 'Logout Employee', hasValue: false },
+                    { value: '13|Shifted Shift', label: 'Shifted Shift', hasValue: false },
+                    { value: '14|Start Test Mode', label: 'Start Test Mode', hasValue: false },
+                    { value: '15|Finish Test Mode', label: 'Finish Test Mode', hasValue: false },
+                    { value: '16|Create Deffect', label: 'Create Deffect', hasValue: false }                                                                                                    
                 ],
                 typeField: $('#node-input-modeOptType'),
                 default: 'Load Job Plan'
@@ -361,7 +367,25 @@
 				} 
                 else if(operationMode.startsWith('7|')) { //Finish Stoppage
 					data = '{ "WorkstationId": 10 }';									
-				}                                    
+				} 
+                else if(operationMode.startsWith('9|')) { //Login Employee
+					data = '{ "WorkstationId": 10, "EmployeeId": 11 }';									
+				}     
+                else if(operationMode.startsWith('10|')) { //Logout Employee
+					data = '{ "WorkstationId": 10, "EmployeeId": 11 }';									
+				}  
+                else if(operationMode.startsWith('13|')) { //Shifted Shift
+					data = '{ "WorkstationId": 10, "LineId": 11 }';									
+				}    
+                else if(operationMode.startsWith('14|')) { //Start Test Mode
+					data = '{ "WorkstationId": 10, "StoppageCauseId": 11 }';									
+				}   
+                else if(operationMode.startsWith('15|')) { //Finish Test Mode
+					data = '{ "WorkstationId": 10 }';									
+				} 
+                else if(operationMode.startsWith('16|')) { //Create Deffect
+					data = '{ "WorkstationId": 10, "DefectId": 11,"StockId": 12, "Quantity": 15.5 }';									
+				}  
 				node.editor.setValue(JSON.stringify(JSON.parse(data),null, 2));	
 
             });

package/src/trexcommands.js

@@ -66,7 +66,52 @@ module.exports = function (RED) {
         else if(payload.operationMode == "7" ) { // Finish Stoppage
             result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId });
             result.isOk = true;
-        }        
+        }  
+        else if(payload.operationMode == "9" ) { // Login Employee
+            if(!payload.EmployeeId){
+                return result;
+            }
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId, "EmployeeId": payload.EmployeeId });
+            result.isOk = true;
+        }              
+        else if(payload.operationMode == "10" ) { // Logout Employee
+            if(!payload.EmployeeId){
+                return result;
+            }
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId, "EmployeeId": payload.EmployeeId });
+            result.isOk = true;
+        }    
+        else if(payload.operationMode == "13" ) { // Shifted Shift
+            if(!payload.LineId){
+                return result;
+            }
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId, "LineId": payload.LineId });
+            result.isOk = true;
+        } 
+        else if(payload.operationMode == "14" ) { // Start Test Mode
+            if(!payload.StoppageCauseId){
+                return result;
+            }
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId, "StoppageCauseId": payload.StoppageCauseId });
+            result.isOk = true;
+        } 
+        else if(payload.operationMode == "15" ) { // Finish Test Mode
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId });
+            result.isOk = true;
+        }
+        else if(payload.operationMode == "16" ) { // Create Deffect
+            if(!payload.DefectId){
+                return result;
+            }
+            if(!payload.StockId){
+                return result;
+            }
+            if(!payload.Quantity){
+                return result;
+            }
+            result.command = JSON.stringify({ "WorkstationId" : payload.WorkstationId, "DefectId": payload.DefectId, "StockId": payload.StockId, "Quantity": payload.Quantity, "ReferenceQuantityType": 0 });
+            result.isOk = true;
+        }                                        
         return result;
     }