This article describes the options available in the Admin - System section of Buttonwood Automation, which allows an administrative user to view and manage the system settings.
This page consists of the following tabs:
- Status: Provides system version and update details, as well as the status of enabled plugins
- Configuration: Includes options for system-wide configuration options
- Admin Account: Provides an interface to reset the build-in Admin user's password
- Unsent Notifications: Lists any queued messages which are not yet sent to Buttonwood Central
Prerequisites
- Administration access to the Buttonwood Automation
Access
- Log into Buttonwood Automation as an administrative user
- Navigate to Admin > System
Status
The Status tab provides a summary of system and the status of connected services.
Buttonwood Automation Version
The Buttonwood Automation version and build number is displayed on this tab. In addition, administrative users can check for and apply any Buttonwood Automation or plugin updates from here. Refer to the article Updating Buttonwood Automation for detailed steps.
Connected Services
The Connected Services section provides an overview of the status of connectivity to Buttonwood Automation Services as well as any third party platforms configured via plugins.
Click on any of the plugin names to view the selected plugin's configuration. Refer to the article Managing Plugins for detailed steps.
Configuration
The Configuration tab lists system-wide configuration parameters and is divided into the following three sections:
- General
- Buttonwood Services
- Advanced
General
Lists general parameters, described in the below table.
Setting | Description |
Enforce Strict Blueprint Validation |
Ensures that Blueprints components, including node types, relationships, and values adhere to a defined schema. This option must only be turned off on advice from Buttonwood Support. Default Value: Checked |
Enable Two Factor Authentication |
Enables two factor authentication using supported software tokens (eg. Google Authenticator, Microsoft Authenticator) for login to Buttonwood Automation. Default Value: Unchecked |
Buttonwood Services
Lists configuration parameters for connectivity to Buttonwood Services, listed in the below table.
Setting | Description |
Buttonwood Automation Services URL |
The URL for Buttonwood Automation Services This setting should only be changed on advice from Buttonwood Support. Default Value: https://brokerservices.bcx.buttonwood.net |
Access Key for Automation Services |
Tenant Access Key as provided by the organisation's Buttonwood administrator. Refer to the article Managing Buttonwood Automation Access Keys for steps on managing access keys. |
Secret Key for Automation Services |
Secret Key as provided by the organisation's Buttonwood administrator. Refer to the article Managing Buttonwood Automation Access Keys for steps on managing access keys. |
Advanced
Lists advanced parameters, listed in the table below.
Setting | Description |
Automation Appliance Server URL |
The URL prefix which is used when generating links within notifications. Default Value: https://<appliance_fqdn_or_ip> |
Automation Appliance External IP |
The IP address that this appliance will use when making requests to the internet. Default Value: 127.0.0.1 |
Automation Appliance Nickname |
A friendly name for the appliance |
Delete Orchestrator Guest Scripts |
Specifies whether to remove scripts which are copied to virtual machine instances during deployment orchestration. Default Value: Checked |
Automatically Open Remote Management Ports |
Specifies whether to automatically open remote management ports (eg. SSH, RDP, WinRM over HTTPS) on Broker-managed security groups. Default Value: Checked |
Enable Maintenance Mode for System Updates |
Enters broker into maintenance mode for updates. When in maintenance mode, running jobs are allowed to completed prior to updates starting. Any new requests will be queued until maintenance mode is disabled. Default Value: Unchecked |
Admin Password
The Admin Password tab allows an administrative user to reset the built-in Admin user password.
Refer to the article Admin Account Password Management to view detailed steps for managing different administrator passwords.
Unsent Notifications
The Unsent Notifications tab lists any queued messages which are not yet sent to Buttonwood Exchange. This tab should usually be empty.
The Broker will automatically attempt to resend any unsent notifications and will hold the notification after 10 unsuccessful retries.
Administrators can perform the following actions on unsent notifications:
- View the error for the last attempted transmission
- Request that the notification be resent
- Remove the notification from the queue