Design Codes are used within the PLM to grant users access rights to documents.
Within a Design Code there are different roles, which provide different access rights. A user can hold more than one type of role within a single Design Code.

The PLM can be opened through the Desktop app or in a web browser. The table below details the supported web browsers for different operating systems.

* Whilst the PLM is supported in windows 11, CATIA currently is not. Therefore, if you need to use CATIA for any reason please ensure you are running windows 10. 

Edit rights to a document is controlled via its Design Code and Responsible Project Group (RPG), which is set on its Parent Part. If a colleague requires edit rights to all the documents with one of these attributes, they should request access to these groups via the appropriate e-group. (Note you only need to belong to one of these groups to edit the documents, but you must belong to the Design Code contributor group to be able to edit the documents and initiate a validation process [Design Verification Workflow]).

However, if your colleague only needs to edit one particular document you can use the ‘Shared edit rights’ feature. A person with access to the document can use this feature to grant edit rights to another user on select documents, rather than all documents in a project.

On the profile card of the document navigate to the ‘Shared edit rights’ tab. From here use the add relation button to add the user that requires access. This person will be given contributor rights to this document only.

On the profile card of the document, in the ‘Shared edit rights’ tab, use the add relation button to grant your colleague edit right to this document only.

This feature is also available from a Part profile card. This will provide edit rights to the Part, but not to any of the CAD documents under it.

There are two ways of retrieving all the objects that you have claimed.

1. Method one is to use the dashboard. From either one of the specific tabs (e.g CAD documents) or the All tab, click on the 'claimed by me' filter at the top. This will filter the results of the tab to show only objects that you currently have claimed.
   
   
    
2. Method two is from a regular PLM search window. From the table of contents navigate to one of the objects, such as Part, and from here you can open a search window for this object type. Use the column 'claimed by' to filter documents claimed by you. The flag column confirms that these objects are claimed by you, through the presence of a green flag. (Note the column order is customisable to user preferences through drag and drop, so yours may differ from the screenshot below) 

To unclaim all the objects in one go, use method 2 and highlight the results. (Press and hold the Ctrl key to select individual results. Alternatively, select a result then hold down the shift button and select another result, this will highlight all the documents in between.)
Once the required documents are highlighted right click to bring up the contextual menu. Click 'unclaim', to unclaim all the highlighted documents.

The CERN Drawing reference (CDR) on a drawing is usually generated from the Design Code applied to its parent Part. 
However, on non-master drawings only, it is possible to apply a CDR that is not based on the parent Part. 

This is to allow a drawing to be created with additional information that is not necessarily related to the main project, without affecting the access rights to the document. The access rights are still inherited from the parent's Part Design Code, and are unaffected by the differing CDR prefix.

To assign a CDR on a drawing from the title block editor press 'get new'. This will open the window shown below, where the design code used to generate the CDR needs to be confirmed. By default the design code used on the Parent part will be shown, but another can be chosen using the drop down button. Please note, only design codes where you are have the Contributor, Design Reviewer, Equipment Owner or Senior Integrator role will be shown.

For master drawings the design code selection is greyed out. To change the design code, and resultant CDR, on these drawings the design code must be changed on the parent Part first. 

CATIA customised settings, such as shortcuts, can be saved in the PLM dashboard to be used when CATIA is reopened. This is also true for PWB setting changed in the options toolbar.
To save new customised settings, close the CATIA session in which the changes were made. Press the cog icon on the CATIA launcher to open the CATIA configurations window.

Enter a name for the new settings configuration. It will be saved and stored under one of the three main configurations that the CATIA session was originally opened under, and the settings were changed in.

Note the setting name may only contain alphanumeric characters and spaces, and be a maximum length of 64 characters. Configuration settings can also be deleted from this window by pressing the bin button next to them.

More: FAQ

To open a 3D CAD document in Spinfire Ultimate there is an icon available on each Profile Card. It is located on the thumbnail (the lower one, whilst the upper icon is used to display the web viewer): Open in Desktop Viewer.

The first time you click on this icon, a new SpinFire Ultimate instance (window) will be launched, and your CAD file will be open there.

If you later open a second CAD document in the viewer through the 'Open in desktop viewer icon', a pop up menu with appear:

"--> Open in a new window" will launch a new SpinFire instance:

"--> Open in a new tab in the first window" will open the selected CAD Document in a new tab of the FIRST instance of SpinFire that was launched.

"--> import to the active tab of the first window" will merge the selected CAD Document in the active tab of the FIRST instance of SpinFire that was launched:

With this last option, it is possible to merge multiple CAD documents that were made with different CAD authoring tools (ex: REVIT & CATIA V5).

The origin axis systems of all CAD Documents will all be coincident. But it is possible to move some components using the Transform dialog box.

Note: PLM desktop must be running, even if you are browsing the PLM using your web browser.

More about how to use SpinFire Ultimate: FAQ

In the case a SmarTeam Item contains Integration data (a non-Master CAD Document that is a simplified representation of the 3D Master for instance), you can proceed with the Ready For Check in PLM only if you ask the Integration team to transfer you the responsibility.

Once the data is available in the PLM after "Ready for Check in PLM", you need to add the Integration Team as Additional Reviewers for the data verification process.

Additional Reviewers are used to involve additional people in the verification process of a given Part, on top of the standard assignees of the Design Verification Workflow control activities.

Assigning Additional Reviewers is typically optional. However, from methodology perspective, it becomes mandatory if the Part contains Integration models.

Depending on your Project, you will need to assign a specific reviewer group.

Please find the full list of reviewers groups in this EDMS document provided by the EN-ACE-INT section.

In most situations all master CAD documents in a CAD structure are contained in the assembly’s BOM. However, there is a valid use case where this is not true.

For example, a component in a structure will be manufactured from a standard SCEM part, such as a long tube. The component is ‘Master’, but very simple and does not require its own drawing (dimensions will be placed on the assembly drawing). Rather than putting the modified CAD part in the BOM, the SCEM part is included instead to aid purchasing and manufacturing. See the example below.

To create a BOM structure that includes the Part of CAD C instead of CAD B, we can use the ‘marked as’ attribute in the PLM. There are different properties that can be applied to this attribute which alter how Parts are shown in the parent assembly BOM. The four different options are, ‘  ‘ (default), ‘IN-BOM’, ‘Not IN-BOM’ and ‘Phantom’. For this use case we will use the ‘  ‘ (default) and ‘Not IN- BOM’ property, but you can read more about the other attributes through the link at the bottom of this ‘How-to’.

The image below shows how to alter this property in CATIA. Select the document you want to change, then open the PDM properties window by selecting the icon on the connector toolbar. From here, there is a drop-down list to select the required marked as attribute.

For our structure above, we can set CAD B to ‘Not IN-BOM’, therefore it will not be included in BOM A. CAD D is left at the default option, meaning that because it is a master document, its Part will be included in BOM A. Finally, to add Part C this must be done manually in the PLM by following the steps below, but for more information please read the FAQ linked at the bottom of this page.

1. Open the profile card of Part A. Put it into edit mode and navigate to the BOM tab at the bottom.
2. Click on the ‘Add Parts’ button.
3. A query box will be displayed, search for Part C and press ok.
4. The part will be added to the BOM table.
   It will be highlighted as manually managed. In addition, the quantity and position override boxed will be ticked as they cannot be computed from the CAD structure. The position box can be left empty, meaning it will be assigned the next available position, or a value can be provided.
5. If required, modify the quantity value. By default, it is set to 1.
6. Click done on Part A’s profile card to save the changes.

Part A’s BOM is now updated and includes the required parts. The schematic below shows the resultant BOM structure compared to the CAD structure.

It is important to note, when creating a workflow to verify the structure, Part B  must be added as a root object of the workflow, else it will not be approved and remain in preparation as a baseline.

BOM management FAQ: BOM management in CATIA / PLM

Some objects are classified as either Catalog or/and Standard components. All standard components are Catalog Components, but not all Catalog Components are Standard.

Both types are components that can be bought from a supplier catalog, as apposed to specifically designed for a CERN project. However, Standard components are compliant with standards such as ISO or DIN. They can be bought from any supplier so typically do not contain supplier information on their profile cards (some exceptions exist).

Both types of documents can easily be identified in the PLM by checking the two distinct properties; ‘Catalog component’ and ‘Standard’. These properties are attributed to both the CAD document and the Part. They are searchable in the PLM Dashboard and PLM search windows as shown below.

This said, some standard components are not flagged as such, for historical reasons. If you want to make an exhaustive search, we strongly recommend you to use the "Catalog Component" property only.

