Hyppää pääsisältöön

Document Workflow

Trimble Connect Web
Web
Trimble Connect
Environment
Not environment-specific

 

Image
075

 

Trimble Connect extension Document Workflow offers full control of workflow management over the selected documents (folders, files, ToDos and Releases). The documents are reviewed by predefined team members in a given order and team structure. Other features to mention: Commenting, linking ToDos, adding attachments, history tracking, and keeping the digital footprint. 

 

Image
Document Workflow

 

This help refers to version 3.7 of the extension. See tab page "About". 

Back to top

CS TC Extension package

Document Workflow belongs to the Construsoft Trimble Connect Extension package.

CS TC Extensions

Back to top

Use for

Approval of files or folders, Releases and ToDos.

Back to top

Before you start

1. Add the extension to the project (when you create a new project and add the extension, all default folders of the extensions are created in the TC extensions folder).

2. Create a workflow with predefined reviewers (see the "Editor" tab).

3. Select a file or folder (Release, ToDo) for approval and start the workflow (see the "Document Workflow" tab)

Back to top

Help overview

Document Workflow tab

  • Explorer
    • Menu bar
    • Footer bar
  • Releases & ToDos
  • Starting workflow
  • Workflow
    • Current running instance EDITOR
  • History
  • Attachments
  • Finalization
    • Finalization of RVT files
    • Finalization of Release
    • Finalization of ToDo
  • Emails
  • Detailed verification
    • Files verification
    • Verification overview
  • Detailed finalization

Verification process

  • Verify
  • Verify fail
  • Skip
  • Finalize
  • Failed by author
  • Checkin files
  • Start

Editor tab

  • Add reviewers

Settings tab

  • Roles
  • Paths
  • Defaults
    • Predefined folders
    • Automatically start workflows on selected folders
    • Editable custom attributes at finalization
    • Pair workflow statuses with TC Explorer file statuses
    • Define workflow name masks
    • Predefined comments
    • Advanced email notifications

About tab

  • Version
  • Documentation
  • License Manager
  • Store
     

Document Workflow tab

On the "Document Workflow" tab, the user can start any predefined workflow on file(s) or folder(s), Release or ToDo (documents) and then follow the process of the workflow verification. 

  • On the left side of the extension, there is the workflow table where folders and files (explorer), or Releases, or ToDos are selected using checkboxes. Already started workflows are displayed in this table and can be opened.
  • On the right side of the extension, there is a detailed view of the selected workflow. When a workflow is opened, details can be viewed, and it can be verified once it has been started.
  • At the bottom side of the extension, the workflow template can be selected and started.
Image
DW tree
Back to top

Explorer

The explorer serves for selecting folders or files from directory tree structure on which the new workflow can be started or already running workflow can be opened.

Image
155

 

OptionDescription
1

Menu bar. 

Option "Explorer" is selected.

2

Document structure tree. 

Select file(s) and/or folder(s) by checkbox to start a new workflow.

The width of the document tree structure can be changed using the mouse. Grab the edge between the explorer and an opened workflow and change the width by pulling on the right or the left side.

3Open the already running, finalized, or failed workflow detail.
4Footer bar.

Menu bar

Image
080

 

OptionDescription
1

Select the view mode.

Options:

  • Explorer - folder structure tree, start workflow on the file(s) and/or folder(s).
  • Releases - start workflow on a Release.
  • ToDo - start workflow on a ToDo.
Image
081
2Filters added to menu bar.
3Search documents by name.
4

Open the overflow menu with filter options.

Image
082

 

To add the filter to menu bar, hover over the filter and use right-click and select the option "Add to menubar".

Image
083

 

The filter is added to menu bar for quick access.

Image
084

 

Image
085
Show workflow - all files and folders with workflows are listed.
Image
086
Show assigned to me.
Image
087
Show supervised by me.
Image
088
Show finalized.
Image
089
Show in progress.
Image
091
Show failed.
Image
090
Show expired.
Image
092
Manage expired.
Image
093
Highlights all files of workflows in the directory tree.
Image
094
Show custom workflows in directory tree.

Footer bar

Image
095

 

OptionDescription
1

View the selected files and folders.

Image
096

View or unselect the listed files and folders.

2
Image
057
Refresh the folder structure tree.
3
Image
165
Start new workflow on selected item(s).
Back to top

Releases & ToDos

The tables for Releases and ToDos work similarly.

