














In this lesson, we’ll demonstrate how to manage project-level documents in the web application. You’ll learn how to manage incremental changes to a document using the check out/in functionality, create a link between documents, and view a document in the PDF Viewer.
Finally, you'll learn how to publish a document, revise a published document, and archive a document.
You must be invited to Upchain and have at least a Participant license to perform the tasks demonstrated in this lesson. You will also need to be added to a project team to be able to manage documentation within that project.
In this video, we will:
In this video, we will:
Transcript
00:05
In this video,
00:06
we will view a document in the PDF
00:08
viewer and gain some familiarity with its functionality,
00:11
explore what happens when the published workflow is rejected,
00:15
and complete the workflow to publish a document.
00:18
So let's take a look.
00:21
Now I'm logged in as the project manager for this project,
00:25
and I can see that this document is awaiting review.
00:30
I have also received an email notification with
00:33
a link to the document to be reviewed.
00:35
I can click on this link to open that document in the web application.
00:44
Again,
00:44
the role doesn't matter when working with documents,
00:47
just that the user has the correct license.
00:50
The role only comes into play when dealing with work flows,
00:53
as it is often a specific role
00:55
that is called out to perform
00:57
specific tasks.
00:59
In this case,
01:00
for this document,
01:01
using the
01:02
document approval workflow,
01:04
it is the person with the project manager role
01:07
who is in charge of reviewing this document
01:09
and deciding whether to publish it or not.
01:15
While you can upload files of practically any type into Upchain,
01:19
only certain file types are compatible with the PDF viewer.
01:23
Again,
01:24
review the help documentation for a full list of compatible file types.
01:29
We have uploaded the project plan as a Word document,
01:32
and this document is compatible with the PDF viewer.
01:36
For someone who wishes to review the document without having
01:39
to download it and open it in its native program,
01:42
you can use the PDF viewer
01:44
to view it directly in the web application.
01:47
To open the document in the viewer,
01:49
click the Action menu beside the document,
01:52
and you can select open PDF web viewer.
01:56
You'll only see this option for file types that are compatible.
01:60
Alternatively,
02:01
if the document has a preview,
02:03
you can see that it is clickable.
02:06
So clicking on this image
02:08
will also load the document into the PDF viewer.
02:13
We will not spend a long time on the PDF viewer.
02:17
You can find more information on all
02:18
of its functionality in the help documentation.
02:23
But to give you an idea,
02:25
there are many actions that you can take to create a markup of this document.
02:32
You can annotate the document with a variety of
02:35
shapes,
02:36
texts,
02:37
comments.
02:39
Uh,
02:39
stamps,
02:40
images,
02:42
call outs,
02:43
and so on,
02:43
and you can also measure the document if perhaps you're viewing a drawing.
02:50
Here,
02:51
I want to point out
02:53
that the rules are incorrect.
03:04
I'm also going to add in a comment to say that the timeline
03:09
has been extended,
03:11
so these dates will need to be updated as well.
03:21
So you can see there are lots of different tools you can
03:23
use to describe what changes need to be made to this document.
03:29
You can also save these annotations as a markup.
03:34
This means that others who also open this document
03:38
are able to view
03:39
these markups.
03:47
You can also download a copy of this PDF with its annotations from the menu here.
03:54
Or you can just download without any markups using this button here.
03:59
Now to communicate the changes that need to be made,
04:03
you have several options.
04:05
You could fully track the required changes
04:08
to this document using an investigation request.
04:14
You could,
04:16
using the Gantt chart,
04:22
You could create a project task.
04:27
And you could associate the documents
04:30
to this project task,
04:33
and assign it to the correct person.
04:38
Or you could simply download this document with its annotations
04:43
and attach it to an email or some other
04:46
form of communication.
04:51
Review the help documentation for more information
04:54
on the tools available in the PDF viewer
04:56
and some of the options that you have for tracking work in Upchain.
05:03
Now,
05:04
because changes are needed to this document,
05:06
it is not ready to be published.
05:10
So I will reject the workflow.
05:23
Logged back in as the mechanical manager,
05:25
I can see that the document is still in a draft state
05:29
even though the work flow has been completed.
05:32
That's my first clue.
05:34
I have also received an email that indicates the published was declined.
05:39
So I could
05:40
load the document into the PDF viewer
05:44
and review the markup that was created
05:46
and indicated to me by my project manager.
05:50
Whatever method they chose to communicate what changes were needed,
05:53
I now need to make a change to that document.
05:57
So we'll do that by checking it out,
06:03
then I can make the changes to that document as required.
06:09
And now I need to check it back in.
06:27
I could check out and check this document back in
06:30
as many times as required.
06:32
Here,
06:32
we've created
06:34
version 3.
06:39
Note that because I have versioned up this document,
06:43
the link that we created
06:45
between this document and that project template has been lost.
06:50
We created that link when it was still at version 2,
06:54
so now we need to reestablish that link.
06:57
This is why it is best to wait
06:60
to create this link until the document is
07:03
absolutely ready
07:05
to be published or is already published.
07:12
Now that we're dealing with a new document version,
07:15
we must also resubmit this to the
07:18
publishing workflow.
07:20
We do that from the
07:22
details tab,
07:23
and we'll start the workflow.
07:37
Assuming this time,
07:38
the changes are
07:40
acceptable,
07:41
this time the document
07:43
can be published.
07:54
And now the document is published at version 3.
07:57
It is also incremented the revision level to AA.
08:02
The history tab now shows version 3 is published.
08:08
This should give you a general understanding of
08:10
the PDF viewer and some of its functionality,
08:13
using a workflow to publish a document,
08:16
and what happens when the workflow is both rejected and accepted.
08:20
Keep going to learn more.
00:05
In this video,
00:06
we will view a document in the PDF
00:08
viewer and gain some familiarity with its functionality,
00:11
explore what happens when the published workflow is rejected,
00:15
and complete the workflow to publish a document.
00:18
So let's take a look.
00:21
Now I'm logged in as the project manager for this project,
00:25
and I can see that this document is awaiting review.
00:30
I have also received an email notification with
00:33
a link to the document to be reviewed.
00:35
I can click on this link to open that document in the web application.
00:44
Again,
00:44
the role doesn't matter when working with documents,
00:47
just that the user has the correct license.
00:50
The role only comes into play when dealing with work flows,
00:53
as it is often a specific role
00:55
that is called out to perform
00:57
specific tasks.
00:59
In this case,
01:00
for this document,
01:01
using the
01:02
document approval workflow,
01:04
it is the person with the project manager role
01:07
who is in charge of reviewing this document
01:09
and deciding whether to publish it or not.
01:15
While you can upload files of practically any type into Upchain,
01:19
only certain file types are compatible with the PDF viewer.
01:23
Again,
01:24
review the help documentation for a full list of compatible file types.
01:29
We have uploaded the project plan as a Word document,
01:32
and this document is compatible with the PDF viewer.
01:36
For someone who wishes to review the document without having
01:39
to download it and open it in its native program,
01:42
you can use the PDF viewer
01:44
to view it directly in the web application.
01:47
To open the document in the viewer,
01:49
click the Action menu beside the document,
01:52
and you can select open PDF web viewer.
01:56
You'll only see this option for file types that are compatible.
01:60
Alternatively,
02:01
if the document has a preview,
02:03
you can see that it is clickable.
02:06
So clicking on this image
02:08
will also load the document into the PDF viewer.
02:13
We will not spend a long time on the PDF viewer.
02:17
You can find more information on all
02:18
of its functionality in the help documentation.
02:23
But to give you an idea,
02:25
there are many actions that you can take to create a markup of this document.
02:32
You can annotate the document with a variety of
02:35
shapes,
02:36
texts,
02:37
comments.
02:39
Uh,
02:39
stamps,
02:40
images,
02:42
call outs,
02:43
and so on,
02:43
and you can also measure the document if perhaps you're viewing a drawing.
02:50
Here,
02:51
I want to point out
02:53
that the rules are incorrect.
03:04
I'm also going to add in a comment to say that the timeline
03:09
has been extended,
03:11
so these dates will need to be updated as well.
03:21
So you can see there are lots of different tools you can
03:23
use to describe what changes need to be made to this document.
03:29
You can also save these annotations as a markup.
03:34
This means that others who also open this document
03:38
are able to view
03:39
these markups.
03:47
You can also download a copy of this PDF with its annotations from the menu here.
03:54
Or you can just download without any markups using this button here.
03:59
Now to communicate the changes that need to be made,
04:03
you have several options.
04:05
You could fully track the required changes
04:08
to this document using an investigation request.
04:14
You could,
04:16
using the Gantt chart,
04:22
You could create a project task.
04:27
And you could associate the documents
04:30
to this project task,
04:33
and assign it to the correct person.
04:38
Or you could simply download this document with its annotations
04:43
and attach it to an email or some other
04:46
form of communication.
04:51
Review the help documentation for more information
04:54
on the tools available in the PDF viewer
04:56
and some of the options that you have for tracking work in Upchain.
05:03
Now,
05:04
because changes are needed to this document,
05:06
it is not ready to be published.
05:10
So I will reject the workflow.
05:23
Logged back in as the mechanical manager,
05:25
I can see that the document is still in a draft state
05:29
even though the work flow has been completed.
05:32
That's my first clue.
05:34
I have also received an email that indicates the published was declined.
05:39
So I could
05:40
load the document into the PDF viewer
05:44
and review the markup that was created
05:46
and indicated to me by my project manager.
05:50
Whatever method they chose to communicate what changes were needed,
05:53
I now need to make a change to that document.
05:57
So we'll do that by checking it out,
06:03
then I can make the changes to that document as required.
06:09
And now I need to check it back in.
06:27
I could check out and check this document back in
06:30
as many times as required.
06:32
Here,
06:32
we've created
06:34
version 3.
06:39
Note that because I have versioned up this document,
06:43
the link that we created
06:45
between this document and that project template has been lost.
06:50
We created that link when it was still at version 2,
06:54
so now we need to reestablish that link.
06:57
This is why it is best to wait
06:60
to create this link until the document is
07:03
absolutely ready
07:05
to be published or is already published.
07:12
Now that we're dealing with a new document version,
07:15
we must also resubmit this to the
07:18
publishing workflow.
07:20
We do that from the
07:22
details tab,
07:23
and we'll start the workflow.
07:37
Assuming this time,
07:38
the changes are
07:40
acceptable,
07:41
this time the document
07:43
can be published.
07:54
And now the document is published at version 3.
07:57
It is also incremented the revision level to AA.
08:02
The history tab now shows version 3 is published.
08:08
This should give you a general understanding of
08:10
the PDF viewer and some of its functionality,
08:13
using a workflow to publish a document,
08:16
and what happens when the workflow is both rejected and accepted.
08:20
Keep going to learn more.
In this video, we will:
Transcript
00:05
In this video, we will revise a published document, clone a document, and archive a document.
00:11
So let's take a look.
00:15
Documents that are published are assumed to have been reviewed, signed off, and are ready for their intended purpose.
00:23
However, it is possible that further changes are still required.
00:28
In our project plan example, perhaps circumstances of the project have changed and the scope of the project has been modified.
00:36
This would require further changes to this now published document.
00:42
To be able to make changes to the document, it must be revised to return it to a draft state.
00:48
To revise the document, click the "Action" menu beside the document and select "Check Out".
00:56
Decide on a location to save the document and click "Save".
01:03
This now locks the document to you so that no other users can make changes to it.
01:09
You can now begin to work on that document in its appropriate program to make the required changes.
01:16
This is the same process as simply checking out the document when it's in a draft state.
01:23
Once the changes have been made, you can check it back in again.
01:40
This creates a new document version,
01:49
as you can see here.
01:51
And the document is in a draft state.
01:55
Now that it's back in draft, the document can be checked out,
01:57
and back in again as many times as necessary until an acceptable version of this document is reached.
02:08
The document can then be sent through the same document workflow to publish it once again.
02:24
Alternatively, if the scope of the project has changed quite drastically,
02:29
it might make more sense to simply make a new project plan and archive the old one.
02:35
This way, it is clear to others that the project plan has changed significantly,
02:40
and the original would only remain in place to be used as a reference instead.
02:48
In the web application, you can clone a document to make a new copy of it with its own document number.
02:56
This way, you aren't starting from scratch with a brand new document, but you also won't be affecting the original document either.
03:06
To clone a document, click the Action menu beside the document to be cloned.
03:13
Select "Clone".
03:16
This copies the document to your clipboard, and you can then paste it wherever you would like in a different project or a different category.
03:24
In our example, we want to paste it back into the same document category.
03:30
So click the action menu beside the document category and select "paste".
03:36
This creates a copy of the document in its selected location.
03:42
The name of the document is copied exactly from the original, but it is assigned a brand new number.
03:57
It is also in a draft state, starting at Version 1, with no revision level.
04:04
From here, it might make sense to rename both of these documents so that it is clear which one is the old one and which one is the new one.
04:17
Now that our new document is in place, we should archive the old project plan.
04:23
Note that you want to clone the document first before archiving it because you cannot clone an archived document.
04:31
This is why we performed the clone action first before we attempted to archive it.
04:41
To archive a document, click the Action menu beside the document to be archived and select "Archive".
04:51
A window opens to confirm that you wish to proceed with this action.
04:56
Archiving cannot be undone.
04:60
Click the archive button.
05:07
You can archive a document that has any status.
05:10
The document is placed in a state that cannot be modified.
05:16
You can still view its details, and you can still view and download this document, but otherwise it is locked in place.
05:32
You should now be able to revise a published document to make changes to it,
05:37
clone a document to create a copy of the document with a new number, and archive a document so that it becomes read-only but still viewable.
05:47
Keep going to learn more.
00:05
In this video, we will revise a published document, clone a document, and archive a document.
00:11
So let's take a look.
00:15
Documents that are published are assumed to have been reviewed, signed off, and are ready for their intended purpose.
00:23
However, it is possible that further changes are still required.
00:28
In our project plan example, perhaps circumstances of the project have changed and the scope of the project has been modified.
00:36
This would require further changes to this now published document.
00:42
To be able to make changes to the document, it must be revised to return it to a draft state.
00:48
To revise the document, click the "Action" menu beside the document and select "Check Out".
00:56
Decide on a location to save the document and click "Save".
01:03
This now locks the document to you so that no other users can make changes to it.
01:09
You can now begin to work on that document in its appropriate program to make the required changes.
01:16
This is the same process as simply checking out the document when it's in a draft state.
01:23
Once the changes have been made, you can check it back in again.
01:40
This creates a new document version,
01:49
as you can see here.
01:51
And the document is in a draft state.
01:55
Now that it's back in draft, the document can be checked out,
01:57
and back in again as many times as necessary until an acceptable version of this document is reached.
02:08
The document can then be sent through the same document workflow to publish it once again.
02:24
Alternatively, if the scope of the project has changed quite drastically,
02:29
it might make more sense to simply make a new project plan and archive the old one.
02:35
This way, it is clear to others that the project plan has changed significantly,
02:40
and the original would only remain in place to be used as a reference instead.
02:48
In the web application, you can clone a document to make a new copy of it with its own document number.
02:56
This way, you aren't starting from scratch with a brand new document, but you also won't be affecting the original document either.
03:06
To clone a document, click the Action menu beside the document to be cloned.
03:13
Select "Clone".
03:16
This copies the document to your clipboard, and you can then paste it wherever you would like in a different project or a different category.
03:24
In our example, we want to paste it back into the same document category.
03:30
So click the action menu beside the document category and select "paste".
03:36
This creates a copy of the document in its selected location.
03:42
The name of the document is copied exactly from the original, but it is assigned a brand new number.
03:57
It is also in a draft state, starting at Version 1, with no revision level.
04:04
From here, it might make sense to rename both of these documents so that it is clear which one is the old one and which one is the new one.
04:17
Now that our new document is in place, we should archive the old project plan.
04:23
Note that you want to clone the document first before archiving it because you cannot clone an archived document.
04:31
This is why we performed the clone action first before we attempted to archive it.
04:41
To archive a document, click the Action menu beside the document to be archived and select "Archive".
04:51
A window opens to confirm that you wish to proceed with this action.
04:56
Archiving cannot be undone.
04:60
Click the archive button.
05:07
You can archive a document that has any status.
05:10
The document is placed in a state that cannot be modified.
05:16
You can still view its details, and you can still view and download this document, but otherwise it is locked in place.
05:32
You should now be able to revise a published document to make changes to it,
05:37
clone a document to create a copy of the document with a new number, and archive a document so that it becomes read-only but still viewable.
05:47
Keep going to learn more.