Cloud Action Publishing

Cloud Action Publishing lets you create action configurations, and publish them as a secure online service. These make it possible to access the action data, where you can pass values back and forth, through a secure WebAPI.

To access this interface, click the Cloud Action Publishing link in the Your Model tab.

Accessing Cloud Action Publishing.

If the link is greyed out, make sure the intended model is Public and currently Active. More information about this is provided later in this topic.

Click this link to open the main window where you can create a Cloud Action Configuration.

The Cloud Action Publishing API Interface.

A Configuration is a container that enables you to connect externally to KnowledgeKube Configured Actions, which are created using existing model actions. Once the configuration is published, it can be used by anyone who has access to that service's Subscription Key. You can send unique subscription keys to developers by linking them to a chosen configuration, enabling them to gain online access to it.

Before creating a Cloud Action Configuration, you will need to create a Configured Action. Creating a configured action may require you to provide Action Variables, which must match an existing model variable.

Action Variables can be used in three different ways:

  • Input -  This type of variable requires a value in order to perform an action. This value must be provided from outside of the application, like a user name and password.
  • Output - This type of variable returns a value after the Cloud Action API configuration has been called, such as the result of a calculation.
  • Input/Output - This type of variable can be used to both pass values into the action and return them.

The options you select here will determine the actions linked developers can modify in the WebAPI, later on.

Creating action variables.

A configuration can be set to several States:

  • Active - The configuration is ready to use.
  • Active (Pending Synchronisation) - Changes to the configuration have been saved, and will become active shortly.
  • Deactivated - The configuration is no longer active and cannot be used.
  • Deactivated (Synchronising) - The configuration has been successfully deactivated, and will become deactivated shortly.

Accessing the context menu for each configuration in the main Cloud Action Publishing window, will display different options depending on the State of your chosen configuration. For example, if you deactivate one there will be an option for reactivation.

To view a list of all actions in the current model, which can be used in a cloud action configuration, switch to the Published Actions tab in the main window.

List of available actions for an API configuration.

Cloud Action Configuration's can only be used with public, active models. If your model is currently set to Public, and you want it to appear as Private, this will cause existing configurations to appear blank, and you will need to create new ones again.

To learn how to use the Cloud Action Publishing interface, refer to the following topics:

Description Further Reading
Create a new Configured Action for use in a configuration. Creating a Configured Action for Cloud Publishing
Modifying a configured action. Editing a Configured Action
Permanently remove a configured action. Deleting a Configured Action
Create a cloud action configuration. Creating a Cloud Action Configuration
Modify the details of a cloud action configuration. Editing a Cloud Action Configuration
Deactivate a configuration. Deactivating a Cloud Action Configuration
Reactivate a configuration. Reactivating a Cloud Action Configuration
Manage configuration subscription keys Creating a Subscription Key for a Cloud Action Configuration
Regenerate an existing subscription key. Regenerating a Subscription Key for a Cloud Action Configuration
Assign a developer to a chosen configuration. Linking a Developer to a Cloud Action Configuration
Grant specific developers access to a configuration. Granting Access to a Cloud Action Configuration
Permanently remove a subscription key from a configuration. Deleting a Cloud Action Configuration Subscription Key
Download a configuration's OpenAPI file. Downloading the OpenAPI Documentation for a Cloud Action Configuration