Image
156

 

OptionDescription
1

Menu bar. 

Option "Releases" is selected.

2

Table with Releases.

Select a Release to start the workflow.

Open the already running workflow.

The width of the document tree structure can be changed using the mouse. Grab the edge between the explorer and an opened workflow and change the width by pulling on the right or the left side.

Image
158
The icon indicates that the Release is sent, and the workflow can't be started on this Release.
Image
157
The icon indicates that the Release is in draft state, and the workflow can be started on this Release.
3Footer bar.
4

Menu bar. 

Option "ToDos" is selected.

5

Table with ToDos.

Select a ToDo to start the workflow.

Open the already running workflow.

The width of the document tree structure can be changed using the mouse. Grab the edge between the explorer and an opened workflow and change the width by pulling on the right or the left side.

6Footer bar.

 

Back to top

Starting workflow

When the file(s) and/or folder(s) (Release, ToDo) is selected, the workflow is started by the "Start new" button (see option 3 in the "Footer bar" paragraph). A dialog opens.

Workflow can be started on multiple folders and files from different folders as a custom selection workflow.

 

NOTE: The workflow can be started with a maximum of 2000 files, folders and subfolders.

 

Image
Start new workflow

 

OptionDescription
1

The informative message. The files and folders selected for this workflow have different paths and the workflow will be created as custom selection workflow.

Selected files and folders are listed in tooltip when hovering over the number. 

Image
099

 

Image
Custom selection icon

Custom selection workflows are indicated in the tree structure with a unique icon.

Files selected to start custom selection workflow can be viewed when clicking on the file icon in the folder structure tree.

Image
Custom selection files
2Unique identifier for each workflow.
Image
100

Edit the ID.

Choose a number that has not been used yet. 

ID must be greater than 1000.

Image
101
3
Image
Lock icon

 

Image
Unlock icon
Private / Public workflow

Private workflow can only be viewed by the author, reviewers, supervisors, followers and project administrators.
4Select the template. 
5
Image
Followers

Enable the toggle and select users or groups who will follow the workflow. Followers remain informed throughout the workflow lifecycle without the ability to approve.

6

Workflow name is generated based on the defined workflow name masks (see option "Define workflow name masks" on the "Settings" tab).

Workflow name can be adjusted manually in this dialog.

7

Add a comment. 

Without comment, the workflow can't be started.

8
Image
102
Add attachments.
9

View all files for verification.

NOTE: Selected files and files from all selected folders are listed there.

10Warning. Reviewers without access to the folder(s).
11
Image
165
The workflow can be started by the "Start new" button.

NOTE: When the new workflow starts, the file(s) are locked to avoid the upload of new versions of these files while the workflow is running.

 

Users in the pending state and users who are not project members can be added to the workflow, but they cannot verify it. When there is a user in the pending state or a user who is not a project member among the reviewers or supervisors, the notification “Users with a state of 'Pending'” or “Users who are not members of the project” is shown with the list of these users. After clicking Start new, a warning is shown and the workflow can still be started.

 

Image
178
Image
Warning pending or removed users

 

When there is a user without access to the files selected for the approval, the notification is shown in the "Start new workflow" dialog.

Image
179

 

When the current reviewer is in the pending state or is not a project member, the workflow is assigned to them, but they cannot verify it. A notification is shown and the author receives an e-mail. The workflow can continue only after this reviewer is skipped.

 

The project administrator can adjust the workflow in the current running instance editor.

Users in a pending state or users who are not project members are indicated in the workflow and editor by the color of the icon.

 

OptionDescription
Image
141
The user is in the pending state.
Image
Removed user
The user is not a project member.

Who can skip pending or removed members:

  • Project administrator
  • Author
  • Author’s supervisor
  • Supervisor
Back to top

Workflow

When the new workflow starts or the workflow is selected in the explorer (Releases or ToDos), it opens on the right side.

Image
105

 

The workflow has the following sections and active buttons:

Image
154

 

OptionDescription
1

Header with basic information about current workflow:

  • Document name - document above which the current workflow is running.
  • Workflow - the name of the current workflow.
  • ID - numerical identifier unique for each workflow.
  • Assigned to - the name of the user, who should verify the document.
  • Comment - comment added when the workflow has been started.
2Attachments added when the workflow was started.
3

