Vous êtes sur la page 1sur 39

02 TB-16 I 01/12/2016 [0] 1 of 39

AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Integrated Formal Model-Based


Framework (IFF) User Manual

COORDINATION SHEET
02 TB-16 I 01/12/2016 [0] 2 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Integrated Formal Model-Based


Framework (IFF) User Manual

Part No. : AFCCAT12FYP - (04)


Publication No.: 12324, Rev. [0]
Vol. 02, TB-16, Issue I

Confidential Publication

The information provided herein is proprietary to CSIR:NAL and shall not be


reproduced or disclosed in whole or in part or used for any design or manufacture
except when such user possesses direct written Authorization from CSIR:NAL

NATIONAL AEROSPACE LABORATORIES


CSIR-NAL
BANGALORE-560 017 INDIA
02 TB-16 I 01/12/2016 [0] 3 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

RECORD OF REVISIONS

REV. NO. PAGE NO. DESCRIPTION AMENDED BY DATE

[0] NA Initial Release Mr. Vishwachetan D 01/12/2016


02 TB-16 I 01/12/2016 [0] 4 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Integrated Formal Model-Based


Framework (IFF) User Manual

Part No. : AFCCAT12FYP-(04)


Publication No. : 12324, Rev. [0]
Vol. 02, TB-16, Issue I

APPROVALS
02 TB-16 I 01/12/2016 [0] 5 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

TABLE OF CONTENTS
1. INTRODUCTION .......................................................................................................... 7
1.1 PURPOSE …………………………………………………………………………………7
1.2 SCOPE …………………………………………………………………………………7
1.3 ACRONYMS AND ABBREVIATION ..................................................................................... 7
1.4 REFERENCE DOCUMENTS ................................................................................................ 8
1.4.1 Internal Documents .................................................................................................. 8
1.4.2 External Documents ................................................................................................. 8
2. ACCESSING IFF ........................................................................................................... 9
3. SETUP IFF – AN OVERVIEW ..................................................................................... 9
3.1 DIFFERENT PHASES IN IFF .............................................................................................. 9
3.2 METHODOLOGIES IN IFF ................................................................................................. 9
3.3 SCM SETUP .................................................................................................................... 9
3.4 ADD TOOLS .................................................................................................................. 10
3.5 ADDING USER TO IFF .................................................................................................... 11
4. PROJECT SETUP ........................................................................................................ 12
4.1 PROJECT OVERVIEW ...................................................................................................... 12
5. ADDING/DELETING USERS ..................................................................................... 17
5.1 ADDING NEW USER ....................................................................................................... 17
5.2 DELETE AN EXISTING USER............................................................................................ 18
6. ADD SCM TO IFF........................................................................................................ 18
7. PROJECT ORGANIZATION ..................................................................................... 20
7.1 MULTIPLE WORKFLOWS ................................................................................................ 22
8. ADDING TOOLS INTO IFF ....................................................................................... 22
9. ADDING FRAMEWORK ............................................................................................ 23
10.CREATING A PROJECT ........................................................................................... 23
10.1 CREATING WORKFLOWS AND ASSIGNING PHASES ........................................................... 25
10.2 ADDING TOOLS TO THE PROJECT .................................................................................... 26
10.3 PHASE COMPLETION CRITERIA ....................................................................................... 28
10.4 WORKFLOW COMPLETION CRITERIA .............................................................................. 29
10.5 PROJECT COMPLETION CRITERIA .................................................................................... 30
11.FOLDER STRUCTURE OF IFF PROJECT.............................................................. 31
12.REPORTS .................................................................................................................... 32
12.1 TRACEABILITY REPORT................................................................................................. 33
12.2 PROJECT ANALYSIS REPORT ........................................................................................... 33
12.3 CUSTOM ANALYSIS REPORTS ........................................................................................ 37
13.NOTES AND EMAIL .................................................................................................. 38
13.1 NOTES ………………………………………………………………………………..38
13.2 SENDING AN EMAIL ....................................................................................................... 38
02 TB-16 I 01/12/2016 [0] 6 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

