Actions

Difference between revisions of "Commands"

From VersaVision Support

(Created page with "<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''OVERVIEW'''</u></span></div> <BR> Commands are where customized items can be added that add functionality to the system. <BR> <BR> Commands will differ by system. The command can be as simple as adding a value to a table to calculating OEE. <BR> <BR> This page will concentrate on Viewing, Editing, Adding, Duplicating and Deleting a Command. '''NOTE:''' No coding will be discussed/explaine...")
 
Line 24: Line 24:
<span id="EDIT"></span>
<span id="EDIT"></span>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''EDIT A COMMAND'''</u></span></div>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''EDIT A COMMAND'''</u></span></div>
<BR>
'''Step. 1'''
<BR>
<BR>
On the Commands page there will be a list of all the Commands setup in the system. Click on the 3 dot menu in-line with the Command that needs to be Edited.  
On the Commands page there will be a list of all the Commands setup in the system. Click on the 3 dot menu in-line with the Command that needs to be Edited.  
Line 33: Line 31:
</gallery>
</gallery>
----
----
<BR>
'''Step. 2'''
<BR>
<BR>
Select Edit from the pop-up menu.
Select Edit from the pop-up menu.
Line 43: Line 39:
----
----
<BR>
<BR>
'''Step. 3'''
The Edit (SQL or JavaScript) Command window will load.
<BR>
The Edit (SQL or Javascript) Command window will load.
<BR>
<BR>
The Command (SQL or Javascript) will show in the black screen.
The Command (SQL or JavaScript) will show in the black screen.
<BR>
<BR>
<gallery widths=600px heights=165px>
<gallery widths=600px heights=165px>
Line 57: Line 51:
</gallery>
</gallery>
----
----
<BR>
'''Step. 4'''
<BR>
<BR>
Select the Properties button to change the Name, Type and Description.
Select the Properties button to change the Name, Type and Description.
Line 66: Line 58:
</gallery>
</gallery>
----
----
<BR>
'''Step. 5'''
<BR>
<BR>
A Table Command will have a Timeout section in addition to the Name, Type and Description.
A Table Command will have a Timeout section in addition to the Name, Type and Description.
<BR>
<BR>
A Javascript Command will only have the Name, Type and Description.
A JavaScript Command will only have the Name, Type and Description.
<BR>
<BR>
<gallery widths=600px heights=250px>
<gallery widths=600px heights=250px>
Line 81: Line 71:
</gallery>
</gallery>
----
----
'''Step. 6'''
<BR>
<BR>
Close the Properties window by clicking on the "X" in the top right corner of the window.
Close the Properties window by clicking on the "X" in the top right corner of the window.
Line 89: Line 78:
</gallery>
</gallery>
----
----
<BR>
'''Step. 7'''
<BR>
<BR>
Select the Parameters button to change the Name, Type and Description.
Select the Parameters button to change the Name, Type and Description.
Line 99: Line 86:
----
----
<BR>
<BR>
'''Step. 8'''
Parameter Properties will be the same for a Table Command or JavaScript Command.
<BR>
Parameter Properties will be the same for a Table Command or Javascript Command.
<BR>
<BR>
Click in the Name or Description fields to edit.
Click in the Name or Description fields to edit.
Line 111: Line 96:
</gallery>
</gallery>
----
----
<BR>
'''Step. 9'''
<BR>
<BR>
To remove a Parameter, click on the 3 dot menu.
To remove a Parameter, click on the 3 dot menu.
Line 125: Line 108:
</gallery>
</gallery>
----
----
<BR>
'''Step. 10'''
<BR>
<BR>
Click on the Add Parameter button to add a Parameter to the command.
Click on the Add Parameter button to add a Parameter to the command.
Line 134: Line 115:
</gallery>
</gallery>
----
----
<BR>
'''Step. 11'''
<BR>
<BR>
Close the Parameters window by clicking on the "X" in the top right corner of the window.
Close the Parameters window by clicking on the "X" in the top right corner of the window.
Line 143: Line 122:
</gallery>
</gallery>
----
----
<BR>
'''Step. 12'''
<BR>
<BR>
To edit the code for a Command, click in any line or highlight a line. Change, Add or Remove code from the Command. Please ensure important Commands that are operating correctly are not edited as it can cause issues.
To edit the code for a Command, click in any line or highlight a line. Change, Add or Remove code from the Command. Please ensure important Commands that are operating correctly are not edited as it can cause issues.
Line 152: Line 129:
</gallery>
</gallery>
----
----
<BR>
'''Step. 13'''
<BR>
<BR>
Once all of the Edits have been made click on the Save button in the top right corner of the window.
Once all of the Edits have been made click on the Save button in the top right corner of the window.
Line 161: Line 136:
</gallery>
</gallery>
----
----
<BR>
'''Step. 14'''
<BR>
<BR>
To Close the Edit Command window click on the "X" next to the Save button.
To Close the Edit Command window click on the "X" next to the Save button.
Line 170: Line 143:
</gallery>
</gallery>
----
----
<BR>
'''Step. 15'''
<BR>
<BR>
If the Name, Command Type or Description was changed, the changes will be reflected in the Command List.
If the Name, Command Type or Description was changed, the changes will be reflected in the Command List.
Line 185: Line 156:
<span id="DELETE"></span>
<span id="DELETE"></span>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''DELETE A COMMAND'''</u></span></div>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''DELETE A COMMAND'''</u></span></div>
<BR>
'''Step. 1'''
<BR>
<BR>
Click on the 3 dot menu in-line with the Command that needs to be removed.  
Click on the 3 dot menu in-line with the Command that needs to be removed.  
Line 194: Line 163:
</gallery>
</gallery>
----
----
<BR>
'''Step. 2'''
<BR>
<BR>
Select Delete from the pop-up menu.
Select Delete from the pop-up menu.
Line 203: Line 170:
</gallery>
</gallery>
----
----
<BR>
'''Step. 3'''
<BR>
<BR>
The Command will be removed from the system, there will not be any warning.
The Command will be removed from the system, there will not be any warning.
Line 218: Line 183:
<span id="DUPLICATE"></span>
<span id="DUPLICATE"></span>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''DUPLICATE A COMMAND'''</u></span></div>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''DUPLICATE A COMMAND'''</u></span></div>
<BR>
'''Step. 1'''
<BR>
<BR>
Click on the 3 dot menu in-line with the Command that needs to be copied.  
Click on the 3 dot menu in-line with the Command that needs to be copied.  
Line 227: Line 190:
</gallery>
</gallery>
----
----
<BR>
'''Step. 2'''
<BR>
<BR>
Select Duplicate from the pop-up menu.
Select Duplicate from the pop-up menu.
Line 236: Line 197:
</gallery>
</gallery>
----
----
<BR>
'''Step. 3'''
<BR>
<BR>
The Properties window will load. Change the Name of the Command.
The Properties window will load. Change the Name of the Command.
Line 245: Line 204:
</gallery>
</gallery>
----
----
<BR>
'''Step. 4'''
<BR>
<BR>
Click on the "X" in the right corner of the Properties window.
Click on the "X" in the right corner of the Properties window.
Line 254: Line 211:
</gallery>
</gallery>
----
----
<BR>
'''Step. 5'''
<BR>
<BR>
Make any changes any other components of the Command. When all changes have been made, click on the Save button.
Make any changes any other components of the Command. When all changes have been made, click on the Save button.
Line 263: Line 218:
</gallery>
</gallery>
----
----
<BR>
'''Step. 6'''
<BR>
<BR>
Click on the "X" next to the Save button to close the New Command window.
Click on the "X" next to the Save button to close the New Command window.
Line 271: Line 224:
File:Commands-25.png
File:Commands-25.png
</gallery>
</gallery>
<BR>
'''Step. 7'''
<BR>
<BR>
The duplicated Command will show in the Commands list.
The duplicated Command will show in the Commands list.
Line 286: Line 237:
<span id="RUN"></span>
<span id="RUN"></span>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''RUN A COMMAND'''</u></span></div>
<div style="text-align: center;"><span style="color:#0054a6; font-size:150%;"><u>'''RUN A COMMAND'''</u></span></div>
<BR>
'''Step. 1'''
<BR>
<BR>
Click on the Run button in-line with the Command name.  
Click on the Run button in-line with the Command name.  
Line 295: Line 244:
</gallery>
</gallery>
----
----
<BR>
'''Step. 2'''
<BR>
<BR>
A Run window will load requesting any Parameters that were setup for the Command. Enter the appropriate information into the Parameter(s) field(s).
A Run window will load requesting any Parameters that were setup for the Command. Enter the appropriate information into the Parameter(s) field(s).
Line 304: Line 251:
</gallery>
</gallery>
----
----
<BR>
'''Step. 3'''
<BR>
<BR>
Once all Parameters have been addressed, click on the Run button in the bottom right corner of the window.
Once all Parameters have been addressed, click on the Run button in the bottom right corner of the window.
Line 313: Line 258:
</gallery>
</gallery>
----
----
<BR>
'''Step. 4'''
<BR>
<BR>
A Result field will show below the the Parameter field(s). Depending on the type of Command being run, there may not be any result. The total run time will show next to the Run button.
A Result field will show below the the Parameter field(s). Depending on the type of Command being run, there may not be any result. The total run time will show next to the Run button.
<BR>
<BR>
If there are errors in the SQL or Javascript Code, an Error message will appear in the Result field.
If there are errors in the SQL or JavaScript Code, an Error message will appear in the Result field.
<BR>
<BR>
<gallery widths=550px heights=539px>
<gallery widths=550px heights=539px>
Line 324: Line 267:
</gallery>
</gallery>
----
----
<BR>
'''Step. 5'''
<BR>
<BR>
Re-Run the Command by clicking the the Run button a second time. To Close the window click on the "X" in the top right corner of the window.
Re-Run the Command by clicking the the Run button a second time. To Close the window click on the "X" in the top right corner of the window.

Revision as of 16:17, 2 February 2023

OVERVIEW


Commands are where customized items can be added that add functionality to the system.

Commands will differ by system. The command can be as simple as adding a value to a table to calculating OEE.

This page will concentrate on Viewing, Editing, Adding, Duplicating and Deleting a Command. NOTE: No coding will be discussed/explained.


NAVIGATION


Commands can be accessed via the Home page menu or the Commands icon under Applications.


Edit       Delete       Duplicate       Run      


EDIT A COMMAND


On the Commands page there will be a list of all the Commands setup in the system. Click on the 3 dot menu in-line with the Command that needs to be Edited.



Select Edit from the pop-up menu.



The Edit (SQL or JavaScript) Command window will load.
The Command (SQL or JavaScript) will show in the black screen.




Select the Properties button to change the Name, Type and Description.



A Table Command will have a Timeout section in addition to the Name, Type and Description.
A JavaScript Command will only have the Name, Type and Description.




Close the Properties window by clicking on the "X" in the top right corner of the window.



Select the Parameters button to change the Name, Type and Description.



Parameter Properties will be the same for a Table Command or JavaScript Command.
Click in the Name or Description fields to edit.
Click on the down arrow in the Type field to change.



To remove a Parameter, click on the 3 dot menu.
Select Delete from the pop-up menu.



Click on the Add Parameter button to add a Parameter to the command.



Close the Parameters window by clicking on the "X" in the top right corner of the window.



To edit the code for a Command, click in any line or highlight a line. Change, Add or Remove code from the Command. Please ensure important Commands that are operating correctly are not edited as it can cause issues.



Once all of the Edits have been made click on the Save button in the top right corner of the window.



To Close the Edit Command window click on the "X" next to the Save button.



If the Name, Command Type or Description was changed, the changes will be reflected in the Command List.


Edit       Delete       Duplicate       Run      


DELETE A COMMAND


Click on the 3 dot menu in-line with the Command that needs to be removed.



Select Delete from the pop-up menu.



The Command will be removed from the system, there will not be any warning.


Edit       Delete       Duplicate       Run      


DUPLICATE A COMMAND


Click on the 3 dot menu in-line with the Command that needs to be copied.



Select Duplicate from the pop-up menu.



The Properties window will load. Change the Name of the Command.



Click on the "X" in the right corner of the Properties window.



Make any changes any other components of the Command. When all changes have been made, click on the Save button.



Click on the "X" next to the Save button to close the New Command window.


The duplicated Command will show in the Commands list.


Edit       Delete       Duplicate       Run      


RUN A COMMAND


Click on the Run button in-line with the Command name.



A Run window will load requesting any Parameters that were setup for the Command. Enter the appropriate information into the Parameter(s) field(s).



Once all Parameters have been addressed, click on the Run button in the bottom right corner of the window.



A Result field will show below the the Parameter field(s). Depending on the type of Command being run, there may not be any result. The total run time will show next to the Run button.
If there are errors in the SQL or JavaScript Code, an Error message will appear in the Result field.



Re-Run the Command by clicking the the Run button a second time. To Close the window click on the "X" in the top right corner of the window.


VC Footer.png
Follow Us On LinkedIn View our Blog