Schedule Documents & Diagrams Generation
Cloudockit generates documents, reports and diagrams for your environment, therefore, you no longer need to do it manually.
Once you start using the product, the next step is to schedule the document generation. You will no longer need to visit the Cloudockit website and manually trigger the document generation.
Cloudockit supports two different methods to schedule your generation:
- ‘Online’ Automation : You trigger the document generation by calling Cloudockit API and we do the generation for you.
- ‘On Prem’ Automation : You install a Windows Application named Cloudockit Desktop which does the document generation locally on your server
Let’s have a look at these two options in detail.
When using Online Automation, Cloudockit will automatically setup a RunBook in your Azure Subscription that will automatically call Cloudockit API to generate the documents for you. We built it this way (this is not Cloudockit that is calling your Azure environment) as we do not persist anything on Cloudockit environments that could allow us to connect to your environment on a scheduled basis. This is really key to us for security reasons of course.
To use these settings, you first need to log into Cloudockit and select a subscription.
- Currently, this automation mode only supports one subscription generation. You can select multiple subscriptions to appear in the same word document but you cannot start different processes with different settings for different subscriptions
- As the document generation is done on the Cloudockit environment, there is a limit on the number of Online Automation Profiles you can create. If you want more Online Automation Profiles, you can use the Windows Application described in the following section or buy more Online Automation Profiles
Once you select the subscription, set the settings you want to use to generate the document. Typically you will set the email where the content should be sent and set the appropriate filters and options.
Once you have set the settings, click on Automation and you will see the following options :
You are asked to enter the name of what we call an Automation Profile, which is basically a Schedule and the day you want the document generation to happen.
When you click on Start Automation, you will see the following options:
- Use an existing automation account:
- Cloudockit can re-use one of your existing Automation Account in Azure and just create a new RunBook for Cloudockit Schedule
- Create a new automation account:
- Cloudockit will create a new Automation Account and create a RunBook inside this newly created account. When you select this option, you will see that there are some pre-requisites like having the permissions to create a Resource Group
- Just give me a Powershell script:
- Cloudockit will give you a Powershell script which you will trigger yourself. The powershell script is basically the same as the one started in the Automation Account for the 2 previous options.
On Prem Automation – Cloudockit Desktop
With On-Premise Automation Profiles, you leverage the Cloudockit Desktop application on one of your servers and schedule the document generation.
The setup is a two step process:
Step 1 : Create Automation Profiles using the On Prem Automation tab
When you click on the On Prem Automation tab, you will be able to create a new On-Premise Automation Profile :
When clicking on Create a new Automation Profile, it will automatically take your current settings and save them as a Profile.
For On-Premise automation, Cloudockit gives you the ability to select multiple subscriptions. For each subscription you will be able to override settings like the email where you want to send the documents to and the storage you would like to use:
Once you have created your Automation Profiles, you are ready for the next step and schedule those profiles.
Step 2 : Install Cloudockit Desktop and choose the Automation Profile that you want to schedule
First, contact us at firstname.lastname@example.org to get Cloudockit Desktop.
You will receive a simple standard MSI. Once installed, enter your product key to associate it to your account.
Then, click on New Schedule in the tool and select the Automation Profile you would like to schedule. If you do not see an automation profile, please be sure that the Product Key you used for the Windows Application Tool and for the WebSite matches.
As you can see, when you select an Automation Profile, it will automatically retrieve the settings of the profile. Everything related to Authentication and Security is empty because this is NOT stored at Cloudockit : you will have to manually enter the authentication keys (refer to the Tool Guide for more details about the setup). Those keys will be stored locally on your server and will never be shared.
Once you enter your keys and click Sign In, Cloudockit will test the Authentication and will ask you to Test or Schedule the document generation.
When you choose to schedule the document generation, it will display the Windows Scheduler as the tool simply creates a Windows Scheduled Task to trigger the process:
We hope you enjoyed this article and we strongly encourage you to schedule your document generation as this is a lot easier to manage.
As always, feedback is greatly appreciated.