LIST OF FIGURES
Figure 1 SVN setup ............................................................................................................. 10
Figure 2 Adding tool to IFF................................................................................................. 11
Figure 3 Tool added to IFF. ................................................................................................. 11
Figure 4 Users in IFF .......................................................................................................... 12
Figure 5 Project Structure – An Example ............................................................................ 12
Figure 6 Project Configuration ............................................................................................ 13
Figure 7 Workflows in a Project .......................................................................................... 14
Figure 8 Workflow Completion Criteria .............................................................................. 14
Figure 9 Adding Tool to a Phase ......................................................................................... 15
Figure 10 Phase Completion Criteria ................................................................................... 16
Figure 11 Project Completion Criteria ................................................................................. 17
Figure 12 Adding New User to IFF ..................................................................................... 18
Figure 13 User appear in User management list after adding into IFF .................................. 18
Figure 14 Adding New SCM ............................................................................................... 19
Figure 15 Adding more SCM Commands............................................................................ 19
Figure 16 Selecting a SCM for All projects ......................................................................... 20
Figure 17 Root path of SCM ............................................................................................... 20
Figure 18 Entry and Exit Criteria Relationship .................................................................... 21
Figure 19 Tool Details......................................................................................................... 23
Figure 20 SCM Root path.................................................................................................... 24
Figure 21 Fields to be filled while adding a tool .................................................................. 25
Figure 22 Creating Workflow.............................................................................................. 26
Figure 23 Adding Tools to a Phase ...................................................................................... 27
Figure 24 Selected Tools ..................................................................................................... 27
Figure 25 Tool Stages based on Order ................................................................................. 28
Figure 26 Phase completion Criteria .................................................................................... 29
Figure 27 Workflow Completion Criteria ............................................................................ 30
Figure 28 Project Completion Criteria ................................................................................. 30
Figure 29 Multiple workflows in a Project........................................................................... 31
Figure 30 Folder Structure of a Project ................................................................................ 32
Figure 31 Traceability Report.............................................................................................. 33
Figure 32 Analysis Report for Project Methodology ............................................................ 34
Figure 33 Analysis Report for Project Techniques ............................................................... 35
Figure 34 Analysis Report for Project Phases ...................................................................... 36
Figure 35 Analysis Report for Project Users ........................................................................ 37
Figure 36 User notes using keyword search ......................................................................... 38
Figure 37 View the selected note ......................................................................................... 38
Figure 38 Email draft in IFF ................................................................................................ 39
Figure 39 Email popup blocked ........................................................................................... 39
Figure 40 Outlook ............................................................................................................... 39

LIST OF TABLES
Table 1 Acronyms and Abbreviations.................................................................................... 7
Table 2 Internal Referred Document ..................................................................................... 8
Table 3 Tool Name and Tool Priority Order ........................................................................ 28
02 TB-16 I 01/12/2016 [0] 7 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

1. Introduction

IFF is a web based Formal methods Framework. It is used to manage complete


Project life cycle. The tool involves. The Framework allows effective lifecycle management
which are very complex. The framework allows Integration of different Formal methods tools
and Frameworks. IFF greatly simplifies the process. It systematically allows users to work in
collaboration. Effectively use different Formal tools, manage reports and artifacts generated.

Tools/Frameworks

Requirement Architecture Design Coding Testing

1.1 Purpose
The objective of this document is to provide the procedure to operate the framework.
This document describes the user the steps involved in operating the Integrated Formal
Model-Based Framework (IFF) with proper screen shots of the framework at suitable stages.

1.2 Scope
The scope of this document is to recommend the user with the standard process for
using the Integrated Formal Model-Based Framework (IFF). Before using the framework, the
user should go through the user manual.

1.3 Acronyms and Abbreviation

ACRONYMS/ABBREVIATIONS EXPANSION

IFF Integrated Formal Model-Based Framework


SCM Software Configuration Management
SDLC Software Development Life-Cycle
SVN Software Version Number
Table 1 Acronyms and Abbreviations
02 TB-16 I 01/12/2016 [0] 8 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

1.4 Reference Documents