Files for verification - the number of files in the workflow. Expand the section to see the list of files with their versions and paths. Use the "View" button to open the file.
When the workflow is finalized, the section changes to "Finalized files" and the "Overview" button opens the Verification overview.

 

Image
Files for verification
4
Image
038
View history (see the "History" paragraph).
Image
029
Edit workflow.
Image
082
Remove workflow.
5

Table in which all team members participating in the current workflow verification process are visible. Above, the author of the workflow, author's supervisor(s) and follower(s) are displayed. Expand the reviewer's row to see the reviewer's comment.


When the template has "Review result set as private" enabled, a lock icon is displayed in the table header and the comments of other reviewers are replaced by the text "Review result is private".

6
Image
135
Add attachments.
7Section, where the active reviewer has to add a comment to his statement.
8

Action buttons used by the active reviewer, supervisor(s) or the author of the current workflow.

Options:

  • Verify - used by an active reviewer or the supervisor(s) of the active reviewer.
  • Verify failed - used by an active reviewer or the supervisor(s) of the active reviewer. Any reviewer from the current workflow can verify fail at any time during the verification process.
  • Finalize - used by the author.
  • Skip - used by supervisor(s) of the active reviewer, the author or the author’s supervisor. The author can skip any reviewer at any time during the verification process.

NOTE: see more about action buttons in the "Verification process" section.

9Refresh the current workflow details.


Current running instance EDITOR

The running workflow can be edited. By pressing the button "Edit workflow" (see option 4 in the "Workflow" paragraph), the editor opens.

Image
107

 

OptionDescription
1

The workflow ID, name, and the document name.

The current running instance editor works the same way as the workflow editor (See the "Editor" tab). Also, the same options can be edited.

NOTE: The current reviewer can't be changed or edited.

2Add reviewersAdd reviewers.
Apply changesApply the changes made in the workflow.
3DisplayDisplay the original template.
SaveSave the template with changes under the original name.
Save asSave the template with your changes under a new name.

 

Back to top

History

When the "View history" button is used, the "Workflow history" dialog opens.

Image
015

 

OptionDescription
1Expandable section with information about the step in the verification process.
2When the section expands, the e-mail of the reviewer, status, time, and comment are displayed.
3Download button - the workflow history can be downloaded in PDF file format.

 

Back to top

Attachments

Every time the reviewer, the author or the supervisor reviews the workflow, they can also add attachments. The dialog opens.

Image
180

As attachments, views, files, ToDos, and BCF Topics can be added by opening the proper section and selecting the desired attachment. All documents can be searched by name.

 

In the "Views" section, only related views can be shown.

Image
147

 

In the "ToDo" section, the following operations can be performed.

Image
184

 

OptionDescription
1Filter ToDos according to assignees.
2Filter ToDos according to the team member who created them.
3Search ToDos by tags.
4Activate the icon to filter ToDos containing all selected tags. When the icon is not active, all ToDos containing at least 1 tag from all selected will be displayed.
5
Image
183
Search ToDos by name.
Image
182
ToDos editor active when the ToDo(s) is selected. Add new or already existing tag(s).

 

In the "BCF Topics" section, the following operations can be performed.

Image
181

 

OptionDescription
1Filter Topics according to assignees.
2Filter Topics according to the team member who created them.
3Filter Topics by tags.
4Activate the icon to filter Topics containing all selected tags. When the icon is not active, all Topics containing at least 1 tag from all selected will be displayed.
5
Image
183
Search Topics by name.
Image
182
Topics editor active when the Topic(s) is selected. Add new or already existing tag(s).
6Topics are listed with the label, the name, and the tags. The details can be displayed in tooltip by hovering over the Topic.

 

Back to top

Finalization

Before the finalization is done, the dialog with the finalization options opens.

 

Finalization of file(s) and/or folder(s)

Image
185

 

OptionDescription
1

The published folder path set by default can be changed in the "Finalize workflow" dialog. 

General published folder path is set in the "Settings" tab. But it can be specified for each workflow individually in the "Editor" tab.

2The list of files belonging to the workflow.
3

Publication mode - choose the way, how the documents should be proceeded after finalization. The default option is shown in this dialog first, but it can be changed.

Options:

  • No action
  • Copy approved documents
  • Move approved documents
4

Settings options set by default in the "Settings" tab.

