Wiki

This version is outdated by a newer approved version.DiffThis version (24 Jun 2020 08:54) is a draft.
Approvals: 0/1

This is an old revision of the document!


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+). 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. Available actions for SigmaStudio scripting:

1 list<string> CreateNewPorject(1: string projectName)
2 list<string> SaveProject(1: string filePath)
3 list<string> OpenExistingProject(1: string filePath)
4 list<string> AddShape(1: string parentUid, 2: string shapeFullName, 3: Position newPosition)
5 list<string> RemoveShape(1: string parentUid, 2: string shapeUid)
6 list<string> AddConnection(1: string parentUid, 2: string channelFullName, 3: string sourceUid, 4:string targetUid, 5: string sourcePinType, 6: string targetPinType, 7: string sourcePinName, 8: string targetPinName)
7 list<string> RemoveConnection(1: string parentUid, 2: string channelUid, 3: string linkUid)
8 list<string> MoveShape(1: string shapeUid, 2: Position newPosition)
9 list<string> RotateShape(1: string shapeUid, 2: Position newPosition, 3: double newAngle)
10 list<string> ResizeShape(1: string shapeUid, 2: Position newPosition, 3: Size newSize)
11 list<string> Link()
12 list<string> LinkCompileConnect()
13 list<string> LinkCompileDownload()
14 list<string> UpdateProperties(1: string elementUid, 2: string propertyName, 3: string propertyType, 4: string propertyValue) 15 list<string> GetAllPlugins(1: string interfaceType) 16 list<string> GetAvailableCanvasElements() 17 list<string> GetElementsInsideCanvas(1: string parentUid) 18 list<string> GetProperties(1: string elementUid)

SdkScripting.Thrift file

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.  

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.

resources/tools-software/sigmastudiov2/usingsigmastudio/scripting.1592981677.txt.gz · Last modified: 24 Jun 2020 08:54 by John Joseph