Cockpit Quick Start - Cognition...
97
Cockpit Quick Start V 1.0 (Beta)
Transcript of Cockpit Quick Start - Cognition...
Cockpit Quick Start
V 1.0 (Beta)
2
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
This document is the sole property of Cognition Corporation and is not to be distributed outside of
Cognition without Cognition’s express permission. Use of this specification is reserved exclusively for
Cognition’s personnel, sales and marketing partners and Cognition Customers. The information and
drawings contained herein are the sole property of Cognition and shall not be divulged to any third party
without prior written consent of Cognition. The information in this specification is subject to change
without notice.
Copyright © 2005, 2015 by Cognition Corporation. All rights reserved.
General Notice: Some of the product names used herein have been used for identification purposes
only and may be trademarks of registered trademarks of their respective manufacturers and sellers.
Revision History
1.0 June, 2015 Created First Draft
Published and printed in the USA
Cognition Corporation
www.cogntion.us
213 Burlington Road, Suite 109
Bedford, Massachusetts 01730
781-271-9300
3
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Table of Contents GETTING STARTED ............................................................................................................................. 5
LOGGING IN .................................................................................................................................... 5
MY STUFF PAGE ............................................................................................................................. 7
COCKPIT UI ........................................................................................................................................ 9
TABLE OF CONTENTS (TOC) ........................................................................................................... 9
BODY PAGE ................................................................................................................................. 12
BODY PAGE MENU AND SEARCH ............................................................................................... 17
NAVIGATION BAR .......................................................................................................................... 17
MAIN MENU .............................................................................................................................. 18
TOOLBAR NAVIGATION BUTTONS ............................................................................................... 22
ENABLING MODTIPS ................................................................................................................. 27
ENABLING HELPTIPS ................................................................................................................ 28
ACCESS COCKPIT HELP ............................................................................................................ 28
LOGGING OUT OF COCKPIT ....................................................................................................... 28
RICH TEXT EDITOR ....................................................................................................................... 29
STANDARD OPERATIONS ON ALL ITEMS ......................................................................................... 29
COPY/MOVE/LINK ......................................................................................................................... 29
COPY ....................................................................................................................................... 29
MOVE ...................................................................................................................................... 29
LINK......................................................................................................................................... 29
FILE STRUCTURE AND PROJECT SETUP ............................................................................................. 30
OBJECT BREAKDOWN ................................................................................................................... 30
CONTAINER OBJECTS ............................................................................................................... 30
DATA ITEMS ............................................................................................................................. 30
ARTIFACT ITEMS ....................................................................................................................... 31
DOCUMENT/SECTION FORMATS ........................................................................................................ 31
DETAILS PAGE OF DOCUMENTS AND SECTIONS .............................................................................. 31
ADHOC LISTS ............................................................................................................................... 33
ADDITIONAL ADHOC LIST REFERENCE ....................................................................................... 36
SIMPLE CONFIGURATIONS ................................................................................................................. 38
CUSTOM TABLES .......................................................................................................................... 38
USER DEFINED ATTRIBUTES (UDAS) ............................................................................................. 40
SORT, FILTER, AND GROUP BY ...................................................................................................... 43
ADHOC TRACE TABLES ..................................................................................................................... 56
VIEW DEFINITIONS ............................................................................................................................ 57
ROW DETAILS .................................................................................................................................. 62
SETUP LEVELS ................................................................................................................................. 65
SITE LEVEL SETUP (CORPORATION LEVEL) .................................................................................... 65
ORGANIZATION LEVEL SETUP ........................................................................................................ 65
PROJECT LEVEL SETUP ................................................................................................................ 67
ADMINISTRATOR TASKS .................................................................................................................... 67
CREATING AND MANAGING USERS/USER GROUPS ......................................................................... 67
PRIVILEGES .................................................................................................................................. 72
4
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
LIMITING VIEW ACCESS AT THE ITEM LEVEL ............................................................................... 73
TEMPLATES .................................................................................................................................. 73
LIFE CYCLE AND WORKFLOW MANAGEMENT ...................................................................................... 74
LIFE CYCLES ................................................................................................................................ 75
ROLES ......................................................................................................................................... 76
CREATING A ROLE .................................................................................................................... 76
ROLE SETTINGS ....................................................................................................................... 76
ASSIGNING A ROLE ................................................................................................................... 76
ASSIGNING A ROLE USING A LIFE CYCLE COMMAND ................................................................... 77
BUILDING A SIMPLE CUSTOM WORKFLOW ...................................................................................... 78
COMMANDS AND ACTIONS ............................................................................................................. 78
COMMANDS .............................................................................................................................. 78
ACTIONS .................................................................................................................................. 79
ROLES ..................................................................................................................................... 81
AVAILABILITY ............................................................................................................................ 82
5
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Getting Started
Logging In
To log into Cockpit you must first access your installation. Your Cockpit administrator provides you with
this path, which is something like http://server/Cockpit. Log in using the username and password
given.
Exercise: Log into Cockpit
1. Open Internet Explorer.
2. Type in URL:
3. Click the here hyperlink located at the bottom left of the login page to perform a browser
check.
Note: It is successful when all responses are green checks.
4. Your initial username and password are:
U: admin
P: admin
6
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
5. Enter your username and password.
6. Click Submit.
Note: Once login is complete, your browser brings you to the home page of Cockpit. Notice the URL you used to login has an added number at the end of the server name:
This number is known as the slave port number in Cockpit.
A screen similar to the one below appears when logging in for the first time:
7
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
My Stuff Page
The My Stuff page is where your information and preferences are located. Any messages sent to you via
workflow or from another user also appear here.
Click on the user name in the upper left corner to open this page:
The page looks as follows:
Exercise: Open the My Stuff page and fill out all information
1. To get to get to the My Stuff page, click admin in the upper left hand corner of Cockpit:
2. Fill out your first and last name in their respective lines. The Name line shows what other users
see:
8
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
3. Enter an active email and telephone number. Providing an email is important because Cockpit
has the ability to email you through workflows:
4. Add a profile picture by clicking Add Image and browsing for a photo in the dialog:
5. Change your password here:
6. Under the Messages section you have access to any notifications and action items addressed
to you:
9
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Cockpit UI
Table of Contents (TOC)
The TOC is located on the left hand side of the browser:
The TOC is adjustable and collapsible. To adjust the width, drag the right edge to the desired size. To
collapse, click on the left blue bar. Click again to re-expand.
The TOC shows the hierarchy for the entire project, from the top level down to the lowest sub-system.
Navigation is made simple using the TOC buttons:
Refresh - Refresh the contents of the TOC
Toggle Text Editing - Modify the description of TOC
items
Hoist Item - Hoist the selected item to the top of the
TOC
Un-Hoist Item - Return the hoisted item to its initial
location in the TOC
Display Item Attribute - Choose how to display the
items in the TOC
10
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Learn functionality of the TOC
1. Move your cursor to the right most point of the TOC:
2. Click and hold the border. Move the cursor right or left to expand or contract the TOC to your
desired width:
3. Move your cursor over the blue border on the left side of the TOC. Click to collapse the TOC:
4. Move your cursor to the collapsed TOC and click. The TOC expands:
11
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
5. Click the Refresh ( ) button on the TOC. Notice that only the TOC refreshes.
6. Click the ab| button to make the TOC items editable:
7. Select an item in the TOC, then click the Hoist Up ( ) button. This button removes
everything but the selected item and the items below it. This is particularly helpful when there
are an overwhelming number of items in the TOC:
8. Click the Hoist Down ( ) button to return the TOC to normal.
12
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
9. Click the Display Item Attribute ( ) icon to bring up the following menu:
10. Try the built in views and note the changes to the TOC.
Body Page
The body page is located at the right hand side of the tool. It contains all the information requested from
the TOC. This is where the majority of your work is performed. The image below is similar to a typical
Cockpit project home page:
Each body page contains the page title, navigation menu, and attributes. For each object type (project,
document, requirement, etc.) the behavior of the menus and attributes vary. You will explore these pages
during training.
13
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
All pages have the following icons (with the exception of Meetings):
Flex Edit: Show the object graphically
Locate Item in Tree: Find the item in the tree
Copy Link: Single click to copy a Cockpit friendly link
to the clipboard; CTRL + click to copy just the URL
which can be used outside of Cockpit (Cockpit login
required to access link)
Email Page: Email the current page link to a single
user or multiple users
Follow Item: Add the item to the Tracking Followed
menu; When changes are made to an item,
notifications appear in the Tracking menu
Bookmark Page: Adds the current page to your
Cockpit Bookmarks found under the Tracking feature
Exercise: Use Flex Edit
1. There are two ways to enter the graphical editing mode (called Flex Editor) once you’ve
chosen which item you want to be the root of your graphical tree:
a. Right click the object in the TOC and select the Flex Edit icon.
b. Select the Flex Edit icon at the top right of the object’s body page.
2. A graphical view opens in the main window. Choose an object in this view to add a child to.
Right click that object and select Insert Child from the menu, or select the object and hit
14
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
the Insert key on your keyboard:
3. A new object is displayed with the name field highlighted. Change New Child to your desired
name:
4. The child object needs to be defined in order for Cockpit to classify it properly. Right click on
the new object and select Type Requirement.
15
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Note: The object changes color to reflect the object type:
5. Right click on the object again, and try out different requirement types.
6. Click Save and Close. The new requirement is added to the TOC:
16
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Note: Only Save and Close saves the contents of the flex editor back to Cockpit! If Close is
selected, changes are NOT saved! There is a warning when closing with unsaved data.
7. Shortcuts can be used for work in Flex Editor:
a. Enter key to enter new sibling:
b. Insert key to enter new child:
c. Del key to delete.
d. F2 key to edit name:
8. A selected object is marked with a blue frame:
9. Several objects can be selected by drawing a frame around them (e.g. to define several
requirements at the same time):
17
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Body Page Menu and Search
The body page also contains a menu bar, which allows for navigation on the selected object, and a
search bar. The Find text search allows you to find instances of text within the loaded page.
Navigation Bar
The top bar of Cockpit is the Navigation Bar. From here you can navigate to different projects, go to site
setup, search through Cockpit, and much more:
18
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Main Menu
The Main Menu provides options to navigate to other projects and configuration locations:
Select Project
Shows a list of projects you have View
access to. To change projects, select one
from the list.
New Project Creates a new project from scratch or from
a template.
Import Project Allows you to import a .COGZIP project file
into your own Cockpit installation.
Site Setup Navigates to Site Setup.
Organization Navigates to the Organization page.
Check Command Status…
In the event that a command window stops
reporting status, you can use this
command to show the status again.
Exercise: Use all of the buttons in the top right of the body
1. Select Main Menu and then New Project to create a new project:
19
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
2. Fill in the Project Description:
3. Select Finish to show your newly created project:
20
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
4. Import a project by selecting Import Project:
5. Click the Browse button to navigate to a .COGZIP (project file) on your local machine.
21
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
6. Click Open on the Windows dialog:
7. Select Finish on the import dialog. Your project appears after import.
8. Navigate back to a project. Select Main Menu Select Project. Select your
desired project via the command menu:
22
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Toolbar Navigation Buttons
Search
Allows access to Cockpit’s search feature.
This activates either the default Cockpit
search or Zoom search.
Layout
Select the layout of Cockpit. Two column
TOC options are available as well as
horizontal orientation.
Tracking Accesses Messages, Bookmarks, Tracked
Items, and Action Items.
ModTips Activates ModTips, which allow for quick
display of changes made to items.
HelpTips Turns on HelpTips.
Help View the Cockpit version you are using, as
well as access to submit support request.
Logout Logout of Cockpit.
Exercise: Use Search to find objects in the project
1. To enter search click the Search icon in the upper right corner of the tool:
A search menu opens in the body providing options for your search parameters:
2. Find What – Requirements, Documents, Voices, Tests, Attachments, etc.
23
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
3. Subtype – Subtype of the item class. E.g. system
4. In Which Project – Current project or another project.
5. Search Filter – Attribute to filter by:
6. Try selecting Documents in the current project, and use * as the filter to show all documents
within the current project.
Note: you can search by any attribute including User Defined Attributes.
24
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
7. Select a Document from the list to navigate to it:
25
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
8. To exit the Search Tool click the X in the upper right corner of the Search window:
Layout
The Layout feature includes the following options:
A vertical TOC with a vertical body page (default view)
Two vertical TOCs and a body page (particularly useful when having to refer to items in different
parts of the tree, and having to enter data on an item's home page, details page etc.)
A horizontal TOC with horizontal body page (particularly useful when doing Cost and Weight
Metric analysis)
Two horizontal TOCs
Two vertical TOCs (particularly useful during drag and drop of items between different parts of the
tree)
Exercise: Use layout to change the tool’s look and feel
1. Click the Layout icon in the upper right corner of the tool:
A drop down menu with layout options appears:
26
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
The most common layout is the Default view, which includes a TOC and a Body.
2. Select alternative views to see what they look like.
Exercise: Use the Tracking feature
1. Enter the tracking feature by clicking the Tracking icon in the upper right corner of the tool:
2. A window opens with four options. Select Actions:
Currently no Actions have been assigned to your user account, therefore there are no
notifications for Actions.
3. Create an Action Item. Right click on a Document and click the Action Item icon:
27
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
4. Enter an example Action Item and set your name as the responsible individual (Who prompt):
5. The Tracking icon changes to include a message indication:
6. Click Tracking, then click Actions:
Enabling ModTips
Click the ModTips link in the header bar to enable them. This link toggles to orange text when active and
show a calendar:
Click the ModTips link again to disable them.
28
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Enabling HelpTips
Click the HelpTips link in the header bar to enable them. This link toggles to orange text when active.
HelpTips are informative popups that appear when you hover the cursor over items in Cockpit. Try
opening various pages and hover over anything to see explanations and supporting material.
Access Cockpit Help
Click Help to display the Help menu to find information such as your Cockpit version and a direct link to
the Cockpit Wiki Area. The Help menu also has a convenient link to submit support requests.
Logging out of Cockpit
Click Logout to end the current Cockpit session and return the browser to the login screen.
29
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Rich Text Editor
The Rich Text Editor allows for the editing of content that may include bold, italics, or underlined text, as
well as bullets, tables, images and other formatting options. The RTE can be opened from numerous
places within Cockpit.
Click the pencil icon to open the editor: This icon floats on the line nearest your cursor.
Standard Operations on All Items
These operations are accessed by right-clicking on the item:
- Linking and unlinking
- Strikethrough and add comments
- Highlight and add comments
- Tag with icon and add comments
- Add attachments to this item
- Add action item to this item
- Access rights
- Toggle help tips
Copy/Move/Link
Copy
To copy an item in the TOC: Left Mouse Click + Ctrl + Drag to desired location
Move
To move an item in the TOC: Left Mouse Click + Drag to desired location
Link
To link an item in the TOC: Left Mouse Click + Alt + Drag to desired location
Note: (Recommended for Admin use only) Use Document Templates to perform linking and association
tasks.
30
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
File Structure and Project Setup
Object Breakdown
Container Objects
Project - A Project is the level or organization that houses the design objects
Process - A collective overview of tasks and their associated meetings
Meeting Category - Organizes meetings
Team/User Group - Organizes users and their information
Documentation Breakdown - Organizes documents
Directory - Organizes documents in the Documentation Breakdown
Document - Organizes objects within Documentation Breakdown, Directory,
Meeting Category, Product Breakdown, and Category container objects
Section - Organizes objects within documents
Product Breakdown - Organizes objects
Category - Organizes documents and objects under Breakdowns (except the
Documentation Breakdown)
Group - Representation of a system or process (i.e. Bill of Materials)
Data Items
Cockpit data items represent objects that contain data. You can use any letter icon (upper or lower case).
The following items are configured out of box:
- Requirements
- Tests
- Voices
- Risks
- Defects
- Initiatives
- Mitigations
- Summary Inputs lead to Voices
31
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
- User
- Meeting
Artifact Items
Cockpit artifact items represent objects that can be associated with data and container items. The
following items are available:
- Attachments
Action Items
Notes
Document/Section Formats Document and section formats provide structure for objects beneath them.
Details Page of Documents and Sections
The Details page of a document looks as follows:
32
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
The Details page of a section looks as follows:
The Details page of documents and sections contain similar types of information, though not all are
applicable to both:
Details
o Name – The name of the document or section
o Ref. Id – An identifier of your choosing used for reference in other documents or
sections (optional)
o Comments – A comment area (optional)
o View Definition – This drop down menu allows you to choose what View Definition
you want to organize data (View Definitions are explained later in the manual) (optional)
o Format Override (optional):
Allow the selected format to be overridden
Keep the selected format and don’t allow override
o Opening Override (optional):
Show opening as blank
Show opening as title only
Show standard opening with a Linker button
o Closing Override (optional):
Don’t show subsections after this section
o Orientation:
Portrait
Landscape
o Page Size:
Letter
A4
Custom
33
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
o Section Format – Defaults to ‘Inherit from parent section’ meaning any formatting
done on the parent section carries to the current section. There are many out of the box
selections such as:
Adhoc List (most common)
Adhoc Trace (2-way, 3-way, and 4-way)
Dozens of other list, matrix, and test based structures
o Data Source – Where the data is pulled from:
This Section
Prior Section
Another Section
This Document
Another Section (or Group)
And more
o Data Source 2 – The same as Data Source, but used mainly in FMEA Tables and
Adhoc Matrix formats
Status
o Current Version – The current version of the item (X.Y)
X=Project version
Y=Object version on the current Project version
o Workflow State - What workflow state it is in, e.g. Pending Approval, Review,
Rejected, Approved, etc.
o Version State – The state of the object or section
o Last Modified - When the object was last modified
o Author - Who created the object or section
o Assigned To - Who the object is currently assigned to
HelpTips Text
o Enter custom Help Tips
Detailed Description
o Rich text content for the section
Adhoc Lists
An Adhoc list is a Section Format option for an object. It is a simple list of items, and is the most
commonly used data organizer. Out of the box tables are available, and custom tables can be used as
well.
Exercise: Create an Adhoc list using out of the box tables
1. Navigate to the Design Input Requirements Section using the TOC:
34
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
2. Select the Details page from the body menu:
3. Find and click on the Section Format drop down menu, then select Adhoc List from the
available options:
4. The Adhoc List options now appear:
5. The default settings allow you to see Requirements within the Data Source this section.
35
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
6. Since there may not be requirements currently entered we will make a modification to the
Section format to allow for the creation of requirements (Note: Customer Requirement is a
custom type, these can be configured at the site level):
7. Now select Home from the menu and notice the Add item here…:
8. Create a new requirement by clicking into the Add item here… space and typing your
requirement:
36
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
9. Clicking away from the typed in requirement or pressing Enter creates a unique identifier for
the requirement and it is saved to the project:
Additional Adhoc List Reference
The Adhoc List options allow you to configure the Home view display:
Kind – Object type viewed:
Display Style – The data from the chosen object to be viewed:
Filter – Filters items in the list based on certain parameters:
37
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Grouping - Allows you to group data by these options or custom Group By definitions:
Sorting – Sorts the list based on an attribute, e.g. alphabetically.
Title – Type in field for a title of the list.
Formal/Informal – Determines if the list has borders or not. If set to Formal, it has borders. If
set to Informal, it does not have borders.
Reorderable – Makes the items in the list re-orderable inline.
Creatable – Allows you to create new objects inline-style in the list.
o SubType – Choose whether a sub-type is used when creating requirements.
o Show a type-in field – Type in to create new object.
o Show a picker only – Can only select from existing objects.
o Picker & type-in – Select from existing objects and can create new.
o Picker & auto-complete – Select from existing objects via a pick-list and type-in.
o Auto-complete only – Type-in from existing objects.
RowDetails – A way to show additional information about an object within a table.
38
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Simple Configurations
Custom Tables
Create New next to the Item Name option allows you to make custom tables that show any attribute of
a chosen object:
After naming a new Custom Table, the Description auto fills. From the Class dropdown list, choose
what type of object you are viewing data for. Click done to view this window:
Under the Wizard section, enter the number of desired columns next to Number of Columns.
39
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Once you enter a number, the Wizard generates that many columns to begin with:
Number of Columns – Defines how many columns are available to show.
Header Text – The header of the column.
Data Item – List of data values available for the given class:
Editability – Determines if the data is editable inline.
Empty Prompt – Defines what shows in an empty prompt within the table. This overrides the
built in value.
40
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Width – Can be in inches (in), centimeters (cm), pixels (px) and percent (%). E.g. 3in, 20%, and
500px. Remember to size things appropriately for export. If you are printing on paper that has a
width of 8.5in, and your table equals more than that, then there will be formatting issues. In
addition, consistency is important—make sure that a table has only one type of measurement.
Header Alignment – Alignment (Left, Center, or Right) of header.
Cell Alignment – Alignment (Left, Center, or Right) of text within cells.
Calculated Table Width – The total width of the table, which is auto-calculated using the
user-defined widths.
Advanced – Additional Cascading Style Sheets (CSS) formatting options for tables.
Note: After you make all selections and input all the data to create the table, you must hit the Generate
button to save any data.
This popup appears if there are no issues with your table, and from there you may close the table
window.
User Defined Attributes (UDAs)
UDAs are a way to add additional data fields to an object. UDAs can have the following types:
String – Can contain any rich text or string of text.
Real – Can contain any real number, either free range or within a set range. The UDA validates
the contents against the settings.
Integer – Can contain any whole number, either free range or within a set range. The UDA
validates the contents against the settings.
41
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Boolean – True or False.
Date - Date field with a calendar picker, either free range or within a set range.
Brief intro to levels – If the UDA is created on the Site or Organization level, then it must be linked to the
Project manually. If it is created on the Project, then it is automatically linked to the Project
To see what UDAs are on the Project, you can go to Project Setup and find the Custom Values section.
There is a Custom Values section for each page in Project Setup. UDAs appear on the details page of
an object in the Custom Values section.
Exercise: Create a User Defined Attribute
1. Right click on the project title and select Project Setup:
2. Select Configuration from the following page:
42
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
3. Expand User Defined Attributes and click on the command menu after hovering in the
table that shows:
4. On the Create New UDA Dialogue set the Name and Description to be Priority and the
Type to be String. Click Done to complete.
5. Setup the UDA for Priority as shown:
43
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Sort, Filter, and Group By
Sort – Allows you to sort based on a data item.
Filter – Allows you to filter based on one or more data items.
Group By – Allows you to group items based on a data item.
44
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Configure a section format using a custom table, UDA, and filter
1. Create a Section called Filter Critical Requirements under Design Inputs:
2. Create new section “With simple text”
45
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
3. Name the Section “Filter Critical Requirements”:
4. The “Filter Critical Requirements” home page appears:
5. Select Adhoc List from Section Format:
46
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
6. In the Data Source option choose “Another section:
7. Select “SEC_Design_Input_Requirements” from the “Select the reference id of the data
source…” drop down menu:
47
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
8. The screen should now look like:
9. Now select “Home” to see what it looks like:
10. Navigate back to the Details page and Select the “Create New” beside “Item Name” to create a
new Table:
48
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
11. Call the new User Defined Table Definition “Critical Requirements” and select “done”:
12. A new window appears from which you can configure your new Table Definition. Change the
number of columns to 3, the Header Text, and width as shown:
49
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
13. Next choose the “Data Item” for each:
50
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
14. The final result should look like:
15. Make sure to click “Generate” and then close out of the Table Definition window.
16. From the “Filter Critical Requirements” Section change the Table Definition being used in the
Adhoc List:
51
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
17. Navigate to the Home page to see the table in action (Priorities may not be entered at this
time):
52
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
18. Notice once we make the column editable the UDA’s feature is shown (Priority is a drop down
menu, hence the downward triangle):
19. Now you can set the priorities for each Requirement:
53
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
20. Now for the Filtering! You can activate an Active Filter by clicking on the funnel icon at the top
right corner of the table:
21. Start typing the value for the High Priority which is 8:
22. Note: Active filtering does not Export to Word as filtered (the entire list will be exported)
23. In order to create a filter that is always on you must create a “Filter Definition”
54
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
24. Navigate back to the Details page and select Create New next to “Filter…”. Call the filter
“Critical Requirements”:
25. Set up the filter as shown, click Generate and exit the Filter Definition window:
55
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
26. In the Details page of the Filter Critical Requirements section choose the newly created filter
from the “Filter…” dropdown menu:
27. Now navigate back to Home to see the filter in action (note that the Active Filter is not
selected):
56
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Adhoc Trace Tables On the Details page of a document or section, set the format to Adhoc Trace - 2 way. You now see
this:
Column 1 can show a requirement, and column 2 could be many things such as Parents of, Tests of,
Children of, Sections of, etc.
Type of Object
Info Shown
Filter
Sorting
Title
Width of Cell
Reorderable
Creatable
Once made creatable, these options display:
SubType – Specifies the type created of the object. If left blank, it defaults to default type per Site
Setup (Requirements are in project Setup).
AddToSection (Column 1) – Defines where newly created objects live.
o Add to data source – Adds object to the Data Source that is set on the section. E.g., if
Data Source is set to ‘this section’ then the objects are added to this section.
o Add to data source and other Section(s) – Same as above, except you have the ability to
select additional/multiple locations outside of the data source for allocation of objects.
AddToSection (Column 2) – All succeeding columns have:
o Add to this section
o Add to this section and other section(s)
o If virtual, add to actual section
o Add to other section(s) only
o Don’t add to any section
57
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Type of Creatable – The method used for the creation of object (Type-in field, Auto-
Complete, Picker, etc.).
Only allow one object creation – Only allows one object to be created or selected.
Show Table With Floating Headers – Locks the header with the top of the page allowing
you to see the headers at all times.
Data Source – Where the data shown is coming from (this section, another section, etc.).
View Definitions
Cockpit has built-in menus:
Cockpit provides the ability to create configured views through View Definitions. View Definitions can be
used to control what menus appear at the top of Cockpit body pages, and control the name of the menus.
A view can be defined for any menu item (Home, Dashboard, Details, etc.). These are useful when you
want to narrow in on one particular item.
58
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Create a View Definition:
1. Create a new folder under the Documentation Breakdown named View Definitions:
2. Go to the Details page of the new View Definitions folder. Set the Ref. ID for the folder to be
View Definitions:
Note: If the Ref ID is not set for View Definitions, then the View Definitions section does not
show up in the TOC
3. Create a document with the name you want the View Definition to have. Add a substructure
similar to the following (it is important to have the first section called Home, each sub-section
under that can have any name you choose):
59
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
4. To use the view definition you need to go to the Details page of the document or section
where you would like the view set:
Select the drop list next to the View Definition option, select the view to use.
5. Go back to the Home page for the document (or section) and you can see the new sub-menus:
6. Select Adhoc List:
Notice it says ***Unsupported section format – using Standard format***.
This is because the definition of how to see/define the data was never entered.
60
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
7. To define the view return to the View Definition:
8. Select the Adhoc List:
9. Select the details page:
10. The details page shows:
61
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
11. In the details option, change the “Section Format” to an Adhoc List:
12. Return to the Adhoc List Home in the view definitions directory.
13. Notice nothing is shown in the body page of the Adhoc list. This is because there is no data in
the section of the Adhoc List. The directory “View Definitions” should never have data linked in.
View definitions should only define how information is displayed. Let’s go to where we have
data that would like to view in a certain manner:
62
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
14. Notice now the list of requirements is displayed
Anything that can be displayed in the Section Format can be displayed in the View Definitions.
Row Details Row details allow you to see any defined data of a selected item. An Adhoc list without row details is
shown below:
Add Row Details to a Table:
In the Details view of the table, select Allow Row Details:
Notice that in the Home view a blue triangle has appeared in the right-most column of each row:
63
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
When clicked, the row expands to show more information on the item. In this case the dashboard is
shown:
There are two default options: Modifications and Dashboard. Additional options can be configured.
Exercise: Add the name of the requirement into Row Details
1. Under Allow Row Details type in sDescription:
2. Return to the section where the row detail is implemented.
3. Click the blue arrow and select sDescription:
The Row Detail shows the description of the item. In this case R1.
4. Under the Allow Row Details type
sDescription|sActiveTarget|sDetailedDescription. Using the “|” allows you to
enter one or more options (Snippets) to be used in the row details:
64
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
5. Return to the section where the row detail is implemented.
6. Click the blue triangle – notice the drop down now contains several options:
65
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Setup Levels
Site Level Setup (Corporation Level)
Site Setup is where all project and domain setting are made. Access is restricted to site administrators
and configuration users (configuration users have limited access). This is the highest level in Cockpit and
can feed down to all organizations and projects of your choosing.
Organization Level Setup
The Organization Level, between the Site Setup and the Project Setup, allows you to construct a
hierarchy of projects, attachments, customizations, organizations, and product lines to help sync and
share resources amongst projects.
66
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
From this view, you can add organizations to delineate different company locations or departments
designing unrelated products.
Separating the corporation into organizations enables the lower level groups finer granularity when
tailoring configurations or overriding corporation configurations so that other groups do not get affected by
unneeded changes.
Notice that both Corporation (aka Site Level) and “TimeMachine Inc. (Subsidiary)” have Configuration
as an option in the body menu:
67
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Project Level Setup
This setup level pertains to this project alone. Right click the project and select Project Setup from the
menu:
This is very similar to Site Setup in that you can set Auto Numbering (and all other Object preferences),
but cannot change types of objects.
Administrator Tasks
Creating and Managing Users/User Groups
The easiest way to organize users within Cockpit. Users and user groups are created at the site level and
permissions and users are added to projects as necessary. Cockpit supports LDAP login and is moving
towards internal Part 11 compliance.
68
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Create users
1. Enter Site Setup.
2. Right click on the Users and Groups folder:
Select Create a new user.
3. In the New User dialog, enter the user’s first name, last name, username, and password twice.
Click Done when complete.
4. A new user appears in the TOC under Users and Groups. Users can also be created under
User Groups using the same method:
69
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Create user groups
1. Right click on the Users and Groups folder:
2. Select Create a new user group.
3. Enter a Name and Description for the group. Click Done. The user group appears in the TOC:
70
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Disable users
1. Right click on a user:
2. Select Disable Login…
3. Disabled users say disabled in red next to their name in the TOC.
Note: Users cannot be completely removed from a site and must be disabled instead. However, users
can be removed from User Groups and default back to the Main Users and Groups directory.
Exercise: Add a user and user group to a project
1. Select Team within the TOC:
71
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
2. Select the command menu for the Team Members section:
3. Select Add existing and Search using the * symbol (default):
4. From the search find the desired name and click the checkbox next to it:
Click the red X to close the search dialogue.
5. This adds you to the team:
6. Adding Groups functions similarly to adding Team Members.
Note: Typically a Project Lead or Admin has access to add individuals to a team, configurable via
Privileges within a Project.
72
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Privileges
To create new projects, you must have the system privilege for creating new projects. Refer to the
section System Privileges for more information.
All other privileges for accessing and modifying projects and project items are assigned on a project-by-
project basis. While some privileges here, such as Modify, View, and Delete, are going to appear in all
applications, others may be application specific. In addition, some privileges may control the access of
specific data attributes on an item.
The project and item privileges available are:
View - Determines who may view the project or project item. Users that are members of the
project team get this privilege by default.
Modify - Determines who may modify the project or project item. By giving a user this privilege,
you automatically give them the following privileges: Define Structure, Manage Documents,
Manage Voices, Manage Requirements, Manage Risks, and Manage Tests (denoted by gray
checkmarks).
Delete - Determines who may delete project items.
Project Admin - Determines who has general administrative access to the project, including
assigning and removing project privileges. This privilege comes with all of the other project and
item privileges, marked with gray checkmarks when Project Admin is selected.
Define Structure - Determines who may create or modify structure (document breakdown,
product breakdown, BOM Structure, etc.) in the project.
Manage Documents - Determines who may create or modify document data in the project.
Manage Voices - Determines who may create or modify voice of customer data in the project.
Manage Requirements - Determines who may create or modify requirement data in the
project.
Manage Risks - Determines who may create or modify risk, cause, and mitigation data in the
project.
Manage Tests - Determines who may create or modify test data in the project.
The creator of a project or item has all item privileges. Additional privilege defaults can be established at
the project Access Rights home page. Other item privileges can be assigned to items and to sub-items
explicitly. This privilege model provides for both simple and complex privilege assignment schemes.
To assign item privileges, you must have Administrator system privileges or Item Admin privileges:
Exercise: Assign project privileges
1. Right click on a project or item in the TOC. Select the Access Rights ( ) icon from the
command menu:
73
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
2. You should see a privilege/access page similar to the one below:
3. Check the boxes to grant or restrict the corresponding privileges for each user listed.
Limiting View Access at the Item Level
Cockpit is designed to allow view access to the entire project for all members of a project team. However,
this is sometimes undesirable when new members are added to project team, or when a project is being
shared with someone outside of the actual project team. Follow the steps below in order to restrict view
access by item inside of a project.
1. Copy the project that you want to restrict view access by item.
2. Go to the original project and delete all items that you want to restrict view access on, making
note of the names before you delete them.
3. Next, use the search feature to find all of the versions of those items in the copied project and link
them to the current/original project by Alt-dragging and dropping them into the correct locations.
4. Now you can control who can view the linked in items by adding or removing members from the
project team on the copy.
Templates
Project, document, change request, and process templates are all stored in this folder. Templates can
either be imported or created from inside a project.
74
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Life Cycle and Workflow Management Every project has a workflow. It can be unique or shared amongst many projects. A workflow process
consists of a sequence of states. The workflow is used to model the steps through which an item, such as
a project, requirement, test, or document, must flow. The workflow provides guidance as to what can
and/or should be done next, conditions that must be met to complete a particular step, limitations as to
who may perform certain tasks, etc.
A workflow exists within the larger context of a project’s life cycle. As the project advances it goes through
various stages, e.g., from concept to design to production. The stage that a project is in influences the
workflow particulars, for example, in early stages there may be no need to sign off on changes.
The states of a workflow and the stages of a life cycle are similar. A project life cycle tends to be a linear
sequence of steps. Contrast that with a workflow that typically has decision points that lead to different
branches, steps that may need to be repeated causing cycles, and so on. The standard Cockpit
installation comes with the Legacy Life Cycle, a package designed to emulate how life cycles and
workflows operated in previous versions of Cockpit. Before creating your own life cycles and workflows,
familiarize yourself with the Legacy Life Cycle.
75
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Workflows are created in the Site Setup area of Cockpit in the folder called Workflow. The two top-level
items within the Workflow area are Life Cycles and Roles.
Life Cycles
The life cycles in Site Setup apply to top-level domain items, such as projects, action items, and
attachments. The tree displays the name of the life cycle followed by the class (type of high-level item) to
which it applies, such as project or attachment.
To create a new life cycle, right click on the Life Cycles folder and choose the Create a new life
cycle command. Fill in a name and choose the class of objects to which it applies. Alternatively, you can
import a previously exported life cycle.
Beneath each of these top-level processes in the tree are two types of items: stages for the top- level
domain items, and workflows that apply to sub-items of the domain item.
76
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Roles
A role defines a responsibility or function performed in a particular life cycle stage or workflow state. A
person, several persons, and/or a group of persons may be associated with a particular role. A role is
often conceptual, for example, the Approver role may have a different person associated with it for
different parts of a document or different stages of a project. There are two built-in roles:
Author – The person who created the object
Current Owner – The person to whom the object is currently assigned
When an object is created both of these roles are automatically assigned.
In order to make use of roles in a Cockpit project there are three steps that need to be completed:
1. Create the role in Site Setup.
2. Associate the role with the life cycle process where the role will be utilized.
3. Create one or more workflow commands to assign roles to the project or any item in the project.
Creating a Role
Choose Create a new role from the command menu on the Roles folder in Site Setup. Enter a name
and click done.
Role Settings
In addition to the role’s name, you can specify an ID. You also choose to enable or disable three
characteristics of the role:
Allow Multiple – Allows two or more people to share this role when checked. If unchecked, only
one person can occupy this role at any given time.
Allow Groups – Allows groups to be assigned to the role.
Team Members Only – Specifies whether role membership is to be restricted to team members.
Assigning a Role
Before a role can be available to a life cycle, you must associate the role with the life cycle. A role can be
associated with life cycles and/or workflows from that object’s traceability page. Any role that you have
defined in the system can be associated with any number of these processes. To assign a role to a
specific life cycle or workflow, go to that item’s Traceability page. In the Roles section, click the menu box
to display the command menu and choose the command Add Existing.
77
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Assigning a Role Using a Life Cycle Command
When assigning roles you can assign both users and groups. Based on the role options above, it is
determined whether one or more than one user/group can be assigned to a specific role. You must create
a command on the project or item you want it to be accessible for. You then need to add an action to the
command with the following options:
1. Action type - Assign
2. Role to Set - <Pick the role you want to assign>
3. Value to assign - <Choose variable if you want to pick from a list, or pick a role if you want to
copy the settings from another role>
4. Variable - <If you choose a variable option in the previous step, choose the name of the
variable prompt>
When creating a variable prompt for the roles, applicable options include:
All Users - Show all users with access to the project
All Groups - Show all groups with access to the project
All Users/Groups - Show all users and groups with access to the project
Team Members Only - Only show users from the project team
Team Members/Groups - Show all users and groups from the project team
When running the workflow assignment command, you are now be able to check both users and groups
based on the options you picked.
The Legacy workflow uses a command to assign approvers and project approvers so it is a good example
of how to assign roles.
78
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Building a Simple Custom Workflow
Right click on a newly created life cycle and select New Process in the command window to create a
new workflow. Name the workflow in the following prompt.
The life cycle needs at least one stage, if you have not yet created one, do so now by selecting New
Stage in the command window on the life cycle. In the life cycle's home page, set the default stage to the
stage you created.
In the Home view of the workflow, create three new states under the States section by typing in their
names where it says Add item here... Name them Edit, In Review, and Approval.
Commands and Actions
Commands
For each state, specific commands need to be created. A command defines a sequence of actions that
can be performed. The user sees the command to be able to execute those actions.
Create commands in the Home view of the state under Commands.
79
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
To create a new command, click the respective state for which you want it, and type in its name in the
Commands section before hitting enter.
Actions
Each command needs to have actions. Actions are the tasks to perform that implement the command.
To create an action, click on the command that you want the action to perform in, and then navigate to
the Actions section in that command's Home view.
Select an Action Type for each action dependent on what you want it to do.
The following sections list the commands, actions, and any other specific details for each state.
Edit
The Edit state should have the following commands:
The command Make View Only should have the action Snapshot Document. This action should
have Action Type set to Version and the Version Action set to Checkpoint.
80
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
The command Edit Document should have the action Edit. This action should have Action Type
set to Version and the Version Action set to New Version.
The command Submit for Review should have the action Move to In Review. This action should
have Action Type set to Change Workflow State and the New State set to In Review.
In Review
The In Review state should have the following commands:
The command Submit for Approval should have the action Move to Approval. This action
should have Action Type set to Change Workflow State and the New State set to Approval.
The command Return to Edit should have the two actions. The action New Version should have
Action Type set to Version and the Version Action set to New Version. The action Move to
Edit should have Action Type set to Change Workflow State and the New State set to Edit.
81
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Approval
The Approval state should have the following command:
The command Approval should have two actions. The action Approve Document. This action should
have Action Type set to Version and the Version Action set to New Version. The action Move
to Edit should have Action Type set to Change Workflow State and the New State set to
Edit.
Roles
Roles need to be added to the workflow so that they can be associated with commands that you created.
To add roles, go to the Traceability view of the workflow and click on the box that appears when you
scroll your cursor onto the Roles section.
Select Add existing in the command window. In the search box that appears on the right, type in the
role that you want to add to the workflow, then check the box next to that role after clicking Go.
82
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Close the search box and the role is added under the Roles section.
Remember: For a role to be added to a workflow it must exist under the Roles folder under the
Workflow folder.
Create new roles in the Home view of the Roles folder. Click the box that appears when you hover your
cursor over the Roles section. In the command window select Create New.
Availability
All actions in the In Review command and the Approval Command should only be available to the
approver. To make this possible, go to the Availability section of each action and create an item
called Approver Access with the Type set to Role Based and the Allow Access To set to the
previously specified role of Approver.
83
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Activate versioning and explore workflow at Site Setup
1. Note: The sample project is currently in the Draft state
2. Browse to Home in the Current Project’s page:
3. At the Site Setup Browse to Life Cycles/Legacy/Draft:
84
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
4. Bring up the command window on the project and select Workflow:
5. Click on Activate Versioning:
6. Give the version a name:
85
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
7. Select Finish:
8. Let the tool run:
9. Notice the workflow state has changed to In Process:
86
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
10. Select the command window from the project again, but notice the commands are now
different
11. The commands from the previous step can be accessed in the “In Process” workflow stage as
shown below:
87
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: Build a three stage workflow on a requirement
1. Select the workflow on a requirement:
2. To change the current workflow, open the Main Menu and select Site Setup:
88
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
3. Navigate to the Legacy workflow for modification:
4. Right click for the command window and select New Process:
5. Give the process a name:
89
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
6. Select Requirement under the Applicable for section:
7. Under States type In Edit, Review, Approve :
90
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
8. Choose In Edit as the Default State:
9. Navigate to the Commands section of the In Edit state and add Move to Review:
91
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
10. Select the new command Move to Review:
92
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
11. Navigate to the Actions section and enter Transition to Next State:
12. In the drop down for Action Type select Change Workflow State:
93
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
13. Select Review for the New State:
14. Type in Make un-editable for Review, select the Action type to be Version:
15. Choose the Version Action to be Checkpoint:
94
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
16. Return to the Review state and create a new command Return to Edit:
17. Create two actions on the Return to Edit command of Transition state back to
In Edit and Make Editable:
18. Select a New State of Approve:
95
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
19. Select the Verison Action to be New Version:
20. Create a new command of Approved:
21. Create an action of Move to Approved in the Actions section of the new command:
22. Change the New State to Approve:
96
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
23. Navigate to the Approved state.
24. Create a command Return to In Work:
25. Create two actions on the new command, Transition State and Make Editable:
26. Exit Site Setup—the requirements in the project now have a new workflow.
27. Using the built-in table definition of workflow, click on the commands to active the workflow.
97
© 2
01
5 | C
og
nitio
n C
orp
ora
tion
Exercise: View the workflow in a section
1. Create a new section.
2. In the section’s details view, set the Section Format to Adhoc List.
3. Set the Kind to Requirements.
4. Set the Display Style to Workflow.
5. The Home view now shows the states that the requirements are in, and the available commands for each requirement.
