Resources export: configuration

 

The export contexts must be saved before triggering them.

 

Creating an export context

 

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

The corresponding part is then enabled:

export_resource_context

Now enter the various characteristics, then click on:

  • OK to save the context,
  • Restore otherwise.

These characteristics are as follows:

 

Name

Give this export 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 export in the proposed languages by clicking on the v7_adm_en_parametres_generaux_symbole_multilangue button.

Note

Name of the export in french Export du personnel
Name of the export in english Staff export
What is seen in a FR desktop Export du personnel
What is seen in a EN desktop Staff 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.

 

Timestamp the process

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

See below.

 

“URL” call

The activation of this option authorizes the triggering of this context using a URL from outside 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 button 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 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 an Access 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 export 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.

Definition of the export context

 

Destination tab

export_resource_destination_tab

The export’s unique destination can be one of the following:

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

The parameters required for the import differ depending on the type chosen.

Standard format

For *.CSV files

export_resource_csv_destination

You must define the following parameters:

Type

In this case, the value should be CSV file.

 

Separator

The separator in the source 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),
  • UTF8, encoding used for Anglophone OS (Windows, Unix),
  • Windows-1252 (Windows).

 

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_resource_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_resource_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 import is from a database, you must choose the Database type.

export_resource_database_destination

You must define the following parameters:

 

Type

In this case, the value must be Database.

 

DBMS

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_msaccess_settings
export_mysql_settings
export_oracle_settings

 

To validate these settings, click on:

  • OK,
  • or Cancel to go backwards.

Database

Define the name of the destination database.

 

Table

Choose the destination table or view.

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 used for this verification is defined in the Correspondence tab.

 

Remove HTML from multi-line fields

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

 

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 take the value 0 if successful,
  • operational message OUT and type VARCHAR: must contain an explicative text, made available to the user.

 

Export 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 produce a correspondence between the source, which is one of the dimensions 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_resource_correspondence_tab

Simply fill in the table, which contains several columns:

Dimension

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

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

  • Each heading of the dimension,
  • Each heading of the “dependent” resources,
  • 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,
  • A log of resource history,
  • The names given to daily and hourly calendars,
  • The internal identifier (UID) for the resources.

Warning

Concerning 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

For an export to a table in a database, you can choose a key by ticking one or more of the Key? boxes.

For an export to a file, you can define the order of the columns in the export file, using the button_arrow_vertical arrows. This order also defines the order of the exported resources 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_resource_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!