Write-up on Delivery Options

sheshashila.bharadwaj@oracle.comDelivery options need to be specified by users as part of the extract definition. Delivery option parameters specify the output format, delivery method (email, ftp, etc), and other parameters required for integration with BI Publisher layer.

Diagram 1: Extract Definition Framework

How Delivery Options work The extracted data is archived into result tables and also stored as an XML output in the database. This XML output is transformed into formatted output (HTML, PDF, EFT, or XLS) and delivered (through email, fax, ftp, or print) depending upon the delivery options set in the extract definition.

Diagram 2: Delivery Options link in the Extract Definition Page

Delivery Option Parameters

Users will need to specify following parameters within Delivery Options:

ParametersDetails

Start Date

End Date

Delivery Option NameName of the Delivery Option. This is a Free Text field. Customers can choose an appropriate name. For example: Email to HR

Output TypeDelivery file output type i.e. PDF, XLS, XML, DOC, etc.

Report (See note-2)Path of the report created in the BI Publisher

Output NameName of the output file. This can be based on the requirement of consuming application.

Template (See note-1)BI publisher report layout name

Delivery Type (See note-3)Delivery Mode i.e. FTP, Email, Fax, etc.

Delivery mode can be Documents of Record as well. This enables Fusion to store the output in the employee Document of Records database. This allows employees to view online pay slips from documents of record

Bursting NodeIf the XML output needs to be split and delivered as separate files, for example individual pay-slips, then bursting node has be specified.

Please leave this field empty for a regular extract definition.

Note:

1. Template name can be a free text. In this example it is ReportLayout. This should be same as what is set-up in BI Publisher (See diagram-9 below).2. Report shall be the X path: /Custom//.xdo. This path should match with the directory structure of the report in the BI Publisher set-up.

Note: Please provide path after(below) Shared Folder location.3. Delivery option should be set to None, if users want to view the output directly from the view HCM Extract page, after the extract process gets completed

SHAPE \* MERGEFORMAT

SHAPE \* MERGEFORMAT

Diagram 3: Delivery Options parameters

Delivery Option Additional Details for Delivery Type

Based on the type of delivery type, users would be required to provide additional details. For example, if FTP is selected as the delivery type, then the Server details, Remote Directory and File Name would need to be specified.

Diagram 4: Additional Details required for delivery type FTP

Similarly for delivery type e-mail, mail address and attachment would be required. In case multiple e-mail addresses have to be specified, they should be separated by a comma, For example: hr@xyz.com,myname@xyz.com.

Diagram 5: Additional Details required for delivery type E-Mail

The delivery options details are mandatory, and need to be specified even if the user just wants an xml output.

Report Category

Report categories help to create combinations of various delivery options under a single run process or Report Category. This helps in delivering through a single run, multiple forms of output to multiple users for an extract definition.An Example:

Organization wants to extract HR Data and e-mail extracted data as a pdf report to HR, and FTP the same data in an EFT file to a 3rd party.To achieve this 2 delivery options are created, and grouped under a report category

Diagram 5: Report Category and grouping of delivery options

BI Publisher Setup

BI Publisher set-up is required to be done before setting up delivery options, as some of the set-up values in BI Publisher would be utilized in defining delivery options.

To access the BI Publisher, please use Reports and Analytics link from the navigator. Once Reports and Analytics page is accessible, browse through the catalog. On the catalog page, new report can be created (3-Step process) by using menu options indicated on diagram-7 below.

Diagram 6: Catalog link on the Reports and Analytics Page

Diagram 7: Navigation for creating a new report

While creating a new report, the application will prompt to provide details of report template and data-model. The existing standard data model (Available at this folder location: /Human Capital Management/Payroll/Data Models/globalReportsDataModel) should be used for all reports.

Diagram 8: Details of setup for creating a BI reportOnce the datamodel is selected, it will show up on the right top corner. The next step is to upload the BI Publisher report template file (the one that was created by using BIP Plug-in for MS Word by loading the XSD downloaded from the 'Export XSD' option of Extract Execution Tree of Manage Extract Definition,for additional details please refer to Creating BI publisher template section in FAQs).

To do this, click on the Upload icon under Upload or Generate Layout and fill in the following information:ParametersDetails

Layout NameFree text to identify the underlying report layout. This should be unique within a report

Template FileFile name of the RTF/ EFT template saved on the local machine - should be selected from the browse option

TypeSelect from the LoV

LocaleLanguage - Select from the LoV

Report NameUsers can specify their report name, Free Text

Report DescriptionOptional - A description for the report can be provided

Report Path (See note-1)/Custom//.xdo

Note:

1. Users can create their own folder under Custom or Shared folder they have access toDiagram 8: BI Publisher Report Path

Diagram 9: Details of setup for creating a BI report

Note: Once the above steps are completed, the BI report should be saved in /Shared Folders/Custom/Human Capital Management/ location (accessible to all logins). The report should not be saved under My Folders.After report is saved, manually schedule (refer FAQ-1) the report and see if output is delivered to destination. Once it is done, then only, please go ahead and configure delivery options else delivery options would fail.Frequently Asked Questions1. Manually Schedule a Report before going to Define Delivery options:

a) Click on More > Schedule

b) Provide sample Payroll Process/Flow Instance name which ran successfully.

c) Follow below steps to configure Email/SFTP

i) Click on Output tab,

ii) Un-check Use Busting Definition to Determine Output..iii) If required change layout/format and Add Destination choosing a Email/SFTP destinationd) Submit the process

e) To check if Email/SFTP is done successfully without any issues. Click on Report Edit > History and see if process succeeds without errors.

f) If process fails, drill down to get root cause of the issue and fix the BI Server setup configuration issue.

2. Configuring SFTP Server (Use Case):a) Ensure that the cloud sftp server is set up Link - https://stbeehive.oracle.com/teamcollab/wiki/PDIT+Oracle+Public+Cloud+%28OPC%29:PDIT+OPC+Docs+-+Multi-Tenant+SFTP+Operational+Documentb) BIP Destination is configured to above SFTP server and will require BI Admin privilege Link - http://docs.oracle.com/cd/E28271_01/fusionapps.1111/e26384/delivery_dests.htm#email_ftp

c) Once manual Scheduling works (using FAQ-1), configure Delivery options with correct server name fusion_ftp (not sftp.cloud.oracle.com)

3. Adding CSV Support for E-Text Template: By default, only Text output type is supported for E-Text template. To enable CSV/XML please follow below steps.

a) Go to bip sever, and Edit your Report.

b) Click on 'View a List' button in top right hand corner

c) In layout page, choose template in table, Click on output format and make sure CSV box is checked.

d) Save report, manually Schedule and see if CSV option is available in LOV4. Delivering XML output:

a) While creating a new report, the application will prompt to provide details of report template and data-model. The existing standard data model (Available at this folder location: /Human Capital Management/Payroll/Data Models/globalReportsDataModel) should be used for all reports.

b) Simply Save Report. Do not associate/upload any template.

c) In Delivery options provide valid Report path, Output Type as Data and Template leave template as blank.

5. Busting to different persons:

Changes need to be done from Extracts Side

For Email Busting

In the additional details of the Delivery Options the Key property should be assigned to Data Element which we considered to be unique value for each person (or assignment). For example in the extract with we tested Person Id is the unique value for each and every block

If we need to split and deliver all the individual reports to single person, hardcode E-Mail Address field with a specific email id (as shown in the above image).

If we need to delivery each report to different people we need to add one Data Element to the Extract which gives us the email ids of the persons to whom we need to mail respective reports.

Use that data element as E-Mail Address as shown in the below image. But currently there is a bug and the Busting SQL Query is not retrieving the E-Mail Address from the data element.

For Document OF Record Busting

For Documents of Record, the key additional attributes need to be specified are listed below. In the delivery options select Delivery Type as Documents of Record. In Additional Details, give some desired name as Document Name. The Key property should be assigned to Data Element which we considered to be unique value for each person (or assignment). For example in the extract with which we tested Person Id is the unique value for each and every block. Person ID should contain the X-Path of the Person Id data element in the extract. (currently this value should be x-path, but in future we can take from data element field) Document Type ID should contain the ID of a document. Since the customer doesnt have IDs with them we need to give a work around for this. The query to get Document Type ID is select document_type_id,document_type from fusion.hr_document_types_vl;

Changes on BIP Side

Need to create a new Data model for each and every extract since the parameters which need to be specified for the Busting Options comes from the extract created. (As discussed earlier we need to have a unique value, in this case Person ID)

The Busting option mainly relay on 3 parameters

Split By: Should contain the X-path of a data element which has unique value for each person (or assignment). In this case Person ID (/DATA_DS/G_1/G_2/FILE_FRAGMENT/Changes_Only_Demo/Employee_Details_Block/Employee_Basic_Details/Person_ID)

Delivery By: It is almost same as Split By parameter, (/DATA_DS/G_1/G_2/FILE_FRAGMENT/Changes_Only_Demo/Employee_Details_Block/Employee_Basic_Details/Person_ID)

Busting Query:

SELECT key key ,TEMPLATE,OUTPUT_FORMAT,OUTPUT_NAME,CALENDAR,'true' SAVE_OUTPUT,DEL_CHANNEL ,PARAMETER1,PARAMETER2,PARAMETER3,PARAMETER4 ,PARAMETER5,PARAMETER6 ,PARAMETER7 ,PARAMETER8 , PARAMETER9 ,PARAMETE10 , LOCALE,TIMEZONE

FROM FUSION.PAY_REP_DELIVERY_DTLS where payroll_action_id=:payrollActionId and ext_delivery_option_id=:deliveryOptionId6. Creating XSL Template Converting XML- another XML

You can use BI server to convert one XML to another XML by creating report using XSL Template.

Create a XSL transform and create the report by using XSL Template and choosing XSL file created.

Sample XML, XSL, Output XML are attached and requirement is to group related employees by payroll.

EMBED Package

EMBED Package 7. Creating BI publisher template

Export XSD option of Extract Execution Tree

Downloaded XSD can be loaded to BI publisher word-plug in using Load XML Schema option

Template can be created and saved by arranging the fields in required format.

_1424096731/Sample Input From Extracts.xml EDTI05 841 Extract Demo Testing 300101721619579 202 2013-03-04 300101721543159 2.0 300100003195395 300100004492329 SC02 300100003192225 300100004479294 OR01 300100003194015 300100004489553 OR02 300100003195395 300100004491542 PA02 300100003194015 300100004491818 SC01 300100003194015 300100004498853 UT01 300100003195395 300100004499333 UT02 300100003195395 300100004479043 OK02 300100003192225 300100004498575 TX01 300100003192225 300100004462090 KY01

_1424096732/group_xslformating.xsl

_1424096730/Sample Output.xml 300100003195395 300100004492329 SC02 300100004479294 OR01 300100004489553 OR02 300100004491542 PA02 300100004491818 SC01 300100004498853 UT01 300100004499333 UT02 300100004479043 OK02 300100004498575 TX01 300100004462090 KY01 300100003192225 300100004492329 SC02 300100004479294 OR01 300100004489553 OR02 300100004491542 PA02 300100004491818 SC01 300100004498853 UT01 300100004499333 UT02 300100004479043 OK02 300100004498575 TX01 300100004462090 KY01 300100003194015 300100004492329 SC02 300100004479294 OR01 300100004489553 OR02 300100004491542 PA02 300100004491818 SC01 300100004498853 UT01 300100004499333 UT02 300100004479043 OK02 300100004498575 TX01 300100004462090 KY01