o Hardware Requirements o Software Requirements o Required Permissions Managing Your Server Features

Transcription

1 LegiTest Server View LegiTest Server Live Dcumentatin With LegiTest Server the user will be able t get an easier glimpse at their tests and the the results f the tests, as well as drill int any given element t detect where a failure may have ccured. LegiTest Server als allws the integratin f test runs and alerts by using the Ntificatin Engine. Table f Cntents Setup Instructins Hardware Requirements Sftware Requirements Required Permissins Managing Yur Server Features Dashbard Server Testing System Cverage System Dashbard Frequently Asked Questins Created with the Standard Editin f HelpNDc: Free help authring tl

2 Setup Instructins Table f Cntents Hardware Requirements Sftware Requirements Required Permissins Wrkbench Server is the main applicatin that LegiTest Server is hsted within. Hwever, the features will nly becme available if yu have purchased a license fr the prduct yu are trying t use. 1. After ensuring yu meet the Hardware and Sftware Requirements, pen the installer. 2. If yu d nt wish t send feature usage statistics, uncheck the bx "Send feature usage statistics t Pragmatic Wrks". 3. Make sure t read the License terms and cnditins befre checking "I agree t the License terms and cnditins". When yu are dne reviewing the settings fr the current page, click "Next". Imprtant Nte: The "Use previus installatin settings" ptin helps users upgrading frm lder versins. This ptin attempts t gather as much f the previus installatin's settings as pssible. Fr example, the applicatin pl identities may need recnfiguring. Please review each cnfiguratin page befre cntinuing.

3 4. On the "Select Cmpnents" page, yu shuld see an itemized list f the cmpnents Wrkbench Server will be installing as well as the ttal space required. When yu are dne reviewing the settings fr the current page, click "Next".

4 5. On the "Wrkbench Server Website Cnfiguratin" page, yu can cnfigure the website that Wrkbench Server will be accessed frm. When yu are dne reviewing the settings fr the current page, click "Next". 1. Wrkbench Server URL: This is the URL that users will enter int their web brwser t access Wrkbench Server. If the user wishes t have Wrkbench Server assciated with a different prt number than the industry standard prt 80 (r 443 fr https), please include the prt number using the fllwing syntax: http[s]://<servername>[:<prt>]/ 2. Run applicatin pl as: This is the user accunt that the website will use fr accessing the database, server files, and resurces. This user accunt shuld already have access t the database(s) and server(s) that will be accessed and dcumented. This user shuld have database access that shuld include the ability t create, update, and delete tables, stred prcedures, and ther database bjects. Applicatin Pl Identity: An IIS cntrlled user accunt designed t have minimal permissins t nly the server that Wrkbench Server is being hsted n. 2. Netwrk Service: A built-in Windws user accunt that has limited netwrk permissins. Generally, the Netwrk Service accunt will nly have access t resurces n the same cmputer hsting Wrkbench Server. 3. User specified belw (Recmmended): A lcal r dmain user accunt created by the user r a system administratr that must have permissins t lcal and remte databases as well as lcal and remte resurces such as files and/r flders. The advantage t using a specific lcal r dmain user accunt is that it is easier t maintain and grant permissins t lcal and remte databases by system administratrs. 1. Imprtant Nte: The user accunt that Wrkbench Server Website's Applicatin Pl is authrized t use, whether it is the Applicatin Pl Identity, Netwrk Service, r Specific User, will dictate the ptin that will als be used fr BI xpress Server Website and DOC xpress Server Website's Applicatin Pls. If the websites are authrized t run as a specific user, unique users can still be selected fr each Applicatin Pl. If Wrkbench Server needs access t services, databases, r assets n any ther cmputer than the machine Wrkbench Server is being installed n, then a specific dmain user must be used by the Applicatin Pl Identities as well as the DOC xpress Data Handler Service.

5

6 6. On the "User and Administratin Database" page, setup the cnnectin infrmatin fr the database that will be used t stre the user and administratin infrmatin. When yu are dne reviewing the settings fr the current page, click "Next". Imprtant Nte: If users are planning n having the User and Administratin Database lcated n a different system than the Wrkbench Server website and the setting Windws Authenticatin is intended t be used, the Wrkbench Server Applicatin Pl cnfigured in Step 5 must be run using a dmain user accunt.

7 7. On the "BI xpress Server Website Cnfiguratin" page, if "User specified belw" was selected fr the Wrkbench Server Applicatin Pl n the "Wrkbench Server Website Cnfiguratin" page, then a different User name and passwrd can be input in here. Otherwise, click "Next".

8 8. On the "BI xpress Database" page, setup the cnnectin infrmatin fr the database that will be used by BI xpress Server fr use within the Mnitring Cnsle. When yu are dne reviewing the settings fr the current page, click "Next". Imprtant Nte: If yu are planning n having the BI xpress Database lcated n a different system than the Wrkbench Server website and yu wish t use Windws Authenticatin, the bth the BI xpress Applicatin Pl cnfigured in Step 7 and the Wrkbench Server Applicatin Pl cnfigured in Step 5 must be running using a dmain user accunt.

9 9. On the "DOC xpress Server Website Cnfiguratin" page, if "User specified belw" was selected fr the Wrkbench Server Applicatin Pl n the "Wrkbench Server Website Cnfiguratin" page, then a different User name and passwrd can be input in here. Otherwise, click "Next".

10 10. On the "DOC xpress Server Databases" page, this page details the settings n hw yu wish fr the DOC xpress Server meta data t be distributed. When yu are dne reviewing the settings fr the current page, click "Next". Imprtant Nte: If users are planning n having the DOC xpress Database lcated n a different system than the Wrkbench Server website and the setting Windws Authenticatin is intended t be used, the DOC xpress Applicatin Pl cnfigured in Step 9 must be run using a dmain user accunt. Single Database: If yu wish t stre all f the meta data in a single DOC xpress Server database, g t Step Multiple Databases: If yu wish fr yur meta data t be stred in up t fur separate databases, g t Step 10.2.

11 1. On the "Single DOC xpress Database" page, setup the cnnectin infrmatin fr the database that will be used t stre the DOC xpress Server meta data infrmatin. When yu are dne cnfiguring the settings fr the current page, click "Next".

12 2. On the "Multiple DOC xpress Database", setup the cnnectin infrmatin fr the databases that will be used t stre the DOC xpress Server meta data infrmatin. When yu are dne cnfiguring the settings fr the current page, click "Next". Cmmand Query Stre: The DOC xpress metabase that DOC xpress Desktp Applicatin users cnnect t in rder t manage and create snapshts and data dictinary categries. 2. Dictinary Query Stre: An ptimized database used t stre Data Dictinary cntent fr use within DOC xpress Server. 3. Generatr Query Stre: An ptimized database used t stre metadate regarding DOC xpress Server generated dcumentatin. 4. Brwser Query Stre: An ptimized database used t stre the structure f bjects fr use within DOC xpress Server. 1. Imprtant Nte: Fr management r scalability reasns, all database infrmatin can pint t the same database, shared databases between any number f DOC xpress Server database(s), r even separate databases fr each database required by DOC xpress.

13 11. On the "DOC xpress Data Handler Service" page, yu can cnfigure the DOC xpress Data Handler Service and hw yu wish fr the Service t lg n as. When yu are dne reviewing the settings fr the current page, click "Next". Imprtant Nte: The DOC xpress Data Handler Service is a service that runs in the backgrund and perfrms all f the DOC xpress dcumentatin generatin and prcessing. By default, this service shuld be running when the cmputer starts up and als after installatin. If the DOC xpress Data Handler Service is set t run as a specific user, that user must be cntained within the "Lg n as a service" lcal security plicy. Additinally, if dcumentatin is nt being generated, please ensure that this service is running and that the user accunt running the service has access t create, update, and delete tables, stred prcedures, and ther database bjects within the DOC xpress Server database(s) that were created in Step 10.

