UCC Framework

https://github.com/splunk/addonfactory-ucc-generator
Admin
UCC (Universal Configuration Console) is a Splunk Add-on SDK that provides a build and code...
Tokens:117,271
Snippets:1,159
Trust Score:9.4
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Complete package.json Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_test_ui_command.md

Example of a complete package.json file if you followed the UI Sub-Project Setup Guide.

```json
{
  "name": "ui",
  "private": true,
  "version": "0.0.0",
  "type": "module",
  "scripts": {
    "build": "ucc-gen-ui ta_name=Splunk_TA_Name init_file_dir=src/ucc-ui.ts",
    "ucc-test": "test-ucc-ui"
  },
  "dependencies": {
    "@splunk/add-on-ucc-framework": "^5.65.0",
    "@splunk/react-ui": "^4.42.0",
    "@splunk/splunk-utils": "^3.1.0",
    "@splunk/themes": "^0.23.0",
    "react": "16.14.0",
    "react-dom": "16.14.0"
  },
  "devDependencies": {
    "@eslint/js": "^9.20.0",
    "@types/node": "^22.13.1",
    "@types/react": "16.14.62",
    "@types/react-dom": "16.9.25",
    "typescript": "^5.8.2"
  },
  "overrides": {
    "react": "16.14.0",
    "react-dom": "16.14.0",
    "@types/react": "16.14.62",
    "@types/react-dom": "16.9.25"
  },
  "engines": {
    "node": ">=22",
    "npm": ">=10"
  }
}
```

--------------------------------

### Create component files

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Bash commands to create the directory and files for a custom tab component.

```bash
mkdir ./src/ucc-ui-extensions/AdvancedInputsTab
touch ./src/ucc-ui-extensions/AdvancedInputsTab/index.tsx
touch ./src/ucc-ui-extensions/AdvancedInputsTab/AdvancedInputsTab.tsx
```

--------------------------------

### Initialize the UI Sub-Project

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Run the following commands to create a new Node.js project and configure TypeScript.

```bash
npm init -y
npm install --save-dev typescript
npx tsc --init
```

--------------------------------

### Create and activate virtual environment (Windows)

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Commands to create and activate a Python virtual environment on Windows.

```bash
python3 -m venv .venv
.venv\Scripts\activate.bat
```

```powershell
.venv\Scripts\activate.ps1
```

--------------------------------

### Package the add-on

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Command to package the Splunk add-on using the ucc-gen tool.

```bash
ucc-gen package --path output/demo_addon_for_splunk
```

--------------------------------

### Build the add-on

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Command to build the Splunk add-on using the ucc-gen tool.

```bash
ucc-gen build --source demo_addon_for_splunk/package --ta-version 1.0.0
```

--------------------------------

### Initialize a new add-on

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Command to initialize a new Splunk add-on using the ucc-gen tool.

```bash
ucc-gen init --addon-name "demo_addon_for_splunk" --addon-display-name "Demo Add-on for Splunk" --addon-input-name demo_input
```

--------------------------------

### Install UCC package

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Command to install the Splunk Add-on Builder (UCC) package using pip.

```bash
pip install splunk-add-on-ucc-framework
```

--------------------------------

### Create project structure and entry file

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Bash commands to create the 'src' directory, the entry file 'ucc-ui.ts', and the 'ucc-ui-extensions' directory.

```bash
mkdir src
touch ./src/ucc-ui.ts
mkdir ./src/ucc-ui-extensions
```

--------------------------------

### build_ui.sh

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Bash script to install npm dependencies and build the UI for the Splunk Add-on.

```bash
# !/bin/bash

# Determine the directory of the script

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

# Check if npm is installed

if ! command -v node &> /dev/null
then
    echo "Node.JS is not installed. Please install Node.JS to continue."
    exit 1
fi

if [ "$CI" = "true" ]; then
    npm --prefix "$SCRIPT_DIR/../ui" ci
else
    npm --prefix "$SCRIPT_DIR/../ui" install
fi

npm --prefix "$SCRIPT_DIR/../ui" run build
```

--------------------------------

### Create and activate virtual environment (macOS, Linux)

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/quickstart.md

Commands to create and activate a Python virtual environment on macOS and Linux.

```bash
python3 -m venv .venv
source .venv/bin/activate
```

--------------------------------

### additional_packaging.py

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Python script to handle additional packaging steps, including executing a UI build script.

```python
import os
from os import path


def additional_packaging(addon_name: str) -> None:
    build_ui_script = os.path.join(
        os.path.dirname(os.path.realpath(**file**)), "scripts", "build_ui.sh"
    )
    if path.exists(build_ui_script):
        os.system(f"chmod +x {build_ui_script}")
        return_code = os.system(build_ui_script)
        if return_code != 0:
            os._exit(os.WEXITSTATUS(return_code))
```

--------------------------------

### JSON Examples Configuration

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_search_commands.md

Defines the search command examples displayed in the search assistant.

```json
"examples": [
    {
        "search": "generatetextcommand count=5 text=\"Hallo There\"",
        "comment": "Generates 5 \"Hallo There\" events enumerated starting by 1"
    }
]
```

