In order to make use of the CloudSET Framework it is first necessary to install and register for use as part of your Zendesk instance.
The CloudSET Framework Installer App can be located and installed from within the Zendesk App Marketplace.
Once invoked, the installation process includes all steps necessary to register your Zendesk account for the use of CloudSET services.
Install the CloudSET Framework App from the Zendesk App Market Place
Bring up the Admin panel (1) and Browse the App marketplace (2).
Search for the CloudSET App (3) and select the CloudSET Framework Installer App (4) in the returned results to kick off the installation process.
A Zendesk Marketplace information page will be presented from where it is possible to review a high level description of the CloudSETFramework.
Select the Install App button (1) to continue with the next step of the installation process.
Once invoked the installation procedure will present a form requesting specific configuration parameters for the App and outlining summary installation instructions.
It is recommended that under normal circumstances the CloudSET Framework is restricted for use by users of your account with full Admin rights.
Check the box (1) to bring up a list of Roles and chose either Administrator, Agent or both as required (2), then select the Install button (3).
Confirm the Presence of the CloudSET Framework Installation App
If successful the CloudSET Framework Installer App (3) should be present within the list of installed applications for your Zendesk account.
The CloudSET Framework sidebar icon (4) should also appear on the page (*note: it might be necessary to refresh the page before the icon appears).
Select the CloudSET Framework sidebar icon (4) to invoke the registration process.
A disclaimer is displayed relinquishing Zendesk from certain responsibilities for the CloudSET Framework.
This is due to the nature of the CloudSET Framework which includes a number of Apps and other tools and components that are not under the control of Zendesk.
However, rest assured that all CloudSET Apps and tools are under the control and responsibility of Coherence Design Ltd. under the terms and conditions agreed in the following registration process.
Select the Agree and Continue Deploy button (1) to continue with the registration procedure.
Please read the Terms and Conditions and confirm acceptance (2), then select the Continue button (3) to proceed to the next stage of the registration process.
Enter the appropriate values in the fields on the form (1) presented for each stage of the registration process following the instructions (2).
There are 6 stages involved in the registration process (3) and all stages must be completed.
Select the Continue button (4) once all fields on a form have been entered to move onto the next stage.
The final stage of the registration process requires the confirmation of access credentials that will be used when CloudSET Apps communicate with Zendesk via the Web Service API.
These services can only be used by a current and fully verified Administrator of the Zendesk account and so the Administrator performing the registration process is assumed (1).
See the next step for instructions for enabling and identifying the API Token (2).
Select the Register Now button (3) to complete the registration process.
*Note: If the administration rights are removed from the registered user (2), the password expires, or the API Token is regenerated then it will be necessary to re-register with CloudSET using a current Administrator and API Token (see Updating the CloudSET Registration Details).
Locate the API Token
Select the Admin side bar icon (1) in your target Zendesk instance and then select API from the list of Channels presented (2) to display the API token.
For security reasons existing API tokens are no longer visible from within the UI so it isn't possible to copy and past an existing token.
However, if you've stored the values elsewhere then any of the existing API tokens can be used for CloudSRT Services.
If you haven't saved a copy of the existing tokens then it will be necessary to create a new API token for use with CloudSET Services by selecting the add new token link (4), copy the generated token (5) and following the instructions.
*Note: it might be necessary to enable the Token Access (3) and save the page (6) in order to generate the API token.
The page above is displayed once the CloudSET registration process has completed successfully, after which it is necessary to select the Finish button (1) for the installation and registration to take full effect.
Now when selecting the CloudSET Framework sidebar icon (1), which when selected should bring up the CloudSET Services sub page (2).
Note: it will not be possible deploy and configure Apps or Widgets, create Configurations or use Tools until a subscription plan has been chosen and purchased (see Purchasing CloudSET Capabilities and Services).