Export Events : configuration

 

The import contexts must be saved before triggering them.

A new export context is created via the Global Settings pane > Right-click on Events export > Create an events export context.

The bottom heading is then enabled:

export_event_context

Now enter the various characteristics, then click on:

  • OK to save the context,
  • Restore otherwise.

These characteristics are as follows:

 

Name

Give this import context a name.

If the multi-language management is activated in the Admin center, it will be possible to fill in a name for this dexport in the proposed languages by clicking on the v7_adm_en_parametres_generaux_symbole_multilangue button.

Note

Name of the export in french Export des réservations
Name of the export in english Booking export
What is seen in a FR desktop Export des réservations
What is seen in a EN desktop Booking export

 

Description

Give a description of this context. This data is optional.

 

History

This represents the creation date and time and the most recent change to the context, together with the login of the user who implemented the actions.

This characteristic cannot be edited.

 

Definition

This is a definition of this context.

Mark the treatment

If enabled, this button is used to save the date, time and login details of the user who exported the event.

 

URL “call”

The activation of this option authorizes the triggering of this context using a URL from outside of VISUAL PLANNING.

 

Use authentication

The activation of this option is used to protect the URL using Basic Access Authentication.

 

Login

Define the identity (login) for the URL if authentication has been activated.

 

Password

Define the password for the URL if authentication has been activated.

 

Event creation/modification

This button is used to activate the triggering of the context during the creation and/or modification of events.

Caution

It cannot be activated for files on the disk or for a database.

Activated

This button is used to activate the export by service trigger.

 

Triggers

This option is used to define the triggers for an export by service.

 

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 sender for the reporting by mail.

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

 

Recipients

Define the address(es) the reporting by mail is to be sent to.

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

Definition of the export context

 

Destination tab

export_event_destination_tab

The unique export destination can be of the type:

 

  • Database,
  • XML file,
  • Excel file,
  • CSV file.

Standard format

Case with *.CSV files
export_event_csv_destination

You must define the following parameters:

 

Type

In this case, the value should be CSV file.

 

Separator

The separator in the destination file can be:

  • Semicolon,
  • Full stop,
  • Space,
  • Comma,
  • Tab,
  • or Vertical Bar.

 

Encoding

The type of encoding is to be chosen to match the OS used on the server:

  • Default (System encoding): the encoding used by the client machine,
  • UTF8: encoding used for Anglophone OS (Windows, Unix),
  • Windows-1252 (European standard)

 

Path

Specify the access path, which may contain:

  • A destination file of the type CSV. If the file does not exist it will be created during the export,
  • A URL-type address,
  • A standard text of the type Import=Import_Context_Name used to import exports.
Case with Excel files
export_event_excel_destination

You must define the following parameters:

 

Type

In this case, the value must be Excel file.

 

Path

Define the path to the file in *.XLS or *.XLSX format.

 

Worksheet.

Define the worksheet of the source file to be imported.

For XML files
export_event_xml_destination

You must define the following parameters:

 

Type

In this case the value should be XML file.

 

Path

Define the path to the file in the format *.XML.

Case with Database

If the export is to a database, you must choose the Database type.

export_event_database_destination

You must define the following parameters:

 

Type

Specify the DBMS technology used:

  • MSAccess,

  • MySQL,

  • Oracle,

  • SQL Server,

  • PostgreSQL,

  • or MariaDB.

 

Connection settings

Connection settings differ depending on the type of DBMS chosen. By clicking on Connection settings, a new window is displayed:

 

MS Access MySQL, SQLServer, PostgreSQL, MariaDB ORACLE
SID
Password
Path
Port
Server
Login
export_event_access_settings
export_event_mysql_settings
export_event_oracle_settings

 

To validate these settings, click on:

  • OK,
  • or Cancel to go backwards.

Database

Define the name of the database to be used for the export.

 

Table

Choose the table or view to be imported.

This list is empty until the database has been identified.

 

Add if no match

Warning

This parameter is useful and can be accessed for an export to a database (other than MSAccess).

For an export to a table, by default the export involves the insertion of new data.

If enabled, this button serves to check whether the data already exists in the destination database, and to only create it if it doesn’t.

The key used used for this verification is defined in the Correspondence tab.

 

Remove HTML from multi-line fields

This button, if enabled, will remove HTML tags from rich text when exporting.

 

Date format

Choose one of the date formats.

  • dd/MM/yyyy,
  • yyyy-MM-dd,
  • MM/dd/yyyy,
  • or dd.MM.yyyy.

 

Filter

It is possible to restrict the export to certain events.

To do this, simply select an events filter.

 

Period

It is also possible to select a period of time during which is found the events to be exported.

 

Type of intersection

Finally, it is possible to select the intersection between events and a time period, from the following choices:

  • Intersects with period,
  • Covers the period,
  • Entirely within the period,
  • Starts within the period,
  • Ends within the period.

 

Stored procedure

Warning

This parameter is useful and can be accessed for an export to a database (other than MSAccess).

The name of the stored procedure should be defined.

Stored procedures should only have the following two parameters:

  • operational retcode OUT and type INTEGER: must take the value 0 if successful,
  • operational message OUT and type VARCHAR: must contain an explicative text, made available to the user.

 

Import context to follow

This is used to launch another import context once the stored procedure has been run.

The user should choose an import context from those listed.

The list of proposed imports are of the type:

  • Database,
  • URL.

Correspondence tab

 

This tab is used to produce a correspondence between the source, which is the events of the schedule and the destination which may be a file, a worksheet or a table.

This correspondence is defined on a field by field basis.

export_event_correspondence_tab

The table, which contains several columns, should be completed:

Property

This column contains the names of the fields and attributes chosen for export.

By clicking on bouton-plus, it is possible to export:

  • The general and temporal properties of the events,
  • Each heading of the dimension,
  • The name of each resource in the form of its identification headings,
  • Several headings at once if you click on (Select all attributes). This is useful when a large number of headings are involved in the export,
  • Each heading in each form,
  • The fixed value, unit value and coefficient of each valuation item,
  • The internal identifier (UID) for the events.

Warning

Concerning calculated heading types, only daily heading types can be exported.

Destination

For each heading or property to be exported, select the corresponding destination field. If no destination is entered, the property or heading is not exported.

  • In the case of a file, the name is by default that of the heading or property. It is possible to modify this name.
  • In the case of a table, the names are chosen from the list of fields in the destination table.

 

Key

For export to a database table, it is possible to choose a key by checking one or more Key? boxes.

In the case of an export to a file, it is possible to define the order of the columns in the export file by using the button_arrow_vertical arrows . This order also defines the order of the exported events in the file.

Modifying an export context

 

To modify an export context, go to the Global Settings pane, then click on the context to modify.

The corresponding part is then enabled. Modify the parameters (see Creating an export context), then click on OK to save your changes.

Deleting an export context

 

To delete an export context, go to the Global Settings pane, then Right-click on the context > Delete.

The following message appears:

export_event_deleting

Click on:

  • Yes to definitively delete the context,
  • No to cancel the deletion.

 

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!