1.4.1 Internal Documents
DOCUMENT
DOCUMENT REFERENCE DOCUMENT NAME
NUMBER
PartNo.:AFCCAT12FYP-(04) Requirements Specifications of
Publication No.:12324, Rev. [0], Vol. 02, DR-03 Integrated Formal Model-Based
DR-03, Issue I Framework (IFF)
PartNo.:AFCCAT12FYP-(04) Requirements Specifications of
Publication No.:12324, Rev. [1]Vol. 02, DR-03 Integrated Formal Model-Based
DR-03, Issue I Framework (IFF)
PartNo.:AFCCAT12FYP-(04) High-Level Design for the
Publication No.:12324, Rev. [0], Vol. 02, DR-09 Design of Integrated Formal
DR-09, Issue I Model-Based Framework (IFF)
PartNo.:AFCCAT12FYP-(04) High-Level Design for the
Publication No.:12324, Rev. [1], Vol. 02, DR-09 Design of Integrated Formal
DR-09, Issue I Model-Based Framework (IFF)
PartNo.:AFCCAT12FYP-(04) Design Analysis Report for
Publication No.:12324, Rev. [0], Vol. 02, TB-11 Design of Integrated Formal
TB-11, Issue I Model-Based Framework (IFF)

Table 2 Internal Referred Document

1.4.2 External Documents


-NA-
02 TB-16 I 01/12/2016 [0] 9 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

2. Accessing IFF
To access IFF, user needs a login ID and password. Open the link https://IFF.com .
Enter the user name and password to login into IFF framework. All the users are classified as
User, Project leader and Admin. Accessibility is based on roles of the user.

3. Setup IFF – An overview


IFF needs to be setup before you accomplish project. Entire IFF setup can be divided
into following tasks

a. Software configuration management (SCM) setup.


b. Tools/Frameworks setup.

3.1 Different Phases in IFF


Complete IFF project is divided into five stages namely,

a. Requirement
b. Architecture
c. Design
d. Coding
e. Testing

Following phases are considered to follow Standard V-Model.

3.2 Methodologies in IFF


IFF Projects uses one or more methodologies to complete a Phase. The methodologies
directly depend on the tools that are used in a particular phase. Different Methodologies
considered are as follows,

a. Formal
b. Informal
c. Model Based
d. Valid combination of above three

3.3 SCM setup


SCM is the first to be setup in the IFF. SCM once setup will be available across all the
projects. Multiple SCM cannot be active simultaneously. Following are the steps to configure
SCM:

a. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
02 TB-16 I 01/12/2016 [0] 10 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

b. Click on “ADD SCM Tool” push button in “Configuration” tab.


c. Select SCM exe path using the browse button e.g.:
“C:\Program~Files\TortoiseSVN\bin\svn.exe”.
d. Fill in all the relevant fields.
e. Provide the “Equivalent SCM Command” commands. Default implementation is Tortoise
SVN configuration management tool.
f. If user needs more commands out of SVN, click on “Link for more commands” to add
more commands. These commands must be added carefully and user shall know the
usage of these commands fully.
g. Click on “Add SCM Tool” to add the configuration to the IFF.
Added tool appears in the available SCM Tool list as show in Figure 1.

Figure 1 SVN setup

3.4 Add Tools


To add tools, the tool must be available as executable. Following is the procedure to
add the tool.

a. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
b. Click on “Add New Tool” push button in “Configuration” tab.
c. Select Browse to get executable path of the tool e.g.: “C:\Program Files\Osate
2.1.2\osate.exe”.
d. Fill in all the relevant fields.
e. Select the Phases(R, A, D, C, T) in which the tool could be used.
f. Assign the methodology.
g. Select the tool completion criteria and fill up the tool Input, Output requirements.
h. Click on Add tools to IFF
02 TB-16 I 01/12/2016 [0] 11 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Added tool Appears in the “Available Tools” list as shown in Figure 2.

Figure 2 Adding tool to IFF

Figure 3 Tool added to IFF.

3.5 Adding user to IFF


Perform the following to add new user.
1. Go to “User Management” page.
2. Click on “Add new User”.
3. Specify Mandatory fields.
4. Assign role to the user as Admin, User Project lead etc.
5. Optionally assign projects to the user and click on “Add New User”.
User name will appear the “User management” table.
02 TB-16 I 01/12/2016 [0] 12 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 4 Users in IFF

4. Project Setup
4.1 Project overview
Every project of IFF is organized as Project->Workflows->Phases-> Tools. Every
project has multiple work flows and every workflow can be multiple phased. It is depicted in
Figure 5.

