JavaScript for SuperOffice enables you to write scripts with javascript, moving away from the traditional CRMscript-language as a whole. The new engine implements everything the netserver has to offer, and the syntax looks familiar to those who has previously used the webapi.
See the JavaScript for SuperOffice: A Paradigm Shift in SuperOffice CRM Customization document to read more about the changes.
See the JavaScript for SuperOffice Online Architecture document to read more about the architecture and flow.
This repo contains basic examples to get started writing scripts, and some helpers to get the proper intellisense in vscode.
- git clone https://github.com/SuperOffice/CRMScriptsV2.git
- Open the terminal and run 'npm run setup'
- Check out the Examples-folder
The scripts still need to be executed inside of SuperOffice!! This means you will have to copy-paste the JS-scripts into the SuperOffice-editor after creation.
VSCODE: To help the editor understand the @types we need to have the import-statement at the top of the file. This line is redundant in the SuperOffice-script, as it s imported by default.
It is also important that you import the extensionMethods as RTL, as that is what the SuperOffice-environment expects.
Lets use CreateContactEntity.js as an example:
import * as RTL from '@superoffice/webapi';
import { context } from '../../../Helpers/logHelper';
//Variables
const name = "NewName";
const agent = new RTL.ContactAgent();
let entity = await agent.createDefaultContactEntityAsync();
entity.name = name;
entity = await agent.saveContactEntityAsync(entity);
context.result.body = JSON.stringify(entity);And this is what you copy-paste into your SuperOffice-Script (without the lines with import):
//Variables
const name = "NewName";
const agent = new RTL.ContactAgent();
let entity = await agent.createDefaultContactEntityAsync();
entity.name = name;
entity = await agent.saveContactEntityAsync(entity);
context.result.body = JSON.stringify(entity);The good old print()/printLine() is now gone, and we need to use 'context.result.body' to print any of the values back into the debug-window. Example:
context.result.body = "foo";Context is the model that contains data (eventData, cgiVariables etc) in the new script.
You can run this to see whats inside the context.
context.result.body = JSON.stringify(context);Javascript is a great language wich has a lot of flexibility. This flexibility also comes with a cost, and some developers dread the idea of not using a stronly typed language. We at SuperOffice want to provide the best experience for all the developers out there, and how you choose to write your javascript is totally up to you! This means you can write typescript and compile that into javascript, or you can write javascript directly. Per today SuperOffice plan to support javascript, as that is what you compile for instance typescript into (to be used). This does NOT mean the door is all the way shut for typescript, and we encourage you as external developers to raise your oppinion in the discussion-board here at the repo!
It is still un-tested in our internal editor (We will keep you posted when we know more), but JSDoc is a good option that is widely used by js-developers. It gives you the possibility to document your code and have some type checking on compiletime, and we are at this point suggesting you try it out and give us feedback on how it works for you. It is available by default in VSCode, and its a good way to make JS feel more strongly typed without having to write something else that gets compiled into JS. We know its not everything for example typescript is, but its a good middle-ground compared to forcing everyone to write typescript (which then needs to be compiled to javascript, which creates both overhead and latency).
So, to sum it up: Write in whatever language/way you want, and put your result-javascript into SuperOffice!
No, this repo only contains a starting-point for you to make your own scripts. We supply an NPM package you can import into any project of your choosing:
URL: https://www.npmjs.com/package/@superoffice/webapi
Command: npm i @superoffice/webapi
As long as you import this package as RTL you should not have any problems.
PS: This NPM package does not contain the class Context, so you can either copy-paste the logHelper.js into your own project or create the class yourself.
How you want to work with CRMScript v2 is up to you, but as per 01.11.2023 there is no intellisense inside the SuperOffice editor, which means that you should make use of the npm-package @superoffice/webapi to get proper intellisense.
Example workflow:
- Open a new folder/project in vscode
- Add npm-package with command 'npm i @superoffice/webapi'
- Create new file, with file-extension .js
- Add import-statement at the top of the file: 'import * as RTL from '@superoffice/webapi';'
- Write your script
- Copy your script and paste it into SuperOffice, without the import-statement in point 4.
- Execute script in SuperOffice and see the result
We are currently discussing the possibility to have a vscode extension that connects to a tenant and have the methods to download/upload scripts. This will simplify the workflow for developers wanting to work in vscode, but we have (for now) only a POC for this.
- 'OLD' CRMScripts will continue to work, but new scripts should be made in javascript.
- This repo only contains examples on how to handle different entities, and will expand as new functionality is created.
- Importing your own NPM-packages are as of 25.09.2023 not supported.
- Only NetServer Classes are currently supported, so trying to use classes from Service (e.g. Ticket t;) or other shenanigans are not working.
Hopefully this shows how would to get writing new Scripts. Got any feedback? Please create an issue on this repo to improve its readability and usefullness!