> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Risksheet to Existing Project

> Enable Nextedy RISKSHEET in a Siemens Polarion ALM project that was not created from a Nextedy template by configuring work item types, document types, and navigation topics.

export const LastReviewed = ({date}) => {
  if (!date) return null;
  const formatted = new Date(`${date}T00:00:00Z`).toLocaleDateString("en-US", {
    year: "numeric",
    month: "long",
    day: "numeric",
    timeZone: "UTC"
  });
  return <p className="mt-10 text-sm text-gray-400 dark:text-zinc-500 not-prose">
      Last reviewed on {formatted}
    </p>;
};

## Prerequisites

* Polarion administrator access
* Risksheet plugin installed on the server
* The Nextedy demo project installed via **Administration > Nextedy Risksheet > Setup**

<Warning title="Install Demo Project First">
  Before adding Risksheet to an existing project, you must install the Nextedy demo project from the Setup page. This makes the Risksheet topic and default templates available. Without this step, the `risksheet` topic will not be recognized.
</Warning>

<Danger title="Do Not Use Polarion's Document Reuse Function">
  Do **not** use Polarion's built-in document Reuse function to clone a Risksheet document into another project or location. Reuse creates unnecessary duplication of the sheet configuration attachments and breaks the link between a document and its template. To share configuration across projects or documents, use template inheritance through the `templateDoc` custom field instead (see Step 3).
</Danger>

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/11.jpeg?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=31ac899ecedd5d8e7f8963df4f74480f" alt="The Polarion Reuse function, which is not recommended for creating new Risksheet documents" width="2698" height="942" data-path="risksheet/images/48001219133/11.jpeg" />
</Frame>