Figure 5 Project Structure – An Example


A project can be created using single or multiple workflows based on, the number of
parallel phases that users will work on, if a particular workflow fails and a new workflow is
needed. Artifacts/Reports are generated at all levels (Project, Workflow, Phase and Tool) if
needed by the project.

Steps to be followed while creating project

a. Make sure the repository path where the project will be created is specified in select SCM
tool page (“SCM repository path in Server”).
b. Go to https://localhost:8080/Iff/secure/welcomeUserPage.xhtml
c. Click on “Create Project” push button in “Configuration” tab.
02 TB-16 I 01/12/2016 [0] 13 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

d. Makes sure SCM application path and root path is available.


e. Fill in all the details.
f. Specify the Project completion criteria(optional)
g. Click on “Create Project” to create the project.
Created project will appear in the “Available Projects” after refresh.

Figure 6 Project Configuration

4.2 Creating workflows

To create a workflow,

a. Click on the “Create Workflow” button from Configuration tab.


b. Select a project from the “Select project” drop down menu.
c. Click on create pushbutton , after dialog opens, specify the workflow name and
associated Phases
d. Click create pushbutton to create the workflow.
02 TB-16 I 01/12/2016 [0] 14 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 7 Workflows in a Project

4.3 Adding Workflow completion criteria to a project


Additional workflow completion criteria can be added to a particular workflow by
selected a workflow and using the “Workflow completion criteria” option from “Create
Workflow” page.

Figure 8 Workflow Completion Criteria


02 TB-16 I 01/12/2016 [0] 15 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

4.4 Assigning tools to phases

Following is the procedure to assign a tool to phase,

a. Select particular workflow, as shown in Figure 7.


b. Select a phase from “Available Phases”.
c. Select tools that are available in the “Available Tools” and select “Add tool” push button.
d. Assign order to the tool (Refer 10.2 for more details).

Figure 9 Adding Tool to a Phase

4.5 Adding Phase completion criteria in a workflow

One can add additional phase completion criteria using the “phase completion
criteria” option from “Create Workflow” page.
02 TB-16 I 01/12/2016 [0] 16 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 10 Phase Completion Criteria

4.6 Complete Setup of a Project

Following are the steps to be followed to setup complete project,

1. Perform step 3.2


2. Provide additional Project completion criteria - Refer Figure 11
3. Perform step 3.3
4. Perform step 3.4
5. Perform step 3.5
6. Perform step 3.6
7. Go to organize project team page, select the Project
8. Add user to the Project using “Add user to Project”
9. Assign particular workflow and phase to user using “Assign Workflow/Phases” option -
Refer Figure
10. To make a workflow active and allow user to work on that particular workflow, Freeze
the workflow From “Create workflow” page using freeze option.
Once we complete the project setup, users can access the project and work on the
assigned tasks.
02 TB-16 I 01/12/2016 [0] 17 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 11 Project Completion Criteria

5. Adding/Deleting Users
IFF being a web application, access is grated only after user registration.
Unlike other applications a user can be added only by admin of IFF.

5.1 Adding new user


New user can be added or existing users can be deleted only By Admin of IFF. While
creating users Admin will specify,

1. User name
2. Email ID of the format user@domain.com
3. User ID is default set as UserName1, if User name is Username.
4. Default password will be generated – To be changed by user after first login.

Email ID should be unique for a user. E.g. two users can have same name as User One
and User One but Email ID cannot be UserOne@nal.com and UserOne@nal.com. Following
steps illustrate creation of new user:

1. Go to user management page – shown in Figure 12


2. Click on Add new user – show in Figure 12
3. Fill all relevant fields – shown in Figure 12
4. It is optional to assign user to any project.
5. Click on “Add new user” – shown in Figure 12
02 TB-16 I 01/12/2016 [0] 18 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

User will appear in the list after creation. This is shown in figure 4.2.

Figure 12 Adding New User to IFF

Figure 13 User appear in User management list after adding into IFF

5.2 Delete an existing user


Existing users can only be deleted if he is not assigned to any active project. All
project assigned to the users should be in closed state or Users should not be associated with
any project.
Following steps illustrate how users can be deleted from Project;

