dgbuilder/nodes/dge/dgereturn/returnSuccess.html

   1 <!--
   2   Copyright 2013 IBM Corp.
   3
   4   Licensed under the Apache License, Version 2.0 (the "License");
   5   you may not use this file except in compliance with the License.
   6   You may obtain a copy of the License at
   7
   8   http://www.apache.org/licenses/LICENSE-2.0
   9
  10   Unless required by applicable law or agreed to in writing, software
  11   distributed under the License is distributed on an "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   See the License for the specific language governing permissions and
  14   limitations under the License.
  15 -->
  16
  17 <script type="text/x-red" data-template-name="returnSuccess">
  18     <div class="form-row">
  19         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
  20         <input type="text" id="node-input-name" placeholder="Name">
  21     </div>
  22     <div class="form-row">
  23         <label for="node-input-xml"><i class="fa fa-wrench"></i> Node XML</label>
  24         <input type="hidden" id="node-input-xml" autofocus="autofocus">
  25         <div style="height: 450px;" class="node-text-editor" id="node-input-xml-editor" onkeyup="resetStatus()" ></div>
  26     </div>
  27     <div class="form-row">
  28     <a href="#" class="btn btn-mini" id="node-input-validate" style="margin-top: 4px;"><b>Validate XML</b></a>
  29      <a href="#" class="btn btn-mini" id="node-input-show-sli-values" style="margin-top: 4px;"><b>Show Values</b></a>
  30     <input type="hidden" id="node-input-comments">
  31     <a href="#" class="btn btn-mini" id="node-input-btnComments" style="margin-top: 4px;"><b>Add Comments</b></a>
  32     <div id="node-validate-result" class="form-tips" style="float:right;font-size:10px"></div>
  33     </div>
  34     <div class="form-tips">See the Info tab for help using this node.</div>
  35 </script>
  36
  37 <script type="text/x-red" data-help-name="returnSuccess">
  38         <p>A returnSuccess node.</p>
  39         <p>First line of XML must contain opening tag.</p>
  40         <p>Do not include closing tag - it will be automatically generated.</p>
  41
  42 <div class="section">
  43 <h4><a name="Return_node"></a>Return node</h4>
  44 <div class="section">
  45 <h5><a name="Description"></a>Description</h5>
  46 <p>A <b>return</b> node is used to return a status to the invoking MD-SAL application</p></div>
  47 <div class="section">
  48 <h5><a name="Attributes"></a>Attributes</h5>
  49 <table border="1" class="table table-striped">
  50 <tr class="a">
  51 <td align="center"><b>status</b></td>
  52 <td align="left">Status value to return (<i>success</i>)</td></tr></table></div>
  53 <div class="section">
  54 <!--
  55 <h5><a name="Parameters"></a>Parameters</h5>
  56 <p>The following optional parameters may be passed to convey more detailed status information.</p>
  57 <table border="1" class="table table-striped">
  58 <tr class="a">
  59 <td align="center"><b>error-code</b></td>
  60 <td align="left">A brief, usually numeric, code indicating the error condition</td></tr>
  61 <tr class="b">
  62 <td align="center"><b>error-message</b></td>
  63 <td align="left">A more detailed error message</td></tr></table></div>
  64 -->
  65 <div class="section">
  66 <h5><a name="Outcomes"></a>Outcomes</h5>
  67 <p>Not applicable. The <b>status</b> node has no outcomes.</p></div>
  68 <div class="section">
  69 <h5><a name="Example"></a>Example</h5>
  70 <div class="source">
  71 <pre>&lt;return status=&quot;success&quot;&gt;
  72     &lt;parameter name=&quot;uni-circuit-id&quot; value=&quot;$asePort.uni_circuit_id&quot; />
  73 &lt;/return&gt;</pre></div></div></div>
  74
  75 </script>
  76
  77
  78 <script type="text/javascript">
  79
  80     RED.nodes.registerType('returnSuccess',{
  81         color:"#9AE767",
  82         category: 'DGEreturn',
  83         defaults: {
  84             name: {value:"return success"},
  85             xml: {value:"<return status='success'>\n<parameter name='' value='' />\n",required:true},
  86             comments:{value:""}
  87         },
  88         inputs:1,
  89         icon: "arrow-in.png",
  90         label: function() {
  91             return this.name;
  92         },
  93         oneditprepare: function() {
  94
  95
  96              var comments = $( "#node-input-comments").val();
  97              if(comments != null){
  98                 comments = comments.trim();
  99                 if(comments != ''){
 100                         $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
 101                 }
 102              }
 103
 104             function functionDialogResize(ev,ui) {
 105                 $("#node-input-xml-editor").css("height",(ui.size.height-275)+"px");
 106             };
 107
 108             $( "#dialog" ).dialog( "option", "width", 1200 );
 109             $( "#dialog" ).dialog( "option", "height", 750 );
 110             $( "#dialog" ).on("dialogresize", functionDialogResize);
 111             $( "#dialog" ).one("dialogopen", function(ev) {
 112                 var size = $( "#dialog" ).dialog('option','sizeCache-function');
 113                 if (size) {
 114                     functionDialogResize(null,{size:size});
 115                 }
 116             });
 117
 118             /* close dialog when ESC is pressed and released */
 119             $( "#dialog" ).keyup(function(event){
 120                 if(event.which == 27 ) {
 121                         $("#node-dialog-cancel").click();
 122                 }
 123             });
 124
 125
 126             $( "#dialog" ).one("dialogclose", function(ev,ui) {
 127                 var height = $( "#dialog" ).dialog('option','height');
 128                 $( "#dialog" ).off("dialogresize",functionDialogResize);
 129             });
 130
 131             var that = this;
 132             require(["orion/editor/edit"], function(edit) {
 133                 that.editor = edit({
 134                     parent:document.getElementById('node-input-xml-editor'),
 135                     lang:"html",
 136                     contents: $("#node-input-xml").val()
 137                 });
 138                 RED.library.create({
 139                     url:"functions", // where to get the data from
 140                     type:"function", // the type of object the library is for
 141                     editor:that.editor, // the field name the main text body goes to
 142                     fields:['name','outputs']
 143                 });
 144                 $("#node-input-name").focus();
 145                 $("#node-input-validate").click(function(){
 146                                 console.log("validate clicked.");
 147                                 //console.dir(that.editor);
 148                                 //console.log("getText:" + that.editor.getText());
 149                                 var val = that.editor.getText();
 150                                 validateXML(val);
 151                 });
 152                 $("#node-input-show-sli-values").click(function(){
 153                                 console.log("SLIValues clicked.");
 154                                 showValuesBox(that.editor,sliValuesObj);
 155                 });
 156             });
 157             //for click of add comments button
 158             $("#node-input-btnComments").click(function(e){
 159                         showCommentsBox();
 160             });
 161
 162         },
 163         oneditsave: function() {
 164             $("#node-input-xml").val(this.editor.getText());
 165                 var resp=validateXML(this.editor.getText());
 166                 if(resp){
 167                         this.status = {fill:"green",shape:"dot",text:"OK"};
 168                 }else{
 169                         this.status = {fill:"red",shape:"dot",text:"ERROR"};
 170                 }
 171                 delete this.editor;
 172         }
 173     });
 174 </script>