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 format;

  • A worksheet (or a tab) in an Excel file;

  • A database table of 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 Planning > Export or Import block, then:

  • Export events > Click on the right arrow > select context;

  • Import events > Click on the right arrow > select context;

  • Resources export > Click on the right arrow > select context;

  • Import resources > Click on the right arrow > select context.

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

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 > Export events > Select the context;

  • Or, Right click on a selection of resources > > Select the context.

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

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 > Import resources > Select the context;

  • Right click on a selection of events > Import events > Select the context.

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

Click on Yes to start the import.

Important

This functionality is only available for an update import.

Export report

When an export is completed, 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 incorrect

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

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

Import report

When an import is completed, 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 incorrect

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

You should then attempt to restart an 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:

No correspondence defined

If no correspondence is defined, the following message appears:

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 operation is used to trigger, based upon a pre-defined frequency, an import of the data into VISUAL PLANNING.

This functionality only covers:

  • Import of Resources,

  • Import of Events.

This functionality allows one to regularly and effectively implement 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
Configuration of import service

To configure the triggering of the import by service function, in General settings > Imports/exports > Click on the import context for resources or events.

The corresponding part is then enabled:

To find out more about these characteristics, see Resource import or Event import.

The following characteristics only involve the triggering by service context.

Activated

This checkbox allows the user to activate or deactivate the services for the import context in question.

Triggers

The triggers are used to define:

  • the import frequency,

  • the source file (for imports from a file),

  • Actions to be applied to the file after treatment (for imports from a file).

By clicking on the button

The following window opens:

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

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

This signifies that one can trigger the launch of an import 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 include the time,

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

  • If the frequency has been defined as being Every month at, then you must include the day, month and time.

File

For imports from an Excel file or a CSV, 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 in order to define the treatments to be applied to the imported file, after completion of the import.

  • Deletion: Definitively deletes the file imported.

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

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

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 planning > Activate import/export service) See Planner management

  4. The import/export services for the application must be activated: See Services management

Export by service

DEFINITION

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

This functionality only covers:

  • The export of resources,

  • The export of events.

This functionality allows one to regularly and effectively implement 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 function, in General settings > Imports/exports > Click on the export context for resources or events.

The corresponding part is then enabled:

To find out more about these characteristics, see Resource export or Events export

The following characteristics only involve the triggering by service context.

Activated

This checkbox allows the user 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).

By clicking on the button

The following window opens:

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

To add a new export 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 include the time,

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

  • If the frequency has been defined as being Every month at, then you must include the day, month and time.

File

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

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

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 planning > Activate import/export service) See Planner management

  4. The import/export services for the application must be activated: See Services management

Automatic

DEFINITION

The automatic imports and exports are a method of triggering imports and exports which occurs during the creation and/or modification of 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.

URL

DEFINITION

This functionality, unique to VISUAL PLANNING ENTERPRISE, is used to trigger, outside of VISUAL PLANNING, the creation 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 box Call via “URL”.

OBTAINING THE URL

To get the URL triggering the import/export context for resources or events, right click on the name of the context > 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.

EXPORTS VIA URL

It is also possible to complete exports using a URL, specifically built along the following syntax.

Simple URL
For resources

SERVER_IP/resourceexport.do?PLANNING=nom_planningand EXPORT=nom_contexte

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the export context.
For events

SERVER_IP/eventexport.do?PLANNING=nom_planningand EXPORT=nom_contexte

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the export context.
URL with named variables

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

All existing blank spaces in the planning 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 export context.

For resources

SERVER_IP/resourceexport.do?PLANNING=nom_planningand EXPORT=nom_contexteandNOM_DE_LA_VARIABLE_1=valeur1andNOM_DE_LA_VARIABLE_N=valeurN

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the export context,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N represent the name of the variable defined by a filter,
  • valeur1 and valeurN represent the value taken by the named variable.
For events

SERVER_IP/eventexport.do?PLANNING=nom_planningand EXPORT=nom_contexteandNOM_DE_LA_VARIABLE_1=valeur1andNOM_DE_LA_VARIABLE_N=valeurN

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the export context,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N represent the name of the variable defined by a filter,
  • valeur1 and valeurN represent the value taken by the named variable.

IMPORTS VIA URL

It is also possible to complete imports using a URL, specifically built along the following syntax.

Simple URL
For resources

SERVER_IP/resourceimport.do?PLANNING=nom_planningand IMPORT=nom_contexteand FILE=adresse_fichier

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the import context,
  • adresse_fichier represents the address for access to the file on the VISUAL PLANNING server, the name of which as well as its extension.
For events

SERVER_IP/eventimport.do?PLANNING=nom_planningand IMPORT=nom_contexteand FILE=adresse_fichier

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the import context,
  • adresse_fichier represents the address for access to the file on the VISUAL PLANNING server, the name of which as well as 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 planning 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/resourceimport.do?PLANNING=nom_planningand IMPORT=nom_contexteandNOM_DE_LA_VARIABLE_1=valeur1andNOM_DE_LA_VARIABLE_N=valeurN

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the import context,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N represent the name of the variable defined by a filter,
  • valeur1 and valeurN represent the value taken by the named variable.
For events

SERVER_IP/eventimport.do?PLANNING=nom_planningand IMPORT=nom_contexteandNOM_DE_LA_VARIABLE_1=valeur1andNOM_DE_LA_VARIABLE_N=valeurN

Where:

  • SERVER_IP is the URL giving access to the VISUAL PLANNING server, without the final /index.jsp,
  • nom_planning is the name of the schedule in question,
  • nom_contexte​ is the name of the import context,
  • NOM_DE_LA_VARIABLE_1 et NOM_DE_LA_VARIABLE_N represent the name of the variable defined by a filter,
  • valeur1 and valeurN 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 FTP or WebDAV protocols are only possible using CSV or EXCEL files 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 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/monfichier.csv

or FTPS://bla/blablabla/monfichier.csv if using an SSL certificate

Example for WebDAV:

webdav://bla/blablabla/monfichier.csv

or webdavs://bla/blablabla/monfichier.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 context 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

Resources export

with or without

Import of resources

Exporting events

with or without

Importing events

Import of resources

with or without

Importing events

Importing events

with or without

None

PREREQUISITES

This type of trigger only operated with database-type import/export contexts.

CONFIGURATION

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

The trigger for the second context is configured in the Definitions 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.

ghostghostghostghostghost
loading table of contents...