14 12. On the "DOC xpress Settings" page, cnfigure server paths t server directries. When yu are dne reviewing the settings fr the current page, click "Next". DOC xpress Templates Directry: This directry that cntains server templates that will be used t lend frm and reasn t the utput in DOC xpress Server. 2. DOC xpress Output Directry: This is the directry that will cntain all f the dcumentatin that is generated by DOC xpress Server. 3. CHM Cmpiler Applicatin Path: This is the path t the CHM Cmpiler that is installed n the server. 1. Imprtant Nte: Currently, DOC xpress Server nly supprts lcal flder lcatins fr the DOC xpress Output Directry. Withut the HTML Help Cmpiler applicatin (hhc.exe), generating CHM dcumentatin will fail.

15 13. On the "LegiTest Server Database" page, setup the cnnectin infrmatin fr the database that will be used t stre the LegiTest Server test suite histry and assemblies. When yu are dne cnfiguring the settings fr the current page, click "Install".

16 Imprtant Nte: Once the user clicks the "Install" buttn, Wrkbench Server will first begin dwnlading and installing the necessary sftware prerequisites. After installing the sftware prerequisites, Wrkbench Server will begin installing the necessary sftware. Once installatin has cmpleted, it may take several minutes while the server self cnfigures befre the website becmes peratinal. Please be patient during this cnfiguratin prcess. 14. Nw that installatin has cmpleted, the administratr needs t allw users and/r grups within IIS t access the hmepage f Wrkbench Server. Fine grained cntrl f users is handled within Wrkbench Server's administrative area. Imprtant Nte: Once the user clicks the "Install" buttn, Wrkbench Server will first begin dwnlading and installing the necessary sftware prerequisites. After installing the sftware prerequisites, Wrkbench Server will begin installing the necessary sftware. Once installatin has cmpleted, it may take several minutes while the server self cnfigures befre the website becmes peratinal. Please be patient during this cnfiguratin prcess. 1. Open IIS, right-click n the Wrkbench Server site, click Edit Permissins...

17 2. Navigate t the security tab. Click Edit Click Add...

18 4. Add any individual users and grups that need access t Wrkbench Server's hmepage. When finished, click OK fr all the remaining dialgs t clse them. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

19 Hardware Requirements Users can determine their hardware requirements based n their envirnment's deplyment mdel. LegiTest Server needs access t several databases in rder t functin. This creates tw deplyment scenaris: Single Machine: The same machine has bth Wrkbench Server and all databases that are necessary Multiple Machines: Wrkbench Server and the databases necessary are installed n separate machines Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

20 Single Machine In the single machine deplyment mdel, the same machine has bth Wrkbench Server and the databases installed. Wrkbench Server is the web applicatin that cntains LegiTest Server and its assciated assemblies while the databases are hsted within a SQL Server Instance. The fllwing memry and prcessr requirements apply t all editins f LegiTest Server: Requirements Cmpnent Minimum Recmmended Memry 4 GB At least 8 GB and shuld be increased as the LegiTest database size increases t ensure ptimal perfrmance Prcessr Speed 1.4 GHz 2.0 GHz r faster Prcessr Type Nt Applicable AMD Optern AMD Athln 64 Intel Xen with Intel EM64T supprt Intel Pentium IV with EM64T supprt Imprtant Nte: Hardware requirements can vary based n wrklads and ther prcesses. Running LegiTest Server n a virtual machine will be slwer than running natively because f the verhead f virtualizatin. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

21 Multiple Machines In the multiple machine deplyment mdel, Wrkbench Server and the databases are installed n separate machines. Wrkbench Server is the web applicatin that cntains LegiTest Server and its assciated assemblies while the databases are hsted within a SQL Server Instance. It is imprtant t differentiate between the Server machine and the Database machine: Server machine: the machine where Wrkbench Server is installed Database machine: the machine cntaining a SQL Server instance where the LegiTest database is deplyed The fllwing memry and prcessr requirements apply t all editins f LegiTest Server: Server Hardware Requirements Requirements Cmpnent Minimum Recmmended Memry 4 GB 6 GB Prcessr Speed 1.4 GHz 2.0 GHz r faster Prcessr Type Nt Applicable AMD Optern AMD Athln 64 Intel Xen with Intel EM64T supprt Intel Pentium IV with EM64T supprt

22 Database Hardware Requirements Requirements Cmpnent Minimum Recmmended Memry 4 GB At least 6 GB and shuld be increased as the LegiTest database size increases t ensure ptimal perfrmance Prcessr Speed 1.4 GHz 2.0 GHz r faster Prcessr Type Nt Applicable AMD Optern AMD Athln 64 Intel Xen with Intel EM64T supprt Intel Pentium IV with EM64T supprt Imprtant Nte: Hardware requirements can vary based n wrklads and ther prcesses. Running LegiTest Server n a virtual machine will be slwer than running natively because f the verhead f virtualizatin. Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

23 Sftware Requirements Befre installing LegiTest Server, make sure yu meet the fllwing system requirements: Internet Infrmatin Services (IIS) 7 r later with: Dynamic Cmpressin installed Windws Authenticatin installed and enabled.net r later installed PwerShell 3.0 r higher installed Access t SQL Server 2008 r later instance LegiTest Server needs access t a SQL Server 2008 r later instance t install the fllwing database: Wrkbench Server User and Administratin database LegiTest database The fllwing perating systems are supprted by LegiTest Server: 64-Bit (x64) Operating Systems: Windws Server 2008 Windws Server 2012 Windws Server 2016 Windws 7 Windws 8 Windws Bit (x86) Operating Systems: Windws Server 2008 Windws 7 Windws 8 Windws 10 The fllwing ptinal prerequisites are required t access sme resurces using LegiTest Server: Scheduling Test Assemblies MSTest Suites: Micrsft Visual Studi 2013 r Agents fr Micrsft Visual Studi 2013 NUnit Test Suites: NUnit Test Cnsle Any sftware requirements (SSIS, SSAS, et cetera) used by LegiTest needed t execute a deplyed test suite Brwser Supprt Supprted Web Brwsers Mzilla Firefx 29 r later Internet Explrer 8 r later Ggle Chrme 35 r later JavaScript must be enabled within the Web Brwser fr prper viewing f LegiTest Server Sftware Requirements fr ther Wrkbench Server prducts: The fllwing ptinal prerequisites are required t access sme resurces using BI xpress Server: Security Windws User accunt(s) that can be used t access databases, servers, and dcumentable bjects within the user's rganizatin SQL Server User accunt(s) t use fr accessing BI xpress Server databases Auditing Framewrk Each versin f SQL Server Integratin Services that the user wishes t apply the auditing framewrk t. Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s)

24 The fllwing ptinal prerequisites are required t access sme resurces using DOC xpress Server: Security Windws User accunt(s) that can be used t access databases, servers, and dcumentable bjects within the user's rganizatin SQL Server User accunt(s) t use fr accessing DOC xpress Server databases Dcumentatin CHM HTML Help Wrkshp and Dcumentatin The fllwing ptinal prerequisites are required t access sme resurces using DOC xpress Visual Studi Extensin Visual Studi 2012 Prfessinal Premium Ultimate Visual Studi 2013 Prfessinal Premium Ultimate Visual Studi 2015 Prfessinal Premium Ultimate The fllwing ptinal prerequisites are required t access sme resurces using DOC xpress Remte Agent 64-bit Operating Systems: Micrsft System CLR Types fr Micrsft SQL Server 2012 x64 Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Analysis Management Objects x64 Micrsft SQL Server 2012 Transact-SQL ScriptDm x64 Micrsft System CLR Types fr Micrsft SQL Server 2012 x86 Micrsft SQL Server 2012 Shared Management Objects x86 Micrsft SQL Server 2012 Analysis Management Objects x86 Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 32-bit Operating Systems: Micrsft System CLR Types fr Micrsft SQL Server 2012 x86 Micrsft SQL Server 2012 Shared Management Objects x86 Micrsft SQL Server 2012 Analysis Management Objects x86 Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 Prviders: Hive: 64-bit Operating Systems: 64-bit HrtnWrks Hive ODBC Driver 32-bit HrtnWrks Hive ODBC Driver 32-bit Operating Systems: 32-bit HrtnWrks Hive ODBC Driver Oracle: 64-bit Operating Systems: 64-bit Oracle Data Access Cmpnents (ODAC) 12c

25 64-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Operating Systems: 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC SQL: 64-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Shared Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x86 SSAS: 64-bit Operating Systems: Micrsft SQL Server 2012 Analysis Management Objects x64 Micrsft SQL Server 2012 Analysis Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Analysis Management Objects x86 SSAS Azure Analysis Services: Micrsft Azure Analysis Services Client Libraries SSIS: SSRS: Each versin f SQL Server Integratin Services (2005 r abve) that the user wishes t snapsht. SQL Server Data Tls r Business Intelligence Develpment Studi. Each versin f SQL Server Reprting Services (2005 r abve) that the user wishes t snapsht. SQL Server Data Tls r Business Intelligence Develpment Studi. Supprt prvided fr the fllwing reprt lcatins: File System: SQL Server 2005 and abve Native Web Services: SQL Server 2008 R2 and abve SharePint Web Service: SQL Server 2008 R2 and abve Infrmatica PwerCenter: If cnnecting t a SQL Repsitry: 64-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x64 Micrsft SQL Server 2012 Shared Management Objects x86 32-bit Operating Systems: Micrsft SQL Server 2012 Shared Management Objects x86 If cnnecting t an Oracle Repsitry: 64-bit Operating Systems: 64-bit Oracle Data Access Cmpnents (ODAC) 12c 64-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC 32-bit Operating Systems:

26 32-bit Oracle Data Access Cmpnents (ODAC) with Oracle Develper Tls fr Visual Studi 12c 32-bit Oracle 12c Managed Data Access Client installed int the GAC Created with the Standard Editin f HelpNDc: Easily create PDF Help dcuments

27 Required Permissins Many f the Applicatin Service accunts need db_wner. These accunts issue updates t the database that may alter the schema f the database. Belw is a cmprehensive list f each accunt and their required permissins. Applicatin Pl Identities: Wrkbench Server Applicatin Pl: User and Administratin database: db_wner LegiTest Server database: db_wner LegiTest Cmmand Line Executin and Task Scheduler: Lcal Security Plicy: Lg n as batch jb Any permissins (databases, reprt servers, file system, et cetera) required t successfully run a LegiTest Test Suite deplyed t the server BI xpress Applicatin Pl: BI xpress database: db_wner DOC xpress Server Applicatin Pl: DOC xpress database(s): db_wner DOC xpress Data Handler Service: DOC xpress database(s): db_wner SSRS Mnitring Cnsle: SSRS ReprtServer database(s): db_datareader Lcal Security Plicy: Lg n as a service DOC xpress Remte Agent Required Permissins Lcal Security Plicy: Lg n as a service Technlgy specific permissins: Hive Read permissins fr the HDFS files that yu wish t dcument Infrmatica View definitin permissins n the Infrmatica repsitry Read permissins within the Infrmatica repsitry n any flder and bject yu wish t dcument SQL Server Definitin permissins fr any bject yu wish t dcument

28 SQL Server Analysis Services Multidimensinal: Read definitin permissin n each database bject yu wish t dcument Tabular: Administratr permissin n each database bject yu wish t dcument SQL Server Integratin Services SSIS Catalg: Read and Mdify permissin fr each prject within the SSISDB the user wishes t analyze SQL Server 2008 R2 (r higher) Reprting Services Flder Security Settings: Minimum Predefined User Rles required: My Reprts Cntent Manager Minimum Tasks required fr a custm User Rle: View Reprts View Flders View Data Surces View Mdels Cnsume Reprts Web Service Security Settings: Minimum Predefined System Rle required: System User Minimum Tasks required fr a custm System Rle: Execute Reprt Definitins Oracle Permissins Cnnect permissins n any schema that yu wish t dcument Tableau Permissins User must be a part f the Server Administratr rle Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

29 Managing Yur Server T manage yur Wrkbench Server and DOC xpress Server, click n the gear icn lcated at the tp right f the navigatin bar t access the System Settings. This will bring yu t the System Settings page where yu can manage everything within Wrkbench Server. The system settings are divided int different pages: Table f Cntents Rles Users Actins Securables Features License Imprtant Nte: Only users wh have been assigned a rle that is a part f the "Administratin" actin will have access t the Web Administratin prtin f Wrkbench Server. Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

30 Rles Within Wrkbench Server's administratin page, the rles page allws yu t create, edit, r delete rles that will dictate what actins users can and cannt take as well as what securables they can view within Wrkbench Server. Table f Cntents Viewing Rle Members Adding Users t Rles Remving Users frm Rles Create a New Rle Edit / Delete a Rle Viewing Rle Members When managing yur rles, yu can add and remve users frm a rle by first clicking the rle yu wish t manage. If yu click n a rle such as Administratrs, yu will be able t view a list f all users that are assigned t that rle, their display name, date jined, and last lgin time. Yu will be able t edit the assignment f this rle frm this page as well.

31 Adding Users t Rles Yu can add users t a specific rle by clicking the "Add users t..." buttn. This extends the pane t allw yu t search fr users t add t the rle. If yu d nt type anything int the search bar, yu will be able t search a list f all users that have access t Wrkbench Server. T add the user(s), click the check bx next t their name and then click the "Add users..." buttn next t the search bar.

32 Remving Users frm Rles Yu can remve users frm a specific rle by clicking the check bx next t each user that yu wish t remve and then clicking the "Remve users frm..." buttn. Create a New Rle T create a new rle, simply click the "Create new rle" buttn at the tp f the Rles page. Ding s will add a new rw within the Rles table that includes a text bx in which t name the rle. Yu may als select this t be the new default rle frm which new users will autmatically be assigned t.

33 Once yu have prvided a name fr the new rle, click update t add the rle t the list f rles. Edit / Delete a Rle T edit a rle, click the edit buttn next t the name f the rle yu wish t edit. This will bring up the naming bx again fr editing and will allw yu t specify the rle as the default rle. Once dne editing, click update buttn t update the changes. T delete a rle click the delete buttn. Once yu click the delete buttn, a warning will appear prviding yu with the impact f deleting the rle will have n Wrkbench Server. T cnfirm deletin, click the delete buttn, therwise, click the cancel buttn.

34 Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

35 Users The user page helps manage a list f all current users that have accessed Wrkbench Server. It als allws the manual adding f dmain users t Wrkbench Server. Frm here administratrs can add r delete users frm Wrkbench Server. By default, Wrkbench Server autmatically adds users the mment they brwse t the server URL. T delete a user, click the delete buttn next t the crrespnding user. T cnfirm deletin, click OK, therwise, click the cancel buttn. Administratrs can manually add users t the server using the "Add Dmain Users" buttn.

36 Frm here, administratrs can filter and select any dmain user they wish t include. Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

37 Actins Within Wrkbench Server's administratin page, the actins page prvides a list f predefined actins fr each f Wrkbench Server's Features that details what each rle can and cannt perfrm. The main actins page lists the actins, what feature it pertains t, and a descriptin f that actin. Table f Cntents Adding Rles t Actins Deleting Rles frm Actins By clicking n an actin, it will take yu t that actin's page. Frm that page yu can add r remve rles assigned t the actin. By adding a rle t that actin, yu are granting that rle permissin t perfrm that actin. Remving a rle frm an actin prevents that rle frm perfrming that actin.

38 Adding Rles t Actins Yu can add rles t a specific actin by clicking the "Add rles t..." buttn. This extends the pane t allw yu t search fr rles t add t the actin. If yu d nt type anything int the search bar, yu will be able t search a list f all rles that have been created n Wrkbench Server. T add the rle(s), click the check bx next t their name and then click the "Add rles..." buttn next t the search bar. If successful yu shuld see a cnfirmatin message and the rle will nw appear in the list f rles assciated with that actin. Deleting Rles frm Actins T remve a rle frm an actin, simply check the rle and click the "Remve rles frm..." buttn. Yu will see a cnfirmatin, and the rle will n lnger be in the list.

39 See the Rle Based Security page fr cnfigurable permissins. Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