--------------------------------

### Setup Task

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Executes the setup task for the project, which is a prerequisite for all other tasks.

```bash
yarn run setup
```

--------------------------------

### Global Config Options Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/options/index.md

Example of the options object within globalConfig.

```json
{
  "...": "...",
  "options": {
    "restHandlers": {...}
  }
}
```

--------------------------------

### Install and authenticate GitHub CLI

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Use Homebrew to install the GitHub CLI and authenticate your session.

```bash
brew install gh
gh auth login
```

--------------------------------

### ucc-ui.ts entry file

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Initial TypeScript code for the 'ucc-ui.ts' entry file, initializing the UCC framework.

```typescript
import { uccInit } from "@splunk/add-on-ucc-framework";

uccInit().catch((error) => {
  console.error("Could not load UCC", error);
});
```

--------------------------------

### package.json configuration

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Recommended contents for the package.json file, including dependencies and scripts for building the UI sub-project. Note: Update 'Splunk_TA_Name' in the 'scripts' section.

```json
{
  "name": "ui",
  "private": true,
  "version": "0.0.0",
  "type": "module",
  "scripts": {
    "build": "ucc-gen-ui ta_name=Splunk_TA_Name init_file_dir=src/ucc-ui.ts"
  },
  "dependencies": {
    "@splunk/add-on-ucc-framework": "^5.65.0",
    "@splunk/react-ui": "^4.42.0",
    "@splunk/splunk-utils": "^3.1.0",
    "@splunk/themes": "^0.23.0",
    "react": "16.14.0",
    "react-dom": "16.14.0"
  },
  "devDependencies": {
    "@eslint/js": "^9.20.0",
    "@types/node": "^22.13.1",
    "@types/react": "16.14.62",
    "@types/react-dom": "16.9.25",
    "typescript": "^5.8.2"
  },
  "overrides": {
    "react": "16.14.0",
    "react-dom": "16.14.0",
    "@types/react": "16.14.62",
    "@types/react-dom": "16.9.25"
  },
  "engines": {
    "node": ">=22",
    "npm": ">=10"
  }
}
```

--------------------------------

### Example arguments configuration

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_search_commands.md

A JSON configuration example demonstrating how to define arguments with required fields, default values, and various validation types such as Integer, Fieldname, and Float.

```json
"arguments": [
    {
        "name": "count",
        "required": true,
        "validate": {
            "type": "Integer",
            "minimum": 1,
            "maximum": 10
        },
        "default": 5
    },
    {
        "name": "test",
        "required": true,
        "validate": {
            "type": "Fieldname"
        }
    },
    {
        "name": "percent",
        "validate": {
            "type": "Float",
            "minimum": "85.5"
        }

    }
]
```

--------------------------------

### Configuration Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/oauth_support.md

Example JSON configuration demonstrating various authentication methods including OAuth.

```json
"configuration": {
    "title": "Configurations",
    "description": "Configure your servers and templates.",
    "tabs": [
        {
            "name": "account",
            "title": "Account",
            "entity": [
                {
                    "field": "name",
                    "label": "Name",
                    "type": "text",
                    "required": true,
                    "help": "Enter a unique name for each Crowdstrike falcon host account."
                },
                {
                    "type": "oauth",
                    "field": "oauth",
                    "label": "Not used",
                    "options": {
                        "auth_type": [
                            "basic",
                            "oauth",
                            "oauth_client_credentials",
                            "additional_authorization_method"
                        ],
                        "basic": [
                            {
                                "label": "User Name",
                                "field": "username",
                                "help": "Enter Account name."
                            },
                            {
                                "label": "Password",
                                "field": "password",
                                "encrypted": true,
                                "help": "Enter Password."
                            },
                            {
                                "label": "Securtiy Token",
                                "field": "security_token",
                                "encrypted": true,
                                "help": "Enter Security Token."
                            }
                        ],
                        "oauth": [
                            {
                                "label": "Client Id",
                                "field": "client_id",
                                "help": "Enter Client Id."
                            },
                            {
                                "label": "Client Secret",
                                "field": "client_secret",
                                "encrypted": true,
                                "help": "Enter Client Secret."
                            },
                            {
                                "label": "Redirect url",
                                "field": "redirect_url",
                                "help": "Please add this redirect URL in your app."
                            },
                            {
                                "label": "Scope",
                                "field": "scope",
                                "help": "Enter the scope for the authorization code with ',' separating each scope.",
                                "required": false
                            },
                            {
                                "label": "Endpoint",
                                "field": "endpoint",
                                "help": "Enter Endpoint"
                            }
                        ],
                        "oauth_client_credentials": [
                            {
                                "label": "Client Id",
                                "field": "client_id_oauth_credentials",
                                "help": "Enter Client Id."
                            },
                            {
                                "label": "Client Secret",
                                "field": "client_secret_oauth_credentials",
                                "encrypted": true,
                                "help": "Enter Client Secret."
                            },
                            {
                                "label": "Scope",
                                "field": "scope",
                                "help": "Enter the scope for the authorization code with ',' separating each scope.",
                                "required": false
                            },
                            {
                                "label": "Endpoint",
                                "field": "endpoint_token_oauth_credentials",
                                "help": "Enter Endpoint"
                            }
                        ],
                        "additional_authorization_method": [
                            {
                                "label": "Username",
                                "field": "additional_username",
                                "help": "Additional Authorization method "
                            },
                            {
                                "label": "Certificate",
                                "field": "additional_method_certificate",
                                "encrypted": true,
                                "help": "Enter Certificate"

```

