Calidus HUB - User contributions [en-gb]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T14:25:49Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database - pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite - it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ===

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' - This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' - This will allow the user to select the level of the fields to be added

* 'Field' - This will allow the user to select an individual field to add to the report.

* 'Add' - This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report - the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' - The 'display' sequence of the fields on the report - as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' - This is the level of the field as defined by the system - it may not be amended.

* 'Title' - This is the title of the field as defined by the system - it may not be amended.

* 'Displayed Title' - This is the title of the field as it will be displayed on the report - this may be amended by the user.

* 'Param' - This will consist of a drop-down with the values 'Blank' and 'Fixed' - A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' - If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' - This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Display' - This denotes whether a field will be displayed on the report. This can be used to include a parameter for the report which is not required to be output on the report.

* 'Remove' - This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal - Required fields will have the select box disabled i.e. it will be 'greyed out'. Any changes made to the report '''WILL NOT''' be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed - the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method - this will be a selection between an XLS format spreadsheet or a web page. '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' - available options will be Once, Daily and Weekly.
* 'Date/Time' - this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' - The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' - The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report <u>was initially run</u> unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has sufficient privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=8
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T14:24:39Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database - pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite - it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ===

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' - This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' - This will allow the user to select the level of the fields to be added

* 'Field' - This will allow the user to select an individual field to add to the report.

* 'Add' - This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report - the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' - The 'display' sequence of the fields on the report - as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' - This is the level of the field as defined by the system - it may not be amended.

* 'Title' - This is the title of the field as defined by the system - it may not be amended.

* 'Displayed Title' - This is the title of the field as it will be displayed on the report - this may be amended by the user.

* 'Param' - This will consist of a drop-down with the values 'Blank' and 'Fixed' - A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' - If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' - This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Display' - This denotes whether a field will be displayed on the report. This can be used to include a parameter for the report which is not required to be output on the report.

* 'Remove' - This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal - Required fields will have the select box disabled i.e. it will be 'greyed out'. Any changes made to the report '''WILL NOT''' be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed - the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method - this will be a selection between an XLS format spreadsheet or a web page. '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' - available options will be Once, Daily and Weekly.
* 'Date/Time' - this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' - The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' - The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report <u>was initially run</u> unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has sufficient privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295976-6.jpg

2012-03-06T14:20:58Z

Rothwellg:

File:295976-5.jpg

2012-03-06T14:06:01Z

Rothwellg:

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T14:04:12Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ===

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Display' - This denotes whether a field will be displayed on the report. This can be used to include a parameter for the report which is not required to be output on the report.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'. Any changes made to the report '''WILL NOT''' be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet or a web page. '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report <u>was initially run</u> unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has sufficient privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295976-4.jpg

2012-03-06T14:02:14Z

Rothwellg:

File:295976-3.jpg

2012-03-06T14:00:28Z

Rothwellg:

File:295976-2.jpg

2012-03-06T13:58:43Z

Rothwellg:

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:47:19Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ===

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'. Any changes made to the report '''WILL NOT''' be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet or a web page. '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report <u>was initially run</u> unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has sufficient privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295976-1.jpg

2012-03-06T13:46:47Z

Rothwellg:

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:45:00Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'. Any changes made to the report '''WILL NOT''' be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet or a web page. '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report <u>was initially run</u> unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has sufficient privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:41:03Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report. '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields. ''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report. '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields. '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'. '''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:40:05Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.
''' NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.
''' NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
''' NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
''' NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
''' NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:37:50Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.
'''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.
'''NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
'''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
'''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
'''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:36:25Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

&diams; '''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

&diams; '''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.
&diams; '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.
&diams; '''NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
&diams; '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
&diams; '''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. &diams; '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

&diams; '''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

&diams; '''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

&diams; '''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

&diams; '''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

&diams; '''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report (&diams; '''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

&diams; '''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:34:15Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

&diams; '''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

&diams; '''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.
&diams; '''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.
&diams; '''NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
&diams; '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
&diams; '''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

&diams; '''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

&diams; '''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

&diams; '''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

&diams; '''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

&diams; '''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:32:21Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

'''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.
&diams; '''NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
&diams; '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
&diams; '''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:29:17Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. '''NOTE:''' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

'''NOTE:''' NO checks will be made to verify the New User has access to the data defined in the report parameters.

'''NOTE:''' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

'''NOTE:''' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.

** '''NOTE:''' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
** '''NOTE:''' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** '''NOTE:''' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
** '''NOTE:''' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. '''NOTE:''' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

'''NOTE:''' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

'''NOTE:''' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

'''NOTE:''' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

'''NOTE:''' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

'''NOTE:''' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report ('''NOTE:''' this is for information purposes only and may be used to view the parameters used in the current selection).

'''NOTE:''' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:28:38Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. ''NOTE:'' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

''NOTE:'' NO checks will be made to verify the New User has access to the data defined in the report parameters.

''NOTE:'' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

''NOTE:'' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.

** ''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
** ''NOTE:'' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** ''NOTE:'' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
** ''NOTE:'' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. ''NOTE:'' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

''NOTE:'' Validation will be performed on the entered values <u>'''but'''</u> this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

''NOTE:'' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

''NOTE:'' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

''NOTE:'' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

''NOTE:'' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report (''NOTE:'' this is for information purposes only and may be used to view the parameters used in the current selection).

''NOTE:'' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:26:14Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the page will contain a drop-down with the choice to amend an existing report (default), copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed), the report 'Type' and then a specific report from a drop-down list of all available reports for the selected user and report type. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New ==