40 Rle Based Security Belw is a list f all cnfigurable permissins that can be used in LegiTest Server: Create Cverage Reprts - Allws the user t create a cverage reprt. Dashbard - The LegiTest Dashbard allws users t see a quick glimpse f their test results. Delete Assemblies - Allws the user t delete pushed assemblies. Delete Cverage Reprts - Allws the user t delete cverage reprts frm the server. Edit Anntatin Types - Allws the user t edit anntatins types n the server. Edit Testable Paths - Allws the user t edit testable paths fr system cverage. Manage Parameters - Allws the user t edit assembly parameters. Manage Tag Permissins - Allws the user t manage permissins based n rles and tags. Manage Test Item - Allws the user t access the test management page. Run Hierarchy - Allws the user t acces the test run hierarchy. Run Histry - Allws the user t acces the run histry f a test item. Run Tests - Allws the user t run tests frm LegiTest Server. Schedule Tasks - Allws the user t schedule a test suite t be ran autmatically frm the windws task scheduler r t edit an existing scheduled task. System Cverage - Allws the user t access the System Cverage page and view a list f available reprts. Tag Items - Allws the user t tag a test item. Untag Items - Allws the user t untag a test item. Update Anntatin Message - Allws the user t edit the anntatin message n the server. View Cverage Reprt - Allws the user t view an available Cverage Reprt. View Run Details - Allws the user t view specific details and results f a test run. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

41 Securables Within Wrkbench Server's administratin page, the securables page prvides users with a mre granular level f cntrl ver what each rle can and cannt see within a DOC xpress slutin and currently is nt applicable within LegiTest Server. Created with the Standard Editin f HelpNDc: Easily create EBks

42 Features The features page will list all installed Wrkbench Server prducts. Administratrs will be able t allcate users, see the versin, whether it is r is nt a trial, and disable r enable beta features. Frm here yu can click n a feature t view all users that are currently cnsuming a user-license fr that particular feature. By default, Wrkbench Server will hand ut licenses t users wh lg in until all userlicenses have been cnsumed. Sme features may still be in a beta. By default, thse features will be disabled. T enable beta features fr general use within Wrkbench Server, click the enable buttn. Adding Users t a Feature Administratrs can add users t a specific feature by clicking the "Add users t..." buttn. This extends the pane t allw searching fr users. Leaving the search bar blank allws users the ability t search a list f all users that have access t Wrkbench Server. T add the user(s), click the check bx next t their name and then click the "Add users..." buttn next t the search bar. Imprtant Nte: When new features are installed t yur Wrkbench Server server, users will autmatically be added t the freshly installed Feature frm the Default Rle. If n rle is currently set as the Default Rle, users frm the Administratin Rle will be autmatically added instead. Remving Users frm a Feature

43 Yu can remve users frm a specific feature by clicking the check bx next t each user that yu wish t remve and then clicking the "Remve users frm..." buttn. Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

44 License Frm within Web Administratin, the license page allws users t see all licenses assciated with Wrkbench Server. Users will see the license name, issued date, expiratin date, maintenance expiratin date, number f users, and if it is r is nt a trial. Users can als add a license, view details f a license, r update a license frm this page. Imprtant Nte: Only users wh have been assigned a rle that is a part f the "Administratin" actin will have access t the Web Administratin prtin f Wrkbench Server, which is where License infrmatin can be fund. Table f Cntents Autmatically Activate a License Manually Activate a License License Detail Deactivate a License Autmatically Activating a License If yu already have an activatin key and the server where Wrkbench Server is installed n has Internet access, then yu shuld be able t autmatically activate Wrkbench Server. 1. Frm within the License page, click "Add a new License" t begin the prcess f autmatically activating yur installatin f Wrkbench Server 2. Place yur Activatin key within the text bx and then click the "activate nline" buttn t autmatically activate yur license f Wrkbench Server Feature.

45 Manually Activating a License If yu require the assistance f the Pragmatic Wrk's Supprt Staff in rder t receive yur license r the machine yu installed Wrkbench Server des nt have Internet access, yu may need t manually activate yur license f Wrkbench Server Feature. 1. Frm within the License page, click "Add a new License" t begin the prcess f autmatically activating yur installatin f Wrkbench Server. 2. Click the "activate manually" buttn. If yu chse t activate manually, cpy the Envirnment Identifier, Envirnment Key, alng with yur Activatin Key, and the infrmatin t supprt@pragmaticwrks.cm. 3. Once a Pragmatic Wrks Supprt Representative has prvided yu with yur license blck, paste the license blck int the license blck text bx and click the "apply license" buttn t manually activate yur license fr the currently selected Wrkbench Server feature. License Detail Clicking n a license's details buttn will prvide yu with further infrmatin abut the license currently activated n the server. Frm here, yu can update (autmatically), manually update, r deactivate yur license.

46 Deactivating a License If yu plan t migrate Wrkbench Server frm ne machine t anther and have already activated yur license n the ld machine, yu will need t first deactivate yur license n the ld machine Frm the License page, click n the "details" buttn next t the crrespnding feature yu wish t deactivate. Click the "deactivate" buttn at the bttm f the page t begin the deactivatin prcess. Within the cnfirmatin text bx, type "YES" and then click the "remve license" buttn t cnfirm deactivatin and remve the license frm this machine.

47 Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

48 Features When the user first enters LegiTest Server, they will be brugh t the Dashbard. This view allws the navigatin f all tests starting frm the very tp, the cntaining assembly, t the very end f any given test. This view will shw a glimpse f the amunt f tests that failed r succeeded in it's last run. This is als where the ntificatins fr these items can be set. Table f Cntents Dashbard Server Testing System Cverage System Dashbard 1. Using the LegiTest Visual Studi Extensin, users create test suites. 2. Users can cnfigure test suites t publish its results and assemblies t a LegiTest Server. 3. Frm the server, users can cnfigure and run published test suites. These scheduled test executins will, in turn, publish their results back t the server. LegiTest Server Architecture

49 Created with the Standard Editin f HelpNDc: Free help authring envirnment

50 Summary With a quick glance at the name f the test bject, a user can see it's status frm the last run by lking at the symbl next t it. On the right side f the table, Pass/Fail data frm the last run is als summarized s a user can see hw many items passed r failed. Table f Cntents Ntificatins Tagging Test Objects Viewing Grid Asserts On the far right, there is an icn, clicking will allw the user t add a ntificatin t the BixPress Server's Ntificatin Engine. When a user clicks n a test bject they will be brught t run histry page, unless the item they click is a Test. Clicking a Test will either bring the user t the details page f the first failed assert if applicable, r the run details page if the Test is part f a Data Driven run. This will allw the user t quickly see all tests run while data driven.

51 Frm here, a user can then get further detail n any particular run by either clicking n the run in the graph r the data table. The run detail page will shw the entire test tree frm the pint selected. A user can quickly see what items passed r failed frm this page fr that particular run. If an item has mre detailed infrmatin t view, such as an assert, r an errr fr that particular step was thrwn, a "View Details" link will be accessible fr that item. Viewing a cmpleted assert will take yu t a

52 page shwing what the assert was cmparing, it's actual and expected result, and if it had passed r failed. This view als shws the user any parameters that were used if it was a data driven run. Viewing a failed item will allw the user t view the errr thrwn as t get further insight int what went wrng with the test step. Viewing unexecuted assemblies: The summary page has tw views. The first, and default is the Summary view. The secnd view, is the Unexecuted Assemblies view. This view will list all assemblies that have been pushed t the server, but have yet t be executed. Users can execute these tests frm this view, and nce cmplete, their results will be pushed ver the Summary view and remved frm the Unexecuted Assemblies view.

53 Created with the Standard Editin f HelpNDc: Easily create Web Help sites

54 Ntificatins The Quality Dashbard can als be used as a shrtcut t adding a ntificatin t the Ntificatin Engine that is triggered by a test bject. T start, click n the icn n the far right f the test bject yu want t add a ntificatin fr. This will bring up the add and remve ntificatin menu. Click "add ntificatins". This will initiate a pp fr enrlling in ntificatins. On this pp up, yu will be able t set the name f the ntificatin, the event name that triggers the ntificatin, and the severity f the ntificatin. Once dne click enrll, this test bject is nw enrlled in ntificatins.

55 Created with the Standard Editin f HelpNDc: Create iphne web-based dcumentatin

