2 Copyright 2013 IBM Corp.
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
8 http://www.apache.org/licenses/LICENSE-2.0
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.
17 <script type="text/x-red" data-template-name="configure">
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">
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>
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>
34 <div class="form-tips">See the Info tab for help using this node.</div>
37 <script type="text/x-red" data-help-name="configure">
38 <p>A configure 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>
44 <h3><a name="Device_Management"></a>Device Management</h3>
46 <h4><a name="Configure_node"></a>Configure node</h4>
48 <h5><a name="Description"></a>Description</h5>
49 <p>A <b>configure</b> node is used to configure a device.</p></div>
51 <h5><a name="Attributes"></a>Attributes</h5>
52 <table border="1" class="table table-striped">
54 <td align="center"><b>plugin</b></td>
55 <td align="left">Fully qualified Java class of resource adaptor to be used</td></tr>
57 <td align="center"><b>activate</b></td>
58 <td align="left">Activate device/interface, for devices that support a separate activation step.</td></tr>
60 <td align="center"><b>key</b></td>
61 <td align="left">SQL-like string specifying criteria for item to configure</td></tr></table></div>
63 <h5><a name="Parameters"></a>Parameters</h5>
64 <p>Specific to device adaptor.</p></div>
66 <h5><a name="Outcomes"></a>Outcomes</h5>
67 <table border="1" class="table table-striped">
69 <td align="center"><b>success</b></td>
70 <td align="left">Device successfully configured</td></tr>
72 <td align="center"><b>not-found</b></td>
73 <td align="left">Element to be configured does not exist.</td></tr>
75 <td align="center"><b>not-ready</b></td>
76 <td align="left">Element is not in a state where it can be configured/activated</td></tr>
78 <td align="center"><b>already-active</b></td>
79 <td align="left">Attempt to activate element that is already active</td></tr>
81 <td align="center"><b>failure</b></td>
82 <td align="left">Configure failed for some other reason</td></tr></table></div>
84 <h5><a name="Example"></a>Example</h5>
86 <pre><configure adaptor="org.openecomp.sdnc.sli.adaptor.emt.EmtAdaptor"
87 key="$uni-circuit-id" activate="true">
88 <parameter name="circuit.id" value="$uni-circuit-id" />
89 <parameter name="subscriber.name" value="$subscriber-name" />
90 <parameter name="emt.clli" value="$edge-device-clli" />
91 <parameter name="port.tagging" value="$port-tagging" />
92 <parameter name="port.mediaSpeed" value="$media-speed" />
93 <parameter name="location.state" value="$uni-location-state" />
94 <parameter name="location.city" value="$uni-location-city" />
95 <parameter name="cosCategory" value="$cos-category" />
96 <parameter name="gosProfile" value="$gos-profile" />
97 <parameter name="lldp" value="$asePort.resource-lldp" />
98 <parameter name="mtu" value="$asePort.resource-mtu" />
99 <outcome value="success">
101 <record plugin="org.openecomp.sdnc.sli.recording.FileRecorder">
102 <parameter name="file" value="/tmp/gamma_r1.log" />
103 <parameter name="field1" value="__TIMESTAMP__"/>
104 <parameter name="field2" value="ACTIVE"/>
105 <parameter name="field3" value="$uni-circuit-id"/>
107 <return status="success">
108 <parameter name="edge-device-clli" value="$asePort.resource-emt-clli" />
112 <outcome value="already-active">
113 <return status="failure">
114 <parameter name="error-code" value="1590" />
115 <parameter name="error-message" value="Port already active" />
118 <outcome value="Other">
119 <return status="failure">
120 <parameter name="error-code" value="1542" />
121 <parameter name="error-message" value="Activation failure" />
124 </configure></pre></div></div></div></div>
129 <script type="text/javascript">
130 RED.nodes.registerType('configure',{
132 category: 'DGElogic',
134 name: {value:"configure"},
135 xml: {value:"<configure adaptor='' key='' activate='' >\n"},
141 icon: "arrow-in.png",
145 oneditprepare: function() {
146 $( "#node-input-outputs" ).spinner({
150 var comments = $( "#node-input-comments").val();
151 if(comments != null){
152 comments = comments.trim();
154 $("#node-input-btnComments").html("<span style='color:blue;'><b>View Comments</b></span>");
159 function functionDialogResize(ev,ui) {
160 $("#node-input-xml-editor").css("height",(ui.size.height-275)+"px");
163 $( "#dialog" ).dialog( "option", "width", 1200 );
164 $( "#dialog" ).dialog( "option", "height", 750 );
165 $( "#dialog" ).on("dialogresize", functionDialogResize);
166 $( "#dialog" ).one("dialogopen", function(ev) {
167 var size = $( "#dialog" ).dialog('option','sizeCache-function');
169 functionDialogResize(null,{size:size});
173 /* close dialog when ESC is pressed and released */
174 $( "#dialog" ).keyup(function(event){
175 if(event.which == 27 ) {
176 $("#node-dialog-cancel").click();
180 $( "#dialog" ).one("dialogclose", function(ev,ui) {
181 var height = $( "#dialog" ).dialog('option','height');
182 $( "#dialog" ).off("dialogresize",functionDialogResize);
185 require(["orion/editor/edit"], function(edit) {
187 parent:document.getElementById('node-input-xml-editor'),
189 contents: $("#node-input-xml").val()
192 url:"functions", // where to get the data from
193 type:"function", // the type of object the library is for
194 editor:that.editor, // the field name the main text body goes to
195 fields:['name','outputs']
197 $("#node-input-name").focus();
198 $("#node-input-validate").click(function(){
199 console.log("validate clicked.");
200 //console.dir(that.editor);
201 //console.log("getText:" + that.editor.getText());
202 var val = that.editor.getText();
205 $("#node-input-show-sli-values").click(function(){
206 console.log("SLIValues clicked.");
207 showValuesBox(that.editor,sliValuesObj);
211 //for click of add comments button
212 $("#node-input-btnComments").click(function(e){
216 oneditsave: function() {
217 $("#node-input-xml").val(this.editor.getText());
218 var resp=validateXML(this.editor.getText());
220 this.status = {fill:"green",shape:"dot",text:"OK"};
222 this.status = {fill:"red",shape:"dot",text:"ERROR"};