Features

Users can track progression of processes, update existing processes and create new processes with ease using this dashboard. The dashboard provides access to a single workspace only to reduce complexity.

• Create new processes by providing basic data only (only if create permission is granted)
• Review history of selected processes
• Update status of a given process
• Download and upload process attachments
• Use 3D markups to document process
• Access bookmarked and recent processes
• Track proces progression in Kanban
• Review process updates in a chart
• Access defined dashboard directly (by providing valid wsId as parameter) or select from configured profiles

Configuration Settings

This dashboard can be used with any workspace but requires the matching configuration in file settings.js. This application is preconfigured for the workspaces Change Requests, Change Orders, Non Conformances, Problem Reports, Project Tasks and Supplier Packages of default tenants. Additional workspace configuration profiles can be added by copying one of the existing configurations shown below.

dashboard : [{title : 'Change Requests Management',wsId : 83,className : 'change-request',contents : [ { type : 'details' , params : { id : 'details', collapseContents : true, editable : true, toggles : true, singleToolbar : 'controls' } },{ type : 'attachments' , params : { id : 'attachments', editable : true, headerLabel : 'Files', singleToolbar : 'controls', layout : 'list', tileSize : 'xs' } },{ type : 'managed-items' , params : { id : 'managed-items', editable : true, columnsIn : [ 'Item', 'Lifecycle', 'Problem Description', 'Proposed Change'], openInPLM : true } },{ type : 'workflow-history', params : { id : 'workflow-history' } }],icon : 'icon-workflow',progress : [{ label : 'Planning', color : '#000000', states : ['Create'] },{ label : 'Review', color : colors.red, states : ['Review & Impact Analysis', 'Peform Tasks', 'Change Control Board Review'] },{ label : 'In Work', color : colors.yellow, states : ['Change Order in progress'] },{ label : 'Completed', color : colors.green, states : ['Completed'] }]}, {title : 'Non Conformances Tracking Dashboard',wsId : 98,className : 'non-conformance',contents : [ { type : 'workflow-history', params : { id : 'workflow-history' } },{ type : 'details' , params : { id : 'details', collapseContents : true, editable : true, toggles : true, singleToolbar : 'controls' } },{ type : 'markup' , params : { id : 'markup', fieldIdViewable : 'NONCONFORMING_ITEM', markupsImageFieldsPrefix : 'IMAGE_' } }, { type : 'attachments' , params : { id : 'attachments', editable : true, headerLabel : 'Files', singleToolbar : 'controls', layout : 'list', tileSize : 'xs' } }],icon : 'icon-rules',fieldIdSubtitle : 'DESCRIPTION',progress : [{ label : 'New', color : colors.red, states : ['Identification In Progress'] },{ label : 'Analysis', color : colors.yellow, states : ['Under Review'] },{ label : 'Improvement', color : colors.yellow, states : ['Disposition In Progress', 'CAPA In Progress'] },{ label : 'Closed', color : colors.green, states : ['Closed'] }]},{...}]

Each profile requires the settings listed below.

Access the Dashboard

You can access the process dashboard with the /dashboard endpoint by providing the workspace profile to use. The value of parameter wsId has to match the wsId property value of the configuration profile to use. If you're connected to a default tenant of 2023 or later, you can use these links:

You can also omit the workspaceId and select from the list of configured profiles instead:

Prerequisites

This app works best with the Items workspace, but can also be used with the former Vault Items and BOMs and Items and BOMs workspaces. However, it is recommended to be used with a workspace where the items have viewable files (dwf) attached.

Features

• Navigate and visualize BOM of a given item
• Browse to item of interest from a landing page
• Filter BOM and 3D view by text and dynamic KPIs
• Apply colours to BOM and viewer to visualise KPIs
• Toggle BOM structure and flat table mode
• Access and download attachments of a selected item
• Review & edit details of selected records
• Review Problem Reports related to a selected item
• Perform markups and initate new Problem Reports for given items
• Manage master data of single records
• Manage master data of multiple records in flat BOM view

Configure Workspace BOM View

This application requires a BOM view that contains all fields required to determine the KPIs for the dashboard shown on the left hand side of the application. It is recommended to create a new BOM view named Details for workspace Items if it does not exist yet - with all the columns shown below. If you omit some of these columns (as they might not exist in your tenant), the given KPIs will be hidden automatically and the dashboard will still work. If you want to reuse an existing BOM view instead, you can change the view's name in file settings.js . Locate the parameter explorer.bomViewName (see given chapter) and change it accordingly (restart the application server afterwards).

List of recommended columns to match the standard KPIs:

• Descriptor
• Number
• Lifecycle (System Field)
• Change Pending
• Type
• Class Name
• PDM Category
• PDM Location
• Responsible Designer
• Material
• REACH
• RoHS
• Spare / Wear Part
• Make or Buy
• Lead Time
• Long Lead Time
• Vendor
• Country
• Has Pending Packages
• Total Cost (BOM Field)
• Total Weight (BOM Field)

Extend Workspace Item Details

If the field DMS_ID does not exist yet in your workspace, add it as Single Line Text (length 20, not visible) in tab Item Details. Let this field be set upon item creation using the following script code:

item.DMS_ID = dmsID;

In addition, add a new computed field Actions to Item Details that renders a button to open the explorer for the current record. Use the formula shown below. In this formula, adjust the workspace ID to match your environment if needed (57 matches the standard Items workspace).
If an Actions field is already present in your Items workspace, add the given formula to your existing Actions field. Note that the latest standard tenant renders multiple buttons in a standard Actions field which are all aligned thanks to a wrapping table. If this table is present in your tenant's Actions field, insert the formula accordingly to the other buttons.

'<a style="border: 1px solid #bec8d2;border-radius:3px;color: #0a131c;font-weight:600;line-height:32px;padding:4px 20px;text-align:center;text-decoration:none !important;white-space:nowrap;" target="_blank" href =" explorer?wsId=57&dmsId='||DMS_ID||'">Explorer</a>'

Make sure that Items can be connected to Problem Reports as affected items. The retrieval of related PRs and also creation of new PRs will fail otherwise.

Configuration Settings

Users can create new Problem Reports for the selected items and also reveal existing processes. As your tenant might be configured differently, you can define the Workspace ID of the matching Problem Reports workspace in your tenant. Open file settings.js and adjust the value of the variable explorer.wsIdProblemReports if needed. This parameter is set to 82 per default to match the default Problem Reports workspace of standard tenants.

Locate the explorer section in file settings.js shown below to adjust your confiugration if needed. These settings are aligned with the latest default tenant as much as possible. After changing this settings file, you have to restart your node server to get them applied.

exports.config = {'explorer' : {bomViewName : 'Details',fieldIdPRImage : 'IMAGE_1',fieldIdPRContext : 'AFFECTED_ITEM',wsIdSupplierPackages : 147,kpis : [..],viewerFeatures : {cube : false,orbit : false,..} }}

Core Settings

Review the following settings to enable startup of the explorer

This utility also uses the following common configuration settings

This explorer also can be used to identify items to be shared with suppliers (i.e. new or changed components). Therefore, one can provide the Workspace ID of Supplier Packages in setting wsIdSupplierPackages . If this setting is provided, users can click the given icon to create a new package for selected BOM components easily

Configuring the Dashsboard

The 'kpis' parameter of config.explorer defines the KPIs being displayed in the explorer's dashboard to the left. You may change them, but please create a backup copy of the original settings.js file before. Keep in mind that all KPIs require you to include the given data as column to the BOM view (which is defined by explorer.bomViewName). If you want to visualise the value of field Material for example, this field must be included in the new BOM view as well.

Certain KPIs are preconfigured to match the standard Items workspace. For example, the dasboard will display counters to reveal items undergoing a change, and also display bars to indicate the PDM category:

{'id' : 'change','title' : 'Pending Change','fieldId' : 'WORKING_CHANGE_ORDER','urn' : '','type' : 'non-empty','style' : 'counters','data' : [{ 'value' : 'Yes', 'count' : 0, 'color' : colors.list[0], 'vector' : vectors.red },{ 'value' : 'No' , 'count' : 0, 'color' : colors.list[4], 'vector' : vectors.green } ]},{'id' : 'pdm-category','title' : 'PDM Category','fieldId' : 'PDM_CATEGORY','urn' : '','type' : 'value','style' : 'bars','data' : []}

Each KPI is configured with the same parameters:

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Access the Explorer

If your tenant contains the default demo datasets and once you have the BOM view configured as described above, you can open the explorer using the link below:

You can also open the explorer's landing page by omitting the dmsId parameter:

Features