56 Tagging Test Objects LegiTest Server allws a user t add custm tags t any test bject n the dash bard. These tags are searchable enabling the user t shw all bjects tagged with the desired filtering tag. Fr a user t tag a test bject, they must use the test management page fr the test bject they wish t tag. See mre here. Filtering By Tag T filter the summary page, and shw nly items by a specified tag, a user can simply click n any visible tag n the summary page. Alternatively, the user can use the search bar n the summary page. This will display all tags matching the specified search term, and then allw the user t click n any tag in the search results. Once a tag is selected, the user will see which tag is being displayed under the search bar. The ptin t remve the filter will als be visible there as well. Created with the Standard Editin f HelpNDc: Easily create HTML Help dcuments

57 Viewing Grid Asserts If an assert cntains a grid cmparisn r validatin, any errrs will be pushed t the server fr the user t view as a grid. The failed rws will be highlighted in red, and rws that are nt equal but within a set tlerance will be highlighted in yellw. Users can als exprt the table t Excel by clicking the "Exprt t Excel" buttn abve the desired grid. This will save the table as an ".xls" file that can be pened in Excel. Sme users may see a warning stating "The file frmat and extensin dn't match". The file will pen fine as lng as the user clicks yes. Users can als click the Switch View buttn t view the expected and actual grids side by side instead f as ne grid.

58 Users can add hyperlinks t their grid asserts. Click here fr mre infrmatin. Created with the Standard Editin f HelpNDc: Free iphne dcumentatin generatr

59 Grid Asserts Hyperlinks Grid Asserts Hyperlinks Users can add hyperlinks t help manage test(s) the grid/validatin assertin belngs t. Fr grid cmparisns, users can add a hyperlink per side (actual and expected hyperlink.) Validatin grids have nly have ne hyperlink. T access the Edit Hyperlinks page, drill dwn t the test and click the wrench icn. The user is presented with the Manage Test page and presented with the Edit Hyperlink ptin at the bttm.

60 After Edit Hyperlinks is clicked, the cnfigurable ptins will appear:

61 Nte: Grid cmparisns will have ne hyperlink per side (actual and expected.) Hwever, validatin grids will nly have ne hyperlink. Bth are cnfigured in the same manner. Clumn Name - Identifies the name a user wishes t call the clumn. Link - Creates the fully qualified link fr users t click. The DtLiquid syntax can be used. Text - Identifies the text t be displayed fr the hyperlink. DtLiquid may als be used t display a clumn. If DtLiquid is used fr an bject that des nt exist, the user will nt see a return as it is an empty string. Fr mre infrmatin abut DtLiquid syntax, please see their page at Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

62 Delete Tests Users can add Assemblies t the trash view f the summary page, and frm there chse which test bjects can be deleted permanently. When viewing the Summary page n LegiTest Server users will be able t see a blue trash icn. This icn will mve the Assembly t the trash view. After mving the assembly ver t the trash. The user will be able t see tw ptins: Mve Back and Delete. Mve back will mve the assembly and all children back t the summary page fr standard viewing. Delete, which is available n all test bjects, will permanently delete test bject and all f that bject's runs. This will als remve all f that bject's children and their runs as well. The Empty Trash buttn will permanently delete ALL test bjects in the trash view, alng with their runs. Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

63 Manage Tests The "Manage Tests" is accessed by clicking the wrench icn frm the LegiTest Server Dashbard. Manage Tests Frm this view, users can d the fllwing: View Run Histry - A buttn that takes users t a Cverage Tests page. This page displays runtime graphs and ther infrmatin abut past test runs. View Latest Run - A buttn that takes users t a Cverage Tests page. This page that displays details and results frm the last run f the selected test. Delete Assemblies Frm Server - This ptin will remve assemblies frm the server and prevent future tests frm running. Users will have t push the assemblies frm their client. Fr mre infrmatin abut pushing assemblies, see Publishing Assemblies. Schedule New Tasks - Users can create, edit, and delete test runs. Cllck the Schedule New Tasks

64 buttn at the tp f the table t create a new task. Click the pencil icn t edit and the trash can t delete. Parameters - Parameters created in the LegiTest client are visible in this sectin. Althugh the parameter names cannt be edited, their cntents can. Click Save after changing the infrmatin t save. Click the "Save and Run" buttn t save and run the test using the new cnfiguratin. Tags - Users can add and delete markers r "Tags" that add meaningful infrmatin t tests. T add a tag, enter the tag name int the text bx labeled "New Tag" and click the Add Tag buttn. Ntificatins - Displays the LegiTest Server ntificatins cnfigured in BIxPress's ntificatin engine. (Such as ing a user n a failed test.) Clicking the play icn will send the ntificatin. Navigatin The navigatin menu t the left, will als shw the user at quick glimpse the latest status fr that test bject. Clicking any f these links will bring the user t the management page fr that item. This navigatin menu will nly shw items within the same assembly. Tagging Tagging a test bject will allw the user t label their test bjects with custm tags. These tags can be used n the Summary page fr filtering, and n the Tag Permissins page fr setting permissins fr individual items. In the Tag sectin, a user can select frm exisitng tags n the server via the drpdwn, r enter the name fr a new tag.

65 Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

66 Server Testing With LegiTest and LegiTest Server a user will be able t launch tests upladed t the server with a simple click n the LegiTest Quality Dashbard. Any upladed test suite can als be scheduled t run n a schedule with LegiTest's cmmand line. Table f Cntents Publishing Assemblies Running Test Assemblies Scheduling Test Assemblies Created with the Standard Editin f HelpNDc: Full-featured EPub generatr

67 Publishing Assemblies Befre a user will be able t run r schedule tests frm the server, they must first push the assemblies f the test t the server. When a user is expecting t run tests frm the server, they must ensure they have added references t all used dlls. T push test assemblies t the server: Right click the prject yu wish t push t the server. Click "Publish t LegiTest Server". 3. This will pen up the publish t server windw: With this windw, we will be able t specify hw and where t publish the assemblies and results.

68 Target - The target will either be an existing LegiTest Server such as " r it can be a flder n the system. Setting the target as a LegiTest server instance will allw the user t run the tests frm the server. Results Mde - The result mde will alw a user t set all, sme, r n suites t be published. The ptins are as fllws: Set all suites t publish results - As the name suggest, this will change the publish results parameter t true fr all suites in the current prject. Set all suites nt t publish results - This will change the publish results parameter t false fr all suites in the current prject. D nt change suite settings - This will keep all publish results parameters set t what they are currently at, allwing a user t specify which suites will publish results. Remve suites settings t inherit glbal cnfiguratin - This will ignre all suite specific parameters fr publishing, and use a parameters file lcated in the cmmn area. Results Server - The server in which t publish results t. Cnfiguratin - Allws the user t specify if the Release r Debug cnfiguratin shuld be pushed t the Target lcatin. Run tests immediately after publish - This ptins will run the pushed assemblies frm the server nce the assemblies are pushed t the server. If left unchecked, the assemblies will still be pushed t the server, but will nt have any run assciated with untill it is manually run frm the server r client. Once these settings are selected and the user clicks k, the required parameters fr publishing will be updated and the assemblies will be pushed. This allws the users a very flexible way f chsing the lcatin f all assemblies and results, and managing a prject with multiple suites. Publishing Assemblies with the LegiTest CmmandLine User's can als push assemblies using the included LegiTest CmmandLine tl. T d s, the fllwing switches must be used: -lh: This will be the server in which t push the assemblies. -ma: This is the path t the main assembly. This assembly will be the ne used t execute tests when ran frm the server. -af: This is the path t the flder that cntains the assemblies t be pushed. This will be all assemblies required by the main assembly t run succesfully. Example: -lh "lcalhst" -ma "C:/TPublish/LegiTestPrject.dll" -af "C:/TPublish" Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

69 Running Test Assemblies LegiTest server gives the user the ability t run a LegiTest Assembly frm the LegiTest dashbard. When the user lgs int LegiTest and views their LegiTest dashbard they will ntice that the tp level items marked as Assemblies will have tw icns beside its name. The first buttn, the green play buttn, will launch that test suite, the secnd, the green calendar, will allw a user t schedule the assembly t be run at a later time. Once a test assembly is run, a ntificatin will pp up at the tp shwing that the run was succesfully started, nce finished the user will see either a success r failure message appear as well. Upn a succesful run, the user will be able t see the run infrmatin in the test runs view upn drilling int the assembly as nrmal. Created with the Standard Editin f HelpNDc: Free PDF dcumentatin generatr

