Knowledge Base

You are here:

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 three different methods to schedule your generation:

  • Cloudockit Desktop: You install a Windows Application named Cloudockit Desktop which does the document generation locally on your server
  • Cloudockit API: You call a REST endpoint to start your document generation
  • Cloudockit Website: Cloudockit will automatically create all the resources in your Subscription to schedule the document generation

Those 3 options are available from the Settings menu of Cloudockit:

Let’s have a look at these three options in detail.

Cloudockit Website

With this option, Cloudockit will automatically setup a component (Runbook in your Azure Subscription – Lambda function in your AWS Account) 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 key to us for security reasons of course.

To use these settings, you first need to log into Cloudockit and select a subscription.

Note : As the document generation is done on the Cloudockit environment, there is a limit on the number of Automation that you can create

Here are the steps to schedule a Document Generation with this option:

  • First, Login to Cloudockit and then select a Subscription/Account. Please refer to this link for more details on how to do that : https://www.cloudockit.com/knowledge-base/getting-started/
  • Once you select the subscription, set the settings you want to use to generate the document. Typically, you will set the email where the end-of-scan notification should be sent and the appropriate filters and options.

Once you have set the settings, click on Scheduling, and under the Cloudockit Website section, select Add new schedule and you will see the following options:

  • Use an existing automation account:
    • Cloudockit can re-use one of your existing Automation Account/AWS Lambda Function in Azure and just create a new Runbook/Function for Cloudockit Schedule
  • Create a new automation account:
    • Cloudockit will create a new Azure Automation Account/AWS Lambda Function 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
  • Use 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.

Cloudockit API

Using Cloudockit API allows you to automate document generation using your own conditions, specifications and integrate Cloudockit in your processes and applications.

Please refer to this link for more information about using Cloudockit API: https://www.cloudockit.com/knowledge-base/cloudockit-api/

Cloudockit Desktop

With Cloudockit Desktop, you get the exact same features as the Cloudockit SaaS version, the only difference is that Cloudockit desktop executes locally in your environment. You can install the software on any Windows environment; it can be in your workstation, a virtual machine hosted in your on-premises environment or hosted in your preferred cloud provider like Microsoft Azure, AWS or Google Cloud Platform.

Please refer to this link for more information about using Cloudockit Desktop: https://generate.cloudockit.com/WinUIGuide/Guide.pdf

Table of Contents