Options:

  • Inherit published folder permissions - decide, whether the folder approved and finalized should inherit published folder's permissions or keep its original permissions.
  • Maintain folder structure - decide, whether the folder structure should be maintained when the workflow is finalized.
  • Unlock files - unlock the files after finalization (unless there is an active or finalized workflow on the file, folder, or parent folder, the file is attached to a Release, or the user has insufficient rights).
  • Set custom attributes on finalized files - available when "Editable custom attributes at finalization" is enabled, the selected custom attributes will be written to each source file. Fill in all fields.
5
Image
151
Interrupt the finalization and close the dialog.
Image
150
Finalize the workflow.

When the workflow is finished, the history report in PDF format is automatically exported to the "Published" folder (see the "Settings" tab).

 

When a folder is finalized and in the folder for publication, there is already a folder with the same name, a warning message opens. The message informs the user about the existence of such a folder and about the attempt to merge the content of these folders together.

Image
186

 

Finalization of RVT files

RVT files can't be copied within Trimble Connect project. When RVT files are among the files to finalize and the option "Copy approved documents" is selected, the warning message shows up with selection from the options:

  • Copy without RVT files - the RVT files won't be copied nor moved to published folder (the other files will be copied).
  • Move the RVT files - the RVT files will be moved to published folder instead of copying (the other files will be copied). 
Image
149

 

Finalization of Release

When the workflow above the Release is being finalized, the dialog has the additional option "Send Release". If enabled, Release will be sent after finalization of the workflow.

Image
187

 

Finalization of ToDo

When the workflow above the ToDo is being finalized, the dialog offers the option to change the status of the ToDo. If this option is selected, the status of the ToDo will be changed to “Done” after finalization the workflow.

Image
188

 

Back to top

Emails

Document Workflow is sending informative emails to the reviewer, the supervisor, or the author when there are actions needed from them or about other important news in the verification process.

  • The reviewer gets the email when he should verify, in case he was skipped and after finalization of WF.
  • The reviewer's supervisor(s) gets the email in case the supervised reviewer doesn't verify in the given review time.
  • The author gets the email when the workflow should be finalized. The followers get the email when the workflow is started and when it is finalized.

 

In the following example, the information provided in the email is visible:

  • Project name
  • File name
  • File path
  • Workflow name
  • Action needed
  • Review time

 

Image
021

 

The email includes direct links to the project and the workflow.

 

Back to top

Detailed verification

Use detailed verification to have possibility to approve each file separately. 

Detailed verification is optional for each workflow. Set it for the desired workflow in the "Editor" tab by enabling the option "Detailed verification and finalization".

Detailed verification is not available in the sub-workflow.

In the running workflow, the Detailed verification can be found in the section "Files for verification".

Image
115

 

When the button "Detailed verification" is used, a new dialog opens where the files for the verification can be reviewed separately.

Image
040

 

In the "Detailed verification" dialog, there are 2 sections:

  • Files verification - in this section, the files are reviewed, and it is available only for the active reviewer.
  • Verification overview - the overview of all approval steps concerning the files. 

 

Files verification

When the section "Files verification" is opened, the table with the list of attached files is displayed. 

The file is selected by clicking on the name of the file, multiple files are selected with checkboxes. The comment, attachments and statement are added filling the part on the right side of the dialog. 

Image
116

 

OPTIONDESCRIPTION
1Toolbar with multiple options and filters.
Select all files
Search files by name.

Filter files according to the verification status.

Options:

  • -
  • Verify failed
  • Verified 
Image
042
Show only commented files.
Image
043
Show only files with attachments.
2The list of attached files. The color of the icon indicates the verification status of the file.
Image
044
The file was verified.
Image
045
The file was verify failed.
Image
046
The file without statement.
3
Image
047
The file has a comment.
Image
048
The file has attachment(s).
Image
049
View the file in a new tab.
4Show the path of the files.
5Add a comment for selected file(s).
6Add the attachment(s) for selected file(s).
7Action buttons.
Image
051
Verify the selected document(s).
Image
052
Verify failed the selected document(s).
Image
050
Remove the verification from the selected file(s).

 

Verification overview

The overview of the detailed verification is available for active reviewer, or any project member authorized to see the workflow. 

Image
117

 

OPTIONDESCRIPTION
1Toolbar with multiple options and filters.
Search files by name.

Filter files according to the verification status:

Options:

  • -
  • Verify failed
  • Verified 
Image
056
Show only reviewers who have already verified.
2
Image
057
Refresh the verification overview.
3Table with files and overview of their verification.
4
Image
159