• The dashboard makes use of the reports defined in PLM. Make sure that you have valid reports defined in the reports panel.
• The first two out of these reports will get displayed in the dashboard automatically.
• The button Select Reports enables users to select a different set of reports for the dashboard. Note: This given selection will not be saved.
• Users can click on the rows in table based reports to navigate to the given record in PLM.

Limitations

This solution only supports non-stacked column charts and pie charts. All other charts require further developoments.

Configure Startup Reports

The dashboard will automatically load a defined set of reports at startup before users can select their preferred reports using the Select Reports button. These startup reports can be defined in the settings.jsfile.

'reports' : {'startupReportNames' : ['Audits by Workflow State', 'CR approval status', 'DR: Rework Required', 'EX: Change Requests'],'startupReportNames' : 5}

The list of startup repports can be defined by their names using the setting startupReportNames. In addition, startupReportNames can be set to define a minimum number of reports to be loaded if none of the report names match for the current user. In this case, when set to 5, the system will display the first five reports (in alphabetical order) if none of the report names were found.

Prerequisites

Your tenant must have the latest NPI solution installed (providing the workspaces Projects, Project Tasks, Teams and so on).

Features

The dashboard will provide insights in all projects that are accessible to the current user and display the following reports:

• The timeline of each projects by showing all Gates' target dates
• The Status Reports of each projects
• Current progress, project budget and progress of current phase of each project
• The planned effort for each project's phase
• Deviations of project end dates

Configuration Settings

Provide the ID of your Projects workspace in file settings.js. Adjust the value of the following variable which is set to 86 to match the default Projects workspace.

export.config = {'projects' : {'wsIdProjects' : '86',}}

Features

• Add EBOM items to the MBOM easily with clicks
• Add further items to the MBOM using drag & drop
• Use the Disassemble mode to quickly define the MBOM by reversing the order
• Use color codes to identify mismatches in EBOM and MBOM
• Access details of selected items in right hand side panel whenever needed
• Manage multiple MBOMs per EBOM item (i.e. site specific BOMs)

Important - Read before proceeding

This editor helps in transitioning an Engineering BOM to a Manufacturing BOM. This may involve one or two item workspaces, depending on your tenant configuration and preference. If your tenant has been created before Mid 2023, your tenant will most likelly have two workspaces to manage items: Items and BOMs as well as Vault Items and BOMs. If your tenant is more recent, it will only contain the new workspace named Items (unless you installed the Vault Items and BOMs from the template library).

If your tenant only has the single Items workspace, this workspace will be used to manage both the EBOMs and the MBOMs. In this case, all installation steps referring to both EBOM and MBOM must be applied to this workspace. You can skip all steps referring to the 2 Workspaces setup.

On the other hand, if you have two workspaces, you can use the one for the EBOM and the other one for the MBOM. In this case, you will most likely use Vault Items and BOMs as the EBOM workspace and Items and BOMs as the MBOM workspace. This setup is referred to as the 2 Workspaces setup in the instructions below. Of course, you can also choose one of these workpaces and use it for both EBOM and MBOM at the same time.

Note that the viewer inside the MBOM Editor will only work if the base EBOM item has a dwf file attached.

Configuration Changes for EBOM Workspace

Extend Item Details

Add a new section Manufacturing BOM with the following fields to this workspace:

Finally, add a computed field 'MBOM_EDITOR' with the following formula. Make sure to provide the right workspace ID (...?wsId=57...). It has to match the EBOM workspace ID (57 matches the standard Items workspace).

CASE WHEN (DMS_ID is null) THEN 'Item ID is not set'WHEN (END_ITEM = true) THEN 'Not available for end items'WHEN (MATCHES_MBOM = true) THEN 'EBOM matches MBOM'ELSE '<a style="color: #0a131c;border: 1px solid #bec8d2;border-radius:3px;text-align:center;text-decoration:none !important;line-height:32px;white-space:nowrap;padding:4px 20px;width:140px;font-weight:600;" target="_blank" href ="LOCATIONmbom?wsId=57&dmsId='||DMS_ID||'">Edit MBOM</a>'END

While the layout does not matter, it is recommended to combine the given fields in a Matrix within this section as shown below.

New BOM View

Add a new BOM view MBOM Transition to the EBOM workspace. Add all the fields that were created in the step before to this view - plus a few others. You may also add any further column as you like. The sequence of columns does not matter.

1. Descriptor
2. PDM Category
3. Quantity
4. Number
5. MBOM
6. Last MBOM Sync
7. Process Code
8. End Item
9. Matches MBOM
10. Ignore in MBOM
11. Revision

Configuration Changes for MBOM Workspace

The following steps must be performed in the workspace to manage the MBOMs - which could be the same one as for the previous steps or a second one in case of a 2 workspaces setup.

Adjust Item Details

Make sure that the NUMBER field of your MBOM workspace is editable (always or at item creation).

Extend Item Details

If you use the same workspace for both the EBOM and MBOM, simply add the following fields to this EBOM & MBOM workspace. You may add these fields to the matrix created before:

1. Add field EBOM as linking pick list to the EBOM workspace (EBOM, Single Selection, editable)
2. Add checkbox 'Is Process' (IS_PROCESS, hidden, editable)

If instead you will use two different workspaces (i.e. manage the EBOM in Vault Items and BOMs and the MBOM in Items and BOMs workspace), you also have to add the following fields to the MBOM workspace in addition:

1. If it does not exist yet, add Single Line Text field 'DMS_ID' (DMS_ID, length 20, not editable, hidden)
2. Add date field 'Last MBOM Sync' (LAST_MBOM_SYNC, visible, editable)
3. Add Single Line Text field 'Process Code' (PROCESS_CODE, length 10, visible, editable)
4. Add computed field 'MBOM_EDITOR' with the following formula. Make sure to provide the right workspace ID (...?wsId=57...). It has to match the MBOM workspace ID (57 matches the standard Items workspace).

   CASE WHEN (DMS_ID is null) THEN 'Item ID is not set'WHEN (END_ITEM = true) THEN 'Not available for end items'ELSE '<a style="color: #0a131c;border: 1px solid #bec8d2;border-radius:3px;text-align:center;text-decoration:none !important;line-height:32px;white-space:nowrap;padding:4px 20px;width:140px;font-weight:600;" target="_blank" href ="LOCATIONmbom?wsId=57&dmsId='||DMS_ID||'">Edit MBOM</a>'END

These fields once again can be managed in a dedicated section and matrix when using two distinct workspaces:

Add new fields to Bill of Materials tab

Add two new fields to the Bill of Materials tab in your MBOM workspace. These fields will be required for the next step and added to the given BOM view.

• Add Checkbox field 'Is EBOM Item' (IS_EBOM_ITEM, hidden, editable)
• Add Single Line Text field 'EBOM Root Item' (EBOM_ROOT_ITEM, length 50, hidden, editable)

BOM View

If you use the same workspace for both the EBOM and MBOM, add the following fields to the existing BOM view MBOM Transition:

1. EBOM
2. Is Process
3. Is EBOM Item
4. EBOM Root Item

If instead you will use two different workspaces, you have to add a new BOM view MBOM Transition with at least the following columnns:

1. EBOM
2. Is Process
3. Process Code
4. Descriptor
5. Revision
6. Quantity
7. Is EBOM Item
8. EBOM Root Item

Additional step for 2 workspaces setup

Make sure that the MBOM workspace allows for BOM connections to the EBOM workspace:

Scripts

For both the EBOM and MBOM workspace, the system has to store the dmsID for new records in field DMS_ID. Add the following script code to the creation event of both workspaces. If your tenant is based on the template released in April 2023, this field exists in your tenant and will be set by script already.

item.DMS_ID = dmsID;

Default Values for new items

When users add operations and MBOM items, these new items may receive default values for defined fields, like a specific type. Such defaults can be defined in the file settings.js - see next chapter for details. The default settings file provides a placeholder example:

You can provide an array of all the fields to be populated with default values. As shown in the example above, this requires the field's ID (TYPE) and value. In addition, the setting fieldsToCopy enables definition of a list of fields which will be copied from the given related EBOM item to the new MBOM item.

Server Settings File

Review the following contents in file settings.js. The default configuration matches the standard tenant template and makes use of the Items workspace only. If you change this file, a restart of your server is required.

export.config = {'mbom' : {'wsIdEBOM' : '57','wsIdMBOM' : '57','bomViewNameEBOM' : 'MBOM Transition''bomViewNameMBOM' : 'MBOM Transition''fieldIdEBOM' : 'EBOM'...}}

Field Mapping

This area within settings.js contains a couple of parameters to adjust the field IDs being used whenever needed. You may want to review this list, but if you followed the setup instructions, this mapping should be fine already.