--------------------------------

### Run quick start script

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Builds the backend, frontend, and spins up the Docker container in one step.

```bash
./scripts/quick_start_ui.sh
```

--------------------------------

### Installation

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/README.md

Install the UCC framework using npm or yarn.

```bash
npm install --save @splunk/add-on-ucc-framework
# or
yarn add @splunk/add-on-ucc-framework
```

--------------------------------

### Get a logger for a specific add-on using solnlib

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/ucc_related_libraries.md

Example of how to get a logger for a specific add-on using the solnlib library.

```python
import logging

from solnlib import log


def logger_for_input(input_name: str) -> logging.Logger:
    return log.Logs().get_logger(f"<add-on name>_{input_name}")
```

--------------------------------

### OAuth Configuration Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/oauth_support.md

An example of how to configure OAuth settings within the addon factory.

```json
{
    "label": "Securtiy Token(Optional)",
    "field": "additional_authorization_param",
    "encrypted": true,
    "help": "Security Token (Optional)."
}
],
"auth_label": "Auth Type",
"oauth_popup_width": 600,
"oauth_popup_height": 600,
"oauth_timeout": 180,
"auth_code_endpoint": "/services/oauth2/authorize",
"access_token_endpoint": "/services/oauth2/token",
"auth_endpoint_token_access_type": "offline"
}
}
],
}
```

--------------------------------

### Configuration JSON Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/configurations/index.md

This JSON example demonstrates how to define a configuration page with different tab types, including account, proxy, and logging tabs. It also shows how to specify capabilities.

```json
"configuration": {
    "title": "Configuration",
    "description": "Set up your add-on",
    "tabs": [
        {
            "name": "account",
            "title": "Account",
            "table": {},
            "entity": []
        },
        {
            "type": "proxyTab",
             "warning": {
                "config": {
                    "message": "Some warning message"
                }
            },
            "proxy_type": true,
            "username": true,
            "password": true,
            "dns_resolution": true
        },
        {
            "type": "loggingTab"
        }
    ],
    "capabilities": {
        "put": "admin_all_objects",
        "post": "list_storage_passwords"
    }
}
```

--------------------------------

### Remote PDB Setup

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/troubleshooting.md

Steps to set up remote_pdb for debugging Python code in a locally installed Splunk instance.

```python
import remote_pdb; remote_pdb.RemotePdb(host="0.0.0.0", port=4444).set_trace()
```

--------------------------------

### Lazy loading example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/overview.md

Example of how to implement lazy loading for React components.

```javascript
const CustomDateInput = React.lazy(() => import("./DateInput"));
```

--------------------------------

### tsconfig.json configuration

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Recommended contents for the tsconfig.json file to ensure compatibility with TypeScript, React, and the UCC framework.

```json
{
  "compilerOptions": {
    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    "jsx": "react", /* Specify what JSX code is generated. */
    
    /* Modules */
    "module": "commonjs", /* Specify what module code is generated. */
    "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */

    /* Emit */
    "noEmit": true, /* Disable emitting files from a compilation. */
    
    /* Interop Constraints */
    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
    
    /* Type Checking */
    "strict": true, /* Enable all strict type-checking options. */
    "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
    "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
    "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
    
    /* Completeness */
    "skipLibCheck": true /* Skip type checking all .d.ts files. */
  }
}
```

--------------------------------

### Updated ucc-ui.ts with custom component

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

Modified 'ucc-ui.ts' file to include the custom 'AdvancedInputsTab' component in the UCC initialization.

```typescript
import { uccInit } from "@splunk/add-on-ucc-framework";
import AdvancedInputsTabClass from "./ucc-ui-extensions/AdvancedInputsTab";

uccInit({
  AdvancedInputsTab: {
    component: AdvancedInputsTabClass,
    type: "tab",
  },
}).catch((error) => {
  console.error("Could not load UCC", error);
});
```

--------------------------------

### Proxy Configuration Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/configurations/proxy.md

An example of a proxy configuration in JSON format.

```json
{
   "type": "proxyTab",
   "name": "custom_proxy",
   "warning": {
        "config": {
        "message": "Some warning message"
        }
    },
   "port": {
       "label": "Proxy port",
       "validators": [
           {
               "type": "number",
               "range": [
                   1025,
                   65535
               ],
               "isInteger": true
           }
       ]
   },
   "username": true,
   "password": {
       "label": "Password for Proxy"
   },
   "dns_resolution": false,
}
```

--------------------------------

### Example additional_packaging.py

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/additional_packaging.md

This example demonstrates the implementation of both `cleanup_output_files` and `additional_packaging` functions within the `additional_packaging.py` file.