1. Go to user management page – shown in Figure 13


2. Click on Delete user – show in Figure 13
3. Click on delete user on the conformation dialog.

6. Add SCM to IFF


SCM plays very important role in IFF. To add any new project this is the first step to
be followed. Users, tools and frameworks can be added at any later stage and assigned to the
project. Project cannot be created without configuring the SCM tool.
Various SCMs are built-in and provision is provided of adding new SCM commands
are given. Check with you vendor about the SCM configurations available. It is a Plugin and
may vary depending on the version of IFF you are using. Common SCM available with IFF
02 TB-16 I 01/12/2016 [0] 19 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

are, Tortoise SVN and ClearCase. Following is the procured to configure the TortoiseSVN
tool and new SCM commands.

1. Click on Add SCM in the welcome page of IFF.


2. Select the executable path of the SCM to be added
e.g.: C:\Program Files\TortoiseSVN\bin\svn.exe
3. Specify name of the SCM tool – example SVN.
4. Specify Short name of SCM, It is an abbreviation of the tool name.
5. Specify Short description of the tool
6. Specify SCM version
7. Specify the manufacturer of the tool.
8. SVN commands for certain commands to be specified by the user.
9. If user wants to add mode commands ,
a. Click on more commands options as shown in Figure 15
b. ADD more commands in Pairs as shown in Figure 15
10. Click on Add SCM tool to complete the procedure.

Figure 14 Adding New SCM

Figure 15 Adding more SCM Commands


02 TB-16 I 01/12/2016 [0] 20 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

6.1. Project’s default SCM tool


All projects in IFF make use of a default repository where projects are created. Before
creating a project. IFF Admin shall specify the default path (Top layer) under which all the
projects are created. Following steps illustrates the procedure to set the repository;

1. Click on “select SCM Tool” button from the welcome page of IFF.
2. Select available SCM from the list as shown in Figure 16

Figure 16 Selecting a SCM for All projects

3. Specify SCM repository root path in “SCM repository path in Server” field as show in
Figure 17

Figure 17 Root path of SCM

4. Save and exit.

7. Project Organization
Project in IFF follows a typical V-Model as shown in figure 6.1. IFF Project consists
of a workflow and workflow is divided into different Phases. Phases in IFF are “R”, “A”,
“D”, “C”, “T”.
02 TB-16 I 01/12/2016 [0] 21 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 18 Entry and Exit Criteria Relationship

Every phase has input and output criteria, Documents/codes/others needed to start a
phase is considered as “Input criteria” of a Phase. Outcomes of a phase i.e.
Artifacts/documents/Codes/Qualification reports are considered as “Output criteria”. Project
leader shall specify Input and Output criteria. R, A, D, C, T are as follows;

1. Requirement (R): R-Phase is the first phase in a project. Typically it is the Requirement
stage of a V-Model. All necessary documents/codes/others are specified in this phase
using entry criteria. Output of this Phase after accomplishing certain tasks is considered
as output criteria.
2. Architecture (A): A-Phase is Architectural phase of a V-Model as shown in figure 6.1.
Input criteria of this phase could be output criteria of R-Phase or input from the workflow
3. Design (D): D-Phase is Design phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of A-Phase or input from the workflow.
4. Coding (C): C-Phase is Coding phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of D-Phase or input from the workflow
5. Testing (T): T-Phase is Testing phase of a V-Model as shown in figure 6.1. Input criteria
of this phase could be output criteria of C-Phase or input from the workflow
02 TB-16 I 01/12/2016 [0] 22 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

7.1 Multiple workflows


A project may have multiple workflows and each workflow can have multiple phases
in it. Multiple workflows allows user to following operations;

1. Execute multiple phases in parallel.


2. Use different approach in project execution and hence different workflows. A project can
be closed using best executed workflow.
3. Choose a given phase which is best executed from multiple workflows for doing a
comparative study. Comparison could be for, time taken to complete a task, tem member
performance, formalization factors etc.
Multiple workflow scenarios are depicted as shown in Figure 5.

8. Adding Tools into IFF


