CONFIGURATION

The export contexts must be saved before triggering them.

Create an export context

To create a new export context, go to General settings > Right click on Resource Export > Create an export context for > Select the dimension.

The corresponding part is then enabled:

Then enter any differing characteristics, then click on:

  • Validate to save the context,

  • Reset otherwise.

These characteristics are as follows:

Name

Give a name to the export context.

Description

Give a description of this context. The description 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.

See Definition of the resource export context.

Mark the treatment

This checkbox, if checked, is used to save the date, time and login details of the use exporting the resource.

See below.

URL"call"

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

Activating authentication

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

User ID

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

Password

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

Resource creation/modification

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

Caution

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

Event creation/modification

This checkbox 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 an MSAccess database.

Activated

This checkbox 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 checkbox is used to transmit a report, by mail, for the results of each export trigger.

Warning

Prerequisites: An SMTP server must be configured as automatic mails are involved. 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 needed when the Reporting activated checkbox is selected.

Recipients

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

This parameter is only active and needed when the Reporting activated checkbox is selected.

Definition of the export context

Destination tab

The unique export destination can be of the type:

Depending on the type chosen, the parameters required for the export are different.

Standard format
For *.CSV files

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, the latter 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=NomDuContexteExport used for imports and exports.

For Excel files

You must define the following parameters:

Type

In this case the value should be Excel file.

Path

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

Worksheet

Define the worksheet of the source file to be imported.

For XML files

You must define the following parameters:

Type

In this case the value should be XML File.

Path

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

Databases

If the import is from a database, you must choose the type “Database”.

You must define the following parameters:

Type

In this case the value should be Database.

DBMS

Define the Database Management System used:

  • MSAccess,

  • MySQL,

  • Oracle,

  • SQLServer,

  • PostgreSQL,

  • or MariaDB.

Connection settings

Connection settings differ with the type of DBMS chosen. By clicking on Connection Settings a new window will appear:

 

MSAccess

MySQL, SQLServer, PostgreSQL, MariaDB

Oracle

SID

  

Password

Path

  

Port

 

Server

 

Login

 

To validate these settings, click on:

  • OK,

  • or Cancel to return backwards.

Database

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

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 database, the export involves, by default, the insertion of new data.

This checkbox, if not checked, is used to check, within the destination database, whether the data already exists, and only create it if it doesn’t.

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

Filter

It is possible to restrict the export to just some of the resources. To do this, select from this list, the resource filter to apply to the data to be exported.

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 be set to the value 0 if successful,

  • operational message OUT and type VARCHAR: must contain explicative text, made available to the user.

Import context to follow

Warning

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

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 create equivalence links between the source, which is one of the dimensions of the schedule, and which is, depending on the case, either a file, a worksheet or a table.

This equivalence is defined on a field by field basis.

Simply fill in the table, which contains three columns:

Dimension

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

By clicking on , it is possible to export:

  • Each heading of the dimension,

  • Each heading of the “dependent” resources,

  • Several headings at once if the user clicks on (Select all attributes). This is useful when a large number of headings are involved in the export,

  • A log of resource history,

  • The names given to daily and hourly calendars,

  • The internal identifier (UID) for the resources.

Caution

In terms of the calculated headings, only the daily headings can be exported.

Destination

Select, for each heading or attribute to be exported, the corresponding destination field. If no destination is given, the attribute or heading will not be exported.

  • For a file, the name, by default, is that of the heading or attribute. It is possible to modify this name by clicking on the corresponding Destination field.

  • For a table, the names are taken from the list of fields in the Destination table.

Key

To export towards a table in a database, it is possible to choose a key by ticking one or more Key? boxes.

See Add if no match

For an export to a file, it is possible to define the order of the columns in the export file, using the arrows . This order also defines the order of the resources exported into the file.

Modification of an export context

To modify an export context, go to General settings then Click on the context to be modified.

The corresponding part is then enabled. Modify the characteristics (see Creation of an export context), then click on Validate to save any modifications.

Deleting an export context

To delete an export context, go to General settings then Click on the context > Delete.

The following message appears:

Click on:

  • Yes, to definitively delete the context,

  • No to cancel the deletion.

ghostghostghostghostghost
loading table of contents...