REPORTING Copyright Framework Private Equity Investment Data Management Ltd

Transcription

1 REPORTING Copyright Framework Private Equity Investment Data Management Ltd

2 Table of Contents Standard Reports... 3 Standard Report Pack... 4 General Data Protection and Framework... 7 Partner Bank Account Report...14 Audit User and Roles...17 CSV Reports...19 CSV Report...20 Data Preparation Reports...26 Data Preparation Report...27 Task Runner and Report Jobs...32 Task Runner...33 Report Job...40

3 Standard Reports Page 3

4 Standard Report Pack A Standard Report Pack is included in the Framework Release Package. The Standard Report Pack contains XML files that contain various reports in them. The reports within each pack are shown below. Note that each pack is imported independently. Refer to the Export Import Tool article for details about how to import a report into the Framework application. Page 4

5 Page 5

6 Page 6

7 General Data Protection and Framework A new General Data Protection and Regulation (GDPR) Report Pack is now available as part of Framework s Standard Report Pack. These reports help identify where data for an individual (Contact and/or Executive) is held within the standard Framework application. The Report Pack includes the below three reports. 1. GDPR Reference Report This report details areas in the application where there are references to Contact/Executive data. The report can be run for either Contact or Executive. Refer to the GDPR Reference Report section below for more detail. 2. GDPR Transparency Report (Contact) This Transparency Report provides relevant Contact information held on a Contact Record within Framework. Refer to the GDPR Contact Transparency Report section below for more detail. 3. GDPR Transparency Report (Executive) This Transparency Report provides relevant Executive information held on an Executive Record within Framework. Refer to GDPR Executive Transparency Report section below for more detail. GDPR Reference Report This report identifies and lists areas in the application where there are references to Contact and/or Executive data. This is a generic report. The report retrieves data stored within the following areas: Reports User Data Sheets User Lists and User Filters Report Parameters After the import of the Report Pack, the Reference Report display as shown in the below screen print. Page 7

8 Note: Refer to the Technical Installation Instructions section below for instructions on the import procedure. The report can be executed to return either: Contact Reference data Executive Reference data Report Content/Detail Below is a sample extract of the Contact Reference Report. Page 8

9 GDPR Contact Transparency Report This report displays relevant contact data within a structured format. In the Framework application, Contact Record stores all the static data related to contacts. This report displays contact specific data and details instances were a contact was an recipient under Investor Communications. Report Parameters Listed below are the report parameters. Contact: This is a mandatory field and the only selectable field for this report. This dropdown field lists all contact records within the Framework application. Executive: This is a read-only field. Selecting a Contact displays the linked Executive in this field. The primary purpose of this parameter is it to distinguish between two contacts if they have the same name. Employer: This is a read-only and non-mandatory field. It displays the employer of the contacts and may appear blank if an employer has not been added to the contact. Status: This is a read-only field that displays the status of the Contact, i.e., either Active or Suspended. Page 9

10 Report Content/Detail Listed below are the details of the Contact Report. Personal Information: Full name, Job title, Status (Active/Suspended), and particulars for contact records, details related to when the contact was created in the system and last modified display in this section. Default Address: When an address is added for the selected contact and tagged as default, the address displays in this field. Additional Addresses: Details of any additional addresses added for the selected contact displays in this field. Contact Information: Communication types recorded for the individual, i.e., , telephone, fax, and website displays in this field. Framework Relationships: List of all relationships the contact has within the application displays in this field. Activity References: Activity inclusions (details of the 5 most recent activities) displays in this field. Mailing Recipient Inclusions: A list of where the contact is selected as a mailing recipient under Investor Communications and the circulation lists where the contact is included displays in this field. Note: Where no data is a returned, an appropriate message displays. Page 10

11 Below is a sample extract of the Contact Transparency Report. GDPR Executive Transparency Report This report displays the relevant Executive data within a structured format. The static data held for an Executive is primarily stored on the Executive record within the Framework system. Report Parameters Listed below are the report parameters. Executive: This is a mandatory field. On selection of the Executive from dropdown list, the status field is populated. Status: This is a read-only field. It displays the status of the Executive, i.e., Active or Suspended. Page 11

12 Report Content/Detail Listed below are the details of the Executive Report. Personal Information: Full name, Job title, and Status (Active/Suspended) display in this section. Default Address: Where an address is added for the selected Executive and tagged as default, the address displays in this field. Additional Addresses: Detail of any additional addresses added for the selected Executive displays in this field. Contact Information: Communication types recorded for the individual i.e., , telephone, fax, and website displays in this field. Framework Relationships: List of all relationships the Executive has within the application displays in this field. Activity References: Activity inclusions (details of the 5 most recent activities) displays in this field. Note: Where no data is a returned, an appropriate message displays. Below is a sample extract of the Executive Transparency Report. Page 12

13 Technical Installation Instructions The GDPR report pack is delivered as a single XML file. The file contains all the queries, reports, and parameter views required for the execution of the reports. Please refer to the Export Import Tool article for details about how to import a XML into the application. Page 13

14 Partner Bank Account Report The Partner Bank Account Excel Report provides a list of fund partners and their bank account details that are linked to each circulation list. Running the report The report can be accessed under Report Groups > Standard Reports > Partner Bank Account. Parameters as seen under Fund / Partner / Circulation List need to be selected. Leaving any of the parameters blank selects All. The report can be run and results displayed by clicking on the green Go icon near the top of the screen. Report Output The Excel sheet opens and displays the details of partners and the circulation lists. Page 14

15 Page 15

16 Page 16

17 Audit User and Roles A standard report pack is delivered with the Framework release package. These reports are delivered as XML files and can be imported using the Import/Export tool option under Tools business object in the Admin role. After import, these standard reports can be used to create various reports according to the requirement. New reports have been included to the Audit.xml file. The table below lists the reports and gives a brief description about the reports. Report Name Active User Roles Active User Details UserRoles Business Object Permissions UserRoles Tree Content Description List of all active users role assignments Listof all active users (excluding Roles Assignment and Linked Executives) Listof user role business object permissions UserRole Tree Object Description Refer to the Export Import Tool articles for details on how to import the report into the application. Once imported, the reports are imported into the application and added to the V11 Audit Report Group. Page 17

18 Page 18

19 CSV Reports Page 19

20 CSV Report Framework can generate reports in various formats. One such format is CSV. CSV is a common file format used in financial services on regular daily basis. It handles data better than most other formats. Once information is stored as a CSV file, it is easy to import into other applications such as Microsoft Excel. The CSV report works similar to other reports i.e., it requires a query and parameters, but will not have any layout information, as the data is output as a comma separated file. CSV reports have the option Include Header Row. If this option is selected, the output CSV file will have the header row with field names displayed. Create a CSV Report In the Admin Role, select a Report Group in the menu tree and click the CSV icon to create a new CSV report. The option is also avialable from right click on the Report Group. Expand the Report Group and select the new report created. Type the name and description for the report in the Name and Description fields. Page 20

21 Select the report group, parameter, and query from the Report Group, Parameters View, and Query dropdown list fields. The Parameters View dropdown contains a list of all User Data Sheets stored under the Report Parameter group. The Query dropdown contains a list of all published Framework Analyser Queries. Check the Tick box at the top of the screen to include a header row in the report. If this option is selected, the output CSV file will have the header row with the field names in the selected Query displayed. If a green play icon is displayed at the top of the screen the report is displayed and can be run from the Report List Viewer in the Report Group. Page 21

22 Click the green play icon to hide the report from the Report List Viewer. A red stop icon replaces the green play icon. Click the Save icon to save the report. Page 22

23 Run the Report For a report to be runnable, the green play icon should display at the top of the report screen. Select a report group from the menu tree. A list of all runnable reports is displayed under the Report List Viewer. Select the required report. The Parameters tab populates according to the Parameters View selected while creating the report. Page 23

24 Ensure the Export to CSV box is checked before running the report. Complete the required fields and click the Run Report icon to export the report as CSV file. Page 24

25 A Save File dialogue will open,, name and save the file as required.. Page 25

26 Data Preparation Reports Page 26

27 Data Preparation Report This is a reporting mechanism for advanced users. The Data Preparation report works in a similar way to other reports i.e., it requires a query and parameters, but doesn t have any viewable output. The report instead creates temporary tables that can be used as reference points for subsequent reports. Create a Data Preparation Report In the Admin Role, select a Report Group in the menu tree and click the New Data Prep Report icon to create a new Data Preparation Report. Expand the Report Group and select the new report created. Type the name and description for the report in the Name and Description fields. Select the report group, parameter, and query from the Report Group, Parameters View, and Query dropdown list fields. The Parameters View dropdown contains a list of all User Data Sheets stored under the Report Parameter group. Page 27

28 The Query dropdown contains a list of all published Framework Analyser Queries. If a green play icon is displayed at the top of the screen the report is displayed and can be run from the Report List Viewer in the Report Group. Page 28

29 Click the green play icon to hide the report from the Report List Viewer. A red stop icon replaces the green play icon. Click the Save icon to save the report. Run the Report For a report to be runnable, the green play icon should display at the top of the report screen. Select a report group from the menu tree. A list of all runnable reports is displayed under the Report List Viewer. Page 29

30 Select the required report. The Parameters tab populates according to the Parameters View selected while creating the report. Complete the required fields and click the Run Report icon to run the report. Page 30

31 Page 31

32 Task Runner and Report Jobs Page 32

33 Task Runner Introduction Task Runner performs scheduled execution of Framework Report Jobs or miscellaneous tasks setup as External Tasks in the Admin role. Install Task Runner Follow the below steps to install the Task Runner on your system. Navigate to the Task Runner Service folder in the release package. Open the folder and run the Task Runner Setup file. Page 33

34 Follow the steps on screen to install the Task Runner to the desired location. Page 34

35 Page 35

36 Configure Task Runner After installing the Task Runner to the desired location. Note: The task runner configuration screen is the same as that of the transaction server configuration screen. However, not all fields are relevant for task runner configuration. Note: Unlike for the Transaction Server, the SQL server name is the name of the instance where the database is stored and not the name given to the ODBC connection. Follow the below steps to configure the Task Runner. Navigate to the folder where the Task Runner is installed and navigate to the Configure Task Runner Service shortcut. Page 36

37 Double click the Configure Task Runner Service shortcut. The Task Runner Service - Login Configure Editor screen displays in a pop out window. Task runner us supplied with one profile (Default profile). Additional profiles can be created as required. All profiles (Default or created) require configuration. The screen has set of icons at the top of the screen. The below screen print shows the various icons available. Page 37

38 The below table lists the various fields available on the screen and gives a brief description about them. Field Name Description Name of the application for which the configuration is being created Parameters Folder Executable Profiles Windows User The name of the launch file (.exe file) to be run Name of the profile selected Windows user name Windows Group Web Service Name SQL Server Name SQL Login SQL Password Name of the SQL server where the database is stored. SQL login user name SQL login password Page 38

39 Field Database Name Description Name of the database Windows domain User Name User Password The Framework application user name The Framework application password Visible Read-only Login Automatically Allow Any Windows User Require Password Re-entry Complete the details as required and click the Save configuration file Icon. Page 39

40 Report Job Introduction Reports jobs can be setup, configured, and either scheduled or run ad-hoc from the Report Job business object in the Admin role. Report jobs can be used to schedule and run single standalone reports in any of the below listed formats. Excel Spreadsheet (XLS) Image file (TIFF) Portable document format (PDF) Rich text file (RTF) Text file (TXT) Web page (HTML) Report Jobs can be used to schedule and run multiple reports as part of a single job. It is possible to add multiple excel reports to a single Excel workbook. The individual reports would then appear on different tabs as part of the workbook. Create Report Job A new report job can either be created by Clicking on Report Jobs and clicking the Create New Report Job icon at the top of the screen. Page 40

41 Or by right clicking on Report Jobs and selecting the Create New Report Job option from pop out menu. A new Report Job is created. Page 41

42 The report job screen has two tabs Report Job Schedule Below are the icons at the top of the screen. The icons and their functionality are listed below in the order they appear. Publish the Report Job making it available to other users Page 42

43 Add individual Reports to the Job Remove individual Reports from the Job Change the order of the Report tabs by moving the current report to the left Change the order of the Report tabs by moving the current report to the right Import Excel Templates Export Excel Templates The Report Job Screen The report job tab contains the below two panels. Report Job Report Name The tables below list the fields seen within the two panels and their purpose. Report Job panel Field Name Purpose Page 43

44 Report Name Master Template Output Path Key in a name for the report job. The name entered here is the name for the Report Job and will appear in the menu tree. Framework provides functionality to generate and export multiple Excel reports to a single Excel Workbook. In order to do this, a Master Template needs to be set up, see the Create the Master Template section for more details. This Master template is referenced for each report that is to be included in the Excel workbook. This field defines where any workbook generated using the Master template is to be saved. It is the same output path for all report jobs that reference the Master Template. Report Name panel Field Name Report Name Report Report Output Type Use Master Template Output Data Range Output Path Report Parameters Purpose The name entered here is the report name. Dropdown list box used to select the appropriate report. Dropdown list box used to select the format in which the report should be generated. If multiple reports need to be part of the Excel workbook, this option needs to be selected. This option is available only for Excel reports. This is defined when creating the Master Template. This is the cell in the Excel sheet from where the application begins to print the report. Only one output range can be defined per sheet in the master Excel template. The output path where the report will be saved. This option is used when the report is to be saved separately and not as part of an Excel Workbook. When the Report is being generated using the Master Template Output Path setting, this field is disabled and the Output path for each individual report should not be defined. Parameters that are required to generate the report. These parameters change depending on the report selected. Page 44

45 Note: It is possible for a report job to have reports that use the master template and reports that don t use the master template. Depending on the setup the required Excel templates should be imported, the output path specified, and the use Master Template option selected. Report Parameters Below is a list of parameters that are used to configure the Report Job. Report Dropdown list box used to select the required report. Report Output Type Active reports can have an output type defined from the Report Output Type dropdown. Page 45

46 The output format for Excel and CSV reports cannot be changed. Output Path Tags The output path accepts tags for any of the report parameters. These tags can be used to generate individual reports based on certain parameters. This option has to be used in conjunction with report parameter Cycle Values. For example, User Roles Tree Content reports can be generated for each individual user by using the Output Path Tag <<USERNAME>> in combination with the Cycle Values option in Report Parameters. See the Cycle Values section under the Parameter Values section for a more detailed example. The path is then updated by inserting the selected field. Page 46

47 Note: It is not possible to use the Output Path Tag when defining Master Template Output Path. These can be used only when defining individual output paths for each report. Parameter Values The report parameters linked to a report are displayed in the Report Name panel. These parameters change depending on the report selected and these parameters define the data used to generate the report. Click on the More option button to display the Parameter Value screen in a pop out window. Page 47

48 The Parameter Value window has the below listed options. Null Formula Value Cycle Values These options can be used to automate the generation of reports based on the selections made. For example, individual Audit Log reports can be generated for each individual user by using the Output Path Tag <<USERNAME>> in combination with the Cycle Values option in Report Parameters. Refer to the Output Path Tag section under Report parameters for more details on how to use the Output Path Tags. Refer to the Cycle Values section under the Parameter Values section for a more detailed example of the output. Null In the example below, the User Role Tree Content report is being generated for the user role Test User. Page 48

49 A single report is generated for all user created user roles. Page 49

50 Formula The value type Formula allows use of Framework functions. Values The value type Value displays a dropdown list box that allows single selections of values or displays a combo box that allows multiple selections of values. This depends on the type of report selected. Below is a screen print of how the Value option displays for the Fund parameter option for the Portfolio Summary report. Page 50

51 Below is a screen print of how the Value option displays for the User Role parameter option for the User Roles Tree Content report. In the example below, the User Role Tree Content report is being generated for the user role Training Role. Page 51

52 The report is generated for the selected user role. Page 52

53 Cycle Values The value type Cycle Values generates individual reports for all values available in the selected parameter when used in combination with a Useage tag. Refer to the Output Path Tags section for more details. Note: When Cycle Values is selected, the relevant tag has to be inserted in the output path. In the example below, the User Role Tree Content report is being generated. The tag <<USERROLE>> is used in the output and the {Cycled Values} option is used in the report parameter. Page 53

54 Separate reports are generated for all user created user roles. Create the Master Template The master template can be created by saving an Excel as an Excel Template (.XLTX). Follow the steps below to create an Excel template. Open an Excel sheet. Select a cell, click the Name box, and give the cell a name. This will be the Output Range used while configuring the report job. The output range serves as an indicator, indicating not only the sheet on which a report is to be generated but also the cell from where the report is to be printed. Page 54

55 Page 55

56 Add more sheets, as required, and define an Output Range per sheet. Note: Only one Output Range can be defined per sheet. Save the Excel workbook as a template (.XLTX). Page 56

57 Set up a Report Job with a Single Report Follow the steps below to set up a report job with a single report. Create a new report job and type a name for the report job in the Report Name field. Type a name in the Report Name field and select the required report using the Report Dropdown list box. Select the output format for the report from the Report Output Type dropdown list box. Note: This option is available only for active reports. Other reports have a fixed format for the output. Click the Browse button beside the Output Path field. The Edit Path screen displays in a popup window. Page 57

58 Browse to the folder location to which the Report Job results are to be saved and define a File name. Page 58

59 Use the Fields dropdown list box to insert the required tags, as necessary, into the file path. The Output path is updated. Page 59

60 Note: When generating a single report via a report job, the Use Master Template option and the Output Data Range fields are left blank. Output: Since the Null option was used as the report parameter, only one report containing all the information about all user roles is generated. Page 60

61 If a particular role was selected using the Value report parameter the report generated would contain details pertaining to that user role and if the Cycle Values option was used, individual reports would be generated for each user role. See the Output Path Tags section under Report parameters for more details on how to use the Output Path Tags and the Cycle Values section under the Parameter Values section for a more detailed example of the output. Set up Report Job with Multiple Reports One Excel Report and One Active Report each Exported Separately Create a Report Job and setup and configure a report with the desired parameters in the report job. To add another report to the report job, click the Add Report icon located in the menu bar at the top of the screen. Setup and configure the report using the desired parameters. Page 61

62 Each Report to be included in the Report Job is set up on its own tab. It is possible to have reports with different output formats as part of a report job. Output: For the GL Transaction List Report, since the <<COMPANY>> output path tag is used with the report parameter value Cycle Values, an individual GL Transaction List report is generated for each company. However, for the User Role Business Object Permission report, since the Null option was used as the report parameter, only one report containing all the information about all user roles is generated. Each report is generated in the specified output type. Page 62

63 Multiple Excel Reports all Exported to a Single Excel Workbook Note: Only Excel reports can be exported into the Master Template. Active reports cannot be exported into the master template using this feature, even if the output type is set to Excel. Follow the steps below to generate and export reports to a single Excel file. Set up the report job with the required reports and parameters. Navigate to one of the Excel reports and click the Import Excel Template icon. Page 63

64 Navigate to and select a master template using the pop up window. Click the Browse icon beside the Master Template Output Path field and define the location for the report in the pop up window. Page 64

65 It is not possible to insert tags when using the master template. Select the Use Master Template option and define an Output Data Range, identifying the target tab and cell. Page 65

66 Navigate to all Excel reports in the report job and select the Use Master Template option and define an Output Data Range, identifying the target tab and cell. The Output Data Range has to be different for each Excel report. This has to be done for all Excel reports that are to be exported using the master template. Output: A single Excel workbook containing both reports is generated. The reports are generated on separate sheets in the workbook. Page 66

67 Multiple Excel Reports all Exported to a Single Excel Workbook and a one Active Report Exported Separately Note: It is possible to have reports with different output formats as part of a report job, even when using a master template for the Excel reports. Note: Only Excel reports can be exported into the Master Template. Active reports cannot be exported into the master template using this feature, even if the output type is set to Excel. Follow the steps below to generate and export reports to a single Excel file. Set up the report job with the required reports and parameters. Navigate to one of the Excel report and click the Import Excel Template icon. Page 67

68 Navigate to and select a master template using the pop up window. Click the Browse icon beside the Master Template Output Path field and define the location for the report in the pop up window. Page 68

69 It is not possible to insert tags when using the master template. Select the Use Master Template option and define an Output Data Range, identifying the target tab and cell. Page 69

70 Navigate to all Excel reports in the report job and check the Use Master Template option and define an Output Data Range, identifying the target tab and cell. The Output Data Range has to be different for each Excel report. This has to be done for all Excel reports that are to be exported using the master template. When using the master template and the master template output path, the output path field should be left blank. However, if other reports, like an active report, is part of the report job, the output path has to be defined for these reports. The Use Master Template option is not available for active reports. Page 70

71 Output: A single Excel workbook containing both the User Roles and the Active User Roles reports is generated. The reports are generated on separate sheets in the workbook. For the GL Transaction List Report, since the <<COMPANY>> output path tag is used with the report parameter value Cycle Values, an individual GL Transaction List report is generated for each company. Each report is generated in the specified output type. Page 71

72 Running a Report Job There are two way of running a report job, they can either be scheduled to run a specified time or time intervals or run immediately using the Run now as a remote task on server option. The task runner needs to be running for reports to be generated. Log into the task runner using the same credentials used to login to Framework. A user cannot generate reports via a task runner that was started using credentials of another user. Schedule After a report job is setup it can be scheduled to run as a task. This requires the Task Runner service to be running. Navigate to the schedule tab on a report job to schedule the report job. The Schedule sheet contains of the panels listed below. Task Schedule: Used to define when and how often the report job should be run. Task History: Displays the history of the report job and contains details like when the report job was run, and if the report was successfully generated or not. Page 72

73 The fields available for selection in the Task Schedule panel vary with selections made in the Occurs dropdown list box. Task Schedule Panel The table below lists the various options available in the Task Schedule panel and their functionality. Field Start Date Task Time Occurs Functionality The first day on which the Report Job is to be run. The time when the report is to be run. This is a 24 hour clock. Defines how often the report is to be run. The below listed options are available for selection. Once Minute Hours Days Page 73

74 Weeks Months Years Based on the selection made in this field, other options are displayed in the Task Schedule panel. Until Run as User An end date can be defined but if none is selected the Report Job will continue to run as specified until it is disabled (untick the start date) or deleted. When a Report Job is being created or maintained by a user, other than the Admin user, they may be able to specify that the Reports should be generated based on another user's data access rights. A user will be permitted to nominate another user if they have the necessary permissions. Task History Panel The table below lists the various options available in the Task History panel and their functionality. Field Run Date End date Log Functionality Displays the date the report job was started Displays the date the report job was completed Provides information on if the task was successful or not, etc. Run now as remote task on server This option can be used to run the Report Job on an ad-hoc basis. This can be done by right clicking on the report job and selecting Run now as remote task on server option from the pop out menu. Alternatively, select the report and click the Run now as remote task on server icon at the top of the screen. Page 74

75 Publish The Report Job can be published and it will become visible to other users with access to the Report Jobs functionality. Reports can be published using the Publish icon at the top of the screen. When a Report Job becomes Public it cannot be set back to private. Page 75

76 A report can only be published if the output path for the report is a common path that can be accessed by multiple users, like a share drive or folder. Refresh or Delete a Report Reports can be refreshed either by right clicking on the report and selecting the Reload option in the pop up list box or selecting the report job and clicking the Refresh icon at the top of the screen. Page 76

77 Reports can be deleted either by right clicking on the report and selecting the Delete option in the pop up list box or selecting the report job and clicking the Delete icon at the top of the screen. Page 77