Exploring item documents

In this lesson, we’ll explore the Documents tab of an item to see both the document categories and specification types. 

We’ll also upload a document to a document category and specification type and explore its detail view. This will help you become familiar with where documents are viewed and managed within items.  

Before you start:

You must be invited to Upchain and have at least a Participant license to perform the tasks demonstrated in this lesson. You must also be added to a project to be able to manage documents within that project.

Exploring item documents

In this video, we will:

  • Explore the Documents section of an item
  • Describe the difference between document categories and specification types
  • Upload a document to a document category and specification type
  • Load a document’s detail view from an item’s Document tab

00:04

In this video, we will explore the document section of an item, describe the difference between document categories and specification types,

00:12

upload a document to a document category and specification type, and load a document's detail view from an item's documents tab.

00:20

Let's take a look.

00:24

An item represents one object in your design.

00:28

It is one level in your bill of materials that can be a part, assembly, subassembly, or end item, which is a top level item with no parent.

00:38

An item manages all data associated with one object in a product design, including CAD models, drawings,

00:46

translations, visualizations, markups, non-CAD documentation, and metadata, which is the attributes.

00:59

Items and their bill of materials are all managed in the BOM section of a project.

01:05

From the navigation pane on the left, click on an item to load it and its bill of materials into the center view.

01:16

From here, click on an item to load its details pane on the right hand side.

01:24

All documents associated with an item are found in the documents tab.

01:34

The top section of this tab displays the document categories.

01:40

These are the same document categories that you also see in the document section of a project and elsewhere throughout Upchain,

01:49

including business processes and so on.

01:53

This reaffirms the case that document categories are indeed applied tenant wide.

02:02

Beside each category is an action menu where you can create subfolders and upload documents to that category.

02:17

Underneath the document category section is the specification type section.

02:24

Here is where you can see the default cBOM, drawing, and translation categories,

02:32

as well as any additional ones that have been created by your tenant administrator.

02:38

And it also includes the icon they chose to represent that specific category.

02:45

While the cBOM drawing and translation sections are primarily managed by your mechanical designers or electrical designers,

02:55

all of the additional custom categories here may be managed by other users.

03:02

Each specification type behaves in the same way as document categories.

03:07

The only difference is that documents in a specification type can only be managed while the item is still in development,

03:16

whereas you do have the option for document categories to allow them to be editable in a released item.

03:23

We'll explore this further in a later video.

03:30

Beside each specification type is an action menu, again, to create subfolders and upload documents to that category.

03:40

To give you a bit more room to manage the documents here, you can click the expand button to view this section in a larger window.

04:03

We would like to upload a requirements document to the assembly item within this bill of materials.

04:10

This will make it more obvious which assembly these requirements are for and are more easily accessible to the designers from the CAD plugin.

04:20

The item is still in development, which means that all document categories and specification types are still editable.

04:30

To upload a document to an item, click the "Action" menu next to the desired document category or specification type and select "Add Document".

04:42

In the window that opens, click the "Add Documents" button.

04:47

Locate the document you wish to upload from your computer.

04:50

You can select more than one document here.

04:54

And then click open.

04:56

Wait for the document to finish uploading, and once it says done, click "Okay".

05:04

The document is uploaded into the chosen document category or specification type and assigned a number,

05:12

seen here and here, based on the numbering rules assigned to that category.

05:20

The document is now in draft at Version 1 and has no revision level yet.

05:30

Now that we have a document uploaded, we can explore its details.

05:34

It is a little bit different to project documents because documents here do not have a full details pane of their own.

05:44

Beside each document is an Action menu.

05:48

Clicking this, you can see the different actions that you can take on this document.

05:55

We'll explore these in further videos.

05:59

To view its details, you would click the "Action" menu, and then select the "View Details" option.

06:09

A window opens that displays the document's details.

06:15

This is also the window where you can set the workflow to publish this document.

06:20

So this is an important window as this is the only location that you can set and continue the publishing workflow for an item document.

06:36

A summary of all documentation uploaded to an item can be seen in the Files column in the Bill of Materials table.

06:45

The defaults in this table include cBOM, Drawing, Documents, and Translations.

06:55

And these are always shown.

06:57

However, your tenant administrator can also decide whether the additional specification types are also visible in this column.

07:09

While this does not indicate what the file types are associated with the item in any of these categories,

07:16

it can give a nice visual summary of which categories contain documents and which ones don't.

07:26

You should now have a general understanding of the difference between document categories and specification types,