<Steps>
  <Step title="Install Demo Templates">
    1. Navigate to **Administration > Nextedy Risksheet > Setup**.
    2. Click the install button to deploy the default Risksheet templates.
    3. Verify the templates (`risksheet_template` and `risksheet_templateHara`) are listed.

    The setup process installs two starter templates: one for a typical FMEA (Failure Mode and Effects Analysis) risk analysis and one for HARA (Hazard Analysis and Risk Assessment) workflows. Risksheet itself is a generic tool supporting any risk management methodology — including FMEA, HARA, TARA (Threat Analysis and Risk Assessment), STRIDE, and CVSS (Common Vulnerability Scoring System) — and Nextedy provides solution templates for typical methodologies across industries.
  </Step>

  <Step title="Configure Work Item Types">
    Ensure your project has a work item type for risk items. Risksheet does not require specific fields or work item types — it is fully configurable for any work item type.

    1. Navigate to **Administration > Work Items > Types** in your project.
    2. Verify you have a risk-related work item type (for example, `risk`, `failureMode`, or any custom type).
    3. If needed, create a new work item type for risk items.

    Risksheet does not introduce a separate data store. All risk items remain standard Polarion work items, subject to Polarion authorization and fully traceable via Polarion's audit infrastructure.

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=c4fc011ce14705b48e7894b96eeb59e4" alt="A risk work item type under Administration > Work Items > Types, referenced by the risksheet.json dataTypes section" data-og-width="1828" width="1828" data-og-height="904" height="904" data-path="risksheet/images/48001219133/1.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=280&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=065ae97653b58707f243a72398e2a56a 280w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=560&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=9941a23bf943c4de1e45f756b49200f6 560w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=840&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=2ea5df04d79e260f8e95bd08c5f3d734 840w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=1100&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=0a10e5f4ff7f5ed01b2e922db0468866 1100w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=1650&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=f3786dc62a6ba04767351d4526eaf9c1 1650w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/1.png?w=2500&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=00d4c4280454cedfb7fb07e5dbcd5be7 2500w" />
    </Frame>
  </Step>

  <Step title="Configure the Document Type and templateDoc Field">
    Set up a document type with the Risksheet property, and configure the `templateDoc` custom field that connects each document to its template:

    1. Navigate to **Administration > Documents & Pages > Document Types** in your project.
    2. Create or edit a document type (for example, `riskSpecification`).
    3. Add the Polarion configuration property `nextedy.risksheet.riskDocumentType` and set its value to your document type.
    4. Add a `templateDoc` custom field to the document type with field type **`enum:@document`** — Polarion's built-in document-reference enumeration. This field holds the connection between a Risksheet document and the template document it inherits its sheet configuration from.

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/2.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=2ae20957eab71aabcd6c3b61f2f76879" alt="The riskSpecification document type, whose id is set via the nextedy.risksheet.riskDocumentType property" width="2000" height="700" data-path="risksheet/images/48001219133/2.png" />
    </Frame>

    <Note title="templateDoc Custom Field Type">
      The `templateDoc` custom field on individual Risksheet documents must be defined with type **`enum:@document`** — the special `@document` built-in enum that produces a document-reference picker. In the field definition this looks like `<field id="templateDoc" name="Template" type="enum:@document"/>`. Do not use a plain string or text type, and do not use a custom document-type enum — the picker behavior depends on the built-in `@document` enumeration. (The analogous user-reference field type is `enum:@user`, as used by fields such as `owner`.)
    </Note>

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=eb350a8c19a2fe4eb7e8a6ca87dc6648" alt="Configuring the templateDoc custom field (type enum:@document) under Administration > Documents & Pages > Document Custom fields" data-og-width="1972" width="1972" data-og-height="1234" height="1234" data-path="risksheet/images/48001219133/6.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=280&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=68c257d1a31edcce5b6ae04b3a7f4e89 280w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=560&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=3ee583411703a1059217e09adf31d9a3 560w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=840&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=ff0eac6effa0e00116bada7f5ea8589e 840w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=1100&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=04f411cf8129f0ee37a9813cb006fa86 1100w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=1650&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=6876bcab9480e0899e6446f40dfb006f 1650w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/6.png?w=2500&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=f87f8426e68133d6a3d38e9b3532152b 2500w" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/7.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=935ae9efa47339424853bf5aca36fae1" alt="Selecting the template in a document's Document Properties via the templateDoc field" width="1016" height="623" data-path="risksheet/images/48001219133/7.png" />
    </Frame>

    <Tip title="Multiple Document Types">
      The `nextedy.risksheet.riskDocumentType` property supports multiple document types using parenthesized syntax if you need Risksheet to work with different document categories.
    </Tip>
  </Step>

  <Step title="Configure Template Paths">
    Set up where users can create new Risksheet documents:

    1. Navigate to **Administration > Nextedy Risksheet** in your project.
    2. Configure the template path. The default value of `nextedy.risksheet.risksheetTemplatePath` is `Risks/Risk Specification`. For a shared global template, use the form `GlobalLibrary:Risks/Risk Specification` to reference a template stored in another project.
    3. Multiple paths can be specified as comma-separated values.

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/8.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=ce9defe57df66d7ec30baf694dccf0eb" alt="Setting nextedy.risksheet.risksheetTemplatePath in Configuration Properties" width="1616" height="620" data-path="risksheet/images/48001219133/8.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/5.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=ad69517957a99ded900bd1c6fbef6250" alt="Creating the template LiveDoc (Risk Analysis) of type Risk Specification" width="1012" height="544" data-path="risksheet/images/48001219133/5.png" />
    </Frame>

    ```text theme={null}
    Project Setup Flow:

      Install Demo Templates (Setup page)
             |
             v
      Configure Work Item Type (risk items)
             |
             v
      Configure Document Type + templateDoc field
             |
             v
      Set Template Path (document location)
             |
             v
      Add Risksheet Topic to Sidebar
             |
             v
      Test: Create New Risksheet Document
    ```
  </Step>

  <Step title="Add the Risksheet Topic to Navigation">
    Add the Risksheet topic to your project's sidebar navigation:

    1. Navigate to **Administration > Topics** in your project.
    2. Add `<topic id='risksheet'/>` to the sidebar configuration for the relevant views and roles.
    3. Save the configuration.

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=41727cb82cd5021402e630090a3568ba" alt="Adding the risksheet topic in Administration > Portal > Topics" data-og-width="1542" width="1542" data-og-height="930" height="930" data-path="risksheet/images/48001219133/3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=280&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=35873c058ec477b94b249cf589db90ee 280w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=560&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=b5352c774055db3864837beb897b9ec2 560w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=840&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=b67520cfc565cd1fd979939afbc81e25 840w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=1100&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=61351ab6a41a10244a4c0a99de9183a9 1100w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=1650&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=a20bbbff3e9bc71466075929c5990982 1650w, https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/3.png?w=2500&fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=6da8b2217d5d4cce82789dffe32c23df 2500w" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/4.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=8bc3f0f5a1ba5a629b0aca0191128675" alt="The Risksheet topic visible in the Polarion project sidebar" width="718" height="300" data-path="risksheet/images/48001219133/4.png" />
    </Frame>

    <Warning title="Risksheet Not Visible After Setup">
      If Risksheet does not appear in the navigation after adding the topic, verify that the topic is configured for the specific view/role that the user is assigned to. Removing or omitting the Risksheet topic from a custom navigation view makes Risksheet invisible in that view.
    </Warning>
  </Step>

  <Step title="Customize Display Names">
    Optionally customize how Risksheet appears in your project. The following properties are available in **Administration > Nextedy Risksheet**:

    | Property                 | Default         | Purpose                         |
    | ------------------------ | --------------- | ------------------------------- |
    | Tool Name                | `Risksheet`     | Display name in the UI          |
    | Document Names (plural)  | `Risk Analyses` | Plural label for document lists |
    | Document Name (singular) | `Risk Analysis` | Singular label in dialogs       |
  </Step>
</Steps>

## Verification

1. Navigate to your project's sidebar and click the Risksheet entry.
2. You should now see the Risksheet home page with folder navigation and a document creation option.
3. Create a test risksheet document to verify the configuration. Pick the closest solution template for your industry or methodology rather than starting from a blank document — modify it to match your process from there.
4. Confirm the document loads with the correct template and column layout.

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/9.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=5a80dd675653054ba90f26cd492eb908" alt="The configured template appearing under + New Blank Document in the Risksheet topic" width="2080" height="910" data-path="risksheet/images/48001219133/9.png" />
</Frame>

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/10.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=4b055f331c463a7d43fca68a64f8dd68" alt="The + New Blank Document dialog: naming the document and selecting the desired template" width="4552" height="768" data-path="risksheet/images/48001219133/10.png" />
</Frame>

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/AIn5YJnEEQyTvSQd/risksheet/images/48001219133/12.png?fit=max&auto=format&n=AIn5YJnEEQyTvSQd&q=85&s=28ba635997fc76332de81917ba894da4" alt="A configuration error shown when a project's configuration differs from the sample template — open the configuration to adjust it" width="2076" height="880" data-path="risksheet/images/48001219133/12.png" />
</Frame>

## See Also

* [Installation](/risksheet/getting-started/installation) — initial plugin installation
* [Configure Template Paths](/risksheet/guides/configuration/template-path-configuration) — advanced template path options
* [Set Up Global Templates](/risksheet/guides/configuration/global-templates) — share templates across projects
* [Basic Configuration](/risksheet/getting-started/basic-configuration) — customize your first risksheet

<LastReviewed date="2026-06-24" />
