How to Use SetBuilder

Follow

Updated:

User Topics

Create a New Set

To create a new Set:

  1. Select the Add New Set button.
  2. Enter a name for the new Set:

mceclip0.png

  1. Select Add.

A newly-created, empty Set appears in edit mode, with the status set to In Progress by default:

mceclip1.png

Note: A Set’s name cannot be the same as another Set in that workspace. (A new Set can also be created by cloning an existing Set.)

Set Folder

When a new Set is created, a corresponding folder (referred to as the Set folder) will be created.  Each Set folder is a subfolder of the Sets folder that was previously created when the Sets tab was enabled in the workspace (see Configuring SetBuilder). This Set folder will have the same name as the Set to which it is associated.

Note: When the Set is renamed through the SetBuilder application, its Set folder will be renamed accordingly.

The Set folder will be used to store all the documents added to the corresponding Set. The newly created Set folder inherits its profile values from its parent Sets folder. Documents added to a Set will inherit their profile values from the Set folder by default, although the profile values of individual documents can be changed later. To ensure that documents added to the Set are given the correct default profile values, it is strongly recommended that immediately after you create a new Set, you edit the profile of its Set folder.

If you have access to a Set then you will should access rights to its Set folder and to every document in the Set folder. To access a Set folder, select the Open Set Folder action when viewing or editing the Set. The Set folder opens in a new browser tab:

mceclip1.png

You can also go to a Set folder in the Navigation Pane:

mceclip2.png

Generally, you should not make changes directly to the contents of a Set folder. It is strongly recommended that you make the following types of changes to a Set and its documents through the Set’s index from inside the Sets tab:

  • Renaming and deleting documents
  • Renaming or deleting the Set

The only types of changes that you should make separately on a document in a Set are editing the document’s content (for example, using ndOffice or uploading a new version) or updating a document’s profile. You are encouraged to update the content of a Set document directly when changes are required. The only change that you should make directly to a Set folder is editing its profile.

Back to Top

Access a Set

To access an existing Set, in the table in the Sets tab, select the Set’s name. The Set’s index will appear in view mode by default:

mceclip3.png

None of the editing features of a Set are available from view mode. You can perform only the following actions in view mode:

  • Select a document’s name to open the document in another browser tab, which is an easy way to access the document so that it can be edited directly:

mceclip4.png

  • Select the Set name to access the Set menu and any of its actions:

mceclip5.png

  • Select the binder icon to access the list of binders previously generated for the set (see Access Binders):

mceclip6.png

  • Select the mceclip71.png icon to view the audit trail for the Set (see Audit Trail):
    mceclip7.png
  • Select Back to Sets to return to the list of Sets in the workspace :

mceclip8.png

Back to Top

Edit Mode

To edit an existing Set, select the Edit button in view mode, which will put the Set into edit mode:

mceclip9.png

(When a new Set is created, it automatically opens in edit mode.)

Note: All changes made to a Set are saved immediately and automatically. You do not need to save changes manually or select the Done button to save changes.

Lock the Set

If you are editing a Set, the Edit button will not appear to another user and no other user can edit the Set at the same time. However, other users can access the Set in view mode and will see any changes being made to the Set in real time. The Set will also show the name of the user currently editing it:

mceclip10.png

Note that editing a Set will lock it for other users. If you are editing a Set, the edit lock on a Set will be removed automatically when your device loses internet access, the browser tab or browser is closed, or your device goes to sleep.

When you have finished editing a Set, select the Done button to unlock the Set so that another user can edit it, and this will return the Set to view mode:

mceclip11.png

Alternatively, you can select Back to Sets to return to the list of Sets. This action will also unlock the Set for another user to edit:

mceclip12.png

Add Elements to a Set

When you are working on a Set, your focus will be adding headers, placeholders, and documents to the Set’s index. Below is information on how to add each type of element.

Add a Header

There are two ways to add a header to a Set:

  1. Select the Add Header button:

mceclip13.png

A new header form will be added to the bottom of the index, without indentation:

