Altair SmartWorks SDK composition
Altair SmartWorks SDK is composed of:
SDK engine
Altair SmartWorks SDK engine is based on Java technology. It’s goal is to execute Groovy scripts in a user context. It provides those main functionalities:
- Communication protocol implementation between the engine and the listeners
-
Security
- Execution time
- Memory consumption
- Libraries encapsulation
- Entity visibility delimitation through Altair SmartWorks Authentication service. Each user will only see own data
- Build a context for each execution
Communication protocol
Communication between a listener event’s dispatchers and Altair SmartWorks SDK engine follows a REST API approach. Internally coded in JSON format, the protocol has two main parts:
- Request composed by the context and the code be executed
-
Response composed by:
- Code: 200 (OK) or 4004 (error)
- Message: response message
- Details: more response details
This structure can be seen in Altair SmartWorks console response.
Sentence example in Terminal
Libraries
Altair SmartWorks SDK provides support for standard Groovy libraries.
For example:
Refer to http://docs.groovy-lang.org/latest/html/gapi/ for more information about Groovy API
Altair SmartWorks SDK API is completed with its own set of libraries divided in two main parts:
- Altair SmartWorks core entities management: com.altair.sc
- Altair SmartWorks utility classes: com.altair.sc.utils