Home

eDRG 3.6 User Guide Documentum Administrator

1. 7 1 WebTop and TaskSpace Configuration The WebTop and Taskspace integrations have one configuration file dit_report_generator_configuration xml This file can be found in the folder drg config report_generator under WebTop or TaskSpace It contains the following settings Setting Description Default value ConfigurationPath The full path in the Repository for the Delt Reporting location where all files for the Configuration euroscript Documentum Report Generator are stored method_name Name of the method that starts the Delt Reporting Agent Delt Reporting Agent should never be changed method_config_file The configuration file that should be Delt Reporting used by the Delt Reporting Agent Configuration Delt must be the same as the value for Reporting Agent configuration_file on the job Configuration xml settings method_trace_level The trace level that the Delt Reporting Agent uses when the users start it manually If set to O zero the log file will not be created but you will not get any error messages if something goes wrong either 55 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 ssa eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 7 2 Job Configuration amp Job Delt Reporting Agent Method Name Select Method Delt Repor
2. 02 10 2011 6 7 0000 0213 Sun Microsystems Inc 1 6 0_24 519110656 386873216 51 61 eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Operating System Windows Server 2008 6 0 Architecture x86 Delt Report Generator Webtop Version 3 0 6 Demo reports The euroscript Documentum Report Generator includes several demo report definitions that can create several basic reports about the repository The following demo Report Definitions are available Report Definition Description ACL Summary Displays the number of ACLs the number of internal ACLs the number of external system ACLs and the number of external private ACLs per format renditions per format per file store Number of Documents by Format Type Area Repository Jobs Displays the name the type the run interval the run mode whether or not the job is active the last run date and the last message of the jobs in the Repository Registered Tables Displays the table name the table owner and the owner group and world permits of the registered tables in the Repository Repository configuration Displays a selection of attributes of the dm_docbase_config object Server Configuration Displays a selection of attributes of the dm_server_config object Displays physic
3. EFS content Size by Format Demo reports Repository Historic Data Allowed indicates if historic data is globally enabled or not If you are a member of the admingroup you can enable or disable this setting from this page Automatically Create Historic Tables indicates if historic tables can be automatically created updated by the eDRG if needed If you are a member of the admingroup you can enable or disable this setting from this page The table contains all the Report Definitions in the repository History Enabled indicates if historic data is enabled for this report Tables Valid indicates if the historic tables are valid i NOTE For Report Definitions with historic data enabled it is not possible to easily detect if the tables are correct For these the Tabled Valid column will be set to Unknown Click the Show Details button Select the Report Definition and click the Show Details button for more information This information is displayed in a table under the Report Definitions table If the tables with the Report Definition are incorrect you will get a link to a logfile which contains the problems for that Report Definition 48 61 re eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Possible problems
4. Info Webpage Dialog A http 172 25 180 60 8080 webtop drg jsp report_generator properties report_generator_definitionProperties jsp _ Properties Info Info ReportTool Email History Advanced Permissions History i Type dit_report_definition Format dm_internal Name Title Subject Keywords Authors Full Content Size 5 Owner Name Edit dmadmin Version Label Edit 1 0 CURRENT Checkout Date Checked Out By P Show More Show all properties show XML Preview Ox cancel gt Fill in a name for the Report Definition i NOTE The Report Definition name is subject to the regular object_name attribute restrictions e g it has a maximum length of 255 characters gt Click Next 14 61 Era eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 8 Properties Info Webpage Dialog Properties Info ReportTool History Permissions History TAF z HH Type dit_report_definition Format dm_internal Report Name Destination 1 Item Edit 1 Item Edit 0 Items Edit 2 Items Presentation Variable DQL Select query E Show all properties show XML Preview ok Cancel The attributes shown on the info tab in the ReportTool sect
5. NOTE The Report Schedule Name is subject to the regular object_name attribute restrictions e g has a maximum length of 255 characters 43 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator a Name of Report Schedule Sep 1 2011 s if Days Super User Run As User _ ssi Named User Next Invocation Date Last Completion Date Last Status Report Definitions add report definition Reportname No report definitions gt Fill in the required attributes Explanation of the attributes Attribute Description Limits The name of the report schedule 255 characters The description of the report schedule 255 characters Report Generator and not be run next invocation is calculated from this date Run Interval Used in conjunction with run_mode to determine how often to run the report For example if you enter 3 for this attribute and Weeks for run_mode the job is invoked every three weeks The default is zero 0 which means the schedule will not run Run Mode Used in conjunction with run_interval to determine how often to run the report Run_mode specifies the unit of measure for the value in run_interval Run As User The schedule will be run under the selected user Th
6. Save Report option for the DQL Select query on this report definition to enable historic data Some general stylesheets are also included Style sheet Description Presentation xsl which displays the results of each query in a table lt cabinet gt Presentations General This stylesheet can be used to create a CSV file with Presentation CSV xsl the results from the queries It uses a comma to separate values but another separator can be used by adding an eDRG variable separator to the Report Definition and setting its value to the correct separator character lt cabinet gt Presentations General This stylesheet can be used to create an Excel sheet Presentation Excel xsl which displays the results of each query in a table form within the Excel sheet Presentation PDF xsl displays the results of each query in a table Presentation Word xsl which displays the results of each query in a table Reports Include charts xsl file See paragraph 4 8 3 Reports Include htmlCommon xsl create HTML files to create the common parts i NOTE These general presentations files are only installed if the demo reports are installed 7 System Administration 54 61 sar eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator
7. amp TaskSpace 01 May 2013 asia gt euroscript THE WORLD OF DOCUMENTS eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace euroscript Documentum Report Generator Properties Info Permissions a Ea A Type dit_report_schedule Format Name Description ls Inactive Start Date Run Interval Run Mode Run As User demo schedule Sep 6 2011 1 Days Super User Named User _ Next Invocation Date Last Completion Date Last Status Report Definitions Add report definition Remove Reportname Category Content size by Rendition Demo reports Repository Reports Documents Test now f ox f Cancel gt Click Test now The schedule runs immediately without sending a message 5 7 Report Schedules can be exported Navigate to Report Administration Report Schedules Select the Report Schedules s that you want to export Choose menu item File Choose the submenu item Export Select the location where you want to save the exported files Exporting Importing Report Schedules Report Schedules can be imported Navigate to Report Administration Report Schedules Choose menu item File Choose the submenu item Import Select the file you want to import 5 8 Report Schedules can be deleted gt Navigate to Report Administration Report Schedules gt Select the Report Schedule that you want to delete gt Choose menu item Fil
8. gt euroscript THE WORLD OF DOCUMENTS EUROSCRIPT DOCUMENTUM REPORT GENERATOR eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 2 is EMC Deliver meaningful insight across your organisation aE SELECT eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Contents Contents 2 1 Product Description 4 2 Introduction 5 2 1 Roles 5 2 2 Reports 6 2 3 Report Definitions 6 2 4 Report Categories 6 2 5 Report Schedules 7 3 Report User 7 3 1 Introduction 7 3 2 Generating Reports 7 3 2 1 Choosing a Stylesheet 8 3 2 2 Setting Variables 8 3 2 3 Including Historic Data 11 3 3 Subscribing to Report Definitions 12 3 4 Subscribing to Report Categories 12 4 Report Builder _____ S 7 OB 4 1 Introduction 13 4 2 Copying Moving Report Categories 13 4 3 Creating Report Definitions 13 4 3 1 Destinations 17 4 3 2 DQL Select Queries 19 4 3 3 Result Threshold 21 4 3 4 Variables 21 4 3 5 Object Variables 23 4 3 6 Repeating Variables 25 4 3 7 Optional Variables 26 4 3 8 Category Variables 26 4 3 9 Special DQL Functions 26 4 3 10 Presentations 28 4 3 11 Historic Data 30 4 3 12 Permissions 31 4 4 Automatically Removing Old Reports 31 4 5 Getting the XML File 32 4 6 Copying Moving Report Definitions 32 4 7 Exporting Importing Report Definitions 32 4 8 Creating Presentation Fil
9. type gt value last row lt last column name gt lt object gt lt objects gt lt objects name name of last DQL query gt lt object gt lt first column name type type gt value first row lt first column name gt lt last column name type type gt value first row lt last column name gt lt object gt lt object gt lt first column name type type gt value last row lt first column name gt lt last column name type type gt value last row lt last column name gt lt object gt lt objects gt lt query_times gt lt duration gt duration of the first DQL query in milliseconds lt duration gt lt duration gt duration of the last DQL query in milliseconds lt duration gt lt query_times gt lt result gt The settings part of the XML file contains the values set by the user for the variables if any were specified for this Report Definition and the float and date formats set on the report definition by the Report Builder The available column types are boolean double id integer string time undefined VvvVvvVvVVVYV 4 9 1 Values From Repeating Attributes in The XML File The syntax of values from repeating attributes in the XML file depends on the value of the Split Repeating Values attribute on the report definition If the Split Repeating Values attribute is not selected the syntax is 37 61 www euroscript com eDRG 3 6 User Guide Do
10. 118 9080 webtop webcomponent library locator locatorcontainer jsp _dmfRequestid _ client9 308 amp _dmfFromModalPopup tr b l Choose a type documentum Starts with Name dm_type dmi_index dmi_sequence dmi_vstamp dmi_session dmi_transactiontog dmi_type_info dmi_recovery dm_acl dm_docbaseid_map dm_user dm_group dm_sysobject dmr_containment 1 D O D O O O DO D DODDO DO O G HT 44 4 Page 1 of 2 tems per page http 172 25 180 118 9080 webtc Internet Beveiligde modus uitgeschakeld 24 61 ane eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 4 3 6 Repeating Variables If the Repeating option for a variable is selected the user can specify multiple values for that variable You can use all variable types except dates and booleans as a Repeating Variable You can use the Repeating Variable in various locations of you DQL query Examples In the SELECT part DQL Query SELECT r_object_id var FROM dm_sysobject If var is filled with object_name title and object_type then the actual DQL query will be SELECT r_object_id object_name title object_type FROM dm_sysobject In an IN or EXISTS list DQL Query SELE
11. Combines most of the other reports in one report 53 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Tasks Assigned to me Displays the workflow name the task name the priority the work queue name the creation date and the due date for tasks assigned to the currently logged in user Tasks Assigned a Group or Work Displays the workflow name the task name the Queue priority to whom the task is assigned the work queue name the creation date and the due date for tasks assigned to a group or work queue that the currently logged in user is a member of 1 These demo report definitions will only work if Document Transformation Services is installed These report definitions give an error when DTS is not installed 2 These demo reports generate links to Webtop but this only works if Webtop run on the address http localhost 8080 webtop To change this address you can change the style sheet for this report definition by changing the value for lt xsl variable name Webtop gt 3 These demo reports are available in HTML Excel and PDF format 4 These demo reports are available in HTML and PDF format 5 The PDF format for this report can also display historic data of this report if enabled Check
12. Documents Created by a user dmadmin Document Transformation Services EFS Doc oao oes EH Documents con Full Text Index EFS Documents Owned by me dmadmin EH Jobs ra Registered Tables ES my Tasks dmadmin com Repository Configuration ES My Workflows dmadmin com Workflows EH WorkQueues User Reports E My Home Cabinet amp Cabinets Add Repository Report Generator tree node in Documentum Administrator and Webtop 2 hi Ate ET Reports Eea EE pi p drg_user Report Definitions EH Demo reports Name Search EH Repository Reports Show Documents mi H Document Transformatior H Documents ee aes 59 Name Title Type Keywords Format Size Modified Owner Name Checked Out By Topic Status 5 SS m lt ree Registered Tables E Documents Created by a user dit_report_definition dm_internal 5 9 9 2011 3 42 PM dmadmin G Repository Configuration aie x i 2 HE Workflows E Documents Created by me dit_report_definition dm_internal 5 9 9 2011 3 42 PM dmadmin raa WorkQueues E Documents Owned by me dit_report_definition dm_internal 5 9 9 2011 3 42 PM dmadmin EC User Reports EH My Tasks dit_report_definition dm_internal 5 9 12 2011 10 26AM dmadmin ERS My Workflows dit_report_definition dm_internal 5 9 9 2011 3 42 PM dmadmin Report Generator tree node in Documentum TaskSpace 3 2 Generating Reports Double click on a Report Definition to generate the report After the report is generated it is placed in your home cabinet and automatically opened
13. Integer Variables You can enter any number for Integer Variables If you enter a text that is not a number you will get an error message Single Integer s Single Integer Variable Add Repeating a Integer Repeating Integer Variable 3 2 2 4 Choice List Variables For Choice List Variables you can select a value from the dropdown box e g a user name Single Choice _ list rie Single Choice List Variable Add Repeating Oll Choice list Removej Repeating Choice List Variable 3 2 2 5 Object Variables Use the Add button to select an object from the repository for the Object Variable The allowed object types to select are set by the Report Builder e g a folder to search in Single Object Add ik Single Object Variable Add Re sii ting amie 7 n Object i Repeating Object Variable 10 61 sor eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator E Choose an item Dialoogvenster van webpagina http 172 25 180 60 8080 da webcomponent library locator locatorcontainerjsp Choose an item Dctmo Starts with Show Current Versions Name Dctm67 Delt Report Generator dm_bof_
14. clicking on the edit link for the visible attribute in the same group i e for variables the attribute variable is visible and the attribute variable_type is not These attributes are required 41 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 oa CHED GHD e eDRG 3 6 User Guide Documentum all e U ro S C r i pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS 5 2 1 Permissions On the Permissions tab of a Report Category the permissions can be changed By default each Report Category will have the dlt_report_definition_acl ACL which means Users with the report_user role can see the Report Category Users with the report_builder role can edit the report category and add Report euroscript Documentum Report Generator Definitions Users with the report_administrator role can delete Report Category i NOTE If you change the permissions on a Report Category the new permissions will be inherited by all new Report Category and Report Definitions that are created in this Report Category not for the objects that are already present 5 3 Deleting Report Categories Report Categories can be deleted Navigate to Report Administration Report Definitions Select the report category that you want to delete Choose menu item File Choose submenu item Delete The Report Category is deleted Vvvv 4 D CAUTION WW If the Report Category i
15. destinations the attribute destination is visible and the attribute destination_type is not 6 If left empty then the following format is used yyyy MM dd hh mm ss 7 If left empty then the following format is used 4 8 This attribute is hidden on both the properties screen and the dql edit screen but is automatically set internally These attributes are required 4 3 1 Destinations Destinations define the location where the report will be saved to or emailed to if the destination type is E mail A Report Definition can have multiple destinations Each destination specification consists of a Destination and a Destination Type Only the attribute Destination is displayed on the attributes screen These two attributes are edited together gt Click Edit The edit screen opens 17 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Core eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator The edit destinations To add new entries gt Fill in the fields in the bottom row gt Click Add Destination Type Destination OS Must be an existing accessible location on the file system on the server with the Java Method Server Repository Must be an existing folder path in the repository Email Must be a valid email address Multiple
16. dit_report_agent_acl This ACL is placed on the eDRG method 7 6 Job Method The euroscript Documentum Report Generator uses a Job and a Method to generate the reports Job Delt Reporting Agent Method Delt Reporting Agent 59 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sere eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator The Job is used for periodically processing scheduled reports The Method is called by the Job as well as when a user manually requests a report Another Job Delt Cleanup History is used to periodically remove old reports from the Historic Data Tab Appendix I Java formats Valid Java date formats taken from Java documentation The following pattern letters can be used Letter Date or Time Presentation Examples Component Text AD Year 1996 96 Month July Jul 07 Number 27 Number Number 189 Number 10 Number Text Tuesday Tue Text PM Number Number 24 Number Number 12 Number 30 Number 55 Number 978 Pacific Standard Time PST GMT 08 00 Pattern letters are usually repeated as their number determines the exact presentation Text for formatting if the number of pattern letters is 4 or more the full form is used Otherwise if available a short or abbreviated form is used For parsing bot
17. email addresses can be specified separated by a The Browse button lets the user select a cabinet or folder in the repository as destination This button only works if Destination Type is set to Repository If the Destination Type is set to any other value the button will be disabled To edit an existing entry gt Click Edit for that row gt Edit the existing entry gt Click OK If you select more rows gt Move the rows up or down with the Move up and Move down buttons Or gt Remove the rows with the Remove button gt Click OK All changes are saved Always specify at least one destination in order to be able to specify presentations 18 61 ase eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Destinations are used for automatically generated reports Manually generated reports are always placed in the user s home cabinet regardless of any destinations specified 4 3 2 DQL Select Queries DQL Select queries define the DQL queries that should be run to build the report Each report definition can have multiple DQL queries A DQL query consists of a DQL Select query a DQL Name a Result Threshold and a Save Report Only the attribute DQL Select query is displayed on the attributes sc
18. file can use the following two lines to load the actual XML result file and process it lt xsl param name SourceDocument select processing instruction input file saxon get pseudo attribute filename gt lt xsl apply templates select sSaxon stream doc SourceDocument result objects gt 4 9 XML File The basis syntax of XML file that the style sheet should process is lt result gt lt settings gt lt variable name name of first variable gt value first variable lt variable gt lt variable name name of last variable gt value last variable lt variable gt lt format type float gt float format lt format gt lt format type date gt date format lt format gt lt reportname gt name of the report lt reportname gt lt settings gt lt objects name name of first DQL query gt lt object gt lt first column name type type gt value first row lt first column name gt 36 61 sere eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator lt last column name type type gt value first row lt last column name gt lt object gt lt object gt lt first column name type type gt value last row lt first column name gt lt last column name type
19. language setting may only be changed if the translated messages are available in this file generated concurrently repository historic_tables automatically created updated when needed in the repository 7 3 Changing the eDRG Cabinet By default the euroscript Documentum Report Generator stores its files in the cabinet Delt Report Configuration It is possible to change the name of this cabinet To change the name of the Delt Report Configuration cabinet gt Login to Documentum Webtop gt Navigate to Cabinets gt View the properties of the cabinet Delt Report Configuration gt Change the name gt Save the cabinet object On the application server Navigate to the Webtop or TaskSpace folder structure Navigate to drg config report_generator dlt_report_generator Open the file dilt_report_generator_configuration xml Change the value between the lt ConfigurationPath gt tags to reflect the new cabinet name Change the value between the lt method_config_file gt tags to reflect the new cabinet name Save the file Restart the application server oyy vV VWVVY Go to this page http lt application server gt webtop wdk refresh jsp 7 4 Checking Method Logs Each time when a report is generated a log file is created unless the trace level is set to 0 If the report is generated manually or the schedule is started with the Test now button the log file is placed in the Temp cabinet If the Delt Reporti
20. of the variable in the DQL query on the place where it should be used All occurrences of this text are replaced with the value entered by the user E g if the variables are set as shown in the image the user that runs the report definition will get the following screen 22 61 aa eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Run report Name of Report Definition Set these variabtes to run the report User name gmadmin From Date 5EP 13 2011 En o ox f cancel If the DQL query for this Report Definition is set to SELECT object_name r_creation_date FROM dm _ document WHERE owner_name user_name AND r_creation_date gt from_date ORDER BY r _creation_date user_name is replaced by the value selected in the first row and from_date is replaced by the date selected on the second row The result is a list of all documents created by the user from the specified date To add new entries gt Fill in the fields in the bottom row gt Click Add To edit an existing entry gt Click Edit for that row gt Edit the existing entry gt Click OK If you select more rows gt Move the rows up or down with the Move up and Move down buttons Or gt Remove the rows with the Remove butt
21. statement is repeated as well Example DQL Query SELECT r_object_id FROM dm_sysobject WHERE ANY keyword var 25 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum S e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator If var is filled with Document and Example then the actual DQL query will be SELECT r_object_id FROM dm_sysobject WHERE ANY keyword Document OR ANY keyword Example i NOTE Repeating variables cannot be used inside special DQL functions See paragraph 4 3 9 4 3 7 Optional Variables The Mandatory field determines if a variable is mandatory or optional Optional Variables can be left empty by the end user Using the special DQL function DRGIF see paragraph 4 3 9 you can create a DQL select query with optional parts Example Variable owner DQL Query SELECT FROM dm_sysobject DRGIF owner WHERE owner_name owner If Sowner is empty the actual DQL query will be SELECT FROM dm_sysobject If Sowner is dmadmin the actual DQL query will be SELECT FROM dm_sysobject WHERE owner_name dmadmin 4 3 8 Category Variables Variables can also be defined on a Report Category In this case all Report Definitions in that Report Category and all sub categories automatically have these va
22. that is used by the Report Definition should create an XSL FO file which is then transformed to a PDF file i NOTE The transformation from XSL FO to PDF will only happen if the presentation type for this presentation file on the report definition is set to PDF The euroscript Documentum Report Generator uses Apache FOP http xmlgraphics apache org fop to create the PDF files The limitations of Apache FOP also apply to the euroscript Documentum Report Generator 4 8 3 Charts in PDF Reports Charts can be created by generating SVG images http www w3 org TR SVG11 inside the XSL FO file Number of Documents by Object Type 57 BB im document 1131 WB dmi_expr_code 181 E dm_method 107 MY dm_app_ref 100 E dm_activity 98 I dm_folder 91 WE am _job 40 WB ciit_report 36 Be dit_report_definition 32 E Others 166 Example chart that can be created in PDF files When the demo reports are installed some of the examples create PDF files and one of them charts xsl can create charts This stylesheet can be included in other stylesheets that create PDF files Read the comments in the charts xsl file for instructions on how to use it Apache FOP uses Batik http xmlgraphics apache org batik to generate the SVG images The limitations of Batik also apply to the euroscript Documentum Report Generator 35 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2
23. the report the time it took to run the query in miliseconds presentation_duration Repeating Integer For each presentation in the report the time it took to create the output file in miliseconds 39 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sere eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 5 Report Administrator Ze My Files Categories F Report Generator 5 1 Introduction E Report Administration This chapter describes the functionality for users with _f3 Report Definitions the report_administrator role ce Demo reports Report Administrators can access the Report 0 Repository Reports Schedules tree node under the Report Administration H User Reports tree node H Report Presentations The Report Schedules tree node contains the Report O Schedules for the eDRG A Administration HE Home Cabinet 3 i o a Cabinets 5 2 Creating Report Categories Report Categories can be created from the following section Report Administration Report Definitions not from the Report Generator section To create a Report Category gt Navigate to the report category in which you want to create the Report Category gt Choose menu item File gt Select submenu item New gt Select submenu item Report Category New Report Category Creat
24. 013 osa eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 4 8 4 Logging Errors in XSL FO Because of the logging method used by Apache FOP and Batik to log errors we cannot place those messages in the euroscript Documentum Report Generator log file The post installation tasks describe a workaround so the messages will be logged to a separate log file on the content server host 4 8 5 Process Large XML Files with Saxon Stream Function Processing large XML files requires lots of memory on the Java Method Server If your reports are too big to process in memory you can use the Saxon Stream Function to reduce the memory requirements To use the Saxon Stream function you need to have Saxon EE Saxon SA installed and a valid license to use it Software and licenses can be obtained via the Saxonica website http www saxonica com Select the Uses Saxon Stream Functions attribute on the report presentation object to enable the Saxon Stream function for that report presentation With this option enabled the euroscript Documentum Report Generator will create 2 XML files 1 file is the same as the XML file for all reports See paragraph 4 9 The other file looks like this lt input file filename Path to actual result file gt lt dummy gt The second file is passed through to the presentation file This presentation
25. 2000 Database 0901e240800001e4 Blank Word 6 0 7 0 Document 0901e240800001e5 Blank Word 97 2000 Document 0901e240800001e6 Blank Word 97 2000 Template 0901e240800001e7 Blank PowerPoint 97 2000 Pr 0901e240800001e8 Blank PowerPoint 97 2000 Te 0901e240800001e9 Blank Microstation Document 0901e240800001ea Framemaker 5 5 Chapter 0901e240800001eb Framemaker 5 5 Fax 0901e240800001ec Framemaker 5 5 FrontMatter 0901e240800001ed Framemaker 5 5 Index 0901e240800001ee Framemaker 5 5 Letter 20 61 w eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum gt a e Uroscr i pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Clicking on Save will copy the DQL query back to the field on the edit page Clicking on Close will close the DQL Test screen without changing anything i NOTE The DQL Test screen does not support variables variables need to be filled in manually The DQL Test screen does support special functions 4 3 3 Result Threshold The Result Thresholds can be used to specify the minimum number of required results A report is only generated if at least one of the DQL queries for the report has at least the number of results specified at Result Threshold If you set the threshold for all DQL queries to one the report will only be generated if at least one of the DQL queri
26. CT r_object_id FROM dm_sysobject WHERE object_name IN var If var is filled with Example Document and My Document then the actual DQL query will be SELECT r_object_id FROM dm_sysobject WHERE object_name IN Example Document My Document If you don t include the quotes around var there will be no quotes in the actual DQL query In a comparison operator This example is with the operator but it also applies to like not like lt gt lt 7 gt DQL Query SELECT r_object_id FROM dm_sysobject WHERE object_name var If var is filled with Example Document and My Document then the actual DQL query will be SELECT r_object_id FROM dm_sysobject WHERE object_name Example Document OR object_name My Document If you don t include the quotes around var there will be no quotes in the actual DQL query If the variable in the DQL query has a character before or after it this will be included in all the values Example DQL Query SELECT r_object_id FROM dm_sysobject WHERE object_name LIKE var If var is filled with Example Document and My Document then the actual DQL query will be SELECT r_object_id FROM dm_sysobject WHERE object_name LIKE Example Document OR object_name LIKE My Document If the statement with the repeating variable is an ANY statement the ANY
27. Copying Moving Report Definitions Copying and moving Report Definitions works in the same way as copying or moving other objects It is only possible to copy or move Report Definitions to Report Categories from Report Administration Report Definitions 4 7 Exporting Importing Report Definitions Report Definitions can be exported by Report Builders Navigate to Report Administration Report Definitions Select the report definition s that you want to export Choose menu item File Choose the submenu item Export Select the location where you want to save the exported files Report definitions can be imported by report builders Navigate to Report Administration Report Definitions 32 61 ae eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Navigate to the report category where the report definition should be imported Choose menu item File Choose the submenu item Import Select the file you want to import 4 8 Creating Presentation Files The stylesheets use XSL http www w3 org TR xsl to create the reports The Presentation Files can be accessed from the tree node Report Administration Report Presentations A Demo reports t Report Schedules To create a report presentation gt Navigate to the f
28. Historic Data Table and optionally a repeating values historic data table The name of the Single Values Table is the value of the dql_history_table field _s The name of the Repeating Values Table is the value of the dql_history_table field _r The value in dql_history_table must start with edrg_ If tables are automatically generated they will get the name edrg_ object id of the report definition _ unique number 6 characters _s or _r The following table describes the columns that are added to all the Historic Data Tables Column Description edrg_report_identifier integer Used to group results from a report edrg_row_id integer Used to sort the results in a report edrg_value_index integer Only added to the repeating values table Used to sort the repeating values results in a row 49 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum Sw c u r O S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator i NOTE The eDRG uses the registered tables from Documentum to check the Historic Data Tables The information in the registered tables must always match the actual Historic Data Table 5 10 2 Historic Info Table The historic data function needs a Historic Info Table to store information about the stored reports This table needs to be created and registe
29. Status The last status for this report Read only field definition reported by the Reporting Agent The presentations for the reports See paragraph 4 3 10 1000 characters 32 characters Presentation Presentation Name Presentation Type Presentation Format Presentation Destination gt Variable Variable Label Variable Type gt Variable Default Value Variable Query Variable Repeating Variable Mandatory Report Name 32 characters e g max 11 13 destinations 32 characters 255 characters The variables for the reports See paragraph 4 3 4 255 characters 1000 characters The name used for the generated 255 characters reports If the report is placed in an OS location or if Save as Version is false the current date and time are added to the name Save as Version If selected new reports will be Saved as new versions of a previous report Save as Rendition If selected multiple presentations will be saved as renditions of each other Users are only allowed to run this report definition between the specified times If the 2 values are Allow manual run after Allow manual run before the same a manual run is always allowed These settings do not affect schedules Remove Reports after Removes reports after the specified Number of Versions number of versions See paragraph 4 4 Remove Reports after Removes old reports after the Number of D
30. agraphs describe the types of variables that can be set 8 61 eye eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Repeating variables have an Add and Remove button to add or remove values from the list Run report Documents Created by a user Set these variables to run the report User name z From Date Date Hz He v Minute v Second v Show History Period From date 5ep 12 2011 End Date Sep 12 2011 Select a stylesheet HTML fomat The variables 3 2 2 1 String Variables You can enter any value for a String Variable e g a keyword to search for Single String ti Single String Variable Add Repeating Oo String Remove Repeating String Variable 3 2 2 2 Date Variables You can use the date selector and time drop down boxes to set a date for a Date Variable e g oldest date to include e i Single Date Date Single Date Variable There are no repeating date variables 9 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sya eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 3 2 2 3
31. al file system paths of the dm_location objects Halted Workflows Displays the workflow template name the instance name the supervisor the user the currently active task was assigned to and the timestamp of the currently active task for the halted workflows in the Repository Number of Workflows by Displays the number of workflows per supervisor Supervisor eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator workflow template of the groups in the Repository Documents Created by me Displays the document name the document creator the modify date the current state of the documents created by the currently logged in user The report contains direct links to the objects in the repository Displays the document name the document creator the modify date and the current state of the documents owned by the currently logged in user The report contains direct links to the objects in the repository Displays the document name and the creation date of the documents created by the specified user and from the specified date The user running the report can select the user and the from date This report definition uses variables and cannot be run from a schedule because no default values are set The report contains direct lin
32. are Problem Solution The table exists for DQL but isn t used Remove the table and registered table from the database No name is specified for the historic tables Nothing exists yet for this Report Definition for DQL Set the dql_history_table to the name of the table you want to use see paragraph 5 10 1 and create the table and registered table in the database The historic table for DQL has an Update the dql_history_table field with the invalid prefix Prefix must be edrg_ correct prefix and update the table and registered table in the database The table does not exist but is required Create the table and registered table in the for DQL database The column in table for DQL is of Change the column in the table and the type but should be registered table in the database to the correct type The length of the column in table for Change the column in the table and DQL is but should be registered table in the database to the correct length The column in table for DQL exists Remove the column from the table and but isn t used registered table in the database The column of the type and length Add the column to the table and registered is missing in the table for DQL table in the database 5 10 1 Historic Data Table Each DQL Select Query with Save Report enabled has a single values
33. ays specified number of days See paragraph 4 4 If selected the Report Generator will use a disk cache less memory 16 61 E eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator consumption instead of a memory cache faster processing for temporary files This option is recommended for large reports Save Run Mode Save Run Mode These attributes are used for reports Save Report Interval with historic data See paragraph 0 Save Report Mode Retention Interval a Retention Mode Default Show History Interval Period User can select Indicates if user can choose a destination destination location in the repository or email address when running a report 1 If left empty then the following text will be used This is a report automatically generated by the Delt Report Generator 2 If left empty then the following text is used lt user_name gt lt repository_name gt com 3 If left empty then the following text will be used Report from repository 4 See Appendix I Java formats 5 These attributes are hidden and won t be displayed on the attributes page but can be set by clicking on the edit link for the visible attribute in the same group i e for
34. begun yet ERROR Error while reading license file There was an error reading the license file After this message the error will be displayed ERROR No license file specified The location of the license file is not specified in the configuration file ERROR Required argument user_name missing Something is wrong with the job Make sure that pass standard arguments is checked settings Check these settings on the job settings ERROR Required argument docbase_name missing Make sure that pass standard arguments is checked on the job settings ERROR The arguments report_definitions and test_schedule are not valid when this method is Started by a job test_schedule cannot be specified together types are not allowed SELECT query check the query that is listed below this message Unknown destination type only Repository OS and These errors are only possible if the 58 61 sere eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Email are allowed values on the report definition are Unknown presentation type only Repository and OS incorrect Open the report are allowed definition edit all destinations or presentations and save the object Cannot find a matching 0 argument function named Mes
35. cumentum Administrator Webtop amp TaskSpace 01 May 2013 Come eDRG 3 6 User Guide Documentum Sw u r O S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator lt column name type type gt value1 value2 last value lt column name gt 1 1 1 If the Split Repeating Values attribute is selected the syntax is lt column name type type repeating true gt lt value index 0 gt value1 lt value gt lt value index 1 gt value2 lt value gt lt value index gt last value lt value gt lt column name gt 4 9 2 Historic Data in The XML Files If the user requested historic data to be included in the report the following XML syntax is added to the report after lt settings gt and the first lt objects gt lt historic name name of first DQL query gt lt historic_report reporttime date of first included historic data reportuser useraccount used for this report runtype 1 manual run 2 automatic run gt lt historic_object gt lt first column name type type gt value first row lt first column name gt lt last column name type type gt value first row lt last column name gt lt historic_object gt lt historic_object gt lt first column name type type gt value last row lt first column name gt lt last column name type type gt value last row lt last colum
36. delete the report will not be generated A DQL query can contain variables see paragraph 4 3 4 and special functions see paragraph 4 3 9 To add new entries gt Fill in the fields in the bottom row gt Click Add To edit an existing entry gt Click Edit for that row gt Edit the existing entry gt Click OK If you select more rows gt Move the rows up or down with the Move up and Move down buttons Or gt Remove the rows with the Remove button gt Click OK All changes are saved The Test DQL button opens DQL Test screen where the user can execute the DQL query and check the results DQL Test Query SELECT r_object_id object_name FROM dm_document Execute save Close Show as text for easy copy and paste 2 Show as HTML for best formatting Results Maximum results to return 100 v String Value Column Width 32 r_object_id object_name 0901e240800001d0 Default Signature Page Template 0901e240800001dea Blank PowerPoint Pre 3 0 Pres 0901e240800001db Blank WordPerfect 6 Document 0901e240800001dc Blank WordPerfect 7 Document 0901e240800001dd Blank WordPerfect 8 Document 0901e240800001lde Blank Excel Workbook 5 0 7 0 0901e240800001dE Blank Excel 97 2000 Workbook 0901e240800001e0 Blank Excel 97 2000 Template 0901e240800001e1 Blank Access 95 Database 0901e240800001e2 Blank Access 37 2000 MDE Da 0901e240800001e3 Blank Access 37
37. e 1 Create 3 Permissions Demo reports Name Show options A window opens where you can enter a name for the Report Category gt Fill in a name for the Report Category 40 61 re eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator i NOTE The Report Category Name is subject to the regular object_name attribute restrictions e g has a maximum length of 255 characters gt Click Next New Report Category Info 1 Create 3 Permissions Demo reports Name new category Title Subject Keywords Edit Owner Name Edit dmadmin P Show More ReportToot Edit 0 Items Variable The attributes screen for Report Categories is shown gt Optionally fill in the attributes gt Click Finish The Report Definition is created Explanation of the attributes Attribute Description Limits Variable The variables for the reports in this 32 characters category See paragraph 4 3 4 Variable Label 255 characters Variable Type Ss Variable Default Value re 255 characters 1 Variable Query 1000 characters Variable Repeating Variable Mandatory DES ene 1 These attributes are hidden and won t be displayed on the attributes page but can be set by
38. e gt Choose menu item Delete 46 61 asi eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Deleting Report Schedules www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator The Report Schedule is deleted 5 9 Automatically Running Report Schedules The Delt Reporting Agent job periodically checks which schedules should be started and starts them When a Report Schedule is started a flag is set so that the schedule won t get started twice If the Documentum Java Method Server or the Documentum Content Server is stopped while a schedule is running this flag will not be removed To prevent that those schedules will never run again the flag is automatically removed after 1 hour 5 10 Managing Historic Tables A Report Administrator can manage the historic tables by pressing the Manage Historic Tables button on the Report Administration page Dctm67 dmadmin File Edit View Tools Work Queue Monitor me Inbox l l are Work Queues Report Administration Buccs Manage Historic Tables gt Q Siiscriptions Get Version and Environment Info f Manage Historic Tables My Files Name Description _ bares sal Report Definitions Manage report definitions and report categories Report Generator Report Administration Report Presentations Mana
39. eckbox Show History Data is used to indicate if historic data should be included in the report The two date selectors below this checkbox can be used to specify the period you want to be included in the historic data 3 3 Subscribing to Report Definitions You can subscribe to Report Definitions gt Select the Report Definition gt Choose menu item Tools gt Choose submenu item Subscribe If you double click on a subscription of a report definition the report will be generated 3 4 Subscribing to Report Categories You can subscribe to Report Categories gt Select the Report Category gt Choose menu item Tools gt Choose submenu item Subscribe 12 61 Era eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator A Report Builder 4 1 Introduction sie My Fil This chapter describes the functionality for users with lt rania the report_builder role Users with the Report Generator report_administrator role also have the report_builder C Srg Demo reports role a l 7 n Repository Reports Report Builders can access the Report Administration re Reais mic tree node and the underlying tree node Report ae Report J EREN ES B EES tt Definitions and Report Presentations EHB Re
40. ed on both Repository level as Web Application Level Both use standard EMC Documentum subcomponents for its functionality In pre euroscript Documentum Report Generator 3 0 versions also some components where needed on the Java Method Server As from release 3 1 this is no longer required Since 2012 the report generator has been EMC certified In this same year euroscript has become an EMC select partner Because of this the name has been changed from euroscript Delt Report Generator to euroscript Documentum Report Generator In the product you will still find some references to the old name This will be adjusted in a future release 2 Introduction 2 1 Roles The euroscript Documentum Report Generator uses three predefined roles to allow access to the functionality it provides After the euroscript Documentum Report Generator has been installed users have to be assigned to each of these roles as appropriate using Documentum Administrator Note that these roles are hierarchical e g a report_builder is also a report_user and a report_administrator is a report_builder and a report_user as well report_user This role is used by the euroscript Documentum Report Generator for users that are allowed to generate reports and view report history report_builder This role is used by the euroscript Documentum Report Generator for users that are allowed to create new report definitions and manage report presentations report_admini
41. ed to generate reports You can access the Report Definitions from the Report Generator tree node A report definition must be placed in a report category and can be created by a report builder 2 4 Report Categories Report Categories are used to group report definitions Each report category can contain other report categories and report definitions Each report definition must be placed in a report category Report categories can be created by a report administrator 6 61 Pa eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 2 5 Report Schedules Report Schedules E are used to schedule reports for automatic generation Example using a schedule a report can be generated every Saturday at 23 00 or every day at any other desired time 3 Report User 3 1 Introduction This chapter describes the functionality for users with the report_user role Users with the report_builder or report_administrator role also have the report_user role Dctm67 drg_user File Edit View Tools Inbox Q Saved Searches Report Generator Demo reports User Reports Q Subscriptions User Reports F Starts With x My Files Categories 10 v Report Generator Sg ee To zap HHA Demo reports a a H Repository Reports EES
42. es 33 4 8 1 Including Other Presentation Files 34 4 8 2 Creating Presentation Files for PDF Report 35 4 8 3 Charts in PDF Reports 35 4 8 4 Logging Errors in XSL FO 36 4 8 5 Process Large XML Files with Saxon Stream Function 36 4 9 XML File 36 4 9 1 Values From Repeating Attributes in The XML File 37 4 9 2 Historic Data in The XML Files 38 4 10 eDRG usage 39 5 Report Administrator 40 5 1 Introduction 40 5 2 Creating Report Categories 40 5 2 1 Permissions 42 5 3 Deleting Report Categories 42 2 61 Cae eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 5 4 Deleting Report Definitions 42 5 5 Creating Report Schedules 43 5 6 Testing Report Schedules 45 5 7 Exporting Importing Report Schedules 46 5 8 Deleting Report Schedules 46 5 9 Automatically Running Report Schedules 47 5 10 Managing Historic Tables 47 5 10 1 Historic Data Table 49 5 10 2 Historic Info Table 50 5 11 Getting Version and Environment Information 50 6 Demo reports 52 7 System Administration 54 7 1 WebTop and TaskSpace Configuration 55 7 2 Job Configuration 56 7 3 Changing the eDRG Cabinet 57 7 4 Checking Method Logs 57 7 5 ACL s 59 7 6 Job Method 59 Appendix I Java formats 60 3 61 www euroscript com eDRG 3 6 User Guide Document
43. es has results Result thresholds are only checked if the Report Definition is run by a report schedule Manually generated reports are always generated Examples Threshold Threshold Actual Actual Report generated DQL 1 DQL 2 results DQL results DQL 1 2 o jo O k Yes both are more or equal o 5 10 __ Yes both are more or equal 4 3 4 Variables Variables in the DQL query can be used to let the user specify a part of the DQL query that Should be run E g the name of a department to get the results for that department Variables are defined on a Report Definition and consist of the following fields a Description Variable The variable as it is used in the DQL query Variable Label The label of the variable that is shown to the user running the report definition Variable Type The type of the variable see next table Variable Default Value The default value for this variable This value is used as the default for when the user is asked to fill in the variables and is used as the value to use when this Report Definition is run in a schedule It is possible to use a DQL Select query as default value Variable Query If the Variable Type is set to Choice list this query is used to fill the dropdown list with values the user can choose from www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 eDRG 3 6 User Guide Documentum e U ro S C ri pt Adminis
44. f historic data to be Default Show History included Last x Days Period Last x Weeks Last x Months Last x Years i NOTE The PDF format of the demo report Number of Documents by Object Type can handle historic data Storing the historic data for this report is not enabled by default Check the Save Report option to enable storing the historic data 4 3 12 Permissions On the Permissions tab of a Report Definition the permissions can be changed GV Note WD By default each report definition has the dit_report_definition_acl ACL unless the Report Category has a different ACL which means Users with the report_user role can see the report definition and can generate reports Users with the report_builder role also can edit the report definition Users with the report_administrator role also can delete the report definition 4 4 Automatically Removing Old Reports Generated reports can be automatically deleted by setting the attributes Remove Reports after Number of Versions and or Remove Reports after Number of Days on the report definition The Remove Reports after Number of Versions option removes the oldest versions of the object if the number of versions exceed the specified number 0 means do not remove reports when a new version is added The Remove Reports after Number of Days options removes the versions of a report older than the specified number of days 0 means do no
45. g XSL style sheets For example reports can be presented in PDF HTML text file Microsoft Excel spread sheet or Microsoft Word format The euroscript Documentum Report Generator can also e mail the output file automatically In this case the recipient does not need to be a Documentum user and can even be someone from outside the organisation The euroscript Documentum Report Generator is integrated into the Documentum Webtop Documentum TaskSpace and Documentum Administrator client in line with the corporate philosophy of Documentum This enables end users to work in an environment that they are already familiar with Besides integration in these environments euroscript has also integrated the euroscript Documentum Report Generator in the popular Documentum D2 client and D2 4 0 Due to its full integration within the Documentum environment no additional components need to be installed on the end user s local machine eDRG eDRG Web Application Repository TaskSpace Webtop Administrator D2 Existing EMC Documentum Platform Application Server Content Server eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator As shown in the figure on the previous page the euroscript Documentum Report Generator components are locat
46. ge report presentations a Administration My Home Cabinet amp Cabinets Add Repository Report Schedules Manage report schedules This will display the Manage Historic Tables screen 47 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 are eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace gt euroscript THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Manage Historic Tables Historic Data Allowed Yes Disable Automatically Create Historic Tables Yes Disable G OG Page 1 of 4 items perpage 19 v Report Name HE Server Configuration ee Server Locations aE Repository Configuration FE Registered Tables C8 Number of Documents by Format ee Number of Documents by Object Type ae Number of Documents by Storage Area ee Number of Groups and Users Be ACL Summary Category Tables Valid Demo reports Repository Reports Repository Configuration Demo reports Repository Reports Repository Configuration Demo reports Repository Reports Repository Configuration Demo reports Repository Reports Registered Tables Demo reports Repository Unknown Click the Show Reports Documents Details button Demo reports Repository Yes Reports Documents Demo reports Repository Yes Reports Documents Demo reports Repository Reports Documents Demo reports Repository Reports Documents
47. h forms are accepted independent of the number of pattern letters Number for formatting if the number of pattern letters is the minimum number of digits and shorter numbers are zero padded to this amount For parsing the number of pattern letters is ignored unless it is needed to separate two adjacent fields Year for formatting if the number of pattern letters is 2 then the year is truncated to 2 digits Otherwise it is interpreted as a number 60 61 core eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum gt a e Uroscer i pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator For parsing if the number of pattern letters is more than 2 the year is interpreted literally regardless of the number of digits So using the pattern MM dd yyyy 01 11 12 parses to Jan 11 12 A D Examples The following examples show how date and time patterns are interpreted in the U S locale The given date and time are 2001 07 04 12 08 56 local time in the U S Pacific Time time zone Date and Time Pattern Result yvyyy MM dd G at HH mm ss z 2001 07 04 AD at 12 08 56 PDT Wead Jul 4 01 oS EEE MMM d yy Wed Jul 4 01 12 08 PM hh o clock a zzzz 12 o clock PM Pacific Daylight Time 0 08 PM PDT S 0 08 PM PDT Valid java number formats from Java documentation eee Symb
48. in the application for the file type of the report e g Adobe Acrobat Reader for PDF reports If the Report Definition needs more information to generate the report a new dialog will be displayed The following paragraphs describes this dialog 7 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 ona eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Run report Documents Created by a user E Run Report et these variables to run the report F P User name From Date Date Ex Hour Minute w Second Y Show History Data Show History Period From date Sep 12 2011 End Date Sep 12 2011 Select a stylesheet HTML fomat The Run Report dialog 3 2 1 Choosing a Stylesheet If a Report Definition has multiple output definitions stylesheets a dropdown box with the available stylesheets will be displayed Run report Documents Created by a user w Run Report Set these variables to run the report User name From Date Date E Show History Data Show History Period From date Sep 12 2011 Dropdown box with available stylesheets 3 2 2 Setting Variables A Report Definition can have optional or required and single or repeating variables You can must specify values for these variables when generating a report The following par
49. ion and following sections define the reports that will be created by this Report Definition gt Fill in the required attributes gt Click Finish The Report Definition is created Explanation of the attributes Attribute Description Limits Date Format The format that should be used for 32 characters should be displaying dates in filenames and a valid java date pattern results 2 The destinations for the reports See 1000 characters paragraph 4 3 1 The DQL queries to run See 2000 characters DQL Name paragraph 4 3 2 and paragraph 0 255 characters Split repeating values If selected the repeating values returned from the DQL queries will be split See paragraph 4 9 1 Email Body The text that is used in emails sent 2000 characters by the Report Generator This text can contain HTML Email Sender The from address used in emails 255 characters 15 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sa eDRG 3 6 User Guide Documentum e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator sent by the Report Generator Email Subject The subject used in emails sent by 255 characters the Report Generator Float Format The format that should be used for 32 characters should be displaying numbers in the results a valid java float pattern 4 Last
50. is means that the DQL queries only return objects that this user can see Default setting is Super User pe po Next Invocation The next time the schedule will be run This value is Date recalculated every time you save the schedule or the schedule is run Last Completion The last time the schedule was run Date Last Status The status message from the last run Report definitions The list of report definitions added to this schedule 44 61 re eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator To add Report Definitions to this schedule gt Click on the link Select Report Definition The following screen opens Name Name Name of Report Category a Documents Created by a us Documents Created by aus Documents Owned by me Documents Created by me Documents Owned by me My Tasks My Workflows gt Click OK gt Click Finish The Report Schedule is created 5 6 Testing Report Schedules 1 CAUTION Make sure that all changes are saved before you click the Test now button otherwise the old settings will be used To test a Report Schedule gt Navigate to the properties of the Report Schedule 45 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop
51. ish The Report Definition is created Explanation of the attributes Attribute Description Limits Presentation Format Specifies in which format the result will be saved this should correspond to the output of the XSL file This setting is always used regardless of the format that is set for this presentation file on the report definition Uses Saxon Stream Indicates if the presentation uses the Functions Saxon Stream function to access the XML result See paragraph 4 8 5 4 8 1 Including Other Presentation Files It is possible to use xsl include and xsl import to include other stylesheets into your own stylesheet Paths used for xsl include and xsl import can be an absolute path or a relative 34 61 owa eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator path to the style sheet that includes them A stylesheet in the repository can only include other stylesheets in the repository and not stylesheets that are on the OS file system A stylesheet on the OS file system can only include other stylesheets on the OS file system and not stylesheets that are in the repository 4 8 2 Creating Presentation Files for PDF Report PDF reports can be created by using XSL FO http www w3 org TR xsl fo section The stylesheet
52. ks to the objects in the reposito My Workflows Displays the workflow template name the instance name the user the currently active task was assigned to the timestamp of the currently active task and the workflow state for the workflows of the current user Document Transformation Service Displays the instance name the version and the host Documents Owned by me Documents Created by a user Instances name of the cts_instance_info objects in the Repository Document Transformation Service Displays the number of waiting documents and the Queue Summary oldest waiting item in the DTS queue Full Text Index Agents Displays the index agent name the index name whether or not the agent was forced inactive and whether or not the agent is active for the index agents in the Repository Full Text Index Queue Summary Displays the number of waiting documents the number of failed documents the number of warnings and the oldest waiting item in the full text index queue Displays the number of inbox items per user Tasks by Work Queue Displays the work queue category the work queue name the number of assigned tasks and the number of unassigned tasks for all work queues in the Repository Displays the workload per priority level Workload by Work Queue by Displays the work queue category the work queue Priority name the workload and the priority for all work queues in the Repository Full Report
53. n name gt lt historic_object gt lt historic_report gt lt historic_report reporttime date of last included historic data reportuser useraccount used for this report runtype 1 manual run 2 automatic run gt lt historic_object gt lt first column name type type gt value first row lt first column name gt lt last column name type type gt value first row lt last column name gt lt historic_object gt lt historic_object gt lt first column name type type gt value last row lt first column name gt lt last column name type type gt value last row lt last column name gt lt historic_object gt lt historic_report gt lt historic gt lt historic name name of last DQL query gt 38 61 sere eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator lt historic gt DQL Queries with historic data within the selected period are added to the XML like the first DQL query example DQL Queries with historic data disabled or no historic data within the selected period are added to the XML like the last DQL query example If historic data is globally disabled no lt historic gt tags will be added to the XML 4 10 eDRG usage Usage information abo
54. ng Agent job is run the log file is created in Temp jobs Delt Reporting Agent 57 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 osia eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Messages that can appear in the log file Message Description Schedule This is normally shown after an Report definition error occurred DQL Query It gives you more information on Presentation file where the error occurred Destination configuration file cannot be found ERROR Wrong license file version The license file is for a different version of the euroscript Documentum Report Generator ERROR Corrupt license file The license file is either damaged or the file specified in the configuration file is not a license file ERROR Current repository does not fall within the Your repository has more report license users then the current license file Too many users in repository allows ERROR Current repository does not fall within the The docbase id of your repository is license not licensed to use the euroscript Docbase ID not in licensed range Documentum Report Generator ERROR Current repository does not fall within the license The license for the euroscript Documentum Report Generator has Licensed period exceeded either expired or has not
55. ol Location Meaning O Number Digit S Digit zero shows as absent Number Decimal separator or monetary decimal separator Minus sign __ Number Grouping separator fhe aneneen be quoted in prefix or Suffix a boundary Sa eemeeee OO suffix suffix Prefix or Currency sign replaced by currency symbol If doubled replaced uooAd suffix by international currency symbol If present in a pattern the monetary decimal separator is used instead of the decimal separator Prefix or Used to quote special characters in a prefix or suffix for example suffix formats 123 to 123 To create a single quote itself use two in a row o clock 61 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Care
56. older in which you want to create the report presentation gt Choose the menu item File gt Choose the submenu item New gt Choose the submenu item Report Presentation The following screen is displayed Dialoogvenster van webpagina eax New Document Create 1 Create 2 Info 3 Permissions Dctm67 Delt Report Generator Presentations Demo reports Name Name of Report Presentation Type Report Presentation dit_report_presentation Format None Show options gt Fill in a name for the Report Definition 33 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 ore eDRG 3 6 User Guide Documentum e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator i NOTE The report presentation name is subject to the regular object_name attribute restrictions e g has a maximum length of 255 characters The attributes shown on the info tab define the Report Presentation Dialoogvenster van webpagina s New Document Info 1 Create 2 Info 3 Permissions Dctm67 Delt Report Generator Presentations Demo reports Name Name of Report Presentation Subject Presentation Format v Uses Saxon Stream Functions Show all properties 2 dicom digital displaywrite gt Fill in the required attributes gt Click Fin
57. on gt Click OK All changes are saved The Test button opens the DQL Test screen where the user can execute the DQL query and check the results The Select Types button is only available for object variables see paragraph 4 3 5 4 3 5 Object Variables Object Variables allow a user to select an object from the repository as value for a variable The Object Type of the object the user can select can be configured 23 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Care eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator To use these variables in the DQL query you can specify the attribute of the object you want to use between brackets For example if your variable is object and you want to use the attribute object_name you specify object object_name If you dont add an attribute the object id of the object will be used The Select Types button opens a screen where you can select the allowed object types for the Object variable All object types are allowed if you don t select an allowed Object Type i NOTE The allowed object types are not inherited For example if you only select dm_document then dm_document objects are allowed but not subtypes of dm_document Choose a type Dialoogvenster van webpagin ne http 172 25 180
58. port Definitions SH Demo reports The Report Definitions tree node contains the same Repository Reports Report Categories and Report Definitions as the Report L User Reports Generator tree node but here the Report Builder can i Ha Report Dresintetinne also create new Report Definitions The Report A EP Presentations tree node contains the presentation files E Cabinets for the report definitions 4 2 Copying Moving Report Categories Copying and moving Report Categories works in the same way as copying or moving other objects It is only possible to copy or move Report Categories to another report category from Report Administration Report Definitions 4 3 Creating Report Definitions Report definitions can be created by Report Builders from the following location Report Administration Report Definitions not from the Report Generator section To create a report definition Navigate to the report category in which you want to create the Report Definition Choose the menu item File Choose the submenu item New Choose the submenu item Report Definition The following screen is displayed Vvvv 13 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator g Properties
59. rdless of any destinations specified The Browse button lets the user select a stylesheet document in the repository as presentation file This button only works if Presentation Type is set to Repository If the Presentation Type is set to any other value this button will be disabled If you use the Browse button to select a presentation file of the object type Report Presentation see paragraph 4 8 the Presentation Type is automatically set correctly 29 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 ase eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 4 3 11 Historic Data i NOTE Historic data can be globally disabled If it is disabled you are still able to enable historic data on Report Definitions However these settings are ignored i NOTE If you enable historic data on a Report Definition you also need to make sure the Report Presentation can process the historic data Historic data can be enabled on Report Definitions This means that results from the queries are stored in the database and included in future reports Set the Save Report attribute to true for each DQL Select Query for which historic data Should be stored It is possible to enable this for only some of the DQL Select Queries of a Report Definition You can control how often hi
60. reation_date 1 r_creation_date must be in the previous week DRGINWEEK r_creation_date 1 2 r_creation_date must be in the previous week or in this week 27 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Come eDRG 3 6 User Guide Documentum Sw u r O S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator DRGINDAY This function tests if the specified attribute is in one or more days The function takes three arguments 1 the name of the attribute to check required 2 the day offset 0 today 1 yesterday 2 2 days ago etc Optional if not specified 0 is used today 3 the number of days to include from the offset Optional if not specified 1 is used Examples DRGINDAY r_creation_date r_creation_date must be in the current day DRGINDAY r_creation_date 1 r_creation_date must be in the previous day DRGINDAY r_creation_date 1 2 r_creation_date must be in the previous day or in this day 4 3 10 Presentations Presentations define the stylesheets that are used to create the reports Each Presentation consists of a presentation specification a Presentation Name a Presentation Type a Presentation Format and a Presentation Destination specification Only the attribute Presentation is displayed on the attributes screen These five linked attributes are edited together A des
61. red manually because its automatic creation is disabled and this table does not exist yet no reports with historic data enabled have previously been run The name of the table is edrg_history_info and must contain the following columns Column Type VARCHAR 32 INTEGER INTEGER Use the following DQL query to register this table REGISTER TABLE dm_dbo edrg_history_info edrg_report_definition_id string 16 edrg_report_identifier integer report_time date report_user string 32 run_type integer status integer 5 11 Getting Version and Environment Information A Report Administrator can get version and environment information about the euroscript Documentum Report Generator and the systems it is running on by pressing on the Get Version and Environment Info button on the Report Administration page This will gather the information and display the results a Dctm67 dmadmin File Edit View Toots Work Queue Monitor aa Inbox Work Queues Report Administration A Saved Searches 7 Subscriptions Get Version and Environment Info Manage Historic Tables Historic Tables a My Files Name Description ee Categories Report Definitions Manage report definitions and report categories m Report Generator Report Administration Report Presentations Manage report presentations i AEA Report Schedules Manage report schedules A My Home Cabinet e Cabinets Add Repository 50 61 o eDRG 3 6 User Guide Doc
62. reen These four linked attributes are edited together Internally the eDRG used a fifth field DQL History Table but this one is not displayed on any screen gt Click Edit The edit screen opens DOL Select Queries DOL Select query Name of Query SELECT r_object_id object_name FROM dm_document Name of Query SELECT r_object_id object_name FROM dm_document Test pat Configured variables Variable Variable Label Var Name Var Label Var Name 2 Var Label 2 Under the list of DQL Select Queries a list of available variables is displayed see paragraph 4 3 4 The value entered for DQL Name can be used in the XSL stylesheet to access the results of the query Attribute Description DQL Name The name for the DQL query DQL Select query A valid DQL select query Result Threshold The minimum number of results for this query default value 0 See paragraph 4 3 3 Save Report Indicates if the results from this query should be saved in 19 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sre eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator historic data tables See paragraph 0 i NOTE DQL Select Query must be a valid DQL select query If a query is entered that is not a select query e g update or
63. repistry dm_bof_repistry dmadmin Dctm67 Dctm67 Dctm67 Dctm67 GQ e ered ez Dctm http 1 Internet Beveiligde modus uitgeschakeld The object browser is shown when clicking the Add button 3 2 2 6 Boolean Variables You can use the checkbox to enter true or false for the Boolean Variable e g to include or exclude older versions Single Boolean Single Boolean Variable There are no repeating Boolean Variables 3 2 3 Including Historic Data If a Report Definition is enabled to store and process historic data you can choose to include it in the report you are generating There are 2 options you can set for the historic data 11 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 Ce eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Run report Documents Created by a user Set these vaniables to run the report User name ris From Date Date cesta Minute wv Second v Show History Data Show History Period From date Sepiz 2011 E 14 End Date Sep 12 2011 E 14 The first checkbox Run Report is used to indicate if the queries that are set on this Report Definition should run or not If the checkbox is not checked you will only get historic data If the checkbox is checked you will also get the current data The second ch
64. riables 4 3 9 Special DQL Functions The euroscript Documentum Report Generator recognizes some additional functions in DQL queries that are not available in normal DQL The functions are case sensitive and should be written in all capitals TIP in many situations eDRG DQL functions can be nested DRGIF This function works like an if then else construction The else part is optional so the function takes either two or three arguments 1 the name of the eDRG variable to check required supported values are true and false for boolean variables or an empty string false and any other string true for other variable types the literal value false for non boolean variables also resolves to false 2 the string to return if the first parameter is true 3 the string to return if the first parameter is false Optional if not present the else part resolves to an empty string 26 61 ase eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum lt u r O S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Examples DRGIF somevar string1 DRGIF somevar string1 string2 The string parameters have no delimiters they contain all characters between commas and braces They are not trimmed meaning that you could pass one or more spaces if you wanted to eDRG variables nested inside st
65. ring parameters are resolved i NOTE If you want to use commas inside string parameters you must escape them by specifying two commas i NOTE If you use variables inside a DRGIF function the enter value for the variable cannot contain a single comma They too need two commas DRGINMONTH This function tests if the specified attribute is in one or more months The function takes three arguments 1 the name of the attribute to check required 2 the month offset 0 this month 1 previous month 2 2 months ago etc Optional if not specified 0 is used current month 3 the number of months to include from the offset Optional if not specified 1 is used Examples DRGINMONTH r_creation_date r_creation_date must be in the current month DRGINMONTH r_creation_date 1 r_creation_date must be in the previous month DRGINMONTH r_creation_date 1 2 r_creation_date must be in the previous month or in this month DRGINWEEK This function tests if the specified attribute is in one or more weeks The function takes three arguments 1 the name of the attribute to check required 2 the week offset 0 this week 1 previous week 2 2 week ago etc Optional if not specified 0 is used current week 3 the number of weeks to include from the offset Optional if not specified 1 is used Examples DRGINWEEK r_creation_date r_creation_date must be in the current week DRGINWEEK r_c
66. s not empty all Report Categories and Report Definitions in the Report Category will be deleted as well 5 4 Deleting Report Definitions 1 CAUTION Ensure that the Report Definition is not used in a report schedule before you delete it Report Definitions can be deleted gt Navigate to Report Administration Report Definitions gt Select the Report Definition that you want to delete gt Choose menu item File gt Choose submenu item Delete 42 61 Care eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 5 5 Creating Report Schedules Report Schedules can be created by Report Administrators from the following section Report Administration Report Schedules A Report Generator Hea Report Administration 3 Report Definitions Report Presentations h Report Schedules To create a Report Schedule Navigate to Report Administration Report Schedules Choose menu item File Choose submenu item New Choose submenu item Report Schedule The following screen opens Vvvv ds Dialoogvenster van webpagina x New Schedule Definition Create Name Name of Report Schedule Show options P Fillin a name for the Report Schedule and click Next The following screen opens i
67. sages like this mean that the http xml apache org xslt java java util Date new stylesheet uses Xalan specific functions while the Saxon XSLT processor is installed The historic info table edrg_history_info does not Some historic data tables don t exist exist and creating it is not allowed or are incorrect and automatic creation is disabled Historic data tables for this report definition don t exist and creating it is not allowed Some queries on this report have the save result This is only a warning The report option enabled but saving history data has been definition has save reports enabled disabled for this repository but the historic data option is globally disabled The report is generated but the results are not stored and no historic data is included A request for a new or updated license file should be directed to euroscript by submission of a request form The license file will be sent by e mail 7 5 ACL s A The euroscript Documentum Report Generator uses six permission sets W Description of the permission sets ACL Description files related to the euroscript Documentum Report Generator Reporting Configuration cabinet This ACL is placed on the new report categories and report definitions by default unless the parent category has a different ACL in which case the different ACL is used This ACL is placed on all new report schedules created by the euroscript Documentum Report Generator
68. storic data is stored e g at most once a week by setting the below attributes on the Report Definition Attribute Description Values Save Run Mode This attribute controls if historic is Automatic stored for only automatic runs Manually schedule only manual runs or Automatic and Manually both Save Report Interval These attributes determine the Save Report Mode minimum time required between 2 Minutes saved reports E g if this is set to 1 Hours hour and a report is saved at Days 13 00 00 then all reports generated Weeks between 13 00 00 and 14 00 00 will Months not be stored Years You can also control how long the historic data is stored by setting the following attributes on the Report Definition A job runs periodically to remove the expired data Attribute Description Values Retention Interval These attributes determine the Retention Mode maximum time reports will be kept Days in the database Weeks Months Years 30 61 sore eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum lt u r O S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Use the last three attributes to determine the default settings for including historic data in a report Attribute Description Values penser e checked These attributes determine the Interval default period o
69. strator This role is used by the euroscript Documentum Report Generator for users that are report administrators which are allowed to manage report schedules and manage report structure Functionality for each role Report User Report Builder Report Administrator Y Show reports history Create report from Objects Create report definitions Copy move report definitions Copy move report categories 5 61 www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 sya eDRG 3 6 User Guide Documentum Sw u r O S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator mema y e g a g ceert fe omero ef Dette repr esenatns peenes e y o Terons O e o o peert e Cesereporsmeaies e o e a Tearen neons e o e a Gonfoue Dek Repon raen e oo 1 If the user is a member of the admingroup NINN NNS 2 If the user has access to Documentum Administrator and permissions to configure jobs i NOTE These functionalities are available as long as the objects have their default permission set If the permissions are changed some functions might no longer be available 2 2 Reports Report objects are the reports generated by either a schedule or a manual request These objects can be stored anywhere in the repository and can be used as any other document 2 3 Report Definitions Report Definitions are us
70. t remove reports when a new version is added 31 61 eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Limitations for this function Automatically removing reports only works on reports that are stored in the repository Automatically removing reports only works if Save as Version is selected Automatically removing reports only works on the current report name E g if the report name is changed on the report definition the reports generated with the old name will not be removed If two report definitions both use the same destination and report name for the generated reports reports generated by both Report Definitions count towards the total number of versions 4 5 Getting the XML File 1 CAUTION Make sure that all changes are saved before you click the Show XML Preview button otherwise the old settings will be used Report Builders have an additional button on the properties page of report definitions This button can be used to get the XML file that is processed by the style sheet This XML file can then be used to test the stylesheets without having to import it and run the report definition every time The generated XML file is placed in the user s home cabinet and automatically opened 4 6
71. tination specification allows selection of one or more previously defined destinations i NOTE You must have created at least 1 destination before you can create presentations gt Click Edit The edit screen opens 28 61 mae eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum s e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator Presentation Presentation Name jag Presentation Format Delt Report HTML Output Repository w html Generator Presentations General Presentation xsl Browse Destination 0 Repository Temp Presentation is the full location and name of the XSL presentation file Presentation Name is the name of the presentation that will be shown to the user generating the report if multiple presentations are specified for this report definition Presentation Type specifies if the presentation file is on the file system OS or in the repository folder structure Presentation Format specifies in which format the result will be saved this should correspond to the output of the XSL file Presentation Destination The numbers 0 to represent the available destinations The list of defined destinations is displayed at the bottom of the page i NOTE Manually generated reports are always placed in the user s home cabinet rega
72. ting Agent Arguments Edit configuration_file Delt Report Generator Delt Reporting Agent Configuration xml M Pass standard arguments To change the job settings for the Delt Report Generator Login to Documentum Administrator gt Navigate to Administration Job Management Jobs gt Locate the Delt Reporting Agent job gt Click the link Select Method on the Method tab gt Specify the arguments Pass standard arguments must always be checked There is one additional custom argument configuration_file for this job This parameter must be specified on a single line It should point to the full location in the repository of the configuration file for the job The default location for the configuration file Delt Reporting Agent Configuration xml is Delt Reporting Configuration Example configuration_file Delt Reporting Configuration Delt Reporting Agent Configuration xml 56 61 sore eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com eDRG 3 6 User Guide Documentum e u ro S C rl pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator The configuration file contains the following settings Setting Description Default value license_file The full location to the license file on the file eDRG system Cabinet eDRG lic ense language The language used for messages in the log files En The
73. trator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator If the Variable Type is set to Object then this field lists the allowed object types to add to this variable This field is ignored for all other variable types Repeating If selected the user can specify multiple values for this variable This option is not available for Date or Boolean variables See paragraph 4 3 6 Mandatory If selected then the user has to specify a value for this variable See paragraph 4 3 7 There is no required syntax for the variables but it is recommended to use special characters for example characters in front and at the end of the variable to make them easily recognizable Variable Type Description String The user can enter any value for this variable Date The user can choose a date from a date selector Integer The user can enter any positive integer value for this value Choice List The user gets a dropdown list from which it can choose the value The dropdown list is filled with the values from the DQL query specified in the Variable Query field Object The user can select an object in the repository from an object selector See paragraph 4 3 5 Boolean The user can check a checkbox Variables Variable Default Value Variable Query select user_name from dm_user where r_is_group false Variables Screen To use a variable in a DQL query you just insert the name
74. um Administrator Webtop amp TaskSpace 01 May 2013 oua eDRG 3 6 User Guide Documentum Sw e U ro S C ri pt Administrator Webtop amp TaskSpace THE WORLD OF DOCUMENTS euroscript Documentum Report Generator 1 Product Description With the euroscript Documentum Report Generator end users can request reports from predefined report definitions They can see the reports displayed on their computer screen or receive reports automatically in their e mail or at a specified location inside or outside the Documentum repository The preferred format can be chosen by the end user without the end user needing any knowledge about DQL HTML or XSL The euroscript Documentum Report Generator categorizes functionalities according to the user s role in the report generator There are 3 predefined roles Users in the Report User role which supplies predefined reports from the system require no knowledge of either DQL or style sheets Users in the Report Administrator role can schedule reports so that they are generated automatically at a predefined time and location Users in the Report Builder role can define new report specifications by configuring the DQL statements and they can identify and compose the desired style sheets The euroscript Documentum Report Generator can be accessed by anyone who has been given one of these default roles The euroscript Documentum Report Generator can produce output in any format that can be generated usin
75. umentum Administrator Webtop amp TaskSpace 01 May 2013 www euroscript com gt euroscript THE WORLD OF DOCUMENTS A result will look like this Content Server Information Content Server Version Delt Report Generator DocApp Version Java Method Server Information DFC Version Java Version Java Total Memory Java Free Memory Operating System Architecture Method Server runs as XSLT Transformer FOP Version Batik Version Delt Report Generator Methods Version TBO Modules TBO module for dit_report_definition TBO module for dit_report_category TBO module for dit_report_schedule License Information License ID Valid repositories Repository ID 1 16777215 Current repository 1 Activation date mm dd yyyy Expiration date mm dd yyyy Webapplication Information DFC Version Java Version Java Total Memory Java Free Memory www euroscript com eDRG 3 6 User Guide Documentum Administrator Webtop amp TaskSpace euroscript Documentum Report Generator 6 7 0000 0217 Win32 Oracle 3 0 6 7 0000 0213 Sun Microsystems Inc 1 6 0_17 265486336 90891304 Windows Server 2008 6 0 x86 dmadmin Xalan Java 2 7 0 0 95 1 7 3 0 nl delt ReportGenerator TBO DlItReportDefinition Version 3 0 nl delt ReportGenerator TBO DitReportCategory Version 3 0 nl delt ReportGenerator TBO DitReportSchedule Version 3 0 Maximum User Count 2147483647 1 01 01 2011
76. ut all the generated reports is stored within the repository and can be queried with DQL Usage information about schedules is stored in the type edrg_usage_schedule Attribute Type Description report_schedule_id ID The object ID of the schedule that was executed start_date Time The start date of the schedule duration Integer duration of the schedule in milliseconds Usage information about report definitions is stored in the type edrg_usage_report Attribute Type Description report_definition_id ID The object ID of the report definition that was executed run_user String The user that started the report start_date Time The start date of the report definition duration Integer duration of the report in milliseconds run_type Integer 1 manual report 2 scheduled report 3 test report by report builder schedule_usage_id ID object ID of the edrg_usage_schedule object if this report was part of a scheduled run variable_name Repeating string List of variables of the report variable_value Repeating string List of variable values of the report corresponds with the items in variable_name historic_from Time The from date selected for historic information or null for no historic data historic_to Time The to date selected for historic information or null for no historic data query_duration Repeating Integer For each DQL Select query in

eDRG 3.6 User Guide Documentum Administrator

Contents

Download Pdf Manuals

Related Search

Related Contents