Documentation Center

Populating a reusable component repository in a CSDB (Arbortext only)

You can populate a reusable component repository in the CSDB with warnings, cautions, support equipment, supplies, and spares. In multi-language CSDBs, you can add only source-language components to the repository. Once in the reusable component repository, these components can be inserted directly into a DM using Arbortext Editor. Issue 4.1 or later CIR warnings and cautions are stored in a CIR DM rather than in the reusable component repository (CSDB).

Before you begin

  • You must have the appropriate permissions to edit DMs on your Contenta S1000D desktop.
  • To control who may populate the repository with reusable components, you should use the pcmadmin utility to remove the Modify S1000D Reusable Data system tool from the BASE_TOOLS toolbox, and make it available to only designated users' toolboxes. See the Contenta Administrator User documentation for more information on Contenta toolboxes.

About this task

This procedure describes how to add warnings, cautions, support equipment, supplies, and spares to a reusable component repository in the CSDB.

  • You add Issue 2.3, 3.0, and 4.0 warnings and cautions to the reusable component repository, and you add Issue 4.1 or later warnings and cautions to a CIR DM (not to the reusable component repository).
  • You add Issue 2.3, 3.0, 4.0, 4.1, 4.2, and 5.0 support equipment, supplies, and spares to the reusable component repository.
  • In a multi-language CSDB, only reusable components in the source language can be added.

The following are the fields in the Add Reusable Component to Repository panel.

  • Component ID—Displays the ID of the warning, caution, support equipment, supply, or spare.
  • Component Type—Can be warning, caution, support_equipment, supply, or spare.
  • Component Title
    • For warnings and cautions only—this field is initially populated with the text of the selected warning or caution, or the first 150 characters of text if the warning or caution text is longer than that.
    • For support equipment—Issues 2.3.and 3.0 use the <supequi> element with the title derived from the <nomen> element, and Issues 4.0 and higher use the <supportEquipDescr> element with the title derived from the <name> or <shortName> elements.
    • For supplies—Issues 2.3.and 3.0 use the <supply> element with the title derived from the <nomen> element, and Issues 4.0 and higher use the <supplyDescr> element with the title derived from the <name> or <shortName> element.
    • For spares—Issues 2.3.and 3.0 use the <spare> element with the title derived from the <nomen> element, and Issues 4.0 and higher use the <spareDescr> element with the title derived from the <name> or <shortName> elements.
  • S1000D Issue—Displays the issue number.
  • Model Identifier—Initially displays the model identification code of the DM being edited. You can modify this field.
  • System Difference Code—Initially displays the SDC of the DM being edited. You can modify this field.
  • Source DM—Displays the Data Module Code (DMC) of the DM being edited.
  • Contenta Configuration IDs—Displays the BLOB ID of the configuration containing the source DM. You can modify this field to specify a different ID, or to specify additional IDs, which you should separate with a space.

Procedure

  1. In Arbortext Editor, select one of the following elements that you want to add to the reusable component repository:
    • warning—Issues 2.3, 3.0, or 4.0
    • caution—Issues 2.3, 3.0, or 4.0
    • supequi—Issues 2.3 and 3.0
    • supportEquipDescr—Issues 4.0 or higher
    • supply—Issues 2.3 and 3.0
    • supplyDescr—Issue 4.0 or higher
    • spare—Issues 2.3 and 3.0
    • spareDesc—Issue 4.0 or higher
  2. Click Contenta > Add Reusable Component to CSDB Repository...

    The Contenta S1000D Add Reusable Component to Repository pane opens on the left.

    If the element does not have an ID attribute, or if the numerical portion of the ID attribute exceeds 9 digits, the Use a generated ID message appears next to a check box that is checked. A representation of the generated ID will appear in the Component ID field, with number signs (#) representing digits. Depending on the element type, generated IDs will be prefixed with warn- , caut-, seq-, sup-, or spa-, for example, warn-#########. The actual generated IDs will start with 000000001 and automatically increment for each component type, for example, warn-000000001. You must use a generated ID to store this component in the reusable component repository.

    If the Component ID is less than 9 digits, or if the prefix is non-standard (not warn-, caut-, seq-, sup-, or spa-), the Optionally use a generated ID message appears next to a check box that is unchecked. You can choose to keep the existing Component ID, or you can check this check box to use a generated Component ID.

    If the Component ID is already in the reusable component repository, you will be prompted to select one of the following choices:

    • Update the XML for this item in the repository. Use this option to modify the content of the existing warning, caution, spare, support equipment, or supply.
    • Add a new item with a generated ID. Use this option to add a new warning, caution, spare, support equipment, or supply to the reusable component repository, and preserve the original.
  3. Optionally, edit the following fields:
    • Component Title
    • Model Identifier
    • System Difference Code
    • Contenta Configuration IDs
  4. Click Add.

    The warning/caution/support equipment/supply/spare will be added as a new item in the reusable component repository, or an existing item will be updated if you selected a duplicate, as long as the following conditions were met:

    • The ID is 9 or fewer digits. For example, warn-000000009
    • The component title is 150 or fewer characters.
    • The component XML markup is valid.
    • The model identfier is valid (it must be 2-14 uppercase, alphanumeric characters).
    • The system difference code is valid (it must be 1-4 uppercase, alphanumeric characters).
    • All configuration BLOB IDs exist in the CSDB.