mceclip14.png

To add the new header, enter the header name in the Header field and press Enter or select the checkmark icon. (To cancel adding the new header, select the x icon.) Headers that have been created appear as black text in the index.

mceclip15.png

  1. Alternatively, you can position a new header anywhere in the index at the time the header is created. Drag the Add Header button to any location in the index. The new header form will be shown in that location. (You can nudge the header to the right to indent it to the same indentation as existing elements.)

Any existing element can be moved to another location in case the initial location is incorrect. 

The other two elements, placeholders and documents, are inserted into the index in a similar way, either by selecting the element’s button, which adds the element’s form to the end of the index, or by dragging the element’s button to the desired location.

Add a Placeholder

Similar to headers, a new placeholder can be added to the end of the index by selecting its button or dragging to a specific location in the index using the [-] button.

mceclip16.png

The placeholder form will then appear:

mceclip17.png

To save the placeholder, enter the placeholder name and press Enter or select the checkmark icon. Placeholders appear as bold text surrounded by brackets in the index:

mceclip18.png

Add One or More Documents

Just like for headers, a new document can be added to the end of the index by selecting its button or dragging to a specific location in the index using the document icon button (mceclip19.png).

mceclip20.png

After taking that action, you will be asked to determine how the document will be added and from where:

mceclip21.png

You have three options:

  1. Drag and drop one or more documents (and/or folders) from your computer
  2. Select one or more documents from your computer
  3. Copy an existing document in the same workspace

Regardless of which method is used, there will be no opportunity at the time a document is added to the Set to profile the document. Newly-added documents will simply inherit the profile values from the Set folder, which is why it is recommended that you profile the Set folder at the time the Set is created. However, if you have edit rights to any document that has been added, you can access a document from the Set folder (select the document’s name in the index or select Open Set Folder), and then profile the document after adding it to the Set:

mceclip22.png

Drag Documents and Folders

From Windows File Explorer or the Mac Finder application, you can select one or more documents and/or one or more folders and drag them to the browser window to add them to the Set. Dragging a folder or folder structure will convert every dropped folder into a header in the index.

One common workflow is to collect and organize the content of the Set on your local computer, maintaining the structure with folders, and then drag the entire folder structure into a blank index.

mceclip23.png

Here is what the result of dragging the content looks like in the index:

mceclip24.png

All the folders and subfolders have been added as headers, with the documents added inside them.

Note: It is also possible to drag documents and/or folder directly onto the index -- without starting with the Add Document button -- by dragging the selected content to the location in the index where the content should be added.  A blue line will appear at that location where the content will be added when you drop it:

mceclip25.png

During the process of uploading content from your local computer, the status of uploading each document will be shown. You can cancel any document before it is added and, instead, a placeholder will be inserted.

mceclip26.png

In addition, if for any reason a document cannot be added, a placeholder with the same name as the document will be added instead.

Select Documents from the Computer

Another option is to select the Upload documents or folders button to open the native file picker to select one or more documents to insert into the index:

mceclip27.png

Copy a Document from the Workspace

If an existing NetDocuments document needs to be added to the Set, select the Copy a Document from the Workspace button. A dialog box will appear showing all the containers and documents in the current workspace:

mceclip28.png

You can navigate through the workspace to identify the document that will be copied into the Set:

mceclip29.png

Select a document and a copy of the selected document will be inserted into the end of the index and the Copy a Document dialog box will close.

Additional Aspects of Adding Documents

Documents that are added to the index appear as blue text links:

mceclip30.png

Selecting a document name opens the document in another browser tab:

mceclip31.png

Any type of file can be added to a Set (except certain known file types that are not allowed to be added at all to NetDocuments, like .exe files, see Supported File Types), but certain types of files cannot be converted to PDF and will not be included in any PDF binders that are generated.

Do not add documents directly to the Set Folder – either new documents from your computer or existing NetDocuments documents that are moved or copied – if you have a goal of having those documents added to the Set. Any documents added directly to the Set Folder will be ignored by the Set and will not appear in the index.

