Auto-Export: Difference between revisions

From EPOD
(Updated based on version 4.0.02.02)
(Updated based on version 4.5.00.02)
Line 1: Line 1:
This screen allows users to create, delete and amend Import and Export parameters. These are held against a configuration ID that is then attached to a site or job group. Multiple different types of imports and exports can be configured under the same config ID. If export is configured on the system, the process will import and export based on the configurations attached to the site or job group.
This screen allows you to create, delete and amend import and export parameters. These are held against a configuration ID that you can attached to a [[Site|site]] or [[Job Groups|job groups]] through the appropriate maintenance screen. You can configure multiple different types of imports and exports under the same config ID. If you configure export on the system, the process will import and export based on the configurations attached to the site or job group.


The screen allows users to filter data by:
You can filter data by:
* Config ID
* ''Config ID''.
* Description
* ''Description''.
* Type - a drop-down list of the different import/export transfer types (for example, FTP, SOAP, etc).
* ''Type'' - a drop-down list of the different import/export transfer types (for example, FTP, SOAP, etc).
* ID - the export type (for example, JOB, LOAD, TPN, TTM, etc)
* ''ID'' - the export type (for example, JOB, LOAD, TPN, TTM, etc).
* Direction - a drop-down list
* ''Direction'' - a drop-down list. You can choose ''Inbound'', ''Outbound'', ''All'' or ''Device'' to see interfaces designed to be used by the mobile device only.


Once the filter information is entered and the '''Search''' button is pressed, all matching configurations are displayed in a table below.
Once you have entered the criteria, click '''Search'''. The screen will display a table of all the matching data. Any plain text boxes will match data that contains what you enter as the criterion.


[[File:EPOD-AutoExport1.PNG|1000px|border]]  
[[File:EPOD-AutoExport1.PNG|1000px|border]]  
<br />''Import/Export Configurations Search Panel and Results table''<br />
<br />''Import/Export Configurations Search Panel and Results table''<br />


A single line is displayed per configuration found.
The results table will display a single line per configuration found.


<!-- Each column can be sorted by clicking on the column header - clicking again will reverse the sort sequence.
<!-- Each column can be sorted by clicking on the column header - clicking again will reverse the sort sequence.
-->
-->
Details shown are:
The results table shows the following columns:
* Config ID - The main configuration ID that will be attached to the Site or Job Group.
* ''Config ID'' - the main configuration ID that will be attached to the site or job group.
* Description - the description of the import/export being configured as part of the Config ID.
* ''Description'' - the description of the import/export being configured as part of the ''Config ID''.
* Type - Transfer Type (e.g. Email, File, SOAP, etc).
* ''Type'' - the transfer type (e.g. Email, File, SOAP, etc).
* ID - the Import/Export type. Standard configurations are one of the following:
* ''ID'' - the import/export type. Standard configurations are one of the following:
** JOB - standard OBS XML updates per job.
** ''JOB'' - standard OBS XML updates per job.
** LOAD - standard OBS XML Updates per Load - can include the Job information if required.
** ''LOAD'' - standard OBS XML Updates per load. This include the job information if required.
** POD/POD2 - Export of Completion Reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
** ''POD''/''POD2'' - export of completion reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
** TTM - Export of load, order and tracking information to ''CALIDUS'' Portal TTM.
** ''TTM'' - export of load, order and tracking information to ''CALIDUS'' Portal TTM.
** VEHICLECHECKS - Export of completed vehicle defect checks.
** ''VEHICLECHECKS'' - export of completed vehicle defect checks.
** JOBSWAP - Export of Job Swap information to Transport Management Systems (e.g. ''CALIDUS'' TMS).
** ''JOBSWAP'' - export of job swap information to transport management systems (e.g. ''CALIDUS'' TMS).
** PF/PALLEX/FORTRACK/TPN/GAP861/Palletline/HazChem - Pallet Network tracking system specific exports.
** ''PF''/''PALLEX''/''FORTRACK''/''TPN''/''GAP861''/''Palletline''/''HazChem'' - pallet network tracking system specific exports.
** TomTom Geocoder - service to geocode addresses.
** ''TomTom Geocoder'' - service to geocode addresses.
** TomTom WEBFLEET Order - service to export orders to TomTom WEBFLEET for tracking and execution.
** ''TomTom WEBFLEET Order'' - service to export orders to TomTom WEBFLEET for tracking and execution.
** TomTom WEBFLEET Order (Import) - service to import debrief information from TomTom WEBFLEET.  
** ''TomTom WEBFLEET Order (Import)'' - service to import debrief information from TomTom WEBFLEET.  
** TomTom Device/Driver - Device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
** ''TomTom Device/Driver'' - device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
** DiPS Orders - Import from DiPS route optimisation software.
** ''DiPS Orders'' - import from DiPS route optimisation software.
** PART - Bespoke Partnerlink JobShare Import.
** ''PART'' - bespoke Partnerlink JobShare import.
** EBB - Bespoke EBB Import
** ''EBB'' - bespoke EBB import.
* Destination - a folder or network specification for file- or FTP-based transfers.
** ''Invoice'' - export of invoice information.
* Direction - Inbound to (I) or Outbound from (O) ''CALIDUS'' ePOD. For TomTom Device/Driver messages, this defaults to "Device".
** ''Here Geocoder'' - service to geocode addresses.
* Message Type - message-specific. For example, for TTM, indicates the individual message types being sent.
* ''Destination'' - a folder or network specification for file- or FTP-based transfers.
* Export Job Types - message-specific. Indicates whether Collection (C), Deliveries (D) or Services (S) are exported with this message.
* ''Direction'' - inbound to (I) or Outbound from (O) ''CALIDUS'' ePOD. For TomTom Device/Driver messages, this defaults to "Device".
* Filename - pattern to match to build a file for export, or to find for import file-based transfer types.
* ''Message Type'' - message-specific. For example, for ''TTM'' export type, this indicates the individual message types being sent.
* ''Export Job Types'' - message-specific. This indicates whether collections (C), deliveries (D) or services (S) are exported with this message.
* ''Filename'' - a pattern to match to build a file for export, or to find for import file-based transfer types.




== New Import/Export Configurations ==
== New Import/Export Configurations ==
The screen allows new configurations to be created, by pressing the provided '''New''' button at the top of the screen.
You can create new configurations by pressing the provided '''New''' button at the top of the screen.


[[File:EPOD-AutoExport4.PNG|border]]  
[[File:EPOD-AutoExport4.PNG|border]]  
<br />''New Import/Export Configuration Pop-up''<br />
<br />''New Import/Export Configuration Pop-up''<br />


The following details may be entered, depending on the type and message:
You can enter the following details, depending on the type and message:
* Config ID - The main configuration ID that will be attached to the Site or Job Group.
* ''Config ID'' - the main configuration ID that will be attached to the site or job group.
* Description - the description of the import/export being configured as part of the Config ID.
* ''Description'' - the description of the import/export being configured as part of the ''Config ID''.
* Type - the mechanism by which the document will be exported. Select one from a drop-down list of:
* ''Type'' - the mechanism by which the document will be exported. You can select one from a drop-down list of:
** FTP - flat-file export to FTP server
** ''FTP'' - flat-file export to FTP server.
** EMAIL - attachment to an Email
** ''EMAIL'' - attachment to an email.
** FILE - flat-file export to a local or shared directory
** ''FILE'' - flat-file export to a local or shared directory.
** SOAP/POST - delivery as the content of a web service request.
** ''SOAP''/''POST'' - delivery as the content of a web service request.
* ID - the Import/Export type. Standard configurations may be selected from a drop-down list of the following:
* ''ID'' - the Import/Export type. Standard configurations may be selected from a drop-down list of the following:
** JOB - standard OBS XML updates per job.
** ''JOB'' - standard OBS XML updates per job.
** LOAD - standard OBS XML Updates per Load - can include the Job information if required.
** ''LOAD'' - standard OBS XML Updates per load. This include the job information if required.
** POD/POD2 - Export of Completion Reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
** ''POD''/''POD2'' - export of completion reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
** TTM - Export of load, order and tracking information to ''CALIDUS'' Portal TTM.
** ''TTM'' - export of load, order and tracking information to ''CALIDUS'' Portal TTM.
** VEHICLECHECKS - Export of completed vehicle defect checks.
** ''VEHICLECHECKS'' - export of completed vehicle defect checks.
** JOBSWAP - Export of Job Swap information to Transport Management Systems (e.g. ''CALIDUS'' TMS).
** ''JOBSWAP'' - export of job swap information to transport management systems (e.g. ''CALIDUS'' TMS).
** PF/PALLEX/FORTRACK/TPN/GAP861/Palletline/HazChem - Pallet Network tracking system specific exports.
** ''PF''/''PALLEX''/''FORTRACK''/''TPN''/''GAP861''/''Palletline''/''HazChem'' - pallet network tracking system specific exports.
** TomTom Geocoder - service to geocode addresses.
** ''TomTom Geocoder'' - service to geocode addresses.
** TomTom WEBFLEET Order - service to export orders to TomTom WEBFLEET for tracking and execution.
** ''TomTom WEBFLEET Order'' - service to export orders to TomTom WEBFLEET for tracking and execution.
** TomTom WEBFLEET Order (Import) - service to import debrief information from TomTom WEBFLEET.  
** ''TomTom WEBFLEET Order (Import)'' - service to import debrief information from TomTom WEBFLEET.  
** TomTom Device/Driver - Device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
** ''TomTom Device/Driver'' - device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
** DiPS Orders - Import from DiPS route optimisation software.
** ''DiPS Orders'' - import from DiPS route optimisation software.
** PART - Bespoke Partnerlink JobShare Import.
** ''PART'' - bespoke Partnerlink JobShare import.
** EBB - Bespoke EBB Import
** ''EBB'' - bespoke EBB import.
* Destination - this depends on the export mechanism:
** ''Invoice'' - export of invoice information.
** FTP - FTP Server and directory in format 'ftp://server/directory'
** ''Here Geocoder'' - service to geocode addresses.
** FILE - directory in format 'X:\directory\' or '\\server\directory\'
* ''Destination'' - this depends on the export mechanism:
** SOAP/POST - web service address
** ''FTP'' - FTP Server and directory in format 'ftp://server/directory'.
* Parameter/Job Types - Collection, Delivery or Service type jobs can be included in the export.
** ''FILE'' - directory in format 'X:\directory\' or '\\server\directory\'.
* Format - for POD exports:  
** ''SOAP''/''POST'' - web service address.
** HTML - the native format of ''CALIDUS'' ePOD. Configured to fit on one A4 sheet where applicable. Pagination is included when printed.
* ''Parameter''/''Job Types'' - collection, delivery or service type jobs can be included in the export.
** Image
* ''Format'' - for POD exports:  
*** Types TIFF, JPEG or PNG, with TIFF compression enabled if required (ZIP or FAX)
** ''HTML'' - the native format of ''CALIDUS'' ePOD. This is configured to fit on one A4 sheet where applicable. Pagination is included when the report is printed.
** PDF - Converted automatically from the HTML for A4 paper. Pagination is supported.
** ''Image''
* Filename - file or attachment name. Can be made up of fixed and variable information:
*** Types ''TIFF'', ''JPEG'' or ''PNG'', with ''TIFF'' compression enabled if required (''ZIP'' or ''FAX'').
** ''PDF'' - the report is converted automatically from the HTML for A4 paper. Pagination is supported.
* ''Filename'' - file or attachment name. This can be made up of fixed and variable information:
** "date" - the current date, formatted as "YYYYMMDD".  
** "date" - the current date, formatted as "YYYYMMDD".  
** "time" - the current time, formatted as "HHMMSS".  
** "time" - the current time, formatted as "HHMMSS".  
Line 88: Line 92:
** Any field from the Job data. So, for example, if a tag <EPL_EXT_REF> is found, this will be replaced with the data value of EPOD_JOB.EPL_EXT_REF.  
** Any field from the Job data. So, for example, if a tag <EPL_EXT_REF> is found, this will be replaced with the data value of EPOD_JOB.EPL_EXT_REF.  