```python
--8<-- "tests/testdata/test_addons/package_global_config_everything/additional_packaging.py"
```

--------------------------------

### Usage Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_hook_context.md

An example of how to configure custom hook context for data inputs.

```json
{
  "inputs": {
    "title": "Inputs",
    "description": "Manage your data inputs",
    "services": [
      {
        "name": "example_input_one",
        "title": "Example Input One",
        "hook": {
          "src": "input_hook",
          "type": "external"
        },
        "entity": []
      }
    ]
  }
}
```

--------------------------------

### Help Link Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a help link component.

```json
{
    "field": "example_help_link",
    "label": "",
    "type": "helpLink",
    "options": {
        "text": "Help Link",
        "link": "https://docs.splunk.com/Documentation"
    }
}
```

--------------------------------

### Start Verdaccio Server

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Command to start a local Verdaccio registry server.

```bash
npx verdaccio
```

--------------------------------

### Install TA Dependencies

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Install dependencies using Poetry and export them to the required requirements.txt file within the TA package directory.

```bash
# These variables would be used in the further steps
ta_repo=/path/to/ta
ta_name=TA_Name_From_app.manifest

poetry install --directory=$ta_repo

mkdir -p $ta_repo/package/lib

# Export dependencies to 'requirements.txt'
poetry export --without-hashes -o $ta_repo/package/lib/requirements.txt --directory $ta_repo
```

--------------------------------

### Table Configuration Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/table.md

This JSON object demonstrates how to configure the table, including headers, more info fields, and available actions.

```json
"table": {
    "header": [
        {
            "label": "Name",
            "field": "name"
        },
        {
            "label": "Account",
            "field": "account"
        },
        {
            "label": "Input Type",
            "field": "serviceTitle"
        },
        {
            "label": "Input Service",
            "field": "serviceName"
        },
        {
            "label": "Status",
            "field": "disabled"
        }
    ],
    "moreInfo": [
        {
            "label": "Name",
            "field": "name"
        },
        {
            "label": "Interval",
            "field": "interval"
        },
        {
            "label": "Index",
            "field": "index"
        },
        {
            "label": "Status",
            "field": "disabled",
            "mapping": {
                "true": "Disabled",
                "false": "Enabled"
            }
        },
        {
            "label": "Example Account",
            "field": "account"
        }
    ],
    "actions": ["edit", "delete", "clone"]
}
```

--------------------------------

### Global Configuration Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/inputs/index.md

This snippet shows the structure of the global configuration for inputs, presented in JSON format.

```json
--8<-- "ui/src/pages/Input/stories/globalConfig.json"
```

--------------------------------

### Testing Configuration Pages Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_test_ui_command.md

Example of using renderConfigurationPage() to test configuration pages.

```typescript
import { screen, waitForElementToBeRemoved } from "@testing-library/react";
import { it, expect } from "vitest";
import userEvent from "@testing-library/user-event";

import { getGlobalConfig } from "./utils";
import AdvancedInputsTabClass from "../ucc-ui-extensions/AdvancedInputsTab";
import DateInputClass from "../ucc-ui-extensions/DateInput";

it("Should open account addition form", async () => {
  mockResponse();
  
  renderConfigurationPage(getGlobalConfig(), {
    DateInput: {
      component: DateInputClass,
      type: "control",
    },
    AdvancedInputsTab: {
      component: AdvancedInputsTabClass,
      type: "tab",
    },
  });

  // Wait for page to load
  await waitForElementToBeRemoved(() => screen.getByText("Waiting"));

  // Check if page elements are present
  expect(screen.getByText("Configuration")).toBeInTheDocument();
  expect(await screen.findByText("Mocked Account name")).toBeInTheDocument();
  
  // Test clicking the Add button
  const addButton = screen.getByRole("button", { name: "Add" });
  expect(addButton).toBeInTheDocument();
  
  await userEvent.click(addButton);
  expect(await screen.findByText("Add Accounts")).toBeInTheDocument();
});
```

--------------------------------

### Custom Menu JavaScript Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/whats_new.md

Example JavaScript code for a custom menu component.

```javascript
class CustomMenu {

    /**
    * Custom Menu
    * @constructor
    * @param {Object} globalConfig - Global configuration.
    * @param {element} el - The element of the custom menu.
    * @param {function} setValue - set value of the custom field.
    */
    constructor(globalConfig, el, setValue) {
        this.globalConfig = globalConfig;
        this.el = el;
        this.setValue = setValue;
        this.services = {};
    }

    render() {
        this.el.innerHTML = '<button type="button">Click Me! I am a button for custom menu</button>'
        this.el.onclick = () => {
            this.setValue({
                service: "example_input_one" // The value of service can be the name of any services, specified in the globalConfig file.
            })
        }
    }
}
export default CustomMenu;
```

--------------------------------

### Requirements File Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/requirements.md

An example of a typical requirements.txt file for a Splunk add-on.

```text
splunktaucclib
splunk-sdk
solnlib
requests>=2.25.0
pyyaml
cryptography

```

--------------------------------

### Adaptive Response Example in globalConfig

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/alert_actions/adaptive_response.md

