Modern Requirements4TFS Installation Guide

Transcription

1

2 TABLE OF CONTENTS Introduction... 3 System Requirements... 3 Software Requirements... 3 Hardware Requirements... 3 Hardware requirements for Redis... 4 Installation Process... 4 Installation Guidelines... 4 Installing Modern Requirements4TFS... 4 Deploying TFS Extension using VSIX file Activation (Embedded) Activation (Standalone) User Based Activation Floating Activation Offline Activation Activation Unsuccessful Error Custom ID Configuration Configuring Windows/Basic Authentication Custom ID Configuration Applying Custom ID on new projects Applying Custom ID on existing data/work Items Appendix: User Configurations Enabling Windows Features Manually Adding IIS Binding Information in Config files Configuration for Feedback option Fix for activation lost after VM Machine restart (stanadalone) Modern Requirements Page 1 of 102

3 How to update the windows credentials for Modern Requirements4TFS How to configure load balancing for Modern Requirements4TFS Change User Interface Configuration File Change Service Configuration File How to change the color (RGB) value for a work item How to configure Repository name for GIT projects How to update work item type for simulation, Diagram and usecase How to change the location of the baseline file How to pre-fill a specific field while copying the baseline using Modern Requirements4TFS How to Define the link type relation with the source Workitem while copying the baseline using Modern Requirements4TFS Configuring the fields to display in Work Item Details Panel on opening a baseline Configuring the fields to display in Work Item Details Panel while comparing baselines Configuring the fields to display in Work Item Details Panel on opening a Review How to configure rules section of review management in Modern Requirements4TFS How to configure the actions for a review response in Modern Requirements4TFS Configuring the Review Metadata in the desired field Configuring the recipients s in case of failed Post-State in the Review Module How to delete obsolete NFR templates from FAQ module Deployment instruction page appearing instead of License Status Page (Embedded) Unexpected Error Message (standalone) IIS version is Lower.. Error Bad Request Error (Embedded) Modern Requirements Page 2 of 102

4 INTRODUCTION This Installation Guide elaborates the installation of Modern Requirements4TFS using detailed steps. The guide is divided into the following three sections: 1. System Requirements 2. Installation Process 3. Activation The first section elaborates the prerequisites for installing the application. The second section deals with the actual installation procedure while the third section describes the process of activation after successful installation. The guide elaborates both the embedded and standalone flavors of Modern Requirements4TFS. Normally a section is applicable to both types of installation, however if a section is valid only for a particular type, that type is mentioned at the end of the section heading. The last section before the appendices discusses the Custom ID configuration The document also has an appendix that explains additional information deemed necessary for installation and proper working of Modern Requirements4TFS. SYSTEM REQUIREMENTS SOFTWARE REQUIREMENTS 1. Operating System: Windows Server 2012, 2008 R2 or Windows 7, 8, 8.1,10 2. Internet Explorer 10 or above, Chrome, Mozilla Firefox or above 3. Screen resolution: 1280 x 960 or above 4. IIS 7 or above 5. Microsoft.Net Framework 4.5 or above 6. ASP.NET 4.5 Note: Both 32-bit and 64-bit versions of the operating systems are supported Credentials required for installing Modern Requirements4TFS should have Administrator rights on Machine. In other words, user installing on his/her machine should use admin credentials (or credentials which have administrator rights on it) for proper installation. For regular Team Projects, the user of a machine on which Modern Requirements4TFS is deployed must have administrative rights on TFS Collection (or added in Application Domain in IIS). Note: To access GIT enabled team projects, logged-in Domain User of a machine on which Modern Requirements4TFS is deployed must have authenticated rights on TFS Collection (or added in Application Domain in IIS). HARDWARE REQUIREMENTS 1. RAM: At least 4GB (higher required if executing TFS Work Item Queries greater than 100,000) 2017 Modern Requirements Page 3 of 102

5 2. Hard Drive Space: 200 MB HARDWARE REQUIREMENTS FOR REDIS According to Modern Requirements4TFS, approx. memory usage per user = KB ( MB) Maximum Hard Drive Space Required = 1.5 * (Memory Size) For instance in case of 8 GB Ram, maximum Hard Drive space occupied by Redis would be = 12GB INSTALLATION PROCESS INSTALLATION GUIDELINES Users are provided with a single installation file i.e. Modern Requirements4TFS 2017 Update X.exe (X being the update number) Since Modern Requirements4TFS is a web-based application, it is preferable to install the file on a server; however any machine with IIS 7 or later installed would suffice. The Installation is required only once. After installation all the users with proper access rights can use the application even if they haven t installed any of the installation files on their local machine. INSTALLING MODERN REQUIREMENTS4TFS 1. Double click on the Modern Requirements4TFS 2017 Update X.exe file to start the installation process Modern Requirements Page 4 of 102

6 The initial installation screen appears requiring the user to accept the terms and conditions for using the application Modern Requirements Page 5 of 102

7 2. Select the terms and conditions agreement check box and then click the Next Button Modern Requirements Page 6 of 102

8 3. Select type of installation (Standalone or embedded) Modern Requirements Page 7 of 102

9 4. Click the Next Button Modern Requirements Page 8 of 102