Tool to be added into IFF can be broadly classified as server based tools and local
tools. Server based tools are located on a central server and can be invoked from the client
machine. Client tools are located on the client machine ant could be invoked locally. All tools
must be windows executable file. Tools in IFF are identified based on certain characteristics,
following are three characteristics of the tool;

1. Version of a tool.
2. Tool qualification.
3. Methodology of the tool.
Tool methodologies are classified as,

a. Formal
b. Informal
c. Formal-Model based
d. Formal-Informal
e. Formal Model based
f. Formal-Informal-Modelbased.
Tools can be associated with one or more Phases of IFF. Tool cannot be used or
invoked in a phase if it is not associated to a phase. Following is the procedure to add a new
tool.

1. Click on “Add new tool” from the welcome page.


2. Specify the tool name.
3. Specify the tool version - Tool name and version form a pair and the pair must be unique
4. Specify Manufacturer of the tool.
5. Specify description of the tool.
02 TB-16 I 01/12/2016 [0] 23 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

6. Specify Tool qualification.


7. Admin shall declare that tool has all Supporting Library/License and is in running state.
8. Tools shall be associated with one or more phases.
9. Specify the methodology.
10. Specify tool completion criteria. Every tool has some Entry criteria and Exit criteria.
• These tool specific criteria are to be specified.
11. Click on add tool to add tool to IFF.

Figure 19 Tool Details

9. Adding Framework
Adding an external framework to IFF follows the same procedure as adding a tool.

10. Creating A project


This section gives a detailed description of how to create a project. Different
consideration while creating a project. Every project is classified based on following;

1. Nature of Project – A project can be one of the following


a. Development
b. Maintenance
c. Certification
d. Experimentation
e. Research
f. Mission critical
02 TB-16 I 01/12/2016 [0] 24 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

2. Type of the system – Depending on the type of the system we are working on , Project
can be classified as follows;
a. Closed Loop system
b. Open loop system
c. Distributed System
d. Hybrid system
e. Modular system
f. Display system
g. Networked system
Based on the version of the IFF the system specification may change. More could be
added.
3. Domain – based on the domain in which we are working IFF project could of following
type
a. Aerospace civil
b. Aerospace Military
c. Nuclear
d. Automotive
e. Medical
f. Space

4. Criticality – Criticality of the project are of the following types


a. Safety critical
b. Mission critical
c. Security

5. Criticality Level – based on the type of system we are working on, Domain, criticality
and criticality levels are defined. Considering Aerospace Civil for hybrid systems that are
of safety critical type, criticality levels are defined as RTCA DO-178B Level A, B, C, D,
E.
Before creating a project above considerations are to be made. Following are the steps
to create a project,

1. Click on Create project in the welcome page.


2. If SCM is configured and Repository path is specified, first two fields appear filled.
User Admin can change the repository path. It is as shown in Figure 20.

Figure 20 SCM Root path.


02 TB-16 I 01/12/2016 [0] 25 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

3. Specify the Project name.


4. Fill in all mandatory fields as shown in Figure 21.

Figure 21 Fields to be filled while adding a tool

5. Specify the Project Entry and exit criteria, e.g. to start a project Requirement document
could be specified as Input criteria.
6. Click on Create project to create project in Specified repository path as shown in
figure(To be completed – considering confidentiality)

10.1 Creating workflows and assigning phases


Once project is created, Workflow and Phases must be specified. A project can have
more than one workflow. IFF allows creating multiple workflows and permitting team
members to work on one or more workflows. A workflow is Activated using “Active” option
in the workflow list, if the workflow is activated, user can work on phases in the workflow
depending on his access rights. If a workflow is deactivated using “Deactivate” option in
workflow list, User cannot access the workflow and hence none of the phases are available to
work on.
Using IFF admin can specify the access writes to a workflow and phases in a
workflow. As an example if there are three workflow having all phases, Admin can restrict a
user to Worflow-1 and workflow-2. In workflow-1 user has access to only A and T phases
and in workflow-2 only D and C phases. Since workflow -3 is not assigned to user, user has
no access to any phase. Following are steps to create workflow and assign Phases,
02 TB-16 I 01/12/2016 [0] 26 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

1. Click on create workflow option in welcome page.


2. Select a project in which workflows are to be created.
3. Click on create option, specify the workflow name, technique used.
4. Select phases to be included in the workflow as shown in Figure 22.

