How do I create and run CRMScripts?

​

Creating CRMScripts

​

Which editors can I use?

You can use whatever code editor you prefer. For example, Visual Studio Code. You can even use Notepad. However, we recommend using the built-in editor in the SuperOffice admin client. This will give you coding assistance and syntax highlighting. You also have easy access to run and debug the script as you develop it.

​

Running CRMScripts

Pre-requisites:

• An administrator account for the tenant or installation
• A Development Tools (previously Expander Services) license or the Core plan

​

Where does CRMScript run?

You need to run your scripts in an environment that has a CRMScript interpreter. For SuperOffice CRM Online, this is available in the Sales and Service admin clients. In Sales:

1. Open the Admin client by selecting Settings and maintenance from the hamburger menu.
2. Select CRMScript from the left menu.

In Service:

1. Click the cogwheel in the upper-right corner.
2. Click System design and then click CRMScript.

​

How to add a script

1. Click New script.
2. At the Information tab, name your script, add a description.
3. Enter a label to uniquely identify it when included in other scripts.
4. Select the Script tab. Then type or paste your script.
5. Click OK to save and Execute script to run it.

​

How to define which HTTP verbs are allowed

While adding a script it is possible to set allowed HTTP verbs. This is relevant, for instance, when creating a Custom REST endpoint and this property applies only when a script is executed via:

• blogic.fcgi?action=doScript
• customer.fcgi?action=safeParse or customer.fcgi?action=printBin

This gives you finer control over script execution and improves overall security.

​

How do I get a sandbox?

You need to register as a developer to get access to our online development environment. This signs you up for a developer user account and creates a test tenant in the SuperOffice Online Development (SOD) environment.