Application Options

Following settings are much more important. They impact the mechanism of the MBOM Editor. Please review these settings carefully.

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Viewer Part Number Mapping

The MBOM Editor will load the selected EBOM item's viewable in the viewer and allow for interactions between the BOMs and the viewer. However, this requires a mappging of your item numbers and the property within the dwf which holds the item number as well.

For a proper match, see the 'viewer' parameters at the end of settings.js. Provide the field ID of your Number field in EBOM workspace as 'fieldIdPartNumber'. Additionally, provide a list of possible property names in 'partNumberProperties' that might be present in your dwf files and contain the matching number too - the first occurence will be taken into account.

export.config = {'viewer' : {'fieldIdPartNumber' : 'NUMBER''partNumberProperties' : ['Part Number', 'Name', 'label', 'Artikelnummer', 'Bauteilnummer'],'backgroundColor' : 255,'groundReflection' : false,'groundShadow' : true...}}

Launching the MBOM Editor in context

The editor cannot only be launched from an item, but also from context records which refer to both an Engineering BOM and a Manufacturing BOM. For example, you may want to launch the MBOM Editor from a Product, a Project or an Asset to transform its EBOM to a MBOM. This can be accomplished by adding the link for starting the MBOM Editor to the Item Details of the given workspace as well.

The given context workspace only requires the two fields to link the EBOM and MBOM. It does not require any adjustments to the BOM tab and its permissions as the editor will determine the base EBOM and from there use the Items workspace configuration settings. Note that the editor can only be launched in context if either the EBOM or MBOM is selected for the context object (Product, Project, Asset). If the EBOM item is found, but the matching MBOM item does not exist yet, the latter one will be created and linked to the context object automatically.

Assuming your context workspace (Products, Projects or Asset) uses the same fields defined for linkig the E/MBOM items as your Items workspace (EBOM + MBOM), simply use the folloowing computed field formlua for adding an Action field which launches the MBOM Editor (this time, pass the workspace ID of your context object, for example 95 for Products).

'<a style="color: #0a131c;border: 1px solid #bec8d2;border-radius:3px;text-align:center;text-decoration:none !important;line-height:32px;white-space:nowrap;padding:4px 20px;width:140px;font-weight:600;" target="_blank" href ="LOCATIONmbom?wsId=95&dmsId='||DMS_ID||'">Edit MBOM</a>'

However, if your context object uses other fields for the E/MBOM links than defined by the settings fieldIdEBOM and fieldIdMBOM, you will instead have to also pass these given fieldIds using additional parameters in the URL. See the following example including the parameters contextFieldIdEBOM=ENGINEEERING_BOM and contextFieldIdMBOM=MANUFACTURING_BOM :

'<a style="color: #0a131c;border: 1px solid #bec8d2;border-radius:3px;text-align:center;text-decoration:none !important;line-height:32px;white-space:nowrap;padding:4px 20px;width:140px;font-weight:600;" target="_blank" href ="LOCATIONmbom?wsId=95&dmsId='||DMS_ID||'&contextFieldIdEBOM=ENGINEERING_BOM&contextFieldIdMBOM=MANUFACTURING_BOM">Edit MBOM</a>'

Support for multiple sites

With the standard configuration steps above, there will be only one MBOM per EBOM. However, the setup can be changed to support multiple MBOMs, for example to have site specific MBOMs. To achieve this setup, the fields that were created formerly must be cloned for each site.

By following the steps below, the existing fields will be kept in order to have a 'standard' base MBOM. In addition, further fields will be added to capture the MBOM for 'Site 1' and 'Site 2'.
Each site requires a unique id that you can define yourself. This id must be used to name the new fields and it will be passed to the MBOM editor to define the site context. In this setup, 'G' will be used for the generic MBOM while '1' and '2' are used for the site specific MBOMs. Keep in mind that these suffixes will get appended to all site specific MBOM item numbers.

1. In the EBOM workspace, adjust the layout of the MBOM transition section as shown below, by adding a second matrixes to hold all the site specific contents:
2. Create new fields for the 2nd matrix. You have to create the same fields multiple times, one for each site. Always append the site index (G, 1, 2) to each field while keeping the field base name identical. Here are the fields for the Generic MBOM:
   • MBOM_G: Linking picklist to MBOM item workspace (single selection, editable)
   • LAST_MBOM_SYNC_G: Date field (editable)
   • LAST_MBOM_USER_G: Single Line Text (length 100, editable)
   • MBOM_EDITOR_G: Computed field with the following formula. Note that the URL contains a parameter to identify the site (G)

   CASE WHEN (DMS_ID is null) THEN 'Item ID is not set'WHEN (END_ITEM = true) THEN 'Not available for end items'WHEN (MATCHES_MBOM = true) THEN 'EBOM matches MBOM'ELSE '<a style="color: #0a131c;border: 1px solid #bec8d2;border-radius:3px;text-align:center;text-decoration:none !important;line-height:32px;white-space:nowrap;padding:4px 20px;width:140px;font-weight:600;" target="_blank" href ="LOCATIONmbom?wsId=57&dmsId='||DMS_ID||'&options=site:G">Edit MBOM</a>'END

   Repeat these steps for site 1 and 2 accordingly.

3. If you followed the setup instructions for a single MBOM before, remove the following fields as they are no longer required:
   • MBOM
   • Last MBOM Sync
   • Last MBOM User
   • MBOM Editor
4. In the end, the MBOM section should look like this:

   Note that you can choose other field labels of course. This documentation only reuses the field ID to better describe the setup process.

5. In the EBOM workspace's BOM view MBOM Transition add the following columns:
   • MBOM_G
   • MBOM_1
   • MBOM_2
   

   Note that your bom view might be named differently. Check for the name in use by validating setting mbom.bomViewNameEBOM in settings.js

Users are now able to open the editor for a specific site. Each site will receive a specific MBOM with a dedicated part number (the site suffix gets appended at the end):

Features

• Creates a new Service BOM when needed during editor startup
• Reuses EBOM items with dedicated property as Spare Parts
• Manages Service Kits to define parts which can only/also be ordered as part of kits
• Users can change item sequence using drag & drop
• When pressing the [Shift] during drag & drop, items will get copied and not moved
• Viewer can be used to review Service BOM item selection
• Items can be selected in viewer to be highlighted in BOM
• Users can add non-EBOM items to the Service BOM using Bookmarks, Searches and further tabs
• The SBOM Editor can be launched from a Product of the Product Portfolio Management
• Details panel can be toggled to explore details of selected items

Important: This editor is not compliant with the Service Portal yet. The portal will not use the Service BOM created by this editor.

Configuration Changes for Items Workspace

Extend Picklist Item Types

This editor uses the existing Items workspace to store the Service BOM. It uses the field Type in item details to distinguish between the various item types used by the Service BOM. The picklist of this property Type must be adjusted to inlcude the required options as shown below. If your tenant does not contain the picklist Item Types and the matching field in Item Details, you must add this list and field - or use the configuration settings described further below to use another list and field that might exist in your tenant already.

Open the Picklist Manager from within Administration | System Configuration and locate the list Item Types. Click the Edit command to the very right to open this list's editor.

Add the following types to this list and click Save:

• Service BOM
• Service Kit
• Service Offering
• Service Operation
• Spare Parts List

With this change, you should now be able to select from these types when creating an item:

Adjust Icon Field Formula (Optional)

To let users esily recognize Service BOM items, it is recommended (but not required) to adjust the computed field formula of the field Icon. Add when-conditions for the new types as shown below. Note that the new IDs used below (100-103) will not match your tenant. You will have to determine the IDs for your tenant specifically. To do so, you can print the value of TYPE in another temporary computed field to determine the right values for the new possible property values.

'<div style="width:48px;line-height:18px;height:18px;border-radius:3px;text-align:center;font-weight:600;font-size:10px;color:#FFF;background-color:'||CASEWHEN (TYPE = 1) THEN '#AD4E7E">SW</div>'WHEN (TYPE = 2) THEN '#8c714d">PKG</div>'WHEN (TYPE = 3) THEN '#299BA6">E/E</div>'WHEN (TYPE = 4) THEN '#A68932">OTH</div>'WHEN (TYPE = 5) THEN '#8256BF">MCAD</div>'WHEN (TYPE = 34) THEN '#6a9728">MBOM</div>'WHEN (TYPE = 67) THEN '#222222">TLA</div>'WHEN (TYPE = 101) THEN '#0696D7">KIT</div>'WHEN (TYPE = 103) THEN '#BFA34D">SBOM</div>'WHEN (TYPE = 100) THEN '#BFA34D">sOFFER</div>'WHEN (TYPE = 102) THEN '#BFA34D">sOPER</div>'WHEN (TYPE = 104) THEN '#BFA34D">SPL</div>'ELSE '#c2cdd3">?</div>'END

