Table of Contents
Create
Click “+ Add Code” from the to open the “Create New Service or Library” modal.
This allows you to use the code libraries to build code. Give the code service a one-word name for the system to refer to and click Create.
Code Editor
Add code to the window to run
Pick code libraries to use in your code (log is added by default). Make sure to choose the clearblade library to interact with the ClearBlade platform
Save and Test Parameters
Edit test parameters
Save and Test code and the results will then appear
Turn the log toggle on to keep track of the code results
Debugging
To debug your code service, ClearBlade provides as simple, but flexible logging facility1. Make sure the log toggle is on2. When you create/edit your code service, you can embed log() calls in strategic places to monitor execution progress3. You can then run/test the code service. This window should pop up after the service executes: 4. There will be a list of logs starting with the most recent one to go back to5. Finally, when you have finished you debugging and your service is working perfectly, You can turn off logging by switching the toggle.You do not have to remove the logs from the code. They just become noop statements.
Trigger Pane
Add Trigger
Click on “+ Add Trigger”
Enter a name
Choose whether to enable or disable the trigger
Select a source and action
Click “Create Trigger” when done.
See Trigger Source for a list of sources and actions.
Update Trigger
The only items that can be updated in the trigger are: - Whether to enable/disable the trigger - The items that appear after “Action” (such as a collection)
Click “Update Trigger” after making the edit.
Delete Trigger
Click “Delete” on the right of the trigger and click “confirm” when prompted.
Timers Page/Pane
Timers can be created on the Timers page (inside of a system) or the Timers pane (on the Code Service Page).
Add the timer information and click “Create Timer” when you are finished. The timer should be listed in the “Timers” page.
Click on the timer to make updates (you cannot update the name). Make sure to save changes by clicking “Update Timer” in the window.
Click on “Topic” to copy the timer topic path.
To delete, click on “Delete” on the right of the timer.
Enable/Disable Triggers/Timers
There is an option available to disable triggers and timers in the editing modal of both handlers. It will display ‘Enabled’ or ‘Disabled’ under each timer/trigger.
Webhooks
Click ‘+ Add Webhook’ to add a new webhook. Enter the information in the modal and click ‘Create’. The webhook should appear in the list.
The webhook can be deleted by clicking ‘Delete’ to the right of it.
Clicking on the webhook will allow you to update the description and auth method in the modal. Click ‘Update’ to update the webhook.
Copy the link to execute the webhook in a service.
Delete, Discard, and Save
Click “Delete Service” and a prompt will appear to verify deletion.
Click “Discard Changes” to delete changes you made in the session. It will take you back to the homepage without a confirmation prompt.
Click “Save” to save changes made to the service.
Libraries
Create library
Click “+ Add Code” from the to open the “Create New Service or Library” modal.
Switch to the “Library” button . Give the library a one word name or the system to refer to and a description and click Create.
Library Code Page
Just like code services, you can write your own code. The difference is you can turn it in to a library to be able to use in code services.
You can also add other libraries to your library. Note: Do not add the current library to itself.
Library Appearance
Your new code library will appear at the top in bold in your code service library list.
Each library is “required” from a service itself. Some libraries are not listed by default and need to be added. Libraries that are added later in the list will override earlier ones if they have conflicts.