File verification overview.

 

Image
064
Image
160
View the file in a new tab.
5The number in the column indicates how many times the file verify failed.
6Check in each column the verification status for each file given by the reviewer.
Image
058
Verified during detailed verification.
Image
061
Verify failed during detailed verification.
Image
059
Verified during the verification of the entire workflow.
Image
060
Skipped during the verification of the entire workflow.
Image
062
Verify failed during the verification of the entire workflow.
7Show the path of the files.

 

Back to top

Detailed finalization

Together with detailed verification also detailed finalization is enabled in the finalize workflow dialog.

This option allows to select the files that will be finalized.

In the top right corner of the "Detailed finalization" button, the number indicates the number of files selected for finalization. By default, all the files are selected.

Image
189

 

Use the "Detailed finalization" button to open the dialog to select the files for the finalization. 

Image
118

 

OPTIONDESCRIPTION
1Toolbar with multiple options and filters.
Search files by name.

Filter files according to the verification status:

Options:

  • -
  • Verify failed
  • Verified 
Image
067
Show only reviewers who have already verified.
Image
068
Show only selected files.
2
Image
057
Refresh the table.
3

Table with files and overview of their verification. In this table, select the files that will be finalized. 

For the further description, please see the similar table in the "Verification overview" in the "Detailed verification" section.

4Show the path of the files.

 

Before the workflow is finalized, the message informs about the number of files selected for finalization. 

Image
069

Confirm your choice using "OK" button and finalize the files. 

 

After finalization in the "Verification overview", the first column in the table "Finalized" provides the information that files were finalized.

Image
120

 

The workflow can be started again to approve the remaining files which weren't finalized yet.

Image
119

Verification process

Reviewers review the workflow in a given order using the action buttons.

Image
144

 

Verify

Reviewers and their supervisors can approve the item(s).

 

Role
Image
164
Reviewer✅The reviewer can verify the workflow when it is turn of this particular reviewer.
Reviewer's supervisor✅

The reviewer's supervisor can verify the workflow when it is turn of this particular reviewer.

When the reviewer is a group, using checkboxes, the supervisor of the group can verify the workflow instead of selected group members.

Author❌-
Author's supervisor❌-

 

Verify fail

The action used by reviewers or reviewer's supervisors when the reviewed documents do not meet the required criteria and need adjustments.

 

Role
Image
165
Reviewer✅The reviewer can verify fail the workflow at any time during the workflow process.
Reviewer's supervisor✅

The reviewer's supervisor can verify fail the workflow when it is turn of this particular reviewer.

When the reviewer is a group, using checkboxes, the supervisor of the group can verify fail the workflow instead of selected group members.

Author❌- 
Author's supervisor❌-

 

Skip

This action is used to bypass a reviewer’s turn without verification, allowing the workflow to continue to the next step.

 

Role
Image
166
Reviewer❌-
Reviewer's supervisor✅

The reviewer's supervisor can skip the reviewer when it is turn of this particular reviewer.

When the reviewer is a group, using checkboxes, the supervisor of the group can select group members, who should be skipped.

Author✅

The author can skip the workflow at any time during the workflow process.

When the reviewer is a group, the author can choose group members, who should be skipped using checkboxes.

Author's supervisor✅The author's supervisor can skip the workflow at any time during the workflow process.
Project admin✅The project admin can skip reviewers who are in the pending state or not project members.

 

