Queries COMOS. Platform Queries. Trademarks 1. Concept of queries. Object Browser 3. Run modes for object queries. Standard queries.

Transcription

1 Trademarks 1 Concept of queries 2 COMOS Platform Operating Manual Object Browser 3 Run modes for object queries 4 Standard queries 5 Other queries 6 Database search 7 Update Classification 8 Bulk processing 9 Object queries by means of script 10 04/2012 A5E

2 Legal information 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 with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken. CAUTION without a safety alert symbol, indicates that property damage can result if proper precautions are not taken. NOTICE indicates that an unintended result or situation can occur if the relevant information is not taken into account. 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: 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. Trademarks 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 NÜRNBERG GERMANY A5E P 05/2012 Technical data subject to change Copyright Siemens AG All rights reserved

3 Table of contents 1 Trademarks Concept of queries The term "Object query" The most important capabilities of the query General object query Object Browser Standard queries Definition "Bulk processing" Dragging object queries to a report Object Browser Overview Display of the object list Changing the order of the columns Row height Column width Changing the row selection by means of the keyboard Editing cells directly Display attributes (additional columns) Row statistics Sort Filter Interaction with "Sorting/Filter" Operation Filter operators Disabling sorting or the filter Sorting / Filter Sorting area Filter area Options "General" tab "Administration" tab "Input layout" tab "Edit column" tab General Object calculation Value calculation Extras...37 Operating Manual, 04/2012, A5E

4 Table of contents Languages Extension classes Export New (additional columns) "General" column "General" tab "Object evaluation" tab "Value calculation" tab "Object by value" tab "Extra" tab "Languages" tab Default columns (project, timestamp...) Context menu "New > Row statistic" Other commands in the context menu "Print" "Delete" "Properties" "Remove" "Script" tab: Run modes for object queries Overview Setting the implementation mode Default mode (DefaultRunMode) Current run mode Simple mode Context menu of the column headers The context menu for objects of the result set Saving local settings Alternative display of queries Opening queries in the classic or alternative display Working with the alternative display of queries Standard queries Creating and opening standard queries Standard for terminal strips or wire lists Saving standard queries Operation: Standard controllers Standard query: Planning objects Standard query base objects Standard query Attributes Standard query Documents General Using the PDF export Further information regarding printing Standard query Connectors Operating Manual, 04/2012, A5E

5 Table of contents 5.9 Outputting standard queries in reports All document tools Other queries Translation Displaying query views in the Navigator Reimport Device selection (product data) User-defined Query as a list Standard tables Standard table values Database search Preparation of the database based search Performing the classification Classification criteria Project properties for the database based search Creating a query for a database based search for objects The query window Fields and function elements of the query window Creating user-defined fields Creating additional filters Executing the search Saving the query Database based search for documents Creating a query for the database based search for documents Cross-project queries Creating cross-project queries Using cross-project queries across all projects Using cross-project queries across individual projects and work layers Update Classification Classification Updating classifications Bulk processing Bulk processing: Preliminary notes Old and new techniques Interface Bulk processing of engineering objects Purpose The left window area The right window area Work flow for bulk processing Setting the object and defining filters Operating Manual, 04/2012, A5E

6 Table of contents Collecting and preparing attributes Save the settings Marking objects Changing the general data and the attributes Concluding bulk processing Bulk processing of base objects Bulk processing of attributes Bulk processing for documents Bulk processing for connectors Object queries by means of script Controlling object queries via script Action script block Operating Manual, 04/2012, A5E

7 Trademarks 1 Trademarks Registered trademark: COMOS Operating Manual, 04/2012, A5E

8 Trademarks 8 Operating Manual, 04/2012, A5E

9 Concept of queries The term "Object query" Each software that processes large amounts of data requires a tool to query and display data. The data is managed in COMOS in the form of objects. The objects are the containers and contain the actual information. If you want to query the data, you have to open these containers the objects. The tool you need for this purpose is called object query in COMOS. The results of the object query are passed back in the form of a virtual table: Each row is based on an evaluated object. You can evaluate text information contained in this object or also identify additional objects that are related to the input object. Example: You determine the owner or the project from the object. Information is read from the input object or additional objects that have been determined and written into the rows of the virtual table. Each item of information that is displayed in a cell is thus ultimately based on a queried object. In the documentation that follows mention is only made of object queries and it is assumed that the reader understands that this refers to the invisible results table rather than to something visible. Definition An object query is a tool to extract information from a number of objects and to pass it back in the form of a data matrix. COMOS also provides a number of other options to query and modify data. For example, you can use a script to access the data, or else address one of the COMOS open interfaces by means of Visual Basic. But object queries are extremely simple and safe to use in comparison with a selfprogrammed query or VB and in principle they have the same functional scope. Operating Manual, 04/2012, A5E

10 Concept of queries 2.2 The most important capabilities of the query 2.2 The most important capabilities of the query 1. User input: Formulation of the query The query requires a collection of objects for the calculation. 2. Calculation of the query results The results of the query are created in a virtual table, a so-called data matrix. The number of rows is the same as the number of queried input objects (basic quantity). The number and type of the columns is the same as the number and type of the queried information. The calculation of the table cell takes place at the earliest when the cell is readout. This readout can have the following reasons, for example: This cell appears in the Object Browser (see the following). This cell appears in an evaluation report. The cell is checked while the data is sorted or filtered, etc. For example, if you display an object query in an object browser, only the visible part is initially calculated. This accelerates the display. The COMOS object query is initially virtual. The calculation of the object query is completely independent from the screen display and can run in the background. Advantages: If required, you can further process this query result in EDP without needing to rely on a time-consuming display. The object query itself can work with any type of object and, in theory, can also process information outside of COMOS. The rules by which the query and the calculation are carried out can be saved and read as archives. 3. Optional: Visual display The form of display can be as you wish. As a rule, an object query is displayed by means of the shipped Object Browser. 2.3 General object query There is a general object query which is used at various points in COMOS: You find more information on this topic in the "Basic Operation" manual under the keyword ""Restore" command". DVM queries: "Bulk Checkin / Checkout" 10 Operating Manual, 04/2012, A5E

11 Concept of queries 2.4 Object Browser 2.4 Object Browser The Object Browser displays the information of an object query. The Object Browser resembles an Access table in its form of display: Normal users will, as a rule, only come into contact with object queries via the Object Browser. For that reason you can easily get the impression that the Object Browser is the object query. But this is not the case. As described above, this involves only one of the possible forms of display of the object query. You can just as easily and reliably display object queries as evaluation reports, for example. In this case an object query can no longer be recognized as such among many others. In principle you can also work within the Object Browser. Depending on the settings in the Object Browser, you can input text and select values, etc. in the table. The Object Browser is used almost everywhere throughout COMOS. It is the usual way of displaying information in COMOS. See also Object Browser (Page 15) 2.5 Standard queries Standard queries are used to: Enable user inputs by which the query is formulated. The primary task here is to determine the quantity of objects that are evaluated by the object query. To execute the query, hence to calculate the results. To display the results in a usual way for COMOS. Each standard query is specialized and only offers a portion of all possibilities of an object query. Each standard query has its own interface to match the special tasks in question. Operating Manual, 04/2012, A5E

12 Concept of queries 2.5 Standard queries Since standard queries are restricted to COMOS information, they can only be used within COMOS. The object query itself can work with any type of object and, in theory, is also capable of processing information outside of COMOS. Standard queries have the following structure: The basis is formed by a COMOS object of system class CDevice/Device. This COMOS object gets the "Action" class and a suitable subclass. The COMOS object gets a specific interface, this being an independent interface with its own abilities. From then on the normal user only sees this special interface and the standard query can not be recognized visually as a base object/ object. This special interface in its core uses an Object Browser in order to display the information. A number of edit fields, menu bars, etc. are arranged around the Object Browser. The expanded interface for the "Engineering objects" standard query is given here as an example: The table-like display of the Object Browser can be seen clearly in the center. 12 Operating Manual, 04/2012, A5E

13 Concept of queries 2.6 Definition "Bulk processing" 2.6 Definition "Bulk processing" Almost all usual inputs can be made within the Object Browser, and of course within a standard query as well. In very special cases, the entry options available within the Object Browser are not sufficient, and bulk processing can be used in such cases. Graphic display of information This also relates to the graphic display of attributes based on tabs, for example. Bulk processing serves to query and display specific COMOS information and to process data easily and securely. Each form of bulk processing is specialized. Each form of bulk processing uses a standard query within its core. A number of fields, menu bars, etc. are arranged around the standard query. As an example, here is the bulk processing for "Engineering objects": The left side of the window consists of the standard query "Engineering objects". Applications of object queries Ultimately there are also cases in which object queries are used for specific technical or administration-related procedures. Examples: An example for a subject-specific application is the product data device selection. This application is used when request objects are to be replaced by concrete manufacturer devices in the course of the planning work. An example of an administration-related application is the "Translation" application. This application is used to translate texts in COMOS. An important application is the user-defined query. Thus a standard query that is as neutral as possible is created so that the user can structure it according to his own wishes. Operating Manual, 04/2012, A5E

14 Concept of queries 2.7 Dragging object queries to a report 2.7 Dragging object queries to a report You find more information on this topic in the "Reports - Basic Operation" manual, keyword "Outputting object queries as a list". 14 Operating Manual, 04/2012, A5E

15 Object Browser Overview The Object Browser displays the information of an object query. The Object Browser resembles an Access table in its display. The Object Browser is divided into various areas: 1. Header, also called column title If you right-click on a desired title of a query column, you get a series of nested menus: 2. Object list, also called cells Each row of the object list is based on an evaluated object. You can evaluate text information from this evaluated object and also determine further objects that have a relation to the evaluated object. Example: You determine the project from the evaluated object (first column in the above illustration). Information is read from the evaluated object or additionally derived objects and written into the cells. Each item of information that is displayed in a cell is thus ultimately based on a queried object. If you right-click on a cell, you get the same context menu as when you click the object in the cell within the Navigator. In particular, you get the navigation menu and the "Properties" command. The display of the object list can be changed. Operating Manual, 04/2012, A5E

16 Object Browser 3.2 Display of the object list See also Sort (Page 20) "Print" (Page 49) Export (Page 39) "Delete" (Page 49) "Properties" (Page 49) Display of the object list (Page 16) Filter (Page 22) Sorting / Filter (Page 28) Run modes for object queries (Page 51) Options (Page 31) New (additional columns) (Page 40) 3.2 Display of the object list Changing the order of the columns You can change the order of the columns in the object browser. Use drag-and-drop to move a column to another position Row height Right-click on a desired column title and select the "Options" command. You can enter the row height directly in the "General" tab. Enter integer numbers only. Alternatively, you can turn on the data set selectors. 16 Operating Manual, 04/2012, A5E

17 Object Browser 3.2 Display of the object list As a result, boxes called dataset selectors appear at the left in the list: Move the mouse cursor to any point on the separator line of the data set selectors until it changes into a double arrow: Hold down the left mouse button and drag the mouse downwards until you reach the desired row height. All other rows are automatically set to the height that you selected Column width Slowly move the mouse pointer in the title bar above the right hand separator line of the column that you wish to modify. When the mouse pointer turns into a double arrow, press the left mouse button and drag the column to the desired width: Unlike the case when changing the row height, changing the column width only affects the selected column Changing the row selection by means of the keyboard You can use the keyboard to select a row in the Object Browser. This procedure only works for rows that are not editable. See also "Edit column" tab (Page 35). Operating Manual, 04/2012, A5E

18 Object Browser 3.2 Display of the object list Procedure In order to select a row by using the keyboard in the Object Browser, proceed as follows: 1. In the Object Browser mouse click in the column in which you want to select a row. 2. Enter the first letter of the object on your keyboard that is located in the row you want to select. The row containing the object which starts with the letter you have entered is selected Editing cells directly In the case of object queries it is possible to input a new value directly into a cell of the list. Object queries, therefore, not only evaluate the COMOS data, but are also capable of modifying COMOS data in a simple and efficient way. For this to happen, the "Editable" option needs to be enabled in the properties of a column in the "Value calculation" tab. See also "General" column (Page 40). This option is only available if the contents of the column are editable. Attributes of the "List" type can also be modified within the object query as described. Multiple cells can also be edited simultaneously. Select the desired cells and then press the <F2> key or use the "Edit" command. If columns are locked in such a way that no cells can be edited in these columns, the locked cells are displayed in gray. You find additional information on this topic in the "Inheriting, Copying, Deleting" manual. Automatic conversion Old queries are converted in such a way that this option is also enabled for all columns in which the "Editable" option was selected. 18 Operating Manual, 04/2012, A5E

19 Object Browser 3.3 Display attributes (additional columns) 3.3 Display attributes (additional columns) Attributes can be imported into the list area as additional columns. Use drag&drop to import an attribute into the list area: Result You now see a new column, but there is no entry for each row in the column. If the cell is blank, then either nothing is entered in the attribute or else the object does not have this attribute. You can tell from the context menu which of these two cases applies. Right-click in the blank cell to do so: If the attribute exists but is empty, the "Navigate > Attribute" command is available in the context menu of the cell. If the attribute does not exist for this object, this command is not available. If you have dragged an attribute into the list area which has a value and a unit, the value, together with the unit and the column which was created for the attribute is displayed. In this case, the following context menu is available in the column header: "Split: Value Unit " Attributes with extension values If a "List" type attribute or an "Edit(Min...Max)" range attribute is dragged onto the column header of the object query, the program automatically creates as many columns as are needed to display all values and extended values. 3.4 Row statistics Column header of the table, context menu "New > Row statistic..." This context menu offers commands that increase the clarity of the rows, such as "Number" or "Amount". Operating Manual, 04/2012, A5E

20 Object Browser 3.5 Sort 3.5 Sort Interaction with the combined "Sorting / Filter" window There is a "Sorting / Filter" window in which sortings and filters can be created simultaneously. This combined window is the main controller for all filters and sortings. You open it via the "Sorting / Filter" command in the context menu. The in this section described "Sort element" window always relates to this main controller and also offers a subset of control options. If sorting has been set in the "Sort element" window, this sorting also appears automatically as a row in the "Sorting / Filter" main controller. Only use the "Sort element" window for simple sorting tasks. Otherwise always use the main controller. There is also the option to set a lock and thus to prevent changes in the "Sorting / Filter" main controller. If a lock was set there, the "Sorting" command is no longer available in the context menu. Background: Sorting techniques Texts can be managed as strings or in a numeric form in object queries. A purely lexical sorting is used for a string. In the dictionary "Aa" comes after "A". This mainly applies for the case if the string only contains numbers. Just as "Ab" comes before "B", "12" comes before "2" for a string sorting. In a numeric sorting "12" comes after "2". You can also construct similar irregularities for the case of mixed letters and numbers. Operation Right-click in the column header and select "Sort" from the context menu. At first, the quick sortings, "Ascending" and "Descending", are offered. This saves you from having to open the "Sort element" window and making a corresponding decision there. The "Sort element" window is opened with the "Edit" command and a whole series of further options are made available in addition to "Ascending" and "Descending": The following tables describes the individual control elements of the "Sort element" window: Control element "Ascending" / "Descending" buttons Description Sorts the entries in ascending or descending order. The text "Up" or "Down" is displayed to the right of the "Sort element" window when you click the corresponding button. 20 Operating Manual, 04/2012, A5E

21 Object Browser 3.5 Sort Control element "Alphabetical" button "Numeric" button "Alphanumeric" button "Case sensitive" checkbox "Grouping" buttons Description Sorts the entries in alphabetical, numerical or alphanumeric order. The text "Alphabetic", "Numeric" or "Alphanumeric" is displayed to the right of the "Sort element" window when you click the corresponding button. Note: The selected sort method must match the contents of the cells in this column. If you select the "Numeric" button but the texts also contain letters, hence "Alphabetic" or "Alphanumeric" is correct, the rows will not be sorted correctly. When this checkbox is selected, case sensitivity is regarded during the sorting. You set the grouping index by using the and buttons. A grouping generates a nested table. Plus and minus characters are created at the left edge of the table, by which you can expand or close similar types of rows. The columns that are used for grouping are automatically sorted to the far left. Effect An active sorting is displayed by a triangle in the column title: Rows are always kept together. If a sorting is set in a column, then the entire table is arranged correspondingly in rows. Sortings in multiple columns have a sequential effect. If a sorting is first set in column B and then in column A, the sorting is carried out first according to B and subsequently within this sorting according to A. If the sorting B is deleted, then only the A sorting takes effect and the table is rebuilt correspondingly. Multiple sorting It is possible to subsequently call the "Sort" command in different columns. The sortings then take effect in the order in which they were set up. Different sorting sequences produce different results. This approach has the disadvantage that you cannot tell in which order the sorting was set up. If you want to set multiple sorting, use the "Sorting / Filter" main controller. Operating Manual, 04/2012, A5E

22 Object Browser 3.6 Filter AutoSort By clicking the button in the column header, you can automatically sort the column entries in ascending or descending order. See also Sorting / Filter (Page 28) 3.6 Filter Interaction with "Sorting/Filter" There is a "Sorting / Filter" window in which sortings and filters can be created simultaneously. This combined window is the main controller for all filters and sortings. The in this section described "Filter element" window always relates to this main controller and only offers a subset of control options. If a filter is set in the "Filter element" window, this filter also appears automatically as an AND row in the "Sorting / Filter" main controller. If there already is a complex entry in the "Sorting / Filter" main controller, the "Filter" command is switched off completely. Only use the "Filter element" window for simple sorting tasks. Otherwise always use the main controller. See also section "Sorting / Filter (Page 28)". There is also the option to set a lock and thus to prevent changes in the "Sorting / Filter" main controller. If a lock has been set there, the "Filter" command is no longer available either Operation Right-click in the column header and select "Filter > Edit" in the context menu. The "Filter element" window opens: 22 Operating Manual, 04/2012, A5E

23 Object Browser 3.6 Filter The control elements in the "Filter element" window have the following meaning: "Filter operator" list Describes how the filter value is evaluated. See also section Filter operators (Page 24). "Filter value" list Relates to the filter operator. When you expand the list, all entries of this column are offered. You can enter your own filter values. For example, with the "Include" filter operator you can set the filter value "t" to find all words that contain a 't' at any position. Regard "Case sensitive" option This option allows case-sensitive filtering. Display An active filter is displayed by a bold column title. Multiple filter You can call the "Filter" command in succession in the various columns. This approach has the disadvantage that you cannot select all possible filter links. If multiple filters are set in this way, it always has to involve AND operators. If you want to set multiple filters, you should use the "Sorting / Filter" main controller. See also section Sorting / Filter (Page 28). AutoFilter By clicking the button in the column header, you can automatically sort the column entries in ascending or descending order. Operating Manual, 04/2012, A5E

24 Object Browser 3.6 Filter Filter operators "Include" When you select the "Include" filter operator, all entries containing the exact string specified in the filter value are displayed. Example: The "diagram" string displays the terminal diagram, diagram overview etc. "=" Searches for all entries that correspond to the condition. The result exactly matches the entry in the "Filter value" field. ">" Searches for all entries that correspond to the condition. Example: With a filter value of "100", "101" is also displayed but "66" is not. With a filter value of "D", "F" is also displayed but "B" is not. ">=" All entries that match the condition are searched, i.e. those greater than or equal to the entered filter value. "<" Searches for all entries that correspond to the condition. Example: With a filter value of "100", "66" is also displayed but "101" is not. With a filter value of "D", "B" is also displayed but "F" is not. "<=" All entries that match the condition are searched, i.e. those less than or equal to the entered filter value. "<>" All entries that match the condition are searched, i.e. those not equal to the entered filter value. 24 Operating Manual, 04/2012, A5E

25 Object Browser 3.6 Filter "Like(VB)" This filter operator uses the definition of Like from Visual Basic and serves to compare two character strings. A brief overview is provided by clicking the "?" button. Syntax Result = character string Like pattern The syntax of the "Like" operator consists of the following parts: Part Result Character string Pattern Description Required. A desired numeric variable. Required. Any character string. Required. Any string expression with a valid comparison pattern. Notes If character string and pattern correspond to each other, the result is "True". If there is no match the result is False". If either the character string or the pattern has the value zero, the result is also "Zero". The behavior of the operator "Like" depends on the "Option Compare" command. The standard method for comparing the character string in all modules is "Option Compare Binary". With "Option Compare Binary", character comparisons are based on a character string which is defined by an internal binary display. The order of sorting is defined by the code page. The following example is a typical binary sorting order. A < B < E < Z < a < b < e < z < À < Ê < Ø < à < ê < ø "Option Compare Text" leads to character string comparisons that use the sorting order for characters of the in the "locale" settings of the system (where case sensitivity is not considered) The above displayed characters would be put in the following order if they were sorted with "Option Compare Text": (A=a) < (À=à) < (B=b) < (E=e) < (Ê=ê) < (Z=z) < (Ø=ø) The integrated pattern comparison is a versatile tool for comparing character strings. With the pattern comparison methods you can set placeholders, character lists or character areas in a desired combination in order to compare characters. The following table shows the placeholder characters that can be used for a pattern and their respective meaning: Character in pattern In the character string stands for? A desired single character * No or multiple characters. # A desired single number (0-9). [CharacterList] A desired individual character in the CharacterList. [!CharacterList] A desired individual character which is not contained in the CharacterList. Operating Manual, 04/2012, A5E

26 Object Browser 3.6 Filter A group set in squared brackets [ ] with one or more characters (CharacterList) can be used to compare any character in the character string and can contain almost all character codes (also numbers). Escape for special characters The special characters left bracket ([), question mark (?), the character # and the asterisk (*) have to be set in squared brackets in order to be used for a comparison. The right squared bracket ("]") cannot be used in a group of to be compared characters. It can be specified as a single character outside a group. Notes In a CharacterList you can also define a range of characters by defining the largest and smallest value of the range, divided by a hyphen (-). [A-Z] as an example leads to a match if the corresponding character position in the character string contains a capital letter in the A to Z range. Multiple ranges can be stated without further separators one after another in a bracket pair. The meaning of the stated area depends on the at the runtime valid character order (which is defined via "Option Compare" and the "locale" settings). In the described example for "Option Compare Binary" [A-E] A, B and E are contained in the area [A-E]. For "Option Compare Text" the characters A, a, À, à, B, b, E, e are contained in the area [A-E]. Ê or ê are not contained because accentuated characters are placed after the corresponding character that is not accentuated. Important rules for comparing patterns: An exclamation mark (!) at the beginning of CharacterList means that there will be a match if the character string contains any character except the characters found in the CharacterList. If the exclamation mark is used outside the squared brackets it serves as a placeholder for itself. A hyphen (-) can either stand at the start (after an exclamation mark, if available) or at the end of the CharacterList in order to serve as its own placeholder. In every other position the hyphen serves to label a character area. When a character area is defined, the characters have to be defined in an ascending sorting manner (from the lowest to the highest). [A-Z] is therefore a permissible pattern, [Z-A], however, is not. The string [] is interpreted as a zero character string (""). Ligatures In some languages there are certain characters in the alphabet that actually display two separate characters. In various languages the character "æ" is used to display the characters "a" and "e" when they appear next to each other. The operator "Like" detects that single special character and the two single characters are equal. 26 Operating Manual, 04/2012, A5E

27 Object Browser 3.7 Disabling sorting or the filter If a language which uses one of theses special characters is specified in the country settings of the system, the system will recognize that the individual special character in Pattern or Character string match the corresponding sequence of two characters in the other character string. In the same manner as a matching between a single special character in the pattern, which is embedded in squared brackets (as single character in a list or an area), and recognized in the according two characters in the Character string. Example operator "Like" In this example the "Like" operator is used in order to compare a character string with a pattern. Dim Test1 Test1 = "abbba" Like "a*a" returns True. Test1 = "F" Like "[A-Z]" returns True. Test1 = "F" Like "[!A-Z]" returns False. Test1 = "a2a" Like "a#a" returns True. Test1 = "am5b" Like "a[l-p]#[!c-e]" returns True. Test1 = "BAT123khg" Like "B?T*" returns True. Test1 = "CAT123khg" Like "B?T*" returns False. 3.7 Disabling sorting or the filter Requirement A filter or sorting is set for a column. Procedure To disable a filter or sorting, proceed as follows: 1. Right-click in the Object Browser on the column in which a filter or sorting is set. 2. Select one of the following options: If you want to disable sorting, select "Sort > Off" in the context menu. If you want to disable a filter, select "Filter > Off" in the context menu. Result The sorting or filtering is disabled. If the column was previously sorted, the triangle is no longer displayed in the column header. If the column was previously filtered, the text is no longer displayed in bold in the column header. Operating Manual, 04/2012, A5E

28 Object Browser 3.8 Sorting / Filter 3.8 Sorting / Filter This command opens a window in which you can define a custom combination of sorting and filtering: The upper and lower window areas are independent from one other, although the instructions are carried out in both windows when the window is confirmed by pressing the "OK" button Sorting area See also section Sort (Page 20). Incorrectly input sortings can be deleted line by line via the context menu. Resorts the order of the rows. This of course changes the sorting result. "Release / Lock" These toggle switches permit changes to the settings or prohibit these changes. If a lock was set here, the "Sort" command can no longer be used. See also section Sort (Page 20). 28 Operating Manual, 04/2012, A5E

29 Object Browser 3.8 Sorting / Filter Set sorting The fields can be filled via the lists. Click on the field and select an entry from the list. Once you selected an entry in the "Column" field, the remaining cells in a row can be changed by means of the buttons above. Alternatively: Right-click on a row and select the "Properties" command. The "Sort element" dialog window opens. See also section Sort (Page 20). Set grouping You can enter an integer grouping index in the "Grouping" column: A grouping creates a hierarchical list in which you can expand and close the next data level in the same way as in the Navigator. Even though the technique looks similar to the operation in the Navigator, the contents are different. In the Navigator, the objects are arranged hierarchically as a rule, and the next level that is folded out displays the hierarchical "children". The grouping is completely free within the object query and only depends on your decision, so as a rule it only reflects the hierarchical relationship purely by chance. The front fields of the sorting must be filled in first to enable the grouping to take effect. Possible result: Operating Manual, 04/2012, A5E

30 Object Browser 3.8 Sorting / Filter Filter area These commands determine how the various filters are supposed to interact with each other. "AND" command: Only results that meet all filter criteria are displayed. "OR" command: Results that meet one or more filter criteria are displayed. "NOT" command: All values in the "Filter operator" field can be negated with this operator. This thus doubles the number of possible filter operators. The rows must produce a logically correct expression. This means that the brackets change an expression if "AND", "OR" and "NOT" are mixed. Thus a correct combination with brackets would look like the following: If you do not mix the operators, omit the brackets. "Move rows" These two buttons let you change the order of individual selected rows with filters or sortings. "Release / Lock" These toggle switches either permit changes to the settings (green) or prohibits them (red). If a lock was set here, the "Filter" command can no longer be used. See also section Filter (Page 22). "Set filters" The front fields can be filled by means of lists. Click on the field and select an entry from the list. "Logical operator" This entry determines the interaction of the individual rows (the "filter elements"). Overall, this must produce a logical expression, as described above. "Column" This value determines on which column the filter is to take effect. 30 Operating Manual, 04/2012, A5E

31 Object Browser 3.9 Options "Filter operator" These filter operators work as described. See also section Filter operators (Page 24). These commands are also available in the context menu. "Filter value" You make an entry in the "Filter value" column. The editing mode for the cell is started by pressing F2 or double-clicking. 3.9 Options It does not matter in which column this command was selected. This always affects the entire Object Browser "General" tab Overview The following table describes the control elements on the "General" tab: Control element "Cell oriented (ByCell)" option "Cell oriented (ByRow)" option "Simple" option "Extended" option "Multiselection" option "Permit new row" option "Apply immediately" option Description When you activate this option only the cell in the object browser is always marked upon selection. Right-clicking on a cell opens the context menu that relates only to that cell. When you activate this option the entire row in the object browser is marked upon selection. When you right-click on a cell the context menu refers to the entire row. This option starts the query in the simple mode. See also section Run modes for object queries (Page 51). This option starts the query in extended run mode. When this option is selected, you can select multiple cells. When this option is selected, a new row is displayed in the Object Browser where you can enter additional information. When this option is selected, it only has an effect if the "Permit new row" option is set. When this option is selected, each row is evaluated immediately as soon as you exit the editable cell. This also applies to the new row. If you do not enable the option "Permit new row", the lines are evaluated only when you click the "Apply" button. Operating Manual, 04/2012, A5E

32 Object Browser 3.9 Options Control element "Row height" field "Headline size" field "Number of fixed columns" field "Data set selectors" option "Cell style" option "Hierarchy levels opened" option "Change monitoring" option Description In this field you define the factor by which the row is extended compared to a standard row. Only integers are allowed. In this field you define the headline size of the object browser. You use this field to specify the data that are to remain visible when scrolling in the Object Browser. This option displays boxes at the beginning of each row which can be used to manually control the row height using the mouse. See also section Row height (Page 16). This option enables the usual display of object information in COMOS. Inherited texts are in italics, individual entries appear in blue, etc. This option requires a relatively large amount of computing time and should only be selected for small numbers of objects or with a fast PC. Otherwise the response time will be very slow. If the results from the Object Browser are only to be output in an evaluation report, this option can then be deactivated, since it only unnecessarily extends the calculation time. When this option is enabled, a configured grouping is automatically opened at the start of the object query. See also Sorting area (Page 28). When this option is enabled, most of the changes automatically appear immediately in the Object Browser. If monitoring is disabled, changed information only appears when you manually refresh the window. This option requires a relatively large amount of computing time and should only be selected for small numbers of objects or with a fast PC. Otherwise the response time will be very slow. This option can be deactivated if you only require information from the query that is of interest and is normally not changed by other persons. An example for this are the object description texts in the event of a translation. 32 Operating Manual, 04/2012, A5E

33 Object Browser 3.9 Options "Administration" tab "Enable change" If this setting is locked, no additional changes can be made in the Object Browser. This concerns the column order, filter and sorting, new columns, etc. Note This change protection also locks the object or the object property with regard to changes via a script or the like. Only visual changes, such as those made to the row height, are excluded from change protection. "Enable saving" If this setting is locked, changes can still be made in the Object Browser, but these changes are not saved and are discarded when the Object Browser is closed. This change protection also locks the object or the object property with regard to changes via a script or the like. Extended administration If the "Extended" button is selected, you have the option to control the rights much more precisely. You can also select multiple cells and lock or unlock the cells together by using the context menu in the columns "Enable change (Lock/Release object)" and "Enable save (Lock/Release archive)": Operating Manual, 04/2012, A5E

34 Object Browser 3.9 Options The following table describes the entries in the "Object type internal" column: Entry "ITopQuery-Browser" Description All properties across dialog windows: "Search at once" button "ITopQuery" All properties concerning the displayed collection (the total number of found objects or the number of displayed objects): Folder options: "without" "only" "all" additional search options Search mechanism: "recursive" "not recursive" Placing/drawing type Lists: "Class" "Start object" "Base object" Subordinate display options: If "ITopQuery" is locked, this locks "IQuery" and therefore automatically all rows below. "IQuery" "IFilter" "ISort" "IColumnDefs" Subordinate display options: If "IQuery" is locked, all rows below are automatically locked. All settings that relate to filters. All settings that relate to sortings. This row concerns all actions that relate to columns but which cannot be allocated to a special column: The "New" command is disabled in the context menu. Thus no new columns can be created in the engineering object. Columns can no longer be moved within the engineering object. All subordinate display options: If "IColumnDefs" is locked, all rows below are automatically locked. "IColumnDef" All information relating to a specific column: labeling sorting filter etc. Other "IColumnDef" An "IColumnDef" row is offered for each existing column. 34 Operating Manual, 04/2012, A5E

35 Object Browser 3.9 Options "Extended object" field Here you can specify your own DLL file and thus also your own interface, for example that is to be run when the object query is started. The DLL file is entered here via its ProgID from the Windows Registry "Input layout" tab Use this tab to specify which menus are to be displayed in the Object Browser. Select the appropriate option for this in the "Visible" column "Edit column" tab The column editing function offers a complete overview of all columns including access to the properties of any column. However, this tab is not divided into additional tabs: Instead, you switch between the various editing options by using the toolbar: The individual areas correspond to the tabs in the properties of a column. In addition, the "Edit column" tab offers additional information that is not visible in the properties of a column. If you see the editing options of different areas simultaneously, you can disable the "Show single" button. If the button is disabled, multiple areas can also be switched on simultaneously. New columns If you have the necessary rights, you can create a new column via the "New" command in the context menu. This column becomes visible in the Object Browser as soon as you confirm the "Options" window. Here it is also possible to use a template for a new column. To do this, you simply copy a row (a row corresponds to exactly one column) and paste the row again. The new row contains the previous name with a counter. This also works generally: you can copy such a row with a column definition and paste it into another query. Operating Manual, 04/2012, A5E

36 Object Browser 3.9 Options General This area corresponds to the "General" tab in the properties of a column. See also section "General" tab (Page 40). Therefore, if you change anything here, it has the exact same effect as when you make a corresponding entry in the properties of the column. However, in this case you access the properties of all columns. The following table describes the individual columns: Column "Name" "Description" Description Mandatory field. A unique name with which the column is managed internally. The length of the name is restricted to 250 characters. Optional. Title of the column in the display. "Reference" "Row object" entry Each row of the object list is based on an evaluated object, the row object. <Column name> entry: Each item of information displayed in a cell is ultimately based on a queried object. This can also be an object that only has a specific relationship to the evaluated object. If a column is selected as the reference, then precisely that object is used in the corresponding cell as the starting point for further calculations, which is located in the neighboring cell of this designated column. "Display symbol" "Numeric" "Filter permitted" "Sorting permitted" "Grouping permitted" "Adding" "Master column" "Visible" "Visible for the user" "Locked" Displays the associated symbol, if available. Changes the way numbers are handled during filtering/sorting: Either as a number or a character. Example: In the case of a number, 2 is less than 10 in the usual way, while with characters a comparison is made on the basis of characters and thus 10 is less than 2 (in exactly the same way that "Aa" is smaller than "B"). It is permitted to set a filter for this column. Activates sorting. The "Sorting allowed" option must be enabled if "Grouping allowed" is to be enabled. This field is only active if sorting had been permitted beforehand. Activates grouping. Totals the entries within the column, as far as possible. Defines which column is the master column. The master column is the column that offers the row object when an object is generated. Specifies which columns are displayed or hidden in the extended mode when the query is started the first time. See also section Run modes for object queries (Page 51). Defines which columns are displayed or hidden in the extended mode after the query is started the first time. Displays which columns are locked. 36 Operating Manual, 04/2012, A5E

37 Object Browser 3.9 Options Object calculation This area gives an overview of the "Object evaluation" tab in the properties of a column. See also section "Object evaluation" tab (Page 40). If you right-click on a row here, you can open the properties of the column by using the "Properties" command and change the object evaluation there Value calculation This area gives an overview of the "Value calculation" tab in the properties of a column. See also section "Value calculation" tab (Page 46). If you right-click on a row here, you can open the properties of the column by using the "Properties" command and change the object evaluation there. The information of the "Value calculation" tab is displayed and synchronized here as follows: Properties of the "Value calculation" tab "Calculation mode" field: "Standard property" "Display" field (An entry is selected): "Calculation mode" field: "Script" "Calculation mode" field: "Expression (CallByName)" (Underneath: Expression entered) Column editing, "Value calculation" area Direct selection option in the "Standard property" column. If a selection is made here in the dropdown menu, the entries in the properties of the "Display" field are set accordingly. The "Standard property" column is set to "***Not defined". The script is listed in the "Script function for value" column. Column "Standard property" is set to "Expression (CallByName)". The expression is listed in the "Parameters" column Extras This area fully corresponds to the "Extra" tab in the properties of a column. See also section "Extra" tab (Page 48). Therefore, if you change anything here, it has the exact same effect as when you make a corresponding entry in the properties of the column. However, in this case you access the properties of all columns. The following table describes the columns: Column "Alignment" "Text wrap" "Sorting for standard table" Description Determines the alignment of the cell content. Permits a text wrap at cell boundaries. Offers various sorting criteria for selection (e.g. "Alphabetic", "Numeric", etc.). Operating Manual, 04/2012, A5E

38 Object Browser 3.9 Options Column "Width" Description Numeric input which gives the factor relating to the value of the adjacent button. "Unit for width" "mm" entry: The width is specified directly in mm. This unit is often used when a query is to be printed in a report, since you can similarly also enter the column widths in mm there. The printout of the report is then exactly as stipulated. However, the effect on the screen can vary according to the set resolution and the used hardware, since a PC does not know the millimeter width of a screen but only the available resolution points. "Twips" entry: A Microsoft specific width format. "Row height" entry: The width is calculated as a multiple of the row height. This thus ensures that the relationship of the page length to the height remains constant when the resolution changes. Only for columns with attribute objects The following table describes the columns: Column "Comos unit" "LCID" "Charset" Description First of all a unit group and then a unit has to be selected. The specified unit is used to convert the display of the attribute values. The attribute data itself is not changed in this case. In the case of cell objects that return other objects (no attributes), the entered unit is simply ignored. This column corresponds to the local ID. Each language has a unique ID within COMOS, which is used to identify this language. In the project options of the "Languages" tab, you can check which language is assigned to which ID. Note: The texts in the object queries are supplied for the most part from the database and not from the COMOS user interface. Therefore, if you switch the COMOS user interface, the column labels of the object queries, for example, remain in German and the ID remains Only when you switch the language of the database the object query is also switched. Almost all Western languages work with charset 0, so in most cases a zero is displayed here. For example, Cyrillic has charset Languages This area fully corresponds to the "Languages" tab in the properties of a column. See also section "Languages" tab (Page 48). Therefore, if you change anything here, it has the same effect as if you make a corresponding entry in the properties of the column. However, in this case you can access the properties of all columns. A column appears for each language stipulated within the project. Any existing translations will appear in the fields. 38 Operating Manual, 04/2012, A5E

39 Object Browser 3.10 Export Extension classes An external DLL file can be specified in the "Options" in the "Administration" tab and be used to evaluate some of the information from the object query. The "Extension classes" area offers an overview as to whether such an external DLL file is to be used and which information is to be calculated by the DLL. Column "ExtendendProgID" "Object by" "Value by" "Picture by" "Style by" "ValueItems by Extended" Description If an external DLL file is used, it is listed in this column. Normally, there is the same entry in all cells of this column, since only one DLL file can be used for access via the Object Browser. This entry relates to the "Object evaluation" tab (or to the corresponding column editing area). This entry relates to the "Value calculation" tab (or to the corresponding column editing area). The "Show symbol" option can be enabled in the "General" tab in the Object Browser (or in the corresponding column editing area). If an external DLL file is used, the scope of the function is more extensive: you can not only specify that a symbol should be visible, but also which symbol should be visible. The "Cell style" option can be enabled in the Object Browser in the "Options" of the "General" tab. If an external DLL file is used, the scope of the function is more extensive. You can not only specify that a graphic style is to be used, but also which graphic style is to be used in the cells. The extended classes evaluate the values of the cells. Example for "ValueItems by Extended" The individual entries in a list are evaluated Export Important rules concerning the reimport COMOS offers various possibilities for export. However, there are a number of specific points that must be noted if the data is to be processed externally and then re-imported into COMOS: Only the export as Excel file or Access file can be reimported with the standard tools. Grouped objects cannot always be reimported correctly. A correct reimport presupposes that editable columns only occur at the last stage of each grouping. The exported data may only be edited at those points that were released for editing within COMOS. These are the in white highlighted cells in Excel. You should not remove the spreadsheet protection in Excel, since this only concerns cells that cannot be edited anyway. Operating Manual, 04/2012, A5E

40 Object Browser 3.11 New (additional columns) The exported data may not be sorted or filtered. The first row of an exported table contains important information and may not be edited. The last column of a table that is exported to Access contains important information and may not be edited. Performing an export Right-click on a column title, "Export" "Microsoft Excel" Output in an Excel file. "Microsoft Access" Output in an Access file. "Text file" Output in a TXT file. "XML file" Output in an XML file New (additional columns) Procedure To create an additional column, right-click on the column header and select the "New" command "General" column You can use the "General" command to generate a new custom column "General" tab This tab corresponds to the "General" area in column editing. See also section General (Page 36) "Object evaluation" tab The "Object evaluation" tab is used to evaluate an object from which the information to be displayed in the Object Browser is calculated. Every cell in the Object Browser (and thus every piece of information displayed) relates to an object. 40 Operating Manual, 04/2012, A5E

41 Object Browser 3.11 New (additional columns) There is an evaluated object for each row in the Object Browser. The properties of this object can be displayed. However, it is also possible to calculate other objects that have a relationship to the evaluated object. That is precisely what happens here: The object evaluated in this tab is exactly the same as the one evaluated in this column (i.e. this cell). Calculation mode: Navigation library short The short navigation library offers a fixed specified selection of navigation steps that are frequently required. You are always offered the same list when you click on a cell in the "Navigation step" column. This list is a part of the COMOS object structure, but is not complete. Thus you cannot set up all possible navigation forms with the short navigation library. This restriction has the advantage that the short navigation library is easy to take in at a glance within the administration and works very quickly within the application. Operating Manual, 04/2012, A5E

42 Object Browser 3.11 New (additional columns) The following columns become visible when the "Navigation step" list is expanded: Column "Navigation step" "Parameter" "Object can be set" "Returns object" "Explanation" "Step" "Nav. constant" Description Descriptive, unique text. The description entered here only has any importance within the navigation library. There may, but need not necessarily, be a similar method or property in the COMOS.dll. Example 1: There is an "CObjectByFullName" entry in the "Navigation step" list. This description does not exist in the class documentation "COMOS.dll" manual, but it is a method that exists only within the navigation library. Example 2: There is an "CDocument" entry in the "Navigation step" list. This designation can also be found in the class documentation "COMOS.dll" manual. However, this is not exactly the same function. Rather, a function was created within the navigation library that works in a similar way to the "CDocument" command in the COMOS.dll. In the Explanation column, there is always information about how the navigation steps of the navigation library can be converted to the "normal" COMOS object hierarchy. Since the navigation library should be as easy as possible to handle, it should normally not be necessary to enter any parameters. However, if a parameter is necessary, an explanation is given here as to what kind of parameter is required. Depending on the type of parameter to be input, you will be supported by a user prompt. If a dot is entered in this column for the last navigation step, you can generally drag&drop an object into the column in the Object Browser. Before, you have to activate the "Can be set" option. The object calculation necessarily always returns an object. Here it is stated what system type the object has. In the Explanation column, there is always information about how the navigation steps of the navigation library can be converted to the "normal" COMOS object hierarchy. The navigation steps are not stored as text in the software but are instead managed as unique numeric codes. This has two reasons: firstly, it saves memory and disk space, and secondly, the Microsoft programming environment that is required only offers support for codes but not for text constants. This designation is the alias name for the internal code of the navigation step. Input support All steps that do not produce a meaningful solution in connection with the above are displayed in gray: The steps are analyzed as follows: The system type of the last step is analyzed with the system type of the navigation steps. If a hierarchical combination of the system type is prohibited by COMOS, the entry is grayed out. Example: No documents are permitted below connectors. No further plausibility controls are conducted between the steps. 42 Operating Manual, 04/2012, A5E

43 Object Browser 3.11 New (additional columns) Calculation mode: Extended navigation library The extended navigation library evaluates a given data stock and determines a navigation rule from it. In other words: the desired navigation must already exist as an example and can therefore be reused here. If the subsequent engineering data deviates only minimally from the example structures, the navigation that had been generated here will no longer function. This tab contains three areas: The quick planner, consisting of the "Start object" and "Target object" fields. The actual "Current path" definition area. The "Go to" support area. Quick planner "Start object" field A start object can here be set by using drag&drop. It has to match the system type for the object specified in the "Reference" field on the "General" tab. Operating Manual, 04/2012, A5E

44 Object Browser 3.11 New (additional columns) "Target object" field Using drag&drop, a target object can be set here that must relate to the start object in one of the following hierarchical relationships: The target object is located within the direct owner structure of the start object. The start object and the target object have a common owner (apart from the project object). If all prerequisites were met, then the route from the start to the target object is determined automatically and entered in the lower part of the table on the left. Using the quick planner presupposes a good knowledge of the object model and the data basis. Note In the end only the definition area from the left table in the lower area is evaluated. If the entries of the quick planner were not taken over to the definition area you have to manually describe a path. Left table In this area you make the entry which is evaluated later. The evaluation of these entries created the path template which is used to evaluate the column data. Starting from the corresponding reference object this path command is conducted for each cell, and the results, as long as they can be displayed, are also entered in the new column. "Step" column The single steps from the start object to the target object. In the following step, only those objects are offered that are actually available at the previous object. The command list is sorted alphabetically. If there is an object of the Device system class as a current step, and this engineering object does not have any connectors, no connectors are offered in the subsequent navigation step. No further plausibility controls are conducted between the steps. "Parameter" column If this involves objects that actually exist, then they are offered here as well. Example: If "ConnectorByName" is selected as a navigation step, a check will have been made beforehand by the navigation help to determine if any connectors exist. These available connectors are offered in the "Parameters" field. Nonetheless, it is not absolutely necessary to make a selection from the offered parameter list and you can also make an input of your own. In this case no plausibility checks are made. "Object" column This is where the object is displayed which can be by the current navigation step. Exactly which objects are displayed later in the engineering data depends on the relevant start object. 44 Operating Manual, 04/2012, A5E

45 Object Browser 3.11 New (additional columns) Right table If you click on a line in the left window area you are offered a small selection of possible following steps in the right window area. The offered follow-up steps are chosen in such a way that there is a high chance that a functional step sequence is created. Hence all real data is evaluated and all found objects are offered. In other words: The right table shows all owners, connectors, elements, attributes, etc. which are actually available for the selected object. Since an object can have attributes of the same name in different "Attribute" tabs, the name of the tab is also shown in the right table in order to clearly identify the attribute. The attribute tab name for all attributes appears in the right table. Previously you could not differentiate between attributes of the same name in different tabs. "Relation" column Here it is stated which navigation step is suggested. "Object" column Supplies on the left side the result in the event that this subsequent step would be selected for the example object from the "Object" field. You can take over a navigation step from the right window area to the left one by doubleclicking on it. Calculation mode: Script The script options are more comprehensive than those provided by the navigation library. The evaluation of a script takes longer than that for an object query via the navigation library. However, there is always no alternative to using a script if the navigation requires decisions or iterations (loops). See the "Properties" manual, keyword "Script editor". Help This button starts the programming help. You also find an example there. Explanations regarding script: "Set ColumnObject = Nothing" The variable is typified. "if Not RefColObject is Nothing Then" It is checked whether the object query received any valid data at all. "Set ColumnObject = RefColObject.GUnit" In addition to the object being evaluated, the unit that is located below the object is determined. This unit is stored in the variables. This also fulfills the condition that an object must always be returned as the result of the script. Operating Manual, 04/2012, A5E

46 Object Browser 3.11 New (additional columns) "Value calculation" tab This tab corresponds to the "Value calculation" area in column editing. See also section Value calculation (Page 37). Value calculation uses the object of the object evaluation for further information processing. This means that the value calculation cannot return a result if there is no correct definition in the "Object evaluation" tab. "Calculation mode" list You can choose between three different types of text evaluation: 1. "Standard property" entry "Display" list When using the "Standard property" calculation mode, a selection field with a list of possibly frequently used functions and properties is displayed. Details regarding the functions and properties can be found in the "Class Documentation COMOS.dll" manual. "Editable" option Enabled: You can make an entry directly in the cell of the Object Browser. This option is only available if the contents of the column are editable. 2. "Script" entry This entry opens a script editor, see the "Properties" manual, keyword "Script editor". Press the "Script Test" button to check your script, the result is displayed in a window. You can call a small programming example by clicking the "?" button in the "Example" tab. Object queries have an interface with which you can create your own columns: "Function ColumnValue". The "ColumnValue" function can return texts and numbers ("String", "Long", "Double"). 3. "Expression (CallByName)" entry "Expression (CallByName)" creates a field in which the usual COMOS point notation can be used to compose a display instruction that covers exactly one row. You can now enter the usual COMOS short notation in this row so as to calculate the desired text, for example "GUnit.Project.Name". You cannot use the "Expression" type if you require loops or more than one row for any reason. In that case you should then use the "Script" type "Object by value" tab The settings that can be made on this tab are only applicable if you have enabled the "Permit new row" option. See also section "General" tab (Page 31). The "Object by value" tab can be used to define rules on how objects are to be generated in the row. 46 Operating Manual, 04/2012, A5E

47 Object Browser 3.11 New (additional columns) When you open the "Calculation mode" list, you are offered two options to define rules: "Default definitions (for engineering objects only)" "Script" "Default definition (for engineering objects only)" calculation mode From the "Calculation mode" list, select the "Default definitions (For engineering objects only)" entry. Two more lists and a check box are displayed on the tab. "Owner object" list The "Owner object" list offers various options for defining the owner object. "Base object" list The "Base object" list offers various options for the definition of the base object. Operating Manual, 04/2012, A5E

48 Object Browser 3.11 New (additional columns) "Script" calculation mode When you select the "Script" entry from the "Calculation mode" list, a window opens in which you can define rules for the creation of the object via script "Extra" tab This tab corresponds to the "Extra" area in column editing. See also section Extras (Page 37) "Languages" tab This tab corresponds to the "Languages" area in column editing. See also section Languages (Page 38) Default columns (project, timestamp...) "New" command in the context menu There is a series of predefined columns below the first entry. Simply click on one of the entries, the corresponding column is then created. The scope of the offered default columns depends on the initial column that was selected. This is due to the fact that a newly created default column is always based on the column in which the context menu and the "New" command was called. 48 Operating Manual, 04/2012, A5E

49 Object Browser 3.12 Other commands in the context menu Context menu "New > Row statistic" Self-explanatory. See also Row statistics (Page 19) 3.12 Other commands in the context menu "Print" This command provides the same functions as the "Print" button in the toolbar "Delete" Selected columns can be deleted with this command. Deleting columns does not change any objects or their properties; it only affects the display. A safety prompt appears to prevent you from deleting anything accidentally "Properties" This command enables you to edit and check the column properties. See also section New (additional columns) (Page 40) "Remove" Removing date entries You have the option of removing date entries in the Object Browser. To do this, select the "Remove" item in the context menu. This item only appears if the column definition is set to "Date" and the cell is editable. See also "Edit column" tab (Page 35) Operating Manual, 04/2012, A5E

50 Object Browser 3.13 "Script" tab: 3.13 "Script" tab: The following script functions only make sense when you exclusively work with standard queries.. You find these functions when you open an object query, "Options" context menu > "Script" tab. Script templates When you click on the "Script templates" button you find the following prepared script templates: "AfterLoad()" Is called after loading TopQuery. "AfterOrigCollection(OrigCollection)" You can here change the by default collected OrigCollection or completely collect a new OrigCollection. Hence the use of the (customer-specific) IExtended.dlls is expendable as long as it is the aim to control the base amount of objects in the object query. "BeforeShutdown()" Runs prior to terminating the standard query. Note Click the "Help" button to get more information about the script templates. 50 Operating Manual, 04/2012, A5E

51 Run modes for object queries Overview COMOS provides two run modes for standard queries: Simple mode In this mode, the configuration options for standard queries are limited to relevant options for normal users, so that working with queries is more intuitive, faster and more error-free. Extended mode The complete configuration options for queries are available in this mode. 4.2 Setting the implementation mode It is differentiated between two different run modes: The default mode of a standard query, in other words the run mode with which the query is opened by default after opening. The current run mode, meaning the run mode the user sets after opening the query Default mode (DefaultRunMode) When you open a query in COMOS for the first time, the query is opened in extended mode by default. However, you do have the option of changing the run mode in which the query is started. To do so, proceed as follows: 1. Right-click on the column header of the query and select the "Options" command. 2. In the window that opens, click on the "General" tab. 3. Via the "Simple" and "Extended" options, you can select the mode in which the query should open by default. 4. To confirm your selection, click the "OK" button and then click the "Save" button Current run mode You can change the current run mode of a standard query at any time. You can switch from the standard mode to the respective other mode. In this way you have the option to switch from the standard mode to the extended mode in order to configure it later. Operating Manual, 04/2012, A5E

52 Run modes for object queries 4.2 Setting the implementation mode Procedure To switch the run mode, proceed as follows: 1. Right-click on the column header of a desired query column. 2. In the context menu that opens, select "Run mode" > "Simple" or "Run mode" > "Extended" Simple mode In the simple mode, all standard queries are opened in a standard TopQueryBrowser, regardless of the type of standard query. Example: Standard query for documents, engineering objects, base objects The TopQueryBrowser only has a few tools in the toolbar. Only one field is displayed in which you can set the start object(s) for the query. Column display In the simple run mode, you can neither create nor delete columns. You can only show or hide the in the extended mode created columns. You can also adjust the column width and change the column order. If local settings have not yet been saved for a standard query, you will see all columns that have been set to "Visible for user" in the extended mode. All columns are displayed by default. Once you have changed and saved the settings for column visibility, the corresponding settings in extended mode are not applied. Show and hide columns You can show and hide columns via the context menu of the column header. See also section Context menu of the column headers (Page 53). 52 Operating Manual, 04/2012, A5E

53 Run modes for object queries 4.2 Setting the implementation mode Context menu of the column headers In simple mode, fewer commands are offered in the context menu of column headers than in the context menu of the extended mode. The following commands are available: From the context menu, you can adjust the configuration of the standard query to your own requirements. You have to explicitly save these settings as a local setting by using the "Save" command. "Columns" context menu You can show and hide columns via the "Columns" context menu. When you run the "Columns" command, a window opens: All columns that were defined in the extended mode are listed in the window. With the "Visible" checkbox, you can define which columns are to be displayed in simple mode. After confirming your selection by clicking the "OK" button, you still have to save these local settings. To do this, click on the "Save" command in the context menu. Operating Manual, 04/2012, A5E

54 Run modes for object queries 4.2 Setting the implementation mode Sort You can only sort a query by a column. The sorting cancels the sorting conducted in the extended mode. A in the extended mode as hierarchically defined query can no longer be sorted in the simple mode. Hierarchies can only be defined in the extended mode. In order to sort a query based on a column, move the mouse pointer to the column and leftclick on the triangle that appears. In the window that opens you either click on "ascending" or "descending". The settings you have made for sorting are no longer available when you close and reopen COMOS. "Filter" command Via "Filter" you can define additional filters beside the in the extended mode already available filters. For each column in the query you can define only one filter. In order to filter a column, move the pointer to the column and click on the filter symbol that appears. In the window that opens, you can define your filter criteria and run the filter by clicking the button. You reset the set filter by clicking the button. The settings you have made for filtering are no longer available when you close and reopen COMOS. 54 Operating Manual, 04/2012, A5E

55 Run modes for object queries 4.2 Setting the implementation mode Other commands in the context menu Command Description "Hierarchy levels" Standard functionality "Search/Replace..." Standard functionality "Run mode" See also chapter Setting the implementation mode (Page 51). "Print" Standard functionality "Export" Standard functionality "Columns..." Standard functionality "Reset" Restores the preconfigured settings, i.e. deletes the local settings. "Save" Saves the local settings. See also chapter Saving local settings (Page 55) The context menu for objects of the result set The context menu for objects from the result set also offers fewer entries in the simple mode than in the extended mode. These commands are a subset of the commands known from previous COMOS versions Saving local settings You need to save the settings you have made in the simple mode via the context menu in order for them to be available later. The local settings are thus saved in your user profile. The settings are also saved when you click on the "OK" button in the query. If you don t save, the settings will not be available the next time you call the query in simple mode. The following settings are saved in the user profile: Start object Column order Per column: Visibility, column width Operating Manual, 04/2012, A5E

56 Run modes for object queries 4.3 Alternative display of queries 4.3 Alternative display of queries The new queries offer many functions and options, for example, for searching and filtering. The alternative display of the query has the aim of improving the performance of the user interface, for example in terms of scrolling and editing functionality, when handling large numbers of objects. Configuration Configure the standard query and save it under the selected object in the Navigator. The alternative display does not factor in all of these settings. Display Only the following layout options of the standard query are taken into account: Cell style Grouping method for presenting the hierarchies in a flat list instead of a nested view Row height Number of fixed columns Change monitoring Context menu The context menu contains only the following entries: Navigate Properties Refresh (selected) Filter/sort You make the settings for sorting and filters at the standard query. The settings will be applied in the alternative display. The settings are not displayed in the column headers. You also have the option of setting a filter for specific columns in the alternative display. Edit You cannot edit the cell contents of the query directly. and need to make changes in a separate editing area. All other options and functionalities that are available in the standard query will be ignored. See also Working with the alternative display of queries (Page 58) 56 Operating Manual, 04/2012, A5E

57 Run modes for object queries 4.3 Alternative display of queries Opening queries in the classic or alternative display Manual call To select how a query is displayed when you open it, click on one of the following commands in the navigator in the context menu of the query: Open (classic) The interface for standard queries is called. Open (alternative) The new alternative display of the query is called. Automatic call 1. To specify the alternative display as the default setting for calling queries, open the query in the classic display and change to the extended run mode. See also chapter Default mode (DefaultRunMode) (Page 51). 2. Then, right-click on the column header of the query and select the "Options" command. 3. On the "General" tab in the "Open query in display" area, select the desired display: Classic Alternative Note: To switch to one of the options, you must have write permissions for the base object of the query and function rights to the base data. From then on, queries of the same type will be opened in the set display with a double-click in the navigator. See also Working with the alternative display of queries (Page 58) Operating Manual, 04/2012, A5E

58 Run modes for object queries 4.3 Alternative display of queries Working with the alternative display of queries Requirements You have already configured and saved a query. Procedure 1. Select the "Open (alternative)" command from the context menu of the query. The search configuration of the query is loaded and the search result opens with an alternative display. The "Search at once" and "Search" button settings are taken from the original query. 2. To filter within a column, enter the relevant filter value in the field below the column caption. The filter value will be evaluated when you exit the filter field. 3. To edit a search result entry, select this entry and click on the "Editable area" button. The properties of the selected object, which are also displayed in the search result, appear. No symbols or cell styles are displayed or supported in this area. Changes to the editable fields are not applied letter-by-letter as you type, but rather when you exit the field. Click on the "Editable area" button again to close the properties. You can also use the <F2> key to open and close the properties. 58 Operating Manual, 04/2012, A5E

59 Run modes for object queries 4.3 Alternative display of queries 4. Click on the "General notes" button to view general information about the alternative display. Click on the "General notes" button once again to hide the general information. See also Alternative display of queries (Page 56) Operating Manual, 04/2012, A5E

60 Run modes for object queries 4.3 Alternative display of queries 60 Operating Manual, 04/2012, A5E

61 Standard queries 5 Standard queries are prefabricated tools in which specific COMOS data is searched for and edited by means of an object browser. The interface differentiates from the standard queries. Example of a standard query: 5.1 Creating and opening standard queries Standard queries are special action objects Standard queries are always based on a base object or an object of the "Action" class. However, the behavior of action objects is different to the behavior you are used to from COMOS objects: The familiar display of the properties is replaced by an extended interface. See below for more details. In addition, in the case of action objects inheritance functions differently from the usual way. The division into base objects and engineering objects is largely nullified: action objects behave the same way in the base data and the engineering data. Only the initial creation continues to be carried out in the "Base data" tab of the Navigator: the corresponding context menu is offered only there. Operating Manual, 04/2012, A5E

62 Standard queries 5.1 Creating and opening standard queries Action objects Action objects are divided into the following main groups: Decision tables Import Object queries Script From these four groups, only the object queries are covered in this section. There are six subclasses for object queries. Five of them involve a concrete standard query and in addition there is a general subclass called "Other". This division has historical reasons and should be ignored for the following reasons: Object queries cannot be completely created by means of the "New base object" function. Only older standard queries are available as a subclass. "New" standard queries always have the subclass "Other" and are then further specified by COMOS. It is therefore not possible to create newer standard queries by creating and accordingly configuring a base object. Object queries should always be made via the context menu. If you right-click anywhere on a base object in the "Base objects" tab, the "New > New query in engineering project > Standard" command appears, amongst other items. Following query types are listed below the command: "Engineering objects" "Base objects" "Documents" "Attributes" "Connectors" The extended interface for standard queries How to open the properties: Right-click on the object in the Navigator and select the "Properties" command in the context menu. A double click or the "Open" command in the context menu always opens the special query interface and not the properties. in COMOS tools The object queries technique is used in many tools in COMOS: Print Manager Translation Script conversion 62 Operating Manual, 04/2012, A5E

63 Standard queries 5.1 Creating and opening standard queries Navigator views etc. In the standard delivery, the COMOS standard tools with object queries are located in the base data under the System Settings Interface" node: Inheritance for action objects Inheritance works in the same way with action objects as it does with base objects. Thus if a new base object is created below an action object, this base object initially inherits all information of the "parent object". Thus all information is inherited as a block, since all information for action objects is stored together in an "XObj", an extension object. But if only one property is changed, then the entire "XObj" is checked in and the inheritance is interrupted. See also Standard query: Planning objects (Page 68) Standard query base objects (Page 72) Standard query Attributes (Page 74) Standard query Connectors (Page 82) Standard query Documents (Page 76) Standard for terminal strips or wire lists New object queries were especially created for the management of terminal strips and wire lists. These object queries can again be freely configured in the usual way. To create an object query, right-click on a base object in the "Base objects" tab and select "New > New query in engineering project > Standard > Miscellaneous > Terminal strip" or "New > New query in engineering project > Standard > Miscellaneous > Wire list" in the context menu. In the default settings based on the "Terminal" column, the inputs are on the left and the outputs are available on the right. If you open the menu in the column header, you find a variety of other prepared columns. Operating Manual, 04/2012, A5E

64 Standard queries 5.2 Saving standard queries 5.2 Saving standard queries The arrow button opens a selection menu for extended saving or loading of settings. Purpose of saving When you save a standard query, you are not in fact saving data but only the rules how data is searched. A saved standard query will therefore return different results if the data stock has changed in the meantime. This means that you cannot actually archive a result by clicking the "Save" button. Due to technical reasons, the settings of the various types of the standard query cannot be exchanged with each other. For a standard query for engineering objects, it is therefore not possible to configure, for example, columns, filters etc as desired and then load these settings again for a standard query for base objects. Commands "Save > Save" The default form of saving data. "Save > Save as" Saves a copy of the object. An owner has to be set in the "Save as" field. COMOS automatically creates a name if no name is specified. A default description that can be changed is suggested in the "Description" field. "Save > Save as file..." By doing so, you save the settings in XML format under a specific name and/or in a path, also outside COMOS. The settings file can later be opened again by using the "Load from file" command. "Save > Load from file..." Loads the settings of another object query. Since the already existing current settings are overwritten during loading, the following safety prompt is displayed: "This action will overwrite the current archives. This is also valid for the administration of data (Lock/Unlock). Continue anyway?" If you confirm the message with the "No" button, the process is aborted and you return to the object query. If you confirm the message with the "Yes" button, a window opens in which you can select the path and file. "Save > Load from inheritance source" You can use this menu item to load the archives of the associated base object, depending on the inheritance path (inheritance of the base object). The "Load from base object" menu item appears on the engineering object side and has the same effect. 64 Operating Manual, 04/2012, A5E

65 Standard queries 5.2 Saving standard queries The required rights for saving Writing into a file Does not require special rights. Load from file Overwrites the settings of the queries and therefore requires additional rights. Further the settings "Allow changes/ Forbid changes" and "Allow saving/ Forbid saving" apply here. Write in File / Load from File These functions are intended for exporting query settings from a database into another database, respectively project or similar cases. Recommendation Distinguish between the following cases: A restricted number of standard lists (Bulk processing, queries) which are immediately accessible for everyone via the COMOS menu. In this case, the administrators (or the user with necessary rights) configure the general queries or bulk processes in the base project in the "Base objects" tab below the corresponding "@System node. These can then be accessed by all users via the COMOS menu. Then you might have not only one form of bulk processing but maybe ten different ones. These queries (or bulk processes) cannot be overwritten by anyone when they are started from the menu bar. You can only change them when they are started from the tree, and only if you have the required rights. that are started from the menu bar are always write-protected. Individual user settings. If the normal user needs private settings, he can start the query from the menu bar, change it, and by doing so save the individually changed queries using "Save as" somewhere else as an engineering object or base object. You need the necessary rights for base objects. Precondition for this is that the original queries allow the change: This means that they have the "Enable change" and "Enable save" options. Operating Manual, 04/2012, A5E

66 Standard queries 5.3 Operation: Standard controllers 5.3 Operation: Standard controllers Overview All queries have a common set of buttons. In addition to these standard buttons queries also have a number of additional special buttons with their own functionalities, which are explained in more detail in the sections regarding the individual queries. The common buttons are: "Navigate" Opens the Navigation menu. The effect is exactly the same as with the corresponding commands of the navigation menu in the Navigator. You find more information on this topic in the "Basic Operation" manual, keyword "navigate". "Refresh - (F5)" This button updates the display and starts a complete recalculation of the query. "Save / Load" The button opens a selection menu for advanced saving, or loading of settings. See also section Saving standard queries (Page 64). "Print list" A click on the printer symbol starts standard printing. The list is printed in the Object Browser. "Export data" This button enables the export of the created query list. The effect is exactly the same as with the corresponding commands in the Object Browser. See also section Export (Page 39). "Properties" This button opens the properties of the query. 66 Operating Manual, 04/2012, A5E

67 Standard queries 5.3 Operation: Standard controllers "Script block 'Action'" This button displays the script window with the "Sub action" in the lower part of the query display. User specific scripts can be entered and run in the script window. Note Script in queries The "Container" property can be used in the script. By doing so you can calculate the object from within the script to which the object query belongs (Device or CDevice). The "Object evaluation" and "Text evaluation" tabs in the properties window of a column have the "BaseRowIndex" and "BaseColumnIndex" parameters. They are used to determine the index position of a cell. The possibility to gain access to a cell via two different indices (such as i, j) means that there is a risk that the information will not be received or will be wrong as a result of layout changes, since the row and column indices change as the result of a move. At this point it is better to use strings (such as "column.name") for the parameterization, since they do not change if the layout is changed. The keywords "Workset" and "Project" can also be used. "Find" "Search at once": The results are recalculated after each change. "Search": The results are only recalculated when the button is pressed. Start object All standard queries have a "Start object(s)" field: This is a mandatory field. A start set can be set in the "Start object(s)" field. Do this by selecting the desired start set, then copy this object set to the clipboard and select the "Clipboard" entry in the field. Effect: Searches for all objects that have one of the start objects or a start object that is hierarchically located below (logical Or combination). As an alternative, you select the desired start set and drag it into the field.. Quantity restriction: as long as the object query is open, almost any number of objects can be set as start objects. However, a large number of start objects quickly slows down the performance. Operating Manual, 04/2012, A5E

68 Standard queries 5.4 Standard query: Planning objects The object query can only save up to 10 start objects. Note The start objects are not automatically saved. If you have only changed the start objects of an object query and nothing else, the query is not saved and you have to set the start objects again the next time. The object query is saved in the following cases: When the user saves the query manually (floppy icon). When other changes were made beside changes to the start objects and you have the right to save the query. In this case there is a prompt if the changed object query is to be saved. When you manually save the query or confirm the prompt for saving, the first ten start objects are saved. The remaining start objects are lost with no further prompt. All other settings of the object query are saved in the usual way. 5.4 Standard query: Planning objects Overview Default "Class(es)" field: "D Device" "Start object(s)" field: If the standard query was initially created in the "Base data" tab of the Navigator, then "***Not set" is shown here. Once the standard query is created in one of the other tabs for the first time, the owner is automatically set as the start object. This also applies if the standard query is subsequently moved to the engineering side. The start object is only fixed once the settings of the standard query are saved. Columns: "Label", "Description" "Search technique": "Not recursive" 68 Operating Manual, 04/2012, A5E

69 Standard queries 5.4 Standard query: Planning objects "Include/exclude start object(s)": "Include start object(s) in selection" "Folder": "Without folder" "Placing filter": "All" Buttons for the operation of the query See also section Operation: Standard controllers (Page 66). The following section covers special features. "Search technique" "Not recursive" In many standard queries there is the option to set the search technique. Most of the time the first option is called "Only first level". It is only called "Not recursive" for the "Engineering objects" standard query and the "Documents" standard query. This difference in the description is due to the fact that the options do the same, but functions differently in technical terms. If the "Only first level" option appears, the search actually terminates after the first hierarchy level. The "Not recursive" option does not necessarily cancel the search after the first level: COMOS scans an object of the first hierarchy level and all objects located below it in the hierarchy until it finds an object that matches the requested class. This may already be the case on the first level, or not until the third or fourth one. The object is added to the results list and COMOS continues its search at the next object from the first hierarchical level. If the object of the first hierarchical level corresponds to the searched for class, then objects created below it that also belong to the searched class are not included in the list. "Recursive" Objects of all subordinated hierarchy levels are displayed. "Backpointer procedure" This procedure takes advantage of the fact that base objects and objects are uniquely and clearly linked in COMOS and not only in relative terms. each object is based on a very specific base object and each base object recognizes the objects that were derived from it. The "Backpointers method" does not evaluate the engineering objects - but their base objects are evaluated - in order to determine which engineering objects derive from them. This option is therefore only available once an entry is available in the "Base object" field. Comparison of "Recursive" and "Backpointers" which of these two options is faster depends on the structure of the data and the start object. Generally speaking: the calculation of the results takes more time if more hierarchical levels have to be evaluated. Operating Manual, 04/2012, A5E

70 Standard queries 5.4 Standard query: Planning objects If it is therefore necessary to search through four or five levels of the tree on the engineering side until the relevant data is found, but then you have a clear organization of the base data (i.e. you immediately have the branch of the base data reference), and it is faster to start from the base data. Turning off the "Location" in the "Options" in the "Backpointer" search technique is not considered. "Usages (Copy templates)" This option is only available if there is an object in the "Start object" field that has usages. "Usages" are objects that were derived from a template. "Usage twins (Copy templates)" This option is only available if there is an object in the "Start object(s)" field that is a usage, meaning that it is derived from a template. You can find additional information on this topic in the "COMOS Administration" manual. All objects of the current project that were derived from the same template can be found with the aid of this option. You must drag the template itself into the "Start object" field. It is not sufficient to set a branch as a start object underneath which there are templates. Specialty: If you use a template as the "Start object" that was created in the base project, then the usages from all projects are searched for. If you use a template that was created in the engineering project, then only the usages within this engineering project are searched for. "Via link - attributes" The objects that reference to the specified start object via the link attribute are considered. "Database search" This option activates the database-based search. See also section Database search (Page 93). "Include/exclude start object(s)" "Include start object(s) in selection" All objects that were set in the "Start object(s)" field can also appear in the results list. "Exclude start object(s) in selection" All objects that were set in the "Start object(s)" field will not appear in the results list. "Folder filter" "Without folder" Objects with the "Folder" option are not considered. "Only folder" Only objects with the "Folder" option are taken into consideration. "All" All objects are considered. 70 Operating Manual, 04/2012, A5E

71 Standard queries 5.4 Standard query: Planning objects "Placing filter" This menu has two levels. The upper part of the selection menu determines whether all objects, only placed ones, or only those that were not placed are to be displayed. In the lower part it is decided for what drawing type the above decision applies. You thus have to click twice in the menu to be able to make a full decision. "All" All objects are considered. "Placed" Only objects that are placed on a report are considered. "Not placed" Only objects that are not placed on a report are considered. Select drawing type: "All": The drawing type is ignored and the above decision applies to all drawing types. Drawing type selected: A single drawing type is selected, a multiple selection is not possible. "Options" This button opens the dialog for setting the search options. Select the desired classes (multiple selection is permissible) and enable or disable them. The calculation of the results can be accelerated if specific branches of the tree do not need to be investigated because a stop condition applies. The options mean: "Consider all placed objects (DocObj.Reference)" When objects are placed on a report, a reference to the placed object is created below the document object of the report. If the option is enabled, these references are also taken into consideration. This means that objects from other parts of the tree in the original, i.e. in a branch that is not below the start node, will also be displayed. In other words: the number of results will be greater if this option is enabled. However, objects cannot appear twice in the results list: when an object is found twice - once in the original and once as a placing reference in the calculation - one of the entries will be automatically deleted from the list. Operating Manual, 04/2012, A5E

72 Standard queries 5.5 Standard query base objects "Dereference base objects (by dragging)" This button is only of meaning for the "Base object(s)" field. A base object can get a reference to another base object (via the "System" tab in the properties). "Dereferencing" means: Resolving and applying the reference, hence using the object to which the reference is set. When this button is pressed, the base object which is entered in the properties window of the dragged object in the "System" tab below "Reference" is used instead of the object which is set per drag&drop in the "Base object" field of the query. This string is dissolved until no further "reference" is still entered for any base object. In other words: if a base object was found during dissolving and this base object in turn has a base object entered for it in the "Reference" field, then a jump is made to this base object and so forth until no further references are found. The at the end found base object is used. Aborting a query It is possible to abort the scanning process of a query for engineering objects. This presupposes that the query uses the ScanManager for the search and a progress bar is shown. This applies only if you have started the query from the user interface. If you have launched the scanning process with a script, you cannot cancel the operation. 5.5 Standard query base objects Overview Default "Class(es)" field: "D Device" "Start object(s)" field: "***Not set". Columns: "Relative name", "Description" and "SystemFullName" "Search technique": "Only first level" "Include/exclude start object(s)": "Include start object(s) in selection" "Inheritance mode": "All" "Collection type": "All" 72 Operating Manual, 04/2012, A5E

73 Standard queries 5.5 Standard query base objects Buttons for the operation of the query The general valid part of the control elements was already explained in section "Operation: Standard controllers (Page 66)", so only special points are being dealt with here. "Search technique" "Only first level" Only objects of the first subordinated hierarchy level are displayed. "Recursive" Objects of all subordinated hierarchy levels are displayed. "By linked attribute" The objects that reference to the specified start object via the link attribute are considered. "Database search" Enables the database based search. See also section Database search (Page 93). "Include/exclude start object(s)" "Include start object(s) in selection" All objects that were set in the "Start object(s)" field can also appear in the results list. "Exclude start object(s) in selection" All objects that were set in the "Start object(s)" field will not appear in the results list. "Inheritance mode" "All" Display all base data. "Own (checked in)" Only display the object's own (checked in) base data. "Inherited (not checked in)" Only display inherited (not checked in) base data. Operating Manual, 04/2012, A5E

74 Standard queries 5.6 Standard query Attributes "'Collection' type" "CDevices" Display base objects. "Elements" Only display elements. This does not refer to the "Class" element but instead to objects of the "Collection" element. These are the objects that are located on the "Elements" tab. "All" Show all. 5.6 Standard query Attributes General Call: "Extras > Query > for attributes > : attributes" Default "Start object(s)" field: "***Not set". Columns: "Name", "Description" "Search technique": "Only first level" "Inheritance mode": "All" "Collection type": "All" Buttons for the operation of the query The general valid part of the control elements was already explained in section "Operation: Standard controllers (Page 66)", so only special points are being dealt with here. The settings of the following toggle buttons have an additive filtering effect on the display. 74 Operating Manual, 04/2012, A5E

75 Standard queries 5.6 Standard query Attributes "Search technique" "Only first level" Only objects of the first subordinated hierarchy level are displayed. "Recursive" Objects of all subordinated hierarchy levels are displayed. "Database search" Enables the database based search. See also section Database search (Page 93). "Inheritance mode" "All" Display all attributes "Own (checked in)" Only display the object's own (checked in) attributes "Inherited (not checked in)" Only inherited (not checked in) attributes are displayed "'Collection' type" "CDevices" Base objects evaluate whether any relevant attributes exist. "Elements" Only evaluate elements. This does not refer to the "Class" element but instead to objects of the "Collection" element. These are the objects that are located on the "Elements" tab. "All" Evaluates everything. "Attribute type" "Attributes" Only "real" attributes are considered. "Tabs" Attribute tabs are very similar to attributes from a technical point of view and hence are also covered by the standard query for "Attributes". Operating Manual, 04/2012, A5E

76 Standard queries 5.7 Standard query Documents "Attribute columns" Lists in COMOS have two levels: The first attribute functions as a container for the entire list. Underneath there is another attribute for each created column. "All" All above options. 5.7 Standard query Documents General Call via "Extra > Query > for documents > Query: Documents": Default "Start object(s)" field: "***Not set" Columns "Document", "Description" and "Type" "Include/exclude start object(s)": "Include start object(s) in selection" "Options": 1,3,4 activated "Extended functions": disabled Buttons for the operation of the query The general part of the control elements was already explained in section "Operation: Standard controllers (Page 66)", so only special points are being dealt with here. "Include/exclude start object(s)" "Include start object(s) in selection" All objects that were set in the "Start object(s)" field can also appear in the results list. "Exclude start object(s) in selection" All objects that were set in the "Start object(s)" field will not appear in the results list. 76 Operating Manual, 04/2012, A5E

77 Standard queries 5.7 Standard query Documents "Options" "Search documents below documents" Enabled: Documents that are located under other documents are also displayed in the dialog window. Disabled: The search stops in a branch when a document is reached. "Search documents below revisions (TIFF documents)" Enabled: The TIFF documents of the revisions are found and can thus also be printed. "Autom. links to 'Documents with location and unit pointer'" Documents can have a pointer to a unit and/or a location. This also produces a backpointer: A link is created below the unit or location. This link shows: "This unit exists as a pointer for the following document". The backpointers are evaluated if this option is enabled. You also see linked documents in the result list, meaning documents whose original is located in another location. Note Documents may appear twice in the results list if this option is enabled. "Autom. links to 'Engineering object with location and unit pointer'" Engineering objects can have a pointer to a unit and/or a location. This also produces a backpointer: A link is created below the unit or location. This link shows: "This unit exists as a pointer for the following engineering object". The backpointers are evaluated if this option is enabled. The links to engineering objects are followed and a further search for documents is made, the found documents also appear in the results list. Note Documents may appear twice in the results list if this option is enabled. "Activate extended functions" This option adds additional buttons to the interface: Operating Manual, 04/2012, A5E

78 Standard queries 5.7 Standard query Documents "Print selected documents" Prints the selected documents on the default printer. Note The order of the documents in the object query changes according to the setting, sorting, filtering, etc. The data have a fixed position in the Navigator and thus the documents also have a fixed order. If you start with the default setting of the Navigator, the documents always appear in the same position in the tree, in the same document group, and in the same order. If the documents are printed via "Standard query Documents", the order may differ from "familiar" one in the Navigator. For that reason "Default query documents" offers the option to change the print order so that it matches the order in the Navigator. Through this you avoid to manually sort the documents after having printed them. "Stop" This button terminates the initiated printing. Extended functions Extended features are listed in the following: "Evaluate documents" You find more information on this topic in the "Document Management" manual, keyword "Updating documents manually". "Revision" With this option the "Revision" window is displayed. You can select a revision step here. If you make a selection one step further down in the list, the steps before it are also automatically executed. The window is enlarged with the "Extended >>" button, additional controls are displayed for revisioning and descriptive text can be entered. Note The selected revision steps are only executed for the documents if this is meaningful. 78 Operating Manual, 04/2012, A5E

79 Standard queries 5.7 Standard query Documents "DWG/DXF export" Opens the "Export to DWG/DXF" window: The dialog saves the marked documents as DWG or DXF. "Without subdirectories" The file name of the saved files is composed of the name of the COMOS object plus the project name. "With subdirectories" Subdirectories are created underneath the target directory; the file names of the marked documents consist only of the names of the COMOS objects and are then sorted into the subdirectories. "File selection": The target directory underneath which the documents are saved. "Select file type": The documents can be saved in the DXF and DWG formats. "Copy TIFF/PDF file of the released revision" Operation as already explained for "DWG/DXF Export". "Word-Export" The selected report is exported to Microsoft Word and its contents are shown in Word. "Excel-Export" The selected report is exported to Microsoft Excel and its contents are shown in Excel. See "Interfaces" manual. "PDF-Export" The selected report is exported as PDF. See also chapter Using the PDF export (Page 80). "Print current revision file" If a revision is completed a Tiff or PDF file is created. This option prints the last available revision file. "Print with revision printer" Prints the report with the help of the revision printer. Operating Manual, 04/2012, A5E

80 Standard queries 5.7 Standard query Documents "Checking interactive reports for inconsistent DocObjects" Several things happen in COMOS when an object is placed on a report: "ReportObject": An object that contains the graphic characteristics of the COMOS object (and some administration information) is created on the report. "DocObj": An object is saved under the COMOS object that manages the information regarding which document the COMOS object is placed on. Under certain circumstances it may occur that DocObj stay put when objects are copied or moved. If you right-click on the white area of an interactive report, you get among other things the "Check document" command. This command starts a match of report objects and document objects and thus immediately finds these superfluous references (DocObj). "Display documents with inconsistent DocObj in the error list" The marked documents are checked. The effect is the same as when you open documents one after another and use the "Check document" command. The results of the check appear in the object test, that does not open automatically. The "Check" note appears, if necessary, at the bottom right in the COMOS status bar. You get the "Object test" command when you click on this message. "Deleting all inconsistent DocObjects" The unnecessary DocObjects are deleted. This option cannot cause any loss of data, as it does not affect either COMOS objects or report objects Using the PDF export Requirements You are using COMOS documents, i.e. interactive or evaluating reports. Starting a PDF export The following options are available for starting a PDF export: COMOS menu "Documents > PDF export" COMOS menu "Documents > All document tools" Context menu of a report "Export > PDF" Configuring a PDF export Settings Intelligent PDF export Unit This option enables the evaluation of the three fields "Unit", "Location" and "Documents". Generates a PDF bookmark with the reproduced COMOS navigator tree in the "Units" tab. 80 Operating Manual, 04/2012, A5E

81 Standard queries 5.7 Standard query Documents Location Documents Output Name/description Navigator text Models Archiving according to ISO standard in PDF/A-1b format Selection Generates a PDF bookmark with the reproduced COMOS navigator tree in the "Locations" tab. Generates a PDF bookmark with the reproduced COMOS navigator tree in the "Documents" tab. Creates the PDF bookmarks based on the name and description of the object in COMOS. Creates the PDF bookmarks based on a system similar to a labeling system. The Navigator text will be included. Generates the PDF file according to the PDF/A-1b standard. The target file is selected here. Using export results Bookmarks of the PDF file The bookmarks form the Navigator tree in accordance with the export configuration. For each of the three tabs, "Units", "Locations" and "Documents", there is a top-level PDF bookmark, underneath which the tree structure of the COMOS objects is reproduced. Another three element levels underneath documents are taken into consideration. The bookmarks are color-coded in the PDF as follows: Documents: Blue Placed components: Black Unit objects and folders: Normal Navigation You can navigate to the PDF page for placed components in the bookmarks. A context menu is generated in the event of multiple placing. On the PDF page, you can navigate to other PDF pages via page references Further information regarding printing It often happens that large number of documents are selected via the "Print" dialog. For this reason, COMOS attempts to combine print jobs as far as possible. This accelerates the print jobs, reduces the amount of resources needed, and simplifies the administration. However, the prerequisite for this is that the print options (document type, height, width, alignment, etc.) within the jobs do not change. The subsequent output format can be specified in the defaults for reports. This can be done by entering the instruction PaperSize = "Parameter" in the option part (script) of the Master Report (permissible parameters: A0... A4). Reports with this default setting are automatically reduced or enlarged to output size. If the selected output size is not supported by the printer, the current printer setting is used. Operating Manual, 04/2012, A5E

82 Standard queries 5.8 Standard query Connectors It is possible to print reports with different formats (such as A4, A3, landscape, portrait, etc.) within one and the same print job. Non-COMOS documents (such as Excel, Word, text files, etc.) continue to be handled in a separate print job. Print jobs have a name: If a single COMOS document is printed, the print job gets the "FullLabel" of the selected document as a name. If several documents are printed, the job gets the name "Comos prn_<sequential number>". Multiple subsequent reports are combined into one print job. When you print an external COMOS document, such as a Word document, the print job gets the name set by the respective application. Example: Word and Excel is the file name of the respective document. 5.8 Standard query Connectors General Call: "Extras > Query > Connector queries > Query: Connectors" This query also finds connectors of objects below the documents. Default Field "Start object": "***Not set". Columns: "Owner", "Name", "Label" "Search technique": "Only first level" "Inheritance mode": "All" "Collection type": "Elements" "In use/available": "All" "From connected objects only the first connector": "Off" Buttons for the operation of the query See also section Operation: Standard controllers (Page 66). The following only covers special features. 82 Operating Manual, 04/2012, A5E

83 Standard queries 5.8 Standard query Connectors "Search technique" "Only first level" Only objects of the first subordinated hierarchy level are displayed. "Recursive" Objects of all subordinated hierarchy levels are displayed. "Inheritance mode" "All" Display all connectors. "Own (checked in)" Only display the object's own (checked in) connectors. "Inherited (not checked in)" Only display inherited (not checked in) connectors. "'Collection' type" "CDevices" Evaluate base objects. "Elements" Only evaluate elements. This does not refer to the "Class" element but instead to objects of the "Collection" element. These are the objects that are located on the "Elements" tab. "All" Evaluates everything. "In use/available" "All" Displays all connectors. "Used" Only displays used connectors. "Free" Only displays free connectors. "From connected objects only the first connector" Among other things, the connected connectors can also be displayed in the query in an additional column. This may have the result that the same connector appears twice in the list, as the "main connector" and as a "connected connector". Effect: If the option is enabled, the list (which may already have been filtered and sorted) is evaluated once again and the duplicated entries are removed. Operating Manual, 04/2012, A5E

84 Standard queries 5.9 Outputting standard queries in reports Subsequent filters and sortings of the list are blocked if this filter is enabled. If the filter is deactivated, all other filter and sorting options are released again. The here described option is intended to create connection lists. "Delete free auxiliary connectors" When you click this button, a window appears asking if you want to delete the free auxiliary connectors. When you press the "Yes" button, the free auxiliary connectors are deleted. 5.9 Outputting standard queries in reports You find more detailed information on this topic in the "Reports - Basic Operation" manual All document tools Call To call up all document tools, select "Extra > All document tools". Functionalities The "All document tools" option is based on a query for documents. To display a list of documents in the Object Browser, drag&drop an object from the Navigator into the "Start object(s)" field. The "All document tools" option provides you with query functionalities as well as print and export functionalities. The following functionalities are available to you: "Navigate..." "Refresh" "Print list" "Export data" "Properties" "Search at once": "Find" "Search technique" "Not recursive" "Recursive" "By linked attribute" "Database search" 84 Operating Manual, 04/2012, A5E

85 Standard queries 5.10 All document tools "Include/exclude start objects" "Options" You find further information on print and export functionalities in the "Document Management" manual, keyword "All document tools". Operating Manual, 04/2012, A5E

86 Standard queries 5.10 All document tools 86 Operating Manual, 04/2012, A5E

87 Other queries Translation You can find additional information on this topic in the "COMOS Administration" manual, keyword "Translation". 6.2 Displaying query views in the Navigator You find additional information on this topic in the "Basic Operation" manual, keyword "Views". 6.3 Reimport You find additional information on this in the "Interfaces" manual, keyword "Reimport". 6.4 Device selection (product data) You can find additional information on this in the ""EI&C Operation" manual, keyword "Device selection (product data)". 6.5 User-defined This query shows the most general form of all queries. It is completely freely configurable. To create new columns, click on a white area and select the "New" command. The icon bar can be extended with the help of the DLL extension. Object queries have interfaces with which you can develop your own object queries. This in particular applies to IExtended. Example: IExtended: CellValue (Variant) Variant is managed in the cells, limited to string / numeric. Operating Manual, 04/2012, A5E

88 Other queries 6.6 Query as a list Example An example for user defined queries is: Restoring COMOS objects. For more information on this topic, refer to the "Basic Operation" Manual. 6.6 Query as a list Object queries are used as lists in various dialog windows: Project selection (ProMgr) User list (UsrList) User groups (UsrGrpList) User rights (RightsList) Material flows (PEMStrList) Material flow components (PEMStrComp) Autoroute manager (ARManager) Project directory matching (DocFileEqualizer) Project revisions (ObjRevisions). The mini-query has a very limited context menu compared to an object query. Only those commands are provided that are practical in the context of a simple list. Typically, it offers the following commands: "Edit / Edit": "Navigate" "New" "Copy" "Paste" "Delete" "Properties cell object" Special commands appear in addition, depending on the list. The usual commands are available in the column header: "Sort" "Filter" etc. 88 Operating Manual, 04/2012, A5E

89 Other queries 6.7 Standard tables 6.7 Standard tables The standard queries in the following sections can only be created via the context menu and not in the properties of base objects. This standard query only provides the access to the properties of the list itself: Name Description Default value The actual list values are edited with the following standard query. Default "Start object(s)" field: "Project" Columns: "Name", "Description" and "Default value" "Search technique": "Only first level" "Inheritance mode": "All" Also, only certain branches of the standard tables can be selected in the "Start object(s)" field. Operating Manual, 04/2012, A5E

90 Other queries 6.8 Standard table values Buttons for the operation of the query See also section Operation: Standard controllers (Page 66). The following covers special features. The settings of the following toggle buttons have an additive filtering effect on the display. "Search technique" "Only first level" Only objects of the first subordinated hierarchy level are displayed. "Recursive" Objects of all subordinated hierarchy levels are displayed. "Inheritance mode" "All" A different collection of standard tables is displayed, depending on which type of project the query was executed in: System project: System project lists Base project: system project and base project lists Engineering project: system project, base project and engineering project lists "Own (checked in)" Only standard tables that were created in the current project are displayed. 6.8 Standard table values Call: Tab "Base objects" > Context menu > "New" > "New query"> "Standard" > "Miscellaneous" > "Standard table values" This standard query is the counterpart of the "Standard table standard queries". 90 Operating Manual, 04/2012, A5E

91 Other queries 6.8 Standard table values Default "Start object(s)" field: "Project" Columns: "Name", "Description" and "Value" "Search technique": "Only first level" "Inheritance mode": "All" Also, only certain branches of the standard tables can be selected in the "Start object" field: Buttons for the operation of the query See also section Operation: Standard controllers (Page 66). The following covers special features. The settings of the following toggle buttons have an additive filtering effect on the display. "Search technique" "Only first level" Only objects of the first subordinated hierarchy level are displayed. "Recursive" Objects of all subordinated hierarchy levels are displayed. Operating Manual, 04/2012, A5E

92 Other queries 6.8 Standard table values "Inheritance mode" "All" If a value of a standard table is checked in, the entire standard table is always checked in, and hence all values of the standard table. If this option is enabled, the following lists are considered in the standard query: In the system project, only lists of the system project. In the base project: lists of the base project and the system project. In an engineering project: lists of the engineering project, the base project and the system project. "Own (checked in)" Only the values of standard tables are displayed that are located in the current project. 92 Operating Manual, 04/2012, A5E

93 Database search 7 There are different possibilities for searching for data in COMOS. A common method to search is the object query. However, the object query search is not directly conducted on the database level, instead the search is conducted in the objects in which the data is managed. Thus object queries may be very slow. Searching large data volumes in COMOS can be accelerated if you conduct a database search instead of object queries. The database based search is a query type in which objects at the database level are marked with identification keys. Hereby the queries that apply to objects have a higher performance as regular object queries. Note that a database based search does not have all the characteristics of the other search techniques. Inherited or linked-to information is not considered. You can only perform a database based search in the case of queries for engineering objects or for documents. 7.1 Preparation of the database based search Before you start with the database based search you have to classify the base objects under which the search is to be conducted. When engineering data, i.e. objects or documents, are classified they are assigned an identification key which is taken from the associated based objects. This information is not inherited to the engineering data because it is not available from the engineering data in the object model but is rather stored in the database. In a database based search only devices are found for which you conducted a classification Performing the classification To perform the classification proceed as follows: 1. Open the "Base objects" tab in the base project in the Navigator. 2. Select the base object which you want to classify. 3. Right-click on the base object and select the "Properties" command. The properties of the base object are displayed. 4. In the properties, click on the "System settings" tab. Operating Manual, 04/2012, A5E

94 Database search 7.1 Preparation of the database based search 5. Deposit the classification criteria for the base object in the "Classification" content area Classification criteria With the help of the classification criteria you can label the base objects under which you want to search. In the following you get an overview of the classification criteria that you can use. Hierarchical classification The hierarchical classification describes the class structure and therefore the base data structure of a COMOS module. The string for this classification consists of a maximum of five times two characters. You can recognize the location of the used base objects based on the string. The structuring system can be found in the "Base objects" tab underneath the following node: "@System classification key 1, structural" For every structure node from the structuring system you can enter two letters in the "Hierarchical classification" field. If, for example, you want to hierarchically classify a variable, you have to enter following identification key in the "Hierarchical classifcation" field: "ECSWVA" 94 Operating Manual, 04/2012, A5E

95 Database search 7.1 Preparation of the database based search You can use the "..." button to enter classification criteria. Functional classification In the functional classification you can assign identification keys which are independent from the base data structure of the objects. For example, you can use the functional classification to identify whether a device should be viewed under "Archive", "Bulk ware", or "Folder". Altogether you can deposit five times two characters for the functional classification. The key to the functional classification can be found in the "Base objects" tab under the following node: "@System classification key 2, functional" User classification The classification labeling can be freely selected. for the user classification. Operating Manual, 04/2012, A5E

96 Database search 7.1 Preparation of the database based search Project properties for the database based search Extra project options In the "Options > Comos" tab in project properties you can define your settings for a database based search in the "Extra project options" control group. Enter the settings in the "Search settings for base data" list. The following table describes the entries in the list: Entry "Take base object pointer into account" "Ignore base object pointer (default)" Description With this setting the search will also consider inherited information. This means that it will also consider the reference to the base object. With this setting the search will consider inherited information as well as hierarchy. The evaluation of classification is not support here. The result table supports hierarchical representation Creating a query for a database based search for objects Procedure After having classified the base objects you can create a query for the database based search. To do so, proceed as follows: 1. Click the menu "Extras > Query > for engineering objects > Query: Engineering objects". 2. In the query window that opens, enable the "Advanced" run mode. See also section Run modes for object queries (Page 51). 3. Click on the arrow next to the "Search technique" button and select "Database search". 96 Operating Manual, 04/2012, A5E

97 Database search 7.1 Preparation of the database based search The query window After you click on the "Database search" button, the query window changes: Filters and buttons are displayed. Via the filters and buttons you can define criteria values for the parameters of the database based search. You can hide specific areas. These areas include: Start object Query description Filter blocks You can hide or show these areas using the query options on the "Input layout" tab. See also "Input layout" tab (Page 35) Fields and function elements of the query window Classification Via the fields in the "Classification" area, you can enter the classification criteria of the base object in which you want to conduct the search. See also section Performing the classification (Page 93). You can use the lists to select the classification criteria. If you have already set a start object, you can run a search without having to enter filter criteria. Operating Manual, 04/2012, A5E

98 Database search 7.1 Preparation of the database based search Filter With the help of the lists that are located underneath the fields in the "Classification" area you can select the criteria for filters. Criteria are additional restrictions for the search in order to only get records of interest in the result set. If you select the "Description" from the "Field" list, no values will be output which are not available directly in the COMOS DB and still need to be calculated, e.g. scripts. To filter a search based on advanced properties, these properties must already have been defined in the database. If you select the "FreeProperty" entry from the "Field" list, select the table name from the next list and then the column name of the advanced property. Select the operator in the last two fields and enter the filter value. If you select the "Attributes" entry from the "Field" list, enter the name of the attribute in the next field. Continue by entering an operator and a value for this attribute. COMOS will find engineering and base objects that have registered attributes with the specified name and value. Labeling You can enter a text that describes the purpose of the query, for example, in the field in the upper area of the query window. Performance level The performance level is calculated by the core and has the name PerformanceIndex there. The performance level changes depending on your selection in the "Field" list. For more information on this topic, refer to the "COMOS.dll" class documentation, keyword "PerformanceIndex". The Performance light is displayed in front of the "List" field on the query interface. The light changes from green (PerformanceIndex 0) to yellow (1) to red (2) Creating user-defined fields Additionally to the already described search criteria, you can develop fields in which the user can or must enter a certain search value. 98 Operating Manual, 04/2012, A5E

99 Database search 7.1 Preparation of the database based search To design the fields you can enter the following values from the list: "No input from user is required" If you select this value, the user cannot enter a search item in the query window. "User can enter value" If you select this value, the user can enter any search item he wishes in the query window. A soon as this value is selected an additional window is displayed below the "Start object" field. Via the field that is directly located next to the list for selecting the user-defined fields, you can enter a description for the edit field. "User must enter value" If you select this value the user has to enter a certain search item in the query window (see also section "Working with mandatory fields" below). A soon as this value is selected an additional window is displayed below the "Start object" field. Via the field that is directly located next to the list for selecting the user-defined fields, you can enter a description for the edit field. Working with mandatory fields If you selected the "User must enter value", you can define parameters for the field. For example, you can drag a standard table into the "Standard table" list. Once you have dragged a standard table into the "Standard table" field, you can use the list to the left of "Standard table" field to specify if the user should be allowed to only select values from the standard table to execute a query, or whether the user can select values from the standard table as well as own search terms. Select the "List value" value if you want the user to only have rights to select values from the standard table. Select the "Edit value" value if you want the user to have the option for the query to select values from the standard table as well as own search items. Operating Manual, 04/2012, A5E

100 Database search 7.1 Preparation of the database based search Creating additional filters If you want to further restrict a data set group on which a filter was already applied you can define additional filters. To do this, click on the "Add new filter" button. When you click on the "Add new filter" button, new lists are displayed below the already existing filters via which you can select additional criteria for filters. Delete filter You can delete filters by clicking the "Delete filter" button. Defining additional filter blocks If the filters for the search are not sufficient for your needs you can create more filter blocks and can therefore add more classifications to the already defined classifications. To do so click on the "Add new data set" button. After having clicked on the "Add new data set" button a new filter block is displayed underneath the already existing filter block from where you can define more classification criteria and filters. Delete data set Via the "Delete data set" button you can delete a filter block. Linking logic of the query The classification criteria and filter that you selected are linked with each other to a query. COMOS first scans the database for the classification criteria you have specified in the fields of the "Classification" area. The results are then narrowed down further, via the filter criteria you have selected. At last the criteria is added to the query that you defined via the additional filter block Executing the search The search can be conducted after having selected the desired classification criteria and filters. Click on the "Search" button. When you click on "Search", the result of the search is displayed in the Object Browser and can be edited there. See also Object Browser (Page 15). 100 Operating Manual, 04/2012, A5E

101 Database search 7.1 Preparation of the database based search Saving the query You can save a query and use it as often as desired. Procedure To save the query proceed as follows: 1. Click on the arrow next to the "Save" button and click "Save as". 2. In the "Save as" window, you select a storage location as well as a name and description for your query. 3. Click "OK". 4. Once you have saved the query, switch to the "Simple" run mode. See also Run modes for object queries (Page 51). Result If a user now opens the query, a query form for the database based search opens whose configuration options are limited in such a way that the user can retain a clear overview. Operating Manual, 04/2012, A5E

102 Database search 7.2 Database based search for documents 7.2 Database based search for documents A database based search for documents is created similar to the database based search for engineering objects. It differs in a way that you do not have to conduct a classification for the database based search for documents Creating a query for the database based search for documents In order to be able to conduct a database based search for documents you have to create a query. To do so, proceed as follows: 1. Click the menu "Extras > Query > Query for documents > Query: Documents". 2. In the query window that opens, enable the "Extended" run mode. See also section Run modes for object queries (Page 51). 3. Click on the arrow next to the "Search technique" button and select "Database search". The created the query for the database based search for documents in the same way as the search for documents in the database based search for engineering objects. Instead of the classification criteria, enter the following in the "Classification" field: "Name" the name of the document group which you want to search for. 7.3 Cross-project queries Use cross-project queries to obtain an overview of different plant versions or plants that are distributed across several projects. Cross-project queries can be used for the following objects: Engineering objects Base objects Documents Base object To be able to work with cross-project queries, you need the base object "@System > QDev003 Query: cross-project engineering objects" from the database. 102 Operating Manual, 04/2012, A5E

103 Database search 7.3 Cross-project queries Creating cross-project queries Procedure You can create a cross-project query in two ways: Click "Query" in the toolbar and select one of the following prepared cross-project queries: "Query > for engineering objects > Query: cross-project engineering objects" "Query > for base objects > Query: cross-project base objects" "Query > for documents > Query: cross-project documents" Select the "Base objects" tab in the Navigator. Right-click on the object at which you want to create the cross-project query. Select the "New > New query in engineering project > Standard" command from the context menu and select the required query. You can then use the query in the plant. See also Cross-project queries (Page 102) Using cross-project queries across all projects Procedure 1. Create a cross-project query. 2. Select the "*** In all projects" entry from the "Start object(s)" list. 3. Configure the query as required. 4. Start the search. Result COMOS scans the project currently logged on to the current work layer and all other projects in the released area. By default, the cells in the search result cannot be edited. To edit the properties of an object, navigate to the object. The query remains visible in this case. You have the option of creating editable columns. See also Creating cross-project queries (Page 103) Operating Manual, 04/2012, A5E

104 Database search 7.3 Cross-project queries Using cross-project queries across individual projects and work layers Procedure 1. Create a cross-project query. 2. Click the "Open project" button. The "Open project" tab opens. 3. Click the header in the "Open project" tab and hold down the left mouse button. The Move cursor appears. For more information on this topic, refer to the "COMOS Platform Getting Started" manual, keyword "Splitting frames". 4. Drag the header with the Move cursor to an arrow. A frame is displayed. The frame indicates the position to which the tab will be moved. 5. Release the left mouse button as soon as the required frame is displayed. The "Open project" tab is displayed along with the cross-project queries tab. 6. Drag&drop the required work layers or projects from the "Open project" tab to the "Start object(s)" field of the query. Select only one work layer per project. 7. Configure the query as required. 8. Start the search. Result The result of the query will be listed. By default, the cells in the search result cannot be edited. To edit the properties of an object, navigate to the object. The query remains visible in this case. You have the option of creating editable columns. See also Creating cross-project queries (Page 103) 104 Operating Manual, 04/2012, A5E

105 Update Classification Classification Types The following types of classification exist: Type Hierarchical classification Functional classification User classification Description The hierarchical classification describes the class structure and therefore the base data structure of a COMOS module. Functional classification describes the function of an object across modules. This classification is available for company-specific purposes. See also section Classification criteria (Page 94). Objectives of the classification The classification has the following objectives: 1. Search: The objective is to find a particular object or similar objects. You are supported by specialized queries when doing so. 2. Control: The goal is to assign similar reactions. In this case, either the objects themselves can react in the same way or else the environment treats all objects in the same way. 3. Standardization: The objective is to create uniform names for objects across databases and companies. This simplifies the matching, exchange and merging. Update Classification If you change the classification of an object, such as a container, you have to perform an classification update, so that the respective object can be found in a query if the corresponding class is selected. See also Performing the classification (Page 93) Operating Manual, 04/2012, A5E

106 Update Classification 8.2 Updating classifications 8.2 Updating classifications Requirement You have performed the classification. Procedure To perform a classification update, proceed as follows: 1. Select one of the following options: If you only want to perform the classification update for the currently open project, click on the "Administrator> Update Classification > Current project" menu. If you want to update the classification upgrade for all projects of the open database, click on the "Administrator> Update Classification > All projects" menu. Result The classification will be updated for the currently open project or for all projects. See also Classification (Page 105) Performing the classification (Page 93) 106 Operating Manual, 04/2012, A5E

107 Bulk processing Bulk processing: Preliminary notes Old and new techniques The bulk processing tools are based on object queries. The tools are offered in the COMOS menu bar if the following data structures with underlying base objects exist in the base project: "@System "@System "@System "@System "@System If the base data contains hierarchical structures with greater nesting depths, these are made available in the COMOS menu bar in the form of submenus Interface Bulk processing queries are always split into two parts: The left section consists of a standard query. The right section displays the necessary properties of the objects. The typical context menus are also available here. Thus the context menus for static links are made available if an attribute tab is displayed on the right. Additional context menus for attribute tabs: "Show/Hide General tab" "Copy tab data" "Paste tab data" Operating Manual, 04/2012, A5E

108 Bulk processing 9.2 Bulk processing of engineering objects 9.2 Bulk processing of engineering objects Purpose Bulk processing allows the user to quickly enter and change the general data and attribute values for large amounts of engineering data. Open the menu "Extra > Bulk processing > Bulk processing for engineering objects > Bulk processing: Engineering objects" The left window area The left area of the bulk processing window consists of a standard query for engineering objects. See also section Standard query: Planning objects (Page 68) The right window area All standard dialog fields ("Name", "Label", "Description", "Folder") can be used in the usual way. The references are set in the usual way via drag&drop. At the bottom edge of the window you initially see a single blank tab that is labeled as "General". This area is used to collect, display and edit the attributes. Attribute tabs can be dragged into the gray area using drag&drop, see the following. The change only takes effect for objects that have an attribute tab and an attribute of the same name as the changed attribute and which have the same object class. 108 Operating Manual, 04/2012, A5E

109 Bulk processing 9.2 Bulk processing of engineering objects Work flow for bulk processing Setting the object and defining filters Drag an engineering object from the Navigator into the "Start object(s)" field": Thus the root object is specified. as a maximum, all engineering objects that are located underneath this root are displayed and processed. "Start object(s)": Clipboard It is also possible to set a quantity of base objects as start objects. This is done by marking and copying a set of base objects and then selecting the "Clipboard" entry in the "Start object(s)" field of the object query. Effect: A search is made for all engineering objects that have one of the base objects or a base object that is hierarchically located below it in the tree (logical OR combination). You will often want to further restrict the quantity of the displayed objects (and hence also the to be processed objects). See also section Standard query: Planning objects (Page 68). It is the combination of the "Start object(s)" field and the defined filters that ultimately determines what is displayed and hence also processed in the bulk processing Collecting and preparing attributes Once you created the desired object list, you have to specify the to be edited attributes. Only attributes from the engineering project can be edited. Right-click on an object in the result list of the bulk processing and select "Navigate > Object". Effect: The object is selected in the Navigator. Operating Manual, 04/2012, A5E

110 Bulk processing 9.2 Bulk processing of engineering objects The attributes are displayed in the Navigator underneath the object. Use drag&drop to move one of them onto the "General" tab of the bulk processing window: This drag&drop operation functions both as shown above for attributes in the Navigator, as well as for attributes that are located in the properties of an object. You can also take over complete tabs. An attribute is only displayed on the working area if the last selected object in the list also has this attribute. As a reminder: you can also display and edit the to be edited attribute in the left window area. Do this by dragging the attribute into the column header of the result list. Whether or not an attribute is also displayed in the list window does not affect the functionality of the bulk processing. The cell remains empty if an object does not have the attribute Save the settings Save The created collection of attributes and tabs is saved. The settings of the list window are also retained Marking objects The inputs that you make on the right side (of the working area) only take effect on the objects marked on the left. You can mark individual items with the <Shift + Ctrl> key combination as usual in Windows. Regard the order in which you mark the objects. The attributes that were dragged onto the working area are only displayed if the first row of the selection on the left in the list also has this attribute. Normally the list is selected in such a way that all marked objects have the attribute, then the display problem simply does not occur. 110 Operating Manual, 04/2012, A5E

111 Bulk processing 9.2 Bulk processing of engineering objects Changing the general data and the attributes General data In the upper area you find the edit field of the general data: You can change any of the properties with the help of the edit fields, including the name. Thereby the multiple selection is also available. If a group of objects is marked, the texts in the "Name", "Description", "Label", "Base object" fields, etc., fields are partially displayed in blue. The blue background color indicates that not all marked objects in this field have the same value. Basically the fields with blue texts can also be edited. The information of the first object in the current collection is displayed. There are two cases: The field may contain the same values. If you change one entry while making a multiple selection, all marked objects are assigned this input. After making the input, the text is displayed in black again. Now all marked objects in this field have the same value. The field cannot contain the same values ("Name", "Label"). COMOS outputs a warning and attempts to automatically adjust the input (for example, automatic continuous counting). Attributes The attributes in the working area can be edited in the usual way. The attributes for this scheme can be more clearly arranged in the "Design mode". (The position and size of the original attributes is not changed by this.) No attributes can be newly created or deleted. The "Delete tab attribute" context menu command only deletes the attribute from the bulk processing scheme. Operating Manual, 04/2012, A5E