70 Cmmand Line If Wrkbench Server was nt installed in the default lcatin, r the installatin is later mved, the user will need t update the cnfiguratin file fr LegiTest Cmmand Line. This cnfiguratin file is lcated by default at: C:\Prgram Files (x86)\pragmatic Wrks\Wrkbench Server\LegiTest Cmmand Line\PragmaticWrks.LegiTest.CmmandLine.exe.cnfig The sectin that will need updating will lk like this: <appsettings> <add key="nunittestrunnerlcatin" value="%prgramfiles(x86)%\nunit 2.6.3\bin\nunit-cnsle.exe" /> <add key="mstestrunnerlcatin" value="%prgramfiles(x86)%\micrsft Visual Studi 12.0\Cmmn7\IDE\CmmnExtensins\Micrsft\TestWindw\vstest.cnsle.exe" /> <add key="schtasks.exe" value="%windir%\system32\schtasks.exe" /> <add key="legitestcmmandline" value="%prgramfiles(x86)%\pragmatic Wrks\Wrkbench Server\LegiTest Cmmand Line\PragmaticWrks.LegiTest.CmmandLine.exe" /> </appsettings> The value fr each respective key will need t be changed if any f the fllwing scenaris ccur: NUnitTestRunnerLcatin A different versin f NUnit is being used. the installatin f NUnit is mved. MSTestRunnerLcatin A versin ther than Visual Studi 2013 is being used. The installatin f Visual Studi 2013 is mved. LegiTestCmmandLine The default lcatin fr Wrkbench Server is nt used. The installatin f Wrkbench Server is mved. Fr Cmmand Line Switches, click here. Created with the Standard Editin f HelpNDc: Easily create EPub bks

71 Cmmand Switches LegiTest Server can perfrm many actins with the cmmand line tl. The tl is fund in the directry C:\Prgram Files (x86)\pragmatic Wrks\Wrkbench Server\LegiTest Cmmand Line. Duble-click the file PragmaticWrks.LegiTest.CmmandLine.exe. Actins -ArgsFrServer, -la Args f fr server initiated run, used fr server. -AssemblyName, -an Name f Assembly t run frm server. -DllLcatin, -d Lcatin f the test suite assembly. -Help, -h Displays the help text. -Hst, -lh Hst server -MsTestLcatin, -ml MSTest Lcatin. -NUnitLcatin, -nl NUnit Lcatin. -Server, -ls Used by LegiTest Server Scheduler -TestGrup, -tg Specifies which Test Grups t run, separated by a cmma. -UniqueIdFrServer, -li UniqueId f TestSuite, used fr server. -MainAssembly, -ma Used when pushing assemblies t the server. This will be the path t the executing assembly, and stred as the entry pint n the server. -AssemblyFlder, -af Specifies a flder cntaining the assemblies t push t the server. All files in this flder will be cmpressed and pushed t the server. Runners: -MsTest, -m -NUnit, -n Enable fr MSTest. Enable fr NUnit. Created with the Standard Editin f HelpNDc: Free help authring envirnment

72 Scheduling Test Assemblies If the user wishes t have their Test Assemblies run n a schedule, then they can click the green calendar buttn by the assemblies name in the LegiTest dashbard. This will bring the user t the scheduling page. Once dne scheduling, the user will be brugh back t the LegiTest Dashbard. Task Name - This will be the name assigned t the task within Windw's Task Scheduler. Server - The name f the server this will be run n, the default is lcalhst. User - The Windws user in which the task is run under. Passwrd - The passwrd fr the Windws username supplied previusly. Start Date - This will be the first date in which the task is run. Start Time - At what time f day is the task t be run, in 24 hur frmat. Interval - Set whether t run every hur, every day, every week, r every mnth. This interval will start frm the supplied start date and start time. Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

73 System Cverage The System Cverage integratin allws users t quickly see if certain parts f their system has been tested, and if s, the status f thse tests. System Cverage rules are set by the user, therefre the rules are nt enfrced by LegiTest. Table f Cntents Getting Started Search Testable Objects Edit Testable Paths Created with the Standard Editin f HelpNDc: Prduce Kindle ebks easily

74 Getting Started T get started with the System Cverage feature f LegiTest, pen a LegiTest suite in Visual Studi. Once pen, we need t g t the Server Integratin nde. Here, enter in the address f the server that cntains the installatin f Wrkbench Server. This will give access t the Dc xpress metabase, which is what ur reprt will be built frm. Once a server has been setup. We can then visit the System Cverage nde. Here we will select a test, in this example we have a SQL Cmparisn, cmparing tw tables within the same database. The database being tested is called GridStuff, and the tw tables are Grid1 and Grid2.

75 In the Dc xpress search sectin, we typed in GridStuff, as we want t specify that this specific test is respnsible fr representing the "health" f the GridStuff bject. T d this, we will highlight GridStuff, and click the "Add" buttn t add it t this test. Once yu have the items yu want represented by this test, we will save the prject. Be sure that n the server integratin page that "Push results..." is checked. Once saved, we will run the test and then visit

76 the server t create a reprt that includes this item. T access the System Cverage n the server, first visit the LegiTest Server dashbard. Frm there, yu will see System Cverage in the navigatin bar. Clicking n System Cverage will bring yu t the Reprts dashbard. Here, if there any reprts available, yu will be able t see a list f them, and select the reprt yu wish t view. Fr nw, lets click the "Create Reprt" buttn t begin creating ur first reprt.

77 ON the create reprt page, we will need t prvide a name fr the reprt. Once prvided, use the search bar t search the Dc xpress metabase fr items we can add t the reprt. Fr the dem, GridStuff was added, since we knw that the GridStuff item was added t a test. This nw becmes a reprt item in the reprt. When an item is added, the reprting fr that item starts at the Path level fr it, and then calculcates dwnward. We will see hw that wrks after ur reprt is created. Fre this example I will als add the \Databases path as a reprt item as well. Once all items yu desire t be in the reprt are added, we can then create the reprt.

78 Once the reprt is created, we are taken t the reprt page. On this page, the tp reprt item will be the ttal f all items added t the reprt nt pictured). The secnd graph shwn is fr the GridStuff item we added. We can see that since the test failed that represented the GridStuff item, the entirety f it's path is cnsidered failed. The secnd reprt item, Databases, shws a percentage f failurs, passes, and nt tested items. In tests that were nt shw in the setup, there were sme tests that tested the health f AdventureWrks, thse tests passed, therefre we see sme passes fr items under the Databases path, and failures, which represent the GridStuff test added fr this example.

79 These graphs are a quick way t view the status f yur envirnment. In rder t a get a mre detailed view thugh, in the tp right f the reprt, we can click "Tree View" t switch t a drillable view. Here we can drill int a path t see where these failures and passes ccured.

80 During reprt creatin, yu can chse which view t default t. By checking the "Default t Tree View" ptin abve the "Create Buttn", the reprt will be pened t the tree view each time instead. Created with the Standard Editin f HelpNDc: Easily create Help dcuments

81 Search Testable Objects A user may use the Search Testable Objects page t quickly find the latest status f a testable bject. This prevents the user frm needing t create a reprt, and then pening the reprt fr just a single item. The search functin wrks similar t the search n the Create Reprt page, as it als searches the Dc xpress metabase. This enables the user t quickly find ut if the bject was tested, and if s, if it passed r failed, r if its previuls test was incnclusive. Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

82 Edit Testable Paths The Edit Testable Paths page allws the user t manage what paths are tested. Initially, mst well knwn paths are added. If a user has need f mre paths t be tested, such as custm paths, then they will be able t add them n this page. Created with the Standard Editin f HelpNDc: Easy t use tl t create HTML Help files and Help web sites

