Import/Export triggers

 

The triggers are used to launch import and export contexts of resources or events.

PREREQUISITES

 

Manual triggering is only possible with the VISUAL PLANNING ONE version.

All other triggers require VISUAL PLANNING ENTERPRISE.

LIST OF TRIGGERS

 

There are various types of trigger for imports/exports:

 

Manual

 

DEFINITION

Manual imports or exports allow users to manually trigger an import or export context for resources or events.

A manual export may function using:

  • A CSV file,
  • An Excel file worksheet (or tab),
  • An XML file,
  • Specific values,
  • A database table in one of the following formats:
    • MSAccess,
    • MYSQL,
    • Oracle,
    • SQL Server,
    • PostgreSQL,
    • or MariaDB.

USE

Triggering a context

To manually trigger an import or export context, go to Schedule > Export or Import, then:

  • Export events > Click on the drop-down arrow > select the context;
  • Import events > Click on the drop-down arrow > select the context;
  • Export resources > Click on the drop-down arrow > select the context;
  • Import resources > Click on the drop-down arrow > select the context.
triggering_context

A window, similar to the following, will then appear:

window_export_events

Click on Yes to start the import or export.

Exporting a selection

It is possible to export a selection of resource or events using a pre-defined context.

To do this:

  • Right-click on a selection of events > Exchange/Distribute > Export events > Select the context;

  • or Right-click on a selection of resources > Exchange/Distribute > Export resources > Select the context.

A window, similar to the following, will then appear:

window_export_events

Click on Yes to start the export.

Caution

Only the selected resources or events which belong within the filter defined in the context will be exported.

Importing a selection

It is possible to trigger an import of resources or events from a selection.

To do this:

  • Right-click on a selection of resources > Exchange/Distribute > Import resources > Select the context;

  • Right-click on a selection of events > Exchange/Distribute > Import events > Select the context.

A window, similar to the following, will then appear:

window_import_events

Click on Yes to start the import.

Important

This functionality is only available for an update import.

Export report

Once the export has finished, the Export report window will appear to display a summary of the operation.

 

Export correct

When the export is completed, the report gives the number of data items exported and, if this is followed by an import, the number of data items imported.

export_correct
Export incorrect

If the export parameters do not allow the export to continue, the following message appears:

export_incorrect

You should then attempt to restart the export with the correct parameters until an Export Correct message appears.

 

Import report

Once the import has finished, the Import report window will appear to display a summary of the operation.

 

Import correct

If the import settings have been correctly completed, a message of this type will appear:

import_correct
Import incorrect

If the import parameters do not allow the import to continue, the following message appears:

export_incorrect

You should then attempt to restart the import with the correct parameters until an Import Correct message appears. (See above)

 

No resource defined

The existence of events and, implicitly, the importation of events, requires a minimum of one resource, to attach the imported events to.

If no resource is defined in the import context, the following message appears:

import_export_no_resource
No correspondence defined

If no correspondence is defined, the following message appears:

import_export_no_correspondence

Service

In this case the import/export context is triggered by service at a pre-defined frequency.

 

Import by service

DEFINITION

An Import by service is used to trigger, based on a pre-defined frequency, an import of the data in VISUAL PLANNING.

This section exclusively concerns the following:

  • Import of Resources,

  • Import of Events.

This functionality can thus be used to regularly implement, when appropriate, the pre-defined and pre-configured import contexts.

This service functions regardless of whether the source is:

  • a CSV file,

  • an Excel file,

  • or a database.

PREREQUISITES
Technical prerequisites

This functionality is only available with VISUAL PLANNING ENTERPRISE.

The import/export function must have been started before the automatic imports are triggered.

 

Functional prerequisite

The “import by service” requires:

  • The preparation of the file or database source,

  • The definition of an import context.

CONFIGURATION

 

Import service settings

 

To configure the import by service, in the Settings menu > Imports/exports > Click on the resources or events import context.

The corresponding part is then enabled:

import_ressource_contexte

To find out more about these characteristics, see Importing resources or Importing events

The following characteristics only involve the triggering by service of the context.

 

Activated

This button allows the user to activate or deactivate the service for the import context in question.

 

Triggers

The triggers are used to define:

  • the import frequency,
  • the source file (for imports from a file),
  • the actions to be applied to the file after processing (for imports from a file).

