Introduction 1 Working with 2 COMOS Lifecycle Operating Manual Working with COMOS DocumentView 3 Working with "COMOS Mobile Document Review" 4 Administration 5 User interface reference 6 04/2014 A5E32019276-AC
Legal information Warning notice system This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. DANGER indicates that death or severe personal injury will result if proper precautions are not taken. WARNING indicates that death or severe personal injury may result if proper precautions are not taken. CAUTION indicates that minor personal injury can result if proper precautions are not taken. NOTICE indicates that property damage can result if proper precautions are not taken. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens products Note the following: Trademarks WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Industry Sector Postfach 48 48 90026 NÜRNBERG GERMANY A5E32019276-AC P 03/2014 Subject to change Copyright Siemens AG 2014. All rights reserved
Table of contents 1 Introduction...7 2 Working with...9 2.1 s...9 2.2 Changes...9 2.3 Starting and closing...10 2.3.1 Opening and logging into...10 2.3.2 Closing...10 2.4 Projects and working layers...12 2.4.1 Opening a project...12 2.4.2 Opening a working layer...13 2.4.3 Switching the project or working layer...13 2.4.4 Switching the project language...14 2.5 Navigator...15 2.5.1 Configuring the Navigator view...15 2.5.2 Navigator display...16 2.5.3 Basic operation of the Navigator...16 2.5.3.1 Using the Navigator...16 2.5.3.2 Opening an object...17 2.5.3.3 Closing an open object...18 2.5.3.4 Navigating to documents on which an engineering object is placed...18 2.5.3.5 Navigating to the location in the Units Navigator...19 2.5.3.6 Navigating to the unit in the Documents Navigator...19 2.5.3.7 Navigating to the implementation...20 2.5.3.8 Navigating to the original document...20 2.6 Properties...21 2.7 Edit...22 2.7.1 Changes...22 2.7.2 Editing attributes...23 2.7.3 Linkattribute...24 2.8 Queries...24 2.8.1 General...24 2.8.2 Opening a query...24 2.8.3 Displaying query properties...25 2.8.4 Displaying a query in an own area...25 2.8.5 Navigating from the query to the Navigator...26 2.8.6 Opening the properties of an object from the query...26 2.9 Documents...27 2.9.1 Document types...27 2.9.2 Opening a document...28 2.9.3 Open the properties of a document...28 2.9.4 Reports...29 Operating Manual, 04/2014, A5E32019276-AC 3
Table of contents 2.9.5 Displaying older revision versions in the History...29 2.9.6 Hiding the revision list...30 2.9.7 Opening external documents...30 2.9.8 Opening the document list...30 2.9.9 Working with the document list...31 2.9.10 Displaying the version of a document...31 2.9.11 PQM documents...32 2.9.11.1 General...32 2.9.11.2 Uploading documents...33 2.9.11.3 Checking out documents...33 2.9.11.4 Checking in a document...34 2.9.11.5 Undoing check out of a document...34 2.9.11.6 Accepting a revision step...35 2.9.12 DVM packages...35 2.9.12.1 Display last revision of the DVM package...36 2.9.12.2 Display last version of an individual document of the DVM package...36 2.9.13 Open link...36 2.10 Document search...37 2.10.1 Searching for documents...37 3 Working with COMOS DocumentView...39 3.1 Using the content-based full-text search...40 4 Working with "COMOS Mobile Document Review"...41 5 Administration...43 5.1...43 5.1.1 s for operating...43 5.1.1.1 Server-side requirements...43 5.1.1.2 Workstation requirements...44 5.1.2 Installation and configuration...45 5.1.2.1 Security information...45 5.1.2.2 Configuring Windows Server 2008 R2...45 5.1.2.3 Configuring "Comos.Web.config.xml"...47 5.1.2.4 Example for "Comos.Web.config.xml"...48 5.1.2.5 Maximum file size...50 5.1.2.6 Setting up IIS...51 5.1.2.7 Setting up SSL...53 5.1.3 Updating...54 5.1.4 Network login...54 5.1.5 Creating a base object for queries in COMOS...54 5.1.6 Settings for editing attributes...55 5.1.6.1 Attributes as Web attributes for...55 5.1.6.2 Marking tab by means of script...55 5.1.7 Links...55 5.1.7.1 Settings for creating links...55 5.1.7.2 Creating a link using a script...56 5.2 COMOS SharePoint interface...57 5.2.1 Configuring authentication for the COMOS SharePoint interface...58 5.2.2 Configuring "Comos.Web.config.xml" for the COMOS SharePoint interface...59 5.2.3 Configuring profiles for the COMOS SharePoint interface...60 5.2.4 Installing COMOS SharePoint interface on SharePoint...61 4 Operating Manual, 04/2014, A5E32019276-AC
Table of contents 5.2.5 Configuring COMOS SharePoint interface at farm level...62 5.2.6 Configuring COMOS DocumentView at site level...62 5.2.7 Language settings for the COMOS SharePoint interface...63 5.2.8 Updating COMOS SharePoint interface on SharePoint...63 5.2.9 Removing COMOS SharePoint interface on SharePoint...64 5.3 "COMOS Mobile Document Review" ipad app...64 5.3.1 Configuring authentication for "COMOS Mobile Document Review"...64 5.3.2 Specifying the default domain...65 5.3.3 Create App-User in COMOS...65 5.3.4 Sending COMOS documents to "COMOS Mobile Document Review"...66 5.3.5 Saving "COMOS Mobile Document Review" data management in a separate base project...67 6 User interface reference...69 6.1 Control elements during login...69 6.2 Displaying projects and working layers...69 6.3 Columns in the document list...70 6.4 Revision list columns...70 6.5 Version history columns...71 Operating Manual, 04/2014, A5E32019276-AC 5
Introduction 1 COMOS data and documents are increasingly needed by people on the move. Reviews have to be performed on-the-go or data is required locally at plants. is a server-based Internet interface to COMOS which permits this kind of mobile access. There are three products available to you for the different mobile scenarios: You use to log into a database using an Internet browser. You cannot change general COMOS settings via. However, you can edit attributes as well as the test and revision steps. displays the following data: Revisioned documents in PDF format External documents, also without revisions All versions of DVM documents Queries Engineering data in the Navigator Attributes of the engineering objects The following functions are available: Navigation Full text search of external documents, DVM documents and revisioned documents Language selection for the user interface and database Document list Document history Check in and check out Editing documents Editing of mandatory attributes and selected attributes Release of test and revision steps section Working with (Page 9). COMOS DocumentView Using COMOS DocumentView of the COMOS SharePoint Interface, you can provide access to COMOS documents within your normal SharePoint environment. All you need for access is the corresponding entitlement of the respective user in SharePoint. Entering every single user into the COMOS database is not necessary. The documents are made available in SharePoint directly from COMOS via the COMOS DocumentView. Operating Manual, 04/2014, A5E32019276-AC 7
Introduction You can individually configure COMOS DocumentView for each SharePoint site. In this case it can be determined for all projects from which document group a COMOS database document has been offered. The following documents can be opened and downloaded: Revisioned documents in PDF format External documents, also without revisions All versions of DVM documents section Working with COMOS DocumentView (Page 39). "COMOS Mobile Document Review" The "COMOS Mobile Document Review" ipad app enables mobile access to and review of relevant documents even without COMOS experience. You send revisioned COMOS documents from COMOS to users of "COMOS Mobile Document Review". In "COMOS Mobile Document Review", you download the documents so that they are also available offline. This enables you to see which documents are new and you have the option of identifying selected documents as favorites. You can save a review to a PDF document with identified errors and inserted comments. You save this red-lining and then send it via E-mail or back to COMOS. This means that you do not change the actual COMOS data or documents. Rather you overlay your comments onto the existing PDF. In addition, you can release test and revision steps. section Working with "COMOS Mobile Document Review" (Page 41). Note Compatibility not guaranteed The Web services of are not designed as API or for the development of customer-specific solutions; they are only intended for use by the specific clients. In particular, there is no compatibility guarantee for the Web services. 8 Operating Manual, 04/2014, A5E32019276-AC
Working with 2 2.1 s Basic knowledge You have basic experience of working with COMOS. For more information on the basic terminology and modes of operation in COMOS, refer to the "COMOS Platform Operation" manual. Recommendation Use Microsoft Internet Explorer 10, Chrome 32 or Safari 7. See section "Workstation requirements (Page 44)". Other requirements A configured server is available. You know the URL of the Web server. Opening and logging into (Page 10) 2.2 Changes Database Changes are only displayed in if you have made them directly in the database that the Web server is using. Use COMOS for this. When data is changed for a project which you are currently accessing with, problems may occur during updating in. Operating Manual, 04/2014, A5E32019276-AC 9
Working with 2.3 Starting and closing 2.3 Starting and closing 2.3.1 Opening and logging into 1. Start the Internet browser. 2. Enter the address of. If you are not automatically authenticated, for example, based on your current Windows account, you are prompted to enter a user name and password in a standard browser window. When specifying the user name, also enter the domain name, depending on the configuration at the server end. You therefore enter your information either under "User name" or "Domain\User name". The login window for is displayed. 3. Enter the required login details in the control elements. 4. Click the "Login" button. Note on data security User name and password are usually not discarded until after the browser is closed. Depending on the browser settings, the login information may also be saved between browser sessions. For security reasons, do not save the data on publicly accessible computers, particularly if you have no access to the browser settings. Result You are logged into. Control elements during login (Page 69) Closing (Page 10) 2.3.2 Closing You are logged into. See section Opening and logging into (Page 10). 10 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.3 Starting and closing To close, click "Log out". Note on data security User name and password are usually not discarded until after the browser is closed. Depending on the browser settings, the login information may also be saved between browser sessions. For security reasons, do not save the data on publicly accessible computers, particularly if you have no access to the browser settings. Result You are logged out. The login window is displayed. Opening a project (Page 12) Operating Manual, 04/2014, A5E32019276-AC 11
Working with 2.4 Projects and working layers 2.4 Projects and working layers 2.4.1 Opening a project 1. Start and log in. The projects are listed in the "Open project" area. 2. Select the desired project in the "Open project" area. The name of the selected project is displayed in the "Project" field. 3. Click the "Open" button. Result The selected project is opened. Opening and logging into (Page 10) Displaying projects and working layers (Page 69) Opening a working layer (Page 13) Switching the project or working layer (Page 13) Switching the project language (Page 14) 12 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.4 Projects and working layers 2.4.2 Opening a working layer Only working layers for which you have read access are displayed. The administrator can set the layer view. section Configuring "Comos.Web.config.xml" (Page 47). 1. Log in to. The projects are listed in the "Open project" area. 2. Select the desired project in the "Open project" area. The "Working layer" area lists the working layers of the selected project for which you have read access. 3. Select the desired working layer from the "Working layer" area. The names of the selected project and working layer are displayed in the "Project" field. 4. Click the "Open" button. Result The selected working layer is opened. Displaying projects and working layers (Page 69) Opening and logging into (Page 10) Opening a project (Page 12) Switching the project or working layer (Page 13) Switching the project language (Page 14) 2.4.3 Switching the project or working layer A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). Operating Manual, 04/2014, A5E32019276-AC 13
Working with 2.4 Projects and working layers 1. Select the "Start > Open project" command in the menu bar. The "Open project" and "Working layer" areas are displayed. 2. Select one of the following options: If you want to open a different project, select it from the "Open project" area. If you want to open a different working layer, select the required project from the "Open project" area and the working layer from the "Working layer" area. 3. Click the "Open" button. Displaying projects and working layers (Page 69) Switching the project language (Page 14) 2.4.4 Switching the project language You determine the language in which the user interface is displayed when you log in. When you have opened a project, you can choose the language in which it is displayed. A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). Select the desired language under "Languages" in the menu bar. Result The open project is displayed in the relevant language. If updating problems occur, open the project again. Control elements during login (Page 69) 14 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.5 Navigator 2.5 Navigator Views When you have opened a project or working layer, the Navigator is automatically displayed in the "Units" view. You can configure the following views for the Navigator: "Units" "Locations" "Documents" If the administrator has made the necessary settings, you can also configure individual views in addition to these default views. Configuring the Navigator view (Page 15) Opening a project (Page 12) Opening a working layer (Page 13) Basic operation of the Navigator (Page 16) 2.5.1 Configuring the Navigator view A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). Select the desired view under "View" in the menu bar. Result The Navigator is displayed in the relevant view. The marker in the "View" menu indicates which view is currently set. Operating Manual, 04/2014, A5E32019276-AC 15
Working with 2.5 Navigator Example In the following example the "Units" view is set. Navigator display (Page 16) Navigator (Page 15) 2.5.2 Navigator display Overview The open project is always displayed at the top in the Navigator. Beneath it the objects belonging to the engineering project in question are displayed. System types Objects of the following system types are displayed in the Navigator: "Device" "Document" Navigator (Page 15) Configuring the Navigator view (Page 15) 2.5.3 Basic operation of the Navigator 2.5.3.1 Using the Navigator A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). 16 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.5 Navigator Selecting the object Click the object. Opening and closing the tree structure 1. To expand the Navigator tree structure, click "+". 2. To collapse the Navigator tree structure, click "-". Navigating using the keyboard You can use the arrow keys to navigate in the tree structure. The following table describes the functions of the arrow keys: Key <Up arrow> <Down arrow> <Right arrow> <Left arrow> Description Selects the next object up in the Navigator. Selects the next object down in the Navigator. Expands the tree structure. Collapses the tree structure. Navigator (Page 15) Navigator display (Page 16) 2.5.3.2 Opening an object A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). Double-click on the desired object in the Navigator. Result A main window with the object-specific display is opened: Queries are displayed in a special query window. Documents are opened. The properties of all other objects are opened. In the properties the various tabs of the object and their attributes are displayed. Operating Manual, 04/2014, A5E32019276-AC 17
Working with 2.5 Navigator Queries (Page 24) Documents (Page 27) Properties (Page 21) Displaying the version of a document (Page 31) 2.5.3.3 Closing an open object An object is open. See section Opening an object (Page 17). Click on the button at the top right. Result The opened object is closed. 2.5.3.4 Navigating to documents on which an engineering object is placed A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). 1. Select an engineering object in the Navigator. 2. Click on the "Documents > <Name of document>" command in the context menu. Result The corresponding document is automatically selected in the Navigator. Navigating to the location in the Units Navigator (Page 19) Navigating to the unit in the Documents Navigator (Page 19) 18 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.5 Navigator Navigating to the implementation (Page 20) Navigating to the original document (Page 20) 2.5.3.5 Navigating to the location in the Units Navigator The Navigator is displayed in the "Units" view. See section Configuring the Navigator view (Page 15). 1. Select the desired object in the Navigator. 2. Select the command "Location: <Name of location>" command in the context menu. Result In the Navigator the location is selected to which the selected object has a link. Navigating to documents on which an engineering object is placed (Page 18) Navigating to the unit in the Documents Navigator (Page 19) Navigating to the implementation (Page 20) Navigating to the original document (Page 20) 2.5.3.6 Navigating to the unit in the Documents Navigator The Navigator is displayed in the "Document" view. See section Configuring the Navigator view (Page 15). 1. Select the desired object in the Navigator. 2. Click the "Unit <Name of unit>" command in the context menu. Result In the Navigator the unit is selected to which the selected object has a link. Operating Manual, 04/2014, A5E32019276-AC 19
Working with 2.5 Navigator Navigating to documents on which an engineering object is placed (Page 18) Navigating to the location in the Units Navigator (Page 19) Navigating to the implementation (Page 20) Navigating to the original document (Page 20) 2.5.3.7 Navigating to the implementation A project or a working layer is open. See section Opening a project (Page 12) or Opening a working layer (Page 13). 1. Select the desired object in the Navigator. 2. Select the "Implementation" command in the context menu. Result In the Navigator the object to which the selected object has an implementation link is selected. Navigating to documents on which an engineering object is placed (Page 18) Navigating to the location in the Units Navigator (Page 19) Navigating to the unit in the Documents Navigator (Page 19) Navigating to the original document (Page 20) 2.5.3.8 Navigating to the original document The Navigator is displayed in the "Document" view. See section Configuring the Navigator view (Page 15). 1. Select the desired document in the Navigator. 2. Click on the "Original document > <Name of document>" command in the context menu. 20 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.6 Properties Result The original document is selected in the Navigator. Navigating to documents on which an engineering object is placed (Page 18) Navigating to the location in the Units Navigator (Page 19) Navigating to the unit in the Documents Navigator (Page 19) Navigating to the implementation (Page 20) 2.6 Properties Attributes and tabs Tabs group the object attributes. The attributes describe the object. To open a tab, click on it. Depending on your rights, you can change the attributes in the tabs in or simply view them. Display The properties are always displayed to the right of the Navigator. An information bar is displayed at the very top. The information bar contains the following information: Operating Manual, 04/2014, A5E32019276-AC 21
Working with 2.7 Edit Type of object selected: Object Document Query FullLabel of the selected object Description of the selected object Scrolling Next to the tabs you see the following buttons: You can use these buttons to scroll through the tabs in order to get to the headers of the tabs which cannot be fully displayed. Opening an object (Page 17) 2.7 Edit 2.7.1 Changes Editable attributes You can change some attributes in. The administrator determines which attributes can be changed in COMOS. section Settings for editing attributes (Page 55). The tabs in which you can edit attributes are shown in italics. Tabs in which you have changed attributes are marked with a red dot. If you save the changes, the tab is no longer marked with a red dot. Example of tab with changed attributes 22 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.7 Edit Attributes that cannot be edited You cannot change the following attributes: Memo fields (RTF) File selection Signature Buttons Even parts of attributes, such as units or the product data display, cannot be changed. Note Future versions Changing attributes is the first step in editing. Siemens AG reserves the right to consider additional attributes for editing without especially identifying them. 2.7.2 Editing attributes Your administrator has made the necessary settings in COMOS. section Settings for editing attributes (Page 55). 1. Open the properties of the object. section Opening an object (Page 17). 2. Change the attributes in the required tab. The tab is marked with a red dot. 3. Select one of the following options: To save the changes, click the "Apply" button. The properties of the object remain open. Your changes are saved. The tab is no longer marked with a red dot. Click "OK" to save your changes and close the properties. Click "Cancel" to discard your changes and close the properties. Your changes are not applied. Operating Manual, 04/2014, A5E32019276-AC 23
Working with 2.8 Queries 2.7.3 Linkattribute Pointers When you edit attributes or upload and check in a document, you can set link attributes, among other things. Link attributes are pointers to other documents, a document group, or a unit/ location, for example. You can perform the following actions with link attributes: Action Button Description Set pointer "..." To set a pointer, select the object in the Navigator and click on the button "...". Delete pointer Deletes an entry in the corresponding field. Navigate to object The object that is pointed to is selected in the Navigator. 2.8 Queries 2.8.1 General Overview You have the option of opening a query in when a query has been saved under the following base object in the Navigator: "@99 > A30 > M04 > A10 View queries" However, you cannot edit the query or create new queries. section Creating a base object for queries in COMOS (Page 54). 2.8.2 Opening a query A query has been saved in the Navigator in COMOS. The query is displayed in the Navigator of. Double-click on the query in the Navigator. 24 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.8 Queries Result The query is displayed in the main window. Displaying a query in an own area (Page 25) 2.8.3 Displaying query properties A query has been saved in the Navigator in COMOS. The query is displayed in the Navigator of. 1. Select the query in the Navigator. 2. Select the "Properties" command in the context menu. Result The properties of the query are displayed in the main window. Properties (Page 21) 2.8.4 Displaying a query in an own area A query has been saved in the Navigator in COMOS. The query is displayed in the Navigator of. 1. Open a query. The query is displayed in the main window. 2. Click the button. Operating Manual, 04/2014, A5E32019276-AC 25
Working with 2.8 Queries Result The query is displayed below the Navigator in an own area. This enables you to open another object in the main window. Opening a query (Page 24) 2.8.5 Navigating from the query to the Navigator You have opened a query. See section Opening a query (Page 24). 1. Select an entry from the open query. 2. Select the "Navigate to object" command in the context menu. Result The object is selected in the Navigator. Displaying query properties (Page 25) Displaying a query in an own area (Page 25) 2.8.6 Opening the properties of an object from the query You have opened a query. See section Opening a query (Page 24). 26 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.9 Documents 1. Double-click on the entry in the query. Result The properties of the object are displayed in the main window. If you previously opened the query in the main window, it is closed. If the query contains documents, the last revision of the document is opened. Properties (Page 21) Displaying a query in an own area (Page 25) 2.9 Documents 2.9.1 Document types Overview The following types of documents are supported: Reports See section "Reports (Page 29)". External documents See section "Opening external documents (Page 30)". PQM documents See section "PQM documents (Page 32)". Display of PDF documents To open PDF documents and revisions in, you need Adobe Reader as of version 7.0. Opening a document (Page 28) Operating Manual, 04/2014, A5E32019276-AC 27
Working with 2.9 Documents 2.9.2 Opening a document A document has been saved in the Navigator in COMOS. The document is displayed in the Navigator. Double-click on the document in the Navigator. Result The document is opened. COMOS Reports If you call up the History in the context menu of COMOS Reports, you will also see revisions. Open the properties of a document (Page 28) Document search (Page 37) 2.9.3 Open the properties of a document A document has been saved in the Navigator in COMOS. The document is displayed in the Navigator. 1. Select the desired document in the Navigator. 2. Select the "Properties" command in the context menu. Result The properties of the document are displayed. Properties (Page 21) Opening a document (Page 28) 28 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.9 Documents 2.9.4 Reports Revisions A report is only displayed in if a revision of the report is available. When you open a report, the revision is always displayed. Displaying the revision When you open a report, the last released revision is always displayed. However, you also have the option of displaying older revisions of the report. Opening a document (Page 28) Displaying older revision versions in the History (Page 29) Document search (Page 37) 2.9.5 Displaying older revision versions in the History You have opened a report. See section Opening a document (Page 28). 1. Click the button. The revision list is displayed. This list displays all available revisions of the opened report. 2. Click on an entry in the revision list. Result The report is displayed below the revision list in the selected revision state. Revision list columns (Page 70) Hiding the revision list (Page 30) Operating Manual, 04/2014, A5E32019276-AC 29
Working with 2.9 Documents 2.9.6 Hiding the revision list The revision list is displayed. See section Displaying older revision versions in the History (Page 29). To hide the revision list, click the button. 2.9.7 Opening external documents Opening documents If you open an external document, it is made available for downloading. Use the History to call up revisions of external documents. To open external documents without revisions in, the relevant programs must be installed on your workstation, for example Word or Excel or Powerpoint. If this feature is not available, activate the option that allows pop-ups of the server in the security settings of the Internet browser. Opening a document (Page 28) Document search (Page 37) 2.9.8 Opening the document list 1. Select an object in the Navigator. In the context menu, only the command "Document list" is shown if there are documents under the selected object. 2. Select the "Document list" command in the context menu. 30 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.9 Documents Result All documents under the selected start node are listed in a table. See section "Columns in the document list (Page 70)". XML connector documents are not displayed. Click on the column headers in the table to sort the displayed documents. 2.9.9 Working with the document list 1. Open the document list. See section Opening the document list (Page 30). 2. Select the desired document in the table. 3. Select one of the following options: Select the "Revisions" tab to display the revision of a document. section Version history columns (Page 71). To make revisions, select the "Revisions" tab. section Accepting a revision step (Page 35). Select the "Version history" tab to display the version history of a document. section Revision list columns (Page 70). 2.9.10 Displaying the version of a document Select one of the following options: Open the document list and click on a version of the document. section Opening the document list (Page 30). Open the properties of a document and click on a version. section Open the properties of a document (Page 28). Double-click on the document in the Navigator. section Opening a document (Page 28). Operating Manual, 04/2014, A5E32019276-AC 31
Working with 2.9 Documents 2.9.11 PQM documents 2.9.11.1 General PQM documents When you open a PQM document in, the latest version of it is always displayed. Placeholders indicate the position at which you can upload documents. See section "Uploading documents (Page 33)". You can check out, modify and check in the PQM documents. When you check out a document, you protect it from modification by other users. See section "Checking out documents (Page 33)". You can only check in a document that you have previously checked out. Other users cannot check in documents that you have checked out. See section "Checking in a document (Page 34)". If you have checked out a document, but do not want to modify it, you can undo the checkout. Other users cannot undo your checkout. See section "Undoing check out of a document (Page 34)". The administrator can release documents that you have locked for editing. Exclusions When uploading and checking in documents, the OnBeforeDocumentCheckin script function, for example, is not supported by. The workflows and XREFs are also not supported. Supported script functions The following script functions are supported: OnChange IsValueValid GetLinkedSpecification IsLinkObjectValid OnLinkObjectSet GetDisplayValue GetDisplayXValue GetScriptLinkObject GetScriptLinkObject SetScriptLinkObject OnSaveDone BeforeSave 32 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.9 Documents BeforeCheck FilterRow FillComboList 2.9.11.2 Uploading documents A placeholder for uploading a document is available. You have write rights. 1. Select a place holder in the navigator under which you want to upload a document. 2. Select the "Upload" command from the context menu. 3. Fill out the fields. The fields highlighted in red are mandatory for you to fill out. All entries are saved in the database. You can also set the Linkattribute among other things. section Linkattribute (Page 24). 4. Click the "Browse..." button. 5. Select the document that you want to upload and confirm your selection. 6. Optional: Enter a comment for the document that you are uploading. 7. Click the "OK" button. 8. Click the "Upload" button. 2.9.11.3 Checking out documents You have write access to the document. 1. Select the document in the Navigator. 2. Select the "Check out" command from the context menu. 3. Optional: Enter a comment. 4. Click the "Check out" button. Result The document is downloaded. You can now edit the document and check it in again after editing. Operating Manual, 04/2014, A5E32019276-AC 33
Working with 2.9 Documents 2.9.11.4 Checking in a document You have checked out the document. See section "Checking out documents (Page 33)". 1. Select the document in the Navigator. 2. Select the "Check in" command from the context menu. 3. Fill out the fields. The fields highlighted in red are mandatory for you to fill out. The entries are saved in the database. You can also set the Linkattribute among other things. section Linkattribute (Page 24). 4. Click the "Browse..." button. 5. Select the modified document that you want to check in. 6. Click the "Open" button. 7. Click the "Upload" button. Result The document is now released for editing. Note Script function The script function OnBeforeDocumentCheckin is not supported by. 2.9.11.5 Undoing check out of a document You have checked out the document an do not want to modify it. See section Checking out documents (Page 33). 1. Select the document you have checked out in the Navigator. 2. Select the "Undo check out" command from the context menu. 3. To confirm the action, click "OK". Result The document is now released for editing. 34 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.9 Documents 2.9.11.6 Accepting a revision step The revision file is already stored in COMOS. The revision steps have not been accepted yet. You have the required permissions to release revision steps. Note Create PDF file at first step Only the revision option "Create PDF file at first step" is supported. 1. Open the document list. section Opening the document list (Page 30). 2. Select the required document. 3. Select the "Revisions" tab. The revision steps for the selected document are displayed. 4. Click "Checked". 5. Confirm the revision step with your user name. Result The contents of the tab "Revisions" is updated when the revision step is created. Optional procedure You can also release a revision via the history. 2.9.12 DVM packages A DVM document package combines multiple documents. Display in the Navigator DVM packages are displayed by the following symbol: When you open a DVM package with "+", documents from the last version of the DVM package are displayed. Operating Manual, 04/2014, A5E32019276-AC 35
Working with 2.9 Documents Display last revision of the DVM package (Page 36) Display last version of an individual document of the DVM package (Page 36) 2.9.12.1 Display last revision of the DVM package Double-click the DVM package in the Navigator. 2.9.12.2 Display last version of an individual document of the DVM package 1. Open the DVM package in the Navigator. 2. Double-click the desired document of the DVM package. 2.9.13 Open link A link to an object in is available. You have a user name and password for access to. 1. Start the Internet browser. 2. Enter the link. 3. If the login information is not determined automatically, enter your user name and the password to log in. 4. Click the "Login" button. Result opens. You are directed to the linked object. Settings for creating links (Page 55) Creating a link using a script (Page 56) 36 Operating Manual, 04/2014, A5E32019276-AC
Working with 2.10 Document search 2.10 Document search Searching Document search is a full-text search function across all documents of the opened project. Document search searches through the contents and attributes of all external documents, PQM documents and revised reports. Searching for documents (Page 37) 2.10.1 Searching for documents The search function only works if a search index has been created for the open project. The search index must be created in COMOS. You cannot create a search index in. 1. Enter a search key in the box at the top right corner of. 2. To start the search, click the button. Result The search results are displayed in the "Search results" area below the Navigator. To open a document, or its last released revision, from the results list, double-click on the desired entry. If no results are found relating to the term your entered, you see the following message: "No search results" Operating Manual, 04/2014, A5E32019276-AC 37
Working with COMOS DocumentView 3 The Server, including the current version of COMOS, is set up. See section Installation and configuration (Page 45). If you wish to display external documents, a corresponding program must be installed on the computer. The account with which you log in to COMOS DocumentView must be identical to the account with which you are currently logged in to SharePoint. If you want to open reports, they must be revisioned. Displaying documents 1. Open the link to COMOS DocumentView. If you are not automatically authenticated on the basis of your current Windows account, you will be asked for your username and password in a standard browser window. Enter your login details in this case. 2. Select a document group to list associated documents. The projects and documents selected by the responsible administrator are displayed. 3. Click on a document to display details for that document. The revisions of a document are shown in the details. For DVM documents, a version history is additionally shown. 4. To open a document, click on the name of the document. 5. To open a specific revision or version of a document, click on the relevant link in the details. 6. To quit COMOS DocumentView click on the "Close" button. 7. To release the license in use, click the "Close" button. If you end COMOS DocumentView by closing the browser window directly, the license will only be released following a timeout. Note on data security User name and password are usually not discarded until after the browser is closed. Depending on the browser settings, the login information may also be saved between browser sessions. For security reasons, do not save the data on publicly accessible computers, particularly if you have no access to the browser settings. COMOS SharePoint interface (Page 57) Operating Manual, 04/2014, A5E32019276-AC 39
Working with COMOS DocumentView 3.1 Using the content-based full-text search 3.1 Using the content-based full-text search 1. Select the node you want to search. You cannot use a project or working layer as a start node. 2. Click in the search field. The search mode is activated. If you select a different start node, the search mode remains active. 3. Enter the term that you want to find. 4. Start the search. 5. To close search mode, click the button. Result The search result is displayed in the document list. 40 Operating Manual, 04/2014, A5E32019276-AC
Working with "COMOS Mobile Document Review" 4 Additional information You will find more detailed information on this topic in the "COMOS Mobile Document Review" manual. "COMOS Mobile Document Review" ipad app (Page 64) Operating Manual, 04/2014, A5E32019276-AC 41
Administration 5 5.1 5.1.1 s for operating 5.1.1.1 Server-side requirements Overview To use, the following requirements must be met at the server end: You are using Windows Server 2008 R2. You are using IIS 7 Web server..net Framework 4.0 is installed in addition to the standard.net Framework 3.5 SP2. Frameworks are supplied as standard with the COMOS installation. COMOS is installed on the server. Make sure that the desired port is released on the server for. The user under whom the IIS application pool runs must have read and write access to the COMOS document directory. Note Using UNC address Use the UNC address to address the document directory of the database. Correct: \\<Server name>\<comos document directory> Wrong: O:\<COMOS document directory> The user under whom the IIS application pool runs must have access to the COMOS database and must be registered as administrator in the database. COMOS license If you wish to work with, you need a license server from the setup of the current COMOS version. You cannot use with local licenses. Temporary files stores temporary files, such as icons, in the temporary directory of the user under whom the IIS application pool is running. Operating Manual, 04/2014, A5E32019276-AC 43
Administration 5.1 SSL Use only with SSL, so that the files can be transferred without encoding. See also section Setting up SSL (Page 53). Note Data security If you use without SSL, the data are transferred unencoded between the client and the server. Workstation requirements (Page 44) 5.1.1.2 Workstation requirements Internet browser To use, one of the following Internet browsers must be installed at the workplace: Internet Explorer 10 Chrome 32 Safari 7 The user of must be a Windows user who is registered as a user in the database. Operating system To use, one of the following operating systems must be installed at the workplace: Windows XP SP3 Windows 7 Also use NewCVS. Server-side requirements (Page 43) 44 Operating Manual, 04/2014, A5E32019276-AC
Administration 5.1 5.1.2 Installation and configuration 5.1.2.1 Security information Current version of the web server software environment Always maintain the latest versions of the operating system, the IIS, COMOS and other relevant components. In particular, make sure that current security updates are applied as promptly as possible. If you do not do this, there is an increased risk of hackers exploiting security gaps. Observe manufacturer's security information During installation, configuration and operation of the web server, observe the manufacturer's safety information. Dedicated server If possible, operate on a dedicated server on which no other applications are run. This increases security and prevents server resources from being used by other applications. Access with VPN Operate the COMOS web server or IIS web server in an internal company network, together with the other necessary servers such as database servers, servers for COMOS document directories and the COMOS license server. If remote access with laptops or other portable devices is required, please use VPN. VPN ensures that only those devices and user accounts permitted in the network are used. When you use VPN, authentication between the end devices and VPN access server takes place before a session is started. Via this authentication, you can access with your browser or an app after successful logon. 5.1.2.2 Configuring Windows Server 2008 R2 You can use the "Server Manager" tool to manage roles on Windows Server 2008 R2. The roles "Application server" and "Web server" must be installed. In turn, the role services listed below must be installed for the roles: Operating Manual, 04/2014, A5E32019276-AC 45
Administration 5.1 Role services for the "Application Server".NET Framework 3.5.1 Web Server (IIS) Support Windows Process Activation Service Support HTTP activation Role services for the "Web server (IIS)" Web server General HTTP features Static content Standard document Directory search HTTP error HTTP redirect Application development ASP.NET.NET extensibility ISAPI extensions ISAPI filter Integrity and diagnostics HTTP logging Logging tools Request monitor Tracing 46 Operating Manual, 04/2014, A5E32019276-AC
Administration 5.1 Security Standard authentication Windows authentication Digest authentication Client certificate assignment authentication IIS client certificate assignment authentication URL authentication Request filtering IP and domain restrictions Performance Compression of static contents Compression of dynamic contents Management programs IIS management console IIS management scripts and tools Management service 5.1.2.3 Configuring "Comos.Web.config.xml" The latest COMOS version is installed. You can find additional information on this topic in the "COMOS Platform Administration" manual, keyword "Installing COMOS ". You have administrator rights for COMOS and Windows. 1. Open the "Config" folder in the COMOS installation directory. 2. Open the "Comos.Web.config.xml" file. In the "<Languages>" node, you can see the COMOS user interface languages that are offered when you log into. 3. Comment out unwanted "<Language>" type elements. 4. In the "<Databases>" element, define the databases that the user can select when logging into. Create a "<Database>" element for each database. Operating Manual, 04/2014, A5E32019276-AC 47
Administration 5.1 5. Create the following elements within the "<Database>" element: Element <Key> <Connection> <Name> Description Unique identifier used by to reference the database specified in the <Connection> element. Use only numbers and Latin letters for the identifier. Do not use the same key for different databases; assign a new key to each additional database during configuration. Connection path to the database. Query the path by selecting the "Database info..." command in the "Help" menu of COMOS. SQL database example [SQL - SERVER]PT_SQL_SERVER Display name of the database in the login interface. 6. The Web service creates its own processes, each of which manages a COMOS workset. You can optionally specify in the "<PoolSize>" node how many processes can run at a given time. Recommendation: Allow at most as many processes as the server has cores. If you do not use this element, automatically selects a value based on the system properties of the computer. 7. Optionally, you can define in the "<OverlayLevel>" element the level of the working layers that are displayed in the user interface of when projects or working layers are opened. If the element remains commented out, a tree view for working layer selection is offered by default. 8. Save your changes. Setting up IIS (Page 51) Example for "Comos.Web.config.xml" (Page 48) 5.1.2.4 Example for "Comos.Web.config.xml" Configuration file <?xml version="1.0" encoding="utf-8"?> <Configuration> <Login> <Databases> <!-- SQL --> <Database> <Key>db1</Key> <Name>Database 1</Name> <Connection>[SQL - SERVER]PT_SQL_SERVER</Connection> 48 Operating Manual, 04/2014, A5E32019276-AC
Administration 5.1 </Database> </Databases> <Languages> <!-- German --> <Language> </Language> <LCID>1031</LCID> <!-- English --> <Language> <LCID>1033</LCID> </Language> <!-- French --> <Language> </Languages> </Login> <!-- -> <LCID>1036</LCID> </Language> <!-- Chinese --> <Language> <LCID>2052</LCID> </Language> <Worker> </Worker> - <PoolSize>2</PoolSize> <!-- <OverlayLevel>1</OverlayLevel> --> <SharePoint> <SystemUsers> <!-- --> <SystemUser> <SharePoint>domain\sharePointUser</SharePoint> <Comos>domain\comosUser</Comos> </SystemUser> </SystemUsers> </SharePoint> Operating Manual, 04/2014, A5E32019276-AC 49
Administration 5.1 </Configuration> Configuring "Comos.Web.config.xml" (Page 47) 5.1.2.5 Maximum file size File size for uploading files You can specify the maximum file size for uploading. To do so, edit the "Comos.Web.config" configuration file. You can transfer files up to 100 MB. The default setting is 100 MB. Configuration example The following configuration example supports the transfer of files up to 100 MB: <?xml version="1.0"?> <configuration> <system.diagnostics> <switches> <add name="appglobal" value="warning" /> </switches> <sources> <source name="appglobal" switchname="appglobal" switchtype="system.diagnostics.sourceswitch"/> </sources> <trace autoflush="true" indentsize="2" /> </system.diagnostics> <system.web> <customerrors mode="off"/> <!-- Specifies the limit for the input stream buffering threshold, in KB.This limit can be used to prevent denial of service attacks that are caused, for example, by users posting large files to the server. The default is 4096 (4 MB).--> <httpruntime maxrequestlength="102400"/> </system.web> <system.webserver> <security> <requestfiltering> <!--Specifies the maximum length of content in a request, in bytes. The default value is 30000000, which is approximately 28.6MB.--> <requestlimits maxallowedcontentlength="136314880"/> </requestfiltering> </security> </system.webserver> <system.servicemodel> <bindings> <webhttpbinding> 50 Operating Manual, 04/2014, A5E32019276-AC