Both sides previous revisionPrevious revisionNext revision | Previous revision |
resources:tools-software:sigmastudiov2:usingsigmastudio:scripting [24 Jun 2020 11:01] – Krithika Manchale | resources:tools-software:sigmastudiov2:usingsigmastudio:scripting [15 Mar 2024 11:42] (current) – [SigmaStudio+ Scripting] Arpit Arora |
---|
| [[resources/tools-software/sigmastudiov2/usingsigmastudio|Click here to return back]] |
| |
====== SigmaStudio+ Scripting====== | ====== SigmaStudio+ Scripting====== |
| |
As a startup guide, this page simply introduces to the Scripting functionality supported by SigmaStudio+ Application This uses Apache Thrift and RPC protocol in order to connect to the server application(SS+). | As a startup guide, this page simply introduces to the Scripting functionality supported by SigmaStudio+ Application. This uses Apache Thrift and RPC protocol in order to connect to the server application(SS+). |
An example solution(i.e., CSharp client in this case) is also given along with the package to make the user understand basic actions that are available for Scripting. | An example (i.e., CSharp client/Python) is also given along with the package to make the user understand basic actions that are available for Scripting. Refer to [[:resources:tools-software:sigmastudiov2:tutorials:remoteexecute|Remote Execute]] for detailed example for client application. |
Available actions for SigmaStudio scripting: | |
| Available actions for SigmaStudio+ scripting: |
\\ | \\ |
| |
- [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updateproperties|UpdateProperties]] | - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updateproperties|UpdateProperties]] |
- [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getallplugins|GetAllPlugins]] | - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getallplugins|GetAllPlugins]] |
- [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getavailablecanvaselements|GetAvailableCanvasElements]] | - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getavailablecanvaselements|GetAvailableCanvas]] |
- [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getelementsinsidecanvas|GetElementsInsideCanvas]] | - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getelementsinsidecanvas|GetCanvasElements]] |
- [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getproperties|GetProperties]] | - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getproperties|GetProperties]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/export|Export]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/import|Import]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getpluginproperties|GetPluginProperties]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updatebooleanproperty|UpdateBooleanProperty]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updatenumericproperty|UpdateNumericProperty]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updatestringproperty|UpdateStringProperty]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updatelistproperty|UpdateListProperty]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/exportpreset|ExportPreset]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/importpreset|ImportPreset]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/execute|Execute]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/read|Read]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/loadshape|LoadShape]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/saveshape|SaveShape]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getcapture|GetCaptureViewEntries]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/clearcapture|ClearCaptureViewEntries]] |
| - [[resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/updatelabel|UpdateLabel]] |
\\ | \\ |
====== Scripting.Thrift====== | ==== Scripting.Thrift==== |
| |
This file is given out for the user to generate files in a specific language with the help of commands as given in Apache thrift startup guide. | This file is given out for the user to generate files in a specific language with the help of commands as given in Apache thrift startup guide [[https://thrift.apache.org/tutorial/]]. |
\\ | \\ |
| |
====== Getting started with example solution====== | |
| |
The example client solution lets the user verify all the actions in simple steps.\\ | |
1. Choose the action to perform(by entering the serial number given against any action)\\ | |
2. Under each of the action chosen, the console application displays every step involved to achieve full result.\\ | |
3. If the user has access to UI, all the steps can be observed on the SigmaStudio application UI.\\ | |
4. Press enter after each step to go onto the execution of the next step. \\ | |
5. Result/Error can be observed instantly on the console application.\\ | |
6. A message, “Would you like to continue? Y/N ” appears on the app once the chosen action is successfully completed.\\ | |
| |