Click on the bouton-crayon button

The following window opens:

 

import_service_trigger

This window is used to define the list of import context services.

To add a new import by service, click on the Add button.

This means that you can trigger the launch of the same import context as many times as necessary, without having to define multiple contexts.

 

Frequency

You can identify two types of frequency:

  • Every day at a defined time;

  • Every dd at a defined time (e.g. every Monday);

  • Every X minutes;

  • Every month, on the.

 

Information
  • If the frequency has been defined as being Every day at, then you must indicate the Time,

  • If the frequency has been defined as being Every X minutes, then you must indicate the number of minutes,

  • If the frequency has been defined as being Every month, on the, then you must indicate the day of the month and the time.

 

File

For imports from an Excel or CSV file, you must define the address of the file used by the service.

As opposed to the path defined for imports, this file must be accessible from the server.

 

Actions

Finally, define the processing to be applied to the imported file after completion of the import.

  • Delete: Definitively deletes the file imported.

  • Archive: Renames the imported file using the extension .yyyyMMddHHmmss (e.g. import file.20180404165412.csv),

  • None: No processing will be applied to the imported file.

 

Reporting activated

This button is used to send a report, by e-mail, of the results of each import trigger.

Warning

Prerequisites: The SMTP server must be configured as these are automatic e-mails.
See Automatic sending of e-mail

Sender

Define the e-mail address to be used as the sender for the reporting by e-mail.

This parameter is only active and necessary when the Reporting activated checkbox is checked.

 

Recipients

Define the address(es) to be informed during the reporting by mail.

This parameter is only active and necessary when the Reporting activated checkbox is checked.

 

USE

The import, by service, of the data into VISUAL PLANNING, does not require a specific use.

The end user will see that the data has been modified without any further manipulation, transparently.

The log of the stored event or resource uses the name of the context as a user name.

To assure that the service functions, the following elements must be activated.

These actions must be undertaken by an administrator:

  • 1) The VISUAL PLANNING server must be running,
  • 2) The “by service” trigger of the import or export context must be activated,
  • 3) The import/export services of the schedule must be activated (Admin Center > Right-click on the schedule > Activate import/export service) See Schedule management
  • 4) The import/export services for the application must be activated: See Services management

Export by service

DEFINITION

An Export by service is used to trigger, at a pre-defined frequency, an export of the data from VISUAL PLANNING.

This section exclusively concerns the following:

  • The export of resources,

  • The export of events.

This functionality can thus be used to regularly implement, when appropriate, the pre-defined and pre-configured export contexts.

This works whether the destination is:

  • a CSV file,

  • an Excel file,

  • an XML file,

  • or a Database.

 

PREREQUISITES

Technical prerequisites

This functionality is only available with VISUAL PLANNING ENTERPRISE.

The import/export function must have been started before the automatic imports are triggered.

 

Functional prerequisite

The “export by service” requires:

  • The preparation of the file or database destination,

  • The definition of an export context.

CONFIGURATION

Export trigger parameters

To configure the triggering of the export by service, go to Global Settings > Imports/exports > Click on the resources or events export context.

The corresponding part is then enabled:

export_event_context

To find out more about these characteristics, see Exporting resources or Exporting events

The following characteristics only involve the triggering by service of the context.

Enabled

This button is used to activate or deactivate the services for the export context in question.

 

Triggers

The triggers are used to define:

  • the export frequency,
  • the destination file (exports to a file).

Click on the bouton-crayon button

The following window opens:

 

export_service_trigger

This window gives a definition of the list of export context services.

To add a new import by service, click on the Add button.

This signifies that one can trigger the launch of an export context as often as required, without having to define multiple contexts.

 

Frequency

We can identify two types of frequency:

  • Every day at a defined time;
  • Every dd at a defined time (E.g.: every Monday);
  • Every X minutes;
  • Every month, on the.

 

Information
  • If the frequency has been defined as being Every day at, then you must indicate the Time,
  • If the frequency has been defined as being Every X minutes, then you must indicate the number of minutes,
  • If the frequency has been defined as being Every month, on the, then you must indicate the day of the month and the time.
File

For exports to an Excel or CSV file, you must define the address of the file used by the service.

The destination directory must be accessible from the server.

Timestamp

If this box is checked, the export file name will include the date on which the export was performed.

 

USE

The export, by service, of the data in VISUAL PLANNING, does not require a specific use.

In this case the user does not see the data export. The export is transparent.

To assure that the service functions, the following elements must be activated.

These actions must be undertaken by an administrator:

  1. The VISUAL PLANNING server must be running.
  2. The “by service” trigger of the import or export context must be activated,
  3. The import/export services of the schedule must be activated (Admin Center > Right-click on the schedule > Activate import/export service) See Schedule management
  4. The import/export services for the application must be activated: See Services management

Automatic

DEFINITION

Automatic imports and exports are an import and export activation mode that must be carried out when creating and/or modifying an event or a resource.

The possible choices are as follows:

  • The creation/modification of an event triggers the export of this event,

  • The creation/modification of an event triggers an import for the updating of this event,

  • The creation/modification of an event triggers the export of one of the resources for this event,

  • The creation/modification of an event triggers an import for the updating of one of the resources for this event,

  • The creation/modification of an event triggers the export of this resource,

  • The creation/modification of an event triggers an import for the updating of this resource.

USE

The use is transparent to the user as the import or export takes place during the creation or modification of resources or events in the schedule.

To activate automatic imports and exports, check the corresponding criteria in the context.

export_import_activated_automatic

URL

DEFINITION

This functionality is used to trigger, outside VISUAL PLANNING, the implementation of an import/export context for a schedule.

In this case the import/export context is triggered by a URL.

 

ACTIVATION OF THE URL

To activate the triggering of an import or export using a URL, the option must be activated in the import/export context, by clicking the “URL” call option.

import_export_url_call
OBTAINING THE URL

To obtain the URL triggering the import/export context for resources or events, right-click on the name of the context > Display URL.

import_export_display_url

The following window will open and display a URL used to trigger the import or export.

Simply copy this URL and use when required.

import_export_url

EXPORTS VIA URL

It is also possible to perform exports using a specific URL built based on the following syntax.

 

Simple URL

For resources

SERVER_IP/resourceexport.do?SCHEDULE=schedule_name&EXPORT=context_name

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the export context.
For events

SERVER_IP/eventexport.do?SCHEDULE=schedule_name&EXPORT=context_name

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the export context.
URL with named variables

When the URL contains a named variable, defined in a filter, the export context will lead to the export of the events or resources, defined by a resource filter or an events filter and named by the variable.

All existing blank spaces in the schedule name, the name of the export context or the values in the variable must be transformed into a “space” character “ “ or “_” , or “+” or even “%20”.

The response is the result of the export context.

 

For resources

SERVER_IP/resourceexport.do?PLANNING=schedule_name&EXPORT=context_name&NAME_OF_VARIABLE_1=value1&NAME_OF_VARIABLE_N=valueN

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the export context.
  • NAME_OF_VARIABLE_1 and NAME_OF_VARIABLE_N represent the name of the variable defined in a filter,
  • value1 and valueN represent the value taken by the named variable.
For events

SERVER_IP/eventexport.do?SCHEDULE=schedule_name&EXPORT=context_name&NAME_OF_VARIABLE_1=value1&NAME_OF_VARIABLE_N=valueN

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the export context.
  • NAME_OF_VARIABLE_1 and NAME_OF_VARIABLE_N represent the name of the variable defined in a filter,
  • value1 and valueN represent the value taken by the named variable.

IMPORTS VIA URL

It is also possible to perform imports using a specific URL built based on the following syntax.

 

Simple URL

For resources

SERVER_IP/resourceimport.do?SCHEDULE=schedule_name&IMPORT=context_name&FILE=file_address

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the import context,
  • file_name represents the address to the file on the VISUAL PLANNING server, its name and its extension.
For events

SERVER_IP/eventimport.do?SCHEDULE=schedule_name&IMPORT=context_name&FILE=file_address

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the import context,
  • file_name represents the address to the file on the VISUAL PLANNING server, its name and its extension.
URL with named variables

When the URL contains a named variable, defined in the filter, the import context will import the events or resources defined by the resource filter or events filter and nominated by the variable.

All existing blank spaces in the schedule name, the name of the export context or the values in the variable must be transformed into a “space” character “ “ or “_” , or “+” or even “%20”.

The response is the result for the import context.

 

For resources