For Email export, the file is exported to the customer email address and one other optional email address (a Site or central email address). This mechanism requires a connection to the customer email server from the ''CALIDUS'' ePOD server.
For email export, the file is exported to the customer email address and one other optional email address (a Site or central email address). This mechanism requires a connection to the customer email server from the ''CALIDUS'' ePOD server.


For SOAP exports, the following parameters may also be entered:
For SOAP exports, you can also enter the following parameters:
* Parameter
* ''Parameter''.
* User Name
* ''User Name''.
* Password
* ''Password''.
* Action
* ''Action''.
* Operation
* ''Operation''.
* Namespace
* ''Namespace''.
* NS Prefix
* ''NS Prefix''.
These are usually specific to the webservice method.


For FTP and POST exports, the following parameters may also be entered:
For FTP and POST exports, the following parameters may also be entered:
* Parameter
* ''Parameter''.
* User Name
* ''User Name''.
* Password
* ''Password''.
 
When changes are complete, you can click '''Save''' to save the changes, or '''Close''' to close the pop-up without saving the changes.


A '''Save''' button is provided to save the entered data. Clicking '''Close''' will discard the new configuration.


== View/Edit Import/Export Configurations ==
== View/Edit Import/Export Configurations ==
The configurations can be viewed and edited by clicking the '''Select''' button against the line in the table. The screen will display a pop-up showing all the details of the configuration.
You can view or edit configurations by clicking the '''Select''' action button against the line in the table. The screen will display a pop-up showing all the details of the configuration.