Back to Top

Take Actions on Elements

Generally, actions can be taken on existing elements by hovering over an element, which will reveal the available actions. Select the ellipses to view additional actions.

mceclip32.png

Convert and Replace Elements

Any type of element that has been added to an index can be converted to another type of element. For example, a placeholder can be converted to a document or header, a header into a document, etc. Hover over the element, select the ellipses that appears, and then select the appropriate option:

  • Convert to Placeholder
  • Convert to Header
  • Set Document

mceclip33.png

This action can also be taken on multiple items by selecting the appropriate action from above the index:

mceclip34.png

If a document is converted to another type of element, the existing document will be deleted (unless you lack VESA rights to the existing document).

In addition, by dragging a document to an existing element, the existing element will be replaced with a new document. If a document is dragged onto an existing document, the existing document will be deleted (unless you lack VESA rights to the existing document).

mceclip35.png

A document can also be replaced by a new document by selecting Replace Document from the ellipses menu, with the existing document deleted:

mceclip36.png

The Replace Document dialog box appears to allow you to select a document:

mceclip37.png

If an existing document is replaced with a new document, the existing document will be deleted (unless you lack VESA rights to the existing document).

Back to Top

Duplicate Elements

Any element can be duplicated by using the Duplicate option:

mceclip38.png

If a parent element (like a header) is duplicated, all its child elements will be duplicated as well. (Multiple unrelated elements cannot be duplicated at one time. Only one element can be selected at a time to be duplicated.) When a document is duplicated, a duplicate document will be added to the Set folder. Duplicate elements are given the same names as their original elements.

Modify Existing Elements

In addition to the other actions discussed above, every type of element can be modified in the following ways, either individually or for multiple-selected elements:

  • Indent/outdent – This will affect what level an element is located in the hierarchy and what numbering scheme will be applied.
    • There are two ways to indent or outdent elements. First, select the element and select the Indent or Outdent action from the ellipses menu above the index.

mceclip39.png

Alternatively, drag (nudge) the element(s) to the left or right (if possible).

An element cannot be indented more than one space further than its parent element so that it will always remain a direct child of its parent. It cannot be made a “grandchild” element without an intervening parent element.

  • Move up and down (manually reorder) – This will affect the number that has been given to elements, both the ones moved and ones that were reordered by the move.
    • Moving up or down can be done by dragging one or more elements.
  • Rename – Select the pencil icon after hovering over an element and the name of the element will turn into a field where the name can be edited.  Press Enter or select the checkmark icon to apply the new name.

mceclip40.png

  • Turn autonumbering on and off – For individual elements, it is possible to remove any numbering from being applied.

mceclip41.png

  • Delete – Any element can be deleted by selecting its garbage-can icon (or multiple items using the multi-select Delete option):
    mceclip42.png
    • You will always be asked to confirm the deletion:

mceclip43.png

If multiple elements are selected to be deleted (using the delete action available from above the index), the confirmation will include the number of elements selected:
mceclip44.png

Deleting a document through the index will delete the corresponding document from the Set folder (unless you lack VESA rights to the corresponding document).

Most actions taken on a parent element will apply to its child elements, like deleting, moving, and indent/outdent. For example, indenting a header will indent the child documents inside it.

Back to Top

Update a Set’s Properties

There are several ways in which the Set as a whole can be changed:

Status of a Set

A Set can have one of three statuses:

  • In Progress (the default status for all new Sets)
  • Final
  • Inactive

The status of every Set in a workspace can be accessed from the Sets tab

mceclip45.png

For an individual Set, its status is shown in the top right in view and edit modes:

mceclip46.png

A Set’s status can be changed only from edit mode. If a Set is given Final status, then the Set’s index cannot be edited unless the Set’s status is changed back to In Progress or Inactive. Selecting the Edit button in a Set with a Final status applied shows the following dialog box:  

mceclip47.png

Also, a Set cannot be placed into Final status if it contains any placeholders. This ensures that the Set is truly final and keeps you from inadvertently failing to include missing documents. You will be warned accordingly:

mceclip48.png

Rename a Set

A Set can be renamed (even a final Set), but the new name must be unique among all the Sets in the same workspace, to avoid confusion. Renaming a Set will also rename the Set’s folder.

Delete a Set

Deleting a Set will delete the Set, the index, the Set folder and all its contents, including Set documents and binders. This action cannot be undone. The deleted documents will be sent to the recycling bin in NetDocuments, not permanently deleted, and therefore they can be recovered. But the Set index itself cannot be recovered after it has been deleted.

Back to Top

Generate, Access and Manage Binders

All the documents in the Set can be combined into a single, hyperlinked PDF file called a binder. The binder’s contents are organized in the same way the content appears in the index, and the PDF file will include a table of contents (also known as “bookmarks”) with a hyperlink to each document, and it has the same numbering scheme and hierarchy as the index.

mceclip49.png

Generate Binders

Before the binder’s status is changed to Final, you can generate a binder based on the content of the Set at the time the binder is generated. (The binders are considered part of the Set, which is why they cannot be generated after the Set is marked as Final.) Multiple binders can be created for the same Set.  Each binder is saved as a separate document. Generated binders will be stored in a Binders subfolder in the Set folder.

When in edit mode, select Generate Binder and the following form appears:

mceclip50.png

If there are any placeholders in the Set at the time the binder is generated, you will receive a warning to that effect:

mceclip51.png

That way you know that the binder itself does not contain the final contents of the Set.

You will have several options when generating the binder:

  • Cover Page – If the first element of the Set is a document that has autonumbering disabled and contains no child elements, then you will be offered the option of treating that document as the Cover Page of the binder, in which case the Cover Page document will appear as the first item in the PDF file, before the Index Page:

mceclip52.png

If this option is not checked, then the document that is the first element of the Set will be included in the binder after the Index Page, like every other document in the index. If there is no document that satisfies the Cover Page requirements described above, then you will be told that there is no Cover Page and how a Cover Page can be added to the binder:

mceclip53.png

  • Name – A name must be given to each binder. By default, the binder is given the same name as the Set, with a time date stamp added to the end. You can modify the default binder name before generating the binder.

mceclip54.png

  • Index Page – You have the option to include an Index Page, which will appear after the Cover Page (if any) and before the contents of the index. The Index Page mimics the structure of the index (excluding the Cover Page document). You can also choose to give the Index Page a unique title, but it defaults to Index Page:

mceclip55.png

  • Comment – You can optionally add a comment for the binder. The comment allows any user to distinguish between different binders generated for the same Set.

After completing the form and selecting Generate, the process of collecting the documents and generating the binder will commence. How long it takes to generate a binder is a function of the number of documents, the size of the documents and how many documents need to be converted to PDF. You will be presented with the status of each document being added to the binder:

mceclip56.png

At the end of the process, a confirmation dialog will appear showing the newly generated binder and any previously generated binders:

mceclip57.png

For every placeholder that was in the index, the generated binder will include a page that contains the word Placeholder.

The binders that have been generated for a Set will also be stored in the Binders subfolder in that Set’s folder. Each binder that is generated will be a separate document.

Share Binders

If any binders have been generated for a Set, the binder icon (mceclip58.png) will appear for that Set in the list of Sets and in both view and edit modes for that Set:

mceclip59.png

mceclip60.png

Select the binder icon and a dialog will be displayed that lists all the binders that have been generated for that Set:

mceclip61.png

This dialog box includes the name given to each binder, the user who created it, the date it was created and comment (if any). To share a binder, which is simply a PDF file stored in the Binders folder for that Set in the workspace, click on the name of the binder to open it in a new browser tab. From there, use any of the existing NetDocuments action to share the binder, including:

  • Deliver a secured link to a third party
  • Email a link to a colleague who has access rights to it
  • Copy it into a CollabSpace
  • Email a copy
  • Download

mceclip62.png

Manage Binders