An example of how to configure adaptive response properties within the globalConfig of an add-on.

```json
{
    "alerts": [
        {
            "name": "test_alert",
            "label": "Test Alert",
            "description": "Description for test Alert Action",
            "iconFileName": "test icon.png",
            "adaptiveResponse": {
                "task": [
                    "Create",
                    "Update"
                ],
                "supportsAdhoc": true,
                "supportsCloud": true,
                "subject": [
                    "endpoint"
                ],
                "category": [
                    "Information Conveyance",
                    "Information Portrayal"
                ],
                "technology": [
                    {
                        "version": [
                            "1.0.0"
                        ],
                        "product": "Test Incident Update",
                        "vendor": "Splunk"
                    }
                ],
                "drilldownUri": "search?q=search%20index%3D\"_internal\"&earliest=0&latest=",
                "sourcetype": "test:incident"
            },
            "entity": [ "..." ]
        }
    ]
}
```

--------------------------------

### File Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a file component, demonstrating various options and validators.

```json
{
    "type": "file",
    "label": "SA certificate",
    "help": "Upload service account's certificate",
    "field": "service_account",
    "options": {
        "fileSupportMessage": "Support message",
        "supportedFileTypes": ["pem", "txt"],
        "maxFileSize": 100,
        "useBase64Encoding": false
    },
    "validators": [
        {
            "type": "regex",
            "pattern": "(-----BEGIN CERTIFICATE-----(\\n|\\r|\\r\\n)([0-9a-zA-Z\\+\/=]{64}(\\n|\\r|\\r\\n))*([0-9a-zA-Z\\+\/=]{1,63}(\\n|\\r|\\r\\n))?-----END CERTIFICATE-----)"
        }
    ],
    "encrypted": true,
    "required": true
}
```

--------------------------------

### Previous Custom Menu Configuration

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/whats_new.md

Example of the previous configuration for a custom menu component.

```json
{
  "inputs": {
    "title": "Inputs",
    "description": "Manage your data inputs",
    "services": [],
    "table": {
      "actions": ["edit", "delete", "clone"],
      "header": [],
      "moreInfo": []
    },
    "menu": {
      "src": "custom_menu",
      "type": "external"
    }
  }
}
```

--------------------------------

### Multiple Select Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a multiple select component.

```json
{
    "type": "multipleSelect",
    "field": "test_multiselect",
    "label": "Test Multiselect",
    "options": {
        "delimiter": "|",
        "items": [
            {
                "value": "option_a",
                "label": "Option A"
            },
            {
                "value": "option_b",
                "label": "Option B"
            }
        ]
    }
}
```

--------------------------------

### Help Message Usage Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/help_message.md

This JSON example demonstrates how to use the help message property, including text with newlines and link references.

```json
{
  "field": "url",
  "label": "URL",
  "type": "text",
  "help": {
    "text": "Enter the URL, for example \n you can use https://splunk.github.io/addonfactory-ucc-generator/ \n also see [[docs_link]] for more reference",
    "links":[{
      "slug": "docs_link",
      "link": "https://splunk.github.io/addonfactory-ucc-generator/",
      "linkText": "reference"
    }]
  },
  "required": true
}
```

--------------------------------

### Proxy Tab Usage Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/configurations/proxy.md

Example of how to include the proxyTab component within the pages.configuration.tabs array in a globalConfig file.

```json
{
    "pages": {
        "configuration": {
            "tabs": [
              {
                "type": "proxyTab"
              }
            ],
            "title": "Configuration",
            "description": "..."
        }
    }
}
```

--------------------------------

### Exclude File Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/requirements.md

An example of an exclude.txt file to remove unwanted packages.

```text
# Exclude packages shipped with Splunk
urllib3
certifi

setuptools # Exclude setuptools

```

--------------------------------

### Install Package from Verdaccio

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Commands to install the published package from the local Verdaccio registry into a TA repository.

```bash
npm install @splunk/add-on-ucc-framework@latest --registry http://localhost:4873
# or
yarn add @splunk/add-on-ucc-framework@latest --registry http://localhost:4873
```

--------------------------------

### Serve documentation locally

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Use this command to preview documentation changes. The script automatically manages a virtual environment.

```bash
python3 mkdocs.py serve -a localhost:8001
```

--------------------------------

### Run Splunk container

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Starts a containerized Splunk Enterprise instance using the provided script.

```bash
./scripts/run_splunk.sh
```

--------------------------------

### Sub Description Usage Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/sub_description.md

This JSON example demonstrates how to configure the subDescription property, including text with newline characters and links.

```json
{
  "name": "example_input_one",
  "title": "Example Input One",
  "entity": [],
  "subDescription": {
    "text": "Ingesting data from to Splunk Cloud?\nRead our [[blogPost]] to learn more about Data Manager and it's availability on your Splunk Cloud instance.",
    "links": [
      {
        "slug": "blogPost",
        "link": "https://splk.it/31oy2b2",
        "linkText": "blog post"
      }
    ]
  }
}
```

--------------------------------

### Global Configuration for Dashboard

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/dashboard.md

Example of how to include a 'dashboard' page in the globalConfig file for an add-on.

```json
{
    "pages": {
        "configuration": {
            "tabs": [
                ...
            ],
            "title": "Configuration",
            "description": "Set up your add-on"
        },
        "inputs": {
            "services": [
                ...
            ],
            "title": "Inputs",
            "description": "Manage your data inputs",
            "table": {
                ...
            }
        },
        "dashboard": {
            "panels": [
                {
                    "name": "default"
                }
            ]
        }
    },
    "meta": {
      ...
    }
}
```

--------------------------------

### Install Git LFS (macOS)

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Installs Git Large File Storage (Git LFS) on macOS using Homebrew.

```bash
brew install git-lfs
```

--------------------------------

### Example REST Handler Parameters

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/options/rest_handlers.md

An example JSON object demonstrating how to define parameters for 'create' and 'remove' actions, including different data types and required/optional status.

```json
{
  "create": {
    "param_str_required": {
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    "param_number": {
      "schema": {"type": "number"}
    },
    "param_object": {
      "schema": {
        "type": "object",
        "properties": {
          "key1": {"type": "string"},
          "key2": {"type": "number"}
        }
      }
    }
  },
  "remove": {
    "param_str_2": {
      "schema": {
        "type": "string"
      }
    }
  }
}
```

--------------------------------

### Example of logging functions for error handling

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/dashboard.md

This example showcases various logging functions available in `solnlib.log` for handling different types of exceptions, including custom exceptions, authentication errors, permission errors, connection errors, configuration errors, server errors, and general exceptions. It illustrates the use of mandatory and optional parameters.

```python
from solnlib import log

... 
except MyCustomException as e:
    log.log_exception(logger, e, "my custom error")
except UnauthorisedError as e:
    log.log_authentication_error(logger, e)
except PermissionError as e:
    log.log_permission_error(logger, e, msg_after="test after")
except ConnectionError as e:
    log.log_connection_error(logger, e, msg_before="test before", msg_after="test after")
except AddonConfigurationError as e:
    log.log_configuration_error(logger, e, full_msg=False, msg_before="test before")
except ServiceServerError as e:
    log.log_server_error(logger, e)
except Exception as e:
    log.log_exception(logger, e, "Other")
```

--------------------------------

### Index Entity - All Attributes

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example of an Index entity configuration with all available attributes.

```json
{
    "type": "index",
    "field": "index",
    "label": "Index",
    "help": "An index is a type of data repository. Select the index in which you want to collect the events.",
    "defaultValue": "main",
    "required": true
}
```

--------------------------------

### Text Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a text input field, including validation rules for string length and pattern matching.

```json
{
    "type": "text",
    "label": "Name",
    "validators": [
        {
            "type": "string",
            "errorMsg": "Length of Name should be between 1 to 50 characters.",
            "minLength": 1,
            "maxLength": 50
        },
        {
            "type": "regex",
            "errorMsg": "Name must begin with a letter and consist exclusively of alphanumeric characters and underscores.",
            "pattern": "^[a-zA-Z]\w*$"
        }
    ],
    "field": "name",
    "help": "Enter a unique name for this account.",
    "required": true
}
```

--------------------------------

### Example of events_ingested function

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/dashboard.md

This example demonstrates how to use the `events_ingested` function from the `solnlib.log` module to record events for the monitoring dashboard. It shows the required positional arguments and an optional named argument.

```python
from solnlib import log


log.events_ingested(
    logger,
    "demo_input://my_input1",
    "my_sourcetype",
    2,
    "my_index",
    account="my_account"
)
```

--------------------------------

### Requirements File Format

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/requirements.md

Examples of the standard pip requirements file format.

```text
# Standard packages
requests>=2.25.0
pyyaml
cryptography==41.0.5

# From VCS
git+https://github.com/user/repo.git@v1.0#egg=package-name

# Local package
./local-package

# Packages with extras
requests[security]

```

--------------------------------

### Initialize Git LFS

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Initializes Git LFS after installation and pulls LFS content.

```bash
git lfs install
git lfs pull
```

--------------------------------

### index.tsx for custom tab component

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_project_init.md

TypeScript code for the 'index.tsx' file of a custom tab component, rendering the component using React.

```typescript
import React from "react";
import ReactDOM from "react-dom";

import { CustomTabBase } from "@splunk/add-on-ucc-framework";

const CustomAdvancedInputsTab = React.lazy(
  () => import("./AdvancedInputsTab.tsx")
);

export default class AdvancedInputsTabClass extends CustomTabBase {
  render(): void {
    ReactDOM.render(
      <React.Suspense fallback={<div></div>}>
        <CustomAdvancedInputsTab />
      </React.Suspense>,
      this.el
    );
  }
}
```

--------------------------------

### Example REST Handler Code for a Modular Input

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/advanced/custom_rest_handler.md

This Python code demonstrates a basic REST handler for a modular input, including field definitions and model setup.

```python
import import_declare_test

from splunktaucclib.rest_handler.endpoint import (
    field,
    validator,
    RestModel,
    DataInputModel,
)
from splunktaucclib.rest_handler import admin_external, util
from splunktaucclib.rest_handler.admin_external import AdminExternalHandler
import logging

util.remove_http_proxy_env_vars()


fields = [
    field.RestField(
        'interval',
        required=True,
        encrypted=False,
        default=None,
        validator=validator.Pattern(
            regex=r"""^\-[1-9]\d*$|^\d*$""", 
        )
    ),  

    field.RestField(
        'disabled',
        required=False,
        validator=None
    )

]
model = RestModel(fields, name=None)



endpoint = DataInputModel(
    'example_input_one',
    model,
)


if __name__ == '__main__':
    logging.getLogger().addHandler(logging.NullHandler())
    admin_external.handle(
        endpoint,
        handler=AdminExternalHandler,
    )

```

--------------------------------

### Date Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the date validator.

```json
{
    "field": "testDate",
    "label": "Test Date",
    "type": "text",
    "validators": [
        {
            "type": "date"
        }
    ]
}
```

--------------------------------

### Example globalConfig.json

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/overview.md

This JSON configuration demonstrates how to define inputs and services, including custom entities with external source types for custom components.

```json
{
  "inputs": {
    "title": "Inputs",
    "description": "Manage your data inputs",
    "services": [
      {
        "name": "example_input_one",
        "title": "Example Input One",
        "hook": {
          "src": "CustomHook",
          "type": "external"
        },
        "entity": [
          {
            "field": "custom_input_field",
            "label": "My Custom Input",
            "type": "custom",
            "options": {
              "src": "CustomInput",
              "type": "external"
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### IPV4 Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the IPV4 validator.

```json
{
    "field": "testIpv4",
    "label": "Test Ipv4",
    "type": "text",
    "validators": [
        {
            "type": "ipv4"
        }
    ]
}
```

--------------------------------

### Start Development Server

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Initiates a server that serves JavaScript bundles from memory and proxies other requests to the target.

```bash
yarn start
```

--------------------------------

### Email Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the email validator.

```json
{
  "type": "text",
  "label": "Email",
  "validators": [
      {
        "type": "email",
      }
  ],
  "field": "email"
}
```

--------------------------------

### URL Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the URL validator.

```json
{
  "type": "text",
  "label": "Url",
  "validators": [
      {
        "type": "url",
      }
  ],
  "field": "url"
}
```

--------------------------------

### Build UI components

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Builds the UI into the ui/dist folder and copies files to the static folder of the UCC.

```bash
./scripts/build_ui.sh
```

--------------------------------

### Date Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a date component.

```json
{
    "type": "date",
    "field": "example_date",
    "label": "Date",
    "required": true
}
```

--------------------------------

### Combined Validators Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example demonstrating how to combine multiple validators in a single array.

```json
{
    "field": "https_url",
    "label": "HTTPS only URL",
    "type": "text",
    "validators": [
        {
            "type": "url"
        },
        {
          "type": "regex",
          "errorMsg": "HTTPS only",
          "pattern": "^https:\/\/"
        }
    ]
}
```

--------------------------------

### Example Configuration for inputHelperModule

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/inputs/helper.md

JSON configuration snippet showing how to specify the 'inputHelperModule' parameter for an input service.

```json
"pages": {
    "inputs": {
        "services": [
            {
                "name": "example_input_one",
                "title": "Example Input",
                "entity": [],
                "inputHelperModule": "my_module"
            }
        ]
    }
},

```

--------------------------------

### Custom UI Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/README.md

Example of a custom UI component using CustomControlBase and TypeScript.

```tsx
import React from "react";
import ReactDOM from "react-dom";
import { CustomControlBase } from "@splunk/add-on-ucc-framework";

export default class MyCustomControl extends CustomControlBase {
  render() {
    ReactDOM.render(
      <input value={this.data.value} />,
      this.el,
    );
  }
}
```

--------------------------------

### Regex Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the regex validator to enforce a specific pattern for a field.

```json
{
  "type": "text",
  "label": "Name",
  "validators": [
      {
        "type": "regex",
        "errorMsg": "Input Name must begin with a letter and consist exclusively of alphanumeric characters and underscores.",
        "pattern": "^[a-zA-Z]\w*$"
      }
  ],
  "field": "name_field"
}
```

--------------------------------

### Component Example: AdvancedCell.tsx

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_cell_context.md

Example of a React component that displays the cell's value.

```typescript
import React from "react";
import { AcceptableFormValueOrNull } from ".";
import { SplunkThemeProvider } from "@splunk/themes";

export const AdvancedCell = ({
  value,
}: {
  value: AcceptableFormValueOrNull;
}) => {
  return (
    <SplunkThemeProvider>
      <div>
        {value === null || value === undefined || value === "" ? (
          <span>No value</span>
        ) : (
          <span>{String(value)}</span>
        )}
      </div>
    </SplunkThemeProvider>
  );
};

export default AdvancedCell;