83 System Dashbard Items frm the LegiTest Server's system cverage can be added t the Wrkbench Server System Dashbard. Table f Cntents System Dashbard Settings T add a LegiTest System Cverage tile t the System Dashbard, click the System Dashbard lcated at the tp navigatin bar frm the hme page. This will bring users t the System Dashbard page where the tiles can be viewed. Clicking ne f the actin icns in the dashbard pane, users can perfrm the fllwing actins: Infrmatin - Users can tggle their view f the text lcated between the Wrkbench Server and tl icns. Refresh - Updates the dashbard view with the mst current data. Edit Dashbard - Takes the user t the System Dashbard Settings page t cnfigure the dashbard. Users can rearrange the rder f tiles by dragging and drpping them within the page. Created with the Standard Editin f HelpNDc: Easily create Qt Help files

84 System Dashbard Settings Table f Cntents System Cverage This page allws users t create, edit, and delete tiles t be used in the System Dashbard. T add a LegiTest System Cverage tile t the System Dashbard, click the select bx titled "Select tile t add t yur dashbard..." and chse Legitest System Cverage. Next, click the "+ Add Tile" buttn and the brwser will lad the LegiTest System Cverage cnfiguratin page. Imprtant Nte: Please see the BIxPress Server help dcumentatin fr mre infrmatin abut the ther tiles that can be added t the System Dashbard. Created with the Standard Editin f HelpNDc: Free Web Help generatr

85 System Cverage In the Add New Tile - LegiTest System Cverage page, users can cnfigure the fllwing: Name: Displays the name f the tile n the System Dashbard Descriptin: Users can prvide helpful infrmatin fr the tile. (Descriptins will nly be visible in the System Dashbard Settings page but nt n the dashbard.) Tag Name: Users can filter the system cverage tests based n an assigned tag within LegiTest Server. Include Partial: When "Yes" is selected, the tile will display cverage f partial runs f a test assembly. If "N" is selected, nly the mst recent full run will be cvered. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

86 Frequently Asked Questins Frequently Asked Questins Wrkbench Server Frequently Asked Questins Managing Yur Wrkbench Server Server thrugh Administratin Hw d I activate r upgrade my installatin f Wrkbench Server? Hw d I cnfigure a custm user accessible URL fr use with Wrkbench Server? Hw d I deactivate my installatin f Wrkbench Server? Hw d I manage my user accunt infrmatin? What are the system requirements fr Wrkbench Server t wrk prperly? Wrkbench server Multi-dmain Cnsideratins LegiTest Server Frequently Asked Questins Using LegiTest Server with AlwaysOn High Availability Grups LegiTest Server cannt find MSTest r NUnit test runner Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

87 Custm User Accessible URL Custm User Accessible URLs By default, Wrkbench Server's setup instructins require either the machine name r the fully-qualified machine name t be used as the user accessible URL fr which users will type int their web brwser's address bar in rder t access Wrkbench Server. If the user wishes t use a custm user accessible URL, this wuld require additinal cnfiguratin pst installatin in rder fr it t wrk. Imprtant Nte: The fllwing cnfiguratin steps are designed fr basic custm user accessible URLs within an intranet and shuld nly be attempted by dmain and web administratrs. Pragmatic Wrks is nt respnsible fr any issues that may ccur due t mdificatins t yur rganizatin's DNS. 1. Fllw the Setup Instructins fr Wrkbench Server. Make sure the user accessible URL and hst name are set t the default value as set within the installer. Everything else within the setup instructin can be custmized as per the user's envirnment.

88 2. Once Wrkbench Server has been installed, n the hst server, launch Internet Infrmatin Services (IIS) Manager 3. In the Cnnectins panel, expand the Sites nde and then select the Wrkbench Server site. Depending n the settings the user cnfigured during installatin, the site's name may be different then what is shwn belw

89 4. In the Actins panel, click the "Bindings..." actin t pen the Site Bindings dialg bx 5. In the Site Bindings dialg bx, click the "Add..." buttn t launch the Add Site Binding dialg bx 6. In the Add Site Binding dialg bx, type the hst header that the user wishes t use t cnnect within the Wrkbench Server then click OK 7. Once all f the site bindings have been cnfigured, within the Manage Website prtin f the Actins panel, click "Restart" t restart the Wrkbench Server site 8. Once Internet Infrmatin Services (IIS) Manager has been cnfigured, cnnect t the intranet DNS Server 9. On the DNS Server, launch Server Manager

90 10. In the Server Manager snap-in, frm the cnsle tree in the left pane, expand the DNS Server name 11. Frm the expanded list, duble-click n Frward Lkup Znes Frm the displayed znes list, click n the DNS zne that cntains the hst server that Wrkbench Server is installed n Once selected, right-click the DNS zne and select "New Alias (CNAME)..." Within the New Resurce Recrd dialg bx, use the alias name cnfigured in Step 6 and use the fully qualified machine name that Wrkbench Server was installed n as the target hst then click OK

91 Frm there, Wrkbench Server shuld nw be cnfigured t use a custm user accessible URL. In sme rare cases, if the user still cannt cnnect, they may need t flush their DNS Reslver Cache. T flush the DNS Reslver Cache, users shuld fllw the belw steps 1. Launch Cmmand Prmpt 2. Type the fllwing cmmand within the Cmmand Prmpt windw and press Enter ipcnfig /flushdns Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

92 Managing User Accunt Infrmatin Managing User Accunt Infrmatin T access the Manage Accunt page, click n the prfile icn in the tp right f the navigatin bar, and then select yur user name. This will bring yu t yur accunt page. On this page yu will see at the tp yur Rle memberships. This lists all rles assigned t yu. Belw that yu can update yur prfile. Yu may change yur display name as well as yur bigraphy. Once yu update click save, and yu will see a green saved message at the tp f the page.

93 Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

94 Multi-dmain Cnsideratins Multi-Dmain Cnsideratin Imprtant Nte: Pragmatic Wrks Sftware des NOT prvide supprt nr d we suggest these scenaris Almst all f the mdificatins require altering perating system, Internet Infrmatin Services, and dmain settings. Prceed with cautin and always make a backup befre mdifying anything. The methds described belw are fr advanced IT administratrs wh are cmfrtable with and have been allwed t alter any required settings and/r security prtcls. These helpful hints are nly fr illustrative purpses and each envirnment will have its wn unique requirements and hurdles. Wrkbench Server is a rbust sftware suite that can span multiple assets within an rganizatin, even thse that lie n different Micrsft Windws Dmains. Belw are sme helpful hints and recmmendatins fr implementing a multi-dmain installatin. Wrkbench Server and SQL Server Databases are in different dmains - Hsting the Wrkbench Server within a dmain ther than the SQL Server databases can be accmplished using Windws Authenticatin r SQL Authenticatin, assuming that necessary firewalls and prts have been pened and allwed t cmmunicate. Users and Wrkbench Server are in different dmains - If users are in a different dmain than the Wrkbench Server cmputer, then trust between dmains need t be established. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

95 Wrkbench Server / SQL Databases Wrkbench Server / SQL Databases in Different Dmains Imprtant Nte: Pragmatic Wrks Sftware des NOT prvide supprt nr d we suggest this scenari Almst all f the mdificatins require altering perating system, Internet Infrmatin Services, and dmain settings. Prceed with cautin and always make a backup befre mdifying anything. The methds described belw are fr advanced IT administratrs wh are cmfrtable with and have been allwed t alter any required settings and/r security prtcls. These helpful hints are nly fr illustrative purpses and each envirnment will have its wn unique requirements and hurdles. Hsting Wrkbench Server n a cmputer that's in a different Micrsft Windws dmain than the databases needed t stre infrmatin can be accmplished by using Windws Authenticatin r SQL Authenticatin. Accessing machines acrss dmains carries additinal security risks that need t be taken int cnsideratin befre implementing this scenari. Using Windws Authenticatin t access crss-dmain databases 1. Ensure that there's a dmain trust between the tw dmains. The fllwing Micrsft TechNet article explains: 2. Open and secure any necessary prts fr cmmunicatin between Wrkbench Server and any SQL Server instance. Prt 1433 is the mst cmmn prt assigned t SQL Server. 3. While installing Wrkbench Server: The dmain user used in the next tw steps must belng t the dmain that has trust. The relatinship defined within the Dmain Cntrllers Dmain Trusts area will dictate which dmain the user must be defined within. Ensure that the user installing Wrkbench Server has access t the ther dmain's database servers s that the installatin SQL scripts can execute and create databases, tables, etc. Specify a user fr the varius applicatin pls which has access t the ther dmain's database servers. This dmain user will be used t run the website and will need t create, update, and delete database bjects in the same manner as a single-dmain installatin. 4. If the dmain user installing Wrkbench desn't have the apprpriate rights n the ther dmain, installatin may fail. Using SQL Authenticatin t access crss-dmain databases 1. Open and secure any necessary prts fr cmmunicatin between Wrkbench Server and any SQL Server instance. Prt 1433 is the mst cmmn prt assigned t SQL Server. 2. While installing Wrkbench Server, specify the SQL Server instance and database as usual althugh a static IP address will mst likely be used instead f a friendly name.

