Gateway Deployment Mode Examples

Deployment Mode Examples

The examples below demonstrate how to create deployment modes, override named and singleton resources, and duplicate named resources.

Creating a Deployment Mode

This example demonstrates how to create a deployment mode.

1. Navigate to the Modes page by going to Platform > System > Modes.

   

2. Click on the Create Mode icon. This will open a popup window where you can populate details about your deployment mode.

   

3. Fill out the popup window with details about your deployment mode, including the mandatory name, optional title, and optional description. Once you have finished, click on Create Mode.

   

   note

   Although the title field is optional, we recommend filling out that field with what you want to call your deployment mode. Similar to a project, resource definitions and some Gateway functions may reference the deployment mode name. As a result, it will be safer to change the title if you need to update the name in the future.

4. Your deployment mode will now be ready to use and available to assign resource definitions to.

   

Overriding Named Resources

This example demonstrates how to override a named resource, using device connections.

1. Navigate to the named resource you want to create an override for. In this example, we will be creating an override for a device connection resource, located under Connections > Devices > Connections.

   

2. Assuming you have already created your device connection, go to the resource you want to override. Next, click on the resource's associated three dots menu, and then Create Override.

   

3. A popup window will appear, allowing you to select the collection you want to assign the resource override to. Select your desired deployment mode, then click Create Override.

   

4. By default, the overridden named resource will not appear in the list if your Gateway is not running in the same deployment mode. However, a new banner will appear on the top of the page with a Show All option.

   

5. Clicking Show All will display the overridden named resource, as well as the deployment mode the resource definition belongs to.

   

Overriding Singleton Resources

This example demonstrates how to override a singleton resource, using the Gateway Network Settings page.

1. Navigate to the singleton resource you want to create an override for. In this example, we will be creating an override for the Gateway Network Settings page, located under Network > Gateway Network > Settings.

   

2. On the Gateway Network Settings page, go to the three dots menu on the top right, then click Create Override.

   

   note

   The Create Override option will not be available if you have not yet created any deployment modes.

3. A popup window will appear asking which deployment mode you want to assign the override to. Select your desired deployment mode and then click Create Override.

   

4. A new banner will appear at the top of the page allowing you to toggle between different deployment mode resource overrides. Select the deployment mode you want to configure your settings for. Make any required changes, then click Save Changes on the top right.

   

5. Your resource override will now be available for your specified deployment mode. Toggling between deployment modes will show the property differences between each mode.

   

Duplicating Resource Definitions

This example demonstrates how to duplicate a named resource, using device connections.

1. Navigate to the named resource you want to duplicate. In this example, we will duplicate a device connection resource, located under Connections > Devices > Connections.

   

2. Assuming you have already created your device connection, go to the resource you want to duplicate. Next, click on the resource's associated three dots menu, and then Duplicate.

   

3. A popup window will appear, allowing you to name the duplicated resource and assign it to the collection you want. Fill out these fields, then click Duplicate.

   

4. Your new resource will not be automatically visible if your Gateway is not running in the same deployment mode. If you kept the same name, your duplicated resource will appear in the Connections list if you select Show All on the top right.

   

   If you are using a different name than the original resource definition, your duplicated resource definition will not appear. In order to see the duplicated resource, you will need to either change your Gateway's deployment mode to the same as the duplicated resource, or create a resource with the same name as the duplicate and then click Show All. See the Duplicating Gateway Resources section for more information.