DOC xpress. o Software Requirements. o Required Permissions. o Workbench Features Features Managing Your Solution.

Transcription

1 DOC xpress View DOC xpress Live Dcumentatin DOC xpress prduces cmplete dcumentatin fr SQL Server instances. In additin, it enables dcumentatin fr Analysis Services (SSAS), Integratin Services (SSIS) and Reprting Services (SSRS). Snapshts f the envirnment can be captured with a few clicks, making it easy t capture what an envirnment lks like befre making changes. Dcumentatin can be prduced frm any daily snapsht, allwing users t see what the envirnment lked like in the past. The snapsht and the dcumentatin prcesses can be scheduled using the cmmand line, allwing integratin with ppular scheduling utilities. The dcumentatin can be prduced in HTML, HTML with frame navigatin, RTF, r Wrd (dcx) frmats. The cntents f the dcumentatin can be custmized, bth fr what is included in the utput, as well as the templates t use fr each type f bject. Speed up yur dcumentatin effrts with DOC xpress! Feature Highlights Dcument yur database, SSAS cubes, SSIS packages and SSRS reprts Generate dcuments frm pint in time snapshts Custmize yur dcumentatin utput Schedule snapshts and dcumentatin frm the cmmand line 64-bit supprt fr dcumenting enterprise scale database installatins Table f Cntents Setup Instructins Hardware Requirements Sftware Requirements Required Permissins Wrkbench Features Features Managing Yur Slutin Data Dictinary Lineage Analysis Metadata Viewer Snapsht Cmparisn Snapsht Management Frequently Asked Questins Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

2 Setup Instructins Table f Cntents Hardware Requirements Sftware Requirements Required Permissins By installing Pragmatic Wrkbench, yu are installing all features f BI xpress, DBA xpress, and DOC xpress. 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". Once yu have agreed, click "Next". 4. Select the type f installatin yu wish t perfrm. 1. If yu select "Custm", g t Step If yu select "Typical", g t Step 6.

3 5. On the "Custm" installatin page, yu may select which features t install r leave ut. After making yur selectins, click "Install". Imprtant Nte: By expanding BI xpress yu may chse which versin(s) f Visual Studi ur add-in will be cmpatible with n yur machine. Yu may als chse t include DBA xpress, DOC xpress, LegiTest and the ptinal prerequisites fr DOC xpress and BI xpress' BI Cmpare.

4 6. The installatin prgress view will appear.

5 7. If yu chse "Typical" install in step 4 r pted t install the ptinal prerequisites*, yu will see the fllwing cmpnents request t be installed frm the Micrsft site: 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 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 Imprtant Nte: These cmpnents are "Optinal Prerequisites" because Pragmatic Wrkbench will wrk withut them. Hwever, DOC xpress and BI Cmpare (a feature within BI xpress) d require them t be installed in rder t dcument and cmpare SSAS and SQL Server database bjects. 8. After each cmpnent, the Wrkbench installer will cntinue. If any errr messages appear during the installatin f these cmpnents, please reference their errr message against Micrsft's supprt site fr reslutin.

6 9. If yu chse "Typical" install in step 4 r pted t install LegiTest, the Visual Studi Extensin installer will appear. This allws users t chse which versins f Visual Studi will cntain LegiTest. 10. When the installer finishes running, yu will be presented with this cnfirmatin page. The "See what's new" buttn will direct yu t ur Release Ntes, yu als have the ptin t clse the installer (click "Finish") r begin using Wrkbench ("Run").

7 Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

8 Hardware Requirements Users can determine their hardware requirements based n their envirnment's deplyment mdel. All f DOC xpress' features need access t the DOC xpress Database. This creates tw deplyment scenaris: Single Machine: The same machine has bth Wrkbench and the DOC xpress database installed Multiple Machines: Wrkbench and the DOC xpress database are installed n separate machines Created with the Standard Editin f HelpNDc: Easy t use tl t create HTML Help files and Help web sites

9 Single Machine In the single machine deplyment mdel, the same machine has bth Wrkbench and the DOC xpress database installed. Wrkbench is the prgram that cntains DOC xpress and its assciated assemblies while the DOC xpress database is hsted within a SQL Server Instance. The fllwing memry and prcessr requirements apply t all editins f DOC xpress: Requirements Cmpnent Minimum Recmmended Memry 4 GB At least 8 GB and shuld be increased as the DOCxPress 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 DOC xpress n a virtual machine will be slwer than running natively because f the verhead f virtualizatin. Created with the Standard Editin f HelpNDc: Single surce CHM, PDF, DOC and HTML Help creatin

10 Multiple Machines In the multiple machine deplyment mdel, Wrkbench and the DOC xpress database are installed n separate machines. Wrkbench is the prgram that cntains DOC xpress and its assciated assemblies while the DOC xpress database is hsted within a SQL Server Instance. It is imprtant t differentiate between the client machine and the server machine: Client machine: the machine where Wrkbench is installed Server machine: the machine cntaining a SQL Server instance where the DOC xpress database is deplyed The fllwing memry and prcessr requirements apply t all editins f DOC xpress: Client 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

11 Server Hardware Requirements Requirements Cmpnent Minimum Recmmended Memry 4 GB At least 6 GB and shuld be increased as the DOCxPress 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 DOC xpress n a virtual machine will be slwer than running natively because f the verhead f virtualizatin. Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

12 Sftware Requirements Befre installing Wrkbench, make sure yu meet the fllwing system requirements: SQL Server Integratin Services 2005, 2008, 2008 R2, 2012, 2014, 2016, 2017 BIDS 2005, 2008, 2008 R2 (Business Intelligence Develpment Studi) r SSDT 2010, 2012, 2014, 2016, 2017 (SQL Server Data Tls) Micrsft.NET 3.5 with Service Pack 1 Micrsft.NET 4.0 Micrsft.NET 4.5 (2017 Prviders nly) Micrsft SQL Server 2012 Transact-SQL ScriptDm x86 The fllwing perating systems are supprted by Wrkbench: 64-bit (x64) Operating Systems: Windws Server 2003 (at least Service Pack 2) * Windws Vista (at least Service Pack 2) Windws Server 2008 R2 Windws Server 2012 Windws Server 2016 Windws 7 Windws 8 Windws bit (x86) Operating Systems: Windws XP (at least Service Pack 3) * Windws Server 2003 (at least Service Pack 3) * Windws Vista (at least Service Pack 2) Windws Server 2008 R2 Windws Server 2012 Windws 7 Windws 8 Windws 10 Imprtant Nte: Windws XP and Server 2003 have been deprecated frm full supprt. Any issues encuntered n either Windws XP r Server 2003 must be reprducible n newer versins f Windws t be eligible fr supprt. The fllwing prerequisites are required t enable sme features within DOC xpress: SQL 2008 r higher is required t create a DOC xpress metabase. Hwever, if cnnected t a valid DOC xpress metabase, SQL 2005 and up may be dcumented, thugh there are sme limitatins t SSRS 2005 and 2008 dcumentatin. Dcumentatin CHM HTML Help Wrkshp and Dcumentatin The fllwing prerequisites are required t enable sme features within BI xpress and DOC xpress: 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

13 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 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: Micrsft.NET 4.5 (Required by SSAS 2017 Only) 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: Micrsft.NET 4.5 (Required by SSIS 2017 Only) Each versin f SQL Server Integratin Services (20058 R2 r abve) that the user wishes t dcument. SQL Server Data Tls r Business Intelligence Develpment Studi. Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s) SSRS:

14 At least ne versin f SQL Server Reprting Services (2008 R2 r abve) that the user wishes t dcument. 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: 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 System Requirements fr ther Wrkbench prducts: The fllwing prerequisites are required t enable sme features within BI xpress: BI xpress extensin fr Visual Studi 2015 requires: An installatin f ne f the fllwing editins f Visual Studi: Visual Studi 2015 Cmmunity Editin Visual Studi 2015 Prfessinal Visual Studi 2015 Enterprise The fllwing extensin installed within their Visual Studi 2015 envirnment: SQL Server Data Tls fr SQL Server 2016 (nw includes BI Prjects) Plug-ins: Auditing Framewrk, BI Cmpare, Package Builder Wizard, and/r SSIS Unit Test: Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s) Reprt Mver Reprting Deplyment is cmpatible with SQL 2008 R2 r later Reprt Mnitring Cnsle: Reprting Perfrmance Mnitr is cmpatible with SQL Server 2008 r later The fllwing prerequisites are required t enable features within LegiTest: LegiTest extensin requires: An installatin f ne f the fllwing editins f Visual Studi: Visual Studi 2012 Pr r better Visual Studi 2013

15 Visual Studi 2013 Cmmunity Editin Visual Studi 2015 Visual Studi 2015 Cmmunity Editin Visual Studi 2017 NUnit Requirements NUnit is required t execute LegiTest NUnit tests utside f Visual Studi NUnit Test Adapter 2.0 is required fr LegiTest NUnit tests t be displayed within the Visual Studi Test Explrer SQL Server Assets Supprted Versins SQL Server 2008 R2 SQL Server 2012 SQL Server 2014 SQL Server 2016 SQL Server 2017 SSIS Actins and Assets Supprted Versins SSIS 2008 R2 SSIS 2012 SSIS 2014 SSIS 2016 SSIS 2017 Each versin f SQL Server Integratin Services (2008 R2 r abve) that the user wishes t test SQL Server Data Tls r Business Intelligence Develpment Studi Micrsft.NET 4.5 (Required by SSIS 2017 Only) SSAS Actins Supprted Versins Multidimensinal SSAS 2008 R2 SSAS 2012 SSAS 2014 SSAS 2016 SSAS 2017 Tabular SSAS 2012 SSAS 2014 SSAS 2016 SSAS 2017 Micrsft.NET 4.5 (Required by SSAS 2017 Only) SSRS Actins Supprted Versins SSRS 2008 R2 SSRS 2012 SSRS 2014 SSRS 2016 SSRS 2017

16 Created with the Standard Editin f HelpNDc: Easily create Help dcuments

17 Required Permissins Many f the features within Wrkbench nly need db_wner when issuing database updates. This ccurs when upgrading frm an lder versin f Wrkbench t a newer versin. Outside f database updates, thse users nly need db_datareader and db_datawriter permissins. Belw is a cmprehensive list f each feature and their required permissins. DOC xpress Required Permissins DOC xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner 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 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:

18 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 Required Permissins fr ther Wrkbench prducts: BI xpress Required Permissins Best Practice Analyzer: BI xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner 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 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 Data Generatin: Each table yu wish t generate data within db_datareader

19 db_datawriter Deplyment Wizard (2005 and 2008): Permissin t deply t the SQL Server SSIS Unit Test: Permissin t execute the packages yu are testing (at their lcatin, ex. file system, SQL server etc...) SSRS Mnitring Cnsle: SSRS ReprtServer database(s): db_datareader Mnitring Cnsle: BI xpress database: Regular Usage: db_datareader db_datawriter Database updates: db_wner Other Features: Fr ther features yu will need permissin t access and btain the packages at their lcatin. DBA xpress Required Permissins Data Inspectr, Data Space Analyzer, Data Surf, Object Brwser, Schema Surf Each bject being manipulated: db_datareader db_datawriter Schema Inspectr, Schema Inspectr Snapsht Tl Each bject being manipulated: db_wner Created with the Standard Editin f HelpNDc: Easy t use tl t create HTML Help files and Help web sites

20 Wrkbench Features Wrkbench Features After Pragmatic Wrkbench is installed, launching Pragmatic Wrkbench will autmatically direct yu t the Wrkbench tlbar with the Feature Finder page selected. Table f Cntents Feature Finder Activities Preferences Overview Tab Preview In the upper left hand crner f Pragmatic Wrkbench is a tlbar buttn that allws users the ability t minimize and maximize the Wrkbench tlbar. The Wrkbench tlbar cntains six ptins that will help users either navigate t r cnfigure features: Feature Finder: The Feature Finder prvides users the ability t quickly navigate t each feature present within Pragmatic Wrkbench. Activities: The Activities page prvides users with a histrical recrd f all actins taken acrss each prduct feature during the current sessin as well as the ability t search activities that ccurred in previus sessins. Open: The Open ptin prvides users with a quick way t pen supprted files and will intelligently launch the best feature fr the selected file. Open Recent: The Open Recent ptin prvides users with a quick list f recently pened files that a user can select and will intelligently launch the best feature fr the selected file. Preferences: The Preferences page prvides users with feature specific ptins that will allw users t custmize the behavir f each feature t their liking. Help: The Help page prvides users with the ability t check fr prduct updates, activate / deactivate licenses, and view prduct versins.

21 Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

22 Feature Finder The Feature Finder prvides users the ability t quickly navigate t each feature present within Pragmatic Wrkbench. Users can srt the features by technlgy type, prduct family, a specific rle, keywrds, r even use a cmbinatin f filters and/r keywrds. These filters prvide users with the ability t fine tune Pragmatic Wrkbench t the user's specific needs and make the user's frequently used features mre readily available. 1. Technlgy: Narrw dwn the feature list by eliminating all features that are nt assciated with the chsen technlgy 2. Prduct: Narrw dwn the feature list by eliminating all features that are nt assciated with the chsen Pragmatic Wrks' Prduct

23 3. Rle: Narrw dwn the feature list by eliminating all features that are nt assciated with the user's Rle within their cmpany

24 4. Keywrds: Narrw dwn the feature list by using the search tlbar t filter ut features that d nt cntain a specific keywrd Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

25 Activities Activities The Activities page prvides users with a histrical recrd f all actins taken acrss each prduct feature during the current sessin as well as the ability t search activities that ccurred in previus sessins. Table f Cntents Activities Search Besides prviding users with histrical recrds f each activity, the Activities page als cntains useful infrmatin regarding t the activity's feature, title, infrmatin, status, date started r ended, and the activity lg Feature: In the upper left crner f each activity, the name f the Feature that generated the activity is displayed Title: On the same line as the Feature Name separated by a cln (:), the title f the activity describes the actin that ccurred within the activity Infrmatin: Belw the Feature and Activity Title is a general descriptin f the current status f the activity Status: The backgrund clr f each activity visually describes the current status fr the activity 1. Red: Activity cmpleted with at least ne errrs 2. Green: Activity cmpleted successfully withut errrs 1. Yellw: Activity cmpleted with warnings 3. Blue: Activity is still either still running, manually stpped, r cmpleted with infrmatin Date Started r Ended: On the far right f the activity displays either the date the activity started r ended depending n the current status f the activity. Activity Lg: By duble-clicking n an activity, users can view a mre detailed activity lg.

26 Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

27 Activities Search With the activities windw users are als given a pwerful search tl that enables them t search fr all activities, regardless f the sessin they ccurred within. By clicking n the "Search" tab, users can begin searching fr activities using specific search parameters. Clicking the "Search" buttn frm within the Search tab will launch the Search Activity Lg windw. The Search Activity Lg cntains five parameters t narrw dwn the search results by: Finished After: The activity search will filter all activities based n activities that finished after the start f a specific date parameter Finished Befre: The activity search will filter all activities based n activities that finished befre the end f a specific date parameter Ending Status: The activity search will filter all activities based n the specific ending status f the activity Title Cntains: The activity search will filter all activities based n the whether the title cntains a specific string Message Cntains: The activity search will filter all activities based n the whether the message cntains a specific string Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

28 Preferences Overview Preferences Overview The Preferences page prvides users with feature specific ptins that will allw users t custmize the behavir f each feature t their liking. Table f Cntents DOC xpress Preferences Wrkbench Preferences Including a general wrkbench sectin, each wrkbench prduct has its wn preferences that can be used t custmize the prduct's features individually.

29 In additin t changing the default behavir f features, users can change the default key bindings fr features t custm keys. This can be btained by clicking the "Key bindings..." buttn lcated at the bttm left f the Preferences windw.

30 Created with the Standard Editin f HelpNDc: News and infrmatin abut help authring tls and sftware

31 DOC xpress Preferences Within the DOC xpress Preferences, users can custmize the behavir and prperties f Data Dictinary, DOC xpress, and Lineage Analysis: Data Dictinary Enabled: Cntrls whether r nt aut save is enabled Interval: Cntrls the number f minutes between aut saves DOC xpress General Autmatically Open Generated Dcuments: Cntrls whether t autmatically pen dcuments nce they are generated Default Output Flder: Cntrls the default flder where generated dcumentatin is placed HTML Help Wrkshp Cmpiler: Cntrls the file path t the HTML Help Wrkshp cmpiler executable used by CHM dcumentatin generatin Snapsht Cmbinatin Time: Cntrls the number f minutes between snapsht updates where the tw updates are cnsidered t be a part f the same snapsht update Autmatically Update Default Output: Cntrls whether the default utput flder fr generated dcumentatin shuld be updated whenever a new utput flder is selected Metabase Cmmand Timeut: Cntrls the timeut applied t peratins against the DOC xpress metabase Cnnectin String: Cntrls the cnnectin string used t cnnect t the DOC xpress metabase Templating Disable Data Dictinary Output: Cntrls whether t suppress data dictinary elements frm being generated in dcuments. Disabling Data Dictinary utput des reduce memry usage Disable Lineage Output: Cntrls whether t suppress Lineage Analysis images and tables frm being generated in dcuments. Disabling Lineage Analysis utput des reduce memry usage Surce Flder: Cntrls the flder frm which templates are laded t apply t bjects when dcumenting Lineage Analysis Appearance Optins Shw Technlgy Type Adrnments: Cntrls whether r nt t shw the name f the technlgy next t each nde within the graph Input Link Clr: Cntrls the clr used fr input links in the lineage display General Link Clr: Cntrls the clr used fr general links in the lineage display Mdificatin Link Clr: Cntrls the clr used fr mdificatin links in the lineage display External Dependency Clr: Cntrls the clr used fr external dependency ndes in the lineage display Selected Item Clr: Cntrls the clr used fr selected ndes in the lineage display SQL Server Clr: Cntrls the clr used fr SQL Server ndes in the lineage display SSAS Clr: Cntrls the clr used fr SSAS ndes in the lineage display SSIS Clr: Cntrls the clr used fr SSIS ndes in the lineage display SSRS Clr: Cntrls the clr used fr SSRS ndes in the lineage display Behavir Optins Duble-click Mde: Cntrls whether t refcus the graph arund a duble-clicked nde, r t extend frm it Default Fllw Mde: Cntrls the default link fllwing mde applied t graphs Default Detail Level: Cntrls the default detail level applied t graphs

32 Default Layut Type: Cntrls the default layut type used t lay ut graph ndes Default Legend Visibility: Cntrls whether r nt the legend is visible by default Default Dependency Levels: Cntrls the number f dependency levels shwn by default Track Selectin by Default: Cntrls whether selectin tracking is active by default Default t Trace Mde: Cntrls whether trace mde is active by default Default View Mde: Cntrls the default view mde fr interacting with lineage infrmatin Trace Mde Rute Limit: Cntrls the maximum number f rutes that can be fund with trace mde Cache Lineage Sets Lcally: If lineage sets are cached lcally, then lineage will pen faster the secnd time yu view a particular slutin snapsht. Cache Path: This is where the lineage sets are stred s that lineage pens faster. Faster strage will result in faster peratin f lineage. Created with the Standard Editin f HelpNDc: Free iphne dcumentatin generatr

33 Wrkbench Preferences Within the Wrkbench Preferences, users can custmize the behavir and prperties fr Pragmatic Wrkbench: Appearance Theme Name: Cntrls the theme used fr Wrkbench clrs Behavir Selected Prducts: Cntrls the prducts t filter by when starting Pragmatic Wrkbench Selected Rles: Cntrls the rles t filter by when starting Pragmatic Wrkbench Selected Technlgies: Cntrls the technlgies t filter by when starting Pragmatic Wrkbench Shw Feature Finder: Cntrls whether t shw r hide the Feature Finder tl in the features list Shw Pragmatic Wrks News: Cntrls whether t shw r hide the Pragmatic Wrks latest news and messages. The latest prduct features, discunts, and tips will be shwn here Start-up Plug-in: Cntrls the plug-in that will be laded when Wrkbench first starts Errr Reprting: Cntrls whether t send annymus errr reprting infrmatin t Pragmatic Wrks Usage Reprting: Cntrls whether t peridically send annymus feature usage reprting t Pragmatic Wrks Created with the Standard Editin f HelpNDc: Free EBk and dcumentatin generatr

34 Tab Preview While using Pragmatic Wrkbench users may have several features pen at a time. Users can see the multiple features lined up side by side in tabs abve their wrkspace. By hvering ver a tab users can see a preview f that tab. Additinally, Pragmatic Wrkbench includes a Feature Switcher. This makes switching between features much easier with a dedicated switching windw that includes a preview windw fr each feature. T access the Feature Switcher, press Ctrl + Tab, after the windw pps up, release tab but cntinue t hld Ctrl. Yu may nw press repeatedly press tab t cycle thrugh the currently pen features. Once n the desired feature is selected, release Ctrl t navigate t that specific feature.

35 Created with the Standard Editin f HelpNDc: Free Kindle prducer

36 Features DOC xpress makes it easy t prduce dcumentatin fr yur SQL Server instances. In additin, it enables the dcumentatin fr Analysis Services (SSAS), Integratin Services (SSIS), Reprting Services (SSRS), Hive Server, Infrmatica PwerCenter Repsitries, and Oracle Databases. DOC xpress makes it easy t dcument the infrmatin abut yur tables and databases. Using the snapsht tls prvided yu can take a picture f yur database's infrmatin at a certain pint in time. The infrmatin gathered frm this is called metadata. Table f Cntents Managing Yur Slutin Data Dictinary Lineage Analysis Metadata Viewer Snapsht Cmparisn Snapsht Management Snapsht A snapsht in DOC xpress is a detailed picture f yur envirnment's state at the time that the snapsht was taken. Yu can take a snapsht f yur envirnment with nly a few clicks, making it easy t capture what an envirnment lks like befre making changes. These snapshts can be used t generate dcumentatin, run cmparisns against previus snapshts using Snapsht Cmpare, explre an bject's dependencies using Lineage Analysis, and add extra infrmatin within their dcumentatin using Data Dictinary. DOC xpress Wrkflw DOC xpress Architecture

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

38 Managing Yur Slutin Managing Yur Slutin Table f Cntents Creating Yur DOC xpress Slutin Adding Slutin Items Custm Metadata Imprt Excel Spreadsheet Hive Server Infrmatica PwerCenter Repsitry Oracle Database SQL Server SSAS Server SSIS Package SSRS Reprt Tableau Server Manage Aliases Creating a Snapsht Cmmand Line Snapshts Generating Dcumentatin Cmmand Line Dcumentatin 1. Once DOC xpress is pen in Wrkbench, select the slutin yu wish t manage.

39 2. 3. When yur item is selected, yu will have the ptin t Open it fr editing, r delete it. Clicking delete will prmpt a cnfirmatin windw. Opening it will bring yu int the slutin. Frm here yu can select slutin items and edit them hw yu wish.

40 Imprtant Nte: After a snapsht has cmpleted, yu can expand and navigate the metadata fr a slutin item by using the Metadata Viewer. Simply select the item yu wish t explre, and left click n the "View" buttn lcated n the right side f the Items Panel. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

41 Creating Y ur DOC xpress Slutin Creating Yur DOC xpress Slutin Click n DOC xpress. If nt already cnnected t a DOC xpress database, and yu d nt already have a DOC xpress database created, create ne nw by clicking "New Metabase". Click the "Brwse" buttn, prvide the server name, security infrmatin (if using Windws Authenticatin, leave as Integrated Security), then click "OK". If yu wish t change the metabase name, d s here. Then, click "Create metabase". 4. If yu have already created a DOC xpress database and wuld like t cnnect t it, click "Change Cnnectin", prvide yur server name and credentials, chse the database frm the drp-dwn list, and click "OK". 5. If this is the first slutin yu have added, the slutin wizard will run first t help yu add a slutin therwise cntinue t step Click "Add" t create a new Slutin.

42 7. Name the slutin smething meaningful, and click "OK".

43 8. The next screen will prmpt yu t name the item and then select a surce type, depending n yur surce the steps t cmplete may vary. Please fllw the guides fund n Adding Slutin Items fr mre explicit steps. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

44 Adding Slutin Items Adding Slutin Items Table f Cntents Custm Metadata Imprt Excel Spreadsheet Hive Server Infrmatica PwerCenter Repsitry Oracle Database SQL Server SSAS Server SSIS Package SSRS Reprt Tableau Server Imprtant Nte: While adding slutin items t yur DOC xpress Slutin, yu may run int an issue where the surce type yu wish t generate des nt shw up. If this happens, chances are yu have nt met the system requirements fr that specific prvider. Please check the System Requirements page and ensure yu have all f the system requirements fr that specific prvider installed prperly. Fr details n the capabilities f each prvider within DOC xpress, click here. Created with the Standard Editin f HelpNDc: Full-featured EBk editr

45 Custm Metadata Imprt Custm Metadata Imprt Dc xpress gathers data using prviders. If there is n existing prvider fr a surce, then users can use the Custm Metadata Imprt prvider t imprt custm metadata files. This is useful when there is a need t incrprate data abut unsupprted platfrms such as Access r DB2. Best Practices a BI Cmpare Dcumentatin Lineage Data Dicti b Best Practices rules can be analyzed fr the Custm Metadata Imprt prvider nce the user has created User Defined Best Practices a Dcumentatin sets generated frm the Custm Metadata Imprt prvider d nt cntain a unique structure and instead use a cmmn layut b Data Dictinary categries can be applied t the Custm Metadata Imprt prvider nce custm paths have been created c Getting Started While inside f a slutin within the DOC xpress feature yu can click the "Add" buttn t add a new item. On the next page yu will give the item a name and select Custm metadata imprt fr the surce type. Then yu will prvide the paths t the needed files. There are three files that need t be imprted: bject file, prperty file, and lineage file. The bject files cntain names f the bjects cntained in the database. The prperties file cntains infrmatin abut thse bjects. The lineage files will cntain infrmatin abut hw the bjects are related. After selecting yur files, click k. c

46 The files have been applied t the slutin and the infrmatin gathered frm thse files will be included in the DOC xpress dcumentatin and shw in the lineage analysis. Created with the Standard Editin f HelpNDc: Easily create PDF Help dcuments

47 Excel Spreadsheet Excel Spreadsheet SSAS Prvider Requirements Excel 2013 and abve wrkbks (*.xlsx) Best Practices BI Cmpare a Dcumentatin Lineage b c Best Practices rules can be analyzed fr the marked prvider(s) nce the user has created User Defined Best Practices a Dcumentatin sets generated frm the marked prvider(s) d nt cntain a unique structure and instead use a cmmn layut b Excel Spreadsheet Lineage Analysis nly supprts dependency scanning Data Surces frm SQL Server and Analysis Services Databases and des nt supprt PwerPivt c d Data Dictinary categries can be applied t the marked prvider(s) nce custm paths have been created Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the windw 2. Give the slutin item a meaningful name 3. Select the Excel Spreadsheet prvider frm the surce type drp dwn Data Dicti d

48 4. 5. The Excel Spreadsheet prvider cntains tw surce ptins: File: Select File t dcument an Excel Wrkbk lcated n the file system. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t navigate t the lcatin f any *.xlsx file Flder: Select Flder t recursively dcument all Excel Wrkbk Item(s) lcated within a specific flder n the file system. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t select a flder that cntains at least ne *.xlsx file Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types r items may affect Lineage Analysis

49 6. Click "OK" t add the Excel Spreadsheet t the Slutin Items windw Sample Lineage Dc xpress allws yu t quickly develp a Lineage verview f yur Excel Wrkbks (*.xlsx) that cntain SQL Server and Analysis Services data surces. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

50 Hive Server Hive Server Hive Prvider System Requirements: 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 Best Practices BI Cmpare Dcumentatin Lineage Data Dicti a a Best Practices rules can be analyzed fr the Hive prvider nce the user has created User Defined Best Practices b Data Dictinary categries can be applied t the Hive prvider nce custm paths have been created Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the Hive prvider frm the surce type drp dwn b

51 4. Prvide a valid Hive cnnectin string

52 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis. 6. Click "OK" t add the Hive Server t the Slutin Items windw

53 Sample Output

54 Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

55 Infrmatica PwerCenter Repsitry Infrmatica PwerCenter Repsitry Infrmatica System Requirements 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: 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 With the Infrmatica prvider, users will be able t use DOC xpress t easily create metabase dcumentatin frm an Infrmatica PwerCenter. Best Practices BI Cmpare Dcumentatin Lineage Data Dicti a Best Practices rules can be analyzed fr the Infrmatica PwerCenter Repsitry prvider nce the user has created User Defined Best Practices a Data Dictinary categries can be applied t the Infrmatica PwerCenter Repsitry prvider nce custm paths have been created b Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the Infrmatica PwerCenter prvider frm the surce type drp dwn b

56 4. Select the type f repsitry that will be dcumented, either SQL Server r Oracle and then prvide a valid data surce, credentials, and database

57 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis.

58 6. Click "OK" t add the Infrmatica PwerCenter Repsitry t the Slutin Items windw Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

59 Oracle Database Oracle Database Oracle Prvider System Requirements 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: 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 If planning t use bth the 64-bit and 32-bit Oracle Prvider, it is imprtant t dwnlad the same release fr bth the 64-bit and 32-bit versin f the Oracle Data Access Cmpnents. That means if dwnlading the 64-bit ODAC 12c Release 4, then the 32-bit ODAC 12c Release 4 versin shuld be the 32-bit versin chsen t dwnlad. Best Practices BI Cmpare Dcumentatin Lineage Data Dicti a Best Practices rules can be analyzed fr the Oracle Database prvider nce the user has created User Defined Best Practices a b Data Dictinary categries can be applied t the Oracle Database prvider nce custm paths have been created Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the Oracle prvider frm the surce type drp dwn 4. Prvide a valid data surce a credentials b

60 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis. 6. Click "OK" t add the Oracle Database t the Slutin Items windw

61 Sample Output: In the dcumentatin yu can drill int the server t view a list f schemas as well as a summary f what each schema cntains. Yu can drill int a specific schema t view a list f tables, prcedures, views and mre. Table dcumentatin prvides table prperties and the table definitin.

62 Created with the Standard Editin f HelpNDc: Full-featured Help generatr

63 SQL Server SQL Server SQL Prvider Requirements 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 Best Practices BI Cmpare Dcumentatin Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the SQL Server prvider frm the surce type drp dwn Lineage Data Dicti

64 4. Prvide a valid server name and credentials 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis.

65 6. Click "OK" t add the SQL Server t the Slutin Items windw Sample Output Dc xpress dcuments databases acrss all majr versins f SQL Server: 2005, 2008, 2008 R2, 2012, 2014, 2016 and Nte: Nn-systemadmin users must be granted "View server state" permissins t view lg file bjects within dcumentatin.

66 Created with the Standard Editin f HelpNDc: iphne web sites made easy

67 SSAS Server SSAS Server SSAS Prvider Requirements Micrsft.NET 4.5 (Required by SSAS 2017 Only) 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 Best Practices BI Cmpare Dcumentatin Lineage Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the windw 2. Give the slutin item a meaningful name 3. Select either the SSAS Server r SSAS Server 2016 prvider frm the surce type drp dwn Imprtant Nte: Use the SSAS Server prvider when cnnecting t the fllwing SSAS Mdes: MultiDimensinal instances with server versins between 2005 and 2014 Tabular instances with server versins between 2012 and 2014 Use the SSAS Server 2016 prvider when cnnecting t the fllwing SSAS Mdes: MultiDimensinal instances with server versins abve 2016 Tabular instances with server versins abve 2016 Azure Analysis Services 4. Prvide a valid server name Data Dicti

68 5. If yu have selected SSAS Server 2016 and are attempting t cnnect t Azure Analysis Services, Azure Active Directry credentials are required. Imprtant Nte: In rder t cnnect t Azure Analysis Services, users will need t dwnlad and install the latest Micrsft Azure Analysis Services Client Libraries.

69 6. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis. 7. Click "OK" t add the SSAS Server t the Slutin Items windw

70 Sample Output Dc xpress is able t dcument SSAS Cubes and Databases acrss all majr versins f SQL Server: 2005, 2008, 2008 R2, and 2012 Multi-Dimensinal. With the SSAS Cube and Database Dcumentatin yu can see the prperties and attributes f each dimensin in a cube. When dcumenting KPI's, yu can see the trend expressin, gal expressin and status expressin.

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

72 SSIS Package SSIS Package SSIS Prvider Requirements Micrsft.NET 4.5 (Required by SSIS 2017 Only) Each versin f SQL Server Integratin Services (2008 R2 r abve) that the user wishes t dcument. SQL Server Data Tls r Business Intelligence Develpment Studi. Any Third-Party Prducts (Cnnectin Managers, Tasks, Cmpnents, et cetera) that are used within the SSIS Package(s) Imprtant Nte: Pragmatic Wrkbench (32-bit) must be used when snapshtting SSIS Slutin items frm a machine that nly cntains SSDT fr Visual Studi Best Practices BI Cmpare Dcumentatin Getting Started 1. After creating a slutin, click the "Add" buttn n the right side f the page Lineage Data Dicti

73 . 2. Give the slutin item a meaningful name 3. Select the SSIS prvider frm the "Surce Type" drp dwn.

74 4. The SSIS Prvider cntains several cnnectin ptins: File: Select File t dcument SSIS Item(s) lcated n the file system. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t navigate t the lcatin f any *.dtsx, *.dtprj, *.sln, r *.ispac files Flder: Select Flder t recursively dcument all Excel Wrkbk Item(s) lcated within a specific flder n the file system. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t select a flder that cntains at least ne SSIS item SQL Server: Select SQL Server t dcument SSIS Item(s) deplyed t a SQL Server instance Package Stre: Select Package Stre t dcument SSIS Item(s) deplyed t an SSIS Package Stre Catalg: Select Catalg t dcument SSIS Item(s) deplyed t an SSIS Package Catalg Imprtant Nte: Due t DOC xpress' need t extract metadata frm SSIS Packages, Integrated Security is required t cnnect t an SSIS Catalg. 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis.

75 6. Click "OK" t add the SSIS items t the Slutin Items windw Sample Output Dc xpress allws yu t quickly develp an verview f yur Integratin Services Packages. With the SSIS Package dcumentatin yu can display diagrams f bth the cntrl and data flw f an SSIS package. Yu can als view detailed infrmatin fr package event handlers.

76 It will als dcument prperties fr every cmpnent acrss all Data Flws. Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

77 SSRS Reprt SSRS Reprt SSRS System Requirements At least ne versin f SQL Server Reprting Services (2008 R2 r abve) that the user wishes t dcument. 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 Best Practices BI Cmpare Dcumentatin Lineage Data Dicti Imprtant Nte: KPIs and Mbile Reprts are currently nt supprted when cnnecting t an SSRS 2016 r abve Reprt Server Getting Started User must have SQL 2008 R2 Reprting Services r higher in rder t dcument. Permissins n server must be: Brwser in the reprt tree and system user n the web server itself. 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the SSRS prvider frm the surce type drp dwn

78 4. The SSRS Prvider cntains several cnnectin ptins: 1. File: Select File t dcument SSRS Item(s) lcated n the file system. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t navigate t the lcatin f any *.rdl, *.rds, *.rsd, r *.rptprj files. 2. Flder: Like File, select Flder t dcument SSRS Item(s) lcated n the file system. Unlike file, the Flder ptin will recursively dcument all SSRS items lcated within the flder. Clicking the ellipses will launch the file explrer, allwing users the pprtunity t select a flder that cntains at least ne SSRS item. 3. Native Web Service: Select Native Web Service t dcument an SSRS Native Web Service. Use the Flder text bx t nly dcument specific flders within an Native Web Service. 4. SharePint Web Service: Select SharePint Web Service t dcument an SSRS SharePint Web Service. Use the Flder text bx t nly dcument specific flders within an Native Web Service. 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis.

79 6. Click "OK" t add the SSRS items t the Slutin Items windw Sample Output DOC xpress dcuments SSRS Reprts fund n the File System acrss the fllwing versins f SQL Server: 2008, 2008 R2, and Additinally, DOC xpress dcuments SSRS 2008 R2 and 2012 Reprts in bth Native and SharePint Integrated Mde. With SSRS Reprt dcumentatin yu can view the prperties, parameters, and data surces f a reprt. Use the dcumentatin t gain a better understanding f what tables yur reprts are using by viewing the

80 data set f the reprt. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

81 Tableau Server Tableau Server Tableau System Requirements Supprt prvided fr Tableau Servers with REST API enabled With the fllwing API versins: Best Practices BI Cmpare Dcumentatin a Lineage Data Dicti b Best Practices rules can be analyzed fr the Tableau Server prvider nce the user has created User Defined Best Practices a b Tableau Lineage Analysis nly supprts SQL Server Data Surces c Data Dictinary categries can be applied t the Tableau Server prvider nce custm paths have been created Getting Started Users must be a part f the Server Administratr rle. 1. After creating a slutin, click the "Add" buttn n the right side f the page 2. Give the slutin item a meaningful name 3. Select the Tableau Server prvider frm the surce type drp dwn c

82 4. Prvide a valid server URL and credentials. Imprtant Nte: The credentials used t cnnect t the Tableau Server must be assigned the Server Administratr rle. 5. Yu may als custmize yur dcumentatin by adding filters Imprtant Nte: Excluding certain types may affect Lineage Analysis.

83 6. Click "OK" t add the Tableau Server t the Slutin Items windw Sample Output Dc xpress dcuments databases acrss all majr versins f SQL Server: 2005, 2008, 2008 R2, and Created with the Standard Editin f HelpNDc: Free EPub prducer

84 Manage Aliases Manage Aliases When wrking within a cmplex envirnment, SQL Server Aliases can make it increasingly difficult t dcument the lineage between ne bject and anther. Often times, DOC xpress will detect bject dependencies t items that are external bjects currently nt within the slutin. These items appear as "Implicit Items" ( ) within Lineage Analysis. Smetimes, these implicit items are actually a part f the slutin, but the links culd nt be detected due t Server Aliases. The belw picture shws an example f an Analysis Services database that references the AdventureWrksDW2014 lcated n FL-WS-QA-TR01 thrugh the server alias "lcalhst": DOC xpress' Manage Alias feature prvides yu with a quick and easy way t rganize aliases int an easily manageable list t help simplify these external links. Hw t setup slutin aliases 1. While inside f a slutin within the DOC xpress feature, click the "Manage aliases" buttn t launch the "Manage slutin aliases" windw

85 2. The "Manage slutin aliases" windw has several buttns: 1. OK - Saves all changes t slutin aliases and clses ut f the windw 2. Cancel - Cancels ut f all changes made t slutin aliases and clses ut f the windw 3. Add - Allws the user t begin cnfiguring a new slutin alias t add t the slutin 4. Edit - Edits an already existing slutin alias 5. Delete - Deletes an already existing slutin alias 3. Clicking n the "Add" buttn will launch the "Add Slutin Alias" windw 1. Surce slutin item - designates which slutin item(s) this alias will applied. Setting the "Surce slutin item" t "Glbal" will apply this alias t all slutin items. 2. Target technlgy type - designates which technlgy this alias will be applied. Setting the "Target technlgy type" t "Nne" will apply this alias t all technlgies. 3. Surce - Designates the string the user wishes t search fr within the target technlgy. 4. Replacement - Designates the string the wishes t replace the "Surce" with 5. Match Case - Designates whether r nt DOC xpress will match the "Surce" part exactly r whether it will ignre case sensitivity. Imprtant Nte: It is imprtant t be as specific as pssible with an alias s as t nt unintentinally match an alias t an bject that shuld nt be redirected. Each rw represents the alias' bject path, with the first bject being the rt bject and each subsequent bject(s) being a child bject f the ne abve it. The less precise the alias the mre items that culd be redirected. In the abve example, nly "lcalhst.adventurewrks.db.dimcustmer" will be redirected t "FL-WSQA-TR01.AdventureWrks.db.DimCustmer". While if the slutin alias merely cntained "lcalhst",