The author of the workflow (or the author's supervisor) has additional action buttons enabled.

Image
167

 

Finalize

Once all reviewers respond, the author finalizes the workflow by publishing the documents and the report.

 

Role
Image
168
Reviewer❌-
Reviewer's supervisor❌-
Author✅The author can finalize the workflow once all reviewers respond.
Author's supervisor✅The author's supervisor can finalize the workflow once all reviewers respond.

 

Failed by author

Once all reviewers respond, the author can fail the workflow when the reviewed documents do not meet the required criteria and need adjustments.

 

Role
Image
169
Reviewer❌-
Reviewer's supervisor❌-
Author✅The author can fail the workflow once all reviewers respond.
Author's supervisor✅The author's supervisor can fail the workflow once all reviewers respond.

 

In the failed workflow, the project admins have following action buttons enabled:

Image
171

 

Checkin files

When the reviewer who failed the workflow has insufficient permissions to checkin the files, the action can be carried out by the author of the workflow (or author's supervisor) or any project admins throughout the workflow.

 

Role
Image
170
Reviewer❌-
Reviewer's supervisor❌-
Author✅

The author can checkin files as long as they are not blocked by another workflow.

Non-admin authors can check in only the files they checked out.

Author's supervisor✅The author's supervisor can checkin files as long as they are not blocked by another workflow, unless this supervisor has the User role in the project.
Project admin✅The project admin can checkin the files.

 

Start

When the workflow fails, it can be started again by single click.

 

Role
Image
172
Reviewer❌-
Reviewer's supervisor❌-
Author✅The author can restart the workflow.
Author's supervisor✅The author's supervisor can restart the workflow.

Editor tab

On the "Editor" tab, new workflow templates can be created and existing ones can be edited.

Image
Editor tab

 

When a new workflow template is created or an existing template is opened, several options for this template are available.

Image
Template

 

OptionDescription
1

Click Create a new template. Dialog opens.

Image
Create a new template

After entering the name for the new workflow, use the button "Create".

2Select an existing workflow from the drop-down list. The template name will appear in the field. The workflow will then open, allowing all reviewers and parameters to be edited.
3Action buttons for selected workflow.
Image
129

 

Clone the template. This option allows copying the workflow and saving under a new name. When selected, the dialog for entering a new name opens.

Image
Clone this template
Image
130

 

Remove the workflow.
4

The table lists reviewers who will review the document(s) in the specified order.

Image
Table Editor tab

The order of reviewers in the workflow can be changed by using drag and drop function.

For each reviewer, the supervisor(s) and review time can be set in this table. Also, reviewers can be removed.

5Additional settings set individually for each workflow.
Detailed verification and finalizationDecide, whether the detailed verification (verification and finalization of the attached files) should be allowed for the workflow. 
Automatic skipping

When the reviewer who is in the review queue runs out of the review time, this reviewer is auto-skipped. 

This action is done every day when any admin or user opens the project for the first time. 

Image
123
Automatic finalizationDecide, whether the workflow should be finalized automatically. When enabled, workflows where all reviewers have completed their review are offered for finalization in the "Automatic finalization" dialog when the extension starts. Only the author or a project administrator can approve the automatic finalization.
Verify fail stops workflow Decide, whether the "verify fail" should stop the workflow or not.
Review result set as private

When enabled, comments and attachments remain private for other reviewers.

 

Review results are visible for:

  • Project administrator(s)
  • Author
  • Author’s supervisor(s)
  • Supervisor(s)
  • Follower(s)
  • Reviewer who performed the verification
6Author’s supervisorSelect users who will have the same rights as the workflow author.
7Only author’s supervisor can finalizeDecide, whether only author’s supervisor can finalize.
Author can skip reviewersDecide, whether the author of the workflow should be authorized to skip reviewers.
8Publication modeNo actionThe document(s) will not be copied or moved.
Copy approved documentsThe document(s) will be copied to a predefined folder.
Move approved documentsThe document(s) will be moved to a predefined folder.
9Published folder pathSelect the folder to which the documents and the PDF report will be published.
10
Image
124
Add reviewers (see the "Add reviewers" paragraph).
11
Image
125

Save changes. 

The button turns yellow to indicate unsaved changes in the workflow template.

Image
126
12

View JSON preview.

Image
128

 

Add reviewers

Use the "Add reviewers" button (see option 10 in the table above) for adding individual reviewers, group, or workflow as a reviewer. The dialog appears.

As a reviewer, a project member, a group, or other workflow can be selected.

Image
129

 

OptionDescription
1

Create group.

Enter the name of the group in the field and then select the group members from the "Reviewers" section.

Image
061
Image
029

Edit the group. The dialog opens. The group name, review time, and required reviews can be edited.

Image
Edit group editor tab

Select "OK" to apply changes.

2Set the review time for selected reviewers.
3Decide, how many group members must review the workflow and set the required reviews.
4Select reviewers from individual project members.
5Select reviewers from project groups.
6

Select reviewers from other workflows to become sub-workflows.

NOTE: Workflow can have only sub-workflow with sub-sub-workflow. Deeper nesting levels are not allowed!

7Confirm selection of reviewers and add them to the workflow by the button "Add reviewers".

Settings tab

On the 'Settings' tab, you can assign roles to project members, define paths, and configure the default settings.

Image
Settings tab

Roles

The "Roles" table lists the project members, and their permissions can be edited there.

Image
131

Admins in the project have automatically permission to start and edit workflows.

Users in the project have by default no permission to start or edit workflows, but the admins can give them permission to do these manipulations.

 

Paths

In the "Paths" section, the paths of the workflow container and published folder can be edited.

Image
099

 

By clicking in the path field, the dialog for selecting the desired folder opens.

Image
Select workflow container path

 

Image
Select published folder path

 

A user can create a new folder if necessary, by selecting the folder to which the new folder should be created and using the "Create a new folder" button. The dialog opens.

Image
Create a new folder

When a new folder is created, it is automatically selected.

 

When a desired folder is selected, it can be confirmed by the "Save" button.

Image
101

The performed changes must be saved.

 

Defaults

In the section "Defaults", configure the default settings for the Document Workflow.

Image
Defaults settings

 

On the left side of the extension, enable or disable by toggle button the following options:

  • Maintain folder structure - decide, whether the folder structure should be maintained when the workflow is finalized.
  • Unlock files when the workflow is finalized - unlock the files after finalization (unless there is an active or finalized workflow on the file, folder, or parent folder, the file is attached to a Release, or the user has insufficient rights).
  • Inherit published folder permissions when workflow is finalized - decide, whether the folder approved and finalized should inherit published folder's permissions or keep its original permissions.
  • Send a Release when the workflow is finalized - when the workflow running on the Release is finalized, the Release will be sent automatically.
  • Review time includes weekends - decide, whether the weekends should be included in the review time or not.
  • Document structure check interval - set the check interval of the document structure. The minimum is 2 minutes, the maximum is 30 minutes. This check interval reveals changes in the documents, Releases and ToDos and refreshes the document structure tree.

 

On the right side of the extension, more settings are available. These have an expandable menu with advanced customizable settings:

Predefined folders

This function allows specific folders to be configured for use with the Document Workflow. Limiting to selected folders helps improve performance. 

Image
Predefined folders

Use the edit button to select Predefined folders. Don’t forget to enable the function.

Image
Predefined folders dialog

 

Only the selected folders will appear in the Document Workflow tree structure.

Image
Tree structure

 

Automatically start workflows on selected folders

This function allows the selection of a folder on which the workflow will start automatically. New workflow is triggered every time new file or new file version is added in the folder during the check.

Image
Automatically start workflows

 

OptionDescription
1

Choose for whom this function will be performed. For example, if the "Admins" option is selected, the check will be executed at the set interval whenever any admin is working in Document Workflow or in the Trimble Connect project where the Document Workflow is running on the background (the extension is active).

Options:

  • Admins
  • Specific users
  • Anyone who can start workflow
2Set the interval for checking whether a new automatically initiated workflow should be created. This control monitors newly created instances and new files added to folders with an automatically started workflow. The interval is measured in minutes, with a minimum setting of 30 minutes.
3Determine whether the skipping of automatic workflow creation should be permitted. If enabled, users will have the option to skip the automatic workflow creation process.
4The table displays the automatically initiated workflows along with their respective folders. Action buttons for adjusting the configured instances are available.
Image
104
Edit the automatically initiated workflow instance. The "Set up auto-run workflows" dialog opens, where the folder and workflow can be changed.
Image
105
Remove the automatically initiated workflow instance.
5

Add new definition. A new row for auto-run workflow setup is added to the table. Using the action buttons, a new instance can be created (See the action buttons in option 4).

Image
134
6The "Start Action" button is used to manually trigger a check and the creation of automatically initiated workflows.
7
Image
113
Reset the changes.
Image
114
Save the changes. When some changes are made, the button turns yellow signalling the need for saving to keep the changes.
8
Image
import from preset

Import from preset opens a dialog for uploading a preset exported from any project. The import replaces all previously created definitions.

 

Export preset downloads .json file with all defined automatic workflows.

 

Automatically initiated workflows are distinguished in the tree structure by a sign for automatically started workflows.

Image
135

 

Additionally, the workflow header includes labels indicating that the workflow was started automatically.

Image
136

 

IconDescription
Image
118
Automatically started workflow sign.
Image
119
Automatically started workflow sign with the tooltip.

Editable custom attributes at finalization

When this function is enabled, users can modify file metadata when files are finalized.

 

Image
Editable custom attributes
OptionDescription
1Enable / disable Editable custom attributes at finalization.
2Add preferred custom attributes to be updated during finalization.
3Action buttons.

When a workflow is ready to finalize, the Set custom attributes on finalized files section appears in the Finalize workflow dialog. Complete the fields selected in the previous step.

Image
Editable custom attributes Finalization

Pair workflow statuses with TC Explorer file statuses

This function allows pairing the workflow status with the file status in the Trimble Connect Explorer.

Image
137

 

OptionDescription
1Enable/disable this function.
2

Select the type of metadata to pair the workflow status with. 

Workflow status can only be paired with one selected metadata type.

The available selection depends on custom property type. Only custom property type "Dropdown" can be selected here.

Manage the metadata types in the account, in the "File Attributes" section (Account administration > Account > Property sets > File attributes).

3

The table for setting the file status that should be paired with the workflow status. 

Workflow statuses:

  • In progress
  • Failed
  • Finalized with error
  • Finalized
  • Default
4Action buttons possible to use for file status settings.
Image
104
Edit the file status.
Image
105
Remove the file status.
5Action buttons.
Image
113
Reset the changes.
Image
114
Save the changes. When some changes are made, the button turns yellow signalling the need for saving to keep the changes.

 

When the "Edit" button is used, the dialog for file status selection opens.

Image
173

 

OptionDescription
1Select the file status.
2
Image
174
Confirm the choice.

 

In the following table, see the example of the metadata type and file status options.

Metadata type exampleFile status options example
Status document
  • -
  • Concept
  • Final
  • In progress

 

Define workflow name masks

Define how the workflow name is generated.

If no other mask is defined, the default workflow mask is applied.

Image
139

 

OPTIONDescription
1Enable/disable this function.
2

Define how the name will be generated for standard and custom selection workflows.

Check the preview of the name under the field.

3

Define how the name will be generated for automatically started workflows.

Check the preview of the name under the field.

4Action buttons:
Image
140
Reset the changes which are not saved yet.
Image
141
Save the changes.

 

Click on the field to adjust the mask. The dialog opens. 

Image
142

 

OPTIONDescription
1

Selected properties for workflow name mask.

Check the preview of the name under the fields.

2

The field with properties possible to use for the workflow name mask. When the option text/separator is used, custom text can be entered, or you can choose from predefined separators.

Image
144
3
Image
162
Use the "add" icon to add the property to the mask.
4
Image
161

Use the "OK" button to confirm completed workflow name mask. 

The workflow name mask has to be then saved in the first dialog, otherwise the changes won't be saved.

NOTE: When starting new workflow, the name will be generated according to the predefined workflow name mask. This name can be manually adjusted in the "Start new workflow" dialog. 

 

Predefined comments

This function allows creation of predefined comments that can be selected in the Workflow detail to add/replace a comment value.

Image
138

 

OptionDescription
1Enable/disable this function.
2The table displays predefined comments with their labels and appropriate comments. Action buttons for adjusting the configured predefined comments are available.
Image
104

Edit the predefined comment. The dialog opens. Label and comment can be edited separately, and changes are confirmed using the "OK" button.

Image
125
Image
105
Remove the predefined comment.
3

Add new predefined comment. The dialog for entering the label and the comment opens. 

Image
126
4
Image
113
Reset the changes.
Image
114
Save the changes. When some changes are made, the button turns yellow signalling the need for saving to keep the changes.

 

Advanced email notifications

Enable or disable sending of the advanced email notifications. By default, sending of these emails is disabled.

Image
177

 

OptionDescription
1When enabled, the email is sent to the reviewer one day before the review time expires. 
2

When enabled, the email is sent to the reviewer, the author, and the author's supervisor(s) when the review time expires. 

 

NOTE: When the review time expires, the email is always sent to the reviewer's supervisor(s), even when this advanced email notification is disabled.

3
Image
113
Reset the changes.
Image
114
Save the changes. When some changes are made, the button turns yellow signalling the need for saving to keep the changes.

 

About tab

On the "About" tab general information about the extension and the developer can be found. 

Image
190

 

Version - check the version of the extension.

Documentation - find the instructions about the functionality on the TUA help page.

License Manager - manage your licenses in the License Manager.

Store - get the license for the extension and other tools in the Construsoft eshop!

All rights reserved. No conclusions can be associated to the representation of the pictures in relation to the operating systems under which Tekla Structures runs.

This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/4.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

Back to top
Lähetä