96 3. Be sure t include the user name and passwrd as usual. Created with the Standard Editin f HelpNDc: Free help authring tl

97 Users / Wrkbench Server User / Wrkbench Server in Different Dmains Imprtant Nte: Pragmatic Wrks Sftware des NOT prvide supprt nr d we suggest this scenari Almst all f the mdificatins require altering perating system, Internet Infrmatin Services, and dmain settings. Prceed with cautin and always make a backup befre mdifying anything. The methds described belw are fr advanced IT administratrs wh are cmfrtable with and have been allwed t alter any required settings and/r security prtcls. These helpful hints are nly fr illustrative purpses and each envirnment will have its wn unique requirements and hurdles. Hsting Wrkbench Server n a cmputer that's in a different dmain than the users that will be accessing it presents sme challenges in making sure that bth dmains have a trust relatinship. The fllwing Micrsft TechNet article illustrates Dmain Trust and hw t implement it: Once a trust has been established between dmains, the dmain users that shuld be allwed access must be granted permissin t access Wrkbench Server. This can be dne in the Internet Infrmatin Services Manager. See Step 14 in ur Setup Instructins. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

98 AlwaysOn Availability Grup Cnsideratins Managing User Accunt Infrmatin When a user wishes t install Wrkbench Server database(s) t an AlwaysOn Availability Grup as availability databases, certain cnsideratins shuld be made. Imprtant Nte: This isn't intended t be a guide fr cnfiguring an AlwaysOn Availability Grup. This guide is assuming that an AlwaysOn Availability Grup has already been prperly cnfigured and the user wishes t add the Pragmatic Wrks databases t an existing availability grup as availability database(s). Server Installatin Befre beginning the installatin prcess f Wrkbench Server, the users that will be set t run each f the applicatin pls must have permissin t cnnect t the availability grup thrugh the availability grup listener. Imprtant Nte: When installing Wrkbench Server with the intent f using an AlwaysOn Availability Grup, the applicatin pls must be set t run as a specific user and cannt be cnfigured t run as either the Applicatin Pl Identity r Netwrk Services.

99 Once the user(s) that will be running the applicatin pls have been granted permissin t cnnect t the availability grup thrugh the availability grup listener, installatin f Wrkbench Server can begin. Installatin f Wrkbench Server will fllw the default setup instructins with several nticeable differences: 1. On Step 5 ensure that the Wrkbench Server applicatin pl is set t run as the user that was riginally cnfigured t have permissin t cnnect t the availability grup thrugh the availability grup listener 2. On Step 6 ensure that the User and Administratin database is cnfigured s that its server setting is set t pint t the availability grup listener 3. On Step 7 ensure that the BI xpress Server applicatin pl is set t run as the user that was riginally cnfigured t have permissin t cnnect t the availability grup thrugh the availability grup listener 4. On Step 8 ensure that the BI xpress database is cnfigured s that its server setting is set t pint t the availability grup listener 5. On Step 9 ensure that the DOC xpress Server applicatin pl is set t run as the user that was riginally cnfigured t have permissin t cnnect t the availability grup thrugh the availability grup listener 6. On Step 10 ensure that the DOC xpress database(s) are cnfigured s that their server settings are set t pint t the availability grup listener 7. On Step 11 ensure that the DOC xpress Data Handler Service is set t run as the user that was riginally cnfigured t have permissin t cnnect t the availability grup thrugh the availability grup listener 8. On Step 13 ensure that the LegiTest database is cnfigured s that its server setting is set t pint t the availability grup listener Once Wrkbench Server installatin has been cmpleted, creatin f the BI xpress, DOC xpress, LegiTest, and Wrkbench Server databases will ccur autmatically n the primary availability replica and the user can cntinue n t adding the databases t the availability grup as availability databases. Adding the databases t the Availability Grup Once the database(s) have been created, the database(s) can nw be added as availability database(s) t the availability grup. This is dne in the exact same way a user wuld add any ther database t an availability grup: 1. Within the database prperties, ensure that the databases' recvery mdel is set t "Full" 2. Create a netwrk share that each availability replica has permissins t access 3. Create a full back up f each database n the netwrk share created in Step 2 4. Once all f the databases have a full back up lcated n a netwrk share, expand "AlwaysOn High Availability" within management studi's bject explrer 5. Right-click n the availability grup that the user wishes t add the database(s) t and select "Add Database..."

100 6. Walk thrugh the steps within the "Add Database t Availability Grup" wizard, ensuring the database(s) selected meet all f the prerequisites. On the "Select Data Synchrnizatin" page, select "Full" and specify the netwrk share created in Step 2 as the lcatin accessible by all replicas

101 Once the BI xpress, DOC xpress, LegiTest and / r Wrkbench Server database(s) have been added t the availability grup as availability databases, whenever a user wishes t cnnect t the databases, the user shuld cnnect thrugh the availability grup listener. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

102 Can nt find MSTest r NUnit test runner Can nt find MSTest r NUnit test runner When running tests frm the server, a user may encunter an errr stating that the server can nt find the MSTest r NUnit test runner. This can ccure if the user has the these items installed in nn default areas. T change where the Legi Test Server lks fr these items, we will have t edit the cnfig file fund by default here: C:\Prgram Files (x86)\pragmatic Wrks\Wrkbench Server\LegiTest Cmmand Line\PragmaticWrks.LegiTest.CmmandLine.exe.cnfig The fllwing sectins in bld will need t be updated t match the user's install lcatin fr vstest r nunit: <appsettings> <add key="nunittestrunnerlcatin" value="%prgramfiles(x86)%\nunit 2.6.3\bin\nunit-cnsle.exe" /> <add key="mstestrunnerlcatin" value="%prgramfiles(x86)%\micrsft Visual Studi 12.0\Cmmn7\IDE\CmmnExtensins\Micrsft\TestWindw\vstest.cnsle.exe" /> <add key="schtasks.exe" value="%windir%\system32\schtasks.exe" /> <add key="legitestcmmandline" value="%prgramfiles(x86)%\pragmatic Wrks\Wrkbench Server\LegiTest Cmmand Line\PragmaticWrks.LegiTest.CmmandLine.exe" /> </appsettings> Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

103 Cntact Us 8936 NrthPinte Executive Dr. Suite 200 Huntersville, NC Abut us: SentryOne creates unmatched slutins that empwer Micrsft data prfessinals t achieve breakthrugh perfrmance acrss physical, virtual, and clud envirnments. SentryOne prducts give custmers the capability and cnfidence t mnitr their databases, diagnse perfrmance issues, and ptimize the entire SQL Server estate t prvide real business value. The SentryOne team includes mre than 140 emplyees lcated in Charltte, NC, Jacksnville, FL, Salem, NH and Dublin, Ireland. Cmpany Culture: Our Missin: SentryOne empwers the Micrsft data prfessinal t achieve breakthrugh data envirnments. Our Cre Values: As SentryOne cntinues t grw, we knw that success depends n remaining true t Innvatin We create inspired, visinary slutins, and take n challenges that thers wnʼt r canʼt. Quality We embrace excellence by getting it right the first time. Agility We respnd and adapt quickly t the needs f ur clients. Created with the Standard Editin f HelpNDc: Prduce nline help fr Qt applicatins