Commands

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.

No coding will be discussed/explained, contact VersaCall Support for assistance.

NAVIGATION

---

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

  Edit  |  Delete  |  Duplicate  |  Run  |  Export  

                    Return to Advanced                    

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 ellipsis 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  |  Export  

                    Return to Advanced                    

DELETE A COMMAND

---

Click on the 3 dot ellipsis 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  |  Export  

                    Return to Advanced                    

COPY A COMMAND

---

Click on the 3 dot ellipsis 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  |  Export  

                    Return to Advanced                    

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.

  Edit  |  Delete  |  Duplicate  |  Run  |  Export  

                    Return to Advanced                    

EXPORT A SINGLE COMMAND

---

Click on the 3 dot ellipsis in-line with the Command that needs to be exported.

---

Select Export from the menu.

---

In most browsers, the user will see a Download pop-up in the top right corner of the window.

The name of the downloaded file (Command Name.json) will display.

---

File will be available in the location that has been setup to receive Downloaded files from the Web Browser.

For our example, the file was downloaded to the Downloads folder.

  Edit  |  Delete  |  Duplicate  |  Run  |  Export  

                    Return to Advanced                    

---