Figure 22 Creating Workflow

5. Select create option to create the workflow.


6. The workflow appears in the list of workflows with selected phases.

10.2 Adding tools to the project


Once workflow and phases are created, tools can be added. A single tool can be added
to multiple phases. Following is the procedure to add tools to different phases.

1. Select a workflow
2. Select a phase from the list of available phases as shown in Figure 23
02 TB-16 I 01/12/2016 [0] 27 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 23 Adding Tools to a Phase

3. Select the tool and click on Add Tool button to add the tool to selected phase. It is as
shown in figure 9.5

Figure 24 Selected Tools

Tools added into phase have order number associated with it. Order defines the input
output relations of the tool with other tools in the list. Figure 24 illustrates the tool order.

Tool name Order

Tool A 1

Tool B 2
02 TB-16 I 01/12/2016 [0] 28 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Tool C 2

Tool D 3

Tool E 1

Tool F 4
Table 3 Tool Name and Tool Priority Order

Figure 25 Tool Stages based on Order

Order of tool can be viewed as a stage, order 1 tools falls under stage one of the tool
chain, order 2 tools fall under stage 2 and so on. Tool’s outputs of stage 1 become tool’s
inputs in stage 2 and so on. Admin shall decide the tool order based on the Input output
relations of the tools used in a phase.
10.3 Phase completion criteria
Each Phase has completion criteria associated with it. If all the criteria are met only
then a phase is said to be complete. Phase criteria are collection of all the criteria of tools in
that phase.
Input criteria are the collection of all the criteria of the tool and output criteria is
collection of all tool output criteria. IFF allows defining additional criteria at phase level.
This is termed as Additional phase criteria. Figure shows how to add additional phase criteria
in a workflow. To add additional phase criteria click on “Phase completion criteria” and add
input or output criteria at phase level.
02 TB-16 I 01/12/2016 [0] 29 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 26 Phase completion Criteria

10.4 Workflow completion criteria


A Workflow has completion criteria associated with it. If all the criteria are
met only then a Workflow is said to be complete. Workflow completion criteria are collection
of all the completion criteria of phase in that workflow.
Input criteria are the collection of criteria of all phases and output criteria is collection
of all phase’s output criteria. IFF allows defining additional criteria at workflow level. This is
termed as Additional workflow criteria. Figure 27 shows how to add additional workflow
criteria in a workflow. To add additional workflow criteria click on “workflow completion
criteria” and add input or output criteria.
02 TB-16 I 01/12/2016 [0] 30 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 27 Workflow Completion Criteria

10.5 Project completion criteria


Project completion criteria are collection of one or more workflow completion
criteria. Similar to phase and workflow completion criteria a project has additional project
completion criteria. These criteria are defined during creation of project. It is possible to
modify these criteria at any given time. Figure 28 shows how to add these criteria.

Figure 28 Project Completion Criteria

Once all the above procedures are complete a project is completely ready for users to start
working on it.
02 TB-16 I 01/12/2016 [0] 31 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

11. Folder structure of IFF project


All the artifacts, codes documents are maintained in SCM by IFF. It is very important
to fully understand folder structure of a project. Before we start will folder structure, it is
mandatory to know how a project is organized. Every project has one or more workflows. A
project cannot exist without a workflow. Every workflow has one or more phases associated
with it. A workflow cannot exist without a phase.
Considering the example of IGAPS projects the folder structure is described here;

1. Name of the project – IGAPS


2. There are three workflows –
3. Workflow -1 has phases namely, R, D, T
4. Workflow -2 has phases namely A, C
5. Workflow -3 has phases namely R, A, D, C, T.

The above scenario is shown in Figure 29

Figure 29 Multiple workflows in a Project

Considering an example of Autopilot project. Autopilot Project Folder structure is


summarized as
1. Project name is – Autopilot
2. It has two workflows – Master and NALWF
3. Master WF has following phases - R, A, D, C, T
4. Master WF-Requirement Phase has reqZ tool associated with it and this has some entry
criteria and exit criteria, these criteria file are placed in
02 TB-16 I 01/12/2016 [0] 32 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

AutoPilot/Master/01_Requirement/reqZtool_1.0.0/Entry and
AutoPilot/Master/01_Requirement/reqZtool_1.0.0/Exit respectively.

Complete folder structure is shown in Figure 30

Project Name
Workflow name
Phase (Requirement)
Phase entry criteria
Phase exit criteria
ReqZ tool in Requirement phase

ReqZ tool Entry criteria


ReqZ tool Exit criteria

Design Phase

Coding Phase

Testing Phase
Workflow Entry criteria
Workflow Entry criteria
Project Entry criteria
Project Entry criteria

Figure 30 Folder Structure of a Project

12. Reports
IFF provides analysis report of Projects. Broadly there are two types of
reports, Analysis Graphs/Report and Traceability Report. Traceability report gives the entry
and exit criteria of in a project and the file paths that are associated with these. Traceability
and Analysis report can be generated at any stage of project.
02 TB-16 I 01/12/2016 [0] 33 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

12.1 Traceability Report


Traceability report gives the Entry and exit criteria names together with file
names that fulfill these criteria. Figure 31show traceability report.

Figure 31 Traceability Report

12.2 Project analysis report


Project Analysis reports are based on the data populated while executing the project,
IFF generates different analysis Bar graphs based on the selection by user from Analysis
Project page, All graphs are one of the following types with x-axis being all projects,

1. Methodology – There are two bar graphs associated with methodologies. First,
Methodology graph provides information about how much of the project is executed
using which methodology. Second, gives how much time the methodology has taken to
accomplish the task. Graphs can be generated by selected different methodologies from
the dropdown menu of Methodologies. Figure 32 shows an example of this.
02 TB-16 I 01/12/2016 [0] 34 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 32 Analysis Report for Project Methodology

2. Techniques – Every workflow is of one type of technique. Analysis graph gives how
many workflows have these techniques. how much time each technique has taken in
executing a project, This is shown in Figure 33
02 TB-16 I 01/12/2016 [0] 35 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 33 Analysis Report for Project Techniques

3. Phases – Phase graph gives the Phase and project relationships. Graph shows number of
projects assigned to a phase. Time graph of phase gives the total time taken to complete a
particular phase. This is show in Figure 34.
02 TB-16 I 01/12/2016 [0] 36 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 34 Analysis Report for Project Phases

4. Users – user graph gives the total time spent by user on a particular project. It also gives
the user assignment to a project. This is shown in Figure 35.
02 TB-16 I 01/12/2016 [0] 37 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 35 Analysis Report for Project Users

12.3 Custom Analysis Reports


IFF allows users to get custom reports. It gives an API (refer developers
manual for the procedure) that could be used in any executable tool to get custom reports.
Procedure to add the new tool is as follows,
1. Go to Analyze Project page of the IFF.
2. Click on add new tool for analysis
3. Browse the executable file of the analysis tool
4. Specify the tool name.
5. Version of tool, Manufacturer and description, agree to license/Library fulfillment.
6. Add the tool by clicking on Add tool.

Once the tool is added, select the tool and launch tool from the Analyze Project page
to get access to IFF project data and hence the analysis reports.
02 TB-16 I 01/12/2016 [0] 38 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

13. Notes and Email


IFF allows user to store notes and send email from IFF using configured outlook.

13.1 Notes
User can save a note and retrieve the notes. These notes are saved in IFF. All notes of
a particular day could be retrieved by selecting a calendar date as shown in Figure 36.
Retrieving the notes could be done either using a calendar note or by using the search
provided in the page. Figure 36 and Figure 37 show the two scenarios.

Figure 36 User notes using keyword search

Figure 37 View the selected note

13.2 Sending an email


IFF provides option to send an email. Emails Ids of all the users of IFF are listed
while adding the email addresses. IFF doesn’t restrict sending an email to other users. An
example is shown in figure. Some of the browsers may be configured with popup blocking
facility; user must allow popup from IFF to make outlook invocation as shown in Figure 38.
02 TB-16 I 01/12/2016 [0] 39 of 39
AFCCAT
VOL. REP. No. ISSUE ISSUE DATE REV REV DATE PAGE NO

Figure 38 Email draft in IFF

Figure 39 Email popup blocked

Figure 40 Outlook

Vous aimerez peut-être aussi