Additionally, the properties are shown in the PWB connector query window.

The properties are shown in the profile card header of both the CAD Document and Part.

For information of how to search for catalogue components that have a space in the document number, read the following how to :

How to search for documents with a space in the name?

Short answer:

When searching in the global search box on the dashboard, you must put document numbers containing a space in quotation marks.

Long answer:

CAD Documents can be searched for either in the Dashboard or the dedicated CAD Document search window. In both windows there are different columns where filters can be applied to narrow down a search. For example you can specify a document number as shown below (simply enter the document number, no need for special characters).

On the Dashboard there is the additional option of using the global search box at the top, which will check in the following properties: Definition, Document Number, CERN Drawing Reference and External Reference. However, note that the settings of this search box are different to those of the the filter boxes. In this search box a white space ( ) is seen as an "AND" operator.

Therefore, for components which contain a space in the middle of the document number, in order to retrieve results you must place the 'number' inside double quotation marks (""), as seen in the first image.

Icons are used throughout the PLM and in the CATIA specification tree to quickly convey information. See the documentation below to find the explanation of each icon. 

More: FAQ

Before working in the PLM please follow the available training material depending on your usage and requirements. The trainings can be found here. 

A CAD document is made up of data, metadata. Some of this comes from CATIA such as the geometry, mass and material. Some of it comes from the PLM, Design code and RPG. 
Two pieces of metadata can be changed in both the PLM and CATIA, the CAD definition and description. These two properties are mapped in both directions so can be modified in either platform and the data will be updated in the other. However, its important to understand when this information is transferred, so as not to loose any data.

• Data is pushed from the PLM to CATIA when a document is first opened.
• Data is pushed from CATIA to the PLM when a document is saved.

Why this is important? 

If you have a document open in CATIA and change either the CAD definition or description in the PLM platform, these updates will not be pushed to the already open document in CATIA. The CATIA data will not be updated. Therefore, if the CAD document is subsequently saved in CATIA, the 'outdated' CATIA data will be pushed to the PLM overwriting the previous change. 
Therefore, please do not change a documents metadata in the PLM if the document is already open in CATIA. Please do the changes in CATIA.

Note: If a document is modified in the PLM whilst it is open in CAD, when the CATIA tree is refreshed the definition will be updated because this displays data directly from the PLM connector. However, the CATIA data is not updated. This can be verified by viewing the data via right click > properties. 

Below is a list of acronyms that are used in relation to the PLM.

• BOM – Bill of Materials
• CDR – CERN Drawing Reference  →  Replaces CDD Number 
• DC – Design Code   
• Doc – Document     
• DT – Digital Twin           
• LC – Lifecycle
• PC – Profile Card
• PWB – PDM Workbench (PLM-CATIA connector)
• QAC – Quality Assurance and Control
• RFC – Ready for Check
• RFC in PLM – Ready for Check in PLM
• RPG – Responsible Project Group
• TBE – Titleblock Editor
• TOC – Table of Contents
• WF – Workflow

See the list of CATIA Acronyms here.
See the list of SmarTeam Acronyms here.

The batch import tool (drag and drop) can also be used to create new versions of CAD Documents already saved in the PLM.

To create a new version, in the 'Version a CAD document' column enter an existing document/Part number, or a CERN drawing reference number. Alternatively, by double clicking on the cell a search box will appear. From here you can search and filter to find the existing document you would like to version.

If a valid document is found, the version column will be populated with the document number, latest version and definition.  In addition, some of the other columns will be automatically filled out with the metadata from the previous version, for example the sheet size and orientation. However, these can be modified if required.

 
  
Please note this feature can only be used with manually managed documents.

Once the import is launched, a new version of the document will be created and attached to the existing Part. The type of version (major or minor) is dependent on the lifecyle state of the previous version. Documents in a frozen state will have a major update, otherwise a new minor version will be created.

  Batch Import

See the 'Batch import' subgroup for related information

If you have multiple workflows to create, that will use the same properties (e.g workflow behaviour, drawing label & reviewers) it’s possible to create a workflow template so the properties do not have to be repetitively assigned.

1. Optional: Create a new part for each workflow template you would like to create. The name of the part can be used to give a description of the workflow attributes, to help you keep track of your different templates. These parts can be stored in a folder.
    

