Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
USER GUIDE
Information in this document is subject to change without notice. Companies, names and data used in examples are fictitious. Copyright 2000 - 2009 by QA Software. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express permission of QA Software. Microsoft Windows, Internet Explorer and Microsoft Excel are registered trademarks of Microsoft Corporation. Although TeamBinder has undergone extensive testing, QA Software makes no warranty or representation, either express or implied, with respect to this software or documentation, its quality, performance, merchantability, or fitness for purpose. As a result this software and documentation are licensed as is, and you, the licensee are assuming the entire risk as to its quality and performance. In no event will QA Software be liable for direct, indirect, special, incidental or consequential damages arising out of the use or inability to use the software or documentation. Please send your comments to: QA Software 21 Bedford Street North Melbourne, VIC, 3051 Australia For technical support: Australia Phone: 03 8379 0000 Fax: 03 9326 6544 International Phone: +61 3 8379 0000 Fax: +61 3 9326 6544 Email: support@qa-software.com Internet: http://www.qa-software.com
Page 2
Table of Contents
Chapter 3 - Mail........................................................................... 27
3.1 Getting Started .................................................................................................. 29
3.1.01 Overview................................................................................................................ 29 3.1.02 Setup Check List ................................................................................................... 29 3.1.03 Configuration Tables ............................................................................................. 30 3.1.04 Binders and Sections ............................................................................................ 31 3.1.05 Security Issues ...................................................................................................... 32 3.1.06 Workflow................................................................................................................ 32 3.1.07 Custom Mail Forms and Templates ...................................................................... 34 3.1.08 Custom Mail Footers ............................................................................................. 34 3.1.09 Company Logos .................................................................................................... 34 3.1.10 Fax-In Configuration.............................................................................................. 35 3.1.11 Email-In Configuration........................................................................................... 36 3.1.12 Customising the Mail Registers............................................................................. 37
Page 3
Table of Contents
Page 4
Table of Contents
Page 5
Table of Contents
Page 6
Table of Contents
Page 7
Table of Contents
Page 8
Table of Contents
Page 9
Chapter 1 Introduction
1.1 About TeamBinder
1.1.01 Introducing TeamBinder 1.1.02 Business Process 1.1.03 Benefits of using TeamBinder
Page 11
With all your project documents and communications managed and maintained on a secure, open platform, project participants are able to focus on the successful delivery of the project on time and within budget.
Page 12
A centralised register of all controlled documents such as plans and drawings which enables:
All project participants to access the latest information from any location with a web browser and an internet connection. A central location to find documents, and capture comments and inputs from stakeholders. Ability to view plans and drawings without the requirement for any specialist software. Automating the uploading and distribution of documents against a pre-defined set of business rules. Security controlled access matrix for viewing and downloading documents. The distribution of documents via transmittal to subcontractors if required. Reductions in plan printing and courier costs to distribute documents. Simplified handover of project documents at completion since all documents are already stored electronically and fully indexed and can simply be archived to CD.
Page 13
Chapter 1 Getting Started Number of documents at each phase in their project life cycle. Number of documents at each approval status which can be further analysed by Discipline. Numbers of tender packages at each phase in their life cycle.
To launch TeamBinder
1. Open Internet Explorer. 2. In the Address Line type www.TeamBinder.com and click Go. 3. Once the TeamBinder homepage has loaded, click the Login menu option at the top left of the screen. 4. At the login window, type your Username, your Company ID, and Password and click Logon. Tip: Tick the box Remember Login User ID & Company at the login window so that on the next login you only need to enter your password. 5. If you have access to more than one project, click on the Project that you wish to login to. The TeamBinder Dashboard will now load. [Refer Section 2.1.01] Notes: (a) For regular TeamBinder users, it is suggested that TeamBinder be made your home page in Internet Explorer. Click on the Tools menu in Internet Explorer. Select Internet Options. On the General tab, type www.TeamBinder.com in the Address field.
(b) The first time TeamBinder is accessed from a workstation, scripts required to run the system are downloaded to the PC. Hence the first login can take a few minutes depending on the speed of your internet connection. (c) If you forget your password, click on the Forgot your password? link at the Login page and a new temporary password will be sent to you by email. (d) If you have any problems accessing TeamBinder, refer [Section 13.3.03] on Internet Explorer Security Settings.
Page 14
Chapter 1 Getting Started (e) Customers self hosting TeamBinder [Section 13.2.01] will be using a different URL to the address line at Step 2 above. Contact your system administrator to get the correct address.
If you are a review coordinator (responsible for the review process for one or more disciplines of documents) you will need to know: How to activate a review workflow How to release a document [Refer Section 6.2.03] [Refer Section 6.2.07]
If you are a project secretary you will need to know: How to process un-registered mail [Refer Section 3.6.01]
If you are a project administrator for TeamBinder you will need to refer to the Getting Started sections of the TeamBinder documentation for each Module to see how to configure it for use. You will also need to understand how to edit the Project Details [Section 12.1.03], populate the Address Book [Section 12.2.01], setup the system Security [Section 12.4.01], and Create Users [Section 12.3.01]. The main TeamBinder modules are: Mail Documents Transmittals Workflow Packages Tasks Defects Reports Published Reports Administration [Refer Chapter 3] [Refer Chapter 4] [Refer Chapter 5] [Refer Chapter 6] [Refer Chapter 7] [Refer Chapter 8] [Refer Chapter 9] [Refer Chapter 10] [Refer Chapter 11] [Refer Chapter 12]
Page 15
Chapter 2 - Dashboard
2.1 Introduction
2.1.01 Overview
Page 17
Chapter 2 Dashboard
2.1 Introduction
2.1.01 Overview
The Dashboard is the starting point after login to TeamBinder. There are six areas in the Dashboard. Dashboard Area Top menu Left menu Management Summary Explanation In the orange band at the top of the Dashboard are the top menu options for Administration and Global Search. The left menu is used to access the TeamBinder modules. Use the More button to see menus for modules you dont have access to. The Management Summary displays key project statistics by module with links to relevant data. It also includes a project drop down list allowing users to quickly move between multiple projects they have access to. This area can be used to display a static project image or stream feed from one or more web cameras plus summary information about the project. An on line weather channel.
The Dashboard is the starting point for all actions in TeamBinder and the left menu provides quick access to common tasks such as Create a new mail or Generate a Transmittal.
Page 18
Chapter 2 Dashboard
Explanation Documents uploaded requiring you to activate the workflow. Documents under review by all review teams within the Discipline(s) that you as Review Coordinator are responsible for. Incoming Transmittals Transmittals received, requiring a response which is still outstanding.
Transmittals Outstanding
Click on any of the above statistics to go directly to the relevant module / information. Note that the default tab of the Management Summary can be changed via User Preferences [see Section 3.2.02].
When viewing the statistics relating to either of the above options, choose between: Personal Mail (Mail that you have sent or received) Department Mail (Mail that users in your department have sent or received) Company Mail (Mail that users in your company have sent or received)
Note that access to Department and Company Mail requires security access [see Section 3.1.05].
Page 19
Chapter 2 Dashboard
Explanation Mail items sent that have not been responded to and for which the response is overdue (as defined via the Response Required by and Responded Dates). Mail items sent that currently have a Status = Outstanding. Additional Status value statistics can be displayed if required [see User Preferences Mail Status 3.2.07] Mail incoming from outside of TeamBinder Incoming Faxes not yet processed [see Section 3.6.03]. Incoming Emails not yet processed [see Section 3.6.04]. Incoming Emails not yet processed but already auto mapped. Incoming Emails not yet processed and that require mapping.
Unregistered Mail Faxes awaiting processing Emails awaiting processing (All) Emails awaiting processing (Mapped) Emails awaiting processing (Unmapped)
Click on any of the above statistics to go directly to the mailbox with the relevant mails displayed. Note: If you have access to multiple projects, the numbers of new mails, outstanding mails, and mails for review for each project are also listed both at the Project Selection window after login, and against each project in the Project drop down list in the top left corner of the Management Summary.
Note that the total number of mail items used on the percentage calculation is either the total of all Personal mail, all Department mail, or all Company mail depending on which of these three options is selected.
Page 20
Chapter 2 Dashboard
Awaiting Release
Un-Restrained
Workflow Statistics by Discipline: Click on one of the Review Status values to see the total number of documents in each discipline at the selected review status together with the % each discipline forms of the total of all documents at that status.
Page 21
Chapter 2 Dashboard The Workflow Management Summary also displays: Statistic Documents awaiting your review Documents awaiting your review Overdue Documents awaiting release Explanation Use this link to run the Document Review Wizard for documents you are required to review. Shows the number of documents for which your review is now overdue. Use this link to run the Document Release Wizard for documents for which you are the review coordinator and are required to review and release. Shows the Review Coordinator the number of documents for which the review is complete but the release is overdue. This option is visible only by Project Administrators and Review Coordinators and shows the total number of documents for review within the discipline(s) they are responsible for and for which the review is overdue. This option is visible only by Project Administrators and shows the total number of documents for all disciplines for which the review is complete but the release is overdue. Shows the logged in user the total number of documents they have uploaded for which the reviews is overdue. Shows the logged in user the total number of documents they have uploaded for which the release is overdue.
Total number of transmittals sent by your company. Number of Transmittals sent which have not been acknowledged as received by the recipient. Number of Transmittals sent, requiring a response which is still outstanding [see Section 5.2.02]. Number of Transmittals sent, requiring a response for which the response is now overdue. Total number of transmittals received by your company. Number of Transmittals received, requiring a response which is still outstanding. Number of Transmittals received, requiring a response for which the response is now overdue.
Page 22
Chapter 2 Dashboard
Explanation
Number of unique recipients to whom your company has sent transmittals. Number of recipients to whom you have transmitted documents and for which there are now pending transmittals [see Section 5.2.03]. Number of documents your company has transmitted (sent). Average response time in days in regard to transmittals you have sent.
Sent Transmittal Statistics No. of transmitted documents Average response time (days)
Click any of the links above to view a list of only the relevant Sent or Received transmittals.
Total number of packages. Total number of private tender packages. Total number of public tender packages. Total number of standard packages. Tender packages created but not released for tender or awarded. Tender packages currently released for tender. Tender packages closed for bidding but not yet awarded. Tender packages awarded but not yet completed. Tender packages completed.
Click any of the links above to view the Package Register displaying only the relevant packages.
Page 23
Chapter 2 Dashboard
Statistic Tasks created by me All tasks created by me Overdue tasks Tasks to be completed today Tasks with High priority Tasks with status New Tasks with status In Progress Click any of the links above to view the Task Register displaying only the relevant tasks either created by you or allocated to you by others. Note: Additional Tasks Statistics can be added to the above lists based on the Task Status via User Preferences Task Status [see Section 8.1.02].
Page 24
Chapter 2 Dashboard
2.4.02 Weather
The weather channel display on the Dashboard is a live update of the weather conditions at the project location (or nearest weather station). The weather station displayed is defined via the project details by the project administrator.
Page 25
Chapter 3 - Mail
3.1 Getting Started
3.1.01 3.1.02 3.1.03 3.1.04 3.1.05 3.1.06 3.1.07 3.1.08 3.1.09 3.1.10 3.1.11 3.1.12 Overview Setup Checklist Configuration Tables Binders and Sections Security Issues Workflow Custom Mail Forms and Templates Custom Mail Footers Company Logos Fax-In Configuration Email-In Configuration Customising the Mail Registers
Page 27
3.11 Reports
3.11.01 Overview 3.11.02 Available Reports Listing
Page 28
Chapter 3 Mail
Page 29
Chapter 3 Mail
Areas
The Area a mail item relates to can be selected from a drop down list when creating outgoing mail and can be used in search filters when finding mail.
Disciplines
The Discipline a mail item relates to can be selected from a drop down list when creating outgoing mail and can be used in search filters when finding mail. Note that the Discipline is also a key document attribute.
Locations
The Location a mail item relates to can be selected from a drop down list when creating outgoing mail and can be used in search filters when finding mail.
Mandatory Fields
The Mandatory Fields list can be used to control which fields are mandatory for user entry in each of the mail and document modules. Mandatory field settings affect all mail forms and in the document module affect the Document Register Details screen plus the Bulk Upload Wizard.
Page 30
Chapter 3 Mail
Notes: (a) Creation, Maintenance and Access to Binders and Sections is restricted by User Access options [see 3.1.05]. (b) It is possible to copy a complete branch of the Binder/Section tree structure to either another Binder or Section Node in the tree. Simply select the top node in the branch to be copied and right click and select Copy. Then navigate to the node to copy to, select the Binder or Section by clicking on it and right click and select Paste. You will be prompted to enter the ID of the top node in new branch. (c) There is no limit to the number of levels in the Binder/Section tree structure. (d) See also Filing Mail [Section 3.9.01] (e) See also Binders and Sections View [Section 3.8.05]
Page 31
Chapter 3 Mail
Note that TeamBinder is designed around a fundamental principal that regardless of security settings, a user from one company can never see a mail between two or more other companies in which no-one from the users company was on the distribution. The mail security group a user is assigned to controls the types of mail they can create, view, edit, delete, print etc. [Refer Section 12.4.02] Whether a user can view only Personal Mail (mail in which the user is any of the TO, CC, BCC or FROM values on the distribution), Department Mail (mail in which a user of the same department is any of the TO, CC, BCC or FROM values on the distribution), or Company Mail (mail in which anyone from the users company is any of the TO, CC, BCC or FROM values) is managed as follows: 1. From the Administration menu, select Configure User Access to Modules from the Security group of options. 2. From the Company drop down list, select the company which contains the user that you wish to define the mail access for. 3. Next to that user, under the Std Mail column, select either None, Personal, Department, or Company mail. At the same screen, setup the user access to Un-registered mail and Binders and Sections: 4. Under Un-reg Mail, set the Users access level to the Un-registered Mailbox for their company. The options are None (no access), Personal (access to process mails sent to the user only), Department (access to process mails sent to any user in the same department), or Company Access (access to process mails sent to any user in the same company). 5. Under Binders and Sections, set the Users access level for Binders and Sections. The options are None, View and Full (giving full access to create new Binders and Sections). Notes: (a) Project Administrators can modify the user access for any user on a project. (b) Company Administrators can modify the user access for only users within their company and cannot give a user a level of access higher than their own. (c) The above settings can also be managed via the Address Book.
3.1.06 Workflow
Managing the workflow for each type of mail being used on a TeamBinder project is a great method of ensuring each user has limited options to choose from when replying to or forwarding mail. The workflow options also include the ability to define on a per mail type basis the default response period which is used to auto calculate the response required by date when generating mail. Finally the workflow options enable the definition of mandatory recipients as either TO or CC values on a per mail type basis.
Page 32
Chapter 3 Mail
Notes: (a) Only the Project Administrator can maintain the mail workflow options for Response periods and Forward/Reply mail types. (b) Only the Project Administrator can define Mandatory Recipients on a Project basis. (c) Only the Project or Company Administrator can define Mandatory Recipients on a Company basis. (d) Any user can define Mandatory Recipients on a Personal basis. (e) Users cannot remove mandatory recipients defined by the Project or Company Administrator when creating mail unless the recipient(s) are currently unable to receive the particular mail type or the sender is restricted from sending mails to the particular recipient.
Page 33
Chapter 3 Mail
Chapter 3 Mail 5. Click the OK button and your logo file will now be uploaded to the server.
Logo Settings
To fine tune how your logo appears on mail: 6. Click on the Customise button. 7. Edit the pixel settings which control the logo size (height and width). 8. Choose the required position for the logo from Top Right, Top Middle or Top Left. 9. Use the preview area button to see how you logo will appear on mail. Note that the preview will show you the position of the logo on a default mail template, not your custom mail template if one is in use. Notes: (a) Uploading a company logo to be used on correspondence can only be done by the Project Administrator, users within the Project Administrators company, and the Company Administrator for their own company. (b) The logo file formats supported are: GIF JPEG / JPG PNG BMP
(c) Use the Remove button to remove an uploaded logo. This is required if you want to replace your company logo with a new file.
Page 35
Chapter 3 Mail 5. 6. In the Fax Number box you will see the fax number, which has been assigned to you. This can contain a combination of numbers, -, (, ) and spaces. E.g. (03) 9326-6544. Click OK.
Notes: (a) Configuring the company (or department) based fax number can only be done by QA Software. (b) To view the Departmental Fax number, edit the Department details in the Address Book. (c) It is possible to have multiple fax numbers configured for a single company within a single project at either a company or department level. (d) All senders of faxes that are to be received by this method must be added to the project address book.
Page 36
Chapter 3 Mail
Notes:
a) Not all columns can have alternative names. b) To open Custom View 1 or Custom View 2 as the default view when you view the mail register, select the required View at the above screen and tick the Open mail box with this view by default box.
Notes:
(a) User Preferences can also be defined by the Project Administrator for one or more users at the same time [see Section 12.2.05]. (b) User Preferences defined on one project can be applied to other projects the user has access to [see Section 3.2.10].
Page 37
Chapter 3 Mail
3.2.02 General
There are number of general user preferences users can control in relation to the mail module of TeamBinder. These are accessed via the General tab of the User Preferences screen [see Section 3.2.02]: (a) Max number of records to display in grids: This setting controls the default number of records to display when viewing mail in the Sent Items or Inbox. (b) Check spelling before saving mail: Use this to always have TeamBinder run a spell check when saving mail. (c) Add Signatures to outgoing mails: Use this option to setup a default signature to be included on the mail form when composing new mail. If the signature is to be excluded when replying and forwarding, tick the box Dont add signature to Replies and Forwards. The Signature text itself is entered in the box provided. To define individual signatures on a per mail type basis, click the Advanced button. Select the Mail type in the upper half of the Add/Edit Signature window and type the signature required in the Signature box. To disable a signature defined in this way temporarily, un-tick the Enable Signature box. (d) Save Auto-recover info every X minutes: Use this option to control how frequently TeamBinder should save a mail you are composing for auto-recovery purposes should you lose your internet connection or time-out of TeamBinder. Users are prompted on login or access to a mail box of any mail items that have been auto recovered and can open the item to continue work from the list provided. (e) Display preview pane in mail register: This option controls whether a preview pane displaying the mail content is shown when accessing the mail registers. (f) Default Dashboard page: Use this option to control which tab should be displayed by default when using the Management Summary. (g) Default mark-up colour: This option is used to set the default colour to be used when redlining documents.
Page 38
Chapter 3 Mail 5. Tick the box labelled Send me a sample notification to be sent a sample notification to your email address. 6. Click Apply. Notes: (a) The Auto responder also applies to the Workflow module of TeamBinder and will send the Review Coordinator an auto-response if you are sent Documents for Review during this period [see Section 6.1.08] (b) The Auto responder message sent is sent only once to each recipient that sends you correspondence while it is active.
To access the Mail options tab: 1. From within User Preferences [see Section 3.2.01], select the Mail Options tab.
Read Receipts
2. To always request a read receipt when sending mail, tick the box under Read receipts Request read receipts. 3. For the sending of read receipts in response to mail you receive, choose between:
Page 39
Chapter 3 Mail Never send You will never be prompted to, nor will the system ever send any read receipts, regardless if they are requested by the originator of the mail or not. The exception to this is if you change the status of a mail and in this case if the Sender requested a read receipt you will be forced to send one to proceed. Notify me when requested The system will prompt you to send a read receipt when the originator of the mail requests one. Always send The system will automatically send a read receipt when the originator of the mail requests one. This receipt will be sent as soon as you open the mail.
Page 40
Chapter 3 Mail 8. Under the Include Internal Notes heading, choose between the following options to include Internal Notes on print outs which will apply when you click print to print a mail you have sent or received: Never Print Prompt to Print Always Print
Page 41
Chapter 3 Mail
Notes: (a) The mail status codes in use on a project are configurable by the Project Administrator [see Section 3.1.03].
Page 42
Chapter 3 Mail
3.2.08 Notifications
Notifications are the means by which TeamBinder informs users of events that are related to them. For users who are logged into TeamBinder continuously, notifications may not be required and the sending of notifications can be switched off via User Preferences. It is also possible to control the method by which notifications are sent to you. From within User Preferences [see Section 3.2.01], select the Notifications tab.
Note that it is possible to control the receipt of notifications at an individual notification level by using the Select Notifications link against the relevant module. It is not possible to switch off receiving notifications for: Transmittals [see Section 5.1.06] Packages [see Section 7.1.04]
Page 43
Chapter 3 Mail
Page 44
Chapter 3 Mail
Page 45
Chapter 3 Mail 6. 7. Click on the Name of a person to CC to the item to if required (they will move to the CC box). Click OK when done. Tip: If the person you need to send the mail is not listed in the Address Book, it is possible for users belonging to company of Project Administration to add new contacts on the fly. See also [Section 3.3.05]. 8. 9. Type the Subject of the mail item. Type the content of the mail item in the Details box.
10. Type (or select using the date picker) a Respond By date if you require a response. 11. Tick Request Read Receipt if required. 12. To attach an external file to your mail item, click the Browse button at the bottom of the mail form, select an external file, and click Open. See also [Section 3.3.07] for details on how to attach information stored within TeamBinder. 13. Enter the number of pages in the field labelled No. Pages: 14. To send the mail immediately, click the Send Mail Now button. The mail will automatically be sent and placed into your Sent items mail box. 15. Alternatively, to save the mail to the Drafts/Outbox, click the Close button and click Yes when prompted. You will then be shown the Drafts/Outbox which stores mail that is saved but not sent. Notes: (a) See Sending Mail [Section 3.3.03] for more details on what happens during and after the sending process. Note that the way the mail is sent defaults to the settings for the contact in the address book but can be changed on a per mail basis. (b) There are a number of ways of selecting the distribution for a new mail. Use the Autocomplete feature to quickly populate the distribution by typing the first few letters of each persons name. Use the Favorites arrow button to the right of the To box at step 4 above to select the distribution from your list of favorite contacts [see Section 12.2.06]. Other alternatives for selecting the distribution for your mail (steps 3 to 7 above) are Speed Addressing [see Section 3.3.04], and Contact Groups [see Section 3.3.06]. (c) It is possible for the Project/Company Administrator and/or individual users to define default and mandatory recipients as either the TO or CC values for specific mail types. Hence it possible that there will be names on the distribution that you cannot remove. [See Section 3.1.06]. (d) At the Addressee Details screen at step 4 above, click on the column headers in the left grid to re-sort the address book as required. (e) If you cannot find the contact you are looking, you may be a restricted user with access to only a limited project address book [see Section 12.2.05]. (f) If you require a contact to be added to the address book, contact the Project Administrator or your company administrator if the contact is within your own company. Note that users belonging to the company of the Project Administrator can create Contacts themselves [see Section 12.2.05]. (g) TeamBinder supports the use of Blind Copies (BCC) on a per project basis. If enabled [see Section 12.1.03], contacts can be made as BCC values in the distribution of the mail by selecting them at step 5 by ticking the box next to them and then using the mover arrow buttons next to the BCC box.
Page 46
Chapter 3 Mail (h) At Step 9, use the Rich Text and Plain Text options to switch from plain text (i.e. without formatting) to rich text (i.e. with formatting), and vice versa, when creating mails. The default setting is controlled via User Preferences [see Section 3.2.06]. (i) After completing the details of the mail, select a Discipline, Area, and Location that the mail item relates if these fields are available, to assist in future searches (these fields are normally on the standard TeamBinder mail templates). (j) To use a Custom Footer with your mail, scroll to the bottom of the mail form to the section labelled Footer and select the Custom Footer that you wish to use. If a custom footer is selected the text can be edited on a per mail basis. See also Defining custom mail footers [Section 3.1.08]. (k) Use the Action note and / or Response fields to make any internal notes about the mail item being created. These fields are not visible to the recipient(s) of the mail item. (l) It is possible to Print Preview an item of mail before sending using the print preview button in the toolbar. The mail will be displayed with a DRAFT Header as it has not been sent. (m) If you are prompted or forced to file your mail in a Binder and Section before sending, see [Section 3.9.01] for more details on how to do this. (n) Default response periods per mail type (which will auto calculate the respond by date at step 10 above) can be defined via the mail workflow [see Section 3.1.06]. (o) Your default setting for requesting read receipts can be set via User Preferences [see Section 3.2.05]. (p) If you would like your work to be auto saved every X minutes, which means that should you lose your internet connection while typing a mail you will minimise the lose of data, [see Section 3.2.02 on auto recovery] (q) It is possible to automatically attach a PDF or HTML copy of a mail to the mail sent from TeamBinder by ticking the box for this at the bottom of the mail form. [See also User Preferences Section 3.2.06]. (r) It is possible to use pre-defined signatures for use on outgoing mail either on a general or per mail type basis [see Section 3.2.02].
Send Methods
There are four ways that mail can be delivered (sent) using TeamBinder: TB This column is always ticked. This column indicates that the mail item will be delivered to the recipients TeamBinder Inbox. As this column cannot be un-ticked, every mail sent from TeamBinder will be delivered to the recipients TeamBinder Inbox regardless of whether they are a user of TeamBinder, in addition to any other options you select.
Email By ticking the box in this column, TeamBinder will send this recipient the mail via email. They will receive the mail in their normal email inbox, as well as their TeamBinder inbox. When ticking this box, the system will check that the user has an email address. This option is the default when sending mail to External Contacts [see Section 12.2.07].
Page 47
Chapter 3 Mail FAX By ticking the box in this column, the mail will be sent out using TeamBinders FaxOut Integrated fax service. This is an optional service for which charges apply and is enabled on a per company per project basis [see Section 3.10.03]. When ticking this box, the system will check that the contact has a valid fax number and that Fax-Out is enabled for your company. By ticking the box in this column, TeamBinder will flag that this recipient is to be sent the mail via hardcopy. Upon sending, TeamBinder will automatically load a print preview so that a printout can be generated. This option is often used on site where it is more convenient to hand a copy of a mail to a recipient rather than send by email, fax or TeamBinder.
HC
Notes: (a) When mails are sent within TeamBinder (sent by TB) a notification is sent by email to the TO and CC values notifying them that they have new mail in TeamBinder. The recipient can access the mail from a hyperlink contained in the email notification. (b) TeamBinder captures both the date and time mail is sent. (c) The default send method for each contact is defined via the Address book [see Section 12.2.05]. (d) It is possible to automatically print hardcopies of mail sent by methods other than hardcopy during the send process automatically if required [see Section 3.2.05]. (e) Sent Mail is stored in the Sent Items mailbox. This can be accessed via the Sent Items menu option. (f) The method used to Send each mail item can be viewed by right clicking on a mail and selecting View Sent Methods. (g) The prompt to print Internal Notes on hardcopies can be controlled via Users Preferences [see Section 3.2.05].
Chapter 3 Mail 2. At the Create New Contact window, enter the First and Last Name of the new contact and press Tab. The ID of the new contact will default automatically (but can be changed). 3. If the new contact belongs to an existing company already in the system, simply select the company from the drop down list. Then complete the remaining details on the screen and click OK. 4. If on the other hand the new contact belongs to a new company, click the Add Company button to the right of the company drop down list. 5. Enter a Company ID, Company Name and select the Type and click OK. Notes: (a) Project Administrators can use the Add as User option which they will see at Step 2 above to launch the Create New User Wizard. See also [Section 12.3.03]. (b) When entering new Companies the system will check both the Company ID and Company name to see if they already exist. (c) The New button for adding new contacts on the fly is also available in the Select Address window and works in the same way as above.
3.3.07 Attachments
It is possible to attach any of the following to outgoing mail: External Files TeamBinder Controlled Documents TeamBinder Mail TeamBinder Published Reports
Select the required option from the Attachments options at the bottom of the mail screen. Notes: (a) When attaching information that is stored in TeamBinder you will first be prompted with the relevant filter for that module to enable you to select the information to attach.
Page 49
Chapter 3 Mail (b) It is possible for the Project Administrator to define a maximum file size via the Project Details, above which the user will prompted if they try and attach an external file of greater size. (c) When viewing mails the size of attachments is displayed to the right of the attachment file name.
Page 50
Chapter 3 Mail
Users can be restricted from sending mail directly, thus forcing them to use the review process. This is controlled via mail security group definitions [see Section 12.4.02].
Notes:
(a) While under review the mail cannot be sent by the originator. (b) A review can be cancelled by the originator at any time by opening the mail in their Drafts/Outbox and using the Cancel Review button.
Page 51
Chapter 3 Mail To either return the mail to the originator or forward to another reviewer, click the Review button. If a further reviewer is selected at the Mail for Review window, then on clicking OK (after entering any comments and a further Due by Date) an email notification is sent to the second reviewer and they review in the same way as the first reviewer. If the Originator is selected at the Mail for Review window, then on clicking OK (after making any comments) a notification is sent to the Originator advising that the Review is complete. The originator now sees a link to Mail Returned from Review via the My Tab on the Management Summary. On opening mail returned from review, the originator sees all reviewer comments and makes any changes to the mail require and sends as normal. Note in addition to the normal notification sent to the recipient when sending mail, notifications are sent to the reviewers advising them the mail has been sent.
[See Section 3.8.02 for an explanation of the filtering options available]. The Inbox is then displayed in a register style format. 3. To open an item of mail, simply click on it once. 4. If prompted for a read receipt, action as required. To modify the defaults for how you action read receipts, see [Section 3.2.5]. 5. Attachments are listed at the bottom of the mail item (there is a link to attachments from the top of the mail for easy navigation) and can be downloaded by clicking on them. 6. Click Close when done. Notes: (a) The display of the filter screen by default when accessing the Inbox is controlled via your User Preferences [see Section 3.2.09)]. (b) Incoming mail once opened is automatically marked as read by the system and the date opened is captured. [See also Section 3.5.03]. (c) Mail opened within session changes colour in the mail register for the duration of the session or until you click Refresh. (d) The mail you can view in the Inbox defaults to Personal Mail only but can be changed to view all mail received by your Company [see Section 3.1.05]. (e) It is possible to display a preview pane within the Inbox (and other mail registers) that shows the contents of each mail as you move through the register. This is activated via User Preferences [see Section 3.2.02]. (f) If an incoming mail has been sent to multiple people in your company a + sign will indicate this when viewing the Inbox for all mail sent to your Company as opposed to Personal Mail only. (g) The List of mail in the Inbox defaults to mail received in the last two working days. Use the filter options to change this at Step 2 above or click the Filter button from within the mail register. The default settings can be changed via User Preferences [see Section 3.2.09]. (h) Use the Reply and Forward buttons to respond to an incoming mail [see Section 3.5.04]. (i) The way the mail items are sorted in the Inbox can be changed by clicking on the column headers. For example to sort the mail items by subject, click the Subject column heading. (j) Attachments can be downloaded by clicking on them or viewed directly within TeamBinder using TeamView [see Section 4.2.07]. A paper clip icon is shown against mail items with attachments in the Inbox list. Alternatively use the Attachments Download Wizard [see Section 3.9.08]. (k) It is possible to process any attachments to mails (either sent or received) as Controlled Documents into the Document Register using the Process Attachment(s) as Controlled Document button on the toolbar within the mail details window. This will load the Document Details window window for Document Registration. Note that if there are multiple attachments to the mail (of different file formats), they will all be processed against the same Document Number. If there are multiple attachments of the same file format the user will be prompted with attachment to use. (l) If a mail is linked to other mail, this is highlighted via the links icon and the links can be viewed using the Thread View button [see Section 3.8.04]. or by opening the mail and using the Show Thread View link at the bottom of the mail form. TeamBinder User Guide Page 53
Chapter 3 Mail
(m) To update the status of the mail after reading, using the Status drop down list. You can also batch change the status of multiple mails [see Section 3.9.04]. (n) The priority the sender has applied to the mail you have received, if other than normal, is displayed as a red exclamation mark (for high priority) or a blue down arrow (low priority) against the mail in the Inbox. (o) It is possible to allocate a user defined status automatically to any mail you receive as a CC or BCC value [see Section 3.2.07]. (p) It is possible to file incoming mail into Binder(s) and Section(s) if these are being used on your project [see Section 3.9.01]. (q) It is possible to batch print a number of Incoming mails [see Section 3.9.07]. (r) It is possible to export one or more mails to PDF or HTML format [see Section 3.9.05]
Page 54
Chapter 3 Mail 4. Click the Reply, Reply To All or Forward buttons on the toolbar and if required, select a mail type to use for the Reply, Reply To All or Forward. 5. Proceed as normal for creating outgoing mail [see Section 3.3.02]. 6. Change the Status of the original mail as required after responding to it.
Notes: (a) The contents (and the way the contents are formatted) of the original mail can be included in the body text of the reply or forwarding mail if required [see Section 3.2.06]. (b) The mail types that you can use for Reply and Forward are controlled via the Mail Type Workflow [see Section 3.1.06]. (c) Mails created as Replies or Forwards are automatically linked to the original Mail [see Section 3.9.02]. (d) Use the Management Summary to see a list of mail with responses outstanding or responses overdue [see Section 2.2.01]. (e) Set up TeamBinder to automatically send you a reminder by email every X days for mail with an outstanding response [see Section 3.2.07]. (f) It is possible to have the system auto update the status of mail to a status of your choosing when you reply to it via User Preferences Mail Options [see Section 3.2.05]. (g) Run Report 005 - Cross Company Mail Status Report to see the both the status of a mail item within your sent items mailbox, and the status of the same mail item in the Inbox of people to whom the mail was sent. [Refer Section 3.11.01]. (h) Run Report 010 - Sent Items Report with Responses to see a list of both the responses and people who have not responded for mail you have sent. [Refer Section 3.11.01].
Page 55
Chapter 3 Mail
Note that no user can: a) Access unregistered mail that was not sent to their company b) Access unregistered mail that was sent to a Department within their company to which the user does not belong.
Page 56
Chapter 3 Mail The complete business process is: Notifications about new Un-registered mail sent.
Incoming Email
Incoming Facsimile
Auto Mapping to find the TO and FROM addressees in the TeamBinder Address Book.
Email sent to: Unregistered Mailbox User Access Company Department Personal Company No or Incorrect Personal Prefix Y N N With Correct Personal Prefix Y N Y Department No or Incorrect Personal Prefix With Personal Prefix N Y Y
Sender is notified.
A copy of the processing mail is delivered to the Inbox of the Addressee(s). Addressee(s) are notified.
A copy of the processing mail is saved into the Sent Items mailbox of the sender.
Processing Mail Filed in a Binder / Section (Optional) Sender and Recipient Companies: Processing Mail Filed in: Sent Items copy auto filed: Same Public Binder Y Private Binder Y Different Public Binder Y Private Binder N
Page 57
Chapter 3 Mail
If the filter screen does not appear, it can be accessed at any time from within the Unregistered mail box using the Filter button. 3. Click OK. Un-processed incoming faxes will listed in the unregistered mail list. 4. Open the fax that you wish to process by clicking on it. 5. View an image of the Fax by clicking on the attachment image at the bottom of the form. 6. Note the distribution (who the fax from, sent to, and copied to) from the fax image. 7. Close the image of the Fax. 8. Now populate the details of the mail that will be used to distribute the fax to the intended distribution as you would when creating a normal outgoing mail [see Section 3.3.02]. Note that the system attempts to map the FROM person who sent the fax to the correct company in TeamBinder based on intelligent fax number recognition. If the auto mapping fails, it is necessary to view the image of the fax to derive the FROM person as well as the TO distribution. After selecting the from person, tick the box Remember this From contact for future faxes received from X. Future faxes received from this fax number will be auto mapped to the selected Contact. 9. Select the mail type to process (deliver) the incoming fax with from the drop down list. 10. Send the mail as normal. Notes: (a) Either a TIFF, PDF or other digital representation of the original fax will be sent as an attachment to the mail used to distribute an incoming fax. (b) Click on the attachment/paper clip icon at the unregistered mail register to view an image of the fax (PDF format only supported) via a new browser window, without opening the incoming fax mail itself. If the fax image is not PDF, you will be prompted to download the image. (c) Users can only process un-registered mail that has been sent to their own companys project fax number. (d) Users can control whether to be notified about new Company, Department or Personal mail only received as unregistered mail. This is done via User Preferences [see Section 3.2.08]. TeamBinder User Guide Page 58
Chapter 3 Mail
(e) Once the processing mail is sent, it will be distributed to all contacts in the distribution list. (f) The processing mail will be placed in the Sent items of the person marked in the FROM box of the mail (even though that person may not be a TeamBinder user), not the Sent items of the person processing the unregistered mail. The processed fax remains in unregistered mail and is marked as processed. (g) The FROM person will be notified by email that their fax has been processed. This notification can be switched off via Company Details [see Section 12.2.03]. (h) It is possible to reprocess a processed fax. Simply follow the instructions above but choose Processed at the filter at Step 2. Note that the system will warn you that you are reprocessing an incoming fax. (i) Use the Delete button to delete any unregistered mails. They will be moved to the Deleted Items folder [see Section 3.9.06]. (j) It is possible to process the incoming fax as a document rather than a mail [see Section 3.6.04]. (k) Access to Unregistered mail is restricted [see Section 3.1.05]. (l) The processing mail can be filed into a Binder + Section as with normal mail [see Section 3.9.01].
Page 59
Chapter 3 Mail Notes: (a) The original body text of the email will automatically be placed in the detail field of the mail being used to distribute it. (b) Any attachments received on the email will be automatically attached to the mail being used to distribute it. (c) Click on the attachment/paper clip icon at the unregistered mail register to download any attachments to the incoming email. (d) The details of how and when the email was received, and when it was processed are stored as part of the mail being used to distribute it and cannot be edited. (e) Users can only process un-registered mail that has been sent to their own companies email address. (f) Users can control whether to be notified about new Company, Department or Personal mail only received as unregistered mail. This is done via User Preferences [see Section 3.2.08]. (g) For Incoming Emails sent to a company based email address with personal unregistered mail activated, if the addressee is mapped to one or more specific contacts then the unregistered mail would be displayed under Company Mail (Mapped) AND under the Personal Unregistered Mail for the mapped contacts. The mail can be processed by either a user with Company Mail access OR the addressee to who it is mapped. If none of the addressees are mapped, the mail will appear under the Company mail view only. (h) For Incoming Emails sent to a Department based email address with personal unregistered mail activated, If the addressee is mapped to one or more specific contacts then the unregistered mail would be displayed under Department Mail (Mapped) AND under the Personal Unregistered Mail for the mapped contacts. The mail can be processed by either a user with Department Mail access (and belongs to the relevant department) OR the addressee to who it is mapped. If none of the addressees are mapped, the mail will appear under the Department mail view only. (i) Once the processing mail is sent, it will be distributed to all contacts in the distribution list. (j) The processing mail will be placed in the Sent items of the person marked in the FROM box of the mail (even though that person may not be a TeamBinder user), not the Sent items of the person processing the unregistered mail. (k) The FROM person will be notified by email that their email has been processed. This notification can be switched off via Company Details [see Section 12.2.03]. (l) It is possible to reprocess a processed email. Simply follow the instructions above but choose Processed at the filter at Step 2. Note that the system will warn you that you are reprocessing an incoming email. (m) Use the Delete button to delete any unregistered incoming emails. They will be moved to the Deleted Items folder [see Section 3.9.06]. (n) It is possible to process the incoming email as a document rather than a mail [see Section 3.6.04]. (o) Access to Unregistered mail is restricted [see Section 3.1.05]. (p) The processing mail can be filed into a Binder + Section as with normal mail [see Section 3.9.01].
Page 60
Chapter 3 Mail
Page 61
Chapter 3 Mail Note that with Personal Unregistered mail activated, mail that is successfully mapped will appear under BOTH Personal Unregistered mail and EITHER Department unregistered mail OR company unregistered mail depending on the email address used.
Page 62
Chapter 3 Mail
Notes:
(a) The Use of Private Issues in regard to Live Mails is switched off by default and can be turned on if required via Administration Project Details [see Section 12.1.03]. (b) The Respond By date for the Live mail is managed via the normal Respond By field. (c) An Email notification is sent to each recipient about the new Live Mail as with normal mail.
Notes:
(a) To save the response in draft without Sending, click the Save button. When you next click Reply to the same Live Mail your previous draft response will be displayed. (b) The recipients for the Response are either the full distribution of the original Mail (for Public Issues) or a single recipient (selected when replying) for Private Issues. (c) The Status of the Response is maintained via the normal Status field on the mail form. This status is the status of the recipients response only. (d) The status of the overall mail is maintained by the Sender. (e) Attachments can be added as part of the response. (f) Custom fields can be added to the Response/Action window if required contact QA Software for more details on this. (g) Responses can not be added to the Live Mail if the Sender has changed their status of the mail to Closed-Out. (h) Note that recipients (and sender) can forward a Live Mail to other parties but in this case a new mail is created and only the contents of the original message (and not the responses) are included with the forwarded mail. (i) The recipients of Live Mail receive the following Notifications by email: On public issue mails when any other person submits responses. Reminders for overdue responses (Sent daily if the recipient has not made a response).
As responses are added to a Live mail by recipients (and possibly the sender if further clarifications are required) the responses are listed at the bottom of the mail chronologically. If there are more than four responses, then all but the last four are collapsed and can be clicked on to be expanded. The Sender of a Live Mail item is responsible for closing the issue out. Once the Sender has changed their status of the Live Mail to Closed-Out, no further responses can be made. If the first responses to the Live Mail do not clarify/close the issue the Sender can make further responses themselves within the same mail.
Page 63
Chapter 3 Mail The My tab of the Management Summary displays the following statistics in regard to Incoming Live Mail: Outstanding: Calculated based on whether a response has been sent or not. Overdue is a subset of outstanding where the current date is greater than the Respond by date.
The Mail tab of the Management Summary shows Live Mail Responses for both Incoming and Sent Mail. For Sent Live Mail: Outstanding is calculated based on whether is at least one person who has not sent a response. Overdue is a subset of outstanding where the current date is greater than the Target date.
Notes:
(a) Live Mails are also included in the normal mail Status outstanding mail count. (b) There are a number of standard reports available relating to Live mail [see Section 3.11.02].
The TeamBinder search engines are able to not only search for mail via information stored in the database (meta data) but also via any text based attachments to correspondence. Text based attachments include file types like MS Excel, MS Word, HTML, RTF, TXT etc.
Page 64
Chapter 3 Mail Addressed to: The filter always defaults to Personal Mail only. To include any mail sent or received by your company (or Department) in your search, click the Company (or Department) Mail option. Access to Company and Department mail is security controlled [see Section 3.1.05]. Use the drop down list to search/filter for a particular type of mail. Choose between the following six hot list options: Document No Contains: All mail (Default). New Mail (Mail that is Un-Read) Outstanding mail (Mail with a Status = Outstanding) Mail received in last X days. (Enter the number of days) Responses requested within the next X days. (Enter the number of days) Mail Closed out within the last X days. (Enter the number of days) Mails with Priority [Low, Normal, High] Choose an option.
To search by the mail reference number, enter the reference number in the Document No Contains field. To search across the body text of all mails for a particular string of text, enter the text in the Message Contains field. To search based on the Subject of mails, select a search condition such as Contains, or Begins with and enter the search text string in the field provided. To search for mails based on the name(s) of file attachments, select a search condition such as Contains, or Begins with and enter the search text string in the field provided. To search through text based file attachments to mails for a particular string of text, enter the text in the Attachment Contains field. Enter a date range to only search/show mails that were received/sent during a period. Click the date picker to select the dates from a calendar. Click the FROM>> button to search for mail FROM a particular Company or Person. Click the TO>> button to search for mail TO a particular Company or Person.
Message contains:
Subject:
Attachment Names:
Attachment Contains:
Date Received/Sent:
From:
To:
When using the filter, choose any of the above options and then click OK to proceed. Notes: (a) The filter screen can be displayed by default when accessing the mail registers by activating the Show Filter option for registers via User Preferences. It is also possible via User Preferences to set the default values for the filter screen. [See Section 3.2.09]. (b) The filter options in different mail folders may vary slightly from the above. (c) Wild cards can be used to enhance the search process. Use ? to search for any character. For example, searching for Document Number A?1 will return A01, A11, A12 etc. Use * to match any number of characters. For example Structur* will return Structural, Structures, Structuring etc. (d) Use the Save button to save your filter settings. You will be promoted to enter a Title for the saved settings. You can then use the Load button to load any saved settings rather than reselect them each time you use the filter screen. (e) Use the Detail Filter button for a full SQL type data search [see Section 3.8.03]. TeamBinder User Guide Page 65
Chapter 3 Mail
4. Add as many filters lines as required using the And or Or options to join the lines together. 5. Click OK when done. Notes: (a) If the Field name selected to filter on is normally populated by values from a TeamBinder configuration table, the data to filter for field will change to a drop down list to select a value from. (b) To return to the Simple filter screen, click the Simple filter button. (c) Detail Filters can be saved using the Save button. Enter a Title when prompted and use the Load button to load a previously saved detail filter. (d) A detail filter can be used in combination with a simple filter by clicking the Combine with Simple Filter option.
Mails can also be manually linked together and even Documents, Transmittals, and Packages can be linked to mail to form part of a thread [see Section 3.9.02]. The Thread view is a special view of mail where the thread before and after the currently selected mail can be viewed in much the same way as a newsgroup discussion is viewed on the internet.
Page 66
Chapter 3 Mail 3. Click on the View button in the toolbar and select Thread View. 4. Navigate through the thread view in the top frame of the page using the + icons to see all linked mail. Different work items in a thread are identified by the use of different icons: Mail This icon denotes that a mail item is linked to this document. Document This icon denotes that a controlled document is linked to this document. Transmittal This icon denotes that a transmittal is linked to this document. Package This icon denotes that a package is linked to this document. 5. Click on an item in the thread in the top frame of the page to view the details of the item in the bottom frame. For mail and transmittals, the mail or transmittal notification will be displayed. For Documents and Packages the Document or Package Details are displayed. Notes: (a) It is possible to change the status of all mail in a thread by changing the status of any one mail items within the thread using the Status drop down list in the lower half of the screen in the mail view. You will be promoted when saving to update the status of all mail in the thread to the same status. Click Yes when prompted and OK at the confirmation window. (b) It is possible to view the thread related to a mail from within a mail form using the Show Thread View link at the bottom of the form.
Notes: (a) Mail items you can view from within a Binder Section combination are always subject to the standard mail security rules in regard to Personal/Company mail and mail types you have access to [see Section 3.1.04]. (b) To file mail in a one or more Binder + Section combinations, see [Section 3.9.01]. (c) Choose the All Mailboxes option to see both incoming and sent mail in a Binder + Section. (d) It is also possible to view all mail within a Binder/Section using the Show Binder Details link at the bottom of the mail form of a mail already filed in that Binder/Section.
Page 67
Chapter 3 Mail
File mail
5. Apply a filter for the correspondence that you wish to file and click Next. Mail that meets the filter conditions applied will be displayed in the left hand grid of the mover window. 6. Move the mail items that you wish to file from the left to the right of the screen using the mover arrow buttons. Note that any mail items which were ticked for selection in the mail register prior to step 2 above will already be shown in the right hand grid as they are auto selected for filing. 7. Click Next and choose the Binders type to select from. The options are: Public; Private; or All. 8. Select the Binder that contains the Section(s) that you wish to file the selected mail items in. 9. Select the Section(s) to file the selected mail items in by moving them from the left to the right of screen using the mover arrow buttons. 10. Click Next and then Finish to complete the Binder/Section Filing Wizard process. Notes: (a) By filing mail items filed in a Binder Section you are NOT creating additional copies of the mail. (b) If a copy of the mail you are trying to file has been received by other users in your company and has already been filed by another user, you will be prompted of this but can still proceed to file your copy although this is not considered necessary. TeamBinder User Guide Page 68
Chapter 3 Mail (c) Mail Items can be filed in multiple Binder + Section combinations. However, there is still only ever one copy of the mail in TeamBinder. It can simply be viewed via the Binder + Section combinations it is filed in. (d) Mail items that have been filed in one or more Binder/Section combinations have a filing icon displayed against them in the Inbox and Sent items mail registers. (e) Pre-select the items to be filed by ticking them in the mail register prior to launching the Binder and Section Filing Wizard. (f) If a mail is already filed in one or more Binder + Section combination and is selected prior to running the Binder Section Filing Wizard, the user is warned the mail is already filed. (g) It is possible to prevent removal of mail from the Binder/Section in which it is filed by activating this option via Administration\Project Details [see Section 12.1.03]. (h) When filing mail from within the un-registered mail module during processing, the following rules apply: If the Sender and Recipients are from the same company, both copies of the processing mail are auto filed in the Binder and Section If the Sender and Recipient are from different companies and the processor selects a Public Binder/Section, again both copies of the processing mail are filed in the same place. If the Sender and Recipient are from different companies and the processor selects a Private Binder/Section, then only the copy of the processing mail delivered to the Inbox of the Addresses (assuming they are in the same company as the processor) is filed.
Transfer Mail
If at step 3 in the above instructions you choose transfer mail rather than file mail, then the following steps apply after you click Next at step 4. 11. Select whether you wish to Move or Copy mail between binders and sections. 12. Select the Binder and Section that you wish to move or copy mail from. 13. Select the Binder and Section that you wish to move or copy mail to. 14. Move the mail(s) to be Moved or Copied from the left to right of the screen using the mover arrow buttons. Note: Only mail items filed within the Binder + Section combination from the currently active mailbox can be moved or copied. 15. Click Next and then Finish to complete the Binder/Section Filing Wizard process.
Linked mails can be viewed via the TeamBinder thread view [see Section 3.8.04]. Manual linking is the facility to link a mail item to another other mail, document, transmittal or package and enables threads to be built from scratch or existing threads expanded to include related work items from other TeamBinder modules.
Page 69
Chapter 3 Mail Note: Use a Filter if required to locate the required mail. 3. Click on the click the Edit Links button on the toolbar Alternatively open the mail and click on the Edit Links button. The TeamBinder Links wizard will now load 4. Click Next at the welcome screen and select the type of work item that you wish to link to this mail. Choose from: Mail Documents Transmittals Packages
5. Click Next and a filter screen will appear. The filter screen is based on the type of work item that you selected at step 4. (e.g. if you selected Documents, a document register filter will be shown). 6. Apply a filter as applicable and click Next. The next screen will show the results of your filter on the left of screen. 7. Use the tick boxes and mover arrow buttons to move work items from the left to right of screen. Items on the right of screen will be linked with your mail. 8. To select work items from a different module, click the relevant Work Items option button at the top left of screen. Apply a filter as required and then select the required Work Items to link as per Step 7. 9. To see all Work Items you have selected regardless of type, use the Selected Work Items option button. 10. Click Next to continue and click Finish to complete the linking process. You will receive a confirmation message once the system completes building the selected links. Notes: (a) Use the Link icon in the New Mail screen to creating links to a mail before sending it if required. (b) The link icon is displayed against mails with links in the mail registers for easy identification.
Chapter 3 Mail Completed Deferred Dormant In Progress N/A Not Started Outstanding Partial
The Status of a mail can be changed by opening the mail and use the Status drop down list. Notes: (a) The default status assigned to all mail is Outstanding. (b) Users can auto allocate a status of their own choosing to mail they receive as either a CC or BCC person the distribution (as opposed to the TO value) [see Section 3.2.07]. (c) The Status of an incoming item of mail that requires a read receipt to be sent cannot be changed to Closed-out until the read receipt is sent. (d) The Management Summary at the Dashboard provides quick access to mail folders and the display of mail within the folders of a status Outstanding or of Status values defined by the user via User Preferences [see Section 3.2.07]. (e) The Status of a batch of mails can be updated using the Batch Status Wizard [see Section 3.9.04]. (f) The Status of mails in a thread can be updated via the Thread View [see Section 3.8.04]. (g) It is possible to auto update the responded date when changing the status of a mail. This is done via User Preferences Mail Options [see Section 3.2.05]. (h) It is possible to run a report on outgoing mail showing the status that the recipient has the mail at (subject to them giving permission for this information to be viewed). See User Preferences Mail Status [Section 3.2.07] and Reports [Section 3.11.02]. (i) It is possible to receive auto email reminders in regard to mail at a particular status every X days [see Section 3.2.07(d)].
Chapter 3 Mail
5. Click OK. 6. At the prompt to batch update the Responded date to the current system date for the selected mails, click Yes to choose this option if required (optional).
To export mail
1. Open the Inbox, Sent Items, or Drafts/Outbox from the left menu. 2. Select one or more mail item(s) to be exported by ticking the select boxes against them. Note: Use a Filter if required to locate the required mails. 3. From the toolbar click the Export Mails button. 4. From the drop down list, select either HTML or PDF. 5. If the TeamBinder privacy statement appears, click Yes to continue with the download. The selected mails will now be zipped on the TeamBinder server and then downloaded to your PC. Note that a single mail being exported is not zipped. 6. Save the zip file to a folder on your PC. The exported mails will be available within the zip file. Notes: (a) The zipping process at step 6 may take a few minutes if a large number of mail items were selected.
Page 72
Chapter 3 Mail (b) While exporting all mail items from your Inbox and Sent Item mail folders would be one way of creating your own archive of TeamBinder correspondence, a far more effective way is to arrange for a regular TBARCHIVE [see 12.1.06].
To delete mail
1. Open the Drafts/Outbox, or Un-Registered mailbox from the left menu. 2. Select the mail items to delete by ticking the select box against them. Note: Use a Filter if required to locate the required mails. 3. Click the Delete button on the toolbar. 4. Click Yes when prompted to move the selected mail to the Deleted items mailbox.
Page 73
Chapter 3 Mail 3. Click the Print button on the toolbar. The Print Dialog box will now load. 4. Click the Print button to print the correspondence Notes: (a) Due to the nature of Microsoft Internet Explorer, the windows print dialog box will appear once for each item of mail being printed and the user will need to click print each time.
6. Click Finish. Notes: (a) The email delivery option can be used to deliver the attachments to any email address. (b) The attachments being downloaded or emailed will be zipped on the TeamBinder server prior to delivery.
Page 74
Chapter 3 Mail 1. A decision is made by a company on a project to use the Fax-In service. 2. QA software will by request, arrange a fax number for the company or each department (this must be done by QA Software as existing company fax numbers cannot be used). 3. The company will then notify the companies who they want to allow to send them faxes (rather than login to TeamBinder to create mail) of the fax number(s) to use. Note that companies who already have a project specific fax number can simply divert this to the fax number provided by QA Software rather than notify all parties of a change in fax number. 4. Faxes sent or diverted to the number provided by QA Software will then appear automatically in TeamBinder as an electronic image and are processed via an UnRegistered mailbox at either a Company or Department level. This task is normally allocated to a nominated person who checks for incoming faxes daily. 5. The person nominated views all incoming faxes received and inputs the correct TO, FROM and CC details after viewing the electronic copy of the Fax on-line. The FROM person will be auto mapped if the senders fax number exists in TeamBinder. 6. TeamBinder then processes the Fax as though the sender has created it online. 7. The Sender also gets an email automatically to tell them the fax has been received and processed. Notes: (a) See also Fax-In configuration [Section 3.1.10]. (b) See also Processing Incoming Faxes [Section 3.6.03].
3.10.02 Email-In
The TeamBinder system has the capability to automatically route normal emails sent to a Project based company email address, directly into the system electronically. This facility can be provided on a per receiving company (or department), per project basis. Any company on the project who wants to allow people to send them communications by email rather than by logging into TeamBinder can arrange the activation of the Email-In feature by contacting QA Software. The process for applying, activating, and using the Email-In service is summarized as follows: 1. A decision is made by a company on a project to use the Email-In service. 2. The company contacts QA Software who arranges an email address specifically for this purpose (only QA Software can arrange this). 3. The company then notifies their own staff (so that their own staff can forward a project related emails they receive into TeamBinder) and external parties who they want to email into TeamBinder, the email address to use for this purpose. Note that it is also possible to simply divert an existing project email address being used to the email address set up at step 2 above which means this step is not necessary. 4. Any emails sent to the email address set-up at step 2 will now appear automatically in TeamBinder in the Un-Register mailbox from where they are processed. This task is normally allocated to a nominated person who checks for incoming emails daily. 5. The person nominated views all incoming emails received and assigns the correct TO, FROM and CC details after viewing the electronic copy of the email on line. The FROM person will be auto mapped if their email address exists in the project address book. 6. TeamBinder then processes the email as though the sender had created it on line from within TeamBinder. TeamBinder User Guide Page 75
Chapter 3 Mail
7. The Sender also gets an email automatically advising them that the email has been received and processed.
Notes: (a) See also Email-In configuration [Section 3.1.11]. (b) See also Processing Incoming Emails [Section 3.6.04]. (c) It is possible to have a single Email-In address that is used to receive mail from multiple projects. All such mail is routed into a single nominated project and from that project can be read and transferred to the correct project. Contact QA Software for more information.
3.10.03 Fax-out
The TeamBinder system has the capability to send outgoing mail by fax if and when required. The Fax-Out service is typically used to communicate with smaller companies involved in the project who have limited Internet access and would prefer to receive correspondence from you via a traditional fax machine. The Fax-Out service attracts monthly charges based on the number of fax pages sent and can only be activated by QA Software. The service is activated on a per sending company per project basis. Once activated, simply update the Address book to set the default send method to Fax for those contacts who prefer to be sent mail by this method. Notes: (a) See also Sending Mail [Section 3.3.03].
*Note these reports are located outside of the Mail report group currently and is listed at the reports screen after selecting Reports from the left menu at the Dashboard. 4. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. TeamBinder User Guide Page 76
Chapter 3 Mail Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) Mail from both Incoming and Outgoing Mail boxes can be included on the same report. (c) When filtering reports by Contact(s), In-active contacts will only be listed if they are ticked in the Address book to be included in such filters (d) See also Generating Standard Reports [see Section 10.1.02] (e) See also Customizing reports [see Section 10.2.01].
005
Page 77
Chapter 3 Mail
Description The Sent items report with Responses is a powerful report that shows: Mail in the Sent Items Mail box The response received against each mail item A list of people who have NOT responded as requested to each mail item
The system identifies a response to your outgoing mails when a recipient uses the Reply or Forward options after reading the mail in their inbox. 015 Sent Items Report - by Originator Reference Inbox Report - by Originator Reference Mail Thread - Summary Report Sent Live Mails Status Sent Live Mails Actions and Responses Received Live Mails Responses Outstanding / Overdue Sent Live Mails Response Outstanding / Overdue This report is used to print a list of mail in Sent Items sorted by and including the Originator Reference number.
020
This report is used to print a list of mail in the Inbox sorted by and including the Originator Reference number.
This report details the thread of all mails that have been responded to. It is the equivalent of a printed version of the thread view. This report prints a register of Live Mails showing the Status or each mail. This report prints a register of Live Mails and includes the details of each response made to the mail. This report prints a register of Live Mails received that are either Outstanding or Overdue.
045
050
This report prints a register of Live Mails sent that are either Outstanding or Overdue.
Page 78
Chapter 4 - Documents
4.1 Getting Started
4.1.01 4.1.02 4.1.03 4.1.04 4.1.05 4.1.06 4.1.07 4.1.08 4.1.09 4.1.10 4.1.11 4.1.12 4.1.13 4.1.14 4.1.15 Overview Setup Check List Revisions Status Codes Disciplines Categories Document Types File Formats Discipline Distribution Matrix Create Discipline Wizard Security Issues Documents User Preferences Document # Masks Design Management Considerations Customising the Document Register
4.5 Reports
4.5.01 Overview 4.5.02 Available Reports Listing
Page 79
Chapter 4 Documents
This chapter is focused on how to get started with the Document Management Process and the management of Un-restrained Documents. The management of the document review and approval process (which occurs for Restrained documents) is the subject of [Chapter 6].
Chapter 4 Documents
8. Define any Document Masks to be used [see Section 4.1.13]. 9. Define the Discipline based distribution Matrix [see Section 4.1.09]. 10. Setup Categories [see Section 4.1.06]. 11. Define any mandatory fields to be used during document registration [see Section 12.4.10]. Notes: (a) See also Design management considerations [see Section 4.1.14].
4.1.03 Revisions
Revisions are a mandatory attribute of controlled documents in TeamBinder. The system supports both alpha and numeric revision systems. However there is a strict rule in TeamBinder that each time a document uploaded, its revision number must be greater than the previous revision. This is controlled via a sequence number against each revision in the revisions configuration table. The Sequence is used to validate documents being uploaded to ensure that the revision being uploaded is greater than the previously uploaded version. Note that in certain circumstances it is possible to upload additional view files to a document without changing the revision.
Chapter 4 Documents
4.1.05 Disciplines
For controlled documents, the Discipline is a mandatory attribute that controls: Who is allowed to upload documents. How documents are distributed. The responsibility for managing the review process (workflow) when required. The default review team for documents requiring a review workflow.
Page 82
Chapter 4 Documents 4. Use the Add/Remove link under the Set Companies column to define which companies can upload documents belonging to the discipline. 5. Select the companies that will be authorised to upload documents for the discipline by ticking the boxes to the left of them and then use the right mover arrows. 6. To enable a company to upload revisions of documents for which they are not the originating company, click the Upload to other companies documents box to the right of the company. See also note (c) below. 7. Click Save and then Close. Notes: (a) Only the Project Administrator can add/edit or delete Discipline values. (b) When adding discipline values, populate the following fields: Discipline Code: This is the code for the Discipline. Discipline Title: This is a description of the Discipline Code The following values are used by the Workflow module of TeamBinder [see Chapter 6]. Document Review Coordinator: This is the Company and Contact responsible for managing the review process/workflow for restrained documents upload belonging to the discipline. Review Workflow Type: Choose between Serial, Parallel, and Single as the Workflow type for document reviews. With Serial reviews, reviewers review documents in sequence. With Parallel reviews, all reviewers review documents at the same time. With Single Reviews, the review is completed by the review coordinator alone (and the following three options are disabled). Remind Reviewers Every: Enter an Interval in days for the auto sending of reminders to reviewers if they are late with their review of documents. Notify Review Coordinator of delays in the review process: Tick this box if the Review Coordinator wants to be notified by email of any delays to the review process (this is in addition to the standard notification sent to the individual reviewers if they are late in the review of documents). Automatically Activate the review workflow: Tick this box if restrained documents of this discipline are to be routed into the workflow automatically on upload rather than manually activated. (c) While more than one company can be authorised to upload documents belonging to a discipline, once a document has been uploaded, generally only the company who uploaded it can upload future revisions. [See also Transfer Document Ownership Section 4.3.06]. Other companies can be enabled to upload revisions of documents for which they are not he original uploading company by ticking the Upload to other companys documents box at Step 5 above in the Set Companies screen. (d) See also the Create Discipline Wizard [Section 4.1.10].
4.1.06 Categories
Categories are a mandatory controlled document attribute. The category of a controlled document can be assigned during the document upload process or via the Category drop down list when viewing the Master Document Register and editing a document.
Page 83
Chapter 4 Documents
Page 84
Chapter 4 Documents 3. Click on any of the current formats and edit the details as required: Modify the Caption and Sequence (controls the column position from left to right) as required. Use the Add/Remove buttons to associate the required file formats with the caption.
Notes: (a) Configuration of file formats must be done prior to the upload of any controlled documents on a project. (b) File formats can only be configured by the Project Administrator. (c) If a document is uploaded and it does not have a file format as defined in the format codes it will be applied to the fixed file format of OTHER. (d) The Format Code of OTHER cannot be removed.
A user included in the discipline based distribution matrix for a discipline of documents will automatically be notified when documents belonging to the discipline are released in TeamBinder. Note however that the Discipline based Distribution matrix is not the only way of controlling the distribution of documents being released. It is only one of a number of methods and is primarily used to manage the distribution of documents between consultants during the design phase of a project and for internal distributions. Other ways of managing the distribution and access to documents include: Subscriptions [see Section 4.2.05]. Transmittals [see Chapter 5]. Packages [see Chapter 7].
By User
1. Select a Company from the drop down list. The Users that belong to the selected company will then be listed. 2. Click on the User to edit the settings for. 3. From the left hand grid, tick the disciplines that you wish to assign this user to and then use the Move Selected Records arrow button to move these disciplines to the right hand grid. 4. Against each selected discipline, populate the following as required:
Page 85
Chapter 4 Documents DWG: Tick this box if the user should be allowed to download documents of the selected discipline in AutoCAD DWG format. PLT: Tick this box if the user should be allowed to download documents of the selected discipline in AutoCAD Plot File (PLT) format. TIFF: Tick this box if the user should be allowed to download approved or unrestrained documents of the selected discipline in TIFF format. OTHER: Tick this box if the user should be allowed to download approved or unrestrained documents that are not in the formats DWG, PLT or TIFF. Note that the above file formats depend on the settings for file formats established for the project [see Section 4.1.08]. Access From: Enter the date of document upload/creation, after which this user should be able to download documents of this format. (e.g. If 1/12/2001 is entered, the user will be able to download all documents of the discipline uploaded/created after 1/12/2001). 5. Click OK when done.
By Discipline
1. Select a Discipline from the Discipline drop down box. The Users assigned to the selected discipline will be listed on the right hand side of the screen. 2. Select a Company from the Company drop down box. The Users that belong to the selected company will then be listed on the left hand side of the screen. 3. From the left hand grid, tick the users that you wish to assign to that discipline and then use the Move Select Records arrow button to move these users to the right hand Discipline grid. 4. Against each selected User, populate the file format and access from settings as described for the By User option above. 5. Click the Save button when done. Notes: (a) The Discipline based distribution matrix can be managed via the Project Administrator (for all users), and the Company Administrator for users in their company and for Disciplines they themselves have access to. (b) See also Document Access [Section 4.2.04].
Page 86
Chapter 4 Documents 3. Enter the workflow settings for the Discipline [see Section 6.1.04] and click Next. 4. Define the default review team members for the Discipline by selecting the names and using the right arrow buttons to select them. Note that the default review team members can be selected from existing Free form review teams or from the Address Book (contacts) in general using the two option buttons for this. 5. Enter the Total and Target durations for the review process and the Sequence and Durations for each reviewer and click Next. Note: See [Section 6.1.05] for more details on Review Teams. 6. Assign the companies authorised to upload documents of the discipline and click Next. Note that if any of the companies assigned do not have at least one user with Full access to the document register you will be promoted (and the company cannot be selected at this point). 7. Assign users to the default distribution matrix and click Next. See [Section 4.1.09] for more details on this. 8. Click Finish at the end of the wizard. Notes: (a) At step 3, click the Duplicate button to duplicate the basic Discipline and workflow settings from an existing discipline. You will be prompted to select the Discipline to duplicate.
User Access
This is the means by which access to the Document Register is controlled for TeamBinder Users. 1. From the Administration menu, select Configure User Access to Modules from the Security group of options. 2. Select a Company. The users within that company will be listed. 3. For each user, choose from between the following options under the Document Register column: None: Access to the Document Register is denied to the user. View: The User can view the Document Register but cannot upload, or edit document details regardless of any other document access settings. Full: The user has full access to the Document Register but can only view, upload, and download documents for which they have specific document Access [see Section 4.2.04].
Chapter 4 Documents (a) User Access can only be set/modified by the Project Administrator (for anyone) or by a Company Administrator (for users within their company). (b) With View or Full Access, it is possible to limit the documents displayed in the register to only the Documents that the logged in user has access to. This is done via the Address Book and Companies settings [see Section 12.2.03].
Document Access
Regardless of a users access level to the Document Register, access to individual documents is controlled at a document level (and even down to a format level for each document) [see Section 4.2.04].
Chapter 4 Documents
Page 89
Chapter 4 Documents
Page 90
Chapter 4 Documents Note that the TeamBinder validation engine will reject any documents not meeting the agreed standards. If QCAD is being used for Document uploads and QPRINT for printing or electronically stamping documents, the standards also include: Standard AutoCAD attribute block for use in DWG files. Standard HPGL2 compatible plotter driver for use in DWG and PLT files. Standard paper size for use with DWG files. Standard plot orientation for use with DWG and PLT files.
Notes:
(a) Not all columns can have alternative names. (b) To open Custom View 1 or Custom View 2 as the default view when you view the Document Register, select the required View at the above screen and tick the Open document register with this view by default box.
Page 91
Chapter 4 Documents
Page 92
Chapter 4 Documents Register View: Select from the following options: Latest Documents (not restrained).
This means the latest revision of released (after going through a review workflow) or un-restrained (not requiring review) documents.
Latest Documents.
This means the latest revision of documents regardless of whether they are currently restrained (going through a workflow), un-restrained, or released.
All.
This means all revisions of all documents regardless of whether they are restrained, un-restrained, or released.
This means documents which have been released or are unrestrained to which you have access and/or documents that are restrained for which you are a reviewer.
This means only documents that the company you belong to has uploaded.
All.
If users within your company can only view documents to which they have access, the All option will be restricted to only showing these documents [see Section 12.2.03].
Select a particular document Status (default is +ALL). Select a particular document Discipline (default is +ALL). Select a particular document Type (default is +ALL). Enter part, or all of a Document Number to search for specific documents via their number. Enter a text string to search for documents via their title. The default is based on the maximum number of records to display as defined in User Preferences [see Section 3.2.02]. Choices are Document no, Approval Status, Discipline, Date Recorded, Status, or Category. Choose between Ascending and Descending order. Up to three sort fields can be combined using the More button. The detail filter allows you to create your own filter conditions using all the fields in the TeamBinder document register, several filter conditions and open text fields [see Section 4.2.03].
Sort by:
Detail filter:
Page 93
Chapter 4 Documents Notes: (a) The filter screen can be displayed by default when accessing the mail registers by activating the Show Filter option for registers via User Preferences [see Section 3.2.09]. Default filter options can also be defined via the same User Preferences screen.
4. Add as many filters lines as required using the And or Or options to join the lines together. 5. Click OK when done. Notes: (a) If the Field name selected to filter on is normally populated by values from a TeamBinder configuration table, the data to filter for field will change to a drop down list to select a value from. (b) To return to the Simple filter screen, click the Simple filter button. (c) Detail Filters can be saved using the Save button. Enter a Title when prompted and use the Load button to load a previously saved detail filter. (d) A detail filter can be used in combination with a simple filter by clicking the Combine with Simple Filter option.
Page 94
Chapter 4 Documents Note: Viewing on-line and Red-lining requires TeamView to be activated on the project. [see Section 4.2.07]. Access to documents is granted by any of a number of methods in TeamBinder which include: Being the document originator. Being on the discipline based distribution matrix for the discipline the document belongs to [see Section 4.1.09]. Being the review coordinator for the discipline the document belongs to - [see Chapter 6]. Being a document reviewer for the discipline the document belongs to (restrained documents only) - [see Chapter 6]. Successfully subscribing to a document [see Section 4.2.05]. Being Transmitted a document [see Chapter 5]. Being awarded a tender package that includes the document [see Chapter 7]. Being given specific access to a document by the Project Administrator [see Section 12.4.06]. Having ownership of the document transferred to you [see Section 4.3.06].
A user with access to a document is generally automatically notified about future revisions of the document. The exceptions to this are where access was gained by Transmittal, Package Award, or the project Administrator and the option to notify automatically about future revisions was un-ticked.
Page 95
Chapter 4 Documents
To subscribe to a document
1. From within the Document Register [see Section 4.2.01]. 2. Locate the first document that you would like to subscribe to and tick the box to the left of the document number to select it. 3. Repeat step 2 for additional documents. 4. Click the Subscribe button. 5. Click OK. Notes: (a) The request to subscribe to a document is passed either to the Company Administrator the user belongs to (if the Company Administrator has access to ALL the documents and document formats being subscribed to) or to the Project Administrator by email. The relevant Administrator will either approve or reject the subscription request and the user making the request will be notified by email of the outcome [see Section 12.4.05]. If the subscription request is successful, you will be able to access the document(s) when back in the Document Register. (b) Only subscription requests in relation to the latest revision of documents (if approved) will be automatically notified about future revisions.
* Means the field is mandatory. Fields in Italics are maintained by the system TeamBinder User Guide Page 96
Chapter 4 Documents
Notes: (a) From within the Document Details screen it is possible to Download the document [see Section 4.4.02]. (b) From within the Document Details it is possible to revise the document if you are the originator [see Section 4.3.03]. (c) In addition to the default mandatory fields, additional fields can be made mandatory if required [see Section 12.4.10]. (d) It is possible to have additional custom fields added to the Document Details screen if required. Contact QA Software for more on this. (e) If a company is allowed to upload documents on behalf of another company [see Section 12.2.03], two further fields appear at the Document Details screen: Sender Company The company that sent the document to the uploading company The person that sent the document to the uploading company
Sender
To view a document
1. From within the Document Register, locate the document that you wish to view. To the left of the Document Number column is the View column. If a format of the document is available for viewing an icon will be shown in this column. 2. Click the View icon. 3. The Document image will be displayed in a new browser window, rendered up by the TeamBinder viewer. 4. The icons on the horizontal toolbar have the following meanings: Icon Purpose Drop down list with options as detailed below: Print: As per Print button below. Properties: Displays the document/drawing properties including the file type; size; scaling; and number of pages. Overlay: Do not select this option. Find Text: Used to locate a text string. Close: This button should not be used. Use the X in the top right corner of the window to close TeamView. Print: Used to print a copy of the document/drawing. Options include: the page or portions of the page to print; the print scale; margins and number of copies; application of watermarks and headers/footers, and the selection of a pen table if available.
Page 97
Chapter 4 Documents
Icon
Purpose Display Preferences: Here you can control for example the background colour used and units of measure. Vector Control: Active only for Vector format Documents
Rotation: Used to rotate the image by 0, 90, 180 or 270 degrees. Zoom window: Click and then drag a window on the image to zoom into. Zoom options: Zoom 1:1 (zoom to scale); Zoom All (show complete image on screen); Zoom Width (show full width), Zoom Height (show full height). Increase Zoom: Click to increase the zoom. Decrease Zoom: Click to decrease the zoom. Pan Hand: Click and drag in the direction required to move around a large drawing. Birds Eye View: Click to load a birds eye view window. As you zoom in and move around a drawing the birds eye view will enable you to keep track of where you are. It also possible to navigate the drawing by using the small red line outline within the Birds Eye view. Measure: Using the down arrow to measure a straight line distance on the drawing (and set this as the default calibration for further measurements). Click the ruler to define an area by clicking on a start point, drag to the next point, click and drag to further points and then right click to get the measurement statistics which include: Angles, distances of each straight line and the area. Page Down: Enabled on a multi page document to move between pages. Page Up: Enabled on a multi page document to move between pages. Select Page to View
5. Use the three options at the top of the screen to switch between: Viewer Full Screen The viewer is displayed full screen (default). Comments Full Screen By clicking this option you will load the comments screen and will enable you to make text based comments [see Section 4.2.09]. Viewer and Comments By clicking this option both the viewer and comments screen will be displayed. The comments screen will be in the lower half of the screen and the viewing tool at the top.
Page 98
Chapter 4 Documents Notes: (a) It is possible to redline (mark up) the document from within the viewer [see Section 4.2.08]. (b) The first time you view a document, TeamBinder must download some scripts to your PC related to the viewing technology. This can take several minutes. (c) Right click anywhere on a document/drawing for quick access to: Zoom window Zoom In Zoom Out Zoom All Zoom 1:1 Pan Copy to Clipboard (requires you to be zoomed in on an area) Measure Print
To red-line a document
1. From within the Document Register, locate the document that you wish to red-line. To the left of the Document Number column is the View column. If a format of the document is available for viewing an icon will be shown in this column. 2. Click the View icon. 3. The Document image will be displayed in a new browser window, rendered up by the TeamBinder viewer. 4. Use the Red-lining toolbar to mark up the document. The icons on the vertical toolbar have the following meanings: Icon Purpose Enable/Disable Redline Toolbar buttons Save or Refresh Markups Markup Preferences: These include the user signature (defaults to the logged in User company Id and user Id (recommend you do not change this); Mark-up Layer and default font for and colour of mark-ups. Markup User and Layer control: Used to toggle on and off markups either by User or Layer. Push button: Click this button so that when you move over a link or notes, the details of the link or note are displayed. Marker: Use this option to set the markups to transparent mode. Then if you draw a filled rectangle for example you can see what is behind it.
Page 99
Chapter 4 Documents
Icon
Purpose Undo: Undo last action Edit: Used to select and edit a markup. Click this button and then click on the markup. The markup then appears with handles at each corner. Use the R handle to rotate the markup. Use the Z handle to Zoom the markup. Double click to edit the text. Link: This is not applicable to TeamView within TeamBinder. Text: Click this button and then click on the document/drawing at the point you want to enter the text in relation to. A text window will appear. Type the required comment. The options for how the text is displayed include using an arrow to point to the item, putting a bubble or frame around the text, and the font required. Click OK and drag the text to the required position. Note: Click the button and then click on the drawing or document where the note is to be added. A text window appears. Enter the note and click OK. The note is displayed on the drawing as a note icon.
Rubber: Click the button and then drag over the area to be rubbed out. This includes parts of the drawing (the original drawing is unaffected) and markups. Lines: Used to draw lines. Use the drop down list to configure the line style. Choose between: Freehand pen, Lines, Curves and Measurement Area. For all these options, click the start point and drag. Then click and drag to the next point. When done, right click. It is also possible for Lines and Measurement Area to select whether the area drawn is hatched, filled, open or closed. Shape: Used to draw a shape: Use the drop down list to select between: Rectangle; Rounded rectangle; Oval; and Bubble options. It is also possible to control whether the shape will be Outlined, Filled or Edged. Arrow: Used to draw straight line arrows. Use the drop list to configure the arrow style. Choose between: Arrow or Dimension (draws a line with the dimension shown between the two end points); Singe; Single Filled; Double; and Double Filled. Filled refers to the arrow heads. Markup line thickness
5. Dont forget to use the save icon to save any markups you make. Notes: (a) In addition to red-lining it is possible to make text comments in relation to the document [see Section 4.2.09]. (b) To see any red-lines/mark-ups made by other users use the Markup User and Layer control button. (c) The Default colour used when redlining documents can be defined for the user via User Preferences General [see Section 3.2.02].
Page 100
Chapter 4 Documents
To comment on a document
1. From within the Document Register, locate the document that you wish to comment on. 2. Click on the document to open the details screen. 3. Click the Comments button. 4. Click New to add a new comment. 5. Type the comment as necessary. To upload an external file to attached to your comments (Optional but ideal if you have sketched comments as well as text based comments): 6. Click the Browse button, locate the file to upload, and click Open. 7. Click OK to save your comments and upload any files you have attached. 8. Click Close to close the comments grid. Notes: (a) Documents in the document register that have existing comments against them are displayed with a comment icon to the left of them. (b) It is possible to have your comments emailed automatically to any or all of the following: The Document Originator The Review Coordinator Everyone who has access to the document (see document Access)
Tick the relevant boxes to send your comments as required. (c) It is possible to quickly apply the same comments against multiple documents you have access to (batch commenting). Simply select the documents first by ticking the select boxes against them and then click the Comment button at the document register and proceed as per steps 4-8 above. The comments you make will be applied to all the selected documents. (d) Making comments by the above method is not a substitute for making comments as part of the formal document review process [see Chapter 6]. (e) It is also possible to access/read/make comments about documents from within the TeamBinder viewer [see Section 4.2.07]. This can be useful as you can both see an image of the document and the comments text box at the same time. Choose either: Comments Full Screen The comments window will load full screen OR Viewer and Comments To see both the viewer and comments.
Page 101
Chapter 4 Documents
Notes:
(a) For large files the comparison can take some time to prepare.
To delete a document
1. From within the Document Register, select one or more documents to be deleted but ticking the select box next to them. 2. Click the Delete button. 3. Click the Add/Edit link under the Reason column to enter the reason that the first document is being deleted. You cannot delete a document without entering a reason. 4. Type the reason that this document is being deleted. 5. If this reason is the same for the other documents that are being deleted at the same time, tick the box labeled Apply to All Selected Documents. This will copy the reason for deletion to all other documents being deleted at the same time. 6. Click OK. 7. Repeat steps 3 to 5 for additional documents (unless you ticked the Apply to All Selected Documents box at step 5). 8. Click OK and click Yes to confirm the deletion. Notes: (a) If all users with access to the document(s) being deleted should be notified of the deletion, tick the box for this purpose after step 6 above.
Page 102
Chapter 4 Documents
4. Once uploaded and released, the documents can also be transmitted to other parties (who have not been notified already by one of the methods above) or included as part of a tender package. There are six alternative methods of uploading documents to TeamBinder: Single document upload from within TeamBinder [see Section 4.3.02]. Bulk document upload from within TeamBinder [see Section 4.3.08]. Using QA Softwares XLUPLOAD utility for batch uploads [see Section 4.3.09]. Using QA Softwares QCAD system for AutoCAD [see Section 4.3.10]. Using QA Softwares QDMS Document Management System [see Section 4.3.11]. Using Un-Registered Mail [see Section 3.6.04].
Page 103
Chapter 4 Documents
Description The document Revision [see Section 4.1.03]. The document Status [see Section 4.1.04]. The Discipline the document belongs to [see Section 4.1.05]. The Category the document belongs to [see Section 4.1.06]. The Type of document [see Section 4.1.07]. This field only appears if your company has the ability to upload documents on behalf of other companies [see Section 12.2.03]. If this is the case, select the company that has sent the documents to here. This is the person who sent you the documents from within the Sending company above. Any revision notes associated with the document. Any remarks associated with the document by the up-loading person. The reason for the uploaded as described by the up-loading person.
5. Now upload a document file (View file) by clicking the Browse button at the bottom of the page. 6. Select the view file from your local hard drive or server and click Open. 7. Repeat steps 5 and 6 for additional view file formats. 8. Click Save The view files will now be uploaded and progress can be monitored via the progress bar. Once uploading is complete the document is distributed automatically [see Section 4.3.05]. In addition to the automatic distribution, if the document is un-restrained [see Section 4.1.04] it can be issued by Transmittal to other parties who are not on the automatic distribution list [see Chapter 5]. Notes: (a) If the document you are uploading has similar attributes to an existing document, first select the existing document using the select box next to it and then click the Duplicate button rather than the New button at Step 3 above. The new document details window will load with most of the meta data populated based on the document selected. (b) TeamBinder captures automatically the Person and Company uploading the document plus the date of upload. (c) It is possible to upload additional view file formats to an existing document of a particular revision at any time but this can only be done by the originator of the document. (d) It is possible to replace a view file format that has been uploaded by mistake using the Replace View File Wizard [ see Section 4.3.07]. (e) To revise a single document [see Section 4.3.03]. (f) To upload more than one document at time see: Batch Upload Wizard [Section 4.3.08]. XLUPLOAD [Section 4.3.09]. Page 104
Chapter 4 Documents
(g) If an Unrestrained document is uploaded to a Discipline that does not have a distribution matrix defined, the Project Administrator can be auto notified if this option is activated via Administration\Project Details [see Section 12.1.03]. (h) If a Restrained document is uploaded to a Discipline that does not have a Review team setup, the Review Coordinator is notified with a CC to the Project Administrator. (i) To get a history of all documents uploaded by your company, run the Documents - Upload History Report [see Section 4.5.02]. (j) To get a history of who has downloaded documents your company has uploaded, run the Documents - Download History Report [see Section 4.5.02].
Page 105
Chapter 4 Documents
For revisions of existing documents: All the rules for New Documents plus: The Title of the revised document must not have been changed from the previous revision. (The exception to this rule is if a ** is added to the end of the title of the revised document which indicates that a conscious decision to change the document title has been made). The Revision of the revised document must be greater than the revision of the existing document (as defined by the sequence) [see Section 4.1.03].
Page 106
Chapter 4 Documents Access to all revisions of the document has been removed via either the discipline matrix or via the Grant Document Access wizard [see Section 12.4.06].
Users in the discipline matrix who do not already have access to the previous revision.
Each user will receive an email notification about the document(s) and can download the documents direct from the email notification or by logging into TeamBinder. Distribution of Restrained Documents (new and revised): If the documents are Restrained (a document is defined as Restrained via the Status applied to it by the Uploading user) they must first pass through a workflow before they are either Released or Rejected [see Chapter 6]. Such documents are listed in the document register with a Review Status of Awaiting Review and can be accessed only by users involved in the review workflow for them until the workflow is completed. If the documents are released after the workflow, they are then automatically distributed as per Unrestrained documents above. Notes: (a) The Automated Distribution process in TeamBinder reduces dramatically the requirement for a document controller to distribute all documents by transmittal, especially during the design phase of a project. (b) The Automated Distribution process is complimented by two types of manual distribution where it is required to issue specific documents to specific parties. See Transmittals [Chapter 5] and Packages [Chapter 7]. (c) It is possible to have a copy of every document uploaded to TeamBinder automatically printed on site and even stamped with a Received time and date (burnt into the document image). Contact QA Software for information on QPRINT if this is of interest charges apply). (d) The diagram below gives a graphic simplified representation of the automated distribution process:
Page 107
Chapter 4 Documents
Page 108
Chapter 4 Documents
Notes:
(a) Replacement of view files can only be performed by the Project Administrator (b) Replacement of view files is limited to Un-restrained documents; restrained documents where the workflow has not yet been activated; restrained documents awaiting release where the review type is Single as opposed to Serial or Parallel.
With the Multiple file upload option, you select each view file individually from your PC or Server and in the process, associate each view file (typically one view file per document) with its document details. If there are multiple view files (of different format) associated with each document, these must be zipped prior to uploading if this option is used. TeamBinder User Guide Page 109
Chapter 4 Documents
Use the Single Zip file upload option if you have already zipped All the view files for All the documents you are uploading into a single zip file.
Using Multiple File upload: 5. Enter the number of documents to be uploaded (approximately) and click Next. 6. At the grid which appears (which has the same number of rows as entered at step 6), populate the fields to reflect the attributes of the documents that you are uploading. Note that the fields are auto populated with the common attribute values entered at step 4 above. 7. Against the first row, click the Browse button to select the first view file to upload and select a view file from your PC or Server and click Open. 8. Repeat step 8 for additional rows. 9. Click Next when done and go to step 15 below. Note the following: (a) You can use the duplicate button to duplicate a record. This will duplicate the attributes of the current document which can then be edited as required. (b) Use the Get Document Details button after entering one or more document numbers at step 7 to populate the grid with the attributes about the documents automatically if the documents already exist in TeamBinder. (c) Using the above screen, only one view file can be associated with each document number. If multiple view files are required for a single document, these must first be zipped on your PC. Then you can browse and select the zip file. In this case, tick the box at the bottom of the screen labelled Unzip the zip file(s) prior to allocating them to the documents. If this is done, the zip file will be uploaded and all files in the zip file will be allocated to the entry.
Using Single Zip file Upload: With this option you must first have zipped ALL view files to be uploaded in this session on your PC. 10. Click the Browse button and select the zip file from your machine and click Open. 11. Click Next. 12. Once the zip file is uploaded a grid with one row for each view file in the zip file uploaded will be displayed. Note that with this option it is possible to associate one or more rows with the same document number. 13. Populate the attributes for each of the uploaded files and click Next.
Completing the Batch upload process: The documents being uploaded are now processed by the TeamBinder validation engine. Any validation errors will be displayed on the far right of the screen and must be corrected before proceeding.
Page 110
Chapter 4 Documents If all documents pass validation, the system will display a list of the files to be transferred to the document register. 14. Check all the details are correct and click Next. 15. Click Finish to complete the upload. The documents uploaded are now distributed automatically [see Section 4.3.05]. In addition to the automatic distribution, if the documents are unrestrained they can be issued by Transmittal to other parties who are not on the automatic distribution list [see Chapter 5].
Notes:
(a) To upload Revised Documents using the Batch Upload Wizard, select the documents to be revised in the document register prior to clicking the Batch Upload Wizard button. The selected documents will be displayed within the wizard without the need to enter their numbers.
4. On receipt of the documents at the TeamBinder server, the documents are unzipped and validated [see Section 4.3.04]. 5. If the documents pass validation they are posted to the document register and distributed automatically [see Section 4.3.05]. The up-loader receives an email notification confirming the successful upload. 6. Documents failing validation are not posted to the document register and a notification is returned to the up-loader by email advising of the reason for validation failure and the action required before re-uploading.
Page 111
Chapter 4 Documents Notes: (a) The document details in XLUPLOAD can be pre-validated before sending if required. (b) Revisions to documents can be uploaded by simply typing the document number in XLUPLOAD and using the Get Data option to download the existing meta data for the document from TeamBinder into XLUPLOAD (which is then updated as required) (c) For more information on XLUPLOAD contact QA Software.
3. On receipt of the documents at the TeamBinder server, the documents are unzipped and validated [see Section 4.3.04]. 4. If the documents pass validation they are posted to the document register and distributed automatically [see Section 4.3.05]. The up-loader receives an email notification confirming the successful upload. 5. Documents failing validation are not posted to the document register and a notification is returned to the up-loader by email advising of the reason for validation failure and the action required before re-uploading. Notes: (a) QCAD supports optional binding of Xrefs using either Insert or Bind methods. (b) QCAD requires AutoCAD 2000 or later for use. (c) For more information on QCAD contact QA Software.
Page 112
Chapter 4 Documents
In all the above cases, users receive notifications by email for the documents they are issued and the documents can be downloaded direct from the notifications themselves from with the users email system by using the hyperlinks provided. It is also possible to download documents in TeamBinder direct from within the document register either singly [see Section 4.4.02] or using a wizard [see Section 4.4.03]. Note that documents a user has access to (has been distributed) that they have not previously downloaded are displayed in blue in the document register for easy identification.
To download a document
1. Select Document Register from the left menu 2. If the filter screen appears, enter the conditions required to locate the document and click OK. 3. Locate the Document to be downloaded. TeamBinder User Guide Page 113
Chapter 4 Documents
Note: If the filter screen does not appear at Step 2, click the Filter button to load it from within the Document Register. 4. Click the Download button underneath the format that you want to download. 5. Agree to the conditions of any download disclaimer that may appear. 6. Save the downloaded document to a location on your PC. Notes: (a) All documents that the user has access to (i.e. has the ability to download), but has not downloaded, are displayed in blue. (b) By downloading at least one format of a document, the system considers you to have downloaded the document. (c) It is also possible to download a document at the document details screen [see Section 4.2.06]. (d) The system stores an audit trail of when and who downloads each document. (e) The download disclaimer is configured on a per project basis and can be removed completely if required via the Project Details [see Section 12.1.03], or switched off for future downloads after first ticking the acceptance box at step 5 above. (f) For a history of who has downloaded documents, run report Documents Download History [see Section 4.5.02].
8. Click Finish. Notes: (c) It is possible after step 6 to use the Previous button to return to the filter screen and filter for additional documents to select for download. (d) The cumulative file size of the documents selected for download is displayed at step 6. (e) The email delivery option can be used to deliver the documents to any email address. (f) The documents being downloaded or emailed will be zipped on the TeamBinder server prior to delivery. TeamBinder User Guide Page 114
Chapter 4 Documents
To Check-Out a document
1. From within the Document Register, locate and then click on the document to be checked out. 2. At the document detail screen, click the Check in/Check out button. 3. Enter a Reason why you are checking the document. 4. If User Access to the documents is to be retained while the document is checked out, untick the Remove User Access option. 5. Click OK. 6. Back at the document details screen, you will see a note at the bottom of the form advising that the document has been checked out. 7. Click Close to return the document register. Notes: (a) Documents can be checked out in bulk by selecting them first within the document register before clicking the Check in /Check out button. (b) The ability to check out a document is restricted to: Any User from Originating company who has access to the document as long as the document is Released. The Project Administrator. Restrained documents (those in a review workflow) can only be checked out by the Review Coordinator responsible for them.
(c) Documents that have been checked out are displayed in the document register with the padlock icon.
To Check-In a document
1. Follow the steps as for Checking Out a document and at step 3, enter the reason for checking the document back in. Notes: (a) Only the person who checked the document out or the Project Administrator can check a document back in. (b) It is not necessary to revise a document before Checking it back in.
Page 115
Chapter 4 Documents
4.5 Reports
4.5.01 Overview
There are a number of standard reports available in TeamBinder related to documents. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. There are four Report on groups relating to documents Documents Document Register. Documents Transmittals [see Chapter 5]. Documents Upload and Download History. Documents Workflow [see Chapter 6]
3. Select Documents Document Register from the Report on drop down list. The reports available are: Document Register Details - by Document Document Register Details - by Current Revision Document Register - Summary Report - by Status and Revision Document Access - by Document Document Access by User Downloaded Only Document Access by User Not Downloaded Only Document Access by Notification by User - Not downloaded Only Document Access by User (All) Document - Subscription History* Discipline Matrix Report* Discipline Matrix Exception Report Documents not linked to Published Reports Documents linked to Published Reports
*Note these reports are located outside of the Documents Document Register report group currently and are listed at the reports screen after selecting Reports from the left menu at the Dashboard. 4. Select Documents Upload and Download History from the Report on drop down list. The reports available are: View Files Upload History* Documents - Upload Summary Report Documents Upload Summary Statistics - by Period, Rev & Sts View Files Download History*
Page 116
Chapter 4 Documents *Note these reports are located outside of the Documents Upload and Download History report group currently and are listed at the reports screen after selecting Reports from the left menu at the Dashboard. 5. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02] (c) See also Customizing reports [see Section 10.2.01].
005
This report is a simple register of the latest revision of documents regardless of whether they are restrained (awaiting release), released or un-restrained, sorted by document number.
Note that security settings such as whether you have access to see All documents or only documents you have access to apply when running this report.
015
This is a powerful cross tabulation of the number of documents uploaded each period (eg Month) to TeamBinder by Revision and Status. On the Y access are listed each Revision + Status combination. On the X axis for each period the number of documents uploaded at that Revision and Status combination is detailed. Note that if say for Rev.0 + Status For Review there were 120 document in March and during April, 20 Documents at Revision 1 and Status Approved were uploaded, March will show 120 documents against Rev.0 and Status FR while April will show 0 documents at Rev.0 and Status FR along with 20 documents at Rev.1 and Status APP. A simple filter is provided when running this report to enable the user to easily select from: Document Status Discipline Type Document No Contains Title Contains Date Range for the report Period (select from Weekly, Fortnightly, Monthly etc.)
Page 117
Chapter 4 Documents
Title Document Access by Document Document Access by User Downloaded Only Document Access by User Not Downloaded Only Document Access by Notification by User - Not downloaded Only Document Access by User (All) Document Subscription History
Description This report details for each document, users with access to it and the formats they each have access to. This report details for each document, users with who have download it, the formats downloaded. This report details for each document, users with access to it but who have not downloaded it. This report is similar to report 025 but considers only documents that a user has been notified about. It is possible to have access to a document without receiving a notification by subscribing, being granted access by the project administrator, or if you have notifications switched off. This report details for each user the documents they have access to and the formats included. The Document Subscription History report allows Administrators to generate a report to see who has subscribed to controlled documents in the register, when they subscribed, and the administrators response to those subscriptions. A simple filter is provided when running this report to enable the user to easily select from: A Company and/or Contact All, Approved, or Rejected Subscriptions A Discipline A Document A Date Range
030
035
040 045
055
The Discipline Matrix Report allows Administrators to generate a report to see what Disciplines of Documents one or more users have as defined in the Discipline Distribution Matrix. A simple filter is provided when running this report to enable the user to easily select from: A Company and/or Contact A Discipline A Document File Format An Access Date Range
Page 118
Chapter 4 Documents
Title Discipline Matrix Exception Report Documents Not Linked to Published Reports Documents Linked to Published Reports Document Comments by Document Deleted Documents by Document
Description This report details for each discipline users who are NOT on the default discipline based distribution matrix. This report details documents in the Master Document Register which have not been linked to a report or category under Published reports. This report details documents in the Master Document Register which are linked to a report or category under Published reports. This report details the text comments made against each document in the Document Register. This report lists all documents that have been deleted.
070
075 080
Report Group: 06 Documents Upload and Download History 001 View Files The View File Upload History report allows users to Upload History generate a report of documents uploaded to TeamBinder across a date range. The report includes who did the upload and the date uploaded. A simple filter is provided when running this report to enable the user to easily select from: Uploaded by Company/Contact Document Status Discipline Document No. Date Range for the report.
Note: This report is located outside of the Documents report group currently and is listed at the reports screen after selecting Reports from the left menu at the Dashboard.
005
This is a powerful cross tabulation of the number of documents uploaded each period (eg Month) to TeamBinder. On the Y axis are listed documents. On the X axis is shown first the Current revision on of the document and then every date a document was uploaded to TeamBinder and under the relevant dates, the revision uploaded.
Page 119
Chapter 4 Documents
Description This is a powerful cross tabulation of the number of documents in the document register at each Status + Rev combination each period (eg Month). On the Y access are listed each Revision + Status combination. On the X axis for each period the number of documents at that Revision and Status combination is detailed. Note that if say for Rev.0 + Status For Review there were 120 document in March and during April, 20 Documents at Revision 1 and Status Approved were uploaded, March will show 120 documents against Rev.0 and Status FR while April will show only 100 documents at Rev.0 and Status FR along with 20 documents at Rev.1 and Status APP. I.e. for any period the total numbers at each Rev + Sts will equal the total number of the latest Revision and Status of documents in the Document Register. A simple filter is provided when running this report to enable the user to easily select from: Document Status Discipline Type Document No Contains Title Contains Date Range for the report Period (select from Weekly, Fortnightly, Monthly etc.)
015
This report allows users to generate a report of documents downloaded from the TeamBinder system across a date range. The report includes who downloaded each document and the date downloaded. A simple filter is provided when running this report to enable the user to easily select from: Uploaded by Company/Contact Downloaded by Company/Contact Discipline Document No. Date Range for the report.
For example it is simple using the above filter to obtain a report for Documents uploaded by company X that have been downloaded by company Y over a date range.
Note: This report is located outside of the Documents report group currently and is listed at the reports screen after selecting Reports from the left menu at the Dashboard.
Page 120
Chapter 5 - Transmittals
5.1 Getting Started
5.1.01 5.1.02 5.1.03 5.1.04 5.1.05 5.1.06 Overview Setup Check List Configuration Tables Default Response Periods Security Issues Notifications
Page 121
Chapter 5 Transmittals
Transmittals are generally used in TeamBinder to issue documents during the construction phase of a project to specific recipients, but can be used at any time to issue specific documents to specific recipients or to issue documents to non-TeamBinder users. The process of issuing documents by transmittal is as follows: 1. The documents to be issued must already exist in the Document Register [see Section 4.3.01] and the user must have access to both the documents and the file formats to be transmitted. 2. A transmittal generation wizard is used to select the documents and recipients for the transmittal(s) [see Section 5.2.01]. 3. A reason for issue, respond by date and message are applied/entered. 4. The recipient receives the transmittal by email from which they can download one, selected, or all of the documents. 5. The system tracks which documents the recipient downloads from the transmittal. 6. Users expedite responses to transmittals they have sent [see Section 5.2.02]. 7. As documents are revised, the recipients are notified automatically unless the option to notify recipients about future revisions was switched off when generating the initial transmittal. 8. The system automatically tracks pending transmittals [see Section 5.2.03] which are documents that have been issued to recipients a later revised but not yet been issued at the latest revision. Pending transmittals are very useful when automatic notification of future revisions is switched off when generating the initial transmittal. Notes: (a) Outgoing transmittals are stored in the Sent Transmittals Register [see Section 5.3.02]. (b) Incoming transmittals (from other TeamBinder users) are stored in the Incoming Transmittals Register with hyperlinks to the source documents [5.4.02]. (c) There is only ever one copy of each view file format for each document in a TeamBinder project. (d) The Format of the Transmittal notification can be customised if required (contact QA Software for more on this charges apply).
Page 122
Chapter 5 Transmittals
These values are used within the transmittal wizard when generating transmittals.
Chapter 5 Transmittals
4. Click Save. Notes: (a) Project Administrators can assign User Access to the Transmittal module for any user. (b) Company Administrators can assign users access to the Transmittal module only if they themselves have access. (c) Users can only see incoming and outgoing transmittals received or generated by their company.
5.1.06 Notifications
The main Transmittal notification is the transmittal itself. Transmittal Notifications cannot be switched off. There full list of notifications in regard to transmittals that TeamBinder sends out is: Notification of Auto Responder for Transmittals Notification of Document Transmittal Notification of Rejected Document Transmittal Notification of Restrained Document Transmittal Notification of Revised Document Transmittal Notification of Superseded Document Transmittal Notification of Transmittal Cancellation
Page 124
Chapter 5 Transmittals
To generate a transmittal
1. Select Transmittals from the left menu and from the drop down menu choose Generate Transmittal. Alternatively: Select the Documents to be transmitted from within the Document Register and click on the Create Transmittals and Packages icon, and select Create Transmittal. OR From within the Sent Transmittals Register, click the New Duplicate button. 2. Choose between the following options and click Next. Latest Documents (Unrestrained/Released): (Default) Used to transmit the latest released revision of one or more un-restrained documents the user has access to. Restrained Documents: Used to transmit documents currently in a workflow [see Chapter 6] to any of the following: Project Administrator; Document Originator; Review Coordinator; or other Reviewers. The use of this option is restricted to be used only by: members of the review team for the workflow in progress; the review coordinator for the discipline the documents belong to; the Document Originator; and the Project Administrator. If this option is selected you are prompted to select the Discipline of the document(s) to be transmitted prior to selecting the documents themselves. Note also that a restrained document transmittal can have only a single recipient. Superseded Documents: Used to distribute older revisions of documents in instances where the latest revision of the document may not be released, or the older revision must be sent to someone outside the system. Rejected Documents: Used to transmit comments and redlines to the Originating Company. Note that this option is restricted and must be enabled on a project by the Project Administrator [see Section 12.1.03]. Free Form Documents: Used to transmit the latest released version of one of more un-restrained documents (as per the Latest Documents option) but with this option the user types the document numbers for the documents to be transmitted rather than selects them from the register.
3. If the Latest Documents option is chosen, the next step is to choose between the following two options for the selection of documents and click Next. The Entire Register (Default): This option will allow the user to select the latest revision of un-restrained documents from the entire register subject to any filter conditions they apply. Previously transmitted that are now superseded: This option will filter the register automatically for pending transmittals [see Section 5.2.03].
4. Select the recipients that you wish to send the transmittal to by moving them to the right of the screen and click Next when done.
Page 125
Chapter 5 Transmittals If the recipients are to be automatically notified about future revisions of the documents being transmitted, tick the option to Notify users of future revisions with download facility in notification. 5. Apply a filter conditions to assist with the selection of documents and click Next. Note that if the user is generating a Transmittal of Rejected, Restrained or Superseded documents, the system will also further filter for documents falling into the respective category. 6. Select the Documents and Document Formats to transmit by ticking the required View File formats next to each document number. Note that the formats that are ticked will be the formats that the recipients have access to download. Note also that it is possible to include public Text or File Attachment comments relating to the documents using the Include Comments tick box. 7. To verify your selections, click the Show Selected only tick box. Check the correct documents are selected and click Next. 8. Populate the remaining details of the transmittal including: Reason for issue [see Section 5.1.03]. Respond by message [see Section 5.1.03]. Respond by date [see Section 5.1.04]. Transmittal message.
9. Tick the Request Read Receipt option if required. This facilitates auto update of the transmittal acknowledgement date [see Section 5.2.02]. 10. Click Next and then Finish. 11. You will see a view of the generated transmittal. Print a hard copy of the transmittal here if required. 12. Click Close to return to the Sent Transmittals Register. Recipients will be sent the transmittal notification via email. Once received, they will have the facility to download the transmitted documents directly from the transmittal. Comments in relation to documents on the transmittal (if selected during the transmittal process) can be downloaded by the recipient using the comments icon. There is also a link on the transmittal to download all the files on the transmittal in one go. By clicking the Click here to download view files associated with this transmittal option on the transmittal, the recipient is presented with a list of all the transmitted documents (all of which are selected by default) from where they can fine tune which documents they wish to download. Notes: (a) Outgoing Transmittals are stored in the Sent Transmittals Register [see Section 5.3.02]. (b) To quickly create a transmittal that is very similar to a previous transmittal, use the New Duplicate button from within the Sent Transmittals Register [see Section 5.3.02]. (c) If the Recipient is not listed in the Address book at Step 4 it is possible to add new recipients on the fly (subject to the normal TeamBinder security on who is able to add new contacts).
Page 126
Chapter 5 Transmittals (d) It is possible in to use the concept of Contact Groups as the means for selecting recipients within the Transmittal Wizard. Simply click the Select Contact Group option at the Select Recipients screen of the Transmittal Wizard. This works in the same way as when using Contact Groups with mail [see Section 3.3.06]. (e) Selected fields on the last page of the transmittal generation screen can be made mandatory if required (such as Reason for Issue). [See Section 12.4.10]. (f) To generate a preview of the transmittal before completing the transmittal process, click the Preview the Transmittal button on the final page of the Transmittal Wizard. Note that the Transmittal if previewed and then printed, will have a heading DRAFT stamped on it as it may not be sent if the transmittal process is not completed. (g) If Free Form Documents is selected at step 3, rather than use a filter to select the documents the user must enter the document numbers manually at step 6. 1. Click the New button to enter the first document number. 2. Click the Refresh button to validate the number entered. The remaining details about the document will be populated automatically. 3. Repeat for additional documents. (h) If there are public redlines associated with the document being transmitted, the recipient can download these if required. The steps for this are: 1. 2. 3. Use the Click here to download view files associated with this transmittal option on the transmittal notification. You will then see a list of documents (requires the recipient be connected to the internet). Click the Viewer icon against a document to view. The TeamBinder document viewer TeamView will now load.
(i) If there is already a later revision of a document in TeamBinder than the version on the transmittal that the recipient has access to, when they download the document from the transmittal they will be prompted to also download the later revision. (j) To print a report of transmitted documents that have not been downloaded by the recipient [see Section 5.5.02]. (k) To immediately create additional transmittals, tick the I have more transmittals to create box at the last page of the transmittal wizard. (l) To Resend a transmittal [see Section 5.3.03]. (m) To Cancel a transmittal [see Section 5.3.04].
Acknowledgements
A Transmittal Acknowledgement is traditionally a signed copy of a transmittal returned by the recipient to the originator of the transmittal to acknowledge receipt of the transmittal and the drawings or documents it contains.
Page 127
Chapter 5 Transmittals In TeamBinder, acknowledgements are updated automatically if the recipient chooses to send an acknowledgement when downloading the documents from the transmittal. When recipients download documents from transmittals they are prompted to acknowledge receipt (assuming the request read receipt option was ticked by the sender). If they click Yes to this prompt the transmittal will be updated at a recipient level as acknowledged automatically. Transmittal acknowledgements can be also be updated manually via the Sent transmittal register [see Section 5.3.02] at either a Transmittal or Recipient level.
Responses to Transmittals
It is possible to track outstanding responses to transmittals using the Management Summary at the Dashboard which has options to view Transmittals with responses outstanding and responses overdue [see Section 2.2.04]. To update that a recipient has responded to a transmittal, update the Response date via the Sent Transmittals Register [see Section 5.3.02] either at a Transmittal or Recipient level.
Page 128
Chapter 5 Transmittals
Notes:
(a) Pending transmittals are created even if the option to Notify users of future revisions with download facility in notification is ticked when generating transmittals. Even though in this case the user will receive an automatic notification about the revised documents, they will not have been formally transmitted them and it is considered prudent to maintain pending transmittals in this scenario.
Notes:
(a) It is not mandatory to transmit revised documents in TeamBinder using the above method. The latest revisions can be selected using the Entire Register option within the Transmittal Generation Wizard if preferred. Pending Transmittals will still be updated correctly. (b) See also Generating Outgoing Transmittals [Section 5.2.01]. (c) It is possible to stop sending notifications about the latest revision of documents to recipients who received the documents via Transmittal and at the same time stop creating pending transmittals for these recipients. This is done via the Change Document Access Wizard [see Section 11.4.07].
Page 129
Chapter 5 Transmittals
Hot List:
Transmittal No. Contains: Message contains: Reason for issue contains: Package Contains: Document No contains: Date Sent: Acknowledgement Received: From: To:
3. Apply the filter conditions as required and click OK. The Sent Transmittals Register will be displayed [see Section 5.3.02]. Notes: (a) It is possible to change the default of 1 day for the Date range in the Date Sent To and From fields [see Section 3.2.02]. (b) Use the Save button to save your filter settings. You will be promoted to enter a Title for the saved settings. You can then use the Load button to load any saved settings rather than reselect them each time you use the filter screen. (c) Use the Detail Filter button for a full SQL type data search [see Section 4.2.03].
Page 130
Chapter 5 Transmittals
Note that the Sent Transmittals also stores all notifications sent via the Packages module [see Chapter 7].
Page 131
Chapter 5 Transmittals
Page 132
Chapter 5 Transmittals
Hot List:
Transmittal No. Contains: Message contains: Reason for issue contains: Package Contains: Document No contains: Date Received: From: To:
3. Apply the filter conditions as required and click OK. The Incoming Transmittals Register will be displayed. Notes: (a) It is possible to change the default of 7 days for the Date range in the Date Received To and From fields [see Section 3.2.02] (b) Use the Save button to save your filter settings. You will be promoted to enter a Title for the saved settings. You can then use the Load button to load any saved settings rather than reselect them each time you use the filter screen. (c) Use the Detail Filter button for a full SQL type data search [see Section 4.2.03].
Page 133
Chapter 5 Transmittals
Note that the Incoming Transmittals also stores all notifications received from other users via the Packages module [see Chapter 7].
5.5 Reports
5.5.01 Overview
There are a number of standard reports available in TeamBinder related to Transmittals. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Documents - Transmittals from the Report on drop down list. The reports available are: Transmittal Details - By Transmittal No. Transmittal Details - By Recipient (Contact) Transmitted - by Document - Not Downloaded only Transmitted - by Recipient - Not Downloaded only Pending Transmittals - by Document Pending Transmittals - by Recipient (Contact) Pending Transmittals - by Company Recipient Document Register - by Document Recipient Document Register - by Recipient (Contact) Recipient Document Register - by Company Document Distribution Matrix
4. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. TeamBinder User Guide Page 134
Chapter 5 Transmittals
Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02] (c) See also Customizing reports [see Section 10.2.01]
015
020
025
030
035
040
Page 135
Chapter 5 Transmittals
Description This report is as per Report 040 but is generated for each company, regardless of which user in a company has been issued the documents by transmittal. If document was transmitted to several users in the same company it will only be listed once for the company on this report. This is a cross tabulation report with documents on the Y axis (grouped by Discipline) and companies on the X axis and is used to detail which companies have access via transmittal to which documents. Access is indicated by showing the last revision sent against the document under each company that has access to the document.
050
Page 136
6.3 Reports
6.3.01 Overview 6.3.02 View Review Progress Status 6.3.03 Available Reports Listing
Page 137
TeamBinder automates and expedites the above process as far as possible using a combination of concepts unique to TeamBinder and automatically generated notifications and reminders. Firstly the requirement for a document to be reviewed (passed through a workflow) is determined automatically by TeamBinder via the document Status [see Section 4.1.04]. A document status that is defined as restrained requires a review workflow before it is released. On projects where all documents require review before being released to other parties, all status values can be made restrained if required. Typically however during the design phase of a project, documents are exchanged quite freely between engineering consultants without the requirement for a formal review workflow for each issue and hence most projects use a combination of Restrained and Unrestrained status values. After successful upload of restrained documents, the Review Coordinator is notified automatically by email. The Review Coordinator is a specific role in TeamBinder that is allocated on a per discipline basis to activate workflows, review progress, and manage the release of documents once the review is complete. The Review Coordinator activates the work flow to either a predefined discipline based review team (that can be adjusted as required on a per document basis) or to a custom review team. Where formal procedures are in place for reviews, the activation process can be fully automated so that reviews commence immediately for documents that are uploaded and require review, without waiting for the review coordinator. The reviewers are notified by email about documents requiring their review and use a Review Wizard to review and record their comments which can consist of redlining the drawings, making text comments, and attaching external files such as sketches or word documents. Reviews can be conducted in Series (each reviewer reviews in turn) or Parallel (all reviews take place at the same time). TeamBinder sends out automatic email reminders to reviewers who are late in reviewing documents based on predefined schedule requirements setup within the workflow. The review coordinator can also be notified of these delays if required.
Page 138
Chapter 6 Workflow - Documents Once all reviewers have completed their reviews, the review coordinator is notified and uses a Release Wizard to complete the workflow. Within the Release Wizard the review coordinator can make their own comments, consolidate the comments of other reviewers, and attach external files and most importantly, apply a Review Status. The Review Status is the formal result of the review process and controls whether the document will be released to others or rejected and returned to the originator. If the Review Status applied (eg Approved) means the document will be released, the system then distributes the document automatically as a released document [see Section 4.3.05]. If the document is rejected, the originator is notified by email with the comments and reasons and takes the necessary action. The document is not released but is stored as a rejected document. The period of time between all reviewers completing their reviews and the release of the documents is also tracked with notifications of delays being auto sent by the system. The diagram below gives an overview of a typical workflow in TeamBinder:
Page 139
Page 140
Chapter 6 Workflow - Documents Review Workflow Type: Choose between Serial, Parallel, and Single as the Workflow type for document reviews. With Serial reviews, reviewers review documents in sequence. With Parallel reviews all reviewers review documents at the same time. With Single reviews the review is completed by the review coordinator alone directly within the release wizard. Remind Reviewers Every: Enter an Interval in days for the auto sending of reminders to reviewers if they are late with their review of documents. For example, Joe Smith was due to review a document by the 01/07/2004, however on the 10/07/2004, Joe still has not completed the review, if the reminder reviewers every interval was set to 2, Joe would be sent an email reminder every 2 days after the 01/07/2003 reminding him that a document review is outstanding. Notify Review Coordinator of delays in the review process: Tick this box if the Review Coordinator wants to be notified by email of any delays to the review process (this is in addition to the standard notification sent to the individual reviewers. Duration allowed for Release: This is the period in days scheduled from the time the review is completed by all reviewers until the release should be made. Notify Review Coordinator of delays in the release process: Tick this box if the Review Coordinator wants to be notified by email of any delays to the release process. Notify Admin of delays in the release process: Tick this box if the Project Administrator needs to be notified by email of any delays to the release process. Automatically Activate the review workflow: Tick this box if restrained documents of this discipline are to be routed into the workflow automatically on upload. For serial workflows the first reviewer will be notified, for Parallel workflows all reviewers will be notified. If un-ticked, only the review coordinator is notified about restrained documents uploaded for review. The review coordinator then manually activates the workflow (using the default discipline or custom review team) and can add/delete members from the Review team or change the reviewer sequence for the document(s) if required before initiating the review process. Notes: (a) Only the Project Administrator can add/edit or delete the workflow settings above. (b) Notifications activated via Workflow Settings can be switched off for individual users via User Preferences [see Section 3.2.08].
Page 141
Target Review Duration This is the target document review period in working days. Total Review Duration This is the contract document review period in working days. 5. From the left hand side of the screen, select the company and users that you wish to add to the document review team. Note that it is also possible to select the contacts for the review team from pre-defined free form review teams [see Section 6.1.06]. Click the Display Review Teams option and then click on one of the Review Teams and the members of that review team will be moved to the right hand side of the screen. 6. Once added to the left hand side, you will need to assign the following attributes against each reviewer: Sequence This sequence determines the order in which each reviewer will receive the documents for review. Users with the lowest sequence will receive the document first. Once that user has completed his or her review, the person with the next lowest sequence will receive the document for review and so on until all reviewers have completed their reviews. Note: If using Parallel reviews the sequence will be the same for each user, as all users receive the documents simultaneously. Duration This is the duration, in working days, allowed for each user to complete their review. After this period, if the user has not completed their review, they will be notified that they are delaying the review process. Note: The combined total duration for all users should not exceed the Total Review Duration. 7. Click Save. Notes: (a) Discipline Review Teams can only be configured by the Project Administrator or the Review Coordinator for the Discipline. (b) See also Free form Review Teams [Section 6.1.06]. (c) See also Modifying an in-progress workflow [Section 6.2.05].
Page 142
5. Locate the Review Team added to the list and click on the Add/Remove link under the Members column. 6. Enter the Target Review Duration and Total Review Duration (for free form review teams these values are for information only). 7. Select the company that contains the first review team members and move required contacts from the left hand side of the screen to the right to add them to the review team. Repeat for other companies. 8. On the right hand side of the page, enter the Sequence and Duration for each reviewer [see Section 6.1.05]. 9. Click Save. Notes: (a) Free Form Review Teams can only be configured by the Project Administrator or Review Coordinators.
Page 143
Chapter 6 Workflow - Documents 3. Populate the Subject and Message that will be sent to the Review Coordinator as the away mode message. 4. Enter the date range that the away mode will be active for. 5. Tick the box labelled Make Auto Responder active for the date range above to activate the Auto Responder. 6. Tick the box labelled Send me a sample notification to be sent a sample notification to your email address. 7. Click OK. Notes: (a) The away mode will remain in place until you un-tick the box at step 5 above.
Page 144
Chapter 6 Workflow - Documents If Auto Activation of the review process is enabled for the discipline the document(s) belongs to, the first reviewer in the discipline based review team is automatically notified that they should complete their review. (for Parallel based reviews, all review team members are notified) [see Section 6.2.06]. If Auto Activation of the review process is disabled for the discipline, the review coordinator is notified that a restrained document has been uploaded and that they should activate the workflow [see Section 6.2.03]. If a Restrained document is uploaded against a Discipline that does not have a review team defined, the review coordinator will be notified with a CC to the Project Administrator.
Page 145
Chapter 6 Workflow - Documents (b) It is possible to modify the default discipline based review team during the activation process by clicking the Add/Edit Workflow members link at step 4 above. The default review team members will be listed on the right of the screen and can be removed or added to as required. The changes only apply to the document against which you clicked Add/Edit. Click Save and then Close and you will be prompted to activate the workflow (for this document). (c) Note that it is possible for a document to pass through the workflow module more than once at the same revision if say an additional view file is uploaded. If a restrained document that has been released is edited by the originator, even if the revision and/or status are not changed, the document is automatically available for workflow activation again. When activated in this scenario (i.e. the revision has not changed) the workflow will be considered as Level 2.
Page 146
Chapter 6 Workflow - Documents 9. Enter the Target and Total Review Durations for the review [see Section 6.1.05]. 10. Click Save to activate the workflow and click OK at the confirmation message. Notes: (a) The first reviewer (for serial reviews) or all reviewers (parallel reviews) will be notified by email automatically to complete their review(s). (b) Click Close at step 10 to return to the list of documents awaiting activation without activating the review.
The Review wizard is also used to indicate that a reviewer has completed their review (the date of which is captured) and this initiates an email notification to the next reviewer in sequence and a notification to the review coordinator informing them that the reviewer has finished.
Page 147
Page 148
The Review Coordinator is also responsible for selecting any of the comments and/or redline markups made by individual reviewers are included in the final comments for the document that are distributed back to the originator and/or to the review members. Note that all reviewers comments are always stored by TeamBinder and the Review Coordinator cannot change any of the comments made by individual reviewers. The decision is simply whether to include or exclude individual reviewers comments from the final comments list. 5. Click the Add/Edit button in the Comments column and enter your reviewer comments as the review coordinator [see Section 6.2.06]. If you have already applied a Review Status that will result in the document being released you will also have an option to apply the same comments to other documents with a similar review status using the Apply to all released documents tick box. This will copy the same comment you have made as the review coordinator to these other documents. To include comments and/or redline markups made by other reviewers, click the link labelled Select Reviewer comments to include with your summary. Select the comments to include by ticked the boxes against them. To view any attachments reviewers have with their comments use the Paper clip icon and click Download when prompted. Click Close when done. On completion of entry of your comments, click OK to close the Review Coordinators comments window. 6. It is also possible within the Release wizard to attach an additional View file to the document [see Section 12.1.03 to enable this option]. This is not the same as adding attachments to comments. To add an extra view file, click the Paper Clip icon and select a view file to be added to the document. 7. To release the documents for which you have completed the above steps, click Next.
Page 149
Chapter 6 Workflow - Documents 8. Finally select to whom you want to send the final comments. The options are the Originator and/or the work flow members and/or the Document Recipients 9. Click Finish. Notes: (a) If the document is released: The document is distributed automatically [see Section 4.3.05] using email notifications. (b) If the document is rejected: The originator of the document is notified that the document was rejected. Users in the same Company as the originator of the document retain access to the rejected document via the Document Register subject to the normal Discipline matrix access rules. (c) The Document Register is updated with the Review Status applied. (d) Comments and/or Redline layers applied directly by the Review Coordinator and those of other reviewers selected by the Review Coordinator as part of the release process become the public comments visible after the document has been released via the Document Register. (e) To include all reviewer comments by default when releasing documents, activate the setting to Include reviewer comments when releasing documents via the Project Details [see Section 12.1.03]. (f) If while using the release wizard you would like to see which documents you are about to release, click the Show Released option at the bottom of the screen. (g) To see only documents you have not released while working on the wizard, click the Show Other option at the bottom of the screen. (h) TeamBinder can be configured to automatically stamp an approval signature, date and status into an image of the document (normally a Tiff file) so that the approved document when printed always contains this information. (Contact QA Software for information on QPRINT if this is of interest. Charges apply).
6.3 Reports
6.3.01 Overview
There are a number of standard reports available in TeamBinder related to Workflows. There is also an option within the Document Register to quickly monitor the review status of any document and where it is in its workflow [see Section 6.3.02]. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Workflow from the Report on drop down list. The reports available are: Review Summary - by Discipline Review Summary - by Document Review Details - by Reviewer Review Details - by Document Reviewer Comments - By Document Review/Release Summary By Document Review/Release Summary By Review Coordinator and Document
Page 150
4. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02]. (c) See also Customizing reports [see Section 10.2.01].
Page 151
Page 152
Description This report lists documents that have passed through a workflow or are currently in a workflow (even if not yet activated) and for each document details the text based comments made by each reviewer. This report lists the release status of each document that is either in or has passed through the workflow process. For each document the Review Coordinator is listed with the following information: Total Days Scheduled for the release process (between completion of the review by all reviewers and the release). Total Days To-date which is either the actual days to date since the review coordinator was notified that the reviewers had completed their reviews (for documents not released), or the actual days taken for the release process (for released documents). Total Days left which for released documents = 0, and for documents in the process of being released is the scheduled completion date less the system date in days. The report also details the Scheduled and Actual Completion dates for each document in regard to the release. Finally the Status is listed. When running this a number of useful filter options are available such as running the report only for documents where the release is due in the next X days.
025
030
This report is similar to report 025 except that the report is sorted by Review Coordinator and then Documents (so that all documents relating to a Review Coordinator are grouped together) rather than just by Document Number.
Page 153
7.7 Reports
7.6.01 Overview 7.6.02 Available Reports Listing
Page 155
The difference between a Tender Package and a Standard Package is that at Tender Package moves through a Tender cycle as detailed below whereas a Standard Package is simply a grouping of documents and recipients which can then be issued for any required reason. The business process for Tender Packages is: 1. Upload documents (eg Tender documents) to TeamBinder 2. Create a Tender Package and assign Documents and Recipients (eg Tenderers) to it. 3. Release the Package for Tender. 4. Upload any additional documents to TeamBinder during the tender process (if required) 5. Release any addendums to Tender during the tender process. 6. Close the Package for bidding. 7. Award the Tender to one company. 8. Close the Package when the work it relates to is complete. TeamBinder uses a concept or Private and Public Tender Packages. Private Tender Packages are released for tender to nominate companies selected from within the TeamBinder address book. Public Tender Packages are created and released from within TeamBinder, also to nominate companies from within the address book but in addition are accessible to anyone with access to the internet. Both Private and Public Tender Packages require the use of QA Softwares TenderDocs secure web site (contact QA Software for more information on TenderDocs). Note finally that all notifications issues as part of the Package Module such as Release of Tender, Addendums to Tender, Award of Tenders are treated as Transmittal notifications and automatically added to the Sent Transmittals Register and Incoming Transmittals Register.
Page 156
Notes: (a) Project Administrators can assign User Access to the Packages module for any user. (b) Company Administrators can assign users access to the Packages module only if they themselves have access. (c) Users can only see incoming and outgoing package notifications received or generated by their company regardless of their user access settings.
For Standard Packages: Notification of Package Issue Notification of Addendum to Package Notification of Change of Package Information
Page 157
Chapter 7 Packages and Tenders 2. At the What Package Items do you want to see? window select Tender Package as the Package Type option. 3. Apply any filter conditions as required and click OK Note the Filter options for Tender Packages are: Package ID Title Contains Phase drop down list Security (Any, Public or Private) 4. At the package register, click the New button and select Tender Package. 5. Populate the details of the tender package ensuring that all the fields mandatory fields marked with a red asterisk (*) are populated. The fields at the tender package details are: Field Package ID* Package Title* Package Phase Awarded To Hardcopy of Documents available from Company and Contact Design Release Tender Release Tender Close Tender Award Start on Site Finish on Site Description Package identifier. Package Title. Package Phase. Company the package has been awarded to. Select the Company from where a hardcopy of a tender package can be obtained. Enter the Schedule, Forecast dates for this event. The Actual date is updated by the system. As above. As above. As above. As above. As above.
* Means the field is mandatory. Fields in Italics are maintained by the system 6. Click the Save button. The tender package will now be created and added to the packages register. The next steps are: Add Documents to the Tender Package [see Section 7.2.02]. Add Recipients to the Tender Package [see Section 7.2.03].
Notes: (a) Packages with similar details can be created quickly by first selecting the package to duplicate and then clicking the Duplicate button.
Page 158
Page 159
Page 160
Chapter 7 Packages and Tenders 6. The recipients allocated to the tender package will be displayed. These recipients will each receive an invitation to tender. If correct click Next (otherwise cancel the process and modify the tender package recipients). Skip the above step for Public Packages with no recipients. 7. Review the details of the invitation to tender notification and enter a message to include on the invitation. 8. If you require a read receipt from each recipient tick the Request Read Receipt option. 9. Click Next and then Finish. Notes: (a) For both Private and Public tenders, package recipients will each receive an invitation to tender email notification which includes the login details for the TenderDocs website. The Tender documents can be downloaded one by one or as a group from within the email notification by the recipients (b) The Invitation to Tender email notification is stored as a transmittal in the Sent Transmittals Register [see Section 5.3.02]. (c) Use the Preview button to preview a copy of the Invitation notification. (d) Both Public and Private Packages will be available via the TenderDocs website but Private Packages will require a logon [see Section 7.4.01] (e) For Public packages it is necessary to know the name of the company issuing the tender to access the tender packages via the TenderDocs website [see Section 7.4.01]. (f) Tender Packages can be resent if required by any user within the same company that created the package (subject to access to the Packages module).
This is managed using Addendums to tender. Addendums to tender relating to new or revised documents can only be issued once the new or revised documents are uploaded to TeamBinder and released in the normal way [see Section 4.3.01] and allocated to the Package [see Section 7.2.02]. Note that it may also be necessary to Add/Remove recipients from the tender [see Section 7.3.03]. This is certainly the case for Public packages as all recipients who have indicated they will submit prices need to be advised of the additional information via the addendum.
Page 161
Chapter 7 Packages and Tenders 5. The list of Recipients currently active for the tender will be displayed [see Section 7.3.03]. These are the recipients who will receive the addendum to tender. Review the list and if correct, click Next. A list of documents allocated to the tender package that have not been previously released to tenders (either when the package was first released or by previous addendums) will be displayed. 6. Select the documents to include in the Addendum to Tender and click Next. Note: To see only New (Documents not currently in the package), Revised (Revised versions of documents that are already in the package), or Superseded (Superseded Revisions of Documents in the package) Documents, use the tick boxes at the bottom of the screen as required. 7. Review the Details that will be sent out on the addendum to tender, and enter the Reason for the issue of the addendum (mandatory) and the Message that is to appear on the addendum notification (optional). A Read Receipt will be requested by default. Un-tick the Request read receipt box if required. 8. Click Next and then Finish. Notes: (a) For Private tender packages, the recipients will now each receive the addendum to tender email notification. (b) For Public tender packages it is essential that the recipients who have indicated they will be submitting bids are added to the Address book and then the Package before creating the addendum to tender. It is not possible to issue Addendums to tender for packages that do not have any recipients allocated. (c) The Addendum to Tender email notification is stored as a transmittal in the Sent Transmittals Register [see Section 5.3.02]. (d) Use the Preview button to preview a copy of the Addendum notification.
7. Click the Close button and click Yes when prompted. You will be prompted to send the Recipient being added: The Original Tender Package Documents sent out when the tender was first released. Any Addendums sent.
You can also select to date the Invitation to tender they will receive based on the current date or original dates at time of issue.
Removing recipients
To de-activate recipients who decline to bid on a tender package released to them: 1. Select Packages from the left menu and select Edit/Create packages. 8. Select Tender Package as the Package Type option and apply any filter conditions as required and click OK. 2. From within the Package Register, locate the tender package and click the link for Recipients. 3. At the Recipients screen, locate the Recipient to be removed and un-tick the Active tick box next to them. This will stop any future addendums being sent to this recipient. 4. Click Yes when prompted.
Page 163
Page 164
To award a package
1. Select Packages from the left menu and Package Maintenance Wizard from the drop down. . 2. At the Select an Option screen click the Tender Package option and then select Award Package and click Next. Tender packages currently closed for bidding but not yet awarded will be listed. Note it is possible to award a tender package that has not yet been released for tender by ticking box labelled Show Pre-release Packages. These packages will then be added to the list. 3. Select the tender package to be awarded by ticking the box next to it and click Next. 4. Select the company to award the package to by ticking the box next to it and click Next. 5. Select the users from the company who should be given access to the tender package documents from within TeamBinder by ticking the select boxes next to them. 6. Tick or un-tick the box labelled Notify users of future revisions with download facility in notification as applicable. Ticking this box will ensure that the users within the company being awarded the package are notified automatically of the release of any revisions to the package documents post award. If un-ticked, future revisions will have to be managed via Pending Transmittals [see Section 5.2.03]. 7. Click Next and then Finish. Notes: (a) An email notification will be sent to the company selected informing them that they have been awarded the tender package. This email will also include the login details to TeamBinder for ongoing access to the documents included in the package. (b) Email notifications will be sent to the unsuccessful companies advising them that they were unsuccessful.
Page 165
Chapter 7 Packages and Tenders 3. Select the tender package to Close Out by ticking the select box against it and click Next. 4. Click Finish. Notes: (a) Access to the documents in the tender package will be removed only for the users who were granted access to the documents via the package award process.
The Reason for Issuing the Package is populated via a drop down selection from the Configuration table of Reasons [see Section 5.1.03]. If OTHER is selected then the Reason must be entered manually. Approximate Value Approximate value of the package (optional) Preferred Format Preferred file format for documents. Long Title A long title for the package Details Any further details * Means the field is mandatory. TeamBinder User Guide Page 166
Chapter 7 Packages and Tenders 6. Click the Save button. The standard package will now be created and added to the packages register. The next steps are: Add Documents to the Standard Package [see Section 7.2.02] but select Standard Package at step 3. Add Recipients to the Standard Package [see Section 7.2.03] but select Standard Package at step 3.
Notes: (a) Packages with similar details can be created quickly by first selecting the package to duplicate and then clicking the Duplicate button.
Page 167
7.7 Reporting
7.7.01 Overview
There are a number of standard reports available in TeamBinder related to Packages. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Packages from the Report on drop down list and select from the available reports. 4. When running any of the reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02]. (c) See also Customizing reports [see Section 10.2.01]. (d) Note that only packages created by users in your company will be shown on reports.
This report lists documents released for tender and for each document details the Recipient, the documents they have downloaded and the date downloaded. This report lists all tender packages that have been issued for Tender. This report lists all tender packages that have been issued for Tender and includes recipient details. This report lists all Standard Packages that have been issued. This report lists details of all tender packages that have been awarded.
005 010
Packages Sent Summary Report Packages Sent Detailed Report Standard Package Documents Issued and Downloaded Only Package Award Details By Package
015 020
Page 168
Chapter 8 Tasks
8.1 Getting Started
8.1.01 Overview 8.1.02 User Preferences - Task Status 8.1.03 User Preferences - Notifications
8.3 Reporting
8.3.01 Overview 8.3.02 Available Reports Listing
Page 169
Chapter 8 - Tasks
Page 170
Chapter 8 - Tasks 1. From the Administration menu select User Preferences under the General group of options. 2. Click the Notifications tab 3. Tick or Un-tick the box against Tasks to switch on or off all task related notifications. 4. To switch on or off specific notifications, click the Select Notifications link. 5. The full list of task notification types is as follows: Notification of Auto Response for Tasks Notification of Automatic Task Status Reminder Notification of New Task Notification of Task Cancelling Notification of Task Change Notification of Task Completion Notification of Task Deletion
3. Scroll to the bottom of the New Task window and link or associate the tasks with one or more work items from the various TeamBinder modules. Note that when any of the modules are selected, the standard filter for that module appears to enable selection of the work item. To remove a linked work item, click the X under Remove. 4. Finally click the Save button and then Close. An email notification will now be sent to the user to whom the task is allocated.
Page 171
Chapter 8 - Tasks
8.3 Reporting
8.3.01 Overview
There are a number of standard reports available in TeamBinder related to Tasks. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Tasks from the Report on drop down list and select from the available reports. 4. When running any of the reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02]. (c) See also Customizing reports [see Section 10.2.01].
Page 172
Chapter 8 - Tasks
Report Group: 020 - Tasks 005 Summary report on Tasks assigned to me 010 Summary report on Tasks created by me
Lists all tasks assigned to the logged in user. Lists all tasks created by the logged in user and assigned to others.
Page 173
Chapter 9 Defects
9.1 Defects Register
9.1.01 Overview 9.1.02 Defects List
9.2 Reports
9.2.01 Overview 9.2.02 Available Reports Listing
Page 175
Chapter 9 Defects
The uploading of the IDMS Project Inspection results and defects is managed from within the IDMS System. See the IDMS User Guide for Details. For more information on IDMS, contact QA Software.
Page 176
Chapter 9 Defects Contractor: Select a company to see the inspection results (including defects) for that company only. Select a building to see the inspection results for. Both, Completed, Not Completed: This refers to whether a defect is closed out (completed) or not yet fixed (not completed). Both, Passed, Not Passed: This refers to whether an inspection item passed inspection or whether defects were found. To see for example all not yet fixed defects, select Not Completed and Not Passed. The Defects List will now be displayed. The fields on the Defects List are explained below: Field Defect # Building Area Location Room Item Sub Item Defect Passed Fix Claimed Completed Notes Orient Position Responsible Company Batch Number Inspection Company Last Saved Completed Completed by Company Forecast Estimated Hours Estimated Cost Description A Unique Defect Number. The Building the inspection item is located in. The Area the inspection item is located in. The Location the inspection item is located in. The room the inspection item is location in. Description of Item the defect relates to. Description of Sub Item the defect relates to. Description of Defect Yes/No as to whether the item passed inspection. Ticked if the responsible company claims they have fixed the defect. Ticked if the defect has been satisfactorily rectified as verified by re-inspection. Notes Orientation of the defect (eg North, South) Position of the defect. (eg Upper, Lower) Company responsible for rectifying the defect. The batch number allocated to the download of the inspection results that this item was included in when downloading from the Pocket PC to IDMS on the PC. The company who inspected the item. The date information about the defect as last updated. This is the person who recorded the defect had been rectified satisfactorily (completed). This is the company the above person belongs to. This is the forecast completion date. Estimated hours to rectify the defect. Estimated Cost to rectify the defect.
Building: Show:
Notes: (a) Access to the defects list is controlled via Configure User Access to Modules from the Administration menu and can only be granted by the Project Administrator or Company Administrator (if they themselves have access).
Page 177
Chapter 9 Defects
9.2 Reporting
9.2.01 Overview
There are a number of standard reports available in TeamBinder related to Defects. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Defects from the Report on drop down list. The reports available are: Defect Statistics - Summary - by Contractor Defect Statistics - Summary - by Contractor + Area Defect Statistics - Summary - by Contractor + Room Defect Statistics - Detailed - by Contractor
4. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [see Section 10.1.02]. (c) See also Customizing reports [see Section 10.2.01].
Report Group: 03 - Defects 001 Defect Statistics - Summary by Contractor 005 Defect Statistics - Summary by Contractor + Area
This report is a graphical summary by contractor of number of defects, total completed and total outstanding. This is a summary by Building and Area for each contractor of total defects, total claimed as fixed, total completed and total outstanding. This is as per report 005 but reports at a greater level of detail down to each Room. A detailed register of defects sorted by responsible contractor.
010 015
Page 178
Chapter 10 - Reports
10.1 Standard Reports
10.1.01 Overview 10.1.02 Generating Standard Reports 10.1.03 Using Filters
Page 179
Chapter 10 Reporting
When running module specific reports the security settings that apply to each module apply for the reports to. For example if a user has access to personal mail only, then when running mail related reports, regardless of filters applied, they will only ever being able to report on personal mail items.
The reports available for the selected module (Standard and Custom) will be listed. 4. Select the report that you wish to generate by clicking on it.
Page 180
Chapter 10 Reporting
5. Click OK to run the report. 6. Apply any necessary filter conditions to limit the data included on the report (optional) [see 10.1.03] and click OK. Your report will be now be generated. Notes: (a) To export the report to a CSV file format (which can be opened by MS Excel) click the CSV option under Print before step 5 above. (b) To use a Custom Title on the report, tick the box against Custom title and enter the required title before proceeding to Step 5. (c) To restrict the maximum number of records downloaded to the report (the default is 10,000) enter the required maximum in the field provided before proceeding to Step 4. (d) To develop customised versions of the standard reports [see Section 10.2.01].
Note that most of the Standard Reports have inbuilt filter conditions such as Mail Outstanding and at the filter window you are simply adding further conditions. Each row of the filter has three columns: The Field Name to filter on. The filter condition. The data to filter for.
To setup the example filter conditions above you would be selecting: Field Name For Mail COMPANYID For Documents DISCIPLINE Condition Equal to Equal to Value QAS S
The Filter can contain as many lines as required. The rows are joined together using the AND or OR options. An example of a multi lined filter for Documents could be: Field Name DISCIPLINE DOCUMENTNO Condition Equal to Begins with Value S S-1 And/Or And
Page 181
Chapter 10 Reporting Such a filter would restrict the documents selected to those that have numbers starting S-1 AND belong to the Discipline = S Notes: (a) If the Field name selected to filter on is normally populated by values from a configuration table, the data to filter for field will change to a drop down list to select a value from. (b) It is also possible to control the sort order of the information on the report. Select from one or more of the three fields at the bottom of the screen to define the sort order. (c) Use the Save button to save a filter and later use the Load button to load a previously saved filter.
To Customise a report
1. Locate the standard report your custom report will be based on from within the Standard Reports Screen. 2. Click on the Modify button. 3. At the welcome screen of the Standard Reports customisation wizard, click Next. 4. Enter a custom title for your report and click Next. 5. The available fields for the report will be listed. Select the fields to appear on your custom report using the right mover arrow. 6. Once the required fields have been selected, adjust the order they will appear across the top of the report from left to right using the up and down arrows and click Next when done. 7. Now select the way the information will be sorted and grouped. The available fields by which your data can be grouped and sorted are listed. Select as required and click Next. For example if generating a report on Documents you may want the report sorted by Discipline with a Discipline subheading and then the list of documents that belong to the discipline. In this case you would select Discipline as the field to Group by. 8. Now setup up a default filter to be applied for the report [see Section 10.1.03] and click Next. 9. At the last screen click Finish. Notes: (a) Custom Reports are added to the standard reports listing with a report number allocated automatically. This is based on the standard report number plus an alpha suffix which commences from a for the first custom report created. (b) There are limits to the amount of customisations that can be achieved using the Modify option above. If you have a specific reporting requirement that you cannot achieve via TeamBinder, prepare a sample in MS Excel and send it to the QA Software support team who will advise you either how to achieve the required report or what will be involved in QA Software developing this custom report for you.
Page 182
Page 183
11.1.01 Overview
Published reports are a TeamBinder feature that allows companies to build a folder structure (Categories) within a TeamBinder project. Within the folder structure companies and users can store files that do not fit into any of the other TeamBinder modules. These files can then be shared with other users in the same company (Private Categories) or with other users from other companies on the project (Public Categories), assuming of course the users have access to published reports. Examples of files that may be published in this way include: Site photos Project Schedules Cost Reports Monthly Reports Resumes
The structure of Published reports is defined by Categories (or Nodes) that are the equivalent in windows of folders. A Category or folder can be defined as either Private or Public. Public categories are accessible to all users of the TeamBinder project with View or Full access to the Published reports module. Private categories are accessible to only users from the company creating the category with View or Full access to Published reports. Note also that users with a minimum of View access to published reports are notified automatically when new reports are published either to Public or Private categories subject to the rules above. To access published reports 1. Select Reports from the left menu. 2. At the Standard Reports screen, click on Published Reports. 3. Categories are displayed with a drawer icon. 4. Expand the node structure by clicking on a Category. 5. Published Reports are marked with a Paper and hand icon. 6. View a Published report by clicking on the download icon. 7. Click Close when done. Notes: (a) Access to view Published reports, maintain the Category structure, or upload reports is managed via Configure User Access to Modules [see Section 10.1.02]. (b) Published Reports can be viewed using TeamView [see Section 12.4.03] if required by using the View File icon after first selecting the Report. (c) Use the Download button to download in bulk selected Published Reports (select the reports first).
Page 184
Chapter 11 Published Reports 2. Select a Company. The users within that company will be listed. 3. For each user, choose from between the following options under the Published Reports column: None: The Published Reports module is not available to the user. View Only: The User can access and download Published Reports but cannot create new categories or publish reports themselves. Full Access: The user has full access to the Published Reports module.
Notes: (a) Project Administrators can assign User Access to the Published Reports module for any user. (b) Company Administrators can assign users access to the Published Report module only if they themselves have access. (c) Users can only see Categories and Published reports relating to their company unless the Category has been set as Public. (d) Users with access of View Only or above access will be notified automatically when new public or company reports are published.
4. Click the New button. 5. At the Add Published Reports window, select the New Report option. 6. Click the Browse button to select the report to upload. 7. Select the report file and click Open. 8. Enter a Title for the report. 9. Click Add. Notes: (a) The Current Node refers to the Category that you are publishing your report to. (b) The Published report is either Private or Public based on the setting of the root node it is stored under. (c) To delete a published report, click on it once and then click on the Delete button (requires Full Access). Users with access to the report will be notified of the deletion.
Notes:
(a) At Step 4, it is possible to show all documents not currently linked to published reports using the tick box provided. (b) At Step 7, it is possible to auto add the Document Revision and Status to the end of the document Description being used for the linked document. Use the tick boxes provided.
Page 186
Chapter 12 - Administration
12.1 Projects
12.1.01 12.1.02 12.1.03 12.1.04 12.1.05 12.1.06 Setup Check List Create Project Project Details Project Calendar Project Links Project Archiving
12.3 Users
12.3.01 12.3.02 12.3.03 12.3.04 12.3.05 Creating Users Passwords Create User Wizard User Maintenance Restricted Users
12.7 Reports
12.7.01 12.7.02 Overview Available Reports Listing
Page 187
Chapter 12 Administration
12.1 Projects
12.1.01 Setup Check List
Once a decision has been made to use TeamBinder on a project, the initial steps to get up and running are: 1. Create the Project [see Section 12.1.02]. 2. Edit the Project Details [see Section 12.1.03]. 3. Populate or Import the address book [see Section 12.2.10]. 4. Create Mail Security Groups [see Section 12.4.02]. 5. Configure Mail Security Groups [see Section 12.4.02]. 6. Setup Users [see Section 12.3.01]. 7. Assign Company Administrators [see Section 12.4.04]. 8. Assign User Access [see Section 12.4.03]. 9. Setup the Project Calendar [see Section 12.1.04]. See also module specific setup check lists: (a) (b) (c) (d) (e) Setup Check List for Mail [see Section 3.1.02]. Setup Check List for Documents [see Section 4.1.02]. Setup Check List for Transmittals [see Section 5.1.02]. Setup Check List for Workflow [see Section 6.1.02]. Setup Check List for Packages [see Section 7.1.02].
Page 188
Chapter 12 Administration The information maintained within the Project details file are as described below: Field General Project No Project Title Project Manager Project Director Weather Station Country Weather Station City Project Image Description
The Project can be any combination of letters and/or numbers with a maximum of 12 characters. Project Title The Project Manager of the hosting company. The Project Director of the hosting company. Select the Country the project is located in [see 2.4.02]. Select the City the project is located in or near [see 2.4.02]. Options for displaying an image on the Dashboard include linking to a Site Camera URL or uploading a static image. [see 2.4.01]
Select the primary companies on the project for the roles of Client, Architect, Prime Contractor, Engineering Consultant, and Quantity Surveyor (these values are for information only).
Enter the text to appear under Project Summary on the Dashboard [see Section 2.4.03]. Enter a privacy message that will appear when users download documents from TeamBinder. Enter the text to appear in the Internet Explorer Title bar when using this project. Select the Days, Hours, Minutes for the frequency with which the system will send email notifications relating to each event type in TeamBinder. For example, it set to 30 minutes, if 20 Documents are uploaded to TeamBinder and these documents are released immediately, each recipient on the distribution matrix will receive one notification listing 20 documents rather than 20 notifications of one document each. The Document Download Expires in X Day(s) field is for use when sending email notifications to users to notify them of a new document. The value entered in this field will determine how long after the notification is created the users can download the document from that email notification. This is a default number of working days used to calculate the respond by date for transmittals based on the current date + number of days defined here. This is a number of days after which users will be required to change their password.
Page 189
Chapter 12 Administration
Field
Description
Document Register Defaults Minimum Document The minimum Document Length field is for use when validating Length document uploads. Send Document Comments to Enable redlining and comments after document review workflow completion Enable upload of additional View files by Review Coordinator within the release wizard Enable upload of additional View files by Originator for Restrained documents. Enable transmitting rejected documents to all users: Send automatic notifications to setup discipline matrix Include Reviewer comments when releasing documents Mail Register Defaults Enable use of Blind Copies (BCC) when sending mail Enable the changing of the status of mail of any user within a company by a user of the same company with Company mail access Allow private Live Mail issues Allow removing of allocated mails from Binders/Sections Maximum size of attachments for mail is Default settings for use when commenting on controlled documents from within the document register. The options are Originator, Review Coordinator, Recipients. [see Section 4.2.09] Used to enable the ongoing red-lining of and commenting against documents by users with access to them once the review workflow for them is completed [see Section 6.1.07]. This option if ticked enables the review coordinator to upload an additional view file to a document as part of the Document Release Wizard Process [see Section 6.2.07]. This option if ticked enables the document originator to upload additional view files to a document that is currently restrained and awaiting workflow activation [See Chapter 6]. This option if ticked allows enables the transmittal of Rejected documents to any user. By default the option is not selected and such transmittals are restricted to be sent only to the Document e Originator. This option if ticked will send an automatic email notification to the Project Administrator if an Un-Restrained Document is uploaded to a Discipline that has no distribution matrix defined. This option if ticked will select by default all reviewer comments and redlines when release documents via the Document Release Wizard. Used to enable the use of Blind Carbon Copies (BCC) by all users if required when generating mail. User to enable a user with company access to mail to change the status of the mail of any other user within the same company.
Tick this option to allow the creation of Private Live Mails. [See Section 3.7.02] This option can be used to allow or dis-allow users from removing mails from Binder/Sections once they have been filed there.
Enter a maximum size for file attachments to mail. Above this size the user will be warned when attaching files to mails that external contacts may not be able to receive the attachments due to the size. Integration with other Systems Activate Integration with Select Yes if TeamBinder is being used in conjunction with QA WebDocsPro Softwares WebDocsPro system on a project. WebDocsPro will be granted access to TeamBinder to transfer and synchronise data between the 2 systems. Activate Integration with Tick this option to enable uploading of Defects Lists from IDMS to IDMS TeamBinder [see Chapter 9].
Page 190
Chapter 12 Administration Notes: (a) Editing the Project Details is limited to the Project Administrator [see Section 12.4.01]. (b) The Project Number cannot be changed after project creation. (c) The Project List displays only users for which you are the Project Administrator. (d) Click on the Dashboard tab to edit the Contract Turnaround Period in days (used in the Management Summary).
Page 191
Chapter 12 Administration 4. Enter the details of the link: The URL address will point the users to that web address or file when the link is clicked. The description will be displayed to users viewing the Links page.
5. Click OK. Notes: (a) Maintenance of Project Links is restricted to the Project Administrator.
The above data is archived to a storage media (normally one or more CDs), together with a copy of TBARCHIVE, QA Softwares unique application for viewing project archives. TBARCHIVE is a complete application enabling a company to view their project archive in a similar way to the way the information was viewed from within TeamBinder. TBARHIVE also includes a powerful Global Search engine to search for information within the Archive. TeamBinder Archives are far more than a companys data simply copied to CD. They are a full application on their own right for viewing project information belonging to the company. Contact QA Software for more information about Project Archives.
Page 192
Chapter 12 Administration
There is also a sub level to Companies which is Departments, use of which is optional. The Address book contains the details of both all users of TeamBinder as-well as details of any external contacts who will receive or send information to users of TeamBinder but are not themselves TeamBinder users. The Address book should be populated directly after a project is created. Contact details can be entered into the Address book manually, imported from another project, or imported from MS Excel (requires the assistance of QA Software). Access to the Project Address book for the purpose of adding or editing contact details is restricted to the Project Administrator (for all contacts), the Company Administrator (for contacts within their own company), and Users of the Project Administrators company for the creation of External contacts. For customers using multiple TeamBinder projects, the concept of a Global Address book can be supported if required [see Section 12.6].
12.2.03 Companies
Companies in TeamBinder are used to group together contacts belonging to the same organisation or company. It is not possible to create a contact without first creating the company they belong to.
Page 193
Chapter 12 Administration
Company Details
Company ID* The Company ID you assign will be used throughout the TeamBinder system and it is worthwhile preparing a procedure on how you will assign Company Ids before creating too many companies. A meaningful abbreviation for Company Ids is suggested. Eg QASOFT for QA Software. The Company Name. The type of company [see Section 12.2.02]. Use the + button to assign one or more trades [see Section 12.2.10] to the Company. The project fax-in number for the company which is used for the Integrated Fax-In service [see Section 3.10.01] and on default mail form headers. The project email address for the company which is used for the Integrated Email-In service [see Section 3.10.02] and on default mail form headers. Enter the Address Details for the Company which include: Address Line 1, Address Line 2, City, State, Postcode, and Country, Phone, Fax, and Website. The address details entered for the company are used as the default address for any contacts created within the company. ABN # Logo Upload Logo The business registration number for the company. The logo file for use on Mail and Reports. [see Section 3.1.09]. Use the Browse button to locate and upload your company logo for use on mail and other reports. Use the Remove button to remove a previous uploaded logo and the Customise button to customise the position of the logo on mail [see Section 3.1.09].
Company Name* Company Type* Trades Fax-in Number Email-in Address Address Details
Options
In Document Register: Show only documents users have access to. Show all documents.
Select between these options. The first option means that a user accessing the document register and/or reports will only ever see documents that the user has access to. Force users to file Mail in Binders and Sections Allow removing allocated mails from Binders/Sections Use this option to control the filing of mail into Binders and Sections for users within this company. The options are Never, Prompt, or Always. Use this option to control whether users can remove mails from Binders/Sections once they have been filed.
Page 194
Chapter 12 Administration
Field Enable Personal Unregistered Mailboxes Allow uploading documents on behalf of other companies Only the Company Administrator can create users within this company Send confirmation to sender when processing unregistered mails. *Mandatory fields 5. Click OK when done.
Description Tick this box to activate Personal Unregistered Mail boxes for this company [See Section 3.6.02] Tick this box to enable this company to upload documents on behalf of other companies. Use this option to prevent the Project Administrator or other users belonging to this company from creating additional users within this company. Un-Tick this box to stop the sending of notifications from TeamBinder to the senders of unregistered mails (Fax-in and Email-in). [see Section 3.6.02]
Notes: (a) After creating a new Company you are prompted to add contacts to that Company if required [see Section 12.2.05] (b) You can print a list of companies using the print or preview buttons on the toolbar. (c) You can delete companies using the delete button on the toolbar as long as there are no contacts set up for the company. (d) Use the Add/Remove link under Notify Un-reg mail to select which contacts within the company (once they have been created) should receive notifications about the receipt of new un-registered mail addressed to the company email-in address. (e) The Company ID can be changed by the Project Administrator if required at any time. (f) If the company you have created is using WebDocsPro [see Section 13.4.01] rather than TeamBinder, you will also need to define the following values: WDHost. WDPath. WDConfigID.
12.2.04 Departments
Departments are a sub-level of Companies and can be used to group contacts within a company for the purpose of controlling access to Mail [see Section 3.1.05] and the management of Un-registered mail [see Section 3.6.01]. If management of access to mail or un-registered mail by Department is not required, there is no need to use Departments in TeamBinder.
To create Departments
1. From the Administration menu select Company Details from the Address Book group of options. 2. At the Company Details screen click the Add/Edit link under the Departments column against the company the Departments relate to. 3. At the Department Details screen, click the New button. 4. At the Add/Edit Departments window, enter a Department ID and Title and click OK. Notes: (a) The Fax Number and Email address for a Department for use with Un-registered mail can only be assigned and configured by QA Software.
Page 195
Chapter 12 Administration (b) After creating a new Department you are prompted to add contacts to that Department if required [see Section 12.2.05] (c) Use the View Contacts button to see the contacts related to a Department when in the Add/Edit Departments window. (d) The Notes field can be used to store a text string that can be used for example on custom mail forms to create a Department based mail footer. (e) Use the Add/Remove link under Notify Un-reg mail to select which contacts within the department (once they have been created) should receive notifications about the receipt of new un-registered mail addressed to the department email-in address.
12.2.05 Contacts
Contacts are used throughout the TeamBinder System in all modules. All Contacts are maintained via the Address book regardless of whether they are users of TeamBinder or Contacts External to the system. Contact details are either entered directly into the address book or can be imported from another project. Maintenance of the Project Address Book is restricted as follows: The Project Administrator can generally create contacts in any company. A Company Administrator can create contacts within their own company. Users of the Project Administrators company can generally create contacts in any company. A Company Administrator can restrict creation of contacts in their company to only themselves.
It is not possible to create a contact without first creating the company they belong to [see Section 12.2.03].
To create a contact
1. From the Administration menu, select Project Address Book from the Address Book group of options. 2. Select the company the new contact belongs to at the filter (What items do you want to see?) screen and click OK. 3. Click the New button on the toolbar. 4. At the Add/Edit Contact Details window enter the following information: Field Contact ID* Title* Type First Name* Last Name* Company ID Company Position Description This ID must be unique within the company. A typical ID is Initial + Last Name. For example JBLOE for Joe Bloe. Select the correct Title for the contact from the drop down list. [See Section 12.2.09] Company Type. First name of the contact. Last name of the contact. The ID of the company the contact belongs to. The name of the company the contact belongs to. The position the contact holds within the company they belong to.
Page 196
Chapter 12 Administration
Description Enter these contact numbers. The Fax number is used both by the Integrated Fax-Out service [see Section 3.10.03] and the Fax-In service [see Section 3.10.01]. Enter the email address for the contact. This is used when sending mail and notifications by email and also by the Integrated Email-In service [see Section 3.10.02]. Use the Validate button to validate the email address entered.
Address Details
Enter the Address Details for the contact which include: Address Line 1, Address Line 2, City, State, Postcode, and Country. Tip: When creating the first contact within a company, ensure you complete the address details as fully as possible as you can then use the New Duplicate option to create further contacts and save the retyping of the same or similar address details.
Free form text field for any remarks about the contact. Select the Department the contact relates to (optional) [see Section 12.2.04]. Tick this box to make the contact an External Contact [see Section 12.2.07]. Choose between Email and Fax as the default send method for the contact. See also Sending Mail [Section 3.3.03]. This is applicable for External Contacts only. Tick this option if you would like transmittal notifications sent to you to also have the document view files they refer to attached as a zip file (in addition to the facility to access and download the view files directly from the transmittal using the hyperlinks provided). Tick this box to make a contact/user Inactive. This contact will no longer appear in the address book when the address book is viewed by other users when creating mail, transmitting documents or anywhere else the address book is used. [see Section 12.3.04]. Tick this box to include Inactive contacts in filters when running reports or queries. Tick this option to restrict the users/contacts that this contact can communicate with [see Section 12.3.05]. Enter a password for the new contact. Click the Set Password button and enter, then confirm the password for the contact/user and click OK. Tip: Set the password as equal to the Contact ID initially and send a message to the contact to change their password after first login.
Forces new users assigned to a project to change their allocated password to one of their own choice the first time they login to the project.
*Mandatory fields Fields generated by the system 5. Click OK. TeamBinder User Guide Page 197
Chapter 12 Administration
Notes: (a) You can print a contact register using the Print button. (b) You can delete contacts using the Delete button on the toolbar as long as they have not made any transactions in any TeamBinder Module. It is also necessary to first make them in-active. (c) To help when maintaining a long list of contacts you can use the filter button to control the list of contacts displayed. (d) Contact Ids can be changed at any time (as long as the user is not logged in) by simply edited them and clicking Save. (e) Use the Detail Filter option when accessing the Address book and the What items do you want to see? screen if required to apply a more advanced filter on the address book. (f) The Address book screen can be customised using the Customise button. (g) Restricted Users are displayed in blue at the Address book screen. (h) Inactive Contacts are displayed in grey at the Address book screen. (i) Information about the security/access setup for the contact can be viewed (and maintained) from within the address book using the following Tabs: User Security Discipline Matrix Review Teams [see Section 12.4.03] [see Section 4.1.09] [see Section 6.1.06]
(j) Use the New Duplicate button to create a new contact with the same security settings as an existing contact. You will be prompted to duplicate the security settings. (k) The Send Login Info button can be used to send a new user their login information. (l) The Set User Preferences button can be used to go directly to the User Preferences screen for selected contacts if these contacts have already been activated as Users. (m) Additional fields on the Address book screen can be made mandatory if required [see Section 12.4.10].
12.2.06 Favorites
Users can select from the complete Address book the contacts with whom they correspondence most frequently and group these into a Favorites list. The use of Favorites in the TeamBinder mail module reduces the time required to select the distribution for outgoing mail.
Page 198
Chapter 12 Administration
All other notifications generated by TeamBinder such as Transmittals operate normally for external contacts. An External contact can be changed to a TeamBinder user at anytime and will see all mail and transmittals sent to them as though they had been a TeamBinder user from the beginning.
Chapter 12 Administration
7. Move the contacts to add to your Group from the left of the screen to the right into either the TO, CC or BCC boxes 8. Click the Save button. 9. Click the Close button. Notes: (a) The BCC option at step 7 will only be available if the use of Blind Copies has been activated on the Project [see Section 12.1.03]. (b) All contacts in a contact Group are considered as TO values when using a Contact Group with the Transmittals module. (c) To use a contact group with mail, see [Section 3.3.06]. (d) Contact groups can be edited by Project Administrators (All) and Company Administrators (for groups set up by users within their company).
12.2.10 Trades
A configuration of table for Trade values is available to enable categorisation of companies within a TeamBinder project. Companies can be allocated more than one Trade. To define the Trade values: 1. From the Administration menu, select Configuration Tables from the General group of options. 2. Use the drop down list in the top right hand corner of the screen to select Trades as the table to work with. 3. Use the toolbar to add new records, delete records or edit existing records.
Page 200
Chapter 12 Administration 4. Select the company that you wish to import contacts from. Note you can filter the companies available using the Type and Trade drop down lists. 5. Move the contacts that you wish to import from the left to the right of the page. 6. Repeat steps 4 and 5 for additional contacts. 7. Click Next and then Finish. You will receive a message advising that the import has been completed successfully. Notes: (a) Once imported, there is no link maintained between the contact details contained in the current project with the project the contacts were imported from.
12.3 Users
12.3.01 Creating Users
Project participants requiring access to the information in TeamBinder and the ability to send communications, upload documents, generate transmittals, etc must be defined as TeamBinder users before this is possible. The process of creating a new user involves: Adding the person to the Address Book [see Section 12.2.05]. Allocating the person a password [see Section 12.2.05]. Assigning the person to a Mail Security Group [see Section 12.4.02]. Setting the persons access levels to the various modules of TeamBinder [see Section 12.4.03]. Adding the person to the discipline based distribution matrix (optional) [see Section 4.1.09].
A user can be created in any of the following ways: Step by step using the various menu options to complete the above process. By using a Create User Wizard [see Section 12.3.03] that walks you through all the steps necessary to create a user and configure their access to the system (recommended). Directly from within the Address Book.
Note that the minimum steps required to enable someone to login to TeamBinder are to add them to the Address Book and allocate them to a mail security group.
Chapter 12 Administration Notes: (a) The Mail Security Group a user belongs to can also be selected via the User Security tab in the Address Book when editing the details for a user/contact. (b) Creation of Users is restricted as follows: The Project Administrator can create Users in any company unless the Company has prevented this by activating the option to restrict creation of users in their own company to only their own Company Administrator. Company Administrators can create Users in their own company only. Users belonging to the same company as the Project Administrator can create Contacts in any company (unless this is restricted by the Company as for the Project Administrator) but cannot make these Contacts into Users.
(c) The new User(s) will now be able to create, send and receive Personal mail as per the setting of the Mail Security Group allocated [see Section 12.4.02]. (d) The new User(s) will be able to upload documents to TeamBinder using XLUPLOAD for Disciplines their company has the authority to upload. (e) Users created by the above method will inherit the default minimum access levels to each module of TeamBinder which are: Standard Mail Un-Registered Mail Binders and Sections Documents Packages Transmittals Published Reports Defects Personal Mail Only None None View None Company None None
To adjust the settings for any of the above, use the Configure User Access to Modules option under the Administration menu [see Section 12.4.03] or via the Address Book and Security Settings tab. See the Security Issues section of the documentation for each module to understand the implications behind the available user access options for each module.
12.3.02 Passwords
Access to TeamBinder is controlled by the use of User Ids and Passwords and 128 bit SSL Encryption during the login process to protect this information. Users can change their own passwords at any time as follows: 1. From the Administration menu, select Change Password from the Security group of options. 2. Enter your existing password. 3. Enter your new password and reconfirm it by entering it again and then click OK. Notes: (a) Users may be forced to change their password on first login into the system (if the administrator activated this requirement when creating them as a contact) [see Section 12.2.05]. (b) Users may be forced to change their password periodically based on a project setting for the interval before passwords expire [see Section 12.1.03]. (c) Changing your password in the current project changes it for all other projects you have access to with the same password.
Page 202
Chapter 12 Administration (d) The Project Administrator can use the above menu option to change the password of any user. In this case Step 2 is not required. (e) A company Administrator can use the above menu option to change the password of anyone in their company. (f) If a User forgets their password they should click the Forgot Password link at the login screen. They will be automatically send a new random password by email (using the email contained in the address book for them) which they will be forced to change on their next login to TeamBinder.
Select an existing contact to turn into a user 4. Select the existing contact from the address book using the mover arrows to move them from the left to the right of screen and click Next. 5. Go to step 13. Create new user 6. Choose between the following two options and click Next. Select from an existing company (go to step 7). Create new Company (go to step 9).
Use existing company 7. Select the company the person belongs to and click Next. 8. Go to Step 10) Create new company 9. Enter in the new company details [see Section 12.2.03] and click Next. Enter user Details 10. Enter the details for the new user. Mandatory fields are marked with a red asterisk [see Section 12.2.05].
Page 203
Chapter 12 Administration 11. Enter a password for the user and re-enter to confirm and then click Next. Tick the Assign Password Later option if you will assign the password later. 12. Choose between the following two options and click Next. Create more users (go to step 6) Continue to set up the users security and access settings (go to step 13).
13. Select the security group that you wish to assign the user to and click Next. If you wish to assign all users on the screen to the same security group, click the tick box labelled Assign to all. 14. Configure each users access rights for each module of TeamBinder and click Next. (The access rights are explained in the Security issues section of this documentation for each module). If you wish to assign all users on the screen to the same access rights, click the tick box labelled Assign to all. 15. Choose between the following 2 options and click Next. Set up the Discipline matrix now (go to step 16). Setup the discipline matrix later (go to Step 17).
Setup the Discipline matrix 16. Assign that user access to particular disciplines and file formats by moving the appropriate disciplines from the left to right of the screen, then ticking the appropriate view file boxes [see Section 4.1.09]. Click Next when done. Note: If you have selected multiple users, these disciplines and access permissions will be assigned to all users 17. Select whether you want a copy of the welcome notifications sent out to the new users to be sent to your normal email address and click Finish. Each User added through the wizard (with an email address) will receive a welcome notification that: Informs them they have been added as a user to the TeamBinder Project. Includes their login details and password. A link to download the TeamBinder Guided Tour, ideal for new users to gain an understanding of the System.
The sending of these welcome notifications is optional and can be controlled at the final page of the create user wizard.
Page 204
Chapter 12 Administration
Note that if an In-active contact is made Active again, you will be prompted to re-install their previous access levels to TeamBinder.
Page 205
Chapter 12 Administration
The Project Administrator is assigned to a Project during the Project creation process but can be changed to any TeamBinder user within a project at any time by the existing Project Administrator.
Page 206
Chapter 12 Administration
2. Click the New button. 3. Enter a Group code and Title. 4. Click OK when done.
If none of the above options are ticked, users belonging to this security group will have no access to the mail type. Notes: (a) The settings for the Open User level cannot be changed. This level is used to provide Project Administrators with full access to all mail types within TeamBinder mail boxes. (b) Security Levels are allocated to users either via the Create User Wizard [see Section 12.3.03] or via the Allocate User to Mail Security Groups menu [see Section 12.3.01], or directly from within the Address book using the User Security tab.
Page 207
Chapter 12 Administration
Chapter 12 Administration
Tip: Click on the column headings to sort the data in the most suitable way. 3. Tick the file formats against each document that the user will be able to access/download. The options are: DWG: Tick this box if the user should be allowed to download documents of the selected discipline in AutoCAD DWG format. PLT: Tick this box if the user should be allowed to download documents of the selected discipline in AutoCAD Plot File (PLT) format. TIFF: Tick this box if the user should be allowed to download approved documents of the selected discipline in TIFF format. 4. Click the Approve Subscriptions button on the toolbar. Notes: (a) To reject a document subscription request, simply click the Reject Subscriptions button at step 4 above. (b) An email is sent to the user requesting the access notifying them of your decision. (c) Click the Comments button to enter a message in regard to your decision. To include the message with the email sent to the user advising them of your decision, tick the Add this comment(s) to the notification box. (d) To see previously approved subscription requests, select Approved Subscriptions from the drop down list. (e) To see previously rejected subscription requests, select Rejected Subscriptions from the drop down list.
Page 209
Chapter 12 Administration
Notes:
(a) Use of this wizard is restricted to the Project Administrator for outgoing transmittals regardless of the sending or receiving company. (b) A Company Administrator can use this wizard to stop the receipt of future revisions of documents received by transmittal to any user in their company.
Chapter 12 Administration
TeamBinder automatically recognises such email addresses and sends all notifications to them plain text.
12.4.09 Broadcasts
A Broadcast is a means of sending an email notification to all users of TeamBinder on a project.
To send a Broadcast
1. From the Administration menu, select Broadcast Message from the General group of options. 2. Enter both a Subject and Broadcast Messages and click OK. Notes: (a) The broadcast message will be sent as an email notification to all active TeamBinder users for the project. (b) Sending of broadcasts is restricted to the Project Administrator.
Page 211
Chapter 12 Administration
Page 212
Chapter 12 Administration 11. At the Distribution Matrix screen, set up the access to controlled documents on a per discipline basis as normal. The access provided here applies to all the approved contacts from the registering company. Click Next when done. 12. At the final page of the wizard, click Finish. Notes: (a) To register more companies, tick the option Setup more users at the finish page of the wizard. (b) The approved contacts will be sent their login details automatically by email. (c) By default, you as the project administrator will get a copy of this email. Un-tick this option if required at the finish page of the wizard.
Linked Projects:
If new contacts are added in a linked project, they are automatically added to the Global Address Book (assuming they dont already exist there) and a link is established. If new contacts are added in a linked project that already exist in the Global Address book the user is prompted to use the details from the Global Address book and a link is established. If linked contacts are updated in a linked project address book, then the details are automatically updated in the Global address book and in other linked projects where the same contact is linked back to the Global Address Book.
Page 213
Chapter 12 Administration
When a contact is created manually in the global address book, the user will be prompted to add the contact to one or more linked projects. If contacts are added to linked projects in this way then a link is established between their entry in the linked projects and their entry in the Global Address book, enabling easy maintenance [see section 12.6.05]. Once the Global Address book is populated, the Project Administrator can export the address book information to selected, or all linked projects, thus updating them with any contacts that are not already in their Address Book.
Notes:
(a) When manually adding to or exporting contacts from the Global Address book, the links to contacts in the linked projects will be created for new contacts only. Contacts that already exist in the linked project that are not already linked to the Global Address Book will not be linked by the either process. (b) Users with access to the Global Address book but who are not assigned as Project Administrators can add contact details to the Global Address book but cannot post these directly to linked projects. The posting must be done by the Project Administrator using Export contacts option:
Page 214
Chapter 12 Administration If the new contact already exists in the global address the user will be prompted to use the address details for the new contact from the Global Address book. If they accept this option a link is made between the contact details. If they manually enter the address then this entry for the contact will not be linked to the Global Address Book. When importing contacts from the Global Address Book project into the current project, any imported contacts are auto linked back to the Global Address Book.
12.7 Reporting
12.7.01 Overview
There are a number of standard reports available in TeamBinder related to Administrative functions. The Standard reports are accessed by: 1. Select Reports from the left hand menu. 2. Click on Standard Reports. 3. Select Administration from the Report on drop down list. The reports available are: Session Log* Project Statistics Report Notifications History By Notification Type
*Note this report is located outside of the Administration report group currently and is listed at the reports screen after selecting Reports from the left menu at the Dashboard. 4. When running any of these reports you will be prompted to apply a filter. Build an appropriate filter if required and click OK to run the report. Notes: (a) Reports can be output to the screen or to a CSV file (which can be then imported into MS Excel or MS Word). (b) See also Generating Standard Reports [Section 10.1.02]. (c) See also Customizing reports [Section 10.2.01]. TeamBinder User Guide Page 215
Chapter 12 Administration
Report Group: 01 - Address Book 001 Address Book - by A simple address list report of all contacts (with Contact ID Company ID & in brackets) in the address book sorted by Company and Contact ID User. 005 Address Book - by Company ID & Last Name Address Book - by Contact ID Address Book - by Last Name Address Book - by Company Type Address Book by User Type Similar to Report 001 but sorted by Company and Last Name of the contact. Similar to Report 001 but sorted by Contact ID. Similar to Report 001 but sorted by Last Name of the contact. Similar to Report 001 but sorted by Company Type.
This is a useful report to print our User Details with filter options for: External contacts Restricted Users Users Allocated to Security Groups Users who are not external contacts and are not yet allocated to a security group Report Group: 02 - Administration 001 Session Log The session log report allows Administrators to generate a report two see who has logged in and out of TeamBinder and when they have done this. When running this report the administrator can easily filter on a particular company and or user and specify a date range over which to run the report. Note: This report is located outside of the Administration group currently and is listed at the reports screen after selecting Reports from the left menu at the Dashboard. 010 Project Statistics Report This report details the total number of work items in each TeamBinder module based on a large number of options. When running this report the administrator can choose between: Summary Detailed Custom: This option allows for the selection of a Summary and Detailed Statistics on a per module basis.
They can then choose which modules to include on the report from Documents, Mail, Packages, Transmittals, Published Reports, and Address Book. Finally select a date range for the report.
Page 216
Chapter 12 Administration
Description
The Summary report includes for example: For Documents: Total number of All revisions; Total Currently Restrained, Total Awaiting Review, Total Awaiting Release, Total Approved; Total Rejected etc. For Mail: Total items in each mailbox. For Transmittals: Total number of transmittals; Total with response outstanding etc. For Administration: Numbers of users with each access level to each module. The Detail report includes for example: For Documents: Average Target, Total and Actual Review Durations, Subscription request details etc. For Mail: Totals for each mailbox by Mail Status. For Transmittals: No. of Recipients with superseded documents, number of transmitted documents etc.
015
Enables Administrators to generate a report on all email notifications that have been sent from the system. This provides a full historical archive of who was notified about what, and when. The report details are grouped by Notification Type. A simple filter is provided when running this report to enable the user to easily select from: Notification Type Date Range for Date Sent From Company/Contact To Company/Contact Sort By (Select a field to sort by and then choose between Ascending or Descending).
Page 217
Chapter 13 - Technical
13.1 ASP TeamBinder
13.1.01 13.1.02 Overview System Requirements
Page 219
Chapter 13 Technical
The customer using TeamBinder requires only a Browser and Internet connection. A monthly hosting fee applies on a per project basis and charges may apply for excess data storage.
Word Processor
Internet Explorer 5.5 with the Internet Explorer 6.0 support for 128 bit encryption. Current Microsoft XML parser. N/A Microsoft Word 97 or above
Page 220
Chapter 13 Technical QA Software as the vendor supplies a Licensed copy of the TeamBinder software to the customer and assists if required with installation and maintenance of the software. When self hosting TeamBinder the customer is responsible for: System Availability 24x7 System Security (via Firewall) System Security (via 128 bit SSL) Hardware Installation and Maintenance Software Installation and Maintenance Data backups System recovery in the event of a server failure
The Licensing model for TeamBinder is based on a simple annual license fee based on unlimited users and projects and which includes technical support and TeamBinder software upgrades.
1 x 40 GB Hard Drive 3 x 120 GB Hard Drivers Raid 5 configuration if required. Operating System Windows 2000 Server Windows 2000 Server Support Software SQL Server 2000 Standard SQL Server 2000 Standard Edition Processor License, Edition Processor License, ASP Upload ASP Upload Network Connection 100 MBPS 100 MBPS Backup, Anti-virus protection As seen fit As seen fit & firewall Note the above is strictly a guide and generic. Each server may require different specifications depending on the number of active projects, active users, and sizes of files in use.
Page 221
Chapter 13 Technical
Hosting Environment
Webservices Interface
Firewall TeamBinder WebServer Client Workstations Specifications: 1) Microsoft Windows 2000 Server or Above. 2) Microsoft Internet Information Server 3) For Browser based clients, content is served as HTML. Also the system exposes a web service interface for collaboration with other corporate systems TeamBinder Database Server Specifications: 1) Microsoft Windows 2000 Server or Above 2) Microsoft SQL Server 2000
Client Workstations will be running Internet Explorer and accessing the TeamBinder Service. The communication between clients and the server will be using either HTTPS or HTTP protocols. At the beginning users will be authenticated using their TeamBinder login credentials and on successful login users can access the system for the given session.
Note: It is possible that TeamBinder WebServer and TeamBinder database server can be hosted on the same box. Also the above diagram does not include the optional configurations such as a dedicated backup server and a fax server to handle incoming and outgoing faxes.
Page 222
Chapter 13 Technical
Support can also be obtained during normal AEST business hours by calling QA Software Pty Ltd on +61 (3) 8379 0000 or by facsimile on +61 (3) 9326 6544.
Page 223
Chapter 13 Technical Note: Before you begin applying these configurations please log out of TeamBinder and access an alternative website, so next time you login into TeamBinder the security configurations take effect in full. To configure the Internet Explorer Security settings for TeamBinder choose between: 1. Adding TeamBinder as a Trusted Site. 2. Customizing your Internet Explorer security settings.
Note: If you are using a different URL to access TeamBinder, please enter this here 8. Click Add. 9. Click OK.
Page 224
Chapter 13 Technical Note: If you are using the document online viewer for the very first time you will be asked to install a JAVA applet (if you have not done so already).
Page 225