BOM View

The Service BOM editor requires a BOM view in workspace Items with at least the following columns:

• Descriptor
• Number
• Title
• Type
• Quantity
• Spare / Wear Part (This field provided by standard tenants can be used by engineering to predefine spare parts within the EBOM)

You may add the column Icon as well as this helps users to better understand the structure, but this is not required.

Your tenant may contain the view Service with these columns already, which will be used automatically. If not, please create this view or provide the name of an existing BOM view to reuse in the configuration settings (see given chapter further below).

Enabling Editor Access

Techincally, the editor can be opened from any context record that has a reference to both an Engineering BOM and a Service BOM. The following steps explain how to configure the editor for the Products workspace, but you can also adapt this setup to your workspace of preference.

Add BOM Picklist fields to workspace Products

The Products requires two fields for the editor to work: One field containing the EBOM reference and another one referring to the matching Service BOM. Please create these two fields as shown in the screenshot below and place them anywhere in the details page. Please note that the standard Products workspace already contains the given field for the Engineering BOM so you can clone it to create the matching field for the Service BOM easily.

Both fields must be of type Single Pick List with reference to the Items workspace.

Place these field anywhere in the details page of your Products workspace:

Add DMS_ID field to workspace Products

Launching the editor from the Products page also requires a hidden field which stores the product's dmsID. Add the hidden field DMS_ID of type Single Line Text field to your Products workspace and add it to any of the sections in your details page:

The value of this field must be set by script when new records get created:

item.DMS_ID = dmsID;

Add this line to the existing script Products WF Actions at the initial transition. As an alternative, you can also add this line it to your onCreate script for Products (if in use).

switch(customTransID) {case 'NEW':item.DMS_ID = dmsID;reset();setMilestone(statesInWork[0], "ENTER", new Date(), null, 0, 0, true); setDefaultMilestones();break; .. }

Pro Tipp: If you have existing Products in your tenant already and want to store the dmsID in this new field for the existing products as well, you can use the Data Manager . This utility provides a matching batch processing action and can be used immediately without any further setup.

Add Action button to workspace Products

In order to launch the Service BOM editor from a Product, a computed field can be used to render the matching link as button:

CASE WHEN (ENGINEERING_BOM is not null) THEN '<a style="margin-right:10px;border: 1px solid #bec8d2;border-radius:3px;color: #0a131c;font-weight:600;line-height:32px;padding:4px 20px;text-align:center;text-decoration:none !important;white-space:nowrap;" target="_blank" href ="LOCATIONsbom?wsId=95&dmsId='||DMS_ID||'">Edit Service BOM</a>'ELSE ''END

You can either create a new field for this button specifically or add it to the standard Actions field provided with the standard Product workspace. In the latter case, append the formula to the existing field using the pipe symbol twice:

Now you're ready to use the editor with default settings

Configuration Settings in settings.js

The server's settings.js file contains configuration settings enabling you to adjust the application. One can even apply the editor's capabilities to other type of BOMs if needed. Using the bomTypes property, it is not only possible to adjust the tabs being displayed in the editor, but also the matching filters and type values to use.

Anyway, if you followed the setup instructions above, there is no need to change any of these settings. Only do so if you want to change labels, fieldIds or BOM views for example. Keep in mind that if you change this file, a restart of your UX server is required.

export.config = {sbom : {appTitle : 'Service BOM Editor',sourceBOM : { .. },targetBOM : { .. },itemsFieldIds : { .. },picklistIdItemType : 'CUSTOM_LOOKUP_ITEM_TYPES',itemHighlight : { .. },bomTypes : [{ .. },{ .. }],enableBOMPin : false,viewerFeatures : { .. }}}

See the table below for details about these settings.

The standard configuration of this utility enables users to define the Service BOM consisting of

• Spare Parts List
• Maintenance Kits
• and Service Offerings

This is achieved by providing the matching list of bomTypes in the settings file. These settings can be adjusted to change / remove existing tabs, but also to adopt the capabilities of this editor to other use cases. Below, you can find the default settings being used by the 3 standnard tabs as reference.

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

• Manage variant items that inherit master data from the base item
• 3D viewer helps to identify the right items
• Keep multiple BOM structures in sync
• Manage multiple variants at the same time or focus a single variant only
• Dynamically define the properties that define a variant

New Workspace Item Variants