86 this wuld redirect all bjects with the rt bject f "lcalhst" (instead f just "lcalhst.adventurewrks.db.dimcustmer") t "FL-WS-QA-TR01", which may nt be intentinal. Additinally, changing aliases can affect the utput f the dependency analysis that ccurs during the slutin snapsht prcess, s yu may need t snapsht yur slutin again befre a newly added aliases is displayed within Lineage Analysis. 4. After all slutin aliases have been added, creating a snapsht will fully extract all dependency links and display them shwing a cmplete Lineage fr the bject. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

87 Creating a Snapsht Creating A Snapsht 1. Create r pen an existing slutin. Once items have been added t the slutin, Click 'Take Snapsht'. This ptin can be fund at the tp and bttm f the windw. Yu may als select an individual slutin item and click the "Snapsht" buttn t the right f the items pane t take a snapsht f just that individual item. Dependencies f all slutin items will be updated at this time. 2. DOC xpress will display an activity mnitr as the snapsht is created. This windw can be sent t the backgrund by clicking the buttn in the bttm-right ("T Backgrund"). This will hide the Activity Mnitr frm view and allw yu t cntinue wrking. If yu wish t re-pen the Activity Mnitr, r check n the snapsht prgress, click "Activities" frm the Wrkbench ribbn bar.

88 3. Once cmplete, DOC xpress will display results f the snapsht prcess. This can be cpied t the clip bard if needed by clicking the 'Cpy Details' buttn. Imprtant Nte: After a snapsht has cmpleted, yu can expand and navigate the metadata fr a slutin item by using the Metadata Viewer. Simply select the item yu wish t explre, and left click n the "View" buttn lcated n the right side f the Items Panel. Created with the Standard Editin f HelpNDc: iphne web sites made easy

89 Cmmand Line Snapsht Cmmand Line 1. T create a snapsht using the cmmand line, ensure that yur slutin has all f the desired slutin items added t the list. Then, click the "Create snapsht request file" buttn at the bttm right and select a lcatin t place the file. This request file is a simple xml file that cntains the slutin item references. 2. Frm the cmmand prmpt, yu must run the executable "DOCxpress.exe" and specify the request file as well. 3. Yur entire cmmand shuld appear as: C:\Prgram Files (x86)\pragmatic Wrks\Pragmatic Wrkbench>DOCxPress.exe "C: \directryname\snapshtrequest.xml"

90 4. After the executin has run, yur snapsht shuld be updated. Created with the Standard Editin f HelpNDc: Free Web Help generatr

91 Generating Dcumentatin Generating Dcumentatin After yu have finished adding yur slutin items and creating a snapsht, yu are ready t generate the dcumentatin. Table f Cntents Dcumentatin Layut Generating Dcumentatin Cmmand Line Dcumentatin Imprtant Nte: Dcumentatin can be custmized by mdifying the DOC xpress Templates. These are advanced peratins, hwever, and may result in unexpected dcumentatin utputs. As such, it is recmmended t always save a cpy f the default templates befre prceeding with mdifying the templates in case the changes negatively impact yur dcumentatin. Dcumentatin Layut What DOC xpress includes within yur dcumentatin is based n the dcumentatin layut, which is fund underneath the list f items present within the Slutin. By default, all slutin items are added t the Layut autmatically, thugh items can be added, gruped, rdered, r deleted frm the Layut. 1. Adding Items t the Layut: Items can be added t the layut by selecting the specific item yu wish t include within the layut and dragging and drpping the item within the Layut Panel. Imprtant Nte:

92 DOC xpress utilizes template structure maps t manage the verall structure f the dcumentatin. When a user includes an item within the Layut that des nt have a crrespnding structure map fr that items' bject type, then DOC xpress will display a yellw warning ( ) t ntify the user that a default structure map will be used instead f ne f the supprted structure maps. When a default structure map is used, the generated dcumentatin will represent the structure f the extracted metadata, which may result in a large number f pages being generated that shw the full metadata cntent. 2. Gruping Items in the Layut: Smetimes yu might wish t grup items by technlgy, wners, servers, et cetera. This can be dne by clicking the "+ Add" buttn lcated n the right side f the Layut Panel. After creating the layut nde, simply fllw the steps fr adding items t the layut by placing the desired item(s) within the layut nde. 3. Ordering Items within the Layut: By selecting specific items, yu can adjust the rder f the Layut by either clicking the up and dwn arrws lcated n the right side f the Layut, r by dragging and drpping the item within the desired lcatin. 4. Deleting Items frm the Layut: Items can be remved frm the Layut by clicking the "Delete" buttn lcated n the right side f the Layut. Imprtant Nte: Deleting an item frm the Layut des nt remve the item and its snapshts frm the slutin, it merely excludes the item frm the dcumentatin. Generating Dcumentatin 1. Once yu are satisfied with the Layut, click the "Generate Dcumentatin" buttn lcated either at the bttm f the plug-in r within the DOC xpress ribbn

93 2. On the next screen yu can set the specific generatin pint that yu wish yur dcumentatin t be generated frm, the dcument cntrl utput type, dcumentatin title, utput flder lcatin, as well as desired utput frmat(s). Imprtant Nte Generating CHM dcumentatin requires yu t have HTML Help Wrkshp and Dcumentatin.

94 3. Once yu have yur ptins cnfigured hw yu want them, click OK t begin generating yur dcumentatin. 4. After dcument generatin is cmpleted, if the "Autmatically Open Generated Dcuments" preference is enabled and multiple frmats were generated, yu will be presented with a cmpletin windw that will give yu shrtcuts t any f the dcument frmats yu chse t create.

95 5. Generated dcumentatin als supprts images. SQL server dcumentatin will autmatically generate impact analysis. Imprtant Nte Lineage Analysis and Data Dictinary utput can be suppressed frm inclusin in the dcument thrugh the DOC xpress Templating preferences.

96 Created with the Standard Editin f HelpNDc: Free EPub prducer

97 Cmmand Line Dcumentatin Cmmand Line 1. Once a snapsht f yur slutin has been created, yu may generate dcumentatin. T d this frm the cmmand line, yu must first create a Dcumentatin Request file. Set yur layut in the DOC xpress UI, and then click the "Create dcumentatin request file" buttn at the bttm right. 2. Yu will be prmpted t select a type f utput (r multiple types, if yu prefer), and set the lcatin that the utput will be stred.

98 3. Once yu have set the utput type and lcatin, click "OK" and select a directry fr the dcumentatin request file. 4. Next, as with the snapsht generatin, run the "DcxPress.exe" executable frm the cmmand prmpt and specify the dcumentatin request file. 5. Yur entire cmmand shuld appear as: C:\Prgram Files (x86)\pragmatic Wrks\Pragmatic Wrkbench>DOCXPRESS.exe "C: \directryname\dcumentatinrequest.xml" 6. After the executin has run, yur dcumentatin will be utput int the directry yu specified in the step abve. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

99 Data Dictinary Data Dictinary Data Dictinary prvides users with the ability t anntate the bjects within a DOC xpress snapsht, including additinal infrmatin and cmments. Users ften want t capture additinal infrmatin as part f their dcumentatin. Infrmatin like SLAs, persns respnsible fr the data, timeliness f the data, and ther attributes can be captured using DOC xpress' Data Dictinary. By adding anntatins t existing bjects in the DOC xpress repsitry, users can capture any additinal infrmatin they desire. Ntice: Data Dictinary wrks hand-in-hand with the DOC xpress feature and requires an already set up Slutin with at least ne Snapsht generated. If this has nt yet been dne, please fllw the steps described in "Creating yur DOC xpress Slutin". Feature Highlights Add business definitins t any item in the dcumentatin Prvide anntatins useful t business users Create and manage anntatins in yur DOC xpress dcumentatin Ntice: Data Dictinary wrks hand-in-hand with the DOC xpress feature and requires an already set up Slutin with at least ne Snapsht generated. If this has nt yet been dne, please fllw the steps described in "Creating yur DOC xpress Slutin". 1. When yu first pen the Data dictinary frm Pragmatic wrkbench yu will have the ptin create a metabase r cnnect t an existing ne.

100 2. Once yu create yur metabase r cnnect t an existing ne yu will chse which slutin t pen. 3. After pening yur slutin yu will be greeted with the Data Dictinary welcme screen. T get started click "Get Started"

101 4. When yu create a data dictinary, yu will first need t create categries. A categry is a field that will cntain infrmatin abut different bjects in the slutin, such as business wner, emergency cntact, etc. Click "Add" t create a categry. 5. On the next page yu will name yur categry and select its scpe. This scpe can be t the metabase, a whle slutin, r an item in a slutin. After selecting the scpe, chse the technlgy type and a data type fr the categry.

102 6. Yu will then chse an applicable item and then click Add. Additinally, users can create custm applicable items by using the Wrkbench Path Language t select specific metadata bject types they wish fr the current categry t be applied. Imprtant Nte: Fr mre infrmatin n the Wrkbench Path Language syntax used within the Data Dictinary categries, please click here. 7. After yu click "OK" yu will be taken back t the chse slutin screen. Select yur slutin and click pen. Inside the slutin select the item t which the categry was added and click pen.

103 8. Here yu can expand the bject tree until yu see text bxes, this is where infrmatin abut the individual bjects can be added. 9. The next time dcumentatin is generated, the data dictinary entries will be displayed within the dcumentatin n each f the crrespnding bjects cntaining ppulated Data Dictinary categries.

104 10. The Analyze feature f the Data Dictinary tl allws yu t scan yur metabase r slutin fr bjects that yu've assigned mandatry categries, but have yet t be assigned values. 11. Frm the Slutin Windw, click the "Analyze" buttn. Yu will see an Activity Mnitr as the ne belw appear. Any errrs r warnings caught during the analysis prcess will be displayed here. 12. After yu cmplete the analysis, yu will see a results windw like the ne belw. In the example shwn, yu can see that the Smke slutin has a ttal f 714 bjects with categries, and 35 f

105 thse bjects are missing values fr their required categries. Yu may als nte that 20 f thse belng t the Lcalhst slutin item, 1 is in the SSAS - FLWSCONS01 slutin item, and the remaining 14 are lcated in the SSIS Catalg slutin item. The items in bld are slutin items that have missing entries. 13. T begin wrking t reslve these, click n ne f the slutin items and select "Open" frm the right. This will pen the Grid View f that bject s yu may edit the categry values. Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

106 Lineage Analysis Lineage Analysis Lineage Analysis allws users access t answer the fllwing tw very imprtant questins: Where did this data cme frm? Where is this data used? A huge time-drain fr all types f SQL develpers and DBA's, whether fcused n BI r nt, is tracing the lineage and impact f data within a system. Lineage Analysis eases this strain by enabling users the ability t explre the dependencies in their envirnment. Imprtant Nte: Lineage Analysis wrks hand-in-hand with the DOC xpress feature and requires an already set up slutin with at least ne snapsht generated and its dependency scanned. If this has nt yet been dne, please fllw the steps described in "Creating yur DOC xpress Slutin". Feature Highlights Diagrammatic and interactive frm saves users many hurs Speeds up develpment by giving users the ability t view dependencies clearly Enables users t pinpint the surce f data in bjects Allws business analysts t make clear judgments abut the crrectness f data Enables users t easily identify areas where errr may be intrduced Table f Cntents Visual View Text View Trace Mde T access this infrmatin, click n Lineage Analysis lcated n the tp navigatin bar. Once laded, users will be shwn all available slutins within the DOC xpress repsitry cntaining Lineage Analysis. These slutins can be srted by: Date Created, Name, Last Updated, Last Snapsht, and Last Refreshed. They then can be placed in Ascending r Descending rder.

107 Frm here users can click n a slutin t g t the Lineage fr that slutin. By default, users will be directed t Lineage Analysis' visual view. If users wish t view a textual versin f Lineage Analysis, click the text view ( ) buttn lcated n the Lineage Analysis tlbar. T utilize the trace mde functinality, fllw the steps detailed n the trace mde page. Fr Lineage Analysis t wrk prperly, it requires the desired slutin t cntain a dependency set. If there is n dependency set fr the currently selected slutin, a red warning will appear prmpting the user t immediately take a snapsht. A snapsht must be taken befre Lineage Analysis will allw a user t view the dependencies fr a slutin. Thugh there are three different views t help users navigate the dependencies f their slutins, there are tw cmmn sectins that are fund within all three views: Lineage Analysis Tlbar and Slutin Explrer. Lineage Analysis Tlbar Regardless f the current view, the lineage analysis tlbar allws users t navigate arund and adjust the behavir f Lineage Analysis. Change cnnectin: Lcated n the Lineage Analysis tab f the tlbar, the change cnnectin allws users t cnnect t a different DOC xpress metabase Back t Slutin Selectin: Lcated n the Lineage Analysis tab f the tlbar, the back t slutin selectin buttn allws users t g back t the list f available slutins fr use within Lineage Analysis

108 Manage Aliases: Lcated n the Lineage Analysis tab f the tlbar, the manage aliases buttn allws users the ability t clarify the lcatin f implicit items fr this slutin. Fr mre details n the inner wrkings f this feature, view the manage aliases page. Imprtant Nte: After aliases have changed, DOC xpress will be required t snapsht the slutin in rder t refresh the dependency links within Lineage Analysis. Detail Level: Lcated n the Lineage Analysis tab f the tlbar, the detail level buttn allws users the ability t adjust the granularity f the bjects that will be included within the current sessin f Lineage Analysis High Detail: Allws users the ability t see dwn t the clumn, measure, and attribute level f lineage Medium Detail: Allws users the ability t see dwn t the table, cmpnent, SSRS item, KPI, and measure grup level f lineage Lw Detail: Allws users the ability t nly see the database, package, and reprt level f lineage Diagram Layut: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual view nly, the diagram layut buttn allws users t cntrl the way bjects are rganized within the lineage diagram Frce-Directed: Organizes the diagram in a nndeterministic manner surrunding the fcused bject Circle: Organizes the diagram int cncentric rings with the fcused bject being in the center Grid: Organizes the diagram in a grid where inbund dependencies are in ne clumn and utbund dependencies appear in anther clumn Save Image: Lcated n the Lineage Analysis tab f the tlbar enabled in visual view nly, the save image buttn allws users t save the current diagram as an image Relad Slutin: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual and textual view nly, the relad slutin buttn allws users the ability t refresh the lineage data frm the DOC xpress metabase Shw Legend: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual view nly, the shw legend buttn allws users the ability t tggle the refresh the legend Dependency Directins: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual and

109 textual view nly, the dependency directin buttn allws users the ability t adjust the directin types f the dependencies t include within the current sessin f Lineage Analysis. An bject dependencies are typically created when an bject is included within anther bject's definitin. Bi-Directinal: Bth inbund (lineage) and utbund (impact) dependencies will be included within the current sessin Inbund Only: Only relatinships that an bject depends n will be included within the current sessin Outbund Only: Only relatinships that are impacted by bjects will be included within the current sessin View Mdes: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual and textual view nly, the view mde buttn allws users the ability t alternate between the three different view mdes used within Lineage Analysis Visual View: Allws the user t view the currently fcused bject using the visual view Text View: Allws the user t view the currently fcused bject using the text view Trace Results: Only enabled when a trace has been executed, the trace results buttn switches the user t trace mde Shw Trace Bar: Lcated n the Lineage Analysis tab f the tlbar, the shw trace bar buttn allws users the ability t tggle the trace mde bar Track Selectin: Lcated n the Lineage Analysis tab f the tlbar, the track selectin buttn allws users the ability t disable the feature that causes the diagram t re-draw every time a new selectin is made within the Slutin Explrer Dependency Level: Lcated n the Lineage Analysis tab f the tlbar and enabled in visual view nly, the dependency level buttn allws users t increase r decrease the number f levels f separatin frm the currently fcused bject t be displayed within the Lineage Diagram. Imprtant Nte: The mre dependency levels included within the Lineage Diagram may cause it t becme increasingly mre difficult t read the diagram. Key Filter: Lcated n the Refinements tab f the tlbar and enabled in visual and textual view nly, the key filter buttn allws users the ability t tggle the visibility f relatinship links that invlve the use f freign keys Object Filter: Lcated n the Refinements tab f the tlbar and enabled in visual and textual view nly, the key filter buttn allws users the ability t tggle the visibility f relatinship links that invlve bject dependencies Data Lineage Filter: Lcated n the Refinements tab f the tlbar and enabled in visual and textual view nly, the key filter buttn allws users the ability t tggle the visibility f relatinship links that invlve the impact r dependency f anther bject's data will be visible

110 Cllapse by Technlgy: Lcated n the Refinements tab f the tlbar, the fur cllapse by technlgy buttn allws users the ability t tggle between cllapsing all bjects f a specific technlgy that the user wishes t nt view int a single, mre manageable, nde Slutin Explrer The slutin explrer cntains a hierarchically rganized tree f all bjects fund within current detail level that cntain lineage. If track selectin is enabled, left clicking n an bject within the slutin explrer will re-draw the lineage diagram fcused n the currently selected bject.

111 Users can expand and cllapse bject, displaying the bject's children, using the arrw t the left. If an bject des nt have an arrw then that bject either des nt have any child bjects that cntain lineage r the current detail level prevents it frm expanding further. Users can als take advantage f the search text bx, allwing users the ability t quickly search the current slutin fr the exact bject they wish t view lineage fr. Additinally, users can right click n bjects within the slutin explrer t launch a cntext menu that will help users take advantages f ther DOC xpress features. Fcus n this: If track selectin is disabled and the currently selected bject cntains lineage, the fcus n this buttn will refresh lineage analysis with the with the currently selected bject fcused View metadata: If the currently selected bject cntains metadata, the view metadata buttn will launch the Metadata Viewer fcused n that specific item. Set as trace surce: If the currently selected bject cntains lineage, the set as trace surce buttn will enable the trace bar and set the currently selected bject as the surce. This cntext menu ptin is used within trace mde Set as trace target: If the currently selected bject cntains lineage, the set as trace target buttn will enable the trace bar and set the currently selected bject as the target. This cntext menu ptin is used within trace mde Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

112 Visual View Visual View By default, users will autmatically be directed t Lineage Analysis' visual view. Where the view diagram panel takes up a majrity f the windw within Lineage Analysis'. It applies all f the settings selected within the lineage analysis tlbar t the currently fcused bject within the slutin explrer t create a visual representatin f the bject's lineage. The use f icns and clr within the diagram will help users quickly identify the bject and technlgy types assciated with each nde. Belw is the legend that is shwn in the DOC xpress lineage view when we click n the 'Legend' icn. Nte that the clrs can be cnfigured using the Preferences sectin within Wrkbench.

113 Including the tw buttns in the lwer left f the diagram, the diagram des have ther ways f navigating the diagram in a meaningful way. Mve Nde: Left-clicking n a nde and then dragging the muse allws users the ability t mve a single nde arund the diagram withut affecting the ther ndes. Pan: Left clicking n the view diagram allws users t pan the lineage diagram t see mre f the diagram if it des nt all fit within the screen. Zm in and ut: Using the muse wheel allws users t zm in and ut t see mre details within the diagram Reset Zm: Clicking the reset zm buttn allws users t reset the zm f the diagram t its default value Zm Preview: Clicking the zm preview buttn allws users the ability t launch the zm preview windw.

114 The zm preview windw cntains a small preview windw f the entire lineage diagram as well as the ability t zm in, zm in, and quickly change views Lineage Rute Inspectr: Duble-clicking n a link between tw bjects will launch the lineage rute inspectr. The lineage rute inspectr allws users the ability t view all dependencies that link ne bject t anther bject. Lineage Rute Inspectr: Duble-clicking n a link between tw bjects will launch the lineage rute inspectr. The lineage rute inspectr allws users the ability t view all dependencies that link ne bject t anther bject. Cntext Menu: Right-clicking n an bject nde will launch a cntext menu that will prvide users with a number f functins Fcus n this: Clicking the fcus n this buttn will autmatically re-draw the diagram with the currently selected bject as the main fcus View metadata: If the currently selected nde cntains metadata, the view metadata buttn will launch the Metadata Viewer fcused n that specific item. Shw cllapsed item names: If the currently selected nde is a cllapsed technlgy, the shw cllapsed item names buttn prvides users with a detail list f all the cntaining bjects Extend this item: Clicking the extend this item buttn will, if pssible, display mre dependency levels fr the currently selected bject Hide this item: Clicking the hide this item buttn will temprarily hide the currently selected nde. Once the diagram is redrawn it will be included again.

115 Hide this item fr this sessin: Clicking the hide this item buttn will ignre the currently selected nde, excluding it frm being included within the diagram. Clicking the relad slutin buttn will include the select nde within the lineage again. Set as trace surce: If the currently selected bject cntains lineage, the set as trace surce buttn will enable the trace bar and set the currently selected bject as the surce. This cntext menu ptin is used within trace mde Set as trace target: If the currently selected bject cntains lineage, the set as trace target buttn will enable the trace bar and set the currently selected bject as the target. This cntext menu ptin is used within trace mde Created with the Standard Editin f HelpNDc: iphne web sites made easy

116 Text View Text View While Lineage Analysis' Visual View allws users the ability t visually navigate the dependencies fund within a specific slutin. After selecting an bject frm the slutin explrer, the lineage analysis explrer will lad a hierarchically rganized tree f the bject its dependencies as well as three clumns: Object, Type, and Endpint. Object: This clumn cntains the name f the bject Type: This clumn cntains the technlgy and bject type Endpint: This clumn cntains the cmplete path t the bject If the dependency directin is set t BI-Directinal, then expanding an bject will reveal tw ndes: Outbund and Inbund Dependencies. Outbund Dependencies: All relatinships that are impacted by the parent bject will be included underneath the utbund dependencies nde Inbund Only: All relatinships that the parent bject depends n will be included underneath the inbund dependencies nde Otherwise, expanding an bject will reveal all respected relatinships fr the dependency directin that is currently set. This means that if the dependency directin is set t inbund nly, then expanding an bject will reveal all relatinships that an bject depends n. Likewise, if the dependency directin is set t utbund nly, then expanding an bject will reveal all relatinships that are impacted by the bject.

117 Created with the Standard Editin f HelpNDc: Full-featured Kindle ebks generatr

118 Trace Mde Trace Mde Trace mde allws users the ability t set a surce and target bject and then run a trace that builds a step by step path frm the starting bject t the target bject. Users can begin trace mde using three different techniques. 1. Within the slutin explrer, users can right-click n an bject t launch a cntext menu. Clicking n either the "set as trace surce" r "set as trace target" buttns will enable the trace bar and set the respected item as either the surce r target item 2. Within visual view, users can right-click n a nde t launch a cntext menu. Clicking n either the "set as trace surce" r "set as trace target" buttns will enable the trace bar and set the respected item as either the surce r target item 3. Enabling the trace bar will allw users t left-click n bjects within the slutin explrer r text view and drag-and-drp them int either the surce r target text bx.

119 Once bth the surce and target have been set, users can click the trace switch buttn t switch the surce bject with the target bject. After the user is cntent with the surce bject and target bject, click the start trace buttn t allw DOC xpress begin calculating all pssible paths between the surce and target bjects. Trace Operatin Traces will nly fllw similar types f link - s, fr example, a rute frm bject A t bject B wuld nt be reprted if it was cmprised f Clumn and Object links. The links that can be cmbined t frm a trace rute are: Clumn and Data Flw links Freign Key and Freign Key Clumn links Object links Sme links may be reprted as 'Link Set' r 'Aggregate' - this happens when multiple types f link fllw the same path. Nte that the trace peratin respects the 'Refinements' set in lineage. S, if yu nly want t trace data lineage, then deselect the 'Object' and 'Key' refinements befre starting the trace. This can significantly imprve the perfrmance f a trace as it reduces the size f the search graph. Trace will als perate frm target t surce, tracing backwards. This is because ften a key table within a database will be read by many entities, but nly updated by a few. By tracing in reverse, we cut dwn n the number f paths we must fllw because nly thse links that update the table need t be traced in rder t find that rute. Imprtant Nte: The prcess f calculating all pssible paths between a surce and target bject may take several minutes depending n the cmplexity f the slutin. If at any time a user wishes t terminate the prcess, click the cancel buttn. Results Once trace calculatins are cmpleted, the first trace path will be displayed. Users can mve between each f the trace paths by clicking left and right n the trace results page

120 numbers. The number f rutes returned is limited by the "Trace Mde Rute Limit" preference and the shrter rutes will be displayed first befre the lnger nes. Each path result cntains a series f bjects each cnnected by a rute dependency. The first bject in the trace result will be lcated at the tp f the trace result view and will always be the surce bject. Likewise, the last bject in the trace result will be lcated at the bttm and will always be the target bject. Each rute dependency cntains a link set. When clicked, the user will be shwn a list f the rute infrmatin that created the dependency. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

121 Metadata Viewer Metadata Viewer DOC xpress Metadata Viewer allws users t dive int each Slutin Item and navigate the metadata f an bject directly. Feature Highlights Explre yur Slutin Items' metadata withut needing t generate dcumentatin Build paths thrugh the Search Panel t help custmize yur dcumentatin Table f Cntents Reaching the Metadata Viewer Navigatin Metadata Tree Object Prperties Search Panel Reaching the Metadata Viewer

122 The Metadata Viewer can be reached using three separate methds: 1. DOC xpress Slutin Management Frm within the DOC xpress plug-in n the Slutin Management page, a user can navigate items that have already had a snapsht taken. When the user reaches an item they wish t view the metadata fr, they can click the "View" buttn lcated n the right f the items panel. This will take them directly t the Metadata Viewer fcused n the item previusly highlighted. 2. DOC xpress Snapsht Management Frm within Snapsht Management n the Slutin Management page, a user can navigate items that have already had a snapsht taken. When the user reaches an item they wish t view the metadata fr, they can click the "View" buttn lcated n the right f the items panel. This will take them directly t the Metadata Viewer fcused n the item previusly highlighted. 3. Lineage Analysis

123 Imprtant Nte: Nt all bjects r ndes within Lineage Analysis' Graph and Tree will necessarily have metadata assciated with them. The mst likely causes fr this t ccur r due t gruping ndes via the "Cllapse by technlgy" feature r implicit bjects that are included within the lineage graph but are nt a part f the snapsht. Frm within Lineage Analysis after selecting a slutin, a user can expand the Lineage Tree lcated n the right until they reach an item they wish t view the metadata fr. Once they find an item they wish t view, they can right-click n the item and select "View metadata" when the cntext menu appears. This will take them directly t the Metadata Viewer fcused n the bject that was right-clicked n frm within the lineage graph. Frm within Lineage Analysis after selecting a slutin, a user can visual navigate the lineage f their slutin until they reach an item they wish t view the metadata fr. Once they find an item they wish t view, they can right-click n the item frm within the visual graph and select "View metadata" when the cntext menu appears. This will take them directly t the Metadata Viewer fcused n the nde that was right-clicked n frm within the lineage tree.

124 Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

125 Navigatin Navigatin When the Metadata Viewer is first pened, it will be divided int tw sectins: Metadata Tree and Object Prperties. In additin t these tw panels, the Search Panel can als be displayed. Metadata Tree The Metadata Tree Panel is lcated n the left f the Metadata Viewer and is used t manually explre an bject's metadata by expanding/cllapsing ndes within the Metadata Tree. Each nde within the Metadata Tree cntains tw items: The bject name and the bject type. 1. Object Name: The Object Name represents the name given t the bject as displayed within yur envirnment. The Object Name is cmmnly the mst familiar name that yu might use fr that particular bject and is used by DOC xpress t name match an bject t Templates frm a specific Structure Map when generating dcumentatin. 2. Object Type: The Object Type represents the bject's class and is used by DOC xpress t type match an bject t Templates frm a specific Structure Map when generating dcumentatin. Object Prperties Panel The Object Prperties Panel is lcated n the right f the Metadata Viewer and displays details fr the currently selected Object within the Metadata Tree r Search Panel. In additin t the bject prperties, yu can als display bject details and as well as enable the display f a prperty value textbx that allws yu t cpy values frm the currently selected prperty. 1. Shw Object Details: Displays specific metadata prperties fr the currently selected bject. Thugh mst f these prperties can be fund by default within the Metadata Tree (Object Name and Object Type), the Object Path is particularly imprtant when building paths thrugh the Search Panel r fr Structure Maps. 2. Shw Prperty Value: Displays a selectable textbx at the bttm f the Object Prperties Panel that allws the user t select and cpy the prperty's value ut f the Metadata tree. Prperty Value textbx is particularly valuable extracting DDL Scripts and ther prperties that may cntain lng strings.

126 Search Panel The Search Panel allws yu t use the Wrkbench Path Language t dynamically search a Metadata tree fr the currently scped bject that fit specific criteria. The Search Panel can be displayed by selecting "Shw search panel" frm the Metadata Viewer ribbn lcated at the tp f the plug-in. Imprtant Nte: Fr mre infrmatin n the Wrkbench Path Language syntax used within the Metadata Viewer, please click here. In additin t searching the Metadata tree, the Search Panel is a valuable tl fr assisting in creating custm Structure Maps. When using the Search Panel, the Metadata Tree Panel can tggle between viewing a filtered tree that nly displays the Search results that match the path, r the full metadata tree. 1. Shw Tree: When n the Search Results Panel, the "Shw Tree" buttn will be enabled and allws users t switch between displaying the search results fr the currently filtered and the unfiltered metadata tree. 2. Shw Search Results: When n the Metadata Tree Panel and a valid search has been initiated, the "Shw Search Results" buttn will be enabled and allws users t switch between displaying the unfiltered and filtered metadata tree. Imprtant Nte: The Search Panel will display search results based n the scpe f the currently selected item. If the scpe changes, typically by selecting a nde frm within the Metadata Tree r the Search Results, then it is very likely that the path selectr used t search will n lnger display results. Created with the Standard Editin f HelpNDc: Full-featured Kindle ebks generatr

127 Snapsht Cmparisn Snapsht Cmparisn Snapsht Cmparisn enables users t determine the differences in their SQL Server envirnments ver time. Having the ability t cmpare slutin items at different pints in time can save a lt f time fr develpers and DBA's wh are attempting t track dwn the surce f either cnsistency r perfrmance prblems. Ntice: Snapsht Cmparisn wrks hand-in-hand with the DOC xpress feature and requires mre than ne snapsht within yur metabase t be useful, whether thse snapshts are f the same r different slutin items; if this has nt yet been dne, g t "Creating yur DOC xpress Slutin" and fllw thse steps. Feature Highlights View changes that have ccurred in yur SQL envirnment ver time Find differences between tw separate envirnments Cmpare Yur Snapshts Ntice: Snapsht Cmparisn wrks hand-in-hand with the DOC xpress feature and requires mre than ne snapsht within yur metabase t be useful, whether thse snapshts are f the same r different slutin items; if this has nt yet been dne, please fllw the steps described in "Creating yur DOC xpress Slutin". 1. Open Snapsht Cmparisn frm the Pragmatic Wrkbench. 2. Set the Left and Right Surce by chsing the Slutin, Slutin Item, and versin (snapsht date) t cmpare. If yu attempt t cmpare bjects that are f different technlgy types, yu will receive a message that advises against this. 3. By default, the Left and Right Starting pint will be set t the rt f the surce. This can be changed, hwever, t create a mre specific cmparisn. Adjusting the left and/r right starting pints are an excellent way t cmpare the same item that has been been mved frm ne envirnment t anther. Fr example, in the abve screensht we are cmparing the SSIS Package "AdventureWrksETL" that has been deplyed frm develpment t prductin envirnment. 4. Click "OK" nce the abve step is cmplete.

128 This will lad the snapshts int the cmparisn windw fr review. Imprtant Nte T save space in yur DOC xpress metabase, a new snapsht may nt be created every time yu run the snapsht. Only when an bject r prperty changes between the last snapsht and current will a new versin be created. Yu can chse t view bjects that are equal, nt equal, exist n the left side nly, and exist n the right side nly. Just like in BI Cmpare, yu may filter in r ut specific bjects frm the cmparisn. Yu may als chse t switch an individual side f the cmparisn frm the windw as well. As an example, in the cmparisn n the right, there is a stred prcedure that exists in the snapsht n the left that desn't exist in the snapsht n the right. This makes all parent levels unequal s the user can lcate the difference. Created with the Standard Editin f HelpNDc: Easily create Qt Help files

129 Snapsht Management Snapsht Management The Snapsht Management feature in DOC xpress gives users an easy way t keep track f and maintain snapshts in the DOC xpress repsitry. Feature Highlights Easily imprt and exprt entire slutins r individual slutin items Manage repsitry size by purging snapshts that are n lnger needed Table f Cntents Exprting Slutins and Slutin Items Imprting Slutins and Slutin Items Purging Slutin and Slutin Item Histry Viewing Slutin and Slutin Item Histry Rescan Dependencies Explring Slutin Item Metadata Slutin Management The Slutin Management page allws yu t manage all f the slutins within yur DOC xpress metabase. Frm this screen yu can exprt slutins, imprt slutins, purge a slutin's histry, r view a slutin's histry. Slutin Item Management 1. Frm the Slutins page f the Snapsht Management add-in, select a slutin that yu wish t manage and then chse "Open." 2. This pens the slutin t shw all slutin items within. Frm here, the user may expand the hierarchy t view child bjects and can exprt slutin items, imprt slutin items, purge a slutin item's histry, view a slutin item's histry, r even view a slutin item's metadata.

130 View Histry Users can view the histry f their slutins by clicking the "Histry" buttn. The Histry panel displays a list f extracted snapshts. Rescan Dependencies Users can trigger a dependency scan by clicking the rescan buttn. This dependency scan des nt take a new snapsht. Instead, it rebuilds the lineage used within Lineage Analysis fr the latest snapsht. If cnnected t a DOC xpress Server instance, it als ntifies the server t refresh the slutin's metadata. It culd take several minutes fr the changes t appear within DOC xpress Server. Metadata Viewer The Metadata Viewer can be used t navigate the metadata fr a specific slutin item. T navigate t the metadata viewer, click n the slutin item yu wish t view, and then click the "View" buttn t navigate t the Metadata Viewer. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

131 Exprt Exprting Slutins and Slutin Items This feature creates an bfuscated file that can be used as a back up fr yur DOC xpress slutins. These files can then be transprted t ther envirnments r imprted int ther slutins/doc xpress databases. Upn selecting "Exprt", chse what slutin items yu wish t exprt. 1. Befre exprting, select the slutin items yu wish t include within the exprt. 2. Then, select the amunt f Histry yu wish t include within the exprt. 3. After selecting the items desired, click "Exprt". This will bring up a Windws Explrer windw t chse where t save the file.

132 4. Then, yu will be presented with a prgress bx that will tell yu when the exprting has cmpleted. Created with the Standard Editin f HelpNDc: Easily create CHM Help dcuments

133 Imprt Imprting Slutins and Slutin Items This feature takes the bfuscated snapsht file created frm an exprted snapsht and includes them in a new r existing slutins. Yu can even imprt them int new DOC xpress databases. 1. Frm the Snapsht Management page, click "Imprt." 2. Here, yu will be presented with a Windws Explrer windw that will allw yu t select the.dxm file that cntains the snapshts yu wish t imprt. 3. On this page, yu can select which bjects yu wish t imprt, whether yu want t imprt them int an existing r new slutin, and the name yu want fr each slutin item. Be sure t rename any slutin items that may have the same name as an existing slutin item (this errr is dented by a red x).

134 4. After yu've chsen which bjects t imprt, click the Imprt buttn. 5. Finally, chse whether t run a dependency scan n the new slutin items.

135 Imprtant Nte Since yu have added slutin items t yur slutin, yu shuld cnduct a new dependency scan t rebuild the lineage histry f the slutin. Hwever, this can be dne at a later time, but yur lineage may be ut f date until it is cnducted. Created with the Standard Editin f HelpNDc: iphne web sites made easy

136 Purge Purging Slutin and Slutin Item Histry After a perid f time, the user may wish t free up space n within their DOC xpress metabase. The Purge feature allws users t clear ut ld snapshts frm slutins r slutin items based n five different methds. 1. On the "Purge Slutin [Item]" page, chse the time perid t clear. 2. Cnfirm yur selectin. 3. After cnfirming, the Wrkbench Activity Mnitr will appear allwing yu t view the prgress f the data purge.

137 Created with the Standard Editin f HelpNDc: Easily create CHM Help dcuments

138 Frequently Asked Questins Frequently Asked Questins Pragmatic Wrkbench Frequently Asked Questins Cmmn Activatin Warnings with Pragmatic Wrkbench Hw d I activate r upgrade my installatin f Pragmatic Wrkbench? Hw d I deactivate my installatin f Pragmatic Wrkbench? Why d my icns have a lck in the upper left hand crner? DOC xpress Frequently Asked Questins Hw can I manage and purge ld snapshts stred within DOC xpress? Hw d I custmize the way my dcumentatin lks? Hw d I generate a snapsht using the cmmand line applicatin? Hw d I make dcumentatin using the cmmand line applicatin? Installing the DOC xpress database t an AlwaysOn High Availability Grup What are the DOC xpress trial limitatins? What features are available fr each f the prviders? Why is a prvider nt shwing up within the Surce Type drp dwn menu? My evaluatin perid has ended. Will I lse the snapshts I have already created when I enter my license? What are the required permissins needed by DOC xpress Users? What are the system requirements fr DOC xpress t wrk prperly? Where can I find a list f the supprted Structure Maps that are included with my installatin? Why can't I view the CHM files created by DOC xpress? Why are there yellw warning symbls within my Slutin's Layut? Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

139 Cmmn Activatin Warnings Cmmn Activatin Warnings This warning is due t license already being activated: T reslve this, fllw the steps belw: 1. G t yur accunt management lcated at 2. Select the "My Accunt" 3. Lg In and select the Registered Prducts Tab 4. Expand the arrw next t the prduct yu are trying t register and it will list all the fllwing infrmatin, here yu will identify the envirnment identifier and key yu wuld like t deactivate.

140 5. After lking at this infrmatin yu find that yu can deactivate a license, yu can g thrugh the help page f the Wrkbench. If that user is n lnger with the rganizatin, yu can cntact Pragmatic Wrks Supprt via with the Envirnment Identifier and Envirnment Key. Created with the Standard Editin f HelpNDc: Easily create Web Help sites

141 Activating Pragmatic Wrkbench Hw d I activate r update my installatin f Pragmatic Wrkbench? Prduct activatin ccur within the Pragmatic Wrkbench help tab. This tab manages licensing and versin infrmatin. It als prvides yu with quick access t view lcal help dcumentatin. 1. T activate any Wrkbench prduct, within wrkbench, navigate t the help page 2. Fr the prduct yu wish t activate, select "Register" r "Mdify" 3. This will launch the Licensing windw. There are tw ways t activate yur prduct: autmatic and manual activatin.

142 4. Autmatic Activatin: Click "Use an activatin key" if yu have have an activatin key and access t the internet Manual Activatin: Click "Activate manually withut Internet cnnectin" if yu need help frm the Pragmatic Wrks' Supprt staff r d nt have access t the internet. Autmatic Activatin If yu select "Use an activatin key", paste r type the activatin key within the prvided text bx. If its frmat is valid, a green check will appear. Click "Activate".

143 5. 6. Manual Activatin If yu clicked "Activate manually withut Internet cnnectin", click the "Cpy Details t Clipbard" buttn. Paste the cpied infrmatin within an addressed t supprt@pragmaticwrks.cm.

144 7. 8. A Pragmatic Wrks Supprt representative will prvide yu with a manual key. Paste the manual key within the prvided text bx and then click "Activate". Upn activating, the licensing windw displays a list f all currently activated prducts Imprtant Nte Upgrading r dwngrading yur installatin is easy. When yu get a new key fr a different versin f the prduct, fllw the steps abve. Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

145 Deactivating Pragmatic Wrkbench Hw d I deactivate my installatin f Pragmatic Wrkbench? Prduct deactivatin ccur within the Pragmatic Wrkbench help tab. This tab manages licensing and versin infrmatin. It als prvides yu with quick access t view lcal help dcumentatin. The licenses fr Pragmatic Wrkbench are per machine. If anther machine needs t run Wrkbench, then the secnd machine will als need a license. Alternatively, users can mve the license frm the ld machine t the new machine. Mving a license requires the user t deactivate the license n the ld machine and then reactivating it n the new machine T deactivate any Wrkbench prduct, within wrkbench, navigate t the help page. Befre prceeding, yu may wish t cpy the activatin key. This is helpful when mving the license frm ne machine t anther. T cpy an activatin key, click the activatin key yu wish t cpy.

146 3. Click the "Deactivate" buttn fr the prduct yu wish t deactivate A deactivatin windw will prmpt yu fr cnfirmatin. If yu wish t deactivate, click "Yes". Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

147 Lcks n Icns Why d my icns have a lck in the upper left hand crner? If yur prduct is displaying a lck n the upper left hand crner f any f yur feature's icns, yu need t purchase an activatin f that prduct. Yu can d s by visiting If yu already have purchased an activatin please see Activating r upgrading yur installatin fr help. Yu will generally see this after yur trial perid has ended and yu have yet t activate yur prduct. As seen here, the icns have lcks and are als grayed ut. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

148 Custmizing Dcumentatin Hw d I custmize the way my dcumentatin lks? Table f Cntents Intrductin Dcument Cntrl Structure Map Templates The DOC xpress and DOC xpress Server templates are used t lend frm and reasn t the utput. They are fully custmizable and cntrl what infrmatin is included in the dcumentatin. Fr users that are just beginning t learn hw t custmize their templates, it is recmmended that they first read thrugh the intrductin befre cntinuing. After cmpleting the intrductin, the dcument cntrl, structure map, and templates pages can prvide users with a mre detailed descriptin f the functins present within the DOC xpress template dcumentatin generatin. By default, the templates are stred within a flder in the installatin directries fr Pragmatic Wrkbench and Wrkbench Server. Belw can be fund the tw default install lcatins: DOC xpress C:\Prgram Files (x86)\pragmatic Wrks\Pragmatic Wrkbench\DOC xpress Templates DOC xpress Server C:\Prgram Files (x86)\pragmatic Wrks\Wrkbench Server\DOC xpress Web Services\DefaultTemplates Imprtant Nte: Mdificatin f the DOC xpress templates are nt fficially supprted by Pragmatic Wrks and this cannt be stressed enugh. While we d prvide dcumentatin and guidance within the help dcumentatin, any mdificatin t the DOC xpress templates is taken at the risk f the user. Because f this, users are encuraged t back up the DOC xpress templates flder befre beginning any mdificatin wrk. At this time, the nly assistance Pragmatic Wrks Supprt may ffer is in the restratin f the template files t their riginal state. Within the template flder, Yu will ntice fur files types and tw flders: *.template files cntrl the general layut f an bject and the prperties that are displayed within that bject's page *.lkup Used t manage the lkup key-value pairs that are searched when called frm the Lkup( ) Functin. defaulttemplate.dcumentcntrl This file is respnsible fr setting what is and is nt displayed within templates and Structure Maps using utput type flags that are set in the Generate Dcumentatin dialg bx.

149 StructureMap.*.xml Cntrls the verall structure f the rt bject within a Slutin Layut. If a valid Structure Map cannt be fund then the StructureMap.Default.xml will be used, which is a data dump. Images - This flder cntains all f the images that are used alng side the Image( ) Functin. TemplateImage This flder cntains small (16x16) and large (32x32) icns fr many f the majr templates. T add additinal TemplateImages, the images must be saved within the TemplateImage flder in the fllwing syntax: <template key><size> template key The key f the template file that yu wish t include, as described in the templates Page( ) functin. size Whether this template image is the small (16x16) r large (32x32) versin f the icn Imprtant Nte: If yu plan t use custm templates, please ensure that yu take a back-up f the existing templates and pint the templates flder t a new lcatin with DOC xpress. Yu cannt edit the templates, lkups, dcument cntrl, structure maps, images, r template images in the default flder and must first cpy them int a new template lcatin. Additinally, yu may be required t change the template and structure map files frm Read-Only befre being able t edit them. Created with the Standard Editin f HelpNDc: Free EPub prducer

150 Intrductin Intrductin Many users f DOC xpress have expressed an interest in custmizing the templates used within DOC xpress t generate dcumentatin. The premises behind this intrductin is t prvide users a walkthrugh fr creating a simple template that summarizes SQL Server clumn data at the table level. Table f Cntents Step One: Mdifying the Dcument Cntrl Step Tw: Mdifying the Structure Maps Step Three: Mdifying the Template Step Fur: Generating Dcumentatin Imprtant Nte: All files mdified within this dcumentatin can be dwnladed fr review here. Within the standard templates included in DOC xpress, upn drilling dwn t a table, DOC xpress displays summary infrmatin abut the table. Drilling dwn further will allw users the ability t see individual clumn infrmatin. The gal is t create a new reprt in which, upn clicking n the table, users are shwn all clumns as seen in the example belw. In additin, the table clumn named "Descriptin" will cntain a DOC xpress Data Dictinary categry. Thrughut this intrductin, cde snippets will be used as examples. The cmpleted prject can be dwnladed here. Imprtant Nte: Befre beginning this intrductin, mdificatin f the DOC xpress templates are nt fficially supprted by Pragmatic Wrks and this cannt be stressed enugh. While we d prvide dcumentatin and guidance within the help dcumentatin, any mdificatin t the DOC xpress templates is taken at the risk f the user. Because f this, users are encuraged t back up the DOC xpress templates flder befre beginning

151 any mdificatin wrk. At this time, the nly assistance Pragmatic Wrks Supprt may ffer is in the restratin f the template files t their riginal state.

152 DOC xpress Template Files By default, the templates are stred within a flder in the installatin directries fr Pragmatic Wrkbench and Wrkbench Server. Belw can be fund the tw default install lcatins: DOC xpress C:\Prgram Files (x86)\pragmatic Wrks\Pragmatic Wrkbench\DOC xpress Templates DOC xpress Server C:\Prgram Files (x86)\pragmatic Wrks\Wrkbench Server\DOC xpress Web Services\DefaultTemplates The files and their uses are identical fr bth versins f DOC xpress. There are fur types f files and tw flders used by the DOC xpress dcument generatin engine. Mre details n these files can be fund here.

153 Step One: Mdifying the Dcument Cntrl The defaulttemplate.dcumentcntrl file is used t cntrl which cmpnents are included within the generated dcumentatin. It is an XML file cntaining tw majr sectins: OutputTypes and Flag. OutputTypes Nde The first sectin f the defaulttemplate.dcumentcntrl XML begins in the OutputTypes nde and is displayed within the Generate Dcumentatin dialg windw. The name attribute prvides a friendly name fr each f the utput types, while the key attribute is used as a unique identifier that assciates the utput type with the flags fund in the secnd sectin f the XML. <OutputTypes> <OutputType name="cmpact Table" key="cmpacttable" /> <OutputType name="sql Develper" key="develper" /> <OutputType name="business Analyst" key="businessanalyst" /> </OutputTypes> Flag Ndes The remaining sectin f the defaulttemplate.dcumentcntrl file defines the varius bjects that can be dcumented. These flags are hierarchical in nature and cntain several imprtant attributes. Belw can be a small snippet f the SQL.Server flag prtin f the defaulttemplate.dcumentcntrl file as well as hw it is displayed within the Generate Dcumentatin dialg windw. The name attribute is used as a unique identifier that helps each Structure Map and Template assciate the flags with the currently active utput type. The descriptin attribute prvides a friendly name fr each

154 f the flags. The shwwarning attribute is an ptinal attribute that details whether r nt a perfrmance warning shuld be displayed within the Generate Dcumentatin dialg windw. Each f the utput type attributes prvide the flag with the default behavir fr that particular utput type. Fr example, by default, the SQL.SchemaDiagrams flag is set t True fr the develper utput type, but is set t False fr the businessanalyst utput type. <Flag name="sql.server" descriptin="sql Server" develper="true" businessanalyst="true" > <Flag name="sql.cnfiguratins" descriptin="server Cnfiguratins" develper="true" businessanalyst="true" /> <Flag name="sql.database" descriptin="database Details" develper="true" businessanalyst="true" > <Flag name="sql.tables" descriptin="table Details" develper="true" businessanalyst="true" > <Flag name="sql.schemadiagrams" descriptin="schema Diagrams" develper="true" businessanalyst="false" /> <Flag name="sql.lineageimpact" descriptin="lineage and Impact" develper="true" businessanalyst="false" > <Flag name="sql.impactlists" descriptin="impact Details" develper="true" businessanalyst="false" /> <Flag name="sql.lineagelists descriptin="lineage Details" develper="true" businessanalyst="false" /> </Flag> <Flag name="sql.tableclumns" descriptin="clumn Details" shwwarning="true" develper="true" businessanalyst="false" /> <Flag name="sql.tablefreignkeys" descriptin="freign Key Details" shwwarning="true" develper="true" businessanalyst="false" /> <Flag name="sql.tableindexes" descriptin="index Details" shwwarning="true" develper="true" businessanalyst="false" /> <Flag name="sql.tabletriggers" descriptin="trigger Details" develper="true" businessanalyst="false" /> </Flag> Snipped fr brevity... </Flag> </Flag>

155 Imprtant Nte: The abve XML may have wrapped due t restrictins in printed frm, but each nde shuld all be n a single line in the XML file. Each flag crrespnds t ne f the lines in the dialg and is hierarchical in nature. Nte that in the abve XML snippet, tw f the attributes n each flag crrespnds directly t the key attribute f the utput type in the OutputTypes sectin f the XML. Every flag must cntain an attribute fr each utput type, indicating whether it shuld be included in the dcumentatin (True) r excluded (False). In this example, the Cmpact Table utput type will essentially be a subset f the SQL Server nde. Thus, the cmpacttable attribute shuld be set t False within each Flag except fr n the SQL Server nde. The mdificatins described abve can be seen in the belw XML sample. <Flag name="sql.server" descriptin="sql Server" develper="true" businessanalyst="true" cmpacttable="false" > Next, add tw new child flags (named SQL.CmpactTable and SQL.Full) t the SQL.Server flag that are mutually exclusive with the develper and businessanalyst attributes. These flags will be used within the next step t cntrl which elements are included in the structure maps. After cmpletely adding the new cmpacttable attribute t all flags as well as the tw new ndes, the abve example shuld appear as it des belw. The bld sectins are the new additins t the dcument cntrl. <Flag name="sql.server" descriptin="sql Server" develper="true" businessanalyst="true" cmpacttable="true" > <Flag name="sql.cmpacttable" descriptin="cmpact Table SQL Server" develper="false" businessanalyst="false" cmpacttable="true" /> <Flag name="sql.full" descriptin="cmpact Table SQL Server" develper="true" businessanalyst="true" cmpacttable="false" />

156 <Flag name="sql.cnfiguratins" descriptin="server Cnfiguratins" develper="true" businessanalyst="true" cmpacttable="false" /> <Flag name="sql.database" descriptin="database Details" develper="true" businessanalyst="true" cmpacttable="false" > <Flag name="sql.tables" descriptin="table Details" develper="true" businessanalyst="true" cmpacttable="false" > <Flag name="sql.schemadiagrams" descriptin="schema Diagrams" develper="true" businessanalyst="false" cmpacttable="false" /> <Flag name="sql.lineageimpact" descriptin="lineage and Impact" develper="true" businessanalyst="false" cmpacttable="false" > <Flag name="sql.impactlists" descriptin="impact Details" develper="true" businessanalyst="false" cmpacttable="false" /> <Flag name="sql.lineagelists descriptin="lineage Details" develper="true" businessanalyst="false" cmpacttable="false" /> </Flag> <Flag name="sql.tableclumns" descriptin="clumn Details" shwwarning="true" develper="true" businessanalyst="false" cmpacttable="false" /> <Flag name="sql.tablefreignkeys" descriptin="freign Key Details" shwwarning="true" develper="true" businessanalyst="false" cmpacttable="false" /> <Flag name="sql.tableindexes" descriptin="index Details" shwwarning="true" develper="true" businessanalyst="false" cmpacttable="false" /> <Flag name="sql.tabletriggers" descriptin="trigger Details" develper="true" businessanalyst="false" cmpacttable="false" /> </Flag> Snipped fr brevity... </Flag> </Flag> Imprtant Nte: The abve XML may have wrapped due t restrictins in printed frm, but each nde shuld all be n a single line in the XML file. Take nte f the tw flag names (SQL.CmpactTable and SQL.Full) as they will be needed later. The SQL.Full flag will be assciated with the riginal utput types included with DOC xpress. The SQL.CmpactTable flag will be assciated with the new frmat currently being created. Nte carefully the values f the utput type attributes. Within SQL.CmpactTable flag, the develper and businessanalyst attributes are set t False, while the cmpacttable attribute is set t true. Within SQL.Full flag, the utput type attribute values are switched. Additinal infrmatin regarding the Dcument Cntrl can be fund here.

157 Step 2: Mdifying the Structure Maps The Structure Map files, which all fllwing the naming pattern StructureMap.*.xml, cntrl the layut f the table f cntents fr the dcuments as well as which bjects are assciated with which templates. There are actually multiple structure map files that make up a single dcumentatin. When dcument generatin begins, DOC xpress starts with the rt level f the bject within the dcument layut. In this case, that rt level is SQL Server. DOC xpress then uses the rt bject type as a guide t match it t a structure map. T determine which structure map t initially use, DOC xpress examines each structure map file it finds within the templates flder. DOC xpress lks fr the StructureMap nde declaratin, which is typically the secnd line within the structure map. Belw can be fund the StructureMap nde fr the StructureMap.Sql.Server.xml file: <StructureMap typematch ="Micrsft\.SqlServer\.Management\.Sm\.Server" > The typematch attribute is a regular expressin used t match the crrect structure map t the rt bject's type. Every bject catalged by DOC xpress has a specific bject type, but nt every bject has a structure map that matches that bject type. DOC xpress examines the rt bject's type and then matches that bject type t the Structure Map using its typematch attribute. If there DOC xpress finds multiple matches, it will nly use the first structure map it finds, which may r may nt be the desired result. In rder fr users t prperly determine the bject type f the bject they wish t add custm dcumentatin, DOC xpress has a built in tl called the Metadata Viewer. T use xpress windw will becme enabled. Clicking the View buttn will autmatically launch the Metadata Viewer. Once the Metadata Viewer has laded, rt bject f the metadata tree n the far left represents the selected in DOC xpress. Underneath the bject's name is the bject's type. In this case, lcalhst's bject type is Micrsft.SqlServer.Managment.Sm.Serv er. This matches directly t the typematch attribute fr the StructureMap.Sql.Server.xml file. In rder t accmmdate fr the Cmpact Table utput type created in Step 1, the StructureMap.Sql.Server.xml file will need t be mdified such that nly databases and tables are present withut adversely affecting the riginal SQL Develper and Business Analyst utput types. T accmplish this, the SQL.Full and SQL.CmpactTable flags that were added will be inserted int the StructureMap.Sql.Server.xml file in rder t cntrl which bjects are displayed in the Structure Map (and hence the "Table f Cntents"). Within the StructureMap.Sql.Server.xml file are tw Objects that are child ndes t the Structure nde. One bject cntrls the table f cntents fr nn-azure Servers, while the secnd cntrls the table f cntents fr Azure Servers. Bth Object ndes will need t be tagged in such a way that they will nly wrk with the SQL Develper and Business Analyst utput types. T d s, the flag attribute "SQL.Full",

158 which was created in Step 1, will need t be added t bth ndes. The mdificatins described abve can be seen in the belw XML sample. <Object selectr="." templatekey="sqlserver" flag="sql.full" cnditin="./[/infrmatin[@editin!= &qut;sql Azure&qut;]!(/Infrmatin)]" > Imprtant Nte: The abve XML may have wrapped due t restrictins in printed frm, but it shuld all be n a single line in the XML file. Case is very imprtant when adding flags. In ur mdificatins, the riginal flag in the cntrl template file was "SQL.Full" and wuld nt match t the flag "Sql.FULL". Next, within the StructureMap.Sql.Server.xml file, scrll dwn t find the secnd Object declaratin and mdify it similarly t the first ne: <Object selectr="." templatekey="sqlserver" flag="sql.full" cnditin="./[/infrmatin[@editin == &qut;sql Azure&qut;]]" > Finally, we need t add a third Object declaratin handle t cntrl the Cmpact Table utput type that was created in Step 1. This new Object will be very simple, cntaining nly the databases and nne f the ther bjects, such as jbs, linked servers, et cetera. The Object nde itself will be similar t the ther tw Objects, its selectr will still be "." and its templatekey will als be "SqlServer". Hwever, this bject will nt cntain a cnditin attribute and will have its flag set t "SQL.CmpactTable" instead. The mdificatins described abve can be seen in the belw XML sample. <Object selectr="." templatekey="sqlserver" flag="sql.cmpacttable" > <ChildObjectsSubStructure selectr="./databases" cnditin="./databases/" /> </Object> The ChildObjectsSubStructure tells DOC xpress t search fr anther Structure Map t fill in the structure fr this sectin, specifically the ne fr the Databases bject. The structure map that cntrls databases (StructureMap.Sql.DatabaseCllectin.xml) drills dwn int tables using a third structure map (StructureMap.Sql.Database.xml). Since these structure maps reach dwn int the tables, there is n need t mdify them. Even thugh a database cntains many bjects, the dcument cntrl that was mdified in Step 1 will exclude all such bjects when dcumenting using the Cmpact Table utput type. Thus, DOC xpress will nt attempt t generate dcumentatin fr these ther, nn-table bjects. Since DOC xpress never generates the dcumentatin fr these items, it wn't add an entry in the Table f Cntents. Imprtant Nte: A gd analgy fr why this ccurs wuld be the 13th flr f many buildings. Many buildings skip ver the 13th flr when assigning flr numbers. Since there is n 13th flr, there is n need t put a 13th flr buttn in the elevatr. Even thugh the elevatr technicians may have wired the elevatr fr flr 13, since there is n buttn fr the 13th flr, the elevatr technician merely pushes the wires back and they are safely ignred. In the standard dcuments generated by DOC xpress, selecting tables allws fr the user t drill dwn further int individual clumn details. Fr the new Cmpact Table utput type, this behavir will need t be altered s that the Table bject becmes the lwest level. Thus, the structure map fr tables will need t be altered t accmmdate this change f behavir. Find and pen the StructureMap.Sql.Table.xml file. Within it, the clumns, triggers, and indexes branches will need t be mdified s that they are nly displayed if the user has selected SQL Develper r Business Analyst and nt the new Cmpact Table utput type. These three sub-branches will need t have the flag attribute set t SQL.Full t accmplish this. The mdificatins described abve can be seen in the belw XML sample.

159 <Structure> <Object selectr="." templatekey="sqltable" flag="sql.tables" > <Object selectr="clumns" templatekey="sqlclumnscllectin" flag="sql.full" cnditin="clumns/" > <ChildObjects selectr="$object(path:'./',orderby: flag="sql.tableclumns" /> </Object> <Object selectr="freignkeys" templatekey="sqlfreignkeycllectin" flag="sql.full" cnditin="freignkeys/" > <ChildObjects selectr="./" flag="sql.tablefreignkeys" /> </Object> <Object selectr="indexes" templatekey="sqlindexcllectin" flag="sql.full" cnditin="indexes/" > <ChildObjects templatekey="sqlrelatinalindex" flag="sql.tableindexes" /> <ChildObjects templatekey="sqlspatialindex" flag="sql.tableindexes" /> <ChildObjects templatekey="sqlxmlindex" flag="sql.tableindexes" /> </Object> <Object selectr="triggers" templatekey="sqltabletriggercllectin" flag="sql.full" cnditin="triggers/" > <ChildObjects selectr="./" flag="sql.tabletriggers" /> </Object> </Object> </Structure> With the abve mdificatin, Clumns, FreignKeys, Indexes, and Triggers will nly be displayed when the SQL.Full flag is set in the riginal dcument cntrl file t True. With the structure maps nw set, the final step is t mdify the templates. Additinal infrmatin regarding structure maps can be fund here.

160 Step 3: Mdifying the Template Unlike the ther files, the *.template files are nt XML. Rather, they are a special template language used by DOC xpress t cntrl the layut f each individual page within dcumentatin. This intrductin will nt cver the entire language and nly the functins necessary t achieve the riginal gal f this intrductin will be discussed. A mre in-depth discussin f the template language can be fund here. Fr purpses f this exercise, the nly mdificatins that are necessary can be fund within the SqlTable.template file. This file cntrls that visual layut f each SQL Server Table. As with the structure maps edited in Step 2, SqlTable.template will be used by all utput types t generate dcumentatin, nt just the new Cmpact Table utput type. Thus, we need t ensure that any mdificatins made t SqlTable.template will nt affect the SQL Develper r Business Analyst utput types that are included within DOC xpress. Frtunately, the template language des supprt simple prgramming cnstructs such as the if-else statement. Using an if-else statement, the dcument cntrl can switch between tw different sets f cde depending n the utput type used. Opening up SqlTable.template, just belw the DeclareSelectr functin, an If statement will need t be added that uses the FlagIsSet functin t check t see if the SQL.CmpactTable flag has been set t true. If the SQL.CmpactTable flag has been set t true, the cde within the If statement will be run. The mdificatins described abve, as well as the new cde can be seen in the belw template sample. 01: 02: 03: 04: 05: 06: 07: 08: 09: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: If(FlagIsSet('SQL.CmpactTable')) { If(Any(RunSelectr('Clumns'))) { Table(RunSelectr('Clumns'), {'Clumn Name', 'Descriptin', 'Data Type', 'Length', 'Can Be Empty' }, { ParameterRequest('DataDictinaryEntry(Descriptin)'), == '-1'? ('Maximum') : (@PrpertyValue('MaximumLength').Frm($Object(Path:'DataType'))), Image(@PrpertyValue('Nullable') == 'True'? ('True.png') : ('False.png')) }); } Else { Span('N clumns are present fr this table.'); } } Else { // Original Template } Imprtant Nte: Line numbers have been added fr purpses f this discussin and are nt a part f the final cde. Line 1 has the already discussed If statement which checks t see if the SQL.CmpactTable flag has been set. In line 3, anther If statement checks t see if any clumns exist. If n clumns exist, the Else clause n line 16 triggers and nly utputs a string ntifying the user that the current table des nt have any clumns. If this was nt dne, then n clumns wuld be returned by the Table functin ne line 5 and a large blank area wuld be present, leaving the user t wnder what happened.

161 Line 5 initiates a Table functin, line 6 describes hw many clumns will be within the table as well as their names: Clumn Name, Descriptin, Data Type, Length, and Can Be Empty, and lines 8 thrugh 13 create a cmma separated list fr the values used within each clumn. Of interest is line 9, which cntains a ParameterRequest functin that retrieves a special value frm the DOC xpress repsitry fr the current clumn. The type f parameter is a DataDictinaryEntry that requires the name f the entry the template creatr wishes t retrieve. In the case f line 9, the template creatr wishes t retrieve the Descriptin Data Dictinary Entry fr each clumn. Users may add new clumns t the Data Dictinary and may explicitly add them t their dcumentatin by replacing Descriptin with the name f the new Data Dictinary Entry they wish t include. The ther lines make fairly standard calls t retrieve items frm the DOC xpress snapsht. Line 21 cntains an Else statement the encapsulates the riginal template with tw curly brackets (line 22 and 24). This Else statement will run when SQL.CmpactTable is False. Additinal infrmatin regarding the template language can be fund here.

162 Step 4: Generating Dcumentatin After editing the dcument cntrl, structure map, and templates t handle bth the new utput types and the riginal, generating dcumentatin is the last step! Generating a dcument with the new utput types is nw as easy as using any f the built in types. After pening a slutin in DOC xpress and clicking the Generate Dcumentatin buttn, ensure that the Output Type is set t the new Cmpact Table. After selecting the desired utput frmat, click the OK buttn t begin generating the dcumentatin. Imprtant Nte: Nte hw the Structure Maps kicked in, and the Tables n lnger drill dwn int the clumns. In additin, the new template pages nly shw a cmpact view f the clumns and hide the mre rbust details present within the standard templates. Created with the Standard Editin f HelpNDc: Prduce electrnic bks easily

163 Dcument Cntrl Dcument Cntrl Within the template flder fr DOC xpress yu will find the dcument cntrl file named defaulttemplate.dcumentcntrl. This file is respnsible fr setting what is and is nt displayed within templates and Structure Maps using utput type flags that are set in the Generate Dcumentatin dialg bx. By clicking the arrw t the right f the Output Type drp dwn menu, yu can set yur wn custm Output styles. After clicking the arrw, it pens the "Specify included utput items" windw. Here yu will check r uncheck the desired utput items fr yur custm selectin. Here yu can name and save yur selectin.

164 This methd will nt update the Dcument Cntrl file, hwever yu can edit a cpied versin f the Dcument Cntrl file t add yur wn Output Types and select the flags yu want. If yu add yur wn <OutputType> tag yu will then add the name t each <Flag> tag and set it t either True r False t chse whether r nt it utputs that type. Keep in mind that each Flag inherits the blean frm its parent, s setting the parent False, autmatically disables all f its children Flags. Output Style Added Via Dcument Cntrl: The added utput type shwing in Generate dcumentatin windw:

165

166 Created with the Standard Editin f HelpNDc: Easily create iphne dcumentatin

167 Structure Maps Structure Maps Structure maps are XML files that are used during dcumentatin generatin that help rganize the layut (table f cntents) f yur dcumentatin and determine which templates are used fr each bject within the structure map. A basic knwledge f XML file structure is necessary in rder t edit Structure Map files. Table f Cntents Ndes StructureMap Structure ChildObjects ChildObjectsSubStructure Object RecursiveChildObjects Rules Rule Attributes cnditin flag namematch templatekey typematch selectr Due t the vast number f Object Types that can be fund within a Carbn Tree, there are nt structure maps that crrespnd t every bject type. A detailed list f all bject types that currently have structure maps included within DOC xpress upn installatin can be fund here. Additinally, there is anther way t knw whether r nt an bject currently present within yur Slutin's dcumentatin des nt have a crrespnding Structure Map: When generating dcumentatin, if yur dcumentatin appears as thugh the dcumentatin represents the metadata available rather than custm tailred dcumentatin, then DOC xpress was unable t find a matching structure map and used t default structure map instead. Imprtant Nte: DOC xpress' Metadata Viewer is an invaluable asset when taking n the task f creating custm Structure Maps as it prvides yu with an exact structure f a carbn tree, including bject types and its prperties. When generating dcumentatin fr the rt bject fund within the layut, DOC xpress will lk fr all files within the templates flder that fllws the naming pattern "StructureMap.*.xml". After gather all Structure Map files, DOC xpress will use the StructureMap's typematch t find all matching Structure Maps. If DOC xpress finds mre than ne Structure Map that matches, DOC xpress will use the first match, therwise, it will use the default Structure Map (StructureMap.Default.xml). After a structure map is

168 fund, DOC xpress will use the structure map t generate the layut (table f cntents) f yur dcumentatin and apply the crrect templates are fr each bject within the structure map. Belw can be fund a simplified Structure Map fr a SQL Server Instance that includes links fr further details f the expected behavir fr each Nde and Attribute: <?xml versin="1.0" encding="utf-8"?> <StructureMap typematch="micrsft\.sqlserver\.management\.sm\.server"> <Structure> <Object selectr="." templatekey="sqlserver" cnditin="./[/infrmatin[@editin!= &qut;sql Azure&qut;]!(/Infrmatin)]" > <Object selectr="." templatekey="sqlcnfiguratins" flag="sql.cnfiguratins" cnditin="./cnfiguratin/" /> <ChildObjectsSubStructure selectr="./databases" cnditin="./databases/" /> <Object selectr="$object(path:'.[./lgins/./credentials/]')" templatekey="sqlsecurity" flag="sql.security" > <Object selectr="lgins" templatekey="sqllginscllectin" cnditin="lgins/" > <ChildObjects selectr="./[@isdisabled == &qut;false&qut;]" templatekey="sqllgin" flag="sql.securitydetail" /> <ChildObjects selectr="./[@isdisabled == &qut;true&qut;]" templatekey="sqllgindisabled" flag="sql.securitydetail" /> </Object> <Object selectr="credentials" cnditin="credentials/" > <ChildObjects selectr="./" flag="sql.securitydetail" /> </Object> </Object> </Object> </Structure> <Rules> <Rule templatekey="sqlcredentialscllectin" namematch="credentials" /> <Rule templatekey="sqlcredential" typematch="sm\.credential$" /> <Rule templatekey="glbaldefault" /> </Rules> </StructureMap> Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

169 Ndes Ndes Table f Cntents StructureMap Structure ChildObjects ChildObjectsSubStructure Object RecursiveChildObjects Rules Rule Created with the Standard Editin f HelpNDc: Easily create PDF Help dcuments

170 StructureMap StructureMap The StructureMap nde is used t encapsulate the entire Structure Map and cntains the typematch attribute, which matches all f a slutin's rt bjects types t their respected structure map. Table f Cntents Structure ChildObjects ChildObjectsSubStructure Object RecursiveChildObjects Rules Rule Syntax This structure map matches t all bject types that fit the Regular Expressin string "Micrsft\.SqlServer\.Management\.Sm\.Server" and creates an empty structure with n ndes as well as implicitly maps all templates t the template "GlbalDefault": <StructureMap typematch="micrsft\.sqlserver\.management\.sm\.server"> <Structure> </Structure> <Rules> <Rule templatekey="glbaldefault" /> </Rules> </StructureMap> Required Attributes typematch - Used by DOC xpress during dcument generatin t match the Structure Map t a regular expressin based n each f the rt bject types present within the slutin layut. Imprtant Nte: The typematch attribute is required fr all Structure Maps with the exceptin f ne: the default structure map. There must be ne and nly ne structure map that des nt specify a typematch, in a default installatin f the DOC xpress templates, that structure map is named "StructureMap.Default.xml". Required Child Ndes Structure - Used by the Structure Map t detail the layut (table f cntents) fr the current Structure Map as well as the Rules - Used by the Structure Map t detail implicit matches between bject and/r name matches fr templates within the current Structure Map. A structure map must have at least ne rule, which typically pints t a default template that is used if there are n explicit templatekeys and n ther rule matches.

171 Imprtant Nte: Rules are evaluated in the rder that they are specified, s if yu have multiple rules that may match the same bject, the first match will always be used. Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

172 Structure Structure The Structure nde is used t encapsulate the entire layut fr the StructureMap and separate the Structure Maps' rules frm the layut. Table f Cntents ChildObjects ChildObjectsSubStructure Object RecursiveChildObjects Syntax <Structure> </Structure> Optinal Child Ndes ChildObjects - Used t create child pages within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects. Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

173 ChildObjects ChildObjects The ChildObjects are used within the Structure t create child pages within the dcumentatin fr each bject that matches the selectr. Syntax This nde returns all children f the parent nde t be included within the Dcumentatin: <ChildObjects selectr="./" > </ChildObjects> Required Attributes selectr - Uses Path Grammar r an $Object Selectr t select ne r mre bjects that the current nde applies t. The selectr is always scped t the parent nde. Optinal Attributes cnditin - Uses Path Grammar r an $Object Selectr t dynamically shw/hide ndes based n whether r nt the Path Grammar r $Object Selectr returns at least ne bject. The cnditin is always scped t the parent nde. flag - Used in cnjunctin with the defaulttemplate.dcumentcntrl file t assciate the current nde's flag value with the name value as detailed within the defaulttemplate.dcumentcntrl file. During dcumentatin, if the assciated flag was set t "False", then DOC xpress will skip the current nde and will nt include it within the dcumentatin. templatekey - Used t explicitly verride any rule and matches all bjects that match the selectr with the specified templatekey. Optinal Child Ndes ChildObjects - Used t create child page(s) within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each child bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects. Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

174 ChildObjectsSubStructure ChildObjectsSubStructure The ChildObjectsSubStructure nde is used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. ChildObjectsSubStructure ndes are used t create a mre flexible Structure Map that allws fr mre bject types within the slutin's layut t return a frmated dcument. A ChildObjectsSubStructure nde shuld cntain n child ndes. Syntax This ChildObjectsSubStructure nde returns all children f the parent nde and attempts t match each child's bject type t anther structure map fr use within the Dcumentatin: <ChildObjectsSubStructure selectr="./" /> Required Attributes selectr - Uses Path Grammar r an $Object Selectr t select ne r mre bjects that the current nde applies t. The selectr is always scped t the parent nde. Optinal Attributes cnditin - Uses Path Grammar r an $Object Selectr t dynamically shw/hide ndes based n whether r nt the Path Grammar r $Object Selectr returns at least ne bject. The cnditin is always scped t the parent nde. flag - Used in cnjunctin with the defaulttemplate.dcumentcntrl file t assciate the current nde's flag value with the name value as detailed within the defaulttemplate.dcumentcntrl file. During dcumentatin, if the assciated flag was set t "False", then DOC xpress will skip the current nde and will nt include it within the dcumentatin. Created with the Standard Editin f HelpNDc: Easily create iphne dcumentatin

175 Object Object An Object is used within the Structure t create a single child page within the dcumentatin fr the first bject that matches the selectr. Syntax This Object nde returns the child f the parent nde with the name "Clumns" t be included within the Dcumentatin: <Object selectr="clumns" > </Object> Required Attributes selectr - Uses Path Grammar r an $Object Selectr t select the first bjects that the current nde applies t. The selectr is always scped t the parent nde. Optinal Attributes cnditin - Uses Path Grammar r an $Object Selectr t dynamically shw/hide the nde based n whether r nt the Path Grammar r $Object Selectr returns at least ne bject. The cnditin is always scped t the parent nde. flag - Used in cnjunctin with the defaulttemplate.dcumentcntrl file t assciate the current nde's flag value with the name value as detailed within the defaulttemplate.dcumentcntrl file. During dcumentatin, if the assciated flag was set t "False", then DOC xpress will skip the current nde and will nt include it within the dcumentatin. templatekey - Used t explicitly verride any rule and matches the bject that match the selectr with the specified templatekey. Optinal Child Ndes ChildObjects - Used t create child page(s) within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects. Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

176 RecursiveChildObjects RecursiveChildObjects The RecursiveChildObjects nde is used t map ut the entire metadata fr each bject that matches the selectr. RecursiveChildObjects ndes are mst ften used during the trubleshting prcess when creating custm Structure Maps t help visually display the entire structure f an bject as well as all f its prperties in an unfrmatted manner. A RecursiveChildObjects nde shuld cntain n child ndes. Imprtant Nte: When using a RecursiveChildObjects nde, the generated dcumentatin will represent the structure f the extracted metadata, which may result in a large number f pages being generated that shw the full metadata cntent. Syntax This RecursiveChildObjects nde returns all children f the parent nde and recursively maps ut the entire metadata fr each bject within the Dcumentatin: <RecursiveChildObjects selectr="./" /> Required Attributes selectr - Uses Path Grammar r an $Object Selectr t select ne r mre bjects that the current nde applies t. The selectr is always scped t the parent nde. Optinal Attributes cnditin - Uses Path Grammar r an $Object Selectr t dynamically shw/hide ndes based n whether r nt the Path Grammar r $Object Selectr returns at least ne bject. The cnditin is always scped t the parent nde. flag - Used in cnjunctin with the defaulttemplate.dcumentcntrl file t assciate the current nde's flag value with the name value as detailed within the defaulttemplate.dcumentcntrl file. During dcumentatin, if the assciated flag was set t "False", then DOC xpress will skip the current nde and will nt include it within the dcumentatin. Created with the Standard Editin f HelpNDc: Free iphne dcumentatin generatr

177 Rules Rules The Rules nde is used t encapsulate the entire list f rules used t implicitly assciating bjects f a specific name and/r type with a specific templatekey. If an explicit templatekey is present within the Structure fr an bject that nrmally wuld match the rule, the explicit templatekey will be used regardless f whether r nt a rule matches the bject type. Imprtant Nte: Rules are evaluated in the rder that they are specified, s if yu have multiple rules that may match the same bject, the first match will always be used. Table f Cntents Rule Syntax <Rules> <Rule templatekey="glbaldefault" /> </Rules> Required Child Ndes Rule - Used t implicitly match an bject type r name with a template. At least ne (default) Rule must be present within each Structure Map t ensure that all bjects present within the Structure Map will be frmatted regardless f whether r nt an explicit r implicit templatekey match was fund. Created with the Standard Editin f HelpNDc: Write ebks fr the Kindle

178 Rule Rule The Rule nde is used t specify a single rule fr implicitly assciating bjects f a specific name and/r type with a specific templatekey. If an explicit templatekey is present within the Structure fr an bject that nrmally wuld match the rule, the explicit templatekey will be used regardless f whether r nt a rule matches the bject type. Syntax This rule will implicitly map all bjects t the template mapped t the key "GlbalDefault": <Rule templatekey="glbaldefault" /> This rule will implicitly map all bjects with an bject type that matches the regular expressin string "Sm\.Credential$" t the template mapped t the key "SqlCredential": <Rule templatekey="sqlcredential" typematch="sm\.credential$" /> This rule will implicitly map all bjects with an bject name that matches the regular expressin string "Credentials$" t the template mapped t the key "SqlCredentialsCllectin": <Rule templatekey="sqlcredentialscllectin" namematch="credentials$" /> This rule will implicitly map all bjects with an bject name that matches the regular expressin string "Credentials$" and an bject type that matches the regular expressin string "Sm\.CredentialsCllectin$" t the template mapped t the key "SqlCredentialsCllectin": <Rule templatekey="sqlcredentialscllectin" namematch="credentials$" typematch="sm\.credentialscllectin$" /> Required Attributes templatekey - Used t specify the templatekey that the fllwing implicit rule references. If n namematch r typematch attributes are included within the rule, this rule is the default rule and will nly be applied if there are n ther matches fund. Optinal Attributes namematch - A regular expressin string that is used by the Structure Map t match all bjects that d nt cntain explicit matches based n the bject's name t a templatekey. If bth namematch and typematch

179 are included, then bth namematch and typematch must match fr the rule t be applied. typematch - A regular expressin string that is used by the Structure Map t match all bjects that d nt cntain explicit matches based n the bject's type t a templatekey. If bth namematch and typematch are included, then bth namematch and typematch must match fr the rule t be applied. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

180 Attributes Attributes Table f Cntents cnditin flag namematch templatekey typematch selectr Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

181 cnditin cnditin The cnditin attribute utilizes Path Grammar r an $Object Selectr t dynamically shw/hide the assciated nde based n whether r nt the Path Grammar r $Object Selectr returns at least ne bject. The cnditin is always scped t the parent nde. Syntax This ChildObjectsSubStructure nde will nly return the "Databases" nde if the "Database" ndes cntains at least ne child nde: <ChildObjectsSubStructure selectr="./databases" cnditin="./databases/" /> This Object nde will nly return the parent nde if the Prperty named "Editin" fund n the Infrmatin nde is nt equal t "SQL Azure" r the Infrmatin nde is nt present within metadata: <Object selectr="." cnditin="./[/infrmatin[@editin!= &qut;sql Azure&qut;]!(/Infrmatin)]" > </Object> This Object nde will nly return the "UserDefinedTypes" nde if the bject with path "UserDefinedTypes/" exists: <Object selectr="userdefinedtypes" cnditin="$object(path:'userdefinedtypes/')" > </Object> Assciated Optinal Ndes ChildObjects - Used t create child pages within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects.

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

183 flag flag The flag attribute is used in cnjunctin with the defaulttemplate.dcumentcntrl file t assciate the current nde's flag value with the name value as detailed within the defaulttemplate.dcumentcntrl file. During dcumentatin, if the assciated flag was set t "False", then DOC xpress will skip the current nde and will nt include it within the dcumentatin. Syntax This ChildObjects nde returns all children f the parent nde nly if the flag "SQL.SecurityDetail" is set t "True" at the time f dcument generatin: <ChildObjects selectr="./" flag="sql.securitydetail" /> This Object nde will nly return the parent nde if the flag "SQL.Database" is set t "True" at the time f dcument generatin: <Object selectr="." flag="sql.database" > </Object> Assciated Optinal Ndes ChildObjects - Used t create child pages within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects. Created with the Standard Editin f HelpNDc: Full-featured Kindle ebks generatr

184 namematch namematch The namematch attribute is used t implicitly match all bjects within the Structure Map t a regular expressin based n the bject's name. If bth namematch and typematch are included within the Rule, then bth namematch and typematch must match fr the rule t be applied. Syntax This rule will implicitly map all bjects with an bject name that matches the regular expressin string "Credentials$" t the template mapped t the key "SqlCredentialsCllectin": <Rule templatekey="sqlcredentialscllectin" namematch="credentials$" /> This rule will implicitly map all bjects with an bject name that matches the regular expressin string "Credentials$" and an bject type that matches the regular expressin string "Sm\.CredentialsCllectin$" t the template mapped t the key "SqlCredentialsCllectin": <Rule templatekey="sqlcredentialscllectin" namematch="credentials" typematch="sm\.credentialscllectin$" /> Assciated Optinal Ndes Rule - Used t specify a single rule fr implicitly assciating bjects f a specific name and/r type with a specific templatekey. Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

185 templatekey templatekey The templatekey attribute has different functinality depending n which nde the templatekey attribute is used alngside. If the templatekey is fund within a Rule nde, the templatekey is used t implicitly match bjects fund within the current Structure Map. If the templatekey is fund within a ChildObjects r Object nde, then the templatekey is used t explicitly verride any Rule that wuld therwise match that bject. Syntax This rule will implicitly map all bjects with an bject type that matches the regular expressin string "Sm\.Credential$" t the template mapped t the key "SqlCredential": <Rule templatekey="sqlcredential" typematch="sm\.credential$" /> This ChildObjects nde will return all children f the parent nde and explicitly apply the template mapped t the key "SqlLgin": <ChildObjects selectr="./" templatekey="sqllgin" > </ChildObjects> Assciated Required Ndes Rule - Used t implicitly match an bject type r name with a template. At least ne (default) Rule must be present within each Structure Map t ensure that all bjects present within the Structure Map will be frmatted regardless f whether r nt an explicit r implicit templatekey match was fund. The templatekey attribute is a required attribute fr a valid Rule. Assciated Optinal Ndes ChildObjects - When the templatekey attribute is present under a ChildObjects nde, then the templatekey is used t explicitly verride any Rule that wuld therwise match that bject. The templatekey attribute is an ptinal attribute fr a ChildObjects. Object - When the templatekey attribute is present under an Object nde, then the templatekey is used t explicitly verride any Rule that wuld therwise match that bject. The templatekey attribute is an ptinal attribute fr an Object. Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

186 typematch typematch The typematch attribute has different functinality depending n which nde the typematch attribute is used alngside. When used within the StructureMap nde, the typematch is used by DOC xpress during dcument generatin t match the Structure Map t a regular expressin based n each f the rt bject types present within the slutin layut. When present within Rule nde, the typematch attribute is used t implicitly match all bjects within the Structure Map t a regular expressin based n the bject's type. If bth namematch and typematch are included within the Rule, then bth namematch and typematch must match fr the rule t be applied. Syntax This structure map matches t all bject types that fit the Regular Expressin string "Micrsft\.SqlServer\.Management\.Sm\.Server" and creates an empty structure with n ndes as well as implicitly maps all templates t the template "GlbalDefault": <StructureMap typematch="micrsft\.sqlserver\.management\.sm\.server"> <Structure> </Structure> <Rules> <Rule templatekey="glbaldefault" /> </Rules> </StructureMap> This rule will implicitly map all bjects with an bject name that matches the regular expressin string "Credentials$" and an bject type that matches the regular expressin string "Sm\.CredentialsCllectin$" t the template mapped t the key "SqlCredentialsCllectin": <Rule templatekey="sqlcredentialscllectin" namematch="credentials$" typematch="sm\.credentialscllectin$" /> Assciated Required Ndes StructureMap - Used t encapsulate the entire Structure Map and cntains the typematch attribute, which matches all f a slutin's rt bjects types t their respected structure map. Assciated Optinal Ndes Rule - Used t specify a single rule fr implicitly assciating bjects f a specific name and/r type with a specific templatekey. Created with the Standard Editin f HelpNDc: Free Web Help generatr

187 selectr selectr The selectr attribute uses the Wrkbench Path Language r a Selectr t select ne r mre bjects fr use by the current nde. The selectr is always scped t the parent nde. Imprtant Nte: Fr mre infrmatin n the Wrkbench Path Language syntax used within a structure map selectr, please click here. Syntax This ChildObjectsSubStructure nde returns all children f the Databases nde and attempts t match each child's bject type t anther structure map fr use within the Dcumentatin: <ChildObjectsSubStructure selectr="./databases/" /> This ChildObjects nde returns all children f the parent nde in which the Prperty named "FunctinType" matches the regular expressin string "^Scalar" fr use within the Dcumentatin: <ChildObjects selectr="$object(path:'./[@functintype>&qut;^scalar&qut;]')" /> Assciated Required Ndes ChildObjects - Used t create child pages within the dcumentatin fr each bject that matches the selectr. ChildObjectsSubStructure - Used t explicitly search fr anther Structure Map that matches the bject type fr each bject that matches the selectr. Object - Used t create a single child page within the dcumentatin fr each the first bject that matches the selectr. RecursiveChildObjects - Used t recursively create the entire metadata tree fr each bject that matches the selectr. This child nde is mst ften used during the creatin f a Structure Map t help display the entire structure f a set f bjects. Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

188 Templates Templates Table f Cntents Object Selectrs Page Level Objects Cntrl Flw Predicates Cntent Items Imprtant Nte: DOC xpress' Metadata Viewer is an invaluable asset when taking n the task f creating custm templates as it prvides yu with an exact structure f a carbn tree, bject types, and prperties. Created with the Standard Editin f HelpNDc: Full-featured EBk editr

189 Object Selectrs Object Selectrs Object selectrs are used in a variety f circumstances t select ne r mre bjects t perate frm. Object selectrs the path grammar in rder t lcate related bjects within the carbn tree fr listing, linking, and building tables. Object selectrs als frm the basis fr the selectin f ndes within the Structure Maps. Syntax: Selectr Meaning Returns the currently scped bject. This is useful when generating links t bjects within a table. Uses Can be used within structure $CurrentObject maps r templates. Can be used Returns the list f bjects returned $Object(Path:ʼpath/t within structure by the specified path using the /related/bjectʼ) maps r Wrkbench Path Language. templates. When a carbn bject cntains a Can be used $ObjectReference(< reference t anther bject, this within structure referencekey>) can be reslved using the maps r $ObjectReference selectr. templates. Can nly be RunSelectr(<select Run a selectr previusly stred used within rkey>) with DeclareSelectrʼ. templates. Imprtant Nte: Fr mre infrmatin n the Wrkbench Path Language syntax used within Object Selectrs, please click here. Examples: Return the children f the child nde Databasesʼ: $Object(Path:ʼDatabases/ʼ) Return the children f the child nde Databasesʼ, rdered by the Nameʼ prperty n each ne: $Object(Path:ʼDatabases/ʼ,OrderBy:@PrpertyValue( Nameʼ)) Return the bject stred in the bject reference RelatedPackageʼ:

190 $ObjectReference( RelatedPackageʼ) Stre and run a selectr fr all tables: DeclareSelectr( Tablesʼ, $Object(Path:ʼTables/ʼ)); Fr(RunSelectr( Tablesʼ)) { } Created with the Standard Editin f HelpNDc: Free help authring tl

191 Page Level Objects Page Level Objects Table f Cntents Cde( ) EmbeddedImage( ) Header( ) Image( ) Include( ) Link( ) List( ) Page( ) Span( ) Table( ) Title( ) UntypedPrpertyTable Page level bjects are the main building blcks fr the utput f a given template file and frm the majr elements that are included within the dcumentatin. Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

192 Cde( ) Cde( ) Specifies the cntent as cde and prvides indentatin. If using the ptinal cde type argument, then it will als prvide syntax highlighting based n the given cde type. Syntax Cde([<cde type>, ]<cntent item>); Arguments cde type - Any cde type frm the fllwing table: Cde Type Term SQL Language T-SQL Visual Basic VB.NET CS C# XML XML FrmattedXML XML Highlighting Refrmatting Yes N Yes N Yes Yes Yes N N Yes If the cde type is mitted, then the utput is emitted in a mnspace fnt, but n highlighting r refrmatting is applied. cntent item the cntent item t frmat Examples Cde(@PrpertyValue('DdlScript')); Created with the Standard Editin f HelpNDc: Free help authring envirnment

193 EmbeddedImage( ) EmbeddedImage( ) Displays an image which is stred as a prperty frm the currently scped bject in the carbn tree. Syntax EmbeddedImage(<prperty key>); Arguments prperty key - The name f the prperty which cntains the image stream. Examples EmbeddedImage('SmePicture'); Created with the Standard Editin f HelpNDc: Free HTML Help dcumentatin generatr

194 Header( ) Header( ) Writes the cntents f the cntent item t the page in a large fnt. Syntax Header(<cntent item>); Arguments cntent item - Any valid cntent item. Examples Header('Object headers!'); Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

195 Image( ) Image( ) Displays an image frm the Images flder f the templates flder. The images flder fund within the templates flder cntains all usable images in templates. Yu can add mre images int this flder as needed. Syntax Image(<cntent item>); Arguments cntent item any cntent item that results in the name f a file (including the extensin) frm the images flder. Examples Image('MappingArrwRight.png'); Image(Lkup( TaskTypeIdʼ))); Belw can be fund all f the default images prvided with the prduct that are lcated within the Images Flder: Image Image Name Circle.0.png Circle.25.png Circle.50.png Circle.75.png Circle.100.png CmpletinAND.png CmpletinOR.png FailureAND.png FailureOR.png False.png FreignKey.png Inherit.png MappingArrwLeft.png MappingArrwLeftRight.png MappingArrwRight.png PrimaryKey.png