When accessing the Set in edit mode, two more options are available for each Set in the Binders dialog box: you may (1) edit the comment associated with a binder or (2) delete an individual binder:

mceclip63.png

Then you will be asked to confirm the deletion:

mceclip64.png

You will need sufficient rights to each binder document to take these actions.

Back to Top

Other SetBuilder Features

There are several other unique SetBuilder features.

Cloning an Existing Set

You can get a running start on the creation of a new Set by cloning an existing Set. Cloning results in greater efficiency and consistency.  When accessing the Set in either view or edit modes, select Clone, and the Clone Set dialog box appears:

mceclip65.png

Give the cloned Set a unique name and choose whether to (a) replace the documents from the original Set with placeholders (which is the default) or (b) copy documents from the original Set into the cloned set.  After selecting Clone, the new Set will be created, and the new Set will be shown in edit mode.

The clone will be created in the same workspace as the original Set, and a new Set Folder will be created to hold the documents of the new Set.

Access Individual Set Documents

Whether in view or edit mode, you can access any document in the Set by simply clicking on a document’s name. The document will be shown in a new browser tab. From there you can take any action on the document that is available generally to documents in NetDocuments: preview, download, edit, share, etc.

Access the Set Folder

Whether in view or edit mode, you can access the entire Set folder and all its content by selecting Open Set Folder. The Set Folder and its contents will be displayed in a new browser tab:

mceclip66.png

The Set Folder also contains a Binders subfolder where any generated binders are stored.

Any headers or placeholders that have been added only exist virtually in the Set’s index. There is no subfolder corresponding to each Set header and no true document corresponding to each placeholder. The Set folder contains only the documents listed in the index.

If other documents are added to the Set folder, they will not appear in the Set index and are not considered part of the Set.

Audit Trail

SetBuilder maintains a detailed audit trail of every change that is made to a Set through the SetBuilder application. Select the clock icon in view and edit modes:

mceclip67.png

To reveal the audit trail:

mceclip68.png

Note that if any changes are made to the contents of a Set outside of the SetBuilder application (that means, not inside the Sets tab), such as renaming a Set document, that change will not be reflected in the audit trail.

Next to the clock icon, it shows who last updated the Set (if no one is currently editing the set) or the name of the user currently editing the Set:

mceclip69.png

If one user is editing the Set, other users may view the edits as they happen in real-time by accessing the Set in view mode.

Back to Top

Known Issues

Conflicting Changes to Underlying Set Components

A Set is composed of the index that has been created and the “components” of the Set, as discussed above, including:

  • the Set Folder where the Set documents are stored (which will have the same name as the Set),
  • the Set documents themselves,
  • the binders that are generated, and
  • the “Binders” subfolder where those binders are stored.

All the Set Folders for a workspace are stored in a Sets folder that is a direct child of the workspace.

You may have edit rights (VE) or greater rights to certain Set components, allowing you to take actions directly on those components, including renaming and deleting components. (You are encouraged to edit Set documents directly, such as through ndOffice.) Through the SetBuilder application (inside the Sets tab), you can also rename and delete Set documents or rename and delete the Set itself.

It is strongly recommended that you rename and delete Set documents and the Set folder itself only through the SetBuilder application. Taking these actions directly on Set components may result in conflicts with the Set index. For example, if a document is deleted directly from the Set Folder, it will still be listed in the index.

Access Rights to Set Components

Your ability to edit the Set index may be impacted if you lack sufficient access rights to Set components.  For example, if you lack edit rights to a Set document, attempting to rename that document through SetBuilder will fail.

Creating New Sets

You must have VES rights to the Sets folder to create a new Set. At the time the Sets tab is first enabled in a workspace, all internal users and groups with access to that workspace will be given VES rights to the Sets folder. But groups added to the workspace later may not have VES rights to the Sets folder and therefore will not be able to create new Sets. In addition, if a user or group’s access rights to the Sets folder are reduced later, they will not be able to create new Sets. In that case, an error message will be shown when trying to create a new Set in the workspace:

mceclip70.png

Back to Top

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk