Cobra Navigation Release 2011

Transcription

1 Cobra Navigation Release 2011 Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 1 of 34

2 Contents Contents 1 Revision History Introduction Cobra Login Initial Entry Menu Security and Access Query Screen Define your Query Fieldname Operator Value to Compare Sort Order Output Type Predefined Query Execute Save Query Insert New Record Excel Tip Query Result (Index) Screen General Query result Limit Adapt Query result screen Document Repository Attach Documents View Documents Remove Documents Details Screen General Protected fields Predefined views...24 Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 2 of 34

3 Contents 6.3 Execution Bar Copy Record Insert Screen Data Loader Introduction How to operate Upload the CSV file to the Webserver Process the Uploaded CSV file Analyzing the results Load file Layout Example of a load file Example of a template: Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 3 of 34

4 Contents 8.5 The loader process in detail Error Messages...33 Appendix...34 Icons Used...34 Note: Examples in this manual are based on test data and do not reflect the true content of the tables, unless otherwise specified. Note: The Cobra Quotation System is used for sample screens Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 4 of 34

5 Revision History 1 Revision History Revision Date Comments Released Added Save Query content expanded how to disable the Excel confirmation on file format Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 5 of 34

6 Introduction 2 Introduction. Cobra is web based application, initially developed to support the Flowserve Aftermarket business. The main target was the development of a unified data entry environment, which uses a data driven data dictionary engine to produce the application scripts. Data Storage of isolated Cobra applications is an Oracle database, but the technology allows combining distributed databases of different architecture (Oracle, SQL, Access and so on), from different instances. The implemented data-entry concept is straight forward: Cobra starts with a query screen where users can define their search criteria to look for existing data, or to switch over to the Insert new record script. Query results are returned, from where specific records can be selected for detailed view and/or maintenance (incl. delete existing info). Query results can be exported to Excel and PDF. That s all there is to it. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 6 of 34

7 Cobra Login 3 Cobra Login From your Internet browser, use the following address to access Cobra Enter your user name and password in the fields provided respectively. (Inotes Username and Inotes Password!) Click the LOG IN button to proceed. a. If not successful, repeat the previous steps. b. If unable to log in, check with the Helpdesk to have your I-notes password reset. If this is a first time login, a users profile will be created that allows read-only access to the default applications. For more specific access, the System Administrator (John Maas) needs to be contacted (jmaas@flowserve.com) Note: Passwords cannot be reset by the Cobra System Admin team, this requires Helpdesk intervention. Most of the times, the I-notes ID is the same as you address ) but there are examples of Gems ID s being used also Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 7 of 34

8 Cobra Login 3.1 Initial Entry Menu Upon successful log in, the last accessed Cobra menu is displayed. Accessibility to the available applications per menu depends on the authorization of the current user. The Menu Selector will offer a selection of all the Menus the current user is subscribed to Select one of the subscribed menus and hit the Activate Menu button. This will display the applications that are assigned to the selected Menu. Subscribed Menus can differ per user. The menu subscription is done by the System Administrator Example: Menu entries are defined in a tree-like structure, the + sign in front of a menu option indicates there is more branches, that will open up when the + sign is selected Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 8 of 34

9 Cobra Login 3.2 Security and Access. Cobra accounts are identified by the unique I-Notes ID and are created by the system when a user logs in for the first time. Additional account information is stored to fully identify a user and contains elements that are required to decide what access should be granted. Additional information stored: Business Unit. Sales Engineer Code.. This data is maintained by the System Administrator. There are numerous tables that are read only by default for all Cobra Users, there are also tables that require special access to either modify or read the content. If the profile is not set up to access a selected table, a warning will be displayed. Security can be granted on a per user bases or can be role based. Please contact the System Administrator (or IT HelpDesk) if there is need for more access. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 9 of 34

10 Query Screen 4 Query Screen 4.1 Define your Query The Query screen enables the user to select records from the current table that is being accessed. A query consists of the following entities: FieldName Operator Value to compare Example: QuoteNumber = 642ABCD Fieldname All the fields from the current table are displayed in the order they appear in the table Operator The Operator is the comparison that needs to happen between the fieldname and the supplied field value. If the result is true, the record will be marked to be included in the query result. Operators can be selected from the list of values. The available operators depend on the field type where the operator applies to. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 10 of 34

11 Query Screen The supported operators are: Like ( %...% ) The value supplied to be somewhere in the string to search. F.i. QuoteNumber like ABC returns all the entries that have ABC somewhere in the QuoteNumber field. f.i 624ABC XYZABC Equal ( = ) The value supplied must equal the string or numerical value to search. F.i. QuoteNumber = 123ABC returns all the entries that have an exact match on 123ABC Not Equal ( <> ) Returns all entries that are NOT equal to the supplied value. Begins with ( % ) Returns the entries that begin with the supplied value Ends with (%... ) Returns the entries that end with the supplied value Greater than ( > ) Greater Equal than (>= ) Less than ( < ) Less Equal than (<= ) Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 11 of 34

12 Query Screen Example of the List of values for the query Operator Character type fields Numerical type fields Date Type fields Value to Compare The value is used to complete the equation and to determine if the query question results in either true or false. Date values are all to be entered in the DD-MMM-YYYY format (f.i. 04-Nov-2004). If the between operator is selected to find records for a given date range, two dates are expected, comma separated f.i: 01-aug-2011,31-aug-2011 Safest way is to use the date picker that accompanies a date field (will not work for date ranges). Fields that have supporting tables attached, are accompanied by the binoculars, which can be activated to zoom to the supporting table and select the value you want to use. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 12 of 34

13 Query Screen Any fieldname combination can be used in the query tool. Cobra determines if a fieldname is to be included in the query by the simple fact that a value needs to be defined for that field. The total query to be executed is determined as the combination of all fields that have a value defined in the query screen, combined with the relational operator AND. The different field types (numerical, string, date) have different query operators. Cobra takes care of this and allows only the applicable operators to be selected. 4.2 Sort Order. By default, the first field of the table is identified as the identifier for the query results to be sorted on. Changing the order can be achieved by selecting the field from the List of Values.. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 13 of 34

14 Query Screen 4.3 Output Type. By default, the query results appear in a tabular form within the Cobra application and are hyperlinked for detailed view/modify capabilities (one record per screen). To export the data for further use by other applications, the output type can set to Excel/PDF and the results will be in the selected output format. 4.4 Predefined Query Queries can be supplied for general use by the System Administrator. Available queries can be selected from the List of Values. Any additional query values defined in the Query Screen will be used in conjunction of the selected predefined query. Example: The selection of AsiaPacific Quotes would return all records that are related to Customers in any Asia Pacific country. If only the quotes, created since January 01, 2011 would be required, the Creation Date on the query screen should be set accordingly: Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 14 of 34

15 Query Screen 4.5 Execute The Execute button will evaluate the supplied Query input and switch to the Index screen, where the Query results will be shown. 4.6 Save Query The Safe Query button, will save the query design, linked to the current user, so it can be reused for future use. It will appear in the Select Predefined Query Selection box. Each saved query will be identified by the current users I-Notes ID and the table this query was designed for. A default name (current date) will be attached to this query design. Changing the name of a Query Design Go to Admin,Users Table Query for your own account This will show your account info Go to the Details Screen and Select the View User Defined Queries by clicking the binoculars Locate your query and change the Query Description to your personal likings. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 15 of 34

16 Query Screen 4.7 Insert New Record. This option is only available if the current user access allows creation of new Records Fur a description of the Insert Function See description of the Insert Screen 4.8 Excel Tip If the Excel output is selected, make sure that the results appear in a separate window (i.e. that MS Excel takes over). How?: Open your Windows Explorer Select tools from the title bar. Select Folder Options Select File Types Locate the.xls extension. Select Advanced and duplicate the settings as shown below. (Browse in Same Window should not be selected!) Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 16 of 34

17 Query Screen As of Excel version 7, the result file will not be displayed in Excel without a confirmation about the format. This confirmation box appears in the background, hidden from the open applications. By using the ALT-TAB sequence you can check to see if the confirmation is there, if not this means Cobra is not done yet with delivering the output To disable this hidden confirmation: In Windows XP, click Start, click Run, type regedit, and then click OK. 1. Locate and then click the following registry subkey: HKEY_CURRENT_USER\Software\Microsoft\Office\14.0\Excel\Security 2. On the Edit menu, point to New, and then click DWORD Value. 3. Type ExtensionHardening, and then press ENTER. 4. Right-click ExtensionHardening, and then click Modify. 5. In the Value data box, type the value data, and then click OK. The following list contains the value data settings that are appropriate for the ExtensionHardening setting: o 0: Do not check the file name extension and the file type, and bypass the function of the warning message. o 1: Check the file name extension and the file type. If they do not match, display the warning message. o 2: Check the file name extension and the file type. If they do not match, do not open the file. Note The default value data is 1. When the value data is set to 1, the behavior becomes the same as when no registry value is set. When the value data is set to 0, the file name extension and the file content are not checked in all situations. We do not recommend bypassing this function. 6. On the File menu, click Exit to exit Registry Editor. Careful!!! Going in to the Registry like this can cause serious issues, so prepare a full registry backup first!! Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 17 of 34

18 Index Screen 5 Query Result (Index) Screen 5.1 General The Query result screen shows the records that match the query criteria as defined in the query screen. Records are show in tabular form and be scrolled horizontally if the information width exceed the display width. Results are shown in batches of 20 records. Scrolling to the first/last/previous/next batch can be done with the navigation Icons. The translated query input is linked as a tooltip to the query result count Hoover over the text (in the middle) and the translated query will be revealed. From the query results screen, the details screen opens up by selecting the (hyperlinked) first field of the applicable row. In this example, Quote Number is hyperlinked to the Details screen Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 18 of 34

19 Index Screen 5.2 Query result Limit The results returned from a given query can be huge for certain tables. To avoid server overloads and response time degradation, the maximum amount of records to be returned can be set to a limited number. This limit can be defined on a per user basis. Whenever this limit is reached, Cobra displays a notification: 5.3 Adapt Query result screen. By default the query results are shown with ALL the fields that are available in the current table. Fields can be omitted by using the Adapt Query result screen Icon Only selected fields will be displayed in the query results screen Select All and Process will select ALL fields De-Select All and Process will de-select ALL fields Process will save the result for this table and the current user Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 19 of 34

20 Index Screen The above selection will only display 3 fields as the query result Selection of fields can be changed at all times. 5.4 Document Repository. Each Cobra application can be equipped with the functionality to attach multiple documents (of any kind) to table entries. The indication if the current table is equipped with this functionality is based on the presence of the green and/or yellow buttons, as the second element of the rows in the Index screen. What the colors mean: Yellow Button: click to attach documents. Green Button: click to view documents. Attach Documents View Documents If there is no green button, this indicates that there are NO documents attached yet. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 20 of 34

21 Index Screen Attach Documents. Click the yellow button, the following dialog opens: From here you either type in the document name (with the complete path) or you click the browse button, which enables you to locate and select the document from your computer or network storage. Once the document has been identified, press the Upload button and the document will be attached to the record of which the yellow button was pressed. The following status information will be displayed: To go back to the index view, use the browsers back button. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 21 of 34

22 Index Screen View Documents. Click the green button, the following dialog opens: Multiple document entries can be present, click on the document you want to view and the applicable viewer/application will display the document. Note: the application associated with a document needs to be installed on the client PC Remove Documents This functionality has not been implemented yet Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 22 of 34

23 Details Screen 6 Details Screen 6.1 General The purpose of the details screen is to display one record at a time and allow for modifications. Which fields can be modified, depends on the implemented security rules and use role for the table being accessed. The Details Screen can be equipped with subject tabs, subject paragraphs or a combination of both Example of Subject Tabs Only Example of Subject Paragraphs only Example of Combination Subject Tabs and Subject Paragraph Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 23 of 34

24 Details Screen Protected fields As general rule within the Cobra system, protected fields are colored grey. Fields can be protected based on the implemented security rules or for the simple reason that they are Read- or Display Only by design of the application. Example of Display Only fields are the related descriptions of coded fields (f.i country codes, sales engineer codes). These descriptions are there for informational purposes only. 6.2 Predefined views Whenever there are tables available that in some way can be linked to the current table, a predefined view can be designed to allow the display/maintenance of the linked data. An example of these links: Quote Header and Quote Lines, displays all the lines for the active quote number. Install base and Quotes, displays all the quotations for a given serial number The predefined views are created by the System Administrator and can be executed from the Details Screen. (click on the Binoculars) In the view, full Cobra functionality is available (incl. security rules) 6.3 Execution Bar Each Cobra application can have specific embedded functionality attached. These are all located at the Execution Bar and can be turned on or off, depending on the data content of the current record Example of the Execution Bar for Quote Header table Tooltips further explain the action, related to each Icon. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 24 of 34

25 Details Screen 6.4 Copy Record Records can be copied if the current user is allowed to insert new records in the current table (as defined by the security settings). The current record from the Details Screen will contain the source data. The identification of the target record will be defined in the Copy Script. As a general rule, the target record should not already exist. (exceptions can be implemented per application). Activate the Copy Option: General question asked: Current record of the Details Screen New record to be created with data from current record Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 25 of 34

26 Insert Screen 7 Insert Screen This is where the record identification (so called primary key) of the new table entry has to be defined. Control will switch to the Insert Screen by using the, available at both the Query- and Index screen (if security setting allow for Inserting new records). There are two ways of entering the primary key values for the new record Enter the values as they should be. Use the Generate button to retrieve the next available number. The generate functionality checks if the current user as specific numbering sequences defined for the current table. 1. If there is only one sequence defined, the next available number will be taken from the stack and control switches to the Details screen. 2. If there is more than one sequence defined, the user has to decide which sequence to use. 3. If there is no sequence defined, a warning will be displayed and the record identifier has to be entered as they should be. Example of multiple sequences defined. Example of no sequence defined Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 26 of 34

27 Data Loader 8 Data Loader 8.1 Introduction. The Cobra Loader is a generated application that is developed to do mass table loads, based on CSV file (comma separated file format) input. CSV files can be easily maintained through Microsoft Excel, or delivered as output by any given business system. Exception can be made to the separation character, this needs to be identified during the loader process (See figure 2) The description in this document is just an example of the generic process to follow. Since each Cobra table can be equipped with loader functionality, additional format description of the specific.csv file will be required to complete the process for a given table. 8.2 How to operate. The required loader is activated from the menu, next to the table that needs to be populated. Loader process consists of two steps Upload the CSV file to the Webserver Process the uploaded CSV file Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 27 of 34

28 Data Loader Upload the CSV file to the Webserver. To take exception on the delimiters used. Use the button to locate the CSV file, either on your hard drive or on the network Press to upload the selected CSV file to the Webserver. A confirmation message will be displayed Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 28 of 34

29 8.2.2 Process the Uploaded CSV file. Data Loader Press to process the entries in the CSV file. During the process, a status bar will be displayed and each row that is being processed will be displayed in a separate window. 8.3 Analyzing the results. After completion, the results are shown in tabular form Meaning: Nr of Records Added Nr of Records Updated Nr of Records Rejected Nr of Records Skipped Number of new records added (inserted) to the table, based on the processed load file Number of existing records in the table that were updated, based on the information in the processed load file Any row from the processed load file that contains an error will be rejected to be loaded in the table Some loaders are configured for new inserts only. Existing records are skipped and reported under this section. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 29 of 34

30 Data Loader 8.4 Load file Layout Although each loader can be designed to perform specific actions, the lay-out of the CSV load file has to comply with the following basics. 1. The first row always has to consist of the field names of the table for which the loader is designed (This will be communicated for each loader). 2. The following row(s) contain the data to be loaded, empty space between the delimiters is NOT allowed. For this purpose the dash has to be used (-). or the string null First row, contains field names Example of a load file Pattern_number,serial,number,owning_bu,pattern_family,qty_core_boxes 98AB123,01,ETL,null,3 3BC_D,01,COS,-,- 3BC_D,02,COS,-,4 Data to be loaded The above example will insert (or modify) three records in the given table, for which the loader was designed. Empty fields are to be defined as -.or null Each loader application is equipped with a downloadable load file template, which can be retrieved by the following link: An Excel formatted template will be generated, containing: The first row that is required for the.csv load file The Field descriptions (Length, type) Dropdown values (if any). Of this template, only row one is to be used for the load file, the rest is only there for information and reference. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 30 of 34

31 Data Loader Example of a template: As explained before, the first row of the load file identified the field names as they are used in the table, for which the loader was designed. Empty cells are not allowed in the load file (use the sign if a cell value is empty, this cell will in turn be ignored and the initial value in the table will not be overwritten). Columns can be omitted from the load file entirely, this will cause the load process to ignore that field to be populated or changed in the table. However, if a mandatory field is omitted during the insert of a new record, the loader will not load that specific row. (Will be reported in the error log at the end of the loader process). Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 31 of 34

32 Data Loader 8.5 The loader process in detail. The Cobra security model also applies to the execution of the loader process. If your account is not authorized, the following message will appear. In this case it is advised to contact the system admin John Maas Once the CSV file is uploaded to the webserver and the process button is pressed the following activities are performed on each row of the load file. Check for numerical fields that contain other than numerical characters Check for mandatory fields (fields that are not allowed to be empty) which are empty. Check if all foreign key elements supplied are valid (this means a validity check for country codes, customer numbers, and more ) If any of the above conditions are not met, the row will not be processed and the error will be displayed at the end of the loader process.(see figure 9). The error s can be handled by modifying the CSV file and start the process from scratch (any rows not flagged are processed and could be eliminated from the re-load) Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 32 of 34

33 Error Messages 9 Error Messages There is a distinct difference between system warnings and system errors. A system warning is nothing more than an informational message, saying what action is considered to illegal or inclomplete. For instance if a mandatory field is left empty, a warning will be generated to instruct the user that a value has to be supplied before the data will be committed to the table. Example of such a warning: Unfortunately, there are occasions that a user action causes situations that were not foreseen by the development team or just software bugs that cause the application to crash. When this happens (see the error below), it would surely help if you let the System Administrator know what happened, so it can be investigated and fixed. Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 33 of 34

34 Appendix Icons Used Appendix Icons Used Insert new record Zoom to supporting Table to make selection. The use is optional. The field that is linked to this Icon can also be manually edited. Selection from List of Values. Use is mandatory. The field that is linked to this icon cannot be manually modified. Date Picker. All date fields have a calendar attached, to select dates from Go to first screen of Query result Go to Previous screen of Query result Go to Next screen of Query result Go to Last screen of Query result Adapt Query result screen Attach Document Show Attached Documents Print Save input, stay on screen Cobra Navigation - Rev.0.2 Date: November jmaas@flowserve.com Page 34 of 34