Updating Instance Configuration
This guide will help you update the configuration on an Instance.
Requirements
To follow the steps in this tutorial, you should be able to log in to the Partner Portal, and have an Instance you created or have access to.
Steps
Updating the configuration of an Instance is a two-step process:
Step 1: Locate Instance
In the menu on the left, click on Instances, and select the Instance you would like to update. The information page of the Instance is displayed.
Step 2: Update Instance configuration
Click on Update configuration. Here is the JSON file that stores your configuration information for the Instance, for example, integrations that you have set up. Most of the configuration can be changed through the Partner Portal, but for example, you can configure a test email here.
You are in read-only mode. To modify the JSON configuration file, switch to Edit mode by clicking on Switch to Edit Mode. Edit the JSON file (explore a list of attributes you can edit below), then click on Update Instance configuration.
Example
{
"enable_sms_and_api_workflow_alerts_on_staging": true,
"include_tag_with_private_scope": false,
"maintenance_mode": false,
"test_email": "sales@platform-os.com,developer@platform-os.com,support@platform-os.com",
"timeout_in_minutes": 15
}
Attributes
enable_sms_and_api_workflow_alerts_on_staging
You can enable and disable SMS and API Notifications on staging by changing the value of this attribute. The default value is true so SMS and API Notifications will be actioned. To disable, simply change this value to false.
Default value: true
Example:
"enable_sms_and_api_workflow_alerts_on_staging": true
include_tag_with_private_scope
By default, Liquid variables defined inside a partial leak outside, which means that any variable is a global variable.
We received a lot of requests to improve this, so we changed that behavior and introduced the export tag.
From then on, all newly created Instances have variables scoped to the partials, and this flag is set to true.
We added this flag to keep Instances backward compatible, even if they have been written with the standard Liquid behavior in mind.
We strongly recommend keeping this flag true and migrating your projects to use private scopes to increase predictability.
Default value: true
Example:
"include_tag_with_private_scope": true
maintenance_mode
This setting redirects all incoming requests to the /maintenance path on your Instance, with the HTTP status code 503.
The page contains the message: Temporarily down for maintenance..
Default value: false
Example:
"maintenance_mode": true
test_email
By default, emails on staging are not going to the email recipient defined inside the Email Notification, but to email(s) defined in this attribute.
You can enter multiple emails, comma-separated.
Default value: ""
Example:
"test_email": "sales@platform-os.com,developer@platform-os.com,support@platform-os.com"
timeout_in_minutes
This setting lets you change the duration of a user session. If not set, the default timeout is 1 year. If you want to log out users after 15 minutes of inactivity, set it as shown in the example below.
Default value: 525960 (1 year in minutes)
Example:
"timeout_in_minutes": 15
Deprecated attributes
- test_mode
- skip_action_types_and_pricings
Next steps
Congratulations! You know how to update the configuration of an Instance. Now you can set up a test email or add integrations: