> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/security-testing-orchestration/use-sto/sto-scanner-configuration/data-theorem-scanner-reference.md).

# Data Theorem step configuration

You can extract and ingest scan results for your code repositories from [Data Theorem](https://www.datatheorem.com/).

### Workflow descriptions <a href="#workflow-descriptions" id="workflow-descriptions"></a>

<details>

<summary>Ingestion workflows</summary>

This workflow applies to scanner integrations that support Ingestion mode.

1. Add a Build or Security stage to your pipeline.
2. Add a Run step and set it up to save your scan results to a shared folder.

   For more information, go to [Run an ingestion scan in an STO Pipeline](/security-testing-orchestration/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md).
3. Add a [Custom Scan](/security-testing-orchestration/use-sto/sto-custom-scanning-and-ingestion/custom-scan-reference.md) step.
4. Review the [Important notes for Custom Scan steps](/security-testing-orchestration/use-sto/sto-custom-scanning-and-ingestion/custom-scan-reference.md#important-notes-for-custom-scan-steps) for additional requirements and relevant information.
5. Add the relevant `key:value` pairs to **Settings**.

</details>

<details>

<summary>Orchestration/extraction workflows</summary>

This workflow applies to scanner integrations that support [`orchestratedScan`](/security-testing-orchestration/new-to-sto/key-concepts/run-an-orchestrated-scan-in-sto.md) or [`dataLoad`](/security-testing-orchestration/new-to-sto/key-concepts/extraction-scans.md) scan modes.

1. Add a **Build** or **Security** stage to your pipeline.
2. If you're scanning a code repository, set up your [codebase](/continuous-integration/use-harness-ci/use-harness-ci/codebase-configuration/create-and-configure-a-codebase.md).
3. Add a [Custom Scan](/security-testing-orchestration/use-sto/sto-custom-scanning-and-ingestion/custom-scan-reference.md) step.
4. Review the [Important notes for Custom Scan steps](/security-testing-orchestration/use-sto/sto-custom-scanning-and-ingestion/custom-scan-reference.md#important-notes-for-custom-scan-steps) for additional requirements and relevant information.

   If you're setting up a scan on a Kubernetes or Docker build infrastructure, you need to add a [Docker-in-Docker background step](/security-testing-orchestration/use-sto/sto-scanner-configuration/security-step-settings-reference.md#configuring-docker-in-docker-dind-for-your-pipeline) to the stage.
5. Add the relevant `key:value` pairs to **Settings**.

</details>

### Custom Scan step settings for Data Theorem scans <a href="#custom-scan-step-settings-for-data-theorem-scans" id="custom-scan-step-settings-for-data-theorem-scans"></a>

#### Scanner settings <a href="#scanner-settings" id="scanner-settings"></a>

These settings are required for most scanners. For more information, go to the reference for the scanner integration you're setting up.

* [Product name](#product-name)
* [Scan type](#scan-type)
* [Policy type](#policy-type)
* [Product config name](#product-config-name)

**Product name**

The scanner name. This is required for all Custom Scan steps.

**Key**

```
product_name
```

**Value**

```
data-theorem
```

**Scan type**

The target type to scan.

**Key**

```
scan_type
```

**Value**

```
repository
```

**Policy type**

The [scan mode](/security-testing-orchestration/new-to-sto/key-concepts/sto-workflows-overview.md) to use.

**Key**

```
policy_type
```

**Value**

Must be one of the following. For supported values, go to the relevant step configuration.

```
ingestionOnly
```

```
dataLoad
```

**Product config name**

Required for most scanner integrations.

**Key**

```
product_config_name
```

**Value**

```
default
```

#### Target and variant <a href="#target-and-variant" id="target-and-variant"></a>

Every Custom Scan step needs a [target and baseline](/security-testing-orchestration/new-to-sto/key-concepts/targets-and-baselines.md).

* [Target name](#target-name)
* [Target variant](#target-variant)

**Target name**

**Key**

```yaml
target_name
```

**Value**

A user-defined label for the code repository, container, application, or configuration to scan. Specify a unique, descriptive name. This makes it much easier to navigate your scan results in the STO UI.

**Target variant**

**Key**

```yaml
target_variant
```

**Value**

A [user-defined label](/security-testing-orchestration/new-to-sto/key-concepts/targets-and-baselines.md) for the branch, tag, or other target variant to scan.

#### Code repository <a href="#code-repository" id="code-repository"></a>

These settings apply to Custom Scan steps when both of these conditions are true:

1. The `policy_type` is `orchestratedScan` or `dataLoad`.
2. The `scan_type` is `repository`.

* [Repository project](#repository-project)
* [Repository branch](#variant)

**Repository project**

**Key**

```
repository_project
```

**Value**

The name of the repo to scan. To specify the repo URL, edit the [Codebase Config object](/continuous-integration/use-harness-ci/use-harness-ci/codebase-configuration/create-and-configure-a-codebase.md) in the Harness pipeline.

In most cases, this should match the repo name used in your Git provider.

**Repository branch**

**Key**

```
repository_branch
```

**Value**

The branch that gets reported in STO for the ingested results. In most cases, this field should match the name of the Git branch that is getting scanned.

You can specify a hardcoded string or use a variable such as `<+codebase.branch>` to specify the branch at runtime. For more information, go to [CI codebase variables reference](/continuous-integration/use-harness-ci/use-harness-ci/codebase-configuration/built-in-cie-codebase-variables-reference.md).

#### Ingestion file <a href="#ingestion-file" id="ingestion-file"></a>

This setting applies to Custom Scan steps when the `policy_type` is [`ingestionOnly`](/security-testing-orchestration/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md).

**Key**

```
ingestion_file
```

**Value**

The path to your scan results when running an [Ingestion scan](/security-testing-orchestration/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md), for example `/shared/scan_results/myscan.latest.sarif`.

* The data file must be in a [supported format](/security-testing-orchestration/new-to-sto/sto-whats-supported/scanners.md#supported-ingestion-formats) for the scanner.
* The data file must be accessible to the scan step. It's good practice to save your scan results to a [shared path](/continuous-integration/new-to-harness-ci/key-concepts.md#stages) in your stage. In the visual editor, go to the stage where you're running the scan. Then go to **Overview** > **Shared Paths**. You can also add the path to the YAML stage definition like this:

  ```yaml
      - stage:
        spec:
          sharedPaths:
            - /shared/scan_results
  ```

#### Product access <a href="#product-access" id="product-access"></a>

These settings are available to access your Data Theorem SaaS instance when `policy_type` is `dataLoad`.

You should [create Harness text secrets](/harness-ai/use-harness-platform/secrets/add-use-text-secrets.md) for your encrypted passwords and tokens and reference them using the format `<+secrets.getValue("my-access-token")>`.

**Product access keys**

```
product_app_id
```

```
product_access_token
```

#### Fail on Severity <a href="#fail-on-severity" id="fail-on-severity"></a>

If the scan finds any vulnerability with the specified [severity level](/security-testing-orchestration/new-to-sto/key-concepts/severities.md) or higher, the pipeline fails automatically. `NONE` means do not fail on severity.

For more information, go to:

* [STO workflows for blocking builds and PRs](/security-testing-orchestration/troubleshooting-and-resources/sto-use-cases/stop-builds-based-on-scan-results/stop-pipelines-overview.md).
* [Exemptions to override Fail on Severity thresholds for specific issues in STO](/security-testing-orchestration/use-sto/sto-exempt-issues/exemption-workflows.md)

**Key**

```
fail_on_severity
```

**Value**

```
CRITICAL
```

```
MEDIUM
```

```
LOW
```

```
INFO
```

```
NONE
```