```

--------------------------------

### Build UCCExample add-on

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Creates a UCCExample add-on for the output directory using the local version of ucc-gen.

```bash
poetry run ucc-gen build --source tests/testdata/test_addons/package_global_config_everything/package
```

--------------------------------

### package.json build command

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/overview.md

Example of how to add a build command to the package.json file for UCC UI generation.

```javascript
module.exports = {
    //...
    "scripts": {
        "build": "ucc-gen-ui ta_name=Splunk_TA_Example init_file_dir=src/ucc-ui.ts",
    },
}
```

--------------------------------

### Example globalConfig.json for custom JS files

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/standard/overview.md

This JSON configuration demonstrates how to specify custom JavaScript files for hooks and input entities within the globalConfig.json file.

```json
{
  "inputs": {
    "title": "Inputs",
    "description": "Manage your data inputs",
    "services": [
      {
        "name": "example_input_one",
        "title": "Example Input One",
        "hook": {
          "src": "CustomHookJSFile",
          "type": "external"
        },
        "entity": [
          {
            "field": "custom_input_field",
            "label": "My Custom Input",
            "type": "custom",
            "options": {
              "src": "CustomInputJSFile",
              "type": "external"
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Number Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the number validator to enforce a range and integer type for a field.

```json
{
  "type": "text",
  "label": "Port",
  "validators": [
      {
        "type": "number",
        "range": [1, 65535],
        "isInteger": true
      }
  ],
  "field": "port"
}
```

--------------------------------

### String Validator Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/validators.md

Example usage of the string validator to enforce minimum and maximum length for a field.

```json
{
  "type": "text",
  "label": "Index Name",
  "validators": [
      {
        "type": "string",
        "errorMsg": "Length of index name should be between 1 to 80 characters.",
        "minLength": 1,
        "maxLength": 80
      }
  ],
  "field": "index_name"
}
```

--------------------------------

### Applying the Apache License

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/appserver/static/js/build/1.licenses.txt

This section provides instructions and a template for applying the Apache License to a project.

```text
Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

--------------------------------

### Running Tests

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/custom_ui_extensions/context/custom_test_ui_command.md

Command to execute all tests in the `src` directory.

```bash
npm run ucc-test
```

--------------------------------

### Build Development Bundle (Watch Mode)

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Creates a development bundle and writes it to the output folder, with watch mode enabled.

```bash
yarn build:watch
```

--------------------------------

### Example globalConfig.json for custom license usage

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/dashboard.md

This JSON configuration demonstrates how to set up custom license usage parameters in the dashboard settings.

```json
{
...
        "dashboard": {
            "panels": [
                {
                    "name": "custom"
                }
            ],
            "settings": {
                "custom_license_usage": {
                    "determine_by": "sourcetype",
                    "search_condition": [
                        "*addon123*",
                        "my_custom_condition*"
                    ]
                }
            }
        },
...
}
```

--------------------------------

### Build the TA

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Run the build command using the local UCC version, ensuring the source points to the package folder.

```bash
poetry run ucc-gen build --source $ta_repo/package
```

--------------------------------

### Radio Component Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a radio button component, including its options.

```json
{
    "field": "test_radio",
    "label": "Test Radio",
    "type": "radio",
    "defaultValue": "Yes",
    "required": false,
    "options": {
        "items": [
            {
                "value": "yes",
                "label": "Yes"
            },
            {
                "value": "no",
                "label": "No"
            }
        ],
        "display": true
    }
}
```

--------------------------------

### CheckboxTree Example

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/entity/components.md

Example JSON configuration for a checkboxTree component, demonstrating the use of groups and rows.

```json
{
    "type": "checkboxTree",
    "label": "CheckboxTreeTitle",
    "field": "api3",
    "options": {
    "groups": [
        {
            "label": "Group 1",
            "options": {
                "isExpandable": true,
                "expand": true
            },
            "fields": ["rowUnderGroup1"]
        },
        {
            "label": "Group 3",
            "options": {
                "isExpandable": true,
                "expand": true
            },
            "fields": ["firstRowUnderGroup3", "secondRowUnderGroup3", "thirdRowUnderGroup3"]
        }
    ],
    "rows": [
        {
            "field": "rowWithoutGroup",
            "checkbox": {
                "label": "Row without group",
                "defaultValue": true
            }
        },
        {
            "field": "rowUnderGroup1",
            "checkbox": {
                "label": "Row under Group 1",
                "defaultValue": true
            }
        },
        {
            "field": "firstRowUnderGroup3",
            "checkbox": {
                "label": "first row under group 3",
                "defaultValue": true
            }
        },
        {
            "field": "secondRowUnderGroup3",
            "checkbox": {
                "label": "second row under group 3"
            }
        },
        {
            "field": "thirdRowUnderGroup3",
            "checkbox": {
                "label": "third row checked under group 3",
                "defaultValue": true
            }
        }
    ]
    }
}
```

--------------------------------

### Build Production Bundle

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/ui/CONTRIBUTING.md

Generates a production bundle for the project.

```bash
yarn build
```

--------------------------------

### Run pre-commit hooks

Source: https://github.com/splunk/addonfactory-ucc-generator/blob/develop/docs/contributing.md

Executes linting and type-checking across all files using the pre-commit framework.

```bash
pre-commit run --all-files
```
Tokens:
Raw