196 SuccessAND.png SuccessOR.png True.png Unchecked.png Warning.png Created with the Standard Editin f HelpNDc: Free EPub prducer

197 Include( ) Include( ) Includes the specified Template file in the current template file. Syntax Include(<template key>); Arguments template key The key f the template file, as described in the templates Page( ) functin, that yu wish t include. Examples Include('GlbalDataDictinary'); Created with the Standard Editin f HelpNDc: Full-featured multi-frmat Help generatr

198 Link( ) Link( ) Creates a link t the specified target item. Syntax Link(<link target>, <link text>[, <substitutin>]); Arguments link target - Any valid bject selectr that returns the bject t link t. Nte that when generating a table where yu wish each rw t be a link t the bject related t the rw, use $CurrentObject as the selectr. link text A cntent item that equates t the text t use fr the link. Nte that any attribute selectrs within the cntent item perate n the item being linked t. If the item being linked t is nt included in the current dcumentatin, then the link will be emitted as plain text. substitutin - A cntent item that equates t the text t use if the link target is nt fund. Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

199 List( ) List( ) List lps thrugh all f the bjects selected by a selectr and prduces a cntent item fr each item in the list. Syntax List(<bject selectr>, <cntent item>); Arguments Object selectr The bject selectr which returns items t list. Cntent item The cntent item t generate fr each item in the list. Nte that attribute selectrs in the cntent item will perate n each bject. Examples Created with the Standard Editin f HelpNDc: Free iphne dcumentatin generatr

200 Page( ) Page( ) Used t identify the template file t the Structure Maps and Template Images. Syntax Page(<key>); Arguments Key - The key name given t the page. The key name is used when specifying template keys in structure maps, using the Include( ) statement, r fr template images. Examples Page('SqlServer'); Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

201 Span( ) Span( ) Writes the cntent item t the page is in regular text. Syntax Span(<cntent item>); Arguments Cntent item The cntent item t generate fr each item in the list. Nte that attribute selectrs in the cntent item will perate n each bject.. Examples Write ut a simple message t the page: Span( This is sme plain text.ʼ) Write ut a cmbinatin f cntent items t the page: Span('Name: ' Created with the Standard Editin f HelpNDc: Easily create iphne dcumentatin

202 Table( ) Table() Creates a frmated table based n the defined header rw and bdy rw(s). Syntax Table([<bject selectr>, ] <header rw>, <bdy rws>) Arguments Object selectr if specified, the table will be generated with ne set f <bdy rws> generated fr each bject returned by the bject selectr. The attribute selectrs in the bdy rws will perate ver each returned bject while generating the rw. Header rw a set f cmma separated list f cntent items that frm the header, enclsed in curly braces { }. Bdy rw ne r mre sets f cmma separated cntent items that frm each bdy rw, enclsed in curly braces { }. Fr a table generated with an bject selectr, any attribute selectrs in the bdy rw will perate ver each returned bject. Fr a table generated withut an bject selectr, the attribute selectrs will perate n the currently scped bject. Nte that after each rw yu can include.where() this allws yu t specify a predicate that will hide the rw if it evaluates t false. Examples The belw example generates a fur clumn table with a rw fr each child fr the bject WidgetFieldsʼ: Table($Object(Path:'WidgetFields/'), { 'Name', 'Data Type', 'Precisin', 'Scale' }); The belw example generates a tw clumn table perating n the currently scped bject that cntains fur rws: Table( { 'Prperty', 'Value'}, {'Widget {'Cnnectin ctinname')!= '') {'Cnnectin Name',

203 ctinvalue')!= '') ); Created with the Standard Editin f HelpNDc: Full-featured EBk editr

204 Title( ) Title( ) Displays and defines the page's title. Syntax Title(<cntent item>); Examples Title('Functins'); Created with the Standard Editin f HelpNDc: Single surce CHM, PDF, DOC and HTML Help creatin

205 UntypedPrpertyTable UntypedPrpertyTable Creates a table cntaining all f the prperties fr the current scpe and their values, but excluding the type name clumn fr each prperty. Syntax UntypedPrpertyTable; Examples UntypedPrpertyTable; Created with the Standard Editin f HelpNDc: Create HTML Help, DOC, PDF and print manuals frm 1 single surce

206 Cntrl Flw Cntrl Flw Table f Cntents Fr( ) If( ) Cntrl Flw elements divide grups f page level bjects int lgical sectins that may be included, excluded, r repeated based n predicates r bject selectrs. Created with the Standard Editin f HelpNDc: Free Qt Help dcumentatin generatr

207 Fr( ) Fr( ) Lps thrugh the bject selectr and includes the list f page level bjects specified fr each item. Syntax Fr(<bject selectr>) { <list f page level bjects> } Arguments <bject selectr> - Any valid bject selectr including stred bject selectrs. Examples Fr($Object(Path:'FieldGrupsAll/')) { Include('InfaWidgetFieldGrupAttributeCllectin'); Include('InfaWidgetFieldGrupFieldCllectin'); Include('InfaWidgetFieldGrupDefaults'); } Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

208 If( ) If( ) An If expressin allws a sectin f cntent t be included based n the result f a predicate, with an ptinal sectin f cntent t be included therwise. Syntax If(Predicate) { <list f page level bjects> } [ Else { <list f page level bjects> } ] Arguments Predicate - Any valid predicate list f page level bjects - Any valid list f page level bjects enclsed in {}. Else - Fllws an If() statement and the If() statement's list f page level bjects. The Else statement defines an alternate set f cmmands t execute if the If() statement is nt run. The Else argument alng with it's list f page level bjects is ptinal. Examples If(Any(RunSelectr('widgets'))) { Span('I will print if True'); } Else { Span('Otherwise I will print'); } Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

209 Predicates Predicates Table f Cntents Any( ) FlagIsSet( ) String Cmparisn Cmpund Predicates Numeric Cmparisn Cunt( ) Int( ) Operatrs Predicates return a Blean value based n the bject being prcessed and allw cntrl flw elements, bject selectrs, and table rw filters t take actin(s) based n their results. Predicates can return the ppsite value that was returned by placing an explanatin pint (!) in frm f the predicate: If (!FlagIsSet('SSIS.CfDiagram')) { Span( The flag SSIS.CfDiagram is nt set.ʼ); } Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

210 Any( ) Any( ) The Any() predicate determines whether a given bject selectr cntains any bjects. Syntax Any(<bject selectr>); Arguments bject selectr any bject selectr. Returns True if the bject selectr cntains at least ne bject, therwise it returns false. Examples If(Any(RunSelectr('PreCmmands'))) { Span( The stred selectr called PreCmmands cntained at least ne bject.ʼ); } Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

211 FlagIsSet( ) FlagIsSet( ) Returns true r false if the flag is checked frm the Dcument Cntrl file fr structure maps. Syntax FlagIsSet(<cntent item>) Arguments cntent item any valid cntent item, representing the name f the flag t check. Returns True r False Examples If(FlagIsSet('SSIS.CfDiagram')) { Span( The SSIS.CfDiagram flag was set.ʼ); } Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

212 String Cmparisn String Cmparisn A string cmparisn expressin effectively cmpares tw cntent items, in the frm: Syntax <cntent item> <cmparisn peratr> <cntent item> The cmparisn peratrs are as fllws: Operatr ==!= -> Meaning Equal the predicate returns true if bth cntent items are the same Nt Equal the predicate returns true if the cntent items are different Regular expressin the right cntent item is treated as a regular expressin pattern, and the predicate returns true if the left cntent item is a match fr the pattern. The standard.net Framewrk regular expressin grammar is used. Nte that all cmparisn peratrs are case-insensitive. Created with the Standard Editin f HelpNDc: Free Web Help generatr

213 Cmpund Predicates Cmpund Predicates Cnditin cmparing tw Predicates. Syntax (Predicate <peratr> Predicate) Arguments peratr Either && r. && means bth predicates must be true fr the cmpund predicate t be true, means either f the predicates may return true fr the cmpund predicate t be true. Examples If (Any(RunSelectr('PreCmmands')) Any(RunSelectr('PstCmmands'))) { Span( Either the selectr PreCmmands r the selectr PstCmmands cntained at least ne bject.ʼ); } Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

214 Numeric Cmparisn Numeric Cmparisn Table f Cntents Cunt( ) Int( ) Operatrs Returns True r False based n the cmparisn f tw numerics. Syntax <numeric> <peratr> <numeric> Arguments <numeric> - Any valid numeric expressin. peratr - Any valid cmparisn peratr such as ==,!=, < etc... Returns True r False Examples Cunt($Object(Path:'./[@Lcatin=="null"]')) >= 5 Created with the Standard Editin f HelpNDc: Qt Help dcumentatin made easy

215 Cunt( ) Cunt( ) Returns the number f bjects that a specified selectr returns. Syntax Cunt(<bject selectr>); Arguments bject selectr any bject selectr. Returns The number f bjects that the specified selectr returns. Examples If (Cunt($Object(Path:'Details/')) == 1) { Span( The sub-bject Details cntained exactly ne child.ʼ); } Created with the Standard Editin f HelpNDc: Easily create Help dcuments

216 Int( ) Int( ) Casts the ) t an integer, allwing it t be used in numeric cmparisns r expressins. Syntax Int(@PrpertyValue( )); ) selects the Prperties value. Returns int - The prperty's value is returned as an integer. Examples Int(@PrpertyValue('Value')); Created with the Standard Editin f HelpNDc: Free EPub and dcumentatin generatr

217 Operatrs Operatrs Numeric peratrs prduce a numeric result by applying mathematical peratrs t tw numbers. Syntax <numeric> <peratr> <numeric> Arguments numeric - Any valid Cunt(), literal number, (NumericBinaryExpressin) r a ternary expressin cntaining numeric. peratr - A standard mathematical peratr: +, -, *, /. Examples Cunt($Object(Path:'./[@Lcatin=="null"]')) + 5 Created with the Standard Editin f HelpNDc: Easily create Web Help sites

218 Cntent Items Cntent Items Table f Cntents Attribute Selectrs Lkup( ) NULL Calescer Ternary Cntent Items are used t retrieve specific values frm the carbn tree r templates directry fr use within the dcumentatin. Cntent items may be frmed f a cncatenatin f mre than ne cntent item: Span( This is the value f the prperty test: testʼ) + and this is the lkup value using the lkup FunctinTypes: + Lkup( testʼ)); Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