2. Create a Workflow as standard and fill out all the desired attributes.
3. Favourite the workflow using the star in the header.
    

4. All favourited workflows can be found under the Change items in the TOC. If you un favourite them, they will be removed from this shortcut.

5. When creating a workflow to validate your new documents, use the ‘apply workflow template’ button below. This opens a new window where all the favourited workflows are shown, including the various attributes so they can easily be differentiated. Press the button on the left to apply the template, and the attributes will automatically be set.
   (Please note: If reviewers are set using the template they are still subject to access rights. These will be checked during the precondition workflow)

More: Design Verification Workflow FAQ

When documents are migrated to the PLM, either by setting them to preliminary in SmarTeam or using the RFC in PLM command*, they are in a frozen state in SmT. Therefore, if people need to edit a document in SmT they must create a new version.
Although this new document will not be visible in the PLM until its migrated itself, the previous version available in the PLM will be flagged as ‘non-current’.

This property can be viewed on the PLM search grid and the structure tab on a CAD Document profile card.

*Documents already released in SmT need to be migrated manually, contact plm-support@cern.ch for help.

Documents that are created in SmarTeam can be migrated to the PLM. They can also have their 'ownership' transferred over so they can be edited in the PLM.
Note: Only one software at a time is permitted to edit documents, to prevent continuity issues.

From SmartTeam you can identify if a document has been migrated over and ownership changed by looking at the lifecycle state. Documents of this nature will be set to the ‘Externalised’ state.

From the PLM you can identify it through the ‘Owned by SmarTeam’ property. If the property is;

• Enabled, it means the document is still owned by SmT and must be edited there
• Disabled, owned by the PLM and must be edited there.

This property is displayed in the search grid from the dashboard and in the relationship grid on the profile card of a CAD document.

For info:

Documents starting with ST2 are native to the PLM so will be editable (subject to lifecycle status and access rights).

Documents starting with ST1 or ST0 were created in SmarTeam or Euclid. These will have to undergo the migration and ownership transferal process before they can be edited in the PLM.

The official CAD tool at CERN for 3D design is CATIA V5. However, the PLM can be used with AutoCAD, BricsCAD, Inventor and REVIT by installing the relevant connector.

Please note there is no support at CERN for the use of these applications, only the installation and usage of the connectors.

Installation steps:

1) Install  the 'CERN - PLM Desktop' via CMF.
2) Install the desired CAD package via CMF. If this is not available please contact the service desk with your PC name.
3) Once the CAD package is installed the relevant connector package should be available in CMF. This should be installed. When the CAD package is opened for the first time with the connector you might need to accept the plugin activation.

For more information on the installation steps, and the versions of the CAD software that are supported by the connector, please read the following documentation.

More: CERN MULTICAD Connectors Installation Guide

The order of the BOM is determined by the CATIA tree. The BOM is built based on the positions and quantities in the CATIA tree, using a top-down approach.

Please note:

• Only CAD Documents identified as 'Master' 'Representation type' are automatically included in the BOM. See the full FAQ to understand how to manually add documents of alternative 'representation types'.
• The first instance of a reference found in the tree structure is what determines its position in the BOM.

There are manual ways to override the CATIA positions & quantities, for further information on this see the FAQ below. However, you can also simply reorder the CATIA tree to order parts in the BOM as you desire. Use the 'Graph tree Reordering' function in CATIA to easily move the parts around.

The third button in the window can be used to move the part quickly next to any other, by selecting one in the list. Note when moving a part down from its current position, it will be placed under the document you select. When moving up, it will be placed above.

More: BOM management in CATIA / PLM

A BOM can be projected onto a drawing using the Title Block Editor (TBE).

When you click on the Title Block Editor icon in CATIA V5,  it will open in a new window. The BOM can be found in the second tab, called “Bill of Materials”.

Check the “Bill of Materials” box to add the BOM to the title block of the drawing. Then click on “Generate & Save” to add the BOM and the title block to the drawing.

More: Title Block Editor FAQ

Further: BOM management in CATIA / PLM

Regular Titleblock stamp:

Case 1: you are working at CERN with an official CAD tool and a PLM Connector (ex: BricsCAD, CATIA etc…).

Thus, you must generate an official CERN Titleblock on your Drawing prior to validating it. Then when a Design Verification Workflow is launched and the Drawing is Approved, this Titleblock will be stamped:

• The banner “Draft for discussion, not valid for execution” will be removed,
• The name of the person(s) who approved the drawing will be added, as well as the date of approval.
• The label defined in the Workflow (ex: For Execution, or For Tender…) will replace the default “Not Valid For Execution”.

Regular CERN Titleblock before validation.

Regular CERN Titleblock after validation.

Mini Stamp:

Case 2: you are not using a PLM Connector, does not matter if you are working at CERN or outside CERN, and you are uploading a native file only.

Examples:

• you are working at CERN with a CAD tool for which there is no connector, therefore no Titleblock Editor, but the format is supported by the PLM,
• you are working at CERN with a CAD tool for which there is a connector, but you chose to not use it,
• you are working in a sub-contractor design office with AutoCAD or BricsCAD, not on the CERN site, thus you do not have access to the CERN connectors, but you have access to the CERN PLM via the web interface,
• you are working at CERN and you receive some drawings as PDF or as DWG from another institute, a contractor etc… that you must upload in the PLM as native file,

For all these cases, it is not possible to have a CERN Titleblock on these drawings, first either because the Titleblock Editor is not available, or because there might be already a Titleblock from another company.

As a result, the regular stamping described in case 1 cannot be done.

Instead, the system will put in place a mini-stamp, which position is customizable, and that will contain the most relevant information (name of the persons who controlled the drawing, date, Label, Reference…).

Mini stamp.

Case 3: you manually upload a viewable file in addition of the native file.

In such a case, does not matter if the native file is connector managed or not, or what the native file type is, the viewable file will always be used for the stamping, with the mini stamp.

Example:

• you are working at CERN with AutoCAD or BricsCAD, and you are working with a multi-sheet drawing.
  This feature is not supported by the CERN Multicad connector. But you can save the Native file (*.dwg) via the CERN connector and upload the multi-sheet drawing as a viewable file previously exported as a pdf.
  Note: This is not possible for CATIA Drawings.
  
  Native File and Viewable File properties on a CAD Document Profile Card.
  
• You are working with an authoring tool not supported by the PLM, you upload the native files in a zip file, then, you can upload a pdf as a viewable file.

Said otherwise, as soon as a viewable file is manually uploaded, this viewable file will be used for the stamping, and in that case, a mini stamp will be applied.
In the case that the Drawing was CERN Connector managed, and even if there is a CERN Titleblock generated with the CERN Titleblock editor, this Titleblock will not be used for the stamping, and the mini stamp only will be filled after the validation.

In such a case, it is normal that the banner “Draft for discussion, not valid for execution” remains visible on the bottom right corner.

The position of the mini stamp is defined via the “Design Office” property, that sets a specific position for the mini stamp for each drawing format (A0, A1…).

As a result, this property becomes mandatory and must be filled for any Drawing that is not Connector managed or for which there is a viewable file uploaded.

To see the position that will be applied, from the CAD Document profile go to the Detailed information tab and locate the Design Office property in the Titleblock info & 2D information block.

Click on the link to open the Design Office Profile Card, then check the positions in the relationship grid at the bottom.

The origins are the bottom left corner of the drawing and the bottom left corner of the mini stamp. The units are millimetres.

For instance, in the picture below, we can see that the position of the bottom left corner of the mini stamp for a A4 drawing that is using the EN-EL Design Office property, will be at 30mm of the left edge of the sheet, and at 252mm of the bottom edge.

The first part of this FAQ will show you a quick method of saving a CAD document without dependencies, like a CATPart. The second, more detailed, section will describe how to save a structure where the files are linked to each other and will explore the different options available to you from the connector. The final part will explain you how to duplicate a CAD structure.

More: FAQ

The PLM uses an automatic engineering BOM (EBOM). This means every time you save an assembly the BOM will be created/updated on each 'claimed' or 'new' assembly node.
The BOM uses the positions and quantities of the instances in the CATIA tree, using a top-down approach. 

Please note:

• Only CAD Documents identified as 'Master' 'Representation type' are automatically included in the BOM. See the full FAQ to understand how to manually add documents of alternative 'representation types'.
• The first instance of a reference found in the tree structure is what determines its position in the BOM.
• There are manual ways to override the CATIA positions & quantities, see the FAQ below.

You can also trigger a forced manual BOM synchronisation at any time from the “More” menu of the CAD Document profile card in the PLM platform.

More: BOM management in CATIA / PLM

The Approved By Integration Workflow can be created from the CAD Document profile card.

There are few basic pre-requirements that the CAD Document must fulfil:

- The CAD Document needs to be in “In Preparation” lifecycle state.

- A Design Code needs to be assigned to the CAD Document through the Part.

In the Profile Card of a given CAD Document, the workflow can be created by selecting the "Create New Workflow" button:

You then need to choose the assignee of the "Design Documentation Check" activity and set the group responsible of the "Review by Approval Group" activity.

Once this is done, the preparation of the Workflow can be finalized by using the "Done" button:

Then launch the Precondition Checks and if you don't meet any issues during this step, you can launch the Workflow. In case there is a precondition check that "FAILED", a specific error message is included for this precondition to help you correct the problem.

As result of the Workflow, the root object and its dependencies will evolve to Approved status.

Complete documentation: Approved By Integration Workflow FAQ

The Approved by Integration Workflow is used to approve Conceptual Drawings and 3D Models, or the envelope of a given equipment.

Its aim is the validation of positions related to functions and beam line equipment, plus reserving space for the development of future equipment.

This Workflow operates on the Integration CAD Structure, meaning the Integration Assembly itself and all its CAD Dependencies, or the Integration (Layout) Drawing.

For this reason, it can only be launched by users holding the “Senior Integrator” role.

The Approved by Integration Workflow is composed of two mandatory control activities that happen “In Series”:

- Design Documentation Check

- Review by Approval Group

Complete documentation: Approved By Integration Workflow FAQ

The image below shows the overview of the PLM "ISO Lifecycle and Workflow" implementation.

PDF Version: PLM ISO Lifecycle and Workflows

If you are new to CATIA/PLM, the document at the bottom will introduce and explain the basic concepts to help you get started.

Please follow the necessary training before using the PLM. You can access the training and learning path here, this will help you identify what training is necessary for you depending on your previous experience and knowledge.

Training on the CATIA-PLM connector (PWB) is a prerequisite to being granted access to CATIA via the PLM. Once you have completed the training please contact the PLM support team with your computer name, so you can be given access. Prior to having access rights, you will receive an error message when attempting to launch CATIA, and you will not be able to view the connector package in CMF.

More: FAQ

The Withdrawal Workflow can be created from the Profile Card of Parts, CAD Documents and Documents.

You can then generate the "Precondition Report" that checks the following pre-requirements:

1. You must hold at least one of the following Roles in the Design Code set on the Root Object:

• Contributor
• Equipment owner
• Configuration Manager
• Senior Integrator

Or be member of the Responsible Project Group.

2. That the lifecycle state of the objects affected by the Workflow is not "In Review" 

Complete documentation: Withdrawal Workflow FAQ

The Withdrawal workflow is used to withdraw a Part (and all its content), a single CAD Document or a single Document.
According to ISO standards, once withdrawn, an object is no longer available as an active object.

A withdrawn version of an object must no longer be used for any purpose. This means it will not be possible to approve or version any object containing a withdrawn object. 

Complete documentation: Withdrawal Workflow FAQ

The Release Workflow can be created from the Part Profile Card.

You can then generate the "Precondition Report" that checks the following pre-requirements:

• Part needs to be in "Approved" or "Replaced" lifecycle state.
• The initiator of the Workflow needs to have the Equipment Owner role in Design Code set on the Part

If all them are fulfilled, you can launch the Workflow that will make the lifecycle state of the Part evolving to Released. 

Complete documentation: Release Workflow FAQ

The Release workflow is used to declare that a given Part (and its BOM) is allowed to be used for its intended purpose, meaning that the required item function has been validated.

A Part should be Released when the first asset created from this design is accepted.

Complete documentation: Release Workflow FAQ

To locate, view or open files of SmarTeam(ST) CAD Documents through the PLM platform, follow the subsequent steps.

1. Optional prerequisite to enable the opening of STEP files of ST CAD Document directly into SpinFire Ultimate:

         Install the software below from CMF. These are available on any CERN Windows machine.

• CERN - PLM Desktop
• Actify SpinFire Ultimate

Note: There is an embedded viewer in the PLM to allow users to view the documents without installing Actify SpinFire Ult., but for a comprehensive review of a document Actify SpinFire Ult. is required.

For the subsequent steps, use either the PLM Desktop app (open the PLM website as shown below), or open the following link in any web browser, https://plm.cern.ch/. However please note, to open a file directly into SpinFire Ult., the PLM desktop must be running. An explicit error will be returned if it is not.

2. Search for the document in the PLM

  2.1 It’s recommended to search for a document through the Folders (ST Projects) and Parts (ST Items) it is in, rather than directly, as these queries load much faster and have improved accuracy. Access these search boxes through the table of contents on the PLM Website (or webpage), as shown below.

Note: the Part (Item) reference can easily be deducted from the ST CAD Doc reference: just remove the _ and the 2 last digits

ex: CAD Doc ref :ST1234567_01 -> Part ref: ST1234567
     

  2.2 Query for the desired Folder or Part using the filter fields. Double-click to open the object in its own window.
 

  2.3 Navigate to the document from the Folder or Part window.

        The contents of both objects are shown as icons under the main information boxes, click to open them in their own window. Alternatively, navigate using the ARAS grid and different tabs at the bottom of the window as shown in the images below.         

2.4 Ensure you open the required revision of the document. A warning will be displayed in the header of the profile card if it is non-latest, with a link to the latest revision.

3. The 3D data of a CAD Document can be viewed from its Profile Card.

• For quick visualisation there is an embedded viewer window on the right-hand side of the window (installation of Actify SpinFire ult. is not required to view this).
• For a more in-depth review, the data can be opened in the local default CAD viewer using the button below (SpinFire Ult. if installed and the PLM desktop is running).
• To download a .stp file of the document, press the arrow in the top box and choose the filetype from the dropdown list.  

4. For a drawing, the 2D data can also be viewed on the Profile Card.

• For quick visualisation there is an embedded viewer window on the right-hand side of the window.
• To download a .pdf file of the CAD Document, press the arrow in the top box and choose the filetype from the dropdown list.
• If it is saved in EDMS, there is also a link to this area.​​​​​​

For more information on how to use SpinFire Ultimate please read the following documentation.

FAQ: SpinFire Ultimate

In order to be able to delete an object from the PLM platform (whether it is a Part, a CAD document, a non-CAD document or a Folder), there are a number of requirements that must be met.

All these requirements and the necessary steps are explained in the FAQ below:

More: How to delete an object from PLM Platform?

To reset/abandon a "Ready For Check in PLM" command, you need to:

Access the object in your CS Dashboard  select More  Life Cycle  "Reset (abandon) Ready For Check in PLM".

As a consequence:

- the selected CAD Document will be reset to the "Preliminary" state in SmarTeam, and can be edited again.

- The corresponding CAD Document in the PLM will transition to "In Preparation" and baselined (frozen).

The transition from "Ready For Check" or "Checked" to "Ready For Check in PLM" is not allowed.

When executing the "Ready For Check in PLM" command on CAD documents that are either in the "RFC" or "Checked" state, or contain dependencies in those states, the report will display:

"Current workflow state (Ready for Check/Checked) is not valid for this workflow transition"

To proceed, you need to:

- Either reject them: you can then check them out and in again to create a new minor version.

- Or wait for the second control to be performed, so that the CAD Documents transition to "Released".

The Fast-Track Promotion Workflow can be created from the Part Profile Card.

You can then generate the "Precondition Report" that checks the following pre-requirements:

• Part needs to be in "In Preparation" lifecycle state.
• The initiator of the Workflow needs to have on of the following roles in Design Code set on the Part:
  • Equipment Owner
  • Senior Integrator
  • Configuration Manager

If all them are fulfilled, you can launch the Workflow.

Complete documentation: Fast-Track Promotion Workflow FAQ

The Fast-Track Promotion can be used to approve the Part without going through a Design Verification, in case the Master CAD Documents are in Approved/Released state.

Once the Part is Approved/Released, you may have the need to just attach to the Part additional documentation, without modifying the Master CAD Documents. In such a case, you need to:

1. Version the Part.
2. Attach the additional documentation needed.
3. Promote the Part by using the Fast-Track Promotion, without going through a formal signature process.

Complete documentation: Fast-Track Promotion Workflow FAQ

It is not possible to validate a single CAD Document in the PLM platform.

The Design Verification Workflow acts on the Part and collects all the CAD Documents and Documents attached to the Part, plus its BOM.

Complete documentation: Design Verification Workflow FAQ

In case the Design Verification Workflow is successfully completed, the state of the objects collected by the Workflow evolves to:

- Approved in the PLM and EDMS.

- Released in SmarTeam.

The signatures performed in the PLM will be available in CDD as well.

In case one control activity is rejected, the state of the objects collected by the Workflow transitions back to:

- In Preparation in the PLM and EDMS

- Preliminary in SmarTeam

The CAD Documents can be worked on again in SmarTeam and the Ready For Check in PLM command can be re-launched on their new version.

The "Replace By" command can be accessed directly from the profile cards of the following object types:

•  Parts
•  CAD Documents
•  Documents

The command is accessible from the "More" menu .

Please note that the name of this command adapts according to the object from which this command is accessed from. Below shows the "Replace CAD" functionality, available from the CAD Document profile card:

This action opens a popup window from which you will be able to search for the object that replaces the "original" one:

 As a result:

- The lifecycle state of the "original" object transitions to "Replaced".

- The Profile Card of the "original" object displays information about the object that replaces it, including a direct link to this replacement Profile Card.

For more information, and explanation of the propagation of this tool, please see the following documentation.

FAQ Documentation

There are few basic pre-requirements that must be fulfilled for being able to perform an Assign Drawing(s) Label Workflow.

CAD Documents set as Root Objects must:

- Be of type "Drawing".

- Be in "Approved" or "Released" lifecycle state.

- Have a Design Code assigned through the parent Part.

Additionally, the initiator of the workflow must hold the "Equipment Owner" role in all the Design Codes set on the Root Objects.

Complete documentation: Assign Drawing(s) Label Workflow FAQ

The Assign Drawing(s) Label Workflow can be created from CAD Documents of type Drawing:

Once the Change Item profile card appears, fill in its Description and choose the Drawing Label you need to apply:

You can change the Label of multiple Drawings with the same Change Item. 

To do that, you simply need to add the Drawings by accessing the "Root Objects" tab from Workflow profile card, and selecting the highlighted icon: 

You can then launch the Workflow by using the following icon from its Profile Card header:

Complete documentation: Assign Drawing(s) Label Workflow FAQ

The Assign Drawing(s) Label workflow is used to change the Label of one or multiple Drawings. This workflow only operates on CAD Documents of type “Drawing”.

As soon as the workflow is launched, this triggers the archiving of the Drawing, taking into account the up-to-date Label, and the generation of the viewable file.

Complete documentation: Assign Drawing(s) Label Workflow FAQ

The "Ready for check in PLM" command is available to all SmarTeam users with lifecycle modification rights. if you require access to this please get in touch with the Support Team at: plm.support@cern.ch

The aim of Ready For Check in PLM is to validate SmarTeam data via the PLM, instead of CDD. 

This command needs to be executed in SmarTeam and triggers the migration of the collected data to the PLM.

The Design Verification Workflow replaces the CDD control process and it is composed by:

- Design Documentation Check: replaces the CDD Control 1

- Part Design Approval: replaces the CDD Control 2

- Review by Approval Group: replaces the CDD Control 3 / Approval Process (mandatory for QAC A Control Rule, optional otherwise)

Complete documentation:

•  Ready for Check in PLM FAQ
• CDD to PLM informative session presentation and recording

The user must be responsible for the documents in SmarTeam and the status of the documents in SmarTeam must be Checked In or Preliminary, with the last version.

Each document must be linked to a single Item in SmarTeam and incorporate the latest changes made to all its related documents.

The drawings must have a title block created with the current TitleBlock Editor tool and a CDD number.

All documents related to the document concerned must already be in one of the following states: In Work, Preliminary or Released.

Complete documentation: Ready for Check in PLM FAQ

To launch the Ready for Check in PLM command in SmarTeam, you have to be set as "Responsible" on all the CAD Documents (Master and non-Master) attached to the Item.

Moreover, you must also take “Responsibility” for the CAD Documents attached to the Items that compose the BOM.

In other words, you must be “Responsible” of all the CAD Documents collected by the Ready for Check in PLM command (dependencies that are not already "Ready for Check in PLM" or "Released".)

Complete documentation: Ready for Check in PLM FAQ