07:33

where to find and view information regarding item documents, and how to upload a document to a document category within an item.

07:42

Keep going to learn more.

Video transcript

00:04

In this video, we will explore the document section of an item, describe the difference between document categories and specification types,

00:12

upload a document to a document category and specification type, and load a document's detail view from an item's documents tab.

00:20

Let's take a look.

00:24

An item represents one object in your design.

00:28

It is one level in your bill of materials that can be a part, assembly, subassembly, or end item, which is a top level item with no parent.

00:38

An item manages all data associated with one object in a product design, including CAD models, drawings,

00:46

translations, visualizations, markups, non-CAD documentation, and metadata, which is the attributes.

00:59

Items and their bill of materials are all managed in the BOM section of a project.

01:05

From the navigation pane on the left, click on an item to load it and its bill of materials into the center view.

01:16

From here, click on an item to load its details pane on the right hand side.

01:24

All documents associated with an item are found in the documents tab.

01:34

The top section of this tab displays the document categories.

01:40

These are the same document categories that you also see in the document section of a project and elsewhere throughout Upchain,

01:49

including business processes and so on.

01:53

This reaffirms the case that document categories are indeed applied tenant wide.

02:02

Beside each category is an action menu where you can create subfolders and upload documents to that category.

02:17

Underneath the document category section is the specification type section.

02:24

Here is where you can see the default cBOM, drawing, and translation categories,

02:32

as well as any additional ones that have been created by your tenant administrator.

02:38

And it also includes the icon they chose to represent that specific category.

02:45

While the cBOM drawing and translation sections are primarily managed by your mechanical designers or electrical designers,

02:55

all of the additional custom categories here may be managed by other users.

03:02

Each specification type behaves in the same way as document categories.

03:07

The only difference is that documents in a specification type can only be managed while the item is still in development,

03:16

whereas you do have the option for document categories to allow them to be editable in a released item.

03:23

We'll explore this further in a later video.

03:30

Beside each specification type is an action menu, again, to create subfolders and upload documents to that category.

03:40

To give you a bit more room to manage the documents here, you can click the expand button to view this section in a larger window.

04:03

We would like to upload a requirements document to the assembly item within this bill of materials.

04:10

This will make it more obvious which assembly these requirements are for and are more easily accessible to the designers from the CAD plugin.

04:20

The item is still in development, which means that all document categories and specification types are still editable.

04:30

To upload a document to an item, click the "Action" menu next to the desired document category or specification type and select "Add Document".

04:42

In the window that opens, click the "Add Documents" button.

04:47

Locate the document you wish to upload from your computer.

04:50

You can select more than one document here.

04:54

And then click open.

04:56

Wait for the document to finish uploading, and once it says done, click "Okay".

05:04

The document is uploaded into the chosen document category or specification type and assigned a number,

05:12

seen here and here, based on the numbering rules assigned to that category.

05:20

The document is now in draft at Version 1 and has no revision level yet.

05:30

Now that we have a document uploaded, we can explore its details.

05:34

It is a little bit different to project documents because documents here do not have a full details pane of their own.

05:44

Beside each document is an Action menu.

05:48

Clicking this, you can see the different actions that you can take on this document.

05:55

We'll explore these in further videos.

05:59

To view its details, you would click the "Action" menu, and then select the "View Details" option.

06:09

A window opens that displays the document's details.

06:15

This is also the window where you can set the workflow to publish this document.

06:20

So this is an important window as this is the only location that you can set and continue the publishing workflow for an item document.

06:36

A summary of all documentation uploaded to an item can be seen in the Files column in the Bill of Materials table.

06:45

The defaults in this table include cBOM, Drawing, Documents, and Translations.

06:55

And these are always shown.

06:57

However, your tenant administrator can also decide whether the additional specification types are also visible in this column.

07:09

While this does not indicate what the file types are associated with the item in any of these categories,

07:16

it can give a nice visual summary of which categories contain documents and which ones don't.

07:26

You should now have a general understanding of the difference between document categories and specification types,

07:33

where to find and view information regarding item documents, and how to upload a document to a document category within an item.

07:42

Keep going to learn more.

Key takeaways

  1. Document categories and specification types are both seen in the Documents tab of an item’s detail pane.
  2. The symbol representing the specification type can also be shown in the BOM table to provide a visual confirmation of a document being present in that specification type.
  3. Use the document detail view to set and progress its publishing workflow.
Was this information helpful?