219 Attribute Selectrs Attribute selectrs Attribute selectrs allw yu t retrieve an bject value r prperty frm the currently scped bject, r a relative theref. There are five attribute selectrs @PrpertyType(<prpertyKey>). Syntax <AttributeSelectr> [ ObjectSelectr ] Arguments ObjectSelectr - This is specified as.frm(<bjectselectr>) and allws yu t retrieve the specified attribute frm a related bject. @PrpertyType(<prpertyKey>) Returns The name f the bject. The path f the bject within the carbn tree. The type f the bject The value f the prperty specified by <prpertykey>. The type f the prperty specified by <prpertykey>, Examples Creates a span with the name f the current bject: Span(@ObjectName); Creates a span with the value f the prperty Descriptinʼ frm the current bject: Span(@PrpertyValue( Descriptinʼ)); Creates a span with the value f the prperty Descriptinʼ frm a child bject named Detailsʼ: Span(@PrpertyValue( Descriptinʼ).Frm($Object(Path:ʼDetailsʼ))); Created with the Standard Editin f HelpNDc: Free help authring envirnment

220 Lkup( ) Lkup( ) Searches the specified lkup file fr the given lkup key. It then attempts t match the given string t ne fr the mappings keys, if a match is fund, it will display the mapping value, therwise it will display the value f the given string. Syntax Lkup(String, <cntent item>); Arguments String - Used fr matching t the mappings f the lkup file. cntent item any valid cntent item. Examples Created with the Standard Editin f HelpNDc: Easy EPub and dcumentatin editr

221 NULL Calescer NULL Calescer A NULL calescer will return the value f the secnd perand if the first perand equates t NULL r an empty string. Syntax <cntent item>?? <cntent item> Examples The belw example will return the value f the prperty Firstʼ, r the value f the prperty Secndʼ if 'First' is NULL r an empty Secndʼ) Created with the Standard Editin f HelpNDc: Generate EPub ebks with ease

222 Ternary Ternary A ternary expressin returns the first cntent item if the predicate evaluates t true, r the secnd cntent item if the predicate evaluates t false. Syntax Predicate? (<cntent item>) : (<cntent item>) Arguments Predicate - Any predicate, used t determine which cntent item t include. Examples Created with the Standard Editin f HelpNDc: Easily create Qt Help files

223 Path Language Understanding the Wrkbench Path Language The Wrkbench Path Language is a special path language, similar t XPath, that is used thrughut Pragmatic Wrkbench t dynamically select specific bjects. Thugh the syntax described belw remains the same, the path language has different purpses depending n the feature that it is currently being used fr. The path grammar utlined here is used within the fllwing prducts and features: BI xpress User Defined Best Practices: Used t evaluate rules. When the Path Language returns a valid that matches the evaluated path, then the rule is in vilatin DOC xpress Custm Templates: Used thrughut DOC xpress' dcument generatin templates t cntrl the Structure Maps and Templates Metadata Viewer: Used t navigate the metadata fr a DOC xpress Snapsht Data Dictinary: Used t match custm categry items t specific metadata bject types within a DOC xpress Snapsht DOC xpress Server Custm Templates: Used thrughut DOC xpress Server's dcument generatin templates t cntrl the Structure Maps and Templates Table f Cntents Path Elements Separatrs Cnditinals Simple Cnditinals Related Path Cnditinals Negating Cnditinals Cmbining Cnditinals Intrductin Paths are cmpsed f repeating grups f separatrs and path elements. Additinally, separatrs at the beginning r end f a path have special meaning. The general frm is as fllws: Path: [<initial separatr>] [ (<element> <separatr>).. n] <element> [<trailing separatr>] Separatr: /, //, ^ Element: (.,.., *, <bject name>) [ cnditinal ] Imprtant Nte: When wrking with Path Grammar, the initial starting pint, r scpe, is exceptinally imprtant when build a valid path. Using this example tree we can see hw we may navigate t certain areas using the path's navigatin elements:

224 If we are starting at A, then t get t C the path wuld be: B/C If we are starting at A, then t get t G the path wuld be: E/F/G Hwever, users may wish t get the set f all X ndes present within the whle tree, in which case the path wuld be: //X Or, users may wish t get all X ndes that are a descendant f B, in which case the path wuld be: B//X The imprtance f the initial and trailing separatrs can be demnstrated by cnsidering the same tree, and starting at pint D. If we wanted t get t C, we culd use ne f the fllwing paths:../c /B/C Nte that the single slash at the start f the path means start frm the rtʼ, which in the case f the abve tree, is A. This is als the meaning when starting with the duble slash. S, starting frm pint D again, t get all X ndes we can use the ntatin: //X Trailing separatrs allw us t lk at get all children. In rder t get all children f nde B frm any pint in

225 the tree, we culd use: /B/ Alternatively, t get all descendants f B, we culd use: /B// Created with the Standard Editin f HelpNDc: Easy CHM and dcumentatin editr

226 Elements Path Elements Path elements, in their simplest frm, are bject names. Hwever, there are als special meaningʼ path elements which allw us t navigate thrugh the tree: The '.' can be used t explicitly state that a path starts frm the current pint. Fr example, yu might want t navigate t B then C s yu culd use B/C r./b/c. The single dt ntatin is never required, but can help in giving cntext.. The '..' is used t navigate t the parent f a nde... The '*' is used t accept any nde name as a match. S, fr example, in ur test tree (as shwn in the intrductin tpic), we culd get t the X ndes that are descendants f B by using the path /B/*/X * Created with the Standard Editin f HelpNDc: iphne web sites made easy

227 Separatrs Path Separatrs Separatrs have special meanings and are used t help navigate t an element in the Path's expressin. The '/' separates path elements in rder t navigate t the series f immediate children. / The '//' navigates t the series f immediate children and all descendants. // The '^' navigates t the series f all ancestr bjects. ^ Created with the Standard Editin f HelpNDc: What is a Help Authring tl?

228 Cnditinals Cnditinals Table f Cntents Simple Cnditinals Related Path Cnditinals Negating Cnditinals Cmbining Cnditinals Cnditinals add an extra element t path syntax. In their simplest frm, they allw returning f ndes based n a given prperty value. Hwever, they can als be used t check fr the existence f related ndes. A cnditinal is specified within square brackets after a path element. S, a simple example might be returning all ndes that are a child f B that has the prperty named Testʼ equals 123ʼ: /B/*[@Test== 123 ] Created with the Standard Editin f HelpNDc: Easy t use tl t create HTML Help files and Help web sites

229 Simple Cnditinals Simple cnditinals Simple cnditinals take ne f the fllwing frms: [<matchable> <peratr> <value>] [<matchable>.cntains(<value>)] Matchable is ne f the the value f the prperty with the key the value f the prperty with the key the type f the prperty with the key the name f the prperty with the key Testʼ name() the name f the current bject type() the type f the current bject Operatr is ne f the fllwing: == - returns a match if the matchable is the same as value.!= - returns a match if the matchable is nt the same as value. -> - returns a match if the matchable is matched by the regular expressin pattern specified by value. Nte that the == and!= peratrs are case sensitive. The -> and.cntains() peratrs are case insensitive. Created with the Standard Editin f HelpNDc: Generate Kindle ebks with ease

230 Related Path Cnditinals Related path cnditinals Related path cnditinals take the frm: [<path>] Path is a path that can be fund frm the current bject, and can cntain the full array f path syntax allwed, including cnditinals. S, a simple path cnditinal might be (referring t the test tree in the intrductin tpic) used t find all ndes that have a child nde called X: //*[./X] Or, we might want t find all ndes that have a child nde called X where that X nde als has a prperty with a key Testʼ and a value 123ʼ: //*[./X[@Test== 123 ]] Created with the Standard Editin f HelpNDc: Easily create EPub bks

231 Negating Cnditinals Negating cnditinals We may wish t negate a cnditin t retrieve the ppsite. Fr any cnditinal in the frm: [<cnditinal>] Its negatin wuld be: [!(<cnditinal>)] S, referring t the test tree in the intrductin tpic, we might want t find all ndes that d nt have a child nde called X. The path fr this wuld be: //*[!(./X)] Created with the Standard Editin f HelpNDc: Write EPub bks fr the ipad

232 Cmbining Cnditinals Cmbining cnditinals If we want t cmbine cnditinals we can create a new single cnditinal in the frm: (<cnditinal>) <peratr> (<cnditinal>) The peratr can be either && in rder t require that bth cnditinals match, r in rder t require that at least ne f the cnditinals match. We can then cmbine these cnditinals again. Fr example, if we wanted t find any bjects that had a prperty called Test that was equal t 1ʼ r 2ʼ and a prperty called OtherTest that was equal t 3ʼ, we culd use the fllwing path: //*[((@Test== 1 ) (@Test== 2 )) && (@OtherTest== 3 )] Created with the Standard Editin f HelpNDc: Create crss-platfrm Qt Help files

233 AlwaysOn Availability Grup Cnsideratins Cnsideratins Befre Installing t an AlwaysOn Availability Grup When a user wishes t install the DOC xpress database t an AlwaysOn Availability Grup as an availability database, 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 DOC xpress database t an existing availability grup as an availability database. Client Installatin Unlike Wrkbench Server, Pragmatic Wrkbench des nt require any additinal setup instructins befre beginning the prcess f cnfiguring Pragmatic Wrkbench's databases t wrk within an AlwaysOn Availability Grup. Once Pragmatic Wrkbench installatin has been cmpleted, creatin f the DOC xpress databases can be dne thrugh the Pragmatic Wrkbench UI. When creating the DOC xpress database, ensure that the databases are cnfigured s that its server settings are set t pint t the availability grup listener. After the database has been created, the user can cntinue n t adding the databases t the availability grup as an availability database. Imprtant Nte: If users wish t use an existing DOC xpress databases, they can execute a full recvery back up f their database and restre it n their primary availability replica befre cntinuing t add the database t an availability grup. Adding the databases t the Availability Grup Once the database has been created, it can nw be added as availability database 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..."

234 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 Once the DOC xpress database has been added t the availability grup as an availability database, whenever a user wishes t cnnect t the databases, the user shuld cnnect thrugh the availability

235 grup listener. Created with the Standard Editin f HelpNDc: Create help files fr the Qt Help Framewrk

236 Trial Limitatins What are the DOC xpress trial limitatins? The DOC xpress trial ffers users an extensive lk int all f DOC xpress' features. Belw is a list f limitatins placed n the DOC xpress trial. Any feature nt listed cntains n limitatins. Trial Limitatins Dcumentatin When running a trial versin f DOC xpress, nly the first three tpics at each level are generated. Created with the Standard Editin f HelpNDc: Free Web Help generatr

237 Prvider Capabilities What features are available fr each f the prviders? Best Data BI Dcume Practice Lineage Dictinar Cmpare ntatin s y Custm Metadata Imprt Excel Spreadsheet a b a b a c d c c Hive Server Infrmatica PwerCenter Repsitry Oracle Database SQL Server SSAS Server SSIS Package Additinal Ntes a c a c Excel Spreadsheet prvider wrks against Excel 2013 and abve Wrkbks (*.xlsx) Hive Server prvider wrks against HDP 2.0 and abve Infrmatica PwerCenter Repsitry prvider wrks against the Infrmatica PwerCenter Repsitry and abve Oracle Database prvider wrks against Oracle Databases 12c and abve SQL Server prvider wrks against SQL Server 2005 and abve when cnnecting t bth SQL Server On-Premises and Azure Instances SSAS prvider wrks against SSAS 2005 and abve when cnnecting t a Multidimensinal Instances and SSAS 2012 and abve when cnnecting t a Tabular Instances. In rder t cnnect t Azure Analysis Services, users will need t dwnlad and install the latest Micrsft Analysis Services Client Libraries. SSIS prvider wrks against SSIS 2005 and abve when cnnecting t the File System, SQL Server, SSIS Package Stre and SSIS 2012 and abve when cnnecting t the

238 Best Data BI Dcume Practice Lineage Dictinar Cmpare ntatin s y Additinal Ntes SSIS Catalg Imprtant Nte: Pragmatic Wrkbench (32-bit) must be used when using the SSIS Package prvider n a machine that nly cntains SSDT fr Visual Studi 2015 r SSRS prvider wrks against SSRS 2005 and abve when cnnecting t the File System and SSRS 2008 R2 and abve when cnnecting t the Native r SharePint Web Service SSRS Reprt Imprtant Nte: KPIs and Mbile Reprts are currently nt supprted when cnnecting t an SSRS 2016 r abve Reprt Server a Tableau Server e c Tableau prvider wrks against Tableau Servers with REST API enabled with the fllwing API Versins: 2.3, 2.2, 2.1 and 2.0 Best Practices rules can be analyzed fr the marked prvider(s) nce the user has created User Defined Best Practices a Dcumentatin sets generated frm the marked prvider(s) d nt cntain a unique structure and instead use a cmmn layut b c Data Dictinary categries can be applied t the marked prvider(s) nce custm paths have been created Excel Spreadsheet Lineage Analysis nly supprts dependency scanning Data Surces frm SQL Server and Analysis Services Databases and des nt supprt PwerPivt d e Tableau Lineage Analysis nly supprts dependency scanning Data Surces frm SQL Server Databases Created with the Standard Editin f HelpNDc: Free CHM Help dcumentatin generatr

239 Prviders nt shwing up Why is a prvider nt shwing up within the Surce Type drp dwn menu? While adding slutin items t yur DOC xpress Slutin, yu may run int an issue where the surce type yu wish t use des nt shw up. If this happens, chances are yu have nt met the system requirements fr that specific prvider. Please check the System Requirements page and ensure yu have all f the system requirements fr that specific prvider installed prperly. Created with the Standard Editin f HelpNDc: Full-featured Help generatr

240 Snapsht Evaluatin Perid My evaluatin perid has ended. Will I lse the snapshts I have already created when I enter my license? All slutins and their snapshts created during yur evaluatin perid are stred within the DOC xpress metabase and will still be available after yu enter yur license. Created with the Standard Editin f HelpNDc: Free EBk and dcumentatin generatr

241 Supprted Structure Maps Where can I find a list f the supprted Structure Maps that are included with my installatin? Belw can be fund the currently up t date list f Object Types that have assciated Structure Maps included upn installatin within DOC xpress Server's Templates. Generic Default Flder Hive Database Server Table Infrmatica Repsitry Server Widget Wrkflw Flder Cllectin Wrkflw Flder Wrkflw Mapping Wrkflw Task Wrkflw Wrklet Wrkflw Mapping Oracle Schema Cllectin Schema Server Server Grup SQL Server Agent Jb Cllectin Agent Jb Availability Grup Cllectin Availability Grup Service Brker Database Cllectin Database Server Stred Prcedure Cllectin Stred Prcedure Table Cllectin Table

242 SSAS View Cllectin View Actin Cllectin Cube Cllectin Cube Database Cllectin Database Dimensin Cllectin Mining Mdel Clumn Mining Structure Perspective Cllectin Rle Cllectin Server Tabular Clumn Cllectin Tabular Clumn Tabular Cnnectin Cllectin Tabular Cnnectin Tabular Database Tabular Hierarchy Cllectin Tabular Hierarchy Tabular Measure Cllectin Tabular Measure Tabular Partitin Cllectin Tabular Partitin Tabular Perspective Cllectin Tabular Perspective Tabular Perspective Table Cllectin Tabular Perspective Table Tabular Rle Cllectin Tabular Rle Tabular Table Cllectin Tabular Table SSIS Cntainers Fr Each Lp Fr Lp Sequence Destinatins ADO.NET Data Reader Flat File ODBC OLE DB Event Handler' Package Package Cllectin Package Stre Surces ADO.NET DataReader Flat File OLE DB SQL Server SSIS Catalg

243 SSIS Flder SSIS Prject SSIS Slutin Tasks Analysis Services Execute DLL Analysis Services Prcessing Backup Database Bulk Insert CDC Cntrl Check Database Integrity Data Mining Query Data Prfiling Execute Package Execute Prcess Execute SQL Server Agent Jb Execute SQL Execute T-SQL Statement Expressin File System FTP Histry Cleanup Maintenance Cleanup Message Queue Ntify Operatr Rebuild Index Rerganize Index Send Mail Shrink Database Transfer Database Transfer Errr Messages Transfer Jbs Transfer Lgins Transfer Master Stred Prcedures Transfer SQL Server Objects Update Statistics Web Service WMI Data Reader WMI Event Watcher XML Transfrms Aggregate Audit Cache CDC Splitter Character Map Cnditinal Split Cpy Clumn Data Cnversin Derived Clumn Lkup Merge Merge Jin Multicast Ole Db Cmmand Percentage Sampling Pivt Rw Cunt Rw Sampling Script

244 Slwly Changing Dimensin Srt Term Extractin Unin All SSRS Chart Reprt Reprt Prject Shared Datasets Shared Data Surces SSRS Directry SSRS File System SSRS Flder SSRS Web Service Rectangle Sub Reprts Tablix Textbx Tableau Server Site Prject Cllectin Prject Data Surce Cllectin Data Surce Wrkbk Cllectin Wrkbk Task Factry Destinatins Dynamics CRM Fact Table Oracle Upsert SalesFrce Sharepint Terminatr XML Upsert XML Output Market Surces Dynamics CRM Facebk Hadp WebHDFS LinkedIn Placehlder SalesFrce Sharepint Twitter Market Rest Tasks Advanced and SMS Advanced Execute Package Advanced Execute Prcess

245 Cmpressin Delete r Mve Surce Messages Dwnlad File Excel Pwer Refresh Expressin File Prperties PGP Secure FTP SecureCnfig SharePint Dcuments Timer Transfrms Address Parse Advanced Aggregatr Advanced Cnditinal Split Advanced Derived Clumn Advanced Lkup Advanced Lkup Cache Case Data Cleansing Data Flw Nugget Data Validatin Delete Batch Dimensin Merge Slwly Changing Dimensin Errr Output Descriptin Filter Rws Hash Null Handler Pack Data Placehlder RegEx Replace Replace Unwanted Characters Surrgate Key Timezne Cnversin Trim Plus Unpack Data Update Batch XML Generatr Created with the Standard Editin f HelpNDc: Full-featured EBk editr

246 Trubles Viewing CHM Files Trubles Viewing CHM Files Micrsft released a security path that makes it difficult t view CHM files that are either stred n a netwrk drive r generated frm a different machine than what is currently viewing them. Often times the help file will appear, but instead f being able t view the dcumentatin, an errr message will appear explaining that "this page cannt be displayed". T view the dcumentatin, please fllw the belw steps: 1. Dwnlad the CHM file t yur lcal machine. 2. Open up Windws Explrer and navigate t the flder lcatin where the CHM file is lcated 3. Right-click n the CHM file and select "Prperties" 4. On the CHM General Tab, click "Unblck" t allw access t the CHM Dcumentatin

247 5. Click the Apply buttn, and then click OK. Yu shuld nw be able t view the CHM n yur lcal machine withut any issues. Created with the Standard Editin f HelpNDc: Easy EBk and dcumentatin generatr

248 Yellw Warning in Layut Why are there yellw warning symbls within my Slutin's Layut? DOC xpress utilizes template structure maps t manage the verall structure f the dcumentatin. When a user includes an item within the Layut that des nt have a crrespnding structure map fr that items' bject type, then DOC xpress will display a yellw warning ( ) t ntify the user that the default structure map will be used instead. If DOC xpress cannt find a crrespnding structure map, a default structure map that generates dcumentatin that represents the metadata available rather than custm tailred dcumentatin. An example f default dcumentatin can be seen belw.

249 If the user des nt wish t use the default structure map, users can add custm structure maps and templates t the template lcatin in rder t custmize the dcumentatin t their persnal needs. Created with the Standard Editin f HelpNDc: Easily create iphne dcumentatin

250 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: Easily create CHM Help dcuments