A new workspace is required to manage the item variants and their BOMs. These item variants in this new workspace will refer to the given base item to allow for data reuse by using derived fields, but will also have additional fields that define a variant (i.e. color, material, dimeions, serial #, ...). Customers can choose any properties they like for these variant specific properties, the application will adjust accordingly.

Create new workspace

Use the Workspace Manager to create new workspace Item Variants as revision controlled workspace.

Set Item Details of new workspace

Create the following 3 sections in tab Item Details :

• Header
• Variant Definition
• Base Item Details

Add the following fields to section Header:

Add a field that derives the Number of the selected Base Item in section Base Item Details:

Additionally, add all further data that should be derived from the Base Item in this section. You can add any derived field you want in order to copy data from the given Base Item. This may for example include Type and Description. However, Image fields are not supported.

Finally, add all the fields that will be used to define a variant (for example Colour and Material) in section Variant Definition. This section may include any type of field, including pick lists (with single selection) but not Images. The fields of this section later on will be used to automatically generate a title for the new variant items being created. See the follwoing properties in file settings.js as described in a later step.

config.variants.newItemVariantsTitle.fieldsToConcatenate : ['COLOUR', 'MATERIAL']config.variants.newItemVariantsTitle.separator : ' / '

Descriptor

Set the workspace's Descriptor to display the fields Base Item Numberand Title:

Bill of Materials tab

Add a new BOM field BASE_BOM_PATH of type Single Line Text. This field should have a length of 1000 characters and not be visible, but editable.

Clone the Default View to create a new BOM view with name Variant Manager. This view should contain the following columns only (sequence does not matter):

Add all the Item Details fields of section Variant Definition to this table as they are used to define the varians (for example Colour and Material).

Workspace Relationships

Enable required Workspace Relationships in the BOM and Relationships tabs:

Tab Names (Optional Step)

Adjust the names and sequence of tabs as shown below.

Access Permissions

Create a role for the new workspace enabling creation of new records, BOM management and attachments. Access to the Sourcing tab is not required, but can be granted to allow for cost comparison across variants. Make sure that users also can access the working versions of records.

Server Settings File

The Workspace ID of this new workspace Item Variants must be provided in the server settings file. Locate the property config.variants.workspaceItemVariants.workspaceId and update the given value.

Adjust Change Management Workspaces

As Item Variants are revision controlled, add this new workspace to the Workspace Relationships in tab Managed Items of the following workspaces:

• Problem Reports
• Change Requests
• Change Orders

Adjust Items Workspace

Configure BOM View

The application requires a BOM view in workspace Items with at least the following columns:

This view will be used to expand the base BOM. You may reuse an existing view (i.e. Basic) or add a new view instead. While this given view may also contain further columns without impacting the Variant Manager, the performance of the editor will be better the less columns are contained in this BOM view.

If you prefer to / or cannot use the BOM view Basic, you have to speficfy this view's name in the server's settings file in parameter.

config.variants.workspaceItems.bomViewName : 'Basic'

Add Button

Users should be able to launch the Variant Manager from any item of workspace Items in PLM. This can be achieved easily by installing the Chrome Extension that is provided with this UX package and which can be used in Mircrosoft Edge and Goolge Chrome. Click the following button to learn about the installation of this extension. Once this Chrome Extension is installed, the given button will automatically be displayed in the header of each item and you can proceed with the next chapter.

If you cannot / don't want to use this extension, you will instead have to add a computed field in the Item Details page which renders the given button. This also requires a field to store the dmsID in a hidden field.

Add hidden field to store dmsID

If not present yet, add a new Single Line Text field with id DMS_ID in the Items workspace. This field should not be visible. Let this field be set automatically at item creation by script as shown below.
Tenants created mid 2023 or later have this field and script already.

item.DMS_ID = dmsID;

Add Computed Field with Action Button

Enable access to the Variants Manager by adding a new computed field to your Items workspace. Use the following formula for the new field:

'<a style="border: 1px solid #bec8d2;border-radius:3px;color: #0a131c;font-weight:600;line-height:32px;padding:4px 20px;text-align:center;text-decoration:none !important;white-space:nowrap;" target="_blank" href ="LOCATIONvariants?wsId=57&dmsId='||DMS_ID||'">Variant Manager</a>'

Optional: Integrate With Products Workspace

Instead of starting the Variant Manager from an item, you can also start it from a product. In this case, the product's Engineering BOM will be used as a basis and all variants will be stored within the product's list of variants (the grid tab). Perform the following steps to enable this integrated feature.

Adjust Grid tab of workspace Products

Add a column BOM to the grid based on a pick list for workspace Item Variants:

Add Button

Users should be able to launch the Variant Manager from any product. This can be achieved easily by installing the Chrome Extension that is provided with this UX package and which can be used in Mircrosoft Edge and Goolge Chrome. Once this Chrome Extension is installed, the given button will automatically be displayed in the header of each product. The default configuration of this extension will use the field ENGINEERING_BOM of workspace Products to locate the matching item. If this field does not exist, you will have to update the given button's configuration in settings.js. Click the following button to learn about the installation and configuration of this extension.

If you cannot / don't want to use this extension, you will instead have to add a computed field in the Item Details page of Products which renders the given button. This also requires a field to store the dmsID in a hidden field.

Add hidden field to store dmsID

If not present yet, add a new Single Line Text field with id DMS_ID in the Products workspace. This field should not be visible.
Let this field be set automatically at item creation by script as shown below.

item.DMS_ID = dmsID;

Add Computed Field with Action Button

Enable access to the Variants Manager app by using the computed field formula shown below. Note that this formula must be adjusted if your product's EBOM is not stored in field ENGINEERING_BOM. You also must replace the workspace ID of 95 with the id of your Products workspace.

'<a style="border: 1px solid #bec8d2;border-radius:3px;color: #0a131c;font-weight:600;line-height:32px;padding:4px 20px;text-align:center;text-decoration:none !important;white-space:nowrap;" target="_blank" href ="LOCATIONvariants?wsId=95&dmsId='||DMS_ID||'&options=fieldIdEBOM:ENGINEERING_BOM">Variant Manager</a>'

Server Settings File Details

If you require usage of different field names, table names etc, please have a look at the settings.js file and locate section variants, listing all possible configurable settings as shown below. You will have to change the first option's value ( workspaceItemVariants.workspaceId ) which must contain the workspace ID of your newly created workspaceItem Variants. You can retrieve this ID from your browser's URL when navigating to this workspace using the workspaces menu. The remaining options are aligned with default tenants and the preceeding instructions already.

export.config = {variants : {workspaceItems : {bomViewName : 'Basic'},workspaceItemVariants : {workspaceId : 373,sectionLabel : 'Variant Definition',fieldIds : {baseItem : 'BASE_ITEM',title : 'TITLE',rootDMSId : 'BASE_ROOT_DMS_ID'},bomFieldIdBaseBOMPath : 'BASE_BOM_PATH',bomViewName : 'Variant Manager'},newItemVariantsTitle : {fieldsToConcatenate : ['COLOUR', 'MATERIAL'],separator : ' / '},maxBOMLevels : 4viewerFeatures : {..}}}

Adjust these settings if needed and restart your server afterwards to apply the given changes.

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

• Can be launched in context of an Asset
• Reuse the Engineering BOM and viewable for a best in class user experience
• Configurable framework allows reuse of this editor for multiple use cases
• The editor is preconfigured for the management of Serial Numbers as reference
• Automatic sync of instance data with the Engineering BOM ensures data integrity

Preconfigured use case of Serial Numbers

This solution's preconfiguration requires installation of the new template Assets Lifecycle & Projects which is available for testing only (as of December 2025). This template includes the required workspaces of Assets and Serial Numbers Lists. As the configuration settings of this application eanble use of custom workspaces and fields, similar workspaces also can be created manually. With the preconfiguration, the solution can immediately manage the Serial Numbers List of an Asset within the list's grid. The solution also requires the Chrome Extensions of this package to be installed on the clients, providing access to the editor in context of an Asset.

If both prerequisites are met, users can launch the given editor using the button in the item header as shown below. This button will be displayed in the header of each Asset and use the related Serial Numbers List referenced in the item details page.

Once launched, the editor will display the Asset's Engineering BOM on the left side and its root item's viewable on top. The main action button in the main toolbar then can be used to retrieve all items in the Engineering BOM that match the defined property filtes. The default configuration profle for example will locat all items being flagged as item with serial number (per workspace configuration described in next chapter).

For each of these items, the system will create one entry per instance in the grid table below the viewer, allowing to manage instance specific data for each of these items. Users can select these table rows to have the matching component highlighted in the viewer and to have the BOM structure displayed accordingly. The BOM also can be used to filter the list of table entries by the instances within the selected context.

When users hit the Save button, the given data will be stored in the grid tab of the related Serial Nunbers List item:

Setup Items Workspace

The default configuration requires the field Serial Number which must be added to your Items workspace before.
Add a new field as shown below and place this field in any of your item workspace's sections:

This field (as well as the field Number) must be contained in the BOM view used by the BOM Instance Editor. According to default configuration, this utility will use the BOM view Instance Editor - which you will also have to create if it does not exist yet. However, you can also use an existing BOM view instead. Simply add the Serial Number field (and Number field) to this BOM view and update the configuration setting instances.bomViewName in settings.js accordingly (see later chapter for details on configuration settings).

Adoption for further use cases

Although the default configuration is preconfigured for the management of Serial Numbers of Assets, you can easily adapt this solution to other use cases. For example, you can replace Assets with another workspace but also use other worksapces than the Serial Numbers List for the management of instance specific properties. You can also use multiple workspaces with dedicated properties to manage a list of motors and a list of sensors as well as a list of control elements at the same time. When configured properly, the editor then will display one tab for each of these workspaces with a unique set of properties:

Replacing the Assets workspace

In order to use another workspace as context element, provide this workspace's ID in setting instances.assets.workspaceId. If this workspace connects the matching EBOM in a field other than the default field ENGINEERING_BOM, you also will have to update the setting instances.assets.fieldIdBOM accordingly.

Adding further tabs / workspaces

As can be seen in the application screenshot above, the schema can be adjusted to allow for management of other information other than Serial Numbers. There can even be multiple tabs to split information by instance and to manage dedicated properties within defined columns.

For this, you will have to create the new workspaces that will store the instance specific data for each item in your BOM. You may clone the existing Serial Number Lists workspace as a starting point as it has all required information already. Your new workspaces must contain the following columns in their grid tabs to enable location of matching instances in the viewer and BOM:

Do not forget to configure the matching access permissions for your new workspaces. Include permission to adjust the Grid tab entries as well as they will be adjusted by the editor.
Once the custom workpaces are available, you must add linking picklist fields on your context element (i.e. the Asset) for each of them. There must be one field per workspace.

The editor can add the BOM entries to the matching tab automatically. However, this requires a property on the BOM items to identify the entries of interest. Add a property in the Items workspace which can be used later to filter for the items of interest. For example, the capability of Serial Numbers management uses the checkbox field SERIAL_NUBMER. You can also add specific checkboxes, but can also use pick list fields for example.

Once the workspaces have been configured properly, you must update the configuration settings of this application to take these workspaces into account. The setting instances.tabs can be used to provide a list of tabs to be displayed. It is recommended to copy the existing configuration profile of serial numbers and to adopt it for the additional workspaces. The standard settings.js file even contains further templates that were commented out. They also can be used as a starting point.

All settings listed below must be provided for each tab / workspace. The default values in this table refer to the Serial Numbers setup.

All Configuration Settings Explained

This secion describes all the configuration settings of this application which can be found in settings.js within exports.config.instances.

Note that changes to this file require a restart of your server.

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

• Can be launched in context of an Asset
• Reuse the Engineering BOM and viewable for a best in class user experience
• Create the derived Asset Items BOM with single clicks
• Creates asset items for all intermediate parents automatically
• Colors indicate the levels containing asset specific items
• Manage instance specific properties and derive information from the referenced base item

Prerequisites

This solution requires installation of the new template Assets Lifecycle & Projects which is available for testing only (as of December 2025). This template includes the required workspaces of Assets and Asset Items. The solution also requires the Chrome Extensions of this package on each client, providing access to the editor in context of Assets.

User Guide

Launching the editor

Once the prerequisites are met, users can launch the editor using the button in the Asset's header as shown below. If the editor is launched for the first time for an asset, it will create and connect the given root Asset BOM item automatically. This item can be found in section Asset Configuration and will be reused when the editor is launched next time.

Deriving the Asset BOM

Once launched, the editor will display the Asset's Engineering BOM and its root item's viewable.
The column Asset Item is added to the EBOM display, enabling the derivation of the Asset BOM.

At the very beginning, there will be no Asset Items at all and users can create the required Asset Items within this BOM column by simply clicking the Create Item button. This can be done on any level, the system will automatically create Asset Items for all the intermediate parents in the Asset BOM if needed. Once an Asset Item has been created, the given item's number will be displayed and the color indicator of the BOM row will turn to green. For proper lifecycle management on all levels, the editor will always create a new Asset Item for each BOM row, even if an item is reused within the same assembly. With this, users can later on document the replacement of a given component in a speciic location only.

Next to this column, key properties can be managed for each Asset Item, including Spare Part and Serial Number indicators. While the Asset Item has not been created, these columns indicate the given EBOM item's defaults. When the Asset Item gets created with the given button, this default will be copied to the new Asset Item. Aftewrwards, users can still modify this property for the given Asset Item using the checkboxes if needed.

Advanced Features

Once the Asset Items got created, users benefit from additional features provided by the buttons in the main toolbar as well as the BOM's toolbar. The buttons Spare Partsand Purchased Partswill list all Asset Items that were flagged accoridingly. With button Serial Numbers user can access the Serial Numbers List entries connected with the context Asset.

The button Side Panel can be used to toggle the details panel for the selected component on/off. When users select a row with an Asset Item, this will display this item's details. If the Asset Item has not been created yet for the selected BOM row, the Engineering BOM item's details will be displayed instead. If no BOM row is selected, the Asset's details will be displayed.

If there are Order Project Deliveries defined for the context Asset, the toggle Deliveries Assignment can be used to easily connect the Asset Items with the given deliveries. These deliveries then will be used for the lifecycle management of the given items, similar to the Change Orders for Engineering BOM items.

Items Workspace Adjustments

BOM View

For the alignment of EBOM and Asset BOM, the editor requires a BOM view in the Items workspace with all the fields listed below. Per default configuration, this BOM view must be named Asset BOM Editor , but this name can be changed using the given configuration setting (see further down below). This also allows to reuse an existing BOM view as long as the view contains at least all the fields listed below.

Derived Fields

This editor uses the workspace Asset Items provided by the template Assets Lifecycle & Projects. These items not only are connected to the context Asset, but also the EBOM's source item. This connection to the Refernce Item can be used to derive properties from the source EBOM item. Use the Workspace Manager to configure these derived fields if needed.

Configuration Settings

This secion describes all the configuration settings of this application which can be found in settings.js within exports.config.abom.

These settings allow for adoption to your environment if needed. Note that changes to this file require a restart of your server.

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

You can use this solution with any workspace that has the Classification section enabled. When opened as standalone application, users can browse the classification tree and search within the classes. On the other hand, when the Chrome Extensions are installed, users can also open the browser from an item that has been classified and see all items that share the same class as the source item.

Prerequisites

The browser can be used as standalone application without any further setup. Once the Chrome Extensions are installed, the browser also is automatically preconfigured to be launched from the Items workspace. Only if the browser also should be accessible from other workspaces, you will have to add the given button for your workspace using the settings file.

In such cases, locate the workspaces definition of exports.chrome. Ensure that your workspace ID is listed and correct. Validate that the configuration of the Class Browser button in buttons has the given workspace name in the list of workspaces.

Prerequisites

You must have the latest Design Review app installed from the App Store. If your tenant is based on a template past April 2021, this given app is included already. To check if your tenant contains this latest app, please verify that the workspace Design Review Tasks is available in your tenant.

Configure Workspace Design Reviews

Use the Workspace Manager to perform the following changes to your workspace Design Reviews:

1. Add section Design Data if it does not exist
2. Add the field Item (id ITEM) to it if it does not exist yet. Make this a single selection picklist field referring to workspace Items (or Vault Items and BOMs if Items does not exist)
3. Also, add the field Image (id IMAGE) as derived field of the previous field and let it derive the image field

Configure Workspace Design Review Tasks

Use the Workspace Manager to perform the following changes to your workspace Design Review Tasks:

1. Add an image field MARKUP to the first section
2. Add two fields of type paragraph: MARKUPSTATE and MARKUPSVG. Set maximum length to 1.000.000 for both fields and set their visibility to Never. Set them to be editable anyway. Add these two fields to the first section of Item Details.
3. The following fields must be editable at creation:
   • TITLE
   • DESCRIPTION
   • DESIGN_REVIEW
   • TARGET_COMPLETION_DATE
4. Field ASSIGNEE must NOT be mandatory
5. Disable Workflow Locking for all sections
6. Enable transition Return also for the Owner. If this permission is not granted, the creation of tasks will fail as the given user cannot upload the markup image after task creation.

Grant permission to Add Items in workspace Design Review Tasks for all the users which will use the Design Review Portal.

Script Changes

Let new Design Review Tasks be connected to the related Design Review by adding the following script to the initial workflow transition (from the Start Node) in workspaces Design Review Tasks:

if(item.DESIGN_REVIEW !== null) { item.DESIGN_REVIEW.project.addTask(item); }

Adjust the script Design Reviews WF Actions by extending the if statement with the following condition as shown in the screenshot below:

item.project.children.length === 0

BOM View configuration for Items workspace

This solution requires a BOM view in the Items workspace which includes the Number field. Only if this column is present, the cross-highlight between the BOM and the viewer will work. The latest tenant template includes such a view Basic already and this solution will use this view automatically. Perform the following steps if this standard Basic view does not exist in your tenant. If it exists, make sure that the basic columns required are included in this view:

1. Descriptor
2. Quantity
3. Number

Use the Workspace Manager to add a new view in the Bill of Materials Tab with the columns shown in the screenshot below. Note that for performance reasons, it is recommended to use a BOM view with the bare minimum of fields only. Anyway, you can add further fields to this view or reuse another view which includes these fields already to not mess up your BOM views.

If your BOM view of choice is not named Basic, you will have to provide this view's name in file settings.js using parameter bomViewName. See the next chapter for details. Keep in mind that you have restart your server to apply the changes to settings.js.

Configuration Settings

Locate the reviews section in file settings.js shown below to adjust your confiugration if needed. These settings are aligned with the latest default tenant as much as possible. After changing this settings file, you have to restart your node server to get them applied.

export.config = {'reviews' : {'fieldIdItem' : 'ITEM','fieldIdImage' : 'IMAGE','fieldIdMarkup' : 'MARKUP','transitionId' : 'CLOSE_REVIEW','bomViewName' : 'Basic','viewerFeatures' : {'cube' : false,'orbit' : false,..},'workspaces' : {'reviews' : {'id' : 76,'sections' : [ { 'name' : 'Review Findings' } ],'states' : [ 'Planning', 'Preparation', 'In Progress' ]},'tasks' : {'id' : '','sections' : [ { 'name' : 'Definition' }, { 'name' : 'Schedule' } ],'states' : [ 'Assigned', 'On Hold', 'In Work', 'Review', 'Complete' ]}},}}

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

With this application, users can by far better assess the impact of changes by reviewing all details of the given Change Order's list of Affected Items.
To do so, multiple information is retrieved in parallel and devided in various tables. So for each affected item, users can easily review the following information:

• 3D view of the attached dwf
• Change Log tab reveals the item's change log
• The Item tab shows details defined in the affected items tab itself
• All Item Details can be reviewed in the Details tab
• The flat BOM can be listed in the BOM tab, where items that got changed will be highlighted by color.
• Users can select items in the BOM tab and have the given component highlighted in the 3D view
• The Where Used tab will be used to retrieve all End Items of an item (the root item nodes not having any further parents). In this view, users can also add the given nodes to the CO's list of Affected Items.
• In tab Impacted, users can see all records linked to the affected item within its Relationships tab. This tab also will show all BOM root nodes which are neither managed in the 'Items and BOMs' nor in the 'Vault Items and BOMs' workspace. The latter one will for example show if a component is used within a product's BOM.
• Inside the Impacted tab, users can easily link given records of interest to the current Change Order's References tab for later reuse
• In tab Changed Items, users can get the list of all BOM sub items where the working version got modified and which are not listed in the list of Affected Items yet
• The item's Attachments can be opened in the Files tab
• All item related change processes are listed in tab Processes

Configuration Changes

Peform the following changes to workspace Change Orders to enable the impact analysis before releasing a change. In addition, you can perform the same changes in workspace Change Requests to benefit of the exact same features while accessing impact of a proposed change.

Store DMSID

In order to make this dashboard work, you have to add a (hidden) field DMS_ID to the item details tab. This field must store the dmsID of the current process.

Use the following script code at Change Orders / Change Requests creation to store the given dmsID (attach this script to the initial workflow transition or the given create event):

item.DMS_ID = dmsID;

Action Button

Add a button to the Item Details tab, enabling to open the analysis dashboard in context ...

... implement this button by adding a computed field Actions with the formula shown below. Replace the workspace ID to match yours (..wsId=84..). In a standard tenant, 84 matches the Change Orders and 83 matches the Change Requests workspace.

'<a style="border: 1px solid #bec8d2;border-radius:3px;color: #0a131c;font-weight:600;line-height:32px;padding:4px 20px;text-align:center;text-decoration:none !important;white-space:nowrap;width:160px;" target="_blank" href ="LOCATIONimpactanalysis?wsId=84&dmsId='||DMS_ID||'">Impact Analysis</a>'

Set Workspace Relationships (optional)

The impact analysis dashboard enables to connect records of interest to the current change process. For example, the dashboard will retrieve related Requirements of each affected item - which then can be connected to the change process inside the dashboard for reference. This helps to create a comprehensive list of all data being impacted by a change. This mechanism requires to allow the given workspace relationships within the Workspace Manager. For example, you may want to enable Relationships for the change proceses to the workspaces Requirements and Supplier Packages. The dashboard will take this workspace configuration into account and only offer to connect workspaces that are valid.

Access the Dashboard

The dashboard also can be opened by using the /impactanalysis endpoint, followed by wsId and dmsId. If your tenant contains the standard demo dataset, you can use the following link to open the dashboard for a given Change Order:

Features

Provide an online interface for service technicians to have latest product information at hand at anytime, anywhere.

• View the 3D design in context of the BOM
• Browse and filter the product BOM
• Select BOM items to retrieve all details
• Download item documentation
• Access list of defined Spare Parts
• Submit Spare Part Requests
• Capture Problem Reports
• Browse catalog of serviceable products and assets
• View and update assigned Asset Services
• Track progression of and update formerly created Spare Parts Requests
• Track progression of and update formerly created Problem Reports

Prerequisites

• This solution is based on the standard Items workspace and its standard properties.
• If the Service Portal should (also) be launched from the Fusion Manage standard user interface, the Chrome Exteionns provided with this package must be installed.
• Spare parts get identified by the standard field Spare Wear Part of workspace Items. If this property's value is set to Spare Part or Wear Part for an item, it will be treated as spare part in this portal. The list of valid values can be configured in the settings.js file.
• If the portal is opened in context of a Product or Asset having a related Service BOM defined, this Service BOM will be used instead.
• In order to create and manage the Spare Part Requests processes, the given workspace is required in your tenant. Recent demo and trial tenants include this workspace already. If the workspace does not exist, you can follow the steps described further down below for a basic configuration of this workspace - or download the Spare Parts Requests template from the library. In the latter case, make sure that the request's details tab and grid entries can link to your Items workspace in the given fields.

If Spare Parts Requests are used, users will be able to track and update these requests within the Service Portal as well:

Setup Instructions

Create BOM View 'Service' for workspace Items

Create a new BOM view Service for workspace Items and add at least the columns shown below. The sequence of columns does not matter. You may add further fields if needed, but this may impact performance / load times of the portal.

Configure Workspace Relationships of Problem Reports

Open the Workspace Relationships control for workspace Problem Reports in the Workspace Manager. In here, enable connections to workspace Items in Managed Items Tab in order to support creation of new PRs.

Modes

The Service Portal can be opened in different modes, it will automatically adapt to the given use case.

Mode #1 : In context of an Item defined by wsId/dmsId

When opening the portal with URL parameters wsId and dmsId pointing to an item record, the portal will retrieve the EBOM of the given item and display its structure. Service technicians can navigate through the BOM, select spare parts and create Spare Parts Requests or Problem Reports in context of the selected item. In this scenario, Spare Parts are determined by the defined property on the EBOM items.

See below the example layout of http://localhost:8080/service?wsId=57&dmsId=14669

Mode #2 : In context of an Item defined by Part Number

Note that the same can be achieved by passing the URL parameter number followed by an item part number. In this case, the system will retreive the matching item first before then opening the related item's EBOM and viewable.

See belw the example layout of http://localhost:8080/service?number=002771

Mode #3 : Product Browser

If no wsId and dmsId are provided, the portal will open a landing page showing a catalog of serviceable products. Users can navigate through this catalog, select a product of interest and open its BOM to create Spare Parts Requests or Problem Reports in context of the selected product. The list of products being shown in the landing page can be configured using settings.js. The Spare Parts will be determined by the Product's Service BOM if available - if not, the related EBOM and the defined Spare Part flag attribute will be used.

See below the example layout of http://localhost:8080/service

Mode #4 : Asset Browser

If no wsId and dmsId are provided and the URL parameter &type=assets is contained instead, the portal will open a landing page showing an Asset browser as well as assigned Asset Service Tickets. Users can open such a service ticket or an asset directly. In both cases, the asset's Service BOM or Engieering BOM will be used for the viewer, BOM and Spare Parts list generation. This mode requires the installation of the given template from the library for the Asset management.

See below the example layout of http://localhost:8080/service?type=assets

Add New Workspace Spare Parts Requests

The Service Portal can be used to initiate Spare Parts Requests processes with reference to the currently selected spare parts. However, this feature requires the given workspace to manage these requests. If you do not want to manage these requests in PLM or if this workspace is availalbe in your tenant already, please skip this chapter.

If the workspace does not exist, you can follow the steps below for a basic configuration of this workspace - or download the Spare Parts Requests template from the library. In the latter case, make sure that the request's details tab and grid entries can link to your Items workspace in the given fields.

Add Workspace

Add a new workspace named Spare Parts Requests using the settings shown in the following screenshot:

Item Details Tab

Add the following fields to the new workspace. You may add further fields (non-mandatory) and sections when needed. You may also omit 'Requestor' in all the field labels, they are just used to keep the internal Field ID identical to the label to make the setup easier.

Descriptor

Set the descriptor for this workspace as you like (i.e. ID - Requestor Company)

Grid Tab

Add the following fields to the grid tab

Tab Names

Adjust the tab names for ease of use:

• Item Details > Request
• Grid > Part List
• Workflow Actions > Workflow

Scripts

Create a new Action script Spare Parts Requests WF Actions with the code shown below. Make sure to select library script getUserName in the script's imports.

item.REQUESTOR_NAME = getUserName();
item.REQUEST_DATE = new Date();

Workflow

Provide a workflow for this new workspace. While the workflow logic does not matter for this solution, make sure to attach the script Spare Parts Requests WF Actions as action script to the initial transition.

Access Permission

Add a role for this new workspace and assign this given role to your users to enable access. Grant full access (add, delete, edit and view) to the tabs Attachments, Grid, and Workflow.

Configuration Settings

Once the previous steps have been completed, you should review the solution's settings in file settings.js before using the application:

export.config = {service : {labels : { .. },products : { .. },items : { .. },sparePartsRequests : { .. },problemReports : { .. },serviceBOMTypes : { .. },assetServices : { .. },projects : { .. },assets : { .. },serialNumbers : { .. },..applicationFeatures : { homeButton : true, itemDetails : true, .. openInPLM : true},viewerFeatures : {contextMenu : false,cube : false,orbit : false,..selectFile : true} }}

Configuring Basic Settings

Configuring Service BOM Support

The following settings are required if the Service Portal should use the related Service BOM for the Spare Parts list creation instead of the Engineering BOM items. These settings must be aligned with the given configuration settings of the Service BOM Editor. Multiple settings must be defined for each major item type in the Service BOM, especially the Type field value (fieldValue). Both groupLabel and icon impact the disply of given BOM entries in the Service Portal.

Configuring support for Assets

The following settings are required if the Service Portal should support Assets and Asset Services based on the given template in the library (which is avaialble for testing only as of December 2025). They only apply when opening the portal with parameter &type=assets.

Configuring Panels

The portal contains multiple configurable panels: the Documentation tabe, the Item Details panel and the related Item Attachmens. The following settings can be used to adjust these panels' contents and behaviors if needed:

• paramsItemDetails
• paramsItemAttachments
• paramsDocumentation

Configuring Application Features

Selected application features can be restricted using the applicationFeatures property in settings.js. In general, if a property equals true, the given feature will be available for the user. You can use basic boolean values, but also make use of groups to grant access for defined user groups only. Examples:

• applicationFeatures.homeButton = true > The home button is available for all users
• applicationFeatures.homeButton = false > The home button is not visible for any user
• applicationFeatures.homeButton = ['Employees','Service Technician'] > The home button will only be shown for users in group Employees or Service Technician

The following settings control features within the application:

Configuring Viewer Features

This application enables configuration of features within the viewer by using parameter viewerFeatures. By using the settings listed below, you can control the availability of given icons in the viewer toolbar. These feaatures can be enabled and disabled for all users in general by setting the value to true or false. As an alternative, you can also provide an array of groups to grant access. Only users being assigned to any of the defined groups will then get access to the feature. Examples:

• viewerFeatures.measure = true > Measurements will be possible for all users
• viewerFeatures.measure = false > Measurements will not be possible for any user
• viewerFeatures.measure = ['Employees','Service Technician'] > The measurements button will only be shown for users in group Employees or Service Technician

Features

This utility enables various batch operations in order to fix inconsistencies of the data in PLM. This includes setting standard values for existing records, transitioning defined records or running a defined script against a selected set of records. Administrators can select the datasets to be processed by using workspaces views or search filters. The batch process can be tracked in the console, providing information about the success and failure of operations.

The following batch processes are provided with this utlity:

Using the utility

Select Data

First, you have to select the data to be processed. As the utility can only process data within a single workspace only, you have to select the given workspace first. Once the workspace selector changes, the screen will reload to reflect the given workspace's configuration.

Next, you have to filter for the data in this workspace by either using one of your workspace views or search filters. Once you select a workspace view, the filters will be hidden as it is not possible to combine both mechanism. Note that you can use any workspace view, the columns do not matter as the utility will only make use of the view's filters.

If you do not select a workspace view, the following filter sections will be available (depending on the selected workspace's type):

• Workflow Status
• Lifecycle Status
• Item Details Field Value
• Item Summary Data (creation, modification, owner)

As you change the options in the data selection panel, the console will continuously determine the number of matching records and display the counter. This counter update may take some time, but helps validating the filter settings:

Choose Action

The list of possible actions gets refreshed upon workspace selection as it takes into account the user's permission as well as the workspace's configuration.

You can only select on action at a time and must proivde the given inputs shown within the selection action (i.e. select the impacted field).

If you do not find an action that meets your requirement, you can use the action Run Script enabling you to run your custom onDemand script of the given workspace. The utility will launch the script for you per record and you can perform the required changes within your script. The usage of scripts is also recommended if the batch processes fail to perform the required update due to permission restrictions. As scripts are executed as super user, they may be able to perform the changes that might not be possible with the API in your user context.

Options : Selected Data

Before launching the batch job, you may want to adjust the options allowing you to perform follow-up actions per record and to adjust the runtime settings. While you will most probably never adjust most of the options, the first settings is very important:

The setting for Selected Data impacts the data retrieval: In order to run the batch jobs, the utility will search for the next set of (100) records which will then be processed before the next set of (100) records will be retrieved. The data retrievel will be based on the filters or workspace view that you selected in section Select Data . Once the inintial set of records got processed, these filters might return different results. For example, if you filter by items which do not have a value in field Type and then set a value for this field using this utility, the items which got processed already won't be returned by the intial filters any longer. This is important as the data retrieval will always continue retrieving the next records in sequence - and this sequence might change.

So if the batch processing modifies the records in a way so that they would no longer be retrieved, you must select the option ... gets reduced by filters . Only if the search results do not change by the batch operations, you can keep the default setting ... does not change at runtime .

Options : Expand & Include BOMs

If the user has access to the BOM tab in the select workspace, an additional option will be displayed next. By selecting from the options listed below, the user can also let the BOM items be processed by the same action.

If the BOM items will be included, the Search Size option mentioned further below will be set to 1 automatically.

Options : Follow-Up Action

Once the records got processed, you can let the utility update one or multiple checkbox or date properties. This can be used to trigger a follow-up edit event or to set a flag that helps filtering out the given record during the next run.

Options : Runtime Settings

Finally, multiple settings can be used to adjust the batch process execution:

The Console & Controls

While the processes are running, the console will indicate the progression and display success and error messages.
Please note that the item names can be clicked to open the given record in PLM for validation or troubleshooting purposes.

Once the processes finish, a summary will be displayed, indicating the total number of records and failures.
Using the button in the main toolbar, you can stop running processes (when the stop button is shown in red) at anytime. Use Clear Console to clear the contents of the console panel. This does not impact the data processing.

Access the utility

You can access the utlity with the /data endpoint, just click this link:

Prerequisites

Your user must have admin privileges to use this dashboard as it uses the system log entries which are hidden for standard users. This privilege will be validated during startup and an error message is shown if permissions are missing. Your user also must have access to the given workspaces that should be taken into account in the insights dashboard.

Please note that the dashboard will retrieve the system log information in small packages. This process takes some time. There is a progress inidicator in top right corner and on top of the header to inform you about the data retrieval progress. You can also review the total number of log entries being processed in tab 'System'.

Configuration Settings

You may want to review the solution's configuration settings in file settings.js to adjust this solution to your needs. This is the default configuration:

insights : {hideUserNames : false,maxLogEntries : 500000,maxEventLogEntries : 10000usersExcluded : ['Administrator', 'Import User', 'Job User', 'Integration User']workspacesExcluded : ['Approval Lists', 'Change Approval Templates', 'Checklist Templates', 'Project Templates']}

See a description of these settings below. Note that you have to restart your UX server after changing any of these settings.

Access the Dashboard

You can access the dashboard with the /insights endpoint, just click this link:

Features

Using the PLM REST API, this utility will analyze the configuration of a selected workspace within two defined tenants. For each difference that is found, the utitlity will provide instructions and shortcuts to perform the given action, for example by using the standard Workspace Manager. This helps to keep business processes in multiple tenants in sync.

The following information will be compared:

• Workspace Settings
• Workspace Tabs
• Item Details Tab
• Grid Tab
• BOM Tab
• Managed Items Tab
• Picklists
• Relationships
• Advanced Print Views
• On Create & On Edit script
• Workflow States
• Workflow Transitions
• Workflow Scripts

As the REST API does not reveal all details about the workspace configuration, some information cannot be compared automatically (for example the formulas of computed fields). Please see the given details provided within this utility.

Starting The Comparison

In order to launch the comparison, the names of two tenants must be defined on top. The tenant which the UX Extensions server is connected to will be considered as Base Tenant automatically while the second tenant must be typed in. You can also use the same tenant name for both the Base and Target in order to compare two different workspaces within the same tenant. Once you press enter in teh tenant inputs fields, the given list of Workspaces below will be refreshed.

As the UX server must connect to both tenants, please make sure that your APS Client ID has been whitelisted in both tenants.

If you are going to use this utility often, you can also provide the Target Tenant name as option in the URL. Simpliy append '?options=adsktenant2023test07' to have the given tenant name filled. This will also load the list of workspaces in this tenant automatically.

Finally, select the workspaces to compare. As you select a workspace in the Base Tenant, the utility will automatically select the matching workspaces in the Target Tenant if available. Run the comparison by clicking the blue Start button. Once the comparison is running, you can click the Stop button to end the process.

Reviewing Results

While the comparison is running, summary information will be added to the sections at bottom. These counters relate to the Base Tenant and show the nubmer of field being found for example. The color indicator reveals if the given configuration settings match with the Target Tenant.

Next to these indicators, you will find instructions about how to sync the given workspaces. These instructions refer to the field and setting to be changed and provide the given details. You can click these instructions to open the given administration utility for the Target Tenant. Once the given change has been applied, you can click the checkbox to remind yourself about your progress.

If you prefer a graphic report about matches and differences, click the Report button which gets enabled once the comparison is complete. This report may be helpful to when reviewing the differences.

Features

On a single page, this utility provides access to all the workspace manager utilities, but also to all scripts, roles and picklists of your tenant. Clicking the given items will launch the matching utility in PLM. Administrators also can acces the where used information for scripts and pick lists.

Users can filter all the lists in this panel using the search input in the global header toolbar. This helps locating all worksapces, scripts, picklists and roles that belong together, for example everything that relates to 'Change'.

When a workspaces is selected, all lists to the right will be filtered automatically to only show items being related to the selected workspace. The text filter entered in the global header also still applies (if used).

Per default, the links will be opened in new browser tabs. As an alternative, users can select to open the links in dedicated browser panels / instances. When positioning this application with such panels side-by-side, admins get direct access to required panels easily:

Access the utility

You can access the utlity with the /shortcuts endpoint, just click this link:

This addin provides quick access to Vault data by using a quick search for folders, files and items. It also provides actions when hovering a search result. These actions enable interactions which must be implemented by the host application using the Chrome Webview library.

The panel uses the Vault Data API and requires proper configuration of the following settings in file settings.js:

• vaultGateway
• Vault Name

Access the utility

You can access the utlity with the /addins/pdm-search endpoint, just click this link: