Anw: v1.0 - Issued to customer

2017-08-16T13:28:18Z

v1.0 - Issued to customer

← Older revision		Revision as of 15:28, 16 August 2017
Line 4:		Line 4:
	{{#vardefine:System\|''CALIDUS'' ePOD}}		{{#vardefine:System\|''CALIDUS'' ePOD}}
	{{#vardefine:Doc_Title\|POD DMS Export Images}}		{{#vardefine:Doc_Title\|POD DMS Export Images}}
	{{#vardefine:Version\|0.1}}		{{#vardefine:Version\|1.0}}
	{{#vardefine:Date\|~~15th~~ August 2017}}		{{#vardefine:Date\|16th August 2017}}
	{{#vardefine:Reference\|343616 SCR-ADD-1}}		{{#vardefine:Reference\|343616 SCR-ADD-1}}
	{{#vardefine:Year\|2017}}		{{#vardefine:Year\|2017}}

Anw: v0.1 - Initial Draft

2017-08-15T12:55:22Z

v0.1 - Initial Draft

New page

<div class="noprint">
{{#vardefine:Client|MARS}}
{{#vardefine:ClientName|Marshalls Stone}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD DMS Export Images}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|15th August 2017}}
{{#vardefine:Reference|343616 SCR-ADD-1}}
{{#vardefine:Year|2017}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}}


<div class="noprint">
= Functional Overview =
== Client Requirement ==
Additional request from customer: Following a meeting with Credit Services they would ideally like images associated with a POD being uploaded in to OnBase as well as the POD report itself, but ideally in a separate file such that they can choose whether to send them with the POD or not to any customer that is querying an invoice.

== Solution Overview ==
The POD/POC report mechanism will be modified so that the images file can be exported in a separate file.

Additionally, this will also be modified so that the addition of images when exporting to a Document Management System can be configured at a system level, allowing OBSL to configure the system so that multiple files can be exported to the DMS:
# The POD file itself
# Any attached images

The customer can then choose to send the images to the customer through OnBase if they desire.

The files are expected to be named in the following patterns:
* The POD file - POD_(EPL_JOB_CODE).pdf
* The Images file - POD_(EPL_JOB_CODE)_Images.pdf
In these file names, EPL_JOB_CODE is replaced with the value from the job. This is expected to be populated from the data in the interface as the Sales Order.

It is expected that the files created will be transferred either by direct file copying into a folder or transferred via FTP to an account and folder set up by the customer. In the case where the files are simply copied, an FTP server may be set up on the instance of ''CALIDUS'' ePOD for the customer, so that the files may be retrieved automatically by an external system or manually.

== Scope ==
Changes will be made to latest version (v4.X) of {{#var:System}} only.

{{Note}} If the report format does not allow images to be specified, this section of the report will never be populated.

{{Note}} If the report format allows images to be generated, a separate image PDF will always be generated for the report when exported through the POD interface to the DMS, if the export is configured for this. In the case where there are no photos present on the job, the file will only contain the header section.

{{Note}} Emailing the report from the Admin Report or automatic emailing of the report to a customer not be affected by this change - these processes will obey the settings against the report itself as to whether the images will be included in the PDF file. This new setting against the report will affect exporting through the POD interface only.


= Set-up =
== Pre-requisites ==

== Menu Structure ==

== Data ==
The existing Marshalls configurable reports will have the parameters modified so that the images will be split:
* Marshalls Premier Mortars
* Marshalls Landscape

An Export configuration will be generated for the export of the POD reports to the DMS:

Example format of POD message.
{| border="1"
|- bgcolor="silver"
!Field !!Value
|-
|EPL_XF_TYPE || FILE (Types of FILE, FTP and EMAIL are supported.)
|-
|EPL_XF_DESTINATION || Destination Folder for example: C:\OUTBOUND\POD\
|-
|EPL_XF_ID || POD
|-
|EPL_WEB_USER || User for filesystem or FTP , if required.
|-
|EPL_WEB_PASSWORD || Password for filesystem or FTP, if required.
|-
|EPL_XF_DIRECTION || O
|-
|EPL_EXPORT_JOB_TYPES || C|D|S
|-
|EPL_EXPORT_FORMAT ||PDF (formats of HTML, Image, PDF)
|-
|EPL_IMAGE_TYPE ||  
|-
|EPL_TIFF_COMPRESSION ||  
|-
|EPL_FILENAME || Filename with insertions, expected to be "POD_(EPL_JOB_CODE)"
|}

<gallery widths=600px heights=350px perrow=1>
File:FS_343616_Admin_XFConfig1.png|''Export Configuration''
</gallery><br />

Each site will be configured with this Export Configuration.

<gallery widths=600px heights=350px perrow=1>
File:FS_343616_Admin_Site1.png|''Site Maintenance''
</gallery><br />


= Functional Description =
{{Note}} The nature of this change is very technical, in that it deals with back-end processing of exports and generic production of reports. As such, it is not expected that this can be explicitly reviewed and accepted. However, the overall result of this change is as described in the Solution Overview above.

== Configurable POD/POC Report ==
The parameter EPOD_CONFIG_REPORT.ECR_EMAIL_IMAGES_IND will change from values 0 (disabled) and 1 (enabled) to the following values:
* 0 - not created
* 1 - Created - same file
* 2 - created - split file in export

The POD section of the report will be changed to be surrounded in comments as follows:
<pre>


</pre>
This will be achieved method PopulateReport, when the divContent.innerHtml is populated.

The Image section of the report will be changed to be surrounded in comments as follows:
<pre>


</pre>
This will be achieved in method generateImageData.

== AutoExport ==
EPOD_SYS_EXPORT.ExportPOD will be changed to the call to EPOD_SYS_EMAIL.GetReportHTML, to add a parameter by reference for the configurable report format (EPOD_CONFIG_REPORT).

EPOD_SYS_EMAIL.GetReportHTML will be changed to get the configurable report format (if this is a configurable report) and set to this parameter. A new EPOD_CONFIG_REPORT DAL object will be created, passing in the configurable report ID from the Job Group, if this is a configurable report, for POD and POC types - service reports are not affected at this time.
The parameter will be set to this object created, or null.

EPOD_SYS_EMAIL.GeneratePDFFromHTML will be changed to receive a new parameter (p_strOrient) indicating (P)ortrait or (L)andscape. If present, add following to the call to WkHTMLtoPDF:
(p_strOrient == PDFDocument.Orientation.Portrait ? "portrait" : "landscape") + " "

The same change above will be added to EPOD_SYS_EMAIL.GenerateImageFromHTML

EPOD_SYS_EXPORT.EmailPOD will be changed to add an EPOD_CONFIG_REPORT parameter to call of GetReportHTML.

EPOD_SYS_EXPORT.ExportPOD will be modified to add an EPOD_CONFIG_REPORT parameter to call of GetReportHTML.

After the call of this, if the Report Format is Configurable (i.e. EPOD_CONFIG_REPORT as a valid DAL object and has a value) and Images are included in this generation (ECR_EMAIL_INC_IMAGES_IND > 0) and they are to be split (ECR_EMAIL_IMAGES_IND == 2):
* Save the ReportHTML into a new variable (ImageHTML)
* In ReportHTML, remove images by replacing with a pattern match through the comments added above.
* In ImageHTML, remove POD by replacing with pattern match through comments added above.
* Call EPOD_SYS_EMAIL.GeneratePDFFromHTML on ReportHTML as normal, adding the parameter for orientation, defaulting to "P" if not present. Store as object PDF.
* Call EPOD_SYS_EMAIL.GeneratePDFFromHTML a second time for imageHTML if present. Store as object ImagesPDF.
* For each PDF object generated, call SendFile to export the file through the parameters specified. Note that the images file must have "_images" appended to the filename, by appending this to the value of EPOD_XF_CONFIG.EPL_FILENAME before calling SendFile for the Images PDF. For example, in this configuration, a job with code "1234567890" with images will be generated as "POD_1234567890.pdf" for the POD and "POD_1234567890_images.pdf" for the images file.

{{Note}} The comment pattern match will be as follows:
\<\!--\sPOD\sSTART.*POD\sEND\s--\> - for POD
\<\!--\sIMAGES\sSTART.*IMAGES\sEND\s--\> - for IMAGES


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing the export to POD can split images.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Marshalls.
|Objective=To test: Auto-Export may export POD and image files separately.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export Tests
|Notes=For these tests:
* Set one configurable report format to split images (Marshalls) and one to not (Premier Mortars). Ensure both are including images.
* Set another configurable report format to not email images.
* Set another configurable report format to not have images at all.
* Set these against 4 different job groups.
* Configure site to auto-email on completion of jobs.
* Configure site to have a POD export of type FILE to a known and accessible file system and POD2 export of type FTP. Set up an FTP site for this.
{{Note}} Ensure all jobs are using a known OBS email address and all other jobs awaiting export are marked as complete before running the auto-export process.
Complete 4 jobs for the 4 job groups, one for each report type. Ensure images are taken (Job Photo will be sufficient).
 
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check Export email from AutoExport.
|Result=All jobs should have a report emailed to the email address against the jobs and the site email address. Every email should have a single attachment. Photos will not be present in the job configured to not have images at all, and the job to not have email images.
|Remarks=
|PassFail=
}}{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check Export to POD in FILE system
|Result=The Job with the report configured for Split images should have two files, one named POD_(EPL_JOB_CODE).pdf containing just the POD, and one named POD_(EPL_JOB_CODE)_Images.pdf containing just the images.
The Job with the report configured to not split images should have one file named POD_(EPL_JOB_CODE).pdf containing the POD and the images.
The Job with the report configured to not display images should have one file named POD_(EPL_JOB_CODE).pdf containing just the POD.
All files should be in the File folder.
|Remarks=
|PassFail=
}}{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check Export to POD in FTP server
|Result=The Job with the report configured for Split images should have two files, one named POD_(EPL_JOB_CODE).pdf containing just the POD, and one named POD_(EPL_JOB_CODE)_Images.pdf containing just the images.
The Job with the report configured to not split images should have one file named POD_(EPL_JOB_CODE).pdf containing the POD and the images.
The Job with the report configured to not display images should have one file named POD_(EPL_JOB_CODE).pdf containing just the POD.
All files should be in the FTP folder.
|Remarks=
|PassFail=
}}{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Run the report from Admin and click the Send email button from the produced report
|Result=All jobs should have a report emailed to the email address entered. Every email should have a single attachment. Photos will not be present in the job configured to not have images at all, and the job to not have email images.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 343616 POD DMS Export Images]]
|RefV1=0.1
|RefDate1=15/08/2017
|EREQ=0
|EEST=0
|EFS=0.75
|ETS=0
|EDEV=2.25
|ESTT=0.50
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0
|FS=0.75
|TS=0
|DEV=2.25
|ST=0.50
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=Simon Martin
|Rev2Title=Customer Representative
|Rev3=Debbie Linley
|Rev3Title=Customer Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 343616 POD DMS Export Images - Revision history

Anw: v1.0 - Issued to customer

Anw: v0.1 - Initial Draft