SCRIPTS INTRODUCTION

Scripts Overview

CDESK provides a possibility to create your own scripts to automate certain processes in your everyday life. These scripts are working separately from CDESK and use API to obtain data and send it back, so they can be run from any computer, server, or cloud service.

We provide you some example scripts that come in two different variations:

• Dockerized CDESK Python scripts
• CDESK Scripts using Azure services to run

Any of these two methods can be chosen to implement your own scenario, but generally Azure service scripts are better to be smaller for easier maintenance, if you do not have a lot of experience with cloud services like this. On the other hand, Python scripts are more flexible, since they are easier to test, setup and manage. Also, if they run on local machine or server, they can be considered free as they do not have any price for their uptime or number of API calls made compared to most cloud services. However, they also require some programming knowledge and basics of the work with Docker. Therefore, it is up to you and your situation to choose which variant is the most suitable.

Dockerized CDESK Python scripts

Dockerized CDESK scripts will require Docker installed on your computer. What you will need most is Docker CLI (cmd, Bash, sh, etc.), Docker Desktop GUI is a good addition if you are not very familiar with Docker. Installation manual and links can be found on the official site.

Also, it is recommended to install Python for local development, so the scripts can be tested without a Docker container creation.

Before starting with scripts, it is recommended to set up a Support CDESK scripts app that is used to display script logs and manually start already existing scripts. This app will not use Docker but run on the local machine instead. Due to security reasons and technical complications, this app is not a part of CDESK app and cannot be accessed from outside, so access will be limited to the PC/server this app is running on. It is recommended to have this application for easier scripts management, but they will work without it as well.

CDESK Scripts using Azure

To run CDESK scripts in Azure you will have to have some understanding of the services it provides. For simple scenarios, where there will be not many API calls done and no complex data processing is included, you can use Azure logic apps (see this manual for more information about logic apps). If there are more complex scenarios to be done, you should consider other services to implement them. For example, Azure Container Instance or Function App can be used to host bigger scripts with multiple source code files, API calls and more complex data processing.

Where to find certain data in CDESK

zne scenáre si určite vyžiadajú informácie o ID objektov CDESK na ich vytváranie alebo úpravu. Na získanie objektov podľa vašich potrieb budete musieť použiť SB filtre. Tieto údaje nie je ťažké nájsť a jedinou podmienkou je prístup do vášho CDESK.

Object ID

Object ID is not an information that will be commonly used outside of development. Therefore, it is not displayed on each object. To find it, you should go to the target object (request, fill, company, user, etc.) and look for id in the url.

Object filter ‘sb’

This filter is commonly used in CDESK with many different objects, including requests, fills, deals, tasks and many others. To get access to sb filters, you should add a related ACL permission to the account that will be able to access them. To do this, log in to CDESK as your local administrator, go to Users and groups -> Users in the left menu / tiles, and select the user you want to add debug tools permission to.

Then, go to Permissions, and find Developer tools in the ACL list. Turn it on for this user and save changes.

Now, you should be able to see red button DEBUG, that will show/hide currently applied sb filter. If you can’t see it, press the button Show advanced search.

It is created as a json object containing fields and filters applied to them. This json is then encoded in a base64 format and used in GET API calls.