This page (revision-22) was last changed on 26-Nov-2021 10:22 by kparrott

This page was created on 26-Nov-2021 10:22 by jmyers

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
22 26-Nov-2021 10:22 26 KB kparrott to previous
21 26-Nov-2021 10:22 26 KB kparrott to previous | to last

Page References

Incoming links Outgoing links
Training.Create_Winward_Report...nobody
Training.Create_Winward_Report

Version management

Difference between version and

At line 174 changed 30 lines
All High Line supplied Windward report templates are shipped in a single ZIP file. Most of the templates are stored in Rich Text Format [RTF], but there can be XLSX and DOCX as well. During the installation and configuration of the Oracle Application Server, a copy of these files would have been placed in the REPORTS folder under the HLAppResources directory used by each ePersonality instance.
Since most users will not have access to the application server, a copy of the RTF template will need to be downloaded to your client system for editing. We will upload this template each time it's needed for testing purposes. Once a final copy of the RTF template is ready, it can be moved into another directory that is used for custom reports. We will use the RENA.rtf file as our starting point and modify this.
Extract a copy of the file from High Line's ZIP file and rename it to RENAC.rtf.
After Windward's Auto Tag plug in has been installed, the license key entered and the report template has been placed on the client system, open the RTF file.
After opening, the first change that will be needed is to define the data source for this report.
From the Auto Tag menu, select Data/Data Sources.
In the dialog box that appears, select the XML data source listed and click edit.
If no data source is listed, simply click the add button.
Ensure the vendor field is XML (file or url) and edit the File/URL field to point to the fol¬lowing URL:
http://argo.highlinecorp.com/selfService_AS01/reportdatastructure?NAME=RENAC
Please note the URL shown above is an example only. You will need to alter this URL to point to your application server and Self Service instance.
This URL is another entry point into the Self Service component of High Line's ePersonality application. This URL simply provides the XML format of the data that will be provided to the Windward report engine when the specified function is run. Auto Tag requires a data structure to provide a list of item that can be added to the report from its Data Bin.
Before exiting the Data Sources Edit dialog, press the Test button in the lower left to ensure Auto Tag is able to communicate with the URL specified. If communication is not successful you will not be able to edit the report template correctly.
Once communication has been established pressing OK will return you to the Data Sources.
The list of items shown in the data sources dialog should now contains several table aliases that can be expanded.
If the EASD table is not listed edit the data source again and correct the URL.
If the URL is correct ensure the function has been saved correctly within the appli¬cation.
The EASD entry will include all the database columns associated to the P2K_HR_ASSIGNMENT_DETAILS table. Within this list of items is EAS_ID. Expanding this item will display all the columns associated to the P2K_HR_ASSIGNMENTS table. From this list we can continue to navigate up the data hierarchy to P2K_HR_EMPLOYMENTS and again to P2K_HR_IDENTITIES. Using this method of data navigation we can also branch out to other tables for department information, unit and group data, as well and the employee's personal information.
Many of the field tags added to the template file by High Line will be visible in the report template. However most will not produce any output in the actual report. The only tags that produce output when run are <OUT> tags. Simply placing the mouse over a tag should display a tool tip for that tag. Since many of the tags created in the RENA report are larger than the cell that has been defined to display the data, the template may not look like the final report. For example, the start of the <OUT> tags for the employee information is at the top of page three in the RTF file but will actually print at the top of page two.
To remove the Termination date and Status code, highlight the column label and the <OUT> tag that corresponds to these fields and press delete. Alternately you can place your cursor at the end of this line and simply back space to remove the tags and field labels.
Type a label for the new field we will be adding. In this example, we will label this Gender and then add the GENDER tag from the Auto Tag data bin. To add this tag you will need to expand the EASD table alias. This will display all the columns in the ASSIGNMENT DETAILS table. Expanding the EAS_ID item will display all the columns associated to ASSIGNMENTS. Expanding the EEM_ID item will display the EMPLOYMENT columns. Finally expanding the EID_ID item will display the columns in the IDENTITIES table, includ¬ing GENDER. Click and drag this item onto our report next to the label that was typed in earlier.
Save the report and connect to ePersonality as a user authorized to run RENA.
Once connected type RENA in the command window, or select it from the report drop down menu. Since this function was extended earlier in the IMFN screen, running RENA will actually run RENAC.
Fill in any parameters you like to limit the number of people included in the report and then go to the Report Options tab of the report parameter screen.
In this tag click the folder icon next to the 'Upload Template' line.
In the file upload dialog box that appears, navigate to the copy of the RENAC.rtf file you have altered and open it. This will place the file name into the Upload Template field.
Click the Launch button to run your report.
If there are no errors in the RTF file the report progress bar will display feedback as the report runs.
When your report completes, click on the Output link to display the PDF output. You can confirm that your template was using by scrolling down to any employee and confirming that both the Term and Status fields have been replaced by the employee's gender.
The next step is to alter the data that is presented to the new template for reporting. This is not controlled by either the template or Windward. Instead, altering this will need to be done within your ePersonality environment. Each report that has a subject table defined within its IMFN screen must have an entry in the IMLQ to build a report list. Since RENAC has the P2K_HR_ASSIGNMENT_DETAILS table defined for its subject table, there must be an entry within IMLQ with an LOV name of IMPV_RENAC. EP will look for an entry that starts with IMPV_ followed by the function name of the report. The Query Text defined in the IMLQ entry is a simple SQL select statement that will build a list of assignment detail ID's that are passed to our report. By altering this SQL statement we can change the quantity of data that will be processed by the report.
All High Line supplied Windward report templates are shipped in a single ZIP file. Most of the templates are stored in Rich Text Format [RTF], but there can be XLSX and DOCX as well. During the installation and configuration of the Oracle Application Server, a copy of these files would have been placed in the REPORTS folder under the HLAppResources directory used by each ePersonality instance.\\ \\
Since most users will not have access to the application server, a copy of the RTF template will need to be downloaded to your client system for editing. We will upload this template each time it's needed for testing purposes. Once a final copy of the RTF template is ready, it can be moved into another directory that is used for custom reports. We will use the RENA.rtf file as our starting point and modify this.\\ \\
;Step 1:Extract a copy of the file from High Line's ZIP file and rename it to RENAC.rtf.
;Step 2:After Windward's Auto Tag plug in has been installed, the license key entered and the report template has been placed on the client system, open the RTF file.
;Step 3:After opening, the first change that will be needed is to define the data source for this report.\\
*From the Auto Tag menu, select Data/Data Sources.
*In the dialog box that appears, select the XML data source listed and click edit.
*If no data source is listed, simply click the add button.
*Ensure the vendor field is XML (file or url) and edit the File/URL field to point to the following URL:[http://argo.highlinecorp.com/selfService_AS01/reportdatastructure?NAME=RENAC]\\%%information Please note the URL shown above is an example only. You will need to alter this URL to point to your application server and Self Service instance.%%\\This URL is another entry point into the Self Service component of High Line's ePersonality application. This URL simply provides the XML format of the data that will be provided to the Windward report engine when the specified function is run. Auto Tag requires a data structure to provide a list of item that can be added to the report from its Data Bin.
;Step 4:Before exiting the Data Sources Edit dialog, press the Test button in the lower left to ensure Auto Tag is able to communicate with the URL specified. If communication is not successful you will not be able to edit the report template correctly.
;Step 5:Once communication has been established pressing OK will return you to the Data Sources.\\ \\The list of items shown in the data sources dialog should now contains several table aliases that can be expanded.
*If the EASD table is not listed edit the data source again and correct the URL.
*If the URL is correct ensure the function has been saved correctly within the application.\\ \\The EASD entry will include all the database columns associated to the [P2K_HR_ASSIGNMENT_DETAILS] table. Within this list of items is [EAS_ID]. Expanding this item will display all the columns associated to the [P2K_HR_ASSIGNMENTS] table. From this list we can continue to navigate up the data hierarchy to [P2K_HR_EMPLOYMENTS] and again to [P2K_HR_IDENTITIES]. Using this method of data navigation we can also branch out to other tables for department information, unit and group data, as well and the employee's personal information.\\ \\Many of the field tags added to the template file by High Line will be visible in the report template. However most will not produce any output in the actual report. The only tags that produce output when run are <OUT> tags. Simply placing the mouse over a tag should display a tool tip for that tag. Since many of the tags created in the RENA report are larger than the cell that has been defined to display the data, the template may not look like the final report. For example, the start of the <OUT> tags for the employee information is at the top of page three in the RTF file but will actually print at the top of page two.
;Step 6:To remove the Termination date and Status code, highlight the column label and the <OUT> tag that corresponds to these fields and press delete. Alternately you can place your cursor at the end of this line and simply back space to remove the tags and field labels.
;Step 7:Type a label for the new field we will be adding. In this example, we will label this Gender and then add the GENDER tag from the Auto Tag data bin. To add this tag you will need to expand the EASD table alias. This will display all the columns in the ASSIGNMENT DETAILS table. Expanding the EAS_ID item will display all the columns associated to ASSIGNMENTS. Expanding the EEM_ID item will display the EMPLOYMENT columns. Finally expanding the EID_ID item will display the columns in the IDENTITIES table, includ¬ing GENDER. Click and drag this item onto our report next to the label that was typed in earlier.
;Step 8:Save the report and connect to ePersonality as a user authorized to run RENA.
*Once connected type RENA in the command window, or select it from the report drop down menu. Since this function was extended earlier in the IMFN screen, running RENA will actually run RENAC.
*Fill in any parameters you like to limit the number of people included in the report and then go to the Report Options tab of the report parameter screen.
*In this tag click the folder icon next to the 'Upload Template' line.
*In the file upload dialog box that appears, navigate to the copy of the RENAC.rtf file you have altered and open it. This will place the file name into the Upload Template field.
*Click the Launch button to run your report.\\ \\If there are no errors in the RTF file the report progress bar will display feedback as the report runs.
;Step 9:When your report completes, click on the Output link to display the PDF output. You can confirm that your template was using by scrolling down to any employee and confirming that both the Term and Status fields have been replaced by the employee's gender.\\ \\
The next step is to alter the data that is presented to the new template for reporting. This is not controlled by either the template or Windward. Instead, altering this will need to be done within your ePersonality environment. Each report that has a subject table defined within its [IMFN] screen must have an entry in the [IMLQ] to build a report list. Since [RENAC] has the P2K_HR_ASSIGNMENT_DETAILS table defined for its subject table, there must be an entry within [IMLQ] with an LOV name of [IMPV_RENAC]. EP will look for an entry that starts with IMPV_ followed by the function name of the report. The Query Text defined in the [IMLQ] entry is a simple SQL select statement that will build a list of assignment detail ID's that are passed to our report. By altering this SQL statement we can change the quantity of data that will be processed by the report.
This page (revision-22) was last changed on 26-Nov-2021 10:22 by kparrottTop