[[File:EPOD-AutoExport3.PNG|border]]  
[[File:EPOD-AutoExport3.PNG|border]]  
<br />''View/Edit Import/Export Configurations Pop-up''<br />
<br />''View/Edit Import/Export Configurations Pop-up''<br />


The configuration may be edited by clicking the provided '''Edit''' button.
You can edit the configuration by clicking the provided '''Edit''' button.




Line 118: Line 124:




A '''Save''' button is provided to save the edited values.
When changes are complete, you can click '''Save''' to save the changes. If you don't want to save your changes, you can click '''Cancel''' to stop editing, or '''Close''' to close the pop-up without saving the changes.
 
A '''Delete''' button is provided to delete the configuration.


Changes may be discarded by clicking the '''Close''' button.
You can click the '''Delete''' button to delete the configuration - the screen will ask you to confirm before the configuration is deleted.




[[Category:UG 291094 EPOD Admin User Guide|400_150]]
[[Category:UG 291094 EPOD Admin User Guide|400_150]]

Revision as of 15:53, 4 April 2019

This screen allows you to create, delete and amend import and export parameters. These are held against a configuration ID that you can attached to a site or job groups through the appropriate maintenance screen. You can configure multiple different types of imports and exports under the same config ID. If you configure export on the system, the process will import and export based on the configurations attached to the site or job group.

You can filter data by:

  • Config ID.
  • Description.
  • Type - a drop-down list of the different import/export transfer types (for example, FTP, SOAP, etc).
  • ID - the export type (for example, JOB, LOAD, TPN, TTM, etc).
  • Direction - a drop-down list. You can choose Inbound, Outbound, All or Device to see interfaces designed to be used by the mobile device only.

Once you have entered the criteria, click Search. The screen will display a table of all the matching data. Any plain text boxes will match data that contains what you enter as the criterion.

EPOD-AutoExport1.PNG
Import/Export Configurations Search Panel and Results table

The results table will display a single line per configuration found.

The results table shows the following columns:

  • Config ID - the main configuration ID that will be attached to the site or job group.
  • Description - the description of the import/export being configured as part of the Config ID.
  • Type - the transfer type (e.g. Email, File, SOAP, etc).
  • ID - the import/export type. Standard configurations are one of the following:
    • JOB - standard OBS XML updates per job.
    • LOAD - standard OBS XML Updates per load. This include the job information if required.
    • POD/POD2 - export of completion reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
    • TTM - export of load, order and tracking information to CALIDUS Portal TTM.
    • VEHICLECHECKS - export of completed vehicle defect checks.
    • JOBSWAP - export of job swap information to transport management systems (e.g. CALIDUS TMS).
    • PF/PALLEX/FORTRACK/TPN/GAP861/Palletline/HazChem - pallet network tracking system specific exports.
    • TomTom Geocoder - service to geocode addresses.
    • TomTom WEBFLEET Order - service to export orders to TomTom WEBFLEET for tracking and execution.
    • TomTom WEBFLEET Order (Import) - service to import debrief information from TomTom WEBFLEET.
    • TomTom Device/Driver - device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
    • DiPS Orders - import from DiPS route optimisation software.
    • PART - bespoke Partnerlink JobShare import.
    • EBB - bespoke EBB import.
    • Invoice - export of invoice information.
    • Here Geocoder - service to geocode addresses.
  • Destination - a folder or network specification for file- or FTP-based transfers.
  • Direction - inbound to (I) or Outbound from (O) CALIDUS ePOD. For TomTom Device/Driver messages, this defaults to "Device".
  • Message Type - message-specific. For example, for TTM export type, this indicates the individual message types being sent.
  • Export Job Types - message-specific. This indicates whether collections (C), deliveries (D) or services (S) are exported with this message.
  • Filename - a pattern to match to build a file for export, or to find for import file-based transfer types.


New Import/Export Configurations

You can create new configurations by pressing the provided New button at the top of the screen.

EPOD-AutoExport4.PNG
New Import/Export Configuration Pop-up

You can enter the following details, depending on the type and message:

  • Config ID - the main configuration ID that will be attached to the site or job group.
  • Description - the description of the import/export being configured as part of the Config ID.
  • Type - the mechanism by which the document will be exported. You can select one from a drop-down list of:
    • FTP - flat-file export to FTP server.
    • EMAIL - attachment to an email.
    • FILE - flat-file export to a local or shared directory.
    • SOAP/POST - delivery as the content of a web service request.
  • ID - the Import/Export type. Standard configurations may be selected from a drop-down list of the following:
    • JOB - standard OBS XML updates per job.
    • LOAD - standard OBS XML Updates per load. This include the job information if required.
    • POD/POD2 - export of completion reports (i.e. POD, POC, Service Report) to external systems (usually document management systems).
    • TTM - export of load, order and tracking information to CALIDUS Portal TTM.
    • VEHICLECHECKS - export of completed vehicle defect checks.
    • JOBSWAP - export of job swap information to transport management systems (e.g. CALIDUS TMS).
    • PF/PALLEX/FORTRACK/TPN/GAP861/Palletline/HazChem - pallet network tracking system specific exports.
    • TomTom Geocoder - service to geocode addresses.
    • TomTom WEBFLEET Order - service to export orders to TomTom WEBFLEET for tracking and execution.
    • TomTom WEBFLEET Order (Import) - service to import debrief information from TomTom WEBFLEET.
    • TomTom Device/Driver - device-specific settings to determine logon information from connected TomTom WEBFLEET systems.
    • DiPS Orders - import from DiPS route optimisation software.
    • PART - bespoke Partnerlink JobShare import.
    • EBB - bespoke EBB import.
    • Invoice - export of invoice information.
    • Here Geocoder - service to geocode addresses.
  • Destination - this depends on the export mechanism:
    • FTP - FTP Server and directory in format 'ftp://server/directory'.
    • FILE - directory in format 'X:\directory\' or '\\server\directory\'.
    • SOAP/POST - web service address.
  • Parameter/Job Types - collection, delivery or service type jobs can be included in the export.
  • Format - for POD exports:
    • HTML - the native format of CALIDUS ePOD. This is configured to fit on one A4 sheet where applicable. Pagination is included when the report is printed.
    • Image
      • Types TIFF, JPEG or PNG, with TIFF compression enabled if required (ZIP or FAX).
    • PDF - the report is converted automatically from the HTML for A4 paper. Pagination is supported.
  • Filename - file or attachment name. This can be made up of fixed and variable information:
    • "date" - the current date, formatted as "YYYYMMDD".
    • "time" - the current time, formatted as "HHMMSS".
    • "uid" - a unique sequence per file per run, formatted as "0000".
    • Any field from the Job data. So, for example, if a tag <EPL_EXT_REF> is found, this will be replaced with the data value of EPOD_JOB.EPL_EXT_REF.

For email export, the file is exported to the customer email address and one other optional email address (a Site or central email address). This mechanism requires a connection to the customer email server from the CALIDUS ePOD server.

For SOAP exports, you can also enter the following parameters:

  • Parameter.
  • User Name.
  • Password.
  • Action.
  • Operation.
  • Namespace.
  • NS Prefix.

These are usually specific to the webservice method.

For FTP and POST exports, the following parameters may also be entered:

  • Parameter.
  • User Name.
  • Password.

When changes are complete, you can click Save to save the changes, or Close to close the pop-up without saving the changes.


View/Edit Import/Export Configurations

You can view or edit configurations by clicking the Select action button against the line in the table. The screen will display a pop-up showing all the details of the configuration.

EPOD-AutoExport3.PNG
View/Edit Import/Export Configurations Pop-up

You can edit the configuration by clicking the provided Edit button.


The same fields may be edited here as when entering a new configuration, bar the Config ID.


When changes are complete, you can click Save to save the changes. If you don't want to save your changes, you can click Cancel to stop editing, or Close to close the pop-up without saving the changes.

You can click the Delete button to delete the configuration - the screen will ask you to confirm before the configuration is deleted.