[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. ''NOTE:'' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

''NOTE:'' NO checks will be made to verify the New User has access to the data defined in the report parameters.

''NOTE:'' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

''NOTE:'' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.

** ''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
** ''NOTE:'' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** ''NOTE:'' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
** ''NOTE:'' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. ''NOTE:'' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if allowed, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

''NOTE:'' Validation will be performed on the entered values '''but''' this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

''NOTE:'' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

''NOTE:'' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

''NOTE:'' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

''NOTE:'' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report (''NOTE:'' this is for information purposes only and may be used to view the parameters used in the current selection).

''NOTE:'' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:14:08Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance ==

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the user will be given the choice to amend an existing report, copy an existing report or create a new one.

=== Amend Existing ===

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed) then a report from a drop-down list of all available reports for the selected user. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New:
[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. ''NOTE:'' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing ===

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

''NOTE:'' NO checks will be made to verify the New User has access to the data defined in the report parameters.

''NOTE:'' Schedules for the existing report will not be copied to the new one.



=== Report Details ===

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

''NOTE:'' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.

** ''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
** ''NOTE:'' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** ''NOTE:'' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
** ''NOTE:'' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. ''NOTE:'' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection ==

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if they have the Report Maintenance privilege, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

''NOTE:'' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

''NOTE:'' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

''NOTE:'' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance ==

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

''NOTE:'' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report (''NOTE:'' this is for information purposes only and may be used to view the parameters used in the current selection).

''NOTE:'' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:10:51Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Include Oracle Data Extracts within Portal}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|6th Mar 2012}}
{{#vardefine:Reference|295976 LD-8QNKJM}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-4: Include Oracle Data Extracts within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal system will be modified to include a Reporting Suite '''similar''' to that of the existing OBS WMS Oracle system.

See the Functional Description for details.

== Scope ==

* The Reporting Suite will only be available on Oracle versions of the WMS system.
* All data reporting will be 'live' i.e. there will be no off-line / batched data retrieval.
* Reporting formats will be limited to HTML, XLS and DOC. Other formats e.g. PDF will not be available. The XLS and DOC reports created will be editable after production i.e. they will not be read-only. Report names will be fixed by the system, but files can be renamed by the user upon saving.
* A 'document store' will ''NOT'' be available i.e. reports will not be saved on the server for later retrieval. It will be the users' responsibility to save/store reports after production.
* Reporting can only be done against a single database – pooling data across databases/systems is out of scope of this change.
* Report scheduling will be limited to reports within the Reporting Suite – it will not be possible to access or schedule reports outside of the suite.



= Functional Description =

== Report Suite Maintenance

A new Report Suite maintenance page will be created to allow users (with the appropriate privilege) to create/modify/remove reports from the suite. On entry into the page, the user will be given the choice to amend an existing report, copy an existing report or create a new one.

=== Amend Existing:

[[File:295976-1.jpg|border|700px]]

The user will be able to select the Oracle User (if allowed) then a report from a drop-down list of all available reports for the selected user. Clicking the 'Find Report' button will display the details of the report for maintenance. See the 'Report Details' section below.

=== Create New:
[[File:295976-2.jpg|border|700px]]

To create a new report, the user should select the Oracle User the report is to be created for (if allowed) followed by the report 'Type', report 'Level' and the 'Name' of the new report. Clicking the 'Create Report' button will create the report and display the details of the report for maintenance. ''NOTE:'' When a report is created, the system will automatically add all required fields onto the report. The report will be added to the list of reports for the current user as defined by the Oracle User parameter against the user.

=== Copy Existing:

[[File:295976-3.jpg|border|700px]]

To copy a report, the user should select the Oracle User (if allowed), the 'Type' and the existing report 'Name' to be copied, then select the user the report is to be copied to (if allowed) and enter a new report name and click the 'Copy Report' button. The report will be copied including all parameters and the system will display the details of the report for maintenance.

''NOTE:'' NO checks will be made to verify the New User has access to the data defined in the report parameters.

''NOTE:'' Schedules for the existing report will not be copied to the new one.



=== Report Details:

[[File:295976-4.jpg|border|700px]]

A 'Delete Report' button will be available to delete the report (after confirmation).

A section 'Add Fields' will be available to add a new field to the report:

* 'Action' – This will initially be set to 'Add Field' to allow the user to select a Level and Field to add to the report. Other Action values available will be 'Add Level' where the user will select a Level, and all fields for that level will be added to the report; and 'Add All Fields' where all fields for each level will be added to the report.

* 'Level' – This will allow the user to select the level of the fields to be added

* 'Field' – This will allow the user to select an individual field to add to the report.

* 'Add' – This button will add the selected field (or level or all fields) to the report.

''NOTE:'' All fields added to the report will be given the next allocated sequence i.e. an added field will be added as the last field in the report – the report sequence i.e. the order of the fields when displayed as results may be changed by 'Dragging and Dropping' rows into the desired sequence, then updating the report.

The report details section will have the following fields:

* 'Sequence' – The 'display' sequence of the fields on the report – as mentioned above, the rows may be dragged/dropped into the desired sequence.

* 'Level' – This is the level of the field as defined by the system – it may not be amended.

* 'Title' – This is the title of the field as defined by the system – it may not be amended.

* 'Displayed Title' – This is the title of the field as it will be displayed on the report – this may be amended by the user.

* 'Param' – This will consist of a drop-down with the values 'Blank' and 'Fixed' – A value of 'Fixed' denotes that the parameter will appear on the Report selection page (see later) but the default From/To values for the Parameters will not be amendable by the user. A blank value denotes that the default From/To values may be amended. The text after the drop-down will denote if parameters are available for this field, and whether this is a 'Range' or 'Single' parameter. A blank value will denote that no parameter selection is available for the field.

* 'From/To' – If a parameter (or range) is available for the field, the default (initial) values may be entered in these fields.

** ''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

* 'Sort Seq' – This drop-down can be used to select and prioritise the sort sequence of fields displayed on the report.
** ''NOTE:'' If two fields are set to have the same sort sequence, the field which is highest in the table will be given that sequence, and all subsequent fields will be dropped down in the sequence.

* 'Remove' – This select box can be used to select fields to remove from the report. Clicking on the 'Remove' button will remove all selected fields.
** ''NOTE:'' It will not be possible to select Required fields for removal – Required fields will have the select box disabled i.e. it will be 'greyed out'.
** ''NOTE:'' Any changes made to the report WILL NOT be saved if the 'Remove' button is clicked so the user should click the 'Update' button prior to selecting any rows for removal if they wish to keep changes.

An update button will be available to update report details. ''NOTE:'' Clicking the 'Update' button will not remove selected rows, it will only update details and all rows will remain.



== Report Suite Selection

A new Report Suite Selection/Parameter page will be created to run the reports.

[[File:295976-5.jpg|border|700px]]

The user will select an Oracle User (if they have the Report Maintenance privilege, otherwise this will be fixed to the users Oracle User) followed by a report type then a report name from a list of the reports for the selected Oracle User. Once selected, the relevant parameters will be displayed for the report. Any parameters which are 'Fixed' will be displayed, but the text boxes will be read-only and changes will not be allowed – the values will be displayed within a white background to denote they cannot be amended.

The parameters will be displayed in the sequence they were assigned when creating the report.

''NOTE:'' Validation will be performed on the entered values but this will be limited to its type i.e. Character, Number or Date and Length of Field e.g. Stock Code will be maximum 20 characters.

Dates will be validated to be in the format DD/MM/YYYY.

Character fields will NOT be up/downshifted, they will be accepted in the case they are entered.

There will be no other validation; lookups etc and defaults (other than those entered in the maintenance page) will not be available.

''NOTE:'' As with the Oracle Reporting Suite, no subtotalling, header/footer information, report grouping etc will be available.

Once the required parameters have been entered, the user can select if they wish to run the report immediately i.e. online, or schedule the report to be e-mailed at a later time.

If the user selects online, they will be prompted only for the output method – this will be a selection between an XLS format spreadsheet, a web page or an MS Word document.

''NOTE:'' For scheduled reports, 'web page' will not be an option.

If the user selects 'scheduled', the following additional parameters will be prompted for:

* 'Frequency' – available options will be Once, Daily and Weekly.
* 'Date/Time' – this will be the date/time to execute the report. A calendar will be displayed to enter the date.
* 'E-mail address' – The e-mail address(es) to send the report once produced. This will initially be set to the users e-mail address entered in the user maintenance page.
* 'Subject' – The subject line of the e-mail.

Once the details are entered, the parameters (as entered on the page) and the e-mail details will be written to the scheduled list of reports.

A polling process will be executed at system set intervals (5 or 10 minutes tbc) and this process will look for scheduled reports on the list which are due since the last polling run. These reports will be executed and once complete they will immediately be e-mailed to the respective people.

If the report was setup with a frequency, a new record will be created on the scheduled list for the same time and appropriate date.

''NOTE:'' Scheduled reports will run each time with the exact same parameters that were entered in the page when the report was initially run, unless removed from the scheduled list and re-scheduled with new parameters.



== Scheduled Report Maintenance

The scheduled report maintenance page can be used to view and delete scheduled reports. If the user has Report Suite Maintenance privileges they will be able to view everyone's reports, otherwise the user will only be allowed to view their own reports.

[[File:295976-6.jpg|border|700px]]

''NOTE:'' The data will be initially sorted on execution date/time (earliest first) then report type/name.

The user can set filters to limit (if required) the reports to be displayed. Once the user has clicked 'Filter' button the scheduled reports matching the filters will be retrieved.

The user can select reports for deletion, or click on a single report line to view the SQL used for the report (''NOTE:'' this is for information purposes only and may be used to view the parameters used in the current selection).

''NOTE:'' Due to the use of existing file structures on the Oracle system, it will not be possible to amend scheduled reports. If the parameters on a report need to be amended, the report should be deleted from the schedule then re-scheduled using the 'Report Suite Selection' page with the new/amended schedule/parameters.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1
|TS=0
|EDEV=5
|DEV=7
|ST=1
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:04:21Z

Rothwellg:

FS 295976 LD-8QNKJM Include Oracle Data Extracts within Portal

2012-03-06T13:03:15Z

Rothwellg: Created page with "<div class="noprint"> {{#vardefine:Client|DHL}} {{#vardefine:ClientName|DHL}} {{#vardefine:System|''CALIDUS'' Portal}} {{#vardefine:Doc_Title|Include Oracle Data Extracts within ..."

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T16:14:53Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

== Message Creation ==

A new page within CALIDUS Portal will allow the entry of an email message from the inbound/outbound processing pages described elsewhere when the user has clicked the 'Report Problem' button and the message processing page described later in this document.

The page will display a header section with relevant information - for all messages the message type, status ('open') and user and then specific information dependent on the message type e.g. for an order message the owner/order number.

[[File:295942-1.jpg|border|700px]]

Under the header will be the email entry section. This will consist of the following fields:

* From - the email address from i.e. the email address of the user raising the message
* To - this will be the admin email address from the users group and if different the originator of the message i.e. the from address <as the message will not be sent by the user - TBC>.
* Cc - an additional box so the user may include other emails they wish to send the message to.
* Subject - the subject for the email.

'''Note:''' The From and To boxes will in nearly all circumstances be pre-populated, and non-amendable. The subject will only be editable on the initial creation of a message thread, for all responses and additional messages on the thread, it will be read-only to ensure the thread subject is consitent.



The final section will be a series of buttons:

* Send - this will send the message. If this is the first message a new message thread will be created, but if this is an additional message to an existing thread, it will be added into the thread, leaving the status of the message 'Open'. On sending the message, the system will take the user into the Message Processing page which will automatically show the message thread.

* Send & Close - this will only appear for admin users. It will send the message and set the stauts of the original to 'Closed' so that the message thread can no longer be added to.

* Cancel - this will not send the message and will return the user to the previous page.



== Message Processing ==

The Message processing page will be called from the inbound/outbound processing pages when the user has clicked the email/message icon against a GRN/Order and the message creation page described above once the user has clicked 'Send'. The page may also be called from the menu.

[[File:295942-22.jpg|border|700px]]

There will be a selection section at the top of the page. If called from another page, the specific message information e.g. GRN/Order will be passed to the page, and this will be locked into the selection. If called from the menu, then the selection may be entered to find the required details. The selection available will be:

* Owner - This will display all owners visible to the user as assigned to the users Group within the Portal. '''NOTE:''' This drop-down will '''''not''''' contain an 'All' option, and will default to the currently selected owner from the Home page.

* Message Type - This will be the type of message - Order or GRN - but will also include 'Raised By' so that the user may select messages raised by a specific user, in which case both Order and GRN messages will be selected.

* Status - This will allow selection of the message status - either 'All' (Default) or 'Open' to only select open message threads.

* <Filter> - This will be a text box, which will either be a specific GRN, Order or User or may be left blank to select all messages for the given type.



Once the user clicks 'Find' or they have been passed in from another page, the page will display the chosen details for the selection:

* Status - this will display the email icon which will be green for closed message threads and red for open threads.
* Type - the type of message, which will be GRN or ORD.
* Owner - the owner for the GRN or Order.
* Order/GRN - either the GRN No. for GRN messages else the Order No. for ORD messages
* Raised By - the user who raised the initial message
* Date Raised - the date the initial message was raised
* Subject - the subject entered on the initial message
* Date Cleared - the date that the message thread was closed
* Cleared By - the admin user who closed the message thread
* Select - for 'normal' users, a select will be available against open messages, for 'admin' users both open and closed messages will be selectable. See below for the actions which may be performed on the message.
* +/- Clicking this will epxand/contract the selected message so that the message thread can be viewed in chronological order, including the actual email content, the from/to and the date/time of each message.

[[File:295942-3.jpg|border|700px]]

At the base of the page there will be an Action drop-down with the following options:

* Add Message - available to all users and for all Open messages, this will allow an additional message to be added to the initial thread.
* Close - only available to admin users. This will close the selected open message, without sending a response. '''Note:''' to send a response and close the message, the admin user should use 'Add Message' then click on 'Send & Close' in the message creation page.
* Re-Open - only available to admin users. This will reset the status of a Closed message to Open.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T16:13:29Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

== Message Creation ==

A new page within CALIDUS Portal will allow the entry of an email message from the inbound/outbound processing pages described elsewhere when the user has clicked the 'Report Problem' button and the message processing page described later in this document.

The page will display a header section with relevant information - for all messages the message type, status ('open') and user and then specific information dependent on the message type e.g. for an order message the owner/order number.

[[File:295942-1.jpg|border|700px]]

Under the header will be the email entry section. This will consist of the following fields:

* From - the email address from i.e. the email address of the user raising the message
* To - this will be the admin email address from the users group and if different the originator of the message i.e. the from address <as the message will not be sent by the user - TBC>.
* Cc - an additional box so the user may include other emails they wish to send the message to.
* Subject - the subject for the email.

'''Note:''' The From and To boxes will in nearly all circumstances be pre-populated, and non-amendable. The subject will only be editable on the initial creation of a message thread, for all responses and additional messages on the thread, it will be read-only to ensure the thread subject is consitent.



The final section will be a series of buttons:

* Send - this will send the message. If this is the first message a new message thread will be created, but if this is an additional message to an existing thread, it will be added into the thread, leaving the status of the message 'Open'. On sending the message, the system will take the user into the Message Processing page which will automatically show the message thread.
* Send & Close - this will only appear for admin users. It will send the message and set the stauts of the original to 'Closed' so that the message thread can no longer be added to.
* Cancel - this will not send the message and will return the user to the previous page.



== Message Processing ==

The Message processing page will be called from the inbound/outbound processing pages when the user has clicked the email/message icon against a GRN/Order and the message creation page described above once the user has clicked 'Send'. The page may also be called from the menu.

[[File:295942-22.jpg|border|700px]]

There will be a selection section at the top of the page. If called from another page, the specific message information e.g. GRN/Order will be passed to the page, and this will be locked into the selection. If called from the menu, then the selection may be entered to find the required details. The selection available will be:

* Owner - This will display all owners visible to the user as assigned to the users Group within the Portal. '''NOTE:''' This drop-down will '''''not''''' contain an 'All' option, and will default to the currently selected owner from the Home page.

* Message Type - This will be the type of message - Order or GRN - but will also include 'Raised By' so that the user may select messages raised by a specific user, in which case both Order and GRN messages will be selected.

* Status - This will allow selection of the message status - either 'All' (Default) or 'Open' to only select open message threads.

* <Filter> - This will be a text box, which will either be a specific GRN, Order or User or may be left blank to select all messages for the given type.

Once the user clicks 'Find' or they have been passed in from another page, the page will display the chosen details for the selection:

* Status - this will display the email icon which will be green for closed message threads and red for open threads.
* Type - the type of message, which will be GRN or ORD.
* Owner - the owner for the GRN or Order.
* Order/GRN - either the GRN No. for GRN messages else the Order No. for ORD messages
* Raised By - the user who raised the initial message
* Date Raised - the date the initial message was raised
* Subject - the subject entered on the initial message
* Date Cleared - the date that the message thread was closed
* Cleared By - the admin user who closed the message thread
* Select - for 'normal' users, a select will be available against open messages, for 'admin' users both open and closed messages will be selectable. See below for the actions which may be performed on the message.
* +/- Clicking this will epxand/contract the selected message so that the message thread can be viewed in chronological order, including the actual email content, the from/to and the date/time of each message.

[[File:295942-3.jpg|border|700px]]

At the base of the page there will be an Action drop-down with the following options:

* Add Message - available to all users and for all Open messages, this will allow an additional message to be added to the initial thread.
* Close - only available to admin users. This will close the selected open message, without sending a response. '''Note:''' to send a response and close the message, the admin user should use 'Add Message' then click on 'Send & Close' in the message creation page.
* Re-Open - only available to admin users. This will reset the status of a Closed message to Open.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295942-22.jpg

2012-03-01T16:12:03Z

Rothwellg:

File:295942-3.jpg

2012-03-01T16:11:08Z

Rothwellg:

File:295942-1.jpg

2012-03-01T16:10:23Z

Rothwellg:

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T16:10:00Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

== Message Creation ==

A new page within CALIDUS Portal will allow the entry of an email message from the inbound/outbound processing pages described elsewhere when the user has clicked the 'Report Problem' button and the message processing page described later in this document.

The page will display a header section with relevant information - for all messages the message type, status ('open') and user and then specific information dependent on the message type e.g. for an order message the owner/order number.

[[File:295942-1.jpg|border|700px]]

Under the header will be the email entry section. This will consist of the following fields:

* From - the email address from i.e. the email address of the user raising the message
* To - this will be the admin email address from the users group and if different the originator of the message i.e. the from address <as the message will not be sent by the user - TBC>.
* Cc - an additional box so the user may include other emails they wish to send the message to.
* Subject - the subject for the email.

'''Note:''' The From and To boxes will in nearly all circumstances be pre-populated, and non-amendable. The subject will only be editable on the initial creation of a message thread, for all responses and additional messages on the thread, it will be read-only to ensure the thread subject is consitent.

The final section will be a series of buttons:

* Send - this will send the message. If this is the first message a new message thread will be created, but if this is an additional message to an existing thread, it will be added into the thread, leaving the status of the message 'Open'. On sending the message, the system will take the user into the Message Processing page which will automatically show the message thread.
* Send & Close - this will only appear for admin users. It will send the message and set the stauts of the original to 'Closed' so that the message thread can no longer be added to.
* Cancel - this will not send the message and will return the user to the previous page.



== Message Processing ==

The Message processing page will be called from the inbound/outbound processing pages when the user has clicked the email/message icon against a GRN/Order and the message creation page described above once the user has clicked 'Send'. The page may also be called from the menu.

[[File:295942-22.jpg|border|700px]]

There will be a selection section at the top of the page. If called from another page, the specific message information e.g. GRN/Order will be passed to the page, and this will be locked into the selection. If called from the menu, then the selection may be entered to find the required details. The selection available will be:

* Owner - This will display all owners visible to the user as assigned to the users Group within the Portal. '''NOTE:''' This drop-down will '''''not''''' contain an 'All' option, and will default to the currently selected owner from the Home page.

* Message Type - This will be the type of message - Order or GRN - but will also include 'Raised By' so that the user may select messages raised by a specific user, in which case both Order and GRN messages will be selected.

* Status - This will allow selection of the message status - either 'All' (Default) or 'Open' to only select open message threads.

* <Filter> - This will be a text box, which will either be a specific GRN, Order or User or may be left blank to select all messages for the given type.

Once the user clicks 'Find' or they have been passed in from another page, the page will display the chosen details for the selection:

* Status - this will display the email icon which will be green for closed message threads and red for open threads.
* Type - the type of message, which will be GRN or ORD.
* Owner - the owner for the GRN or Order.
* Order/GRN - either the GRN No. for GRN messages else the Order No. for ORD messages
* Raised By - the user who raised the initial message
* Date Raised - the date the initial message was raised
* Subject - the subject entered on the initial message
* Date Cleared - the date that the message thread was closed
* Cleared By - the admin user who closed the message thread
* Select - for 'normal' users, a select will be available against open messages, for 'admin' users both open and closed messages will be selectable. See below for the actions which may be performed on the message.
* +/- Clicking this will epxand/contract the selected message so that the message thread can be viewed in chronological order, including the actual email content, the from/to and the date/time of each message.

[[File:295942-3.jpg|border|700px]]

At the base of the page there will be an Action drop-down with the following options:

* Add Message - available to all users and for all Open messages, this will allow an additional message to be added to the initial thread.
* Close - only available to admin users. This will close the selected open message, without sending a response. '''Note:''' to send a response and close the message, the admin user should use 'Add Message' then click on 'Send & Close' in the message creation page.
* Re-Open - only available to admin users. This will reset the status of a Closed message to Open.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295942-2.jpg

2012-03-01T16:08:50Z

Rothwellg: uploaded a new version of "File:295942-2.jpg"

File:295942-2.jpg

2012-03-01T16:06:55Z

Rothwellg: uploaded a new version of "File:295942-2.jpg"

File:295942-2.jpg

2012-03-01T16:05:55Z

Rothwellg: uploaded a new version of "File:295942-2.jpg": Reverted to version as of 16:03, 1 March 2012

File:295942-2.jpg

2012-03-01T16:05:29Z

Rothwellg: uploaded a new version of "File:295942-2.jpg"

File:295942-2.jpg

2012-03-01T16:03:46Z

Rothwellg: uploaded a new version of "File:295942-2.jpg"

File:295942-2.jpg

2012-03-01T16:01:53Z

Rothwellg:

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T16:01:30Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

== Message Creation ==

A new page within CALIDUS Portal will allow the entry of an email message from the inbound/outbound processing pages described elsewhere when the user has clicked the 'Report Problem' button and the message processing page described later in this document.

The page will display a header section with relevant information - for all messages the message type, status ('open') and user and then specific information dependent on the message type e.g. for an order message the owner/order number.

[[File:295942-1.jpg|border|700px]]

Under the header will be the email entry section. This will consist of the following fields:

* From - the email address from i.e. the email address of the user raising the message
* To - this will be the admin email address from the users group and if different the originator of the message i.e. the from address <as the message will not be sent by the user - TBC>.
* Cc - an additional box so the user may include other emails they wish to send the message to.
* Subject - the subject for the email.

'''Note:''' The From and To boxes will in nearly all circumstances be pre-populated, and non-amendable. The subject will only be editable on the initial creation of a message thread, for all responses and additional messages on the thread, it will be read-only to ensure the thread subject is consitent.

The final section will be a series of buttons:

* Send - this will send the message. If this is the first message a new message thread will be created, but if this is an additional message to an existing thread, it will be added into the thread, leaving the status of the message 'Open'. On sending the message, the system will take the user into the Message Processing page which will automatically show the message thread.
* Send & Close - this will only appear for admin users. It will send the message and set the stauts of the original to 'Closed' so that the message thread can no longer be added to.
* Cancel - this will not send the message and will return the user to the previous page.



== Message Processing ==

The Message processing page will be called from the inbound/outbound processing pages when the user has clicked the email/message icon against a GRN/Order and the message creation page described above once the user has clicked 'Send'. The page may also be called from the menu.

[[File:295942-2.jpg|border|700px]]

There will be a selection section at the top of the page. If called from another page, the specific message information e.g. GRN/Order will be passed to the page, and this will be locked into the selection. If called from the menu, then the selection may be entered to find the required details. The selection available will be:

* Owner - This will display all owners visible to the user as assigned to the users Group within the Portal. '''NOTE:''' This drop-down will '''''not''''' contain an 'All' option, and will default to the currently selected owner from the Home page.

* Message Type - This will be the type of message - Order or GRN - but will also include 'Raised By' so that the user may select messages raised by a specific user, in which case both Order and GRN messages will be selected.

* Status - This will allow selection of the message status - either 'All' (Default) or 'Open' to only select open message threads.

* <Filter> - This will be a text box, which will either be a specific GRN, Order or User or may be left blank to select all messages for the given type.

Once the user clicks 'Find' or they have been passed in from another page, the page will display the chosen details for the selection:

* Status - this will display the email icon which will be green for closed message threads and red for open threads.
* Type - the type of message, which will be GRN or ORD.
* Owner - the owner for the GRN or Order.
* Order/GRN - either the GRN No. for GRN messages else the Order No. for ORD messages
* Raised By - the user who raised the initial message
* Date Raised - the date the initial message was raised
* Subject - the subject entered on the initial message
* Date Cleared - the date that the message thread was closed
* Cleared By - the admin user who closed the message thread
* Select - for 'normal' users, a select will be available against open messages, for 'admin' users both open and closed messages will be selectable. See below for the actions which may be performed on the message.
* +/- Clicking this will epxand/contract the selected message so that the message thread can be viewed in chronological order, including the actual email content, the from/to and the date/time of each message.

[[File:295942-3.jpg|border|700px]]

At the base of the page there will be an Action drop-down with the following options:

* Add Message - available to all users and for all Open messages, this will allow an additional message to be added to the initial thread.
* Close - only available to admin users. This will close the selected open message, without sending a response. '''Note:''' to send a response and close the message, the admin user should use 'Add Message' then click on 'Send & Close' in the message creation page.
* Re-Open - only available to admin users. This will reset the status of a Closed message to Open.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T15:55:48Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

== Message Creation ==

A new page within CALIDUS Portal will allow the entry of an email message from the inbound/outbound processing pages described elsewhere when the user has clicked the 'Report Problem' button and the message processing page described later in this document.

The page will display a header section with relevant information - for all messages the message type, status ('open') and user and then specific information dependent on the message type e.g. for an order message the owner/order number.

[[File:295942-1.jpg|border|700px]]

Under the header will be the email entry section. This will consist of the following fields:

* From - the email address from i.e. the email address of the user raising the message
* To - this will be the admin email address from the users group and if different the originator of the message i.e. the from address <as the message will not be sent by the user - TBC>.
* Cc - an additional box so the user may include other emails they wish to send the message to.
* Subject - the subject for the email.

'''Note:''' The From and To boxes will in nearly all circumstances be pre-populated, and non-amendable. The subject will only be editable on the initial creation of a message thread, for all responses and additional messages on the thread, it will be read-only to ensure the thread subject is consitent.

The final section will be a series of buttons:

* Send - this will send the message. If this is the first message a new message thread will be created, but if this is an additional message to an existing thread, it will be added into the thread, leaving the status of the message 'Open'. On sending the message, the system will take the user into the Message Processing page which will automatically show the message thread.
* Send & Close - this will only appear for admin users. It will send the message and set the stauts of the original to 'Closed' so that the message thread can no longer be added to.
* Cancel - this will not send the message and will return the user to the previous page.



== Message Processing ==

The Message processing page will be called from the inbound/outbound processing pages when the user has clicked the email/message icon against a GRN/Order and the message creation page described above once the user has clicked 'Send'. The page may also be called from the menu.

[[File:295942-2.jpg|border|700px]]

There will be a selection section at the top of the page. If called from another page, the specific message information e.g. GRN/Order will be passed to the page, and this will be locked into the selection. If called from the menu, then the selection may be entered to find the required details. The selection available will be:

* Owner - This will display all owners visible to the user as assigned to the users Group within the Portal. '''NOTE:''' This drop-down will '''''not''''' contain an 'All' option, and will default to the currently selected owner from the Home page.

* Message Type - This will be the type of message - Order or GRN - but will also include 'Raised By' so that the user may select messages raised by a specific user, in which case both Order and GRN messages will be selected.

* Status - This will allow selection of the message status - either 'All' (Default) or 'Open' to only select open message threads.

* <Filter> - This will be a text box, which will either be a specific GRN, Order or User or may be left blank to select all messages for the given type.

Once the user clicks 'Find' or they have been passed in from another page, the page will display the chosen details for the selection:

* Status - this will display the email icon which will be green for closed message threads and red for open threads.
* Type - the type of message, which will be GRN or ORD.
* Owner - the owner for the GRN or Order.
* Order/GRN - either the GRN No. for GRN messages else the Order No. for ORD messages
* Raised By - the user who raised the initial message
* Date Raised - the date the initial message was raised
* Subject - the subject entered on the initial message
* Date Cleared - the date that the message thread was closed
* Cleared By - the admin user who closed the message thread
* Select - for 'normal' users, a select will be available against open messages, for 'admin' users both open and closed messages will be selectable. See below for the actions which may be performed on the message.
* +/- Clicking this will epxand/contract the selected message so that the message thread can be viewed in chronological order, including the actual email content, the from/to and the date/time of each message.

At the base of the page there will be an Action drop-down with the following options:

* Add Message - available to all users and for all Open messages, this will allow an additional message to be added to the initial thread.
* Close - only available to admin users. This will close the selected open message, without sending a response. '''Note:''' to send a response and close the message, the admin user should use 'Add Message' then click on 'Send & Close' in the message creation page.
* Re-Open - only available to admin users. This will reset the status of a Closed message to Open.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T15:30:38Z

Rothwellg:

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T15:04:26Z

Rothwellg:

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T15:02:33Z

Rothwellg:

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T14:38:05Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* A new Calidus Portal table PORTAL_MESSAGES will be created to hold the messages.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_USERS table to hold the users email address.

* A new EMAIL_ADDRESS field will be added onto the PORTAL_GROUPS table to hold the groups admin email address(es).



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available receipts for that depot.

[[File:295941-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295941-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see receipts for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - Both Incomplete and Complete receipts.
** Incomplete (Default) - receipts which have not been Putwaway Confirmed.
** Complete - Receipts which have been Putwaway Confirmed.

* A filter box to allow the user to enter a specific GRN Number (or a partial match, by entering just the beginning of the receipt e.g. 123 to find 1234 & 1236 etc).

* A filter box to allow the user to enter a specific Advice Note Number (or a partial match, by entering just the beginning of the receipt e.g. REC123 to find REC1234 & REC1236 etc).

'''NOTE:''' None, Either or Both of the above fields may be entered. If both a GRN Number and Advice Note Number are entered, then the search will try to match against both values.



Once the user has made their selection and clicks on the 'Find' button, a list of receipts will be displayed which match the selected criteria. The screen will limit the number of receipts displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295941-3.jpg|border|700px]]

The data will initially be sorted by Status and GRN No. Clicking on any of the column headings will change the sort sequence.

The details displayed for each GRN found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will be red; else if all the alert(s) have been cleared the icon will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select a GRN for processing which has an outstanding alert.
* Owner - the owner/study
* GRN No - the CALIDUS WMS GRN no
* Advice Note No - the Advice Note No
* Expected Date - the Expected Date in the format DD-MMM-YYYY
* Status - the status of the GRN. See the drop-down description above for details.
* Return - a tick icon to denote if the GRN is marked as a retrun i.e. the CALIDUS WMS GRN type is "R".
* Selected - a radio button for the user to select a sigle GRN to be actioned. Note that if a GRN has an outstanding alert, then the radio button will not be available for selection.
* +/- Expansion - clicking on the +/- button at the end of each row will expand the rows details to show the following additional detail information:
** Stock Code - the CALIDUS WMS Stock Code
** Description - the description of the stock
** Rotation - the CALIDUS WMS System Rotation No
** Sell By Date - the Sell-By-Date against the line
** Qty - the total unit qty against the line
Note that the +/- icons in the heading will expand/collapse all of the row details.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected GRN information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Print''' - If the GRN status is 'Pending', clicking this button will create a GRN Putaway Note. Selecting a status other than 'Pending' will disable this button.

The GRN Putaway Note produced will be a PDF document with a simple list of the GRN information, followed by each product and the Serial Numbers against each product. The list can be saved and printed by the user.

'''Confirm''' - If the GRN status is 'Pending', clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue with the confirmation, the system will create all pallets in their default putaway locations with all preadvised serial numbers received as if 100%. The page will also mark the GRN as putaway confirmed. Standard processing (automatically holding the stock until the temperature has been confirmed) will remain in place. Once the confirmation has been processed, the data grid will be refreshed to display the changed GRN status.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T14:32:54Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include Message Creation and Message Processing pages which will allow the user to perform the following:

* Create a message (email) to report an Issue/Problem.
* Add additional messages onto the same problem thread.
* Show the message thread/history
* Respond to a user problem (admin only)
* Close a message thread (admin only)
* Re-Open a problem thread (admin only)

See the Functional Description for details.

== Scope ==

* When a supplier is going to send stock direct into the depots without routing through Cherwell, the Cherwell users will manually create a preadvice with all serial numbers. Once created, this will appear on the GRN list within CALIDUS Portal.

* It was discussed that an email be sent to each depot, once per day, indicating the preadvices arriving in on that day. The meeting rejected the proposal, as this either encouraged lazy processes, or the messages will simply be ignored.

* It was also noted that the Business Requirements Document (section 9.4.1) suggested that Carrier, Temp, Packaging and Monitor requirements were to be preadvised. The meeting decided that this was probably not required, but that this should be confirmed by the operation (Lukasz Danel of the DHL team has confirmed this on 27/01/2012).



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available receipts for that depot.

[[File:295941-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295941-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see receipts for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - Both Incomplete and Complete receipts.
** Incomplete (Default) - receipts which have not been Putwaway Confirmed.
** Complete - Receipts which have been Putwaway Confirmed.

* A filter box to allow the user to enter a specific GRN Number (or a partial match, by entering just the beginning of the receipt e.g. 123 to find 1234 & 1236 etc).

* A filter box to allow the user to enter a specific Advice Note Number (or a partial match, by entering just the beginning of the receipt e.g. REC123 to find REC1234 & REC1236 etc).

'''NOTE:''' None, Either or Both of the above fields may be entered. If both a GRN Number and Advice Note Number are entered, then the search will try to match against both values.



Once the user has made their selection and clicks on the 'Find' button, a list of receipts will be displayed which match the selected criteria. The screen will limit the number of receipts displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295941-3.jpg|border|700px]]

The data will initially be sorted by Status and GRN No. Clicking on any of the column headings will change the sort sequence.

The details displayed for each GRN found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will be red; else if all the alert(s) have been cleared the icon will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select a GRN for processing which has an outstanding alert.
* Owner - the owner/study
* GRN No - the CALIDUS WMS GRN no
* Advice Note No - the Advice Note No
* Expected Date - the Expected Date in the format DD-MMM-YYYY
* Status - the status of the GRN. See the drop-down description above for details.
* Return - a tick icon to denote if the GRN is marked as a retrun i.e. the CALIDUS WMS GRN type is "R".
* Selected - a radio button for the user to select a sigle GRN to be actioned. Note that if a GRN has an outstanding alert, then the radio button will not be available for selection.
* +/- Expansion - clicking on the +/- button at the end of each row will expand the rows details to show the following additional detail information:
** Stock Code - the CALIDUS WMS Stock Code
** Description - the description of the stock
** Rotation - the CALIDUS WMS System Rotation No
** Sell By Date - the Sell-By-Date against the line
** Qty - the total unit qty against the line
Note that the +/- icons in the heading will expand/collapse all of the row details.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected GRN information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Print''' - If the GRN status is 'Pending', clicking this button will create a GRN Putaway Note. Selecting a status other than 'Pending' will disable this button.

The GRN Putaway Note produced will be a PDF document with a simple list of the GRN information, followed by each product and the Serial Numbers against each product. The list can be saved and printed by the user.

'''Confirm''' - If the GRN status is 'Pending', clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue with the confirmation, the system will create all pallets in their default putaway locations with all preadvised serial numbers received as if 100%. The page will also mark the GRN as putaway confirmed. Standard processing (automatically holding the stock until the temperature has been confirmed) will remain in place. Once the confirmation has been processed, the data grid will be refreshed to display the changed GRN status.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295942 LD-8QNKTV Implement Supervisor Message Handling

2012-03-01T14:23:21Z

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Implement Supervisor Message Handling}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|1st Mar 2012}}
{{#vardefine:Reference|295942 LD-8QNKTV}}
{{#vardefine:Year|2012}}
</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 ==
Implement Supervisor Message Handling within CALIDUS Portal and Implement Problem Resolution emails within Portal As per FS 294817, SCR-294817-6: Implement Supervisor Message Handling within CALIDUS Portal & SCR-294817-7: Implement Problem Resolution emails within Portal. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Inbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pre-Advice Note
* Putaway Confirm a GRN

See the Functional Description for details.

== Scope ==

* When a supplier is going to send stock direct into the depots without routing through Cherwell, the Cherwell users will manually create a preadvice with all serial numbers. Once created, this will appear on the GRN list within CALIDUS Portal.

* It was discussed that an email be sent to each depot, once per day, indicating the preadvices arriving in on that day. The meeting rejected the proposal, as this either encouraged lazy processes, or the messages will simply be ignored.

* It was also noted that the Business Requirements Document (section 9.4.1) suggested that Carrier, Temp, Packaging and Monitor requirements were to be preadvised. The meeting decided that this was probably not required, but that this should be confirmed by the operation (Lukasz Danel of the DHL team has confirmed this on 27/01/2012).



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available receipts for that depot.

[[File:295941-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295941-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see receipts for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - Both Incomplete and Complete receipts.
** Incomplete (Default) - receipts which have not been Putwaway Confirmed.
** Complete - Receipts which have been Putwaway Confirmed.

* A filter box to allow the user to enter a specific GRN Number (or a partial match, by entering just the beginning of the receipt e.g. 123 to find 1234 & 1236 etc).

* A filter box to allow the user to enter a specific Advice Note Number (or a partial match, by entering just the beginning of the receipt e.g. REC123 to find REC1234 & REC1236 etc).

'''NOTE:''' None, Either or Both of the above fields may be entered. If both a GRN Number and Advice Note Number are entered, then the search will try to match against both values.



Once the user has made their selection and clicks on the 'Find' button, a list of receipts will be displayed which match the selected criteria. The screen will limit the number of receipts displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295941-3.jpg|border|700px]]

The data will initially be sorted by Status and GRN No. Clicking on any of the column headings will change the sort sequence.

The details displayed for each GRN found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will be red; else if all the alert(s) have been cleared the icon will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select a GRN for processing which has an outstanding alert.
* Owner - the owner/study
* GRN No - the CALIDUS WMS GRN no
* Advice Note No - the Advice Note No
* Expected Date - the Expected Date in the format DD-MMM-YYYY
* Status - the status of the GRN. See the drop-down description above for details.
* Return - a tick icon to denote if the GRN is marked as a retrun i.e. the CALIDUS WMS GRN type is "R".
* Selected - a radio button for the user to select a sigle GRN to be actioned. Note that if a GRN has an outstanding alert, then the radio button will not be available for selection.
* +/- Expansion - clicking on the +/- button at the end of each row will expand the rows details to show the following additional detail information:
** Stock Code - the CALIDUS WMS Stock Code
** Description - the description of the stock
** Rotation - the CALIDUS WMS System Rotation No
** Sell By Date - the Sell-By-Date against the line
** Qty - the total unit qty against the line
Note that the +/- icons in the heading will expand/collapse all of the row details.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected GRN information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Print''' - If the GRN status is 'Pending', clicking this button will create a GRN Putaway Note. Selecting a status other than 'Pending' will disable this button.

The GRN Putaway Note produced will be a PDF document with a simple list of the GRN information, followed by each product and the Serial Numbers against each product. The list can be saved and printed by the user.

'''Confirm''' - If the GRN status is 'Pending', clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue with the confirmation, the system will create all pallets in their default putaway locations with all preadvised serial numbers received as if 100%. The page will also mark the GRN as putaway confirmed. Standard processing (automatically holding the stock until the temperature has been confirmed) will remain in place. Once the confirmation has been processed, the data grid will be refreshed to display the changed GRN status.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=4
|ST=1.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295941 LD-8QNJQH Create Portal Inbound Confirmation screen

2012-03-01T14:12:15Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Create Portal Inbound Control screen}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th Feb 2012}}
{{#vardefine:Reference|295941 LD-8QNJQH}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-1: Create Portal Inbound Confirmation screen Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Inbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pre-Advice Note
* Putaway Confirm a GRN

See the Functional Description for details.

== Scope ==

* When a supplier is going to send stock direct into the depots without routing through Cherwell, the Cherwell users will manually create a preadvice with all serial numbers. Once created, this will appear on the GRN list within CALIDUS Portal.

* It was discussed that an email be sent to each depot, once per day, indicating the preadvices arriving in on that day. The meeting rejected the proposal, as this either encouraged lazy processes, or the messages will simply be ignored.

* It was also noted that the Business Requirements Document (section 9.4.1) suggested that Carrier, Temp, Packaging and Monitor requirements were to be preadvised. The meeting decided that this was probably not required, but that this should be confirmed by the operation (Lukasz Danel of the DHL team has confirmed this on 27/01/2012).



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available receipts for that depot.

[[File:295941-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295941-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see receipts for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - Both Incomplete and Complete receipts.
** Incomplete (Default) - receipts which have not been Putwaway Confirmed.
** Complete - Receipts which have been Putwaway Confirmed.

* A filter box to allow the user to enter a specific GRN Number (or a partial match, by entering just the beginning of the receipt e.g. 123 to find 1234 & 1236 etc).

* A filter box to allow the user to enter a specific Advice Note Number (or a partial match, by entering just the beginning of the receipt e.g. REC123 to find REC1234 & REC1236 etc).

'''NOTE:''' None, Either or Both of the above fields may be entered. If both a GRN Number and Advice Note Number are entered, then the search will try to match against both values.



Once the user has made their selection and clicks on the 'Find' button, a list of receipts will be displayed which match the selected criteria. The screen will limit the number of receipts displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295941-3.jpg|border|700px]]

The data will initially be sorted by Status and GRN No. Clicking on any of the column headings will change the sort sequence.

The details displayed for each GRN found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will be red; else if all the alert(s) have been cleared the icon will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select a GRN for processing which has an outstanding alert.
* Owner - the owner/study
* GRN No - the CALIDUS WMS GRN no
* Advice Note No - the Advice Note No
* Expected Date - the Expected Date in the format DD-MMM-YYYY
* Status - the status of the GRN. See the drop-down description above for details.
* Return - a tick icon to denote if the GRN is marked as a retrun i.e. the CALIDUS WMS GRN type is "R".
* Selected - a radio button for the user to select a sigle GRN to be actioned. Note that if a GRN has an outstanding alert, then the radio button will not be available for selection.
* +/- Expansion - clicking on the +/- button at the end of each row will expand the rows details to show the following additional detail information:
** Stock Code - the CALIDUS WMS Stock Code
** Description - the description of the stock
** Rotation - the CALIDUS WMS System Rotation No
** Sell By Date - the Sell-By-Date against the line
** Qty - the total unit qty against the line
Note that the +/- icons in the heading will expand/collapse all of the row details.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected GRN information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Print''' - If the GRN status is 'Pending', clicking this button will create a GRN Putaway Note. Selecting a status other than 'Pending' will disable this button.

The GRN Putaway Note produced will be a PDF document with a simple list of the GRN information, followed by each product and the Serial Numbers against each product. The list can be saved and printed by the user.

'''Confirm''' - If the GRN status is 'Pending', clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue with the confirmation, the system will create all pallets in their default putaway locations with all preadvised serial numbers received as if 100%. The page will also mark the GRN as putaway confirmed. Standard processing (automatically holding the stock until the temperature has been confirmed) will remain in place. Once the confirmation has been processed, the data grid will be refreshed to display the changed GRN status.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=2
|TS=0
|DEV=14
|ST=3
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295940 LD-8QNK64 Create Portal Outbound Control screen

2012-03-01T14:11:39Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Create Portal Outbound Control screen}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th Feb 2012}}
{{#vardefine:Reference|295940 LD-8QNK64}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-2: Create Portal Outbound Control screen. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf". A new button "POD details" should be added on top of the specified in this SCR. It should enable user to enter information on: who sign for the parcel, date and time It should update information entered on Unison Oracle screen "POD confirmation" SOS3000.

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Outbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pick List
* Print a Despatch Note
* Pick/Pack an Order
* Despatch Confirm an Order
* POD Confirm an Order

See the Functional Description for details.

== Scope ==

The order will be created in ''CALIDUS'' WMS and allocated by the Cherwell staff.

Any orders that have been created through the EDI process will simply be allocated by the Cherwell staff.

Any orders that have been manually entered by the Cherwell staff must be double-checked (to ensure that the Serial Number information has been keyed correctly). The process for this will be:
* The order will be keyed by one user.
* A second user will regularly show a list of all manually-entered orders at Entered status, through the standard ''CALIDUS'' WMS reports. The list will show all serial numbers entered against the orders.
* For each order on the list, the user will check the serial numbers on this list. If they are correct, this user will then allocate the order and move onto the next on the list, until all are completed.
* If the order's serial numbers do not match, the user will amend the order with the correct serial numbers, then allocate the order.



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available orders for that depot.

[[File:295940-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295940-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see Orders just for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - All of the below status.
** Incomplete (Default) - Orders at status Pending, Picked and Packed
** Complete - Orders at status Despatched and POD Confirmed
** Pending - Orders at status Allocated or Pick Listed.
** Picked - Orders at status Pick Confirmed.
** Packed - Orders at status Pick Confirmed with Pack information entered.
** Despatched - Orders at status Despatched.
** POD Confirmed - Orders at a later order status (POD Conf, Invoiced, etc).
** Cancelled - Any cancelled orders. '''NOTE:''' Cancelled orders cannot be selected for processing.

* A filter box to allow the user to enter a specific Order Number (or a partial match, by entering just the beginning of the order e.g. ORD123 to find ORD1234 & ORD1236 etc).



Once the user has made their selection and clicks on the 'Find' button, a list of orders will be displayed which match the selected criteria. The screen will limit the number of Orders displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295940-3.jpg|border|700px]]

The data will initially be sorted by Status and Order. Clicking on any of the column headings will change the sort sequence. Note this will also reset any order selection.

The details displayed for Orders found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will have a red border; else if all the alert(s) have been cleared the border will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select an order for processing which has an outstanding alert.
* Owner - the owner/study
* Order - the CALIDUS WMS order reference
* Order Ref - the alternate order reference
* Client Order No - the customer's order reference
* Customer - the Name of the customer
* Priority - the order priority
* Status - the status of the order. See the drop-down description above for details.
* Selected - a check box for the user to select which orders are to be actioned. Buttons below this column will allow the user to select all/none of the orders displayed on the page. Note that if there are multiple pages of orders, only those displayed on the grid can be selected at the same time. If the order has an outstanding alert, then the check box will not be available for selection.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page. Note that clicking on any of these buttons will reset any order selection.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected order information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Pick List''' - If the selected orders are at status 'Pending', this button will print a Pick List for all the orders selected. Multiple orders can be selected when clicking this button. On printing the pick list, this button will update the status of the selected orders to Pick Listed, if they are not already at Pick Listed status. Selecting any order with a status other than 'Pending' will disable this button. Once the pick list has been printed, the data grid will be refreshed to display any changed order status.

The Pick List produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be displayed in the sequence in which they are held on CALIDUS WMS. At the footing of each page the text "For Internal Use Only" will be displayed. The list can be saved and printed by the user.

''C-TMS Notes'': For each order number selected the wms system will be called to update the orders to status ‘Pick List’ and set as ‘Pick Printed’. This will be achieved by adding a new procedure to the DP_PICK_REQ package. The marshalling location will be assumed as the default value listed within Warehouse Maintenance.

'''Despatch Note''' - If the orders selected are at 'Despatched' status, this button will print a Despatch note for all the orders selected. Multiple orders can be selected when clicking this button. Selecting any order with a status other than 'Despatched' will disable this button.

The Despatch note produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be ordered ascending and displayed in this sequence. The note can be saved and printed by the user.
'''NOTE:''' For the confirmation buttons below, only a single order may be selected. If multiple orders are selected, all of the confirmation buttons will be disabled.

''C-TMS Notes'': The wms despatch print package will be called to update the 'Despatch Printed' flag to 'Y' for the orders that are printed.

'''Pick/Pack Confirm''' - If the order selected is at status 'Pending', clicking this button will call a Pick/Pack page, described elsewhere.

'''Despatch Confirm''' - If the order selected is at status 'Packed', clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the despatch, the system will update the order to Despatched within CALIDUS WMS. The Despatched date and time will be set to the current date and time, and the despatch user will be set to the logged-in user ID. Once completed, the Despatch note will be displayed (as with the Despatch Note button above). Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': The wms dispatch package will be called for each of the order numbers selected. The orders will updated to status 'Despatch Confirmed', the stock will be downdated from the warehouse and 'SALE' records will be produced. This will be achieved by adding a new procedure to the DP_DESPATCH package.



'''POD Confirm''' - If the order selected is at status 'Despatched', clicking this button will display a section on the page to enter the POD Confirmed Date and Time, as well as the contact who has signed for the parcels.

[[File:295940-4.jpg|border|700px]]

If the user clicks on the 'Cancel Confirmation' button then no action will be performed.

If the user enters the required data and clicks on the 'POD Confirm' button, the system will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the POD confirmation, the system will update the order to Pod Confirmed status within CALIDUS WMS. The POD Confirmed date and time will be set to the date and time entered, and the user will be set to the logged-in user ID. Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': For each order number selected the wms system will be called to update the order as 'POD'. This will be achieved by adding a new POD package to the wms system. The process will extract the order number passed in and set the orders to status completed. The pallet and serial level records will also be updated to be at status 'POD'. It is assumed that no pod discrepancies will occur for this process.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=10
|ST=2
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295941 LD-8QNJQH Create Portal Inbound Confirmation screen

2012-03-01T14:09:39Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Create Portal Inbound Control screen}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th Feb 2012}}
{{#vardefine:Reference|295941 LD-8QNJQH}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-1: Create Portal Inbound Confirmation screen Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf"

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Inbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pre-Advice Note
* Putaway Confirm a GRN

See the Functional Description for details.

== Scope ==

* When a supplier is going to send stock direct into the depots without routing through Cherwell, the Cherwell users will manually create a preadvice with all serial numbers. Once created, this will appear on the GRN list within CALIDUS Portal.

* It was discussed that an email be sent to each depot, once per day, indicating the preadvices arriving in on that day. The meeting rejected the proposal, as this either encouraged lazy processes, or the messages will simply be ignored.

* It was also noted that the Business Requirements Document (section 9.4.1) suggested that Carrier, Temp, Packaging and Monitor requirements were to be preadvised. The meeting decided that this was probably not required, but that this should be confirmed by the operation (Lukasz Danel of the DHL team has confirmed this on 27/01/2012).



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available receipts for that depot.

[[File:295941-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295941-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see receipts for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - Both Incomplete and Complete receipts.
** Incomplete (Default) - receipts which have not been Putwaway Confirmed.
** Complete - Receipts which have been Putwaway Confirmed.

* A filter box to allow the user to enter a specific GRN Number (or a partial match, by entering just the beginning of the receipt e.g. 123 to find 1234 & 1236 etc).

* A filter box to allow the user to enter a specific Advice Note Number (or a partial match, by entering just the beginning of the receipt e.g. REC123 to find REC1234 & REC1236 etc).

'''NOTE:''' None, Either or Both of the above fields may be entered. If both a GRN Number and Advice Note Number are entered, then the search will try to match against both values.



Once the user has made their selection and clicks on the 'Find' button, a list of receipts will be displayed which match the selected criteria. The screen will limit the number of receipts displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295941-3.jpg|border|700px]]

The data will initially be sorted by Status and GRN No. Clicking on any of the column headings will change the sort sequence.

The details displayed for each GRN found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will be red; else if all the alert(s) have been cleared the icon will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select a GRN for processing which has an outstanding alert.
* Owner - the owner/study
* GRN No - the CALIDUS WMS GRN no
* Advice Note No - the Advice Note No
* Expected Date - the Expected Date in the format DD-MMM-YYYY
* Status - the status of the GRN. See the drop-down description above for details.
* Return - a tick icon to denote if the GRN is marked as a retrun i.e. the CALIDUS WMS GRN type is "R".
* Selected - a radio button for the user to select a sigle GRN to be actioned. Note that if a GRN has an outstanding alert, then the radio button will not be available for selection.
* +/- Expansion - clicking on the +/- button at the end of each row will expand the rows details to show the following additional detail information:
** Stock Code - the CALIDUS WMS Stock Code
** Description - the description of the stock
** Rotation - the CALIDUS WMS System Rotation No
** Sell By Date - the Sell-By-Date against the line
** Qty - the total unit qty against the line
Note that the +/- icons in the heading will expand/collapse all of the row details.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Message Creation page passing the selected order information into the page. This page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking Send, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table, and the message thread can be viewed on the CALIDUS Portal Message Processing page.

'''Print''' - If the GRN status is 'Pending', clicking this button will create a GRN Putaway Note. Selecting a status other than 'Pending' will disable this button.

The GRN Putaway Note produced will be a PDF document with a simple list of the GRN information, followed by each product and the Serial Numbers against each product. The list can be saved and printed by the user.

'''Confirm''' - If the GRN status is 'Pending', clicking this button will display a confirmation dialogue, showing the GRN Number and user name. If the user confirms that they wish to continue with the confirmation, the system will create all pallets in their default putaway locations with all preadvised serial numbers received as if 100%. The page will also mark the GRN as putaway confirmed. Standard processing (automatically holding the stock until the temperature has been confirmed) will remain in place. Once the confirmation has been processed, the data grid will be refreshed to display the changed GRN status.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=2
|TS=0
|DEV=14
|ST=3
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295940 LD-8QNK64 Create Portal Outbound Control screen

2012-03-01T13:58:43Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Create Portal Outbound Control screen}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th Feb 2012}}
{{#vardefine:Reference|295940 LD-8QNK64}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-2: Create Portal Outbound Control screen. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf". A new button "POD details" should be added on top of the specified in this SCR. It should enable user to enter information on: who sign for the parcel, date and time It should update information entered on Unison Oracle screen "POD confirmation" SOS3000.

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Outbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pick List
* Print a Despatch Note
* Pick/Pack an Order
* Despatch Confirm an Order
* POD Confirm an Order

See the Functional Description for details.

== Scope ==

The order will be created in ''CALIDUS'' WMS and allocated by the Cherwell staff.

Any orders that have been created through the EDI process will simply be allocated by the Cherwell staff.

Any orders that have been manually entered by the Cherwell staff must be double-checked (to ensure that the Serial Number information has been keyed correctly). The process for this will be:
* The order will be keyed by one user.
* A second user will regularly show a list of all manually-entered orders at Entered status, through the standard ''CALIDUS'' WMS reports. The list will show all serial numbers entered against the orders.
* For each order on the list, the user will check the serial numbers on this list. If they are correct, this user will then allocate the order and move onto the next on the list, until all are completed.
* If the order's serial numbers do not match, the user will amend the order with the correct serial numbers, then allocate the order.



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available orders for that depot.

[[File:295940-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295940-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see Orders just for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - All of the below status.
** Incomplete (Default) - Orders at status Pending, Picked and Packed
** Complete - Orders at status Despatched and POD Confirmed
** Pending - Orders at status Allocated or Pick Listed.
** Picked - Orders at status Pick Confirmed.
** Packed - Orders at status Pick Confirmed with Pack information entered.
** Despatched - Orders at status Despatched.
** POD Confirmed - Orders at a later order status (POD Conf, Invoiced, etc).
** Cancelled - Any cancelled orders. '''NOTE:''' Cancelled orders cannot be selected for processing.

* A filter box to allow the user to enter a specific Order Number (or a partial match, by entering just the beginning of the order e.g. ORD123 to find ORD1234 & ORD1236 etc).



Once the user has made their selection and clicks on the 'Find' button, a list of orders will be displayed which match the selected criteria. The screen will limit the number of Orders displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295940-3.jpg|border|700px]]

The data will initially be sorted by Status and Order. Clicking on any of the column headings will change the sort sequence. Note this will also reset any order selection.

The details displayed for Orders found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will have a red border; else if all the alert(s) have been cleared the border will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select an order for processing which has an outstanding alert.
* Owner - the owner/study
* Order - the CALIDUS WMS order reference
* Order Ref - the alternate order reference
* Client Order No - the customer's order reference
* Customer - the Name of the customer
* Priority - the order priority
* Status - the status of the order. See the drop-down description above for details.
* Selected - a check box for the user to select which orders are to be actioned. Buttons below this column will allow the user to select all/none of the orders displayed on the page. Note that if there are multiple pages of orders, only those displayed on the grid can be selected at the same time. If the order has an outstanding alert, then the check box will not be available for selection.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page. Note that clicking on any of these buttons will reset any order selection.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Alerts/Issues page passing with the selected order information into the page so that any existing issues for the order will be displayed. The page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking OK, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table created for this purpose.

'''Pick List''' - If the selected orders are at status 'Pending', this button will print a Pick List for all the orders selected. Multiple orders can be selected when clicking this button. On printing the pick list, this button will update the status of the selected orders to Pick Listed, if they are not already at Pick Listed status. Selecting any order with a status other than 'Pending' will disable this button. Once the pick list has been printed, the data grid will be refreshed to display any changed order status.

The Pick List produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be displayed in the sequence in which they are held on CALIDUS WMS. At the footing of each page the text "For Internal Use Only" will be displayed. The list can be saved and printed by the user.

''C-TMS Notes'': For each order number selected the wms system will be called to update the orders to status ‘Pick List’ and set as ‘Pick Printed’. This will be achieved by adding a new procedure to the DP_PICK_REQ package. The marshalling location will be assumed as the default value listed within Warehouse Maintenance.

'''Despatch Note''' - If the orders selected are at 'Despatched' status, this button will print a Despatch note for all the orders selected. Multiple orders can be selected when clicking this button. Selecting any order with a status other than 'Despatched' will disable this button.

The Despatch note produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be ordered ascending and displayed in this sequence. The note can be saved and printed by the user.
'''NOTE:''' For the confirmation buttons below, only a single order may be selected. If multiple orders are selected, all of the confirmation buttons will be disabled.

''C-TMS Notes'': The wms despatch print package will be called to update the 'Despatch Printed' flag to 'Y' for the orders that are printed.

'''Pick/Pack Confirm''' - If the order selected is at status 'Pending', clicking this button will call a Pick/Pack page, described elsewhere.

'''Despatch Confirm''' - If the order selected is at status 'Packed', clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the despatch, the system will update the order to Despatched within CALIDUS WMS. The Despatched date and time will be set to the current date and time, and the despatch user will be set to the logged-in user ID. Once completed, the Despatch note will be displayed (as with the Despatch Note button above). Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': The wms dispatch package will be called for each of the order numbers selected. The orders will updated to status 'Despatch Confirmed', the stock will be downdated from the warehouse and 'SALE' records will be produced. This will be achieved by adding a new procedure to the DP_DESPATCH package.



'''POD Confirm''' - If the order selected is at status 'Despatched', clicking this button will display a section on the page to enter the POD Confirmed Date and Time, as well as the contact who has signed for the parcels.

[[File:295940-4.jpg|border|700px]]

If the user clicks on the 'Cancel Confirmation' button then no action will be performed.

If the user enters the required data and clicks on the 'POD Confirm' button, the system will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the POD confirmation, the system will update the order to Pod Confirmed status within CALIDUS WMS. The POD Confirmed date and time will be set to the date and time entered, and the user will be set to the logged-in user ID. Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': For each order number selected the wms system will be called to update the order as 'POD'. This will be achieved by adding a new POD package to the wms system. The process will extract the order number passed in and set the orders to status completed. The pallet and serial level records will also be updated to be at status 'POD'. It is assumed that no pod discrepancies will occur for this process.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=10
|ST=2
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 295940 LD-8QNK64 Create Portal Outbound Control screen

2012-03-01T13:57:30Z

Rothwellg:

<div class="noprint">
{{#vardefine:Client|DHL}}
{{#vardefine:ClientName|DHL}}
{{#vardefine:System|''CALIDUS'' Portal}}
{{#vardefine:Doc_Title|Create Portal Outbound Control screen}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th Feb 2012}}
{{#vardefine:Reference|295940 LD-8QNK64}}
{{#vardefine:Year|2012}}
</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 ==
As per FS 294817, SCR-294817-2: Create Portal Outbound Control screen. Please take under consideration all comments for this section from attached "CT Global Order Well v0 3 - initial spec.rtf". A new button "POD details" should be added on top of the specified in this SCR. It should enable user to enter information on: who sign for the parcel, date and time It should update information entered on Unison Oracle screen "POD confirmation" SOS3000.

== Solution Overview ==

The CALIDUS Portal Web Application will be modified to include a WMS Outbound Processing Page which will allow the user to perform the following:

* Report an Issue/Problem
* Print a Pick List
* Print a Despatch Note
* Pick/Pack an Order
* Despatch Confirm an Order
* POD Confirm an Order

See the Functional Description for details.

== Scope ==

The order will be created in ''CALIDUS'' WMS and allocated by the Cherwell staff.

Any orders that have been created through the EDI process will simply be allocated by the Cherwell staff.

Any orders that have been manually entered by the Cherwell staff must be double-checked (to ensure that the Serial Number information has been keyed correctly). The process for this will be:
* The order will be keyed by one user.
* A second user will regularly show a list of all manually-entered orders at Entered status, through the standard ''CALIDUS'' WMS reports. The list will show all serial numbers entered against the orders.
* For each order on the list, the user will check the serial numbers on this list. If they are correct, this user will then allocate the order and move onto the next on the list, until all are completed.
* If the order's serial numbers do not match, the user will amend the order with the correct serial numbers, then allocate the order.



= Functional Description =

A new screen within CALIDUS Portal will display a list of all available orders for that depot.

[[File:295940-1.jpg|border|700px]]

A number of filters will be available for the users to filter what is displayed:

[[File:295940-2.jpg|border|700px]]

* A drop-down list of Studies (i.e. Owners) will be available to allow the users to see Orders just for a particular study. This will display all owners visible to the user as assigned to the users Group within the Portal, and will include an 'All' option, which will include all owners visible within the drop-down. '''NOTE:''' The drop-down will default to the currently selected owner from the Home page.

* A Drop-down List of Statuses will be available to allow the user to see Orders at that particular status. The list will comprise of the following values:
** All - All of the below status.
** Incomplete (Default) - Orders at status Pending, Picked and Packed
** Complete - Orders at status Despatched and POD Confirmed
** Pending - Orders at status Allocated or Pick Listed.
** Picked - Orders at status Pick Confirmed.
** Packed - Orders at status Pick Confirmed with Pack information entered.
** Despatched - Orders at status Despatched.
** POD Confirmed - Orders at a later order status (POD Conf, Invoiced, etc).
** Cancelled - Any cancelled orders. '''NOTE:''' Cancelled orders cannot be selected for processing.

* A filter box to allow the user to enter a specific Order Number (or a partial match, by entering just the beginning of the order e.g. ORD123 to find ORD1234 & ORD1236 etc).



Once the user has made their selection and clicks on the 'Find' button, a list of orders will be displayed which match the selected criteria. The screen will limit the number of Orders displayed with a default of 20 records, with buttons to fetch the next/previous pages of data.

[[File:295940-3.jpg|border|700px]]

The data will initially be sorted by Status and Order. Clicking on any of the column headings will change the sort sequence. Note this will also reset any order selection.

The details displayed for Orders found will be:

* Alert - showing whether a problem has been reported. If there is an outstanding alert, the icon will have a red border; else if all the alert(s) have been cleared the border will be green. Clicking the alert icon will take the user into the Alert/Issues page to display the alerts. '''NOTE:''' It will not be possible to select an order for processing which has an outstanding alert.
* Owner - the owner/study
* Order - the CALIDUS WMS order reference
* Order Ref - the alternate order reference
* Client Order No - the customer's order reference
* Customer - the Name of the customer
* Priority - the order priority
* Status - the status of the order. See the drop-down description above for details.
* Selected - a check box for the user to select which orders are to be actioned. Buttons below this column will allow the user to select all/none of the orders displayed on the page. Note that if there are multiple pages of orders, only those displayed on the grid can be selected at the same time. If the order has an outstanding alert, then the check box will not be available for selection.

At the foot of the page, a navigation section will allow the user to navigate between the pages of data and select the number of records to be displayed on the page. Note that clicking on any of these buttons will reset any order selection.

In addition to the navigation section, a selection of buttons will be available, dependent on the order selections made, as described next.



'''Report Problem''' - If this button is pressed clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue reporting a problem, the system will display the Alerts/Issues page passing with the selected order information into the page so that any existing issues for the order will be displayed. The page will allow the user to enter details of an email. The Email recipient and some of the details will be pre-set on the form. On clicking OK, the email will be sent directly through the client's email program. The details of the email will also be saved in CALIDUS WMS on a new table created for this purpose.

'''Pick List''' - If the selected orders are at status 'Pending', this button will print a Pick List for all the orders selected. Multiple orders can be selected when clicking this button. On printing the pick list, this button will update the status of the selected orders to Pick Listed, if they are not already at Pick Listed status. Selecting any order with a status other than 'Pending' will disable this button. Once the pick list has been printed, the data grid will be refreshed to display any changed order status.

The Pick List produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be displayed in the sequence in which they are held on CALIDUS WMS. At the footing of each page the text "For Internal Use Only" will be displayed. The list can be saved and printed by the user.

''C-TMS Notes'': For each order number selected the wms system will be called to update the orders to status ‘Pick List’ and set as ‘Pick Printed’. This will be achieved by adding a new procedure to the DP_PICK_REQ package. The marshalling location will be assumed as the default value listed within Warehouse Maintenance.

'''Despatch Note''' - If the orders selected are at 'Despatched' status, this button will print a Despatch note for all the orders selected. Multiple orders can be selected when clicking this button. Selecting any order with a status other than 'Despatched' will disable this button.

The Despatch note produced will be a PDF document with a simple list of the order information, followed by each product, then the Serial Numbers against each product. The Serial numbers will be ordered ascending and displayed in this sequence. The note can be saved and printed by the user.
'''NOTE:''' For the confirmation buttons below, only a single order may be selected. If multiple orders are selected, all of the confirmation buttons will be disabled.

''C-TMS Notes'': The wms despatch print package will be called to update the 'Despatch Printed' flag to 'Y' for the orders that are printed.

'''Pick/Pack Confirm''' - If the order selected is at status 'Pending', clicking this button will call a Pick/Pack page, described elsewhere.

'''Despatch Confirm''' - If the order selected is at status 'Packed', clicking this button will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the despatch, the system will update the order to Despatched within CALIDUS WMS. The Despatched date and time will be set to the current date and time, and the despatch user will be set to the logged-in user ID. Once completed, the Despatch note will be displayed (as with the Despatch Note button above). Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': The wms dispatch package will be called for each of the order numbers selected. The orders will updated to status 'Despatch Confirmed', the stock will be downdated from the warehouse and 'SALE' records will be produced. This will be achieved by adding a new procedure to the DP_DESPATCH package.

'''POD Confirm''' - If the order selected is at status 'Despatched', clicking this button will display a section on the page to enter the POD Confirmed Date and Time, as well as the contact who has signed for the parcels.

[[File:295940-4.jpg|border|700px]]

If the user clicks on the 'Cancel Confirmation' button then no action will be performed.

If the user enters the required data and clicks on the 'POD Confirm' button, the system will display a confirmation dialogue, showing the Order Number and user name. If the user confirms that they wish to continue with the POD confirmation, the system will update the order to Pod Confirmed status within CALIDUS WMS. The POD Confirmed date and time will be set to the date and time entered, and the user will be set to the logged-in user ID. Once the confirmation has been processed, the data grid will be refreshed to display the changed order status.

''C-TMS Notes'': For each order number selected the wms system will be called to update the order as 'POD'. This will be achieved by adding a new POD package to the wms system. The process will extract the order number passed in and set the orders to status completed. The pallet and serial level records will also be updated to be at status 'POD'. It is assumed that no pod discrepancies will occur for this process.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=10
|ST=2
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=OBS
|Rev1Title=OBS Product Manager
|Rev2=DHL
|Rev2Title=DHL Representative
}}</div>
[[Category:{{#var:Client}} FS]]

File:295941-3.jpg

2012-02-27T13:26:50Z

Rothwellg: