OrgGlobalSettings Documentation

Overview

The OrgGlobalSettings component is part of the Vantage analytics and data platform that allows organization administrators to manage settings related to cross-company sharing of resources such as workflows and dashboards within their organization. This component provides a user interface to enable or disable sharing capabilities and configure sharing rules between different companies.

Purpose

The primary purpose of the OrgGlobalSettings component is to provide administrators with the ability to control which companies can share their resources with each other. This helps to create a collaborative environment while ensuring that sensitive information is only shared with applicable parties.

Settings

The component has several configurable settings. Below are detailed explanations for each setting available in OrgGlobalSettings:

1. Sharing Workflows Enabled

• Name: sharing_workflows_enabled
• Input Type: Boolean (toggle switch)
• Description: This setting enables or disables the ability for companies to share workflows with one another within the organization. When enabled, administrators can define sharing rules specifying which companies can share workflows.
• Default Value: false

2. Sharing Workflows Rules

• Name: workflow_sharing_rules
• Input Type: Object
• Description: This setting maintains the sharing rules for workflows. Each key represents a source company ID, and the value is an array of target company IDs that are allowed to share workflows with the source company. Modifying this setting affects which companies can share workflows.
• Default Value: {} (empty object)

3. Sharing Dashboards Enabled

• Name: sharing_dashboards_enabled
• Input Type: Boolean (toggle switch)
• Description: This setting enables or disables the ability for companies to share dashboards with other companies in the organization. Similar to workflow sharing, enabling this allows administrators to specify sharing rules for dashboards.
• Default Value: false

4. Sharing Dashboards Rules

• Name: dashboard_sharing_rules
• Input Type: Object
• Description: This setting holds the sharing rules for dashboards. Like workflow sharing rules, it contains keys for each source company ID and values as an array of target company IDs that are allowed to share dashboards with the source company. It directly impacts which dashboards can be shared and accessed by other companies.
• Default Value: {} (empty object)

Data Input Expectations

The OrgGlobalSettings component communicates with a back-end API to fetch and save settings and uses a structure that expects specific information when making requests:

• For fetching settings, the API expects no additional data as it returns the current settings and company list.
• For saving updates (/api/organization/settings), the expected body format is a JSON object structured as follows:
  jsonCopy

  {
      "settings": {
          "sharing_workflows_enabled": true,
          "workflow_sharing_rules": { "companyId1": ["companyId2"], ... },
          "sharing_dashboards_enabled": true,
          "dashboard_sharing_rules": { "companyId1": ["companyId3"], ... }
      }
  }

AI Integrations and Billing Impacts

While the OrgGlobalSettings does not directly specify AI integrations or billing impacts in the provided code, the following considerations apply:

• AI Integrations: If the platform uses AI to provide insights or automates sharing rules, enabling sharing options could enhance AI model effectiveness by broadening the dataset available for analysis.
• Billing Impacts: Enabling sharing may indirectly influence billing if the usage metrics are based on the number of resources shared or the number of companies engaged in sharing. Administrators should monitor their configurations to align with organizational goals and budgeting.

Use Cases & Examples

Use Case 1: Inter-Company Workflow Collaboration

An organization comprising multiple companies wants to facilitate collaboration between different teams that operate independently. They can enable workflow sharing to allow teams to share automated processes and best practices.

Use Case 2: Consolidated Dashboard Insights

A data analytics team is tasked with providing insights from multiple companies under the same organization. By enabling dashboard sharing, the team can create consolidated views of respective company performance metrics.

Example Configuration

Use Case: Inter-Company Workflow Collaboration

In this scenario, the organization consists of three companies: A, B, and C. The organization has decided that company A should be able to share workflows with companies B and C.

The configuration for the OrgGlobalSettings would look like this:

{
    "settings": {
        "sharing_workflows_enabled": true,
        "workflow_sharing_rules": {
            "companyA": ["companyB", "companyC"],
            "companyB": [],
            "companyC": []
        },
        "sharing_dashboards_enabled": false,
        "dashboard_sharing_rules": {}
    }
}

In this configuration:

• sharing_workflows_enabled is set to true, thus allowing workflow sharing.
• workflow_sharing_rules specifies that company A can share workflows with B and C.
• Dashboard sharing is disabled as indicated by sharing_dashboards_enabled set to false.

This setup facilitates streamlined operations between companies while restricting non-relevant sharing of dashboards.