Skip to content

Settings page

The Settings page in BizzStream Aero allows administrators to define custom, environment-specific configurations. While the Environment tab provides a set of essential default settings, this dedicated Settings page enables the addition of fields unique to your organization's operational requirements, such as a company-wide URL used across various processes. Once these custom settings are defined, they can be easily accessed programmatically throughout your environment using the SETTINGS pointer within system expressions. It can also be accessed using the actionInfo object when using scripts.

When to Use the Settings Page

You should use the Settings page when:

  • Initial Setup: Configuring essential organizational details that are specific to an environment but aren't available in the general Environment tab. This includes common fields like a primary website URL or additional branding elements such as multiple company logos.
  • Centralized Management: If you need a centralized location to manage environment-specific configurations (e.g., URLs, API keys, or feature toggles) that might change frequently or need to be easily accessible for modification without requiring code deployments. This streamlines updating configurations across the application.

How to Set Up the Settings Page

To start utilizing the Settings page for your configurations, you'll need to follow these initial setup steps:

  1. Navigate to the Setup Section.
  2. Click Environment in the left-hand menu to open the Environment page. (For more details, see Configuring Environments - BizzStream Aero Documentation).
  3. Add the document definition and the layout you've created to the Settings Document Definition and Settings Layout fields.
  4. Click on Save.

Configuring Settings

To configure the settings within your newly defined layout:

  1. Go to Setup Section
  2. Click on Settings in the left-hand menu.
  3. Enter the desired values in the fields you created.
  4. Click on Save

Using settings

Settings can be used in two ways:

  1. Via the actionInfo object in scripts
  2. Via the environment settings system expression

Example: Setting up Basic Company Information

Let's walk through an example of how to add a new setting, such as a company tagline, to your BizzStream Aero application.

  1. Update the Document Definition:
    • Go to the document definition that you are using for your settings (e.g., the one named "settings").
    • Add a new field to this document definition. For our example, we add a field named companyTagline with a data type of "Text".
    • Save the document definition.
  2. Update the Layout:
    • Navigate to the layout that is currently being used for your settings page.
    • Drag the field you just created (companyTagline) to the desired location within this layout.
    • Save the layout.
  3. Fill in the Value on the Settings Page:
    • Go to the Settings page in your BizzStream Aero application.
    • You should now see the newly added field for companyTagline.
    • Fill in the value you want to add, for instance, "Innovation at its Core."
    • Save the settings.

This new companyTagline setting can be dynamically accessed throughout your BizzStream Aero application using {{SETTING["companyTagline"]}}, allowing you to display this tagline in various places without hardcoding it. This process demonstrates the flexibility of the Settings page for managing diverse application configurations.

Security

When working with settings, especially those containing sensitive information, it's crucial to prioritize security. BizzStream sometimes automatically filters fields including "password". You need to consider the risks of adding certain fields and make sure you're using the correct fields when handling secure information. More general information about security can be found in the security documentation.