SERVER_IP/resourceexport.do?SCHEDULE=schedule_name&IMPORT=context_name&NAME_OF_VARIABLE_1=value1&NAME_OF_VARIABLE_N=valueN

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the import context,
  • NAME_OF_VARIABLE_1 and NAME_OF_VARIABLE_N represent the name of the variable defined in a filter,
  • value1 and valueN represent the value taken by the named variable.
For events

SERVER_IP/eventimport.do?SCHEDULE=schedule_name&IMPORT=context_name&NAME_OF_VARIABLE_1=value1&NAME_OF_VARIABLE_N=valueN

Where:

  • SERVER_IP is the URL to the VISUAL PLANNING server, without the final /index.jsp,
  • schedule_name is the name of the schedule in question,
  • context_name is the name of the import context,
  • NAME_OF_VARIABLE_1 and NAME_OF_VARIABLE_N represent the name of the variable defined in a filter,
  • value1 and valueN represent the value taken by the named variable.

FTP and WebDAV

DEFINITION

WebDAV is an extension to the HTTP protocol, used to simplify the management of files using remote servers.

FTP is a File Transfer Procedure involving remote servers.

 

PREREQUISITES

The import/export using the FTP or WebDAV protocols is only possible using CSV or EXCEL file types.

You need an FTP and/or WebDAV server, depending on the protocol used.

 

CONFIGURATION

When defining an import/export context for the resources or events, the Path parameter must be completed as follows:

  • Click on the bouton-crayon button.
  • Enter the FTP or WebDAV link to the file, by entering the user.

Note

The server name and password are defined from within Admin Center (See Configuration for external access).

Example for FTP:

FTP://bla/blablabla/myfile.csv

or ftps://bla/blablabla/myfile.csv if using an SSL certificate

Example for WebDAV:

webdav://bla/blablabla/myfile.csv

or webdavs://bla/blablabla/myfile.csv if using an SSL certificate

Note

The username and password are provided by the client.

The SSL certificate is installed on the JAVA VM used by the VISUAL PLANNING server

FUNCTIONALITIES

The post-processing functionalities cannot be used via the HTTP protocol as it renders it impossible to manipulate the source files.

Here is a table clarifying these notions:

 

Functionality

Local folder

HTTP protocol

WebDAV protocol

FTP protocol

Export

Yes

No

Yes

Yes

File processing after import (deletion/archiving)

Yes

No

Yes

Yes

 

Chains

 

DEFINITION

The import/export contexts may be triggered by the completion of another context, potentially using a stored procedure.

The following options are available:

 

Initial context

Stored procedure

Context triggered next

Exporting resources

with or without

Importing resources

Exporting events

with or without

Importing events

Importing resources

with or without

Importing events

Importing events

with or without

None

 

PREREQUISITES

This type of trigger only operates with import/export contexts via database.

 

CONFIGURATION

The configuration of import or export contexts must be completed in advance.

The trigger for the second context is configured in the Definition tab of the first context.

 

USE

The use is as transparent as possible for the user in terms of the triggering of the initial context.

 

Import of an export or export of an import

 

In this case, the import or export context is triggered by its use as a source or destination of another context.

IMPORT OF AN EXPORT

Definition

The source of an import context for resources or events can be a URL.

It may be:

  • a URL generated by another application,
  • a URL trigger of an export context in the same schedule,
  • a URL trigger of an export context in another schedule.

You can thus use an Export as the source of an Import.

 

Configuration

In the definition of the import context, you must define the source path:

  • Either by entering the export URL,

  • or by entering EXPORT=Export_Context_Name.

In this case, the data is not generated by in a file or table; it passes via the import flow.

 

EXPORT OF AN IMPORT

Definition

The destination of an export context for resources or events can be a URL.

It may be:

  • a URL generated by another application,
  • a URL trigger of an import context in the same schedule,
  • a URL trigger of an import context in another schedule.

You can thus use an Import as the destination of an Export.

 

Configuration

In the definition of the export context, you must define the destination path:

  • Either by entering the import URL,

  • or by entering IMPORT=Import_Context_Name.

In this case, the data is not generated by in a file or table; it passes via the export flow.

Print Friendly, PDF & Email
1 Etoile2 Etoiles3 Etoiles4 Etoiles5 Etoiles (3 votes, average : 5.00 on 5)
Loading...
Consulting training

Need training?

Use our consulting services!