10 5. Enter Windows credentials* (for user login for the PC where the Services are being installed) and then click the Next Button. * Application would be installed, even if incorrect windows credentials entered during the installation, however user will not be able to login into the application. An error message would show up on Sign-in page. Refer to Appendix section, to find out how to update the windows credentials Modern Requirements Page 9 of 102

11 6. Configure Redis Installation options* and click the Install Button. Auto Install Redis option is the recommended option if Redis is not already installed on the target machine. In case Redis is already installed, then the users has to provide the name (or IP address) of the machine where Redis is installed. Similarly if Modern Requirements4TFS is being installed on a load balancing server, then the relevant details are to be provided here. The default port for Redis is 6379 however user can give another port number if he is installing Redis independently of Modern Requirements4TFS. Now at the time of Modern Requirements4TFS installation, same Port number should be given that was used during the Redis installation. Refer to your network department to get the value of Redis Password (if there is one). Use SSL option should be enabled where required. Refer to your network department in this regard as well. Both the Password and Use SSL options are optional, however their use mainly depends upon the procedures followed in any particular organization Modern Requirements Page 10 of 102

12 7. Click Yes Button in the warning message box. The relevant files are installed Modern Requirements Page 11 of 102

13 8. Complete the Installation of Modern Requirements4TFS by clicking the Finish or Run Button. This is the last installation step for Standalone version. Additional steps for Embedded version are described below. For the Embedded version, TFS Deployment instruction page is shown in the default browser window. Follow the steps described in the page to get VSIX file Modern Requirements Page 12 of 102

14 DEPLOYING TFS EXTENSION USING VSIX FILE 1. Log into your TFS Server. 2. Click Marketplace icon and then select the Manage extensions option from the drop-down menu. 3. Click the Browse local extensions link. 4. Click the Manage extensions Button Modern Requirements Page 13 of 102

15 5. Click the Upload new extension Button. 6. Click the Browse Button Modern Requirements Page 14 of 102

16 7. Navigate and select the relevant VSIX file (created at the end of the installation in last section). 8. Click the Upload Button Modern Requirements Page 15 of 102

17 9. Select the desired collection and click the Continue Button Modern Requirements Page 16 of 102

18 10. Click the Confirm Button Modern Requirements Page 17 of 102

19 The Modern Requirements4TFS Embed options become accessible through the Work tab Modern Requirements Page 18 of 102

20 ACTIVATION (EMBEDDED) Most of the activation process for embedded version is similar to that of the standalone version however some early steps are unique to embedded version. These are described below: 1. Access your TFS Server using a browser and select the Modern Requirements4TFS embedded tab. In case the product has not been activated; following message is displayed: 2. Click the Activate Button Modern Requirements Page 19 of 102

21 The user is taken to the License Activation Page. Proceed to User Based Activation section (elaborated below) to complete the activation process Modern Requirements Page 20 of 102

22 ACTIVATION (STANDALONE) 1. Open a browser window and enter the path shown at the end of installation followed by a colon and 8028/User/SignIn e.g Click the Sign In Button on the Sign In Page. Refer to the end of Appendix section if an unexpected error message is shown on the Sign In page Modern Requirements Page 21 of 102

23 If Modern Requirements4TFS has not been activated yet; the user is taken to the License Activation Page. USER BASED ACTIVATION 3. Select User Based type of license Modern Requirements Page 22 of 102

24 4. Enter relevant license key and click the Activate Button. On successful activation, the user is taken to the Browse Page, from where the desired Team Project can be opened Modern Requirements Page 23 of 102

25 FLOATING ACTIVATION 3. Select the Floating type of license 4. Enter the Floating URL and click the Activate Button. On successful activation, the user is taken to the Browse Page, from where the desired Team Project can be opened Modern Requirements Page 24 of 102

26 OFFLINE ACTIVATION 3. Select the Activate Offline check box. 4. Follow the given instructions to activate. On successful activation, the user is taken to the Browse Page, from where the desired Team Project can be opened Modern Requirements Page 25 of 102

27 ACTIVATION UNSUCCESSFUL ERROR Very rarely a user can come across the Activation Unsuccessful Error as described in the above image. In most cases this error is due to problems in internet connectivity. Users have to resolve their connectivity problems themselves in order to successfully activate the application. This message is also displayed when secured environment is blocking proxy from firewall or due to applied network policy. To resolve the problem in this case users have to provide their network department with the following URL and should ask them to allow it: Modern Requirements Page 26 of 102

28 CUSTOM ID CONFIGURATION The Custom ID feature basically allows user to add customized ID according to their own required format in TFS work items. Users can define customized ID in existing data as well as for new work items instead of getting bound to use TFS work item ID. It works on TFS server and work items created from any source would have custom ID applied on it. The whole process is divided into the following distinct tasks: 1. Configuring Windows/Basic Authentication 2. Custom ID Configuration 3. Applying Custom ID on new projects 4. Applying Custom ID on existing projects Each of these tasks is elaborated below in relevant section. CONFIGURING WINDOWS/BASIC AUTHENTICATION 1. Invoke inetmgr through Windows s Run command/start Menu Modern Requirements Page 27 of 102

29 2. Expand the node in the left-side panel of the Internet Information Services (IIS) Manager. 3. Expand the Sites node Modern Requirements Page 28 of 102

30 4. Under the Sites node, expand Team Foundation Server and then select tfs node. 5. Double-click on the Authentication icon (in the main panel) Modern Requirements Page 29 of 102

31 6. Select Windows Authentication or Basic Authentication* option and Enable it as shown in the following image. *Only one of these options would exist. CUSTOM ID CONFIGURATION In order to make the Custom ID work properly, the following two things are to be created by the users manually: 1. TFS server folder name(on which Custom ID is required to Apply) 2. TFS Collection folder name(collection on which Custom ID is required) under the TFS server folder name The relevant collection folder should also contain the config.xml file containing all configuration. File and folder hierarchy should be as shown below using text pattern and relevant image: 2017 Modern Requirements Page 30 of 102

32 Follow these steps to configure Custom ID: 1. Go to the following location: <Installation Drive>:\Program Files (x86)\modern Requirements\Custom ID\App_Data\CustomId\ 2. Create a copy of the sample configuration file placed on this location with name config.xml 3. Open config.xml file in notepad or any text editor. 4. Define value of IDScope tag as per requirement i.e. Collection Project Team -> apply counter scope to Collection level. -> apply counter scope to Project level. -> apply counter scope to Team level. 5. FieldReferenceName tag with Override value "Yes means user defined field (between the tags) would be considered for Custom ID, while Override value No means default field MR.CID would be considered and applied for Custom ID( which means user has to define this field in their TFS template with same reference name i.e. MR.CID) 6. CollectionUrl tag requires Url for TFS collection on which Custom ID is required to apply.(note: Please make sure that Url should not end on \ ) 7. UserId and Password tags are required to define credentials to access and create service hooks on required TFS server. These credentials should have rights to read/write service hooks subscription and modify WorkItems at collection level. 8. Sequence Id="1" tag Id value shows number of different Custom ID groups created in configuration file and is used to identify and differentiate from Id, it would always be numeric only field and should be kept unique. Sequence tag consists of combination of WorkItem type, formatting required on ID field and counter to start from. a. WIType value requires type of WorkItem on which Custom ID is required to apply. Also if required multiple WorkItems could be defined for same Configuration to apply as group. b. FieldFormat tag is to define ID formatting required on Custom ID. Example: <FieldFormat>Req #####</FieldFormat> For reference please check link below: 2017 Modern Requirements Page 31 of 102

33 c. FieldCounter tag is required to define number/series from where Custom ID counter is required to start from. Once the counter value is applied (configuration file is applied), it cannot be modified in any case. 9. After successful completion of configuration file, save and close it. 10. Create a folder with name of TFS server. 11. Inside TFS server name folder, create another folder with Collection name on which user wants to apply Custom ID configuration. 12. Go to collection name folder and paste modified configuration file here to apply it on TFS server. 13. Now go to location below: <Installation Drive>:\Program Files (x86)\modern Requirements\Custom ID 14. Right click and Edit AppSettings.config file. 15. A tag with name "edev.mr.customid.workitemcreatedserviceurl" requires address in its value from which TFS server machine could access MR4TFS Server machine (containing Custom ID). If both machines are on same domain it would be displaying the correct path while in case of both machines are residing on different domains, address in value of this tag should be verified and correct network address should be given from which both machines can communicate. 16. Go to Internet Information Service (IIS) Manager, Expand Left panel contents and under Sites folder CustomID site would be displayed. 17. Right click on it and select Refresh option to restart service Modern Requirements Page 32 of 102

34 APPLYING CUSTOM ID ON NEW PROJECTS After Custom ID configuration on any collection, new team projects created would not be considered. Therefore applying the Custom ID on subsequent new projects (created after configuring Custom ID) a command line option is provided. Following steps elaborate the procedure. 1. Invoke Cmd (Command Line Interface) of Microsoft Windows. 2. Enter the following command on CMD: cd <Installation Drive Letter>:\Program Files (x86)\modern Requirements\Custom ID\bin 2017 Modern Requirements Page 33 of 102

35 The bin folder would be selected (as shown below). 3. Now write the following command to scan all new projects created after configuring Custom ID: cid.exe Scan <TFS Collection Url>* * (This Url should be the same Url defined in configuration file at Step 6) This will apply Custom ID settings from configuration file to all new projects found and then any new Work Item created after this command; Custom ID would be displayed. APPLYING CUSTOM ID ON EXISTING DATA/WORK ITEMS Configured Custom ID settings cannot be applied on existing Work Items as they were already present. Therefore to apply the configuration on existing Work Items the user has to follow these steps: 1. Invoke Cmd (Command Line Interface) of Microsoft Windows Modern Requirements Page 34 of 102

36 2. Enter the following command on CMD: cd <Installation Drive Letter>:\Program Files (x86)\modern Requirements\Custom ID\bin The bin folder would be selected (as shown below). 3. Now write the following command to scan all new projects created after configuring Custom ID: cid.exe Apply <TFS Collection URL>* * This URL should be the same URL defined in configuration file at Step 6 It will apply Custom ID settings from configuration file to all existing Work Items found Modern Requirements Page 35 of 102

37 APPENDIX: USER CONFIGURATIONS ENABLING WINDOWS FEATURES MANUALLY In case an organization has restrictions in working environment, which do not permit users you to enable or modify the Windows Feature settings; the users can follow these instructions to enable the window features manually. 1. Open the Control Panel and change the View by field value to Category (if not selected by default). 2. Click on the Programs option Modern Requirements Page 36 of 102

38 3. Select the Turn Windows features on or off option, under the Programs and Features category. The Windows Feature screen would be displayed 4. Select the highlighted features required for Modern Requirements4TFS.(refer to image below) 2017 Modern Requirements Page 37 of 102

39 5. If Win8 or a higher version is installed on the machine; please also enable the features highlighted in the following image ADDING IIS BINDING INFORMATION IN CONFIG FILES If a user has bound any IP on the system then the web config file needs to be updated using the following steps: 7. Invoke inetmgr through Windows s Run command/start Menu Modern Requirements Page 38 of 102

40 8. Expand the node in the left-side panel of the Internet Information Services (IIS) Manager. 9. Click the Application Pools option Modern Requirements Page 39 of 102

41 10. Right click on Modern Requirements4TFS 2017 Update XX and select the Edit Binding option The Site Bindings window will be displayed. The IP Address field would display which IP has been bound (if any). 11. Note the IP Address value e.g (in the above image) ; and go to the installation directory i.e. <Default Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\User Interface 12. Select the Web.config file among the list displayed in folder. (Highlighted in the above image) Modern Requirements Page 40 of 102

42 13. Open the file in Notepad. 14. Search for the tag <add key="serviceaddress" value=".."/> (selected in the following image) and update its value= name>:8027/ with IP address bound and noted above. i.e. value= 15. Save the file and close it. In case the user is not allowed to save the notepad file with changes on same directory then save it on the desktop first. Then copy it back to this directory i.e. location and replace. 16. Switch back to IIS Manger window and restart both integreat services under Sites folder Modern Requirements Page 41 of 102

43 CONFIGURATION FOR FEEDBACK OPTION The configuration is essential if the user wants to use the Feedback option in Simulation Module. This is because Modern Requirements4TFS automatically sends out s to concerned stakeholders to get their feedback. If the settings are not properly configured then these s can t be sent out and the feedback option cannot function properly. Following steps should be taken to configure the settings for Modern Requirements4TFS: 1. Navigate to the following location on your computer: C:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\Service Modern Requirements Page 42 of 102

44 2. Copy the Web.config file to another location (e.g. desktop) for editing. 3. Open the file using a text editor (e.g. Notepad). Note: The highlighted section in the above image shows the section of the file that needs to be configured properly Modern Requirements Page 43 of 102

45 4. Now open your client / reader (e.g. Microsoft Outlook). Note: The following steps show the process for Microsoft Outlook. If you are using another reader then refer to its documentation for relevant steps. 5. Click on File Account Settings Account Settings. 6. Double-click on the desired account from the list Modern Requirements Page 44 of 102

46 7. Note down the information highlighted in the window. 8. Click the More Settings Button Modern Requirements Page 45 of 102

47 9. Click the Advanced Tab. 10. Note down the SMTP port highlighted in the window. 11. After noting down all the required information; close down all the windows in Microsoft Outlook. 12. Switch back to Web.config file opened in a text editor Modern Requirements Page 46 of 102

48 13. Update the mail settings section using the information gathered from Microsoft Outlook. 14. Save the Web.config file and replace the older version with this updated version at its original location (i.e. C:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\Service ) This completes the configuration process for the Feedback Option Modern Requirements Page 47 of 102

49 FIX FOR ACTIVATION LOST AFTER VM MACHINE RESTART (STANADALONE) For any general Virtual Machine (of any O.S): 1. After Activation of License, If user is navigated to Activation page again ( as shown below): OR following error page occurs with error message An error occurred while processing your request. 2. Remote desktop the Modern Requirements4TFS Deployed VM Machine. 3. Go to run window (by pressing Keyboard shortcut: [<windows key> + R ])and type gpedit.msc. Refer the screen shot below: 2017 Modern Requirements Page 48 of 102

50 4. Go to Computer Configuration->Administrative Templates->System-> UserProfiles. 5. Select Do not forcefully unload the user registry at user logoff (highlighted below). 6. Change the setting from Not Configured to Enabled, and click Apply once done; Restart the VM machine and check it should resolve the issue 2017 Modern Requirements Page 49 of 102

51 If VDI (Virtual Desktop Infrastructure) has been implemented, follow these steps: 1. Remote desktop the Modern Requirements4TFS Deployed VM Machine. 2. Go to run window and Type %public%. 3. Select Public Documents folder and confirm username.bin (In case of OFFLINE Activation) OR username.orf (In case of ONLINE Activation) is present in folder. 4. If Yes; Kindly mention this in your along with log files (<Default Drive>:\inetpub\wwwroot\walog) at: 5. If No; please ask VDI administrator to share Image of VM after activating license from all users. That image would persist all licensing information Modern Requirements Page 50 of 102

52 HOW TO UPDATE THE WINDOWS CREDENTIALS FOR MODERN REQUIREMENTS4TFS During the installation of Modern Requirements4TFS, user login credentials are provided. These Windows credentials are saved in Modern Requirements4TFS settings and are used while running the application. If a user changes his Windows password after the installation of Modern Requirements4TFS then these settings become obsolete and the user may face problem running the application. For seamless working of Modern Requirements4TFS, the saved settings of the Windows Credentials should be consistent with the current Windows Credentials. In case a user has changed his password after installing Modern Requirements4TFS then the following steps should be taken to make the saved settings up-to-date: 1. Invoke inetmgr through Windows s Run command/start Menu Modern Requirements Page 51 of 102

53 2. Expand the node in the left-side panel of the Internet Information Services (IIS) Manager. 3. Click the Application Pools option Modern Requirements Page 52 of 102

54 4. Select integreat4tfssrv option (center-pane) and then click on Advanced Settings under Edit Application Pool in right-side pane. 5. Select Identity option under Process Model section and then click the Button Modern Requirements Page 53 of 102

55 6. Select Custom account option and then click the Set Button. 7. Enter the latest Windows Credentials* and click the OK Button. * The User name should be given in the format of <Domain\Username> as shown in the image Clicking the OK Button would save the settings Modern Requirements Page 54 of 102

56 8. Start the integreat4tfssrv by clicking the Start option under the Application Pool Tasks in the right-side pane. Close all open windows to complete the process Modern Requirements Page 55 of 102

57 HOW TO CONFIGURE LOAD BALANCING FOR MODERN REQUIREMENTS4TFS This section elaborates the configuration process of load balancing for Modern Requirements4TFS using detailed steps. It acts only as a framework to show how to configure load balancing for Modern Requirements4TFS. Installation steps are not covered here. For installation steps of individual applications, refer to their respective section in the guide. The configuration process consists of the following seven steps: 1. Setup/Install the desired load balancing environment. 2. Install Modern Requirements4TFS on all servers. 3. Configure shared network drive for shared workspace. 4. Install/configure shared Redis server. 5. Change User Interface Configuration file (web.config). 6. Change Service Configuration file (web.config) 7. Repeat step 5 and 6 for all server on which Modern Requirements4TFS has been installed (for load balancing). While most of the steps are quite straightforward, steps 5 and 6 are further elaborated below. Also note that both these steps refer to different files albeit with same name. CHANGE USER INTERFACE CONFIGURATION FILE The location of this file in Program Files (x86) is highlighted in the following image: To complete this step; carry out the following elementary steps: 1. Open the Web.config file (as mentioned above), in editable mode. 2. Edit the following, to set the shared drive path*: <add key="appcontentpath" value="<shared drive path>" /> *Note: The shared drive path is setup in step #3 of overall configuration process (mentioned in previous section) 3. Comment the SessionState timout command as following: <!--<sessionstate timeout="40" />--> 2017 Modern Requirements Page 56 of 102

58 4. Uncomment the following section: 5. In the above section, set customprovider value to RedisCacheAzure Comment the following line in above section: <add name= LocalRedisCacheAzure01 type= Microsoft.Web.Redis.Redis. 7. Set Redis host, port and access key(password) value in the following line in above section: <add name= RedisCacheAzure01 type= Microsoft.Web.Redis.Redis. CHANGE SERVICE CONFIGURATION FILE The location of this file in Program Files (x86) is highlighted in the following image: To complete this step; carry out the following elementary steps: 1. Open the Web.config file (as mentioned above), in editable mode. 2. Set shared drive path for workspace folder key (Same path assigned in Step #3) <add key= WorkspaceFolder value= %public%documents > 3. Set EnableLoadBalancer key value to true : <add key= EnableLoadBalancer value= true > 4. Set Redis storage value host, port and password* *Note: The values for these attributes are determined while installing Redis Server in Step 4 of overall configuration process (mentioned at the beginning of this section) 2017 Modern Requirements Page 57 of 102

59 HOW TO CHANGE THE COLOR (RGB) VALUE FOR A WORK ITEM The color for a Work item can be changed by performing the following steps 1. Go to the location <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\User Interface\App_Data 2. Open the file ColorCodeMapping.xml in the notepad. 3. Change the desired color code for a Work Item. 4. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file. 5. Restart IIS Modern Requirements Page 58 of 102

60 HOW TO CONFIGURE REPOSITORY NAME FOR GIT PROJECTS By default in any project, the repository is named as the project s name. However for GIT projects only, users can now configure the repository name of their choice by following these steps: 1. Open the desired GIT Project Modern Requirements Page 59 of 102

61 2. Click the Code option from toolbar and then select the repository name in the dropdown menu. 3. Click the repository name and then select the New Repository option Modern Requirements Page 60 of 102

62 4. Enter desired name for the new repository and click the Create button. A new repository is created. 5. Go to the location <Modern Requirements4TFS Installation Drive>:\Users\Public\Documents 2017 Modern Requirements Page 61 of 102

63 6. Open the file IG4TFSUserSetting.json in any text editor. 7. Search for the GeneralSettings section. 8. If found then search for subsequent sub-sections mentioned below. In case any of the sub-sections is not present in the file, create it as described in the following steps. 9. If GeneralSettings section is not found then place a comma at the end of the last section Modern Requirements Page 62 of 102

64 10. Now create a new GeneralSettings section as shown in the following image. 11. Create a sub-section named WorkItemProperties under the GeneralSettings section Modern Requirements Page 63 of 102

65 12. Similarly create a ConfigField sub-section under WorkItemProperties. 13. Under ConfigField sub-section create a property named ProjectBasedGitRepoName as highlighted in the following image Modern Requirements Page 64 of 102

66 14. Now enter the value for the desired repository name. Separate the GIT Project Name and the relevant Repository Name using a separator Modern Requirements Page 65 of 102

67 15. Repeat the process for other GIT projects and the relevant repository name. Separate two pairs of GIT Project/Repository names using a semi-colon. 16. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file. 17. Sign out from Modern Requirements4TFS and then sign in again for changes to take effect (Standalone version). 12. Click on any of the Modern Requirements4TFS modules (Embedded version) Modern Requirements Page 66 of 102

68 HOW TO UPDATE WORK ITEM TYPE FOR SIMULATION, DIAGRAM AND USECASE A default mapping is embedded in application to support Work Item to File Type functionality. So that when user creates new file, a page work item get created in connected team project according to the work item type stated in this file. Complete the following steps to Update Work Item Type of a Page Work item: 1. Access the following path: <Windows installation folder>\program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\Service\App_Data 2. Look for the XML file WIToFileTypeMapping in folder and open it. 3. Look for the field <WorkItem id="<wi Type>" /> in respective module section and then update "<WI Type>" value accordingly. 4. Save as the file at some other location (e.g. Desktop). 5. Copy file from saved location and paste it in same installation folder (as mentioned above in Point # 1) 6. Restart application Service from IIS (Internet Information Services) Manager. (Refer to Appendix to see the process details) 7. Logon to the application. 8. Type text inetmgr on Run Command Modern Requirements Page 67 of 102

69 Internet Information Service Manager Window will open. 9. In IIS Manager Window, select Modern Requirements4TFS 2017 Service option from left panel Modern Requirements Page 68 of 102

70 10. Look for the section Manage Web Site in Right side panel. First click on Stop and then Start the Service. HOW TO CHANGE THE LOCATION OF THE BASELINE FILE Modern Requirements4TFS creates a local working folder on the machine where Modern Requirements4TFS is installed. The path can be changed but it is recommended when you are installing and using Modern Requirements4TFS for first time. By doing this with existing installation; all existing created project data and files would be inaccessible. This approach will not be going to work for the existing projects by just copying existing content to new location. Once any existing file is changed or removed from location it might corrupt the whole project data. Following steps needs to be performed to update the location: 1. Go to the location : <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\Service 2. Open web.config file, Find tag : <add key="worksapcefolder" value="%public%/documents"/> 3. Update value of Workspace Folder with the required location**. 4. Save the web.config file. 5. restart the IIS service. **Location can be a shared Data Drive, or separate drive/folder. P.S: By doing this with existing installation; all existing created project data and files would be inaccessible Modern Requirements Page 69 of 102

71 HOW TO PRE-FILL A SPECIFIC FIELD WHILE COPYING THE BASELINE USING MODERN REQUIREMENTS4TFS You can prefill a specific field (s) of a work item when it is copied from one of the baseline to same or another project, by changing in the IG4TFSUserSetting file in the Modern Requirements4TFS installation file. Following steps have to be performed 1. Close Modern Requirements4TFS application 2. Go to the location <Modern Requirements4TFS Installation Drive>:\Users\Public\Documents 3. Open the file IG4TFSUserSetting.json in any text editor. 4. Search for the ConfigField section under CopyBaseline section, which in turn would be under BaselineSettings section Modern Requirements Page 70 of 102

72 The basic structure for the configuration would already be there, i.e. Name & Value. 5. Configure the pre-filled field using the following format: a. Enter the name of the filed within the in the Name field b. Enter the Value to be pushed within the in the Value field Basically, there are two approaches that user can do EITHER set a static value into the target project field For example: User want to populate the Description field of target project with value login details (static text): Name: Description Value: Login Details OR Get value from source project field and set into the target project field For example: User want to populate the Description field of target project with value of Area Path field of source project: Name: Description Path [Please note that to get value of a specific field, <Field name> must be mentioned character] 2017 Modern Requirements Page 71 of 102

73 6. Repeat last step if additional fields are to be configured. Make sure to separate two fields with a comma as mentioned in the following image: 7. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 72 of 102

74 HOW TO DEFINE THE LINK TYPE RELATION WITH THE SOURCE WORKITEM WHILE COPYING THE BASELINE USING MODERN REQUIREMENTS4TFS When you copy the work items from baseline using Modern Requirements4TFS to same or other project you can select the option of Link with the source Work Item. If you check this box (shown in the image below) by default it will create Related Relationship in the target project. This can be changed to any relationship type defined in your process template by making the following changes 1. Go to the location <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\ Modern Requirements\Modern Requirements4TFS 2017 Update X\Service\App_Data 2017 Modern Requirements Page 73 of 102

75 2. Open the file IG4TFSUserSetting.json in the notepad. 3. Search for the RelationLinkType section Modern Requirements Page 74 of 102

76 4. Replace the value Related with the desire one. 5. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file. 6. Restart IIS Modern Requirements Page 75 of 102

77 CONFIGURING THE FIELDS TO DISPLAY IN WORK ITEM DETAILS PANEL ON OPENING A BASELINE When a Baseline is opened, the fields of the selected Work Item are shown in the Work Item Details Panel (If the panel is not collapsed). Users can configure which Work Item fields they want to display in the panel, by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor Modern Requirements Page 76 of 102

78 2. Create a new section named GeneralSettings. 3. Now add WorkItemProperties section inside the GeneralSettings section Modern Requirements Page 77 of 102

79 4. Similarly add ConfigField section inside the WorkItemProperties section. 5. Configure the desired properties (that are to be displayed in the Work Item Details Panel) using the following format: a. In the first line write the following text = Name : WorkItemDisplayProperties, b. In the second line write the following text = Value : <reference name of the Work Item field> For example if the user wants to display only the Work Item Type then he should write: Name : WorkItemDisplayProperties, Value : System.WorkItemType Additional fields are to be separated by a comma as shown in the following image. 6. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 78 of 102

80 CONFIGURING THE FIELDS TO DISPLAY IN WORK ITEM DETAILS PANEL WHILE COMPARING BASELINES The previous section elaborated the process to configure the Work Item fields that would show up in the Work Item Details panel. A similar panel is also shown when two baselines are compared. Users can configure its fields as well by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor. 2. Search or create the section named GeneralSettings. This section would already exist if the user would have carried out the instructions in the previous section 2017 Modern Requirements Page 79 of 102

81 3. Add an unnamed sub-section under the ConfigField section and populate it as described in the previous topic (i.e. Configuring the fields to display in Work Item Details Panel on opening a baseline). Make sure to place a comma between the two sub-sections. 4. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 80 of 102

82 CONFIGURING THE FIELDS TO DISPLAY IN WORK ITEM DETAILS PANEL ON OPENING A REVIEW When a Review is opened, the fields of the selected Work Item are shown in the Work Item Details Tab (when the tab is selected. By default Comments Tab is shown). Users can configure which Work Item fields they want to display in the panel, by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor Modern Requirements Page 81 of 102

83 2. Create a new section named GeneralSettings. 3. Now add WorkItemProperties section inside the GeneralSettings section Modern Requirements Page 82 of 102

84 4. Similarly add ConfigField section inside the WorkItemProperties section. 5. Configure the desired properties (that are to be displayed in the Work Item Details Panel) using the following format: a. In the first line write the following text = Name : WorkItemDisplayProperties, b. In the second line write the following text = Value : <reference name of the Work Item field> For example if the user wants to display only the Work Item Type then he should write: Name : WorkItemDisplayProperties, Value : System.WorkItemType Additional fields are to be separated by a comma as shown in the following image. 6. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 83 of 102

85 HOW TO CONFIGURE RULES SECTION OF REVIEW MANAGEMENT IN MODERN REQUIREMENTS4TFS In the Review module of Modern Requirements4TFS when you set up the review you may define the rules. This rule section can be configured. There are two things that can be done. 1. Individual Rules* may or may not show up in the window 2. Rules with checkboxes can be set as checked by default * The rules with checkboxes are individually controlled while the rules with dropdown boxes are controlled as a whole, to appear or not. The above can be setup as follows 1. Go to the location <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\User Interface 2. Open the file web.config in the notepad Modern Requirements Page 84 of 102

86 3. Search for the tag keys starting with Review.Rules By default some values are set to True, while others are set to False Modern Requirements Page 85 of 102

87 The relation between the fields displayed in Review Request window and corresponding tag keys is shown in the following image: 4. Set the values as required using the following table serving as a guide: Key RulesApproveAsPackage RulesApproveAsPackageChecked RulesReenterPassword RulesReenterPasswordChecked RulesStatesVisible Set Value as True: if Approve as package rule is to be shown in the section False: if Approve as package rule is to be omitted from the section True: if Approve as package checkbox is to be shown selected by default False: if Approve as package checkbox is to be shown unchecked by default True: if Password on approval rule is to be shown in the section False: if Password on approval rule is to be omitted from the section True: if Password on approval checkbox is to be shown selected by default False: if Password on approval checkbox is to be shown unchecked by default True: if the Pre state, Post state and Change state rules are to be shown in the section 2017 Modern Requirements Page 86 of 102

88 False: if the Pre state, Post state and Change state rules are to be omitted from the section 5. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file. 6. Restart IIS Modern Requirements Page 87 of 102

89 HOW TO CONFIGURE THE ACTIONS FOR A REVIEW RESPONSE IN MODERN REQUIREMENTS4TFS The actions for the review response can be configured so that the desired values can be added. This can be done as follows: 1. Go to the location C:\users\Public\Documents and open the file IG4TFSUserSetting in the notepad Modern Requirements Page 88 of 102

90 2. Search for the contents highlighted in the image 3. It is used to set action against a review response. By default, it has 3 actions (as shown in xml in Value field). 4. User can only configure Value field i.e. can add more actions, delete or update any existing. 5. User cannot update label of Review Action field, not even can set any action value to appear in drop down as default. 6. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file. 7. Restart IIS Modern Requirements Page 89 of 102

91 CONFIGURING THE REVIEW METADATA IN THE DESIRED FIELD With each Review Request initiated, a Feedback Request Work Item is created. By default the metadata of the review is saved in the Launch Instruction field of that Work Item. However users could configure it to save the metadata in the field of their choice*, using the following steps: *Metadata support is reserved for only HTML type fields. 1. Go to the location C:\users\Public\Documents and open the file IG4TFSUserSetting in the notepad. 2. Search for ReviewManagementSettings section in the file Modern Requirements Page 90 of 102

92 3. Configure the metadata to the desired field by adding the section highlighted in the following image, where Value = the desired field required to hold metadata. 4. Add reference name of desired field in Value tag from the process template as shown in image below. 5. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 91 of 102

93 CONFIGURING THE RECIPIENTS S IN CASE OF FAILED POST-STATE IN THE REVIEW MODULE When a review request is being created there is a field called Post State (In the Rules section). It tells Modern Requirements4TFS to change the State field (to the selected state) when approval process is completed. If the selected Post State can t be automatically achieved due to any reason then the review Initiator is automatically notified by an regarding the situation. However review initiators may want to send out the automatic notification to additional stakeholders. This section deals with how to configure the s for these additional stakeholders. 1. Open the file IG4TFSUserSetting.json in any text editor Modern Requirements Page 92 of 102

94 2. Search for the ReviewManagementSettings section. 3. Under this section create the ReviewRequest section. 4. Add ConfigField section under it. 5. Under this section add the Address property along with its value, as shown in the following image. Separate two addresses with a semi colon. Save the file, if you don t have the admin rights save the file on desktop and then replace it in the same folder with the existing file Modern Requirements Page 93 of 102

95 HOW TO DELETE OBSOLETE NFR TEMPLATES FROM FAQ MODULE The obsolete NFR templates of the FAQ module appear when users try to create a new topic in the FAQ Module. These templates appear due to a folder created during the installation of older versions of Modern Requirements4TFS (at that time named as integreat4tfs). The following folder needs to be manually deleted by the users to get rid of these obsolete templates: C:\Users\Public\Documents\inteGREAT4TFS\QWizard Templates\NFR 2017 Modern Requirements Page 94 of 102

96 After deleting the folder user should re-sign in or refresh the application to confirm the disposition of the obsolete templates. DEPLOYMENT INSTRUCTION PAGE APPEARING INSTEAD OF LICENSE STATUS PAGE (EMBEDDED) For the Embedded version, users may check the status of the license for Modern Requirements4TFS by entering the following URL: <machine name>:8028/license/status e.g. steve:8028/license/status. This usually displays the status page similar to as shown below Modern Requirements Page 95 of 102

97 However user may come across the situation where instead of the license status page, the deployment instruction page is displayed as shown below. This situation occurs when users is using Visual Studio Team Services but in the current session hasn t yet used any of the Modern Requirements4TFS modules. In other words although the user has been using the container environment but hasn t actually used Modern Requirements4TFS so far. Therefore the status check for the license won t work at that moment. However after clicking any of the Modern Requirements4TFS modules the aforementioned problem won t persist. UNEXPECTED ERROR MESSAGE (STANDALONE) Occasionally a user may come across the unexpected error, as shown in the following image Modern Requirements Page 96 of 102

98 The solution to this error starts at the same Sign In page. 1. Click on the Click here link, as shown. The user is taken to the Diagnostics page which briefly describes the precise root cause of the error. 2. Now click on the click here for solution link. The User is redirected to the solutions page, where the user can browse through the detailed solution for the relevant root cause of the error Modern Requirements Page 97 of 102

99 3. Follow the solution given in the answer to counter the relevant problem being faced. IIS VERSION IS LOWER.. ERROR During installation if a user encounters the error message Modern Requirements4TFS cannot be installed on system with IIS Services version lower than 7.0, there could be multiple reasons for it. 1. IIS is not installed on targeted machine (on which user is trying to install Modern Requirements4TFS). 2. IIS has not been properly/completely installed on machine. 3. Or IIS has been properly installed but version is below 7.0. In these scenarios it is recommended to install Internet Information System Manager (IIS Mgr.) completely, for the successful installation of Modern Requirements4TFS. Additionally the IIS version installed should be greater than version BAD REQUEST ERROR (EMBEDDED) Internet Explorer by default doesn t allow to store cookies of sites which are inside the IFrame and have different domain from parent site. The embedded version of Modern Requirements4TFS does have an architecture where the parent site is and IFrame site used is This issue however is limited to Internet Explorer only. Firefox & Chrome do not show any problem in such scenario. To overcome the issue we need to direct IIS to send a custom header with every response it send. This needs to be done on every IIS where Modern Requirements4TFS will be deployed in the Embedded version. Following steps are required to solve the issue: 1. Open IIS Manager Modern Requirements Page 98 of 102

100 2. Select the Server Name in Root Modern Requirements Page 99 of 102

101 3. Open the HTTP Response Headers option by double-clicking. 4. Click the Add option in the Actions panel Modern Requirements Page 100 of 102

102 5. Enter the following values and click the OK Button. Name = p3p Value = CAO PSA OUR 6. Again click the Server Name in Root Modern Requirements Page 101 of 102