Français | English
 

FORMAT D'IMPORT EXCEL

Attention : Avant toute utilisation des informations décrites dans ce document, merci de contacter ONprint en envoyant un mail à support@onprint.com, pour obtenir l'accès et le complément d'informations nécessaire.

Contexte

Pour les gros volumes de données (documents multi-pages, documents en grand nombre, ou fréquence élevée de mises à jours) le mode manuel d'enrichissement n'est plus praticable. Une des solutions possibles est de passer par un fichier EXCEL de format fixe, mis à jour manuellement voire chargé automatiquement depuis des données client.

Ici nous décrivons les formats possibles de ce fichier Excel, et les différentes options, depuis le cas le plus simple jusqu'au cas le plus élaboré.

Notes importantes

  • Le format Excel attendu est le format ".xlsx" (et non l'ancien ".xls")
  • Il est possible d'utiliser un format CSV au lieu du format Excel (séparateur : ";", extension ".csv")

Chargement et conversion

Pour charger un fichier excel sur un document ou sur un ensemble de document il suffit d'utiliser :

  • pour un document simple : menu "engrenage"/"Import XML ou JSON" et de sélectionner le fichier excel dans le dialogue qui s'ouvre
  • pour un dossier complet : déposer le fichier excel sur la zône de dépot qui sert également à l'import de nouveaux documents. Une boîte de dialogue s'ouvre alors montrant le déroulé de l'import. Pour importer sur un dossier complet il faut nécessairement que le fichier excel comporte une colonne indiquant le nom exact du fichier destinataire pour chaque action (formats "MULTI" ci dessous).

Le fichier de configuration doit être au préalable chargé par ONprint.

Formats standards

Format Usage Template Excel
STD document simple, que des actions URLs Télécharger
STD-MULTI multi-documents (dossier), que des actions URLs Télécharger
STD-MTYPES document simple, actions de tout type Télécharger
STD-MULTI-MTYPES multi-documents (dossier) et tout type d'action Télécharger
STD-ZONES document simple avec zônes, que des actions URLs Télécharger

Variantes autour d'un format standard

Il est possible d'amender un des 4 formats ci-dessus, en ajoutant au nom du format une chaîne d'options de la forme "+[<lettre><nombre>]". Par exemple "STD+D12T4". La lettre indique le type d'information de la colonne. Le nombre est son indice horizontal ou vertical (commençant à zéro : A == 0).

Le tableau suivant indique la correspondance entre la lettre et le contenu de la colonne

Lettre Contenu de la colonne
D Numéro de la première ligne de données (commence à zéro, verticalement)
T Titre de l'action
N Numéro de page
U URL
C Nom du fichier ou chapitre (mode multi documents)
F Première page du chapitre dans le fichier
P Titre de page
I Icône
A Type de l'action

Principe

Les données à charger sont stockées dans un fichier Excel (xlsx) dont le format est spécifié grace à un fichier de configuration.

La première cellule du fichier excel donne le nom logique du format utilisé, ce qui permet de charger le fichier config correspondant.

Le fichier de configuration contient une suite de couples (nom de variable, valeur). Ce document liste les différentes variables reconnues et fonctionnalités associées.


— Fin de la partie publique —

Format et construction du fichier de configuration

Ce chapitre est à usage interne ONprint.

Ce chapitre décrit la structure interne des fichiers de configuration. La gestion de ces fichiers de configuration est réservée à un usage interne ONprint.

Cas le plus simple

Le mode le plus simple consiste à charger des actions URL (uniquement) en spécifiant pour chacune :

  • le numéro de page sur laquelle elle apparaît,
  • son nom (titre)
  • et l'URL associée.

Il s'agit donc d'un tableau excel à seulement 3 colonnes.

Tous les autres paramètres sont pris par défaut (icône, langue, style, titre de page etc).

Exemple du format minimum

|ONPRINTFORMAT:XXX|Ne pas supprimer cette ligne|Mosquito| |Num Page|Nom Action|URL Action| |-------------------|-------------------|-----------| |1|Acheter|http://www.mosquito.com?product=8787| |1|Voir la vidéo|http://www.mosquito.com?product=8787#video| |2|Acheter|http://www.mosquito.com?product=4565| |2|Voir la vidéo|http://www.mosquito.com?product=4565#video|

Le fichier de config aura au moins les paramètres suivants :

  • data_firstline 2 Les données commencent ici en ligne 2

  • col_page_number 0 première colonne : numéros de page

  • col_action_title 1 seconde colonne : titres des actions

  • col_action_url 2 troisième colonne : URL des actions

Avec ce fichier minimum, les actions auront l'icône par défaut (URL), et la langue par défaut (fr-FR)

Possibilités supplémentaires

À partir de là on peut complexifier ce format Excel au gré des besoins en ajoutant les possibilités suivantes :

  • icônes
  • langues
  • options d'URL
  • langue du document
  • titre de chaque page
  • styles
  • mode chapitre : subdivision du document en plusieurs PDF par chapitre, ou décalage des pages pour pdf partiels

Nous allons détailler chaque possibilité.

Chaque fichier Excel fait référence à son format exact via un nom logique. Ce nom logique indique un fichier de configuration approprié dans lequel on détaille chaque paramètres et options utilisés.

Icônes des actions

Pour qu'une icône soit référençable depuis un fichier Excel il faut qu'elle soit tout d'abord chargée sur la plate-forme (en utilisant la popup de configuration des icônes de la page d'enrichissement). Il faut donner à chaque icône un niveau de visibilité suffisant pour tous les documents qui devront l'utiliser. Il faut ensuite noter l'ID de chaque icône et créer dans le fichier config (voir plus bas) une entrée du style :

```icon_BLABLA "73763-87837-987638-7638736"


"BLABLA" est un nom quelconque attribué à cette icône et qui figurera dans le fichier excel. Entre quote on indique l'ID de l'icône.

Le fichier excel doit maintenant contenir une colonne supplémentaire dont le numéro est spécifié par le paramètre col_iconname du fichier de configuration.
Cette nouvelle colonne ne doit contenir que des noms d'icône déclarés dans le fichier config, comme indiqué ci dessus.

### Multilingue

Toutes les langues sont spécifiées sous leur format ISO "xx-YY", ou xx est le code de la langue et YY le code du pays.
Par exemple "fr-FR" pour "Français - France".

On peut tout d'abord changer la langue par défaut du document dans son ensemble :
```def_language "en-US"

Et on peut indiquer pour chaque action sa langue en ajoutant une colonne dont le numéro est donné par le paramètre col_action_language.

Titre des pages

Le titre des pages peut être indiqué globalement en spécifiant le titre par défaut grace aux 2 paramètres doc_title_line et doc_title_col. Le plus souvent en première ligne du fichier ou en tout cas avant la première ligne de données.

On peut aussi indiquer un titre par page en ajoutant une colonne spécifique dont le numéro est col_page_title. Si une page comporte plusieurs actions il suffit de l'indiquer une seule fois et de laisser vide cette céllule pour les lignes suivantes, ou bien de répéter le même titre pour chaque action.

Titre des actions avec lettrine

En plus de la colonne col_action_title il est possible de préfixer automatiquement les titres d'actions au moyen d'une lettre ("lettrine") indiquée dans une colonne supplémentaire col_action_lettrine.

Options

Is Embedded View

Cette option d'URL est modifiable en ajoutant une colonne de numéro col_opt_isembeddedview. Sa valeur est vraie par défaut (cellule vide), fausse si un "0" est mis dans cette cellule

Auto Trigger

Pour qu'une page soit en mode autotrigger, il suffit d'ajouter une colonne de numéro col_page_autotrigger contenant "1" ou "True" pour les pages à déclenchement automatique.

Référence : Format du fichier excel

Attention : Toutes les lignes et colonnes du fichier Excel sont comptées depuis 0 (donc cellule [A1] = [ligne 0, colonne 0]).

Entête (première ligne du fichier excel)

La première ligne du fichier excel contient obligatoirement:

  • en première colonne (cellule [A1]) la chaîne ONPRINTFORMAT:XXX, ou XXX est le nom du format. Ce nom fait référence à un fichier de configuration XXX.config décrit plus bas dans ce document.

  • en colonne 2 (cellule [B1]) la chaîne "Ne pas supprimer cette ligne"

Optionnellement :

  • en colonne 3 (cellule [C1]) le titre de la campagne

  • en colonne 4 (cellule [D1]) l'offset de page à appliquer si ce fichier correspond un fichier PDF qui est un fragment du fichier global (unchapitre par exemple). Dans ce cas les numéros de page réels (figurant au nbas des pages papier) sont décalés de cet offset par rapport à l'indice de page dans le PDF

Colonnes et paramètres obligatoires (format minimum)

  • Paramètre Indice de la première ligne de données (les actions) (data_firstline)

Entre la première ligne (réservée) et cette ligne on peut intercaler autant de lignes : entête de tableau, lignes d'aide, etc. Ces lignes seront ignorées au chargement.

  • Colonne Numéro de page (commençant à 1) de l'action (col_page_number)

  • Colonne Titre de l'action (col_action_title)

  • Colonne URL de l'action (col_action_url)

Colonnes et paramètres optionnels

  • Colonne titre de page

  • Colonne lettrine

  • Colonne nom de l'icône

  • Colonne langue de l'action

  • Colonne option d'URL : "Is Embedded View"

  • Colonne option "Auto Trigger"

  • Titre du document

  • Colonne est ligne de la cellule titre

  • Décalage de page pour PDF partiel

  • Icône par défaut

Les icônes

  • icon_XXX

Mode XML unique et mode par chapitre

  • Mode chapitre

  • Colonne première page des chapitres

Fichier .config

Template du fichier XXX.config, ou XXX est le nom du format 

  #----------------------------------------------------
  # ONprint Excel > XML convertor
  # 2015
  #
  # Config Customer (model)
  # Syntax :
  #   - line start with # or empty line : ignored (comment)
  #   - line start with letter : <param name > <param value>
  #----------------------------------------------------
  #--------------- Mandatory parameters - Column numbers start at 0
  #=== Default language for this document (ISO format "ll-CC")
  def_language   "fr-FR"
  #==== Mode chapter : 1: decoupage en multi-xml, 0 : un seul
  mode_chapter   0
  # Data start at line firstline on first sheet
  data_firstline       2
  # action title is on column col_page_title
  col_action_title 1
  #==== Only If mode_chapter == 1
  # chapter number
  col_chapter    2
  # chapter first page number if mode_chapter == 1
  col_chapter_first_page 3
  #====
  # action is attache to page col_pagenumber
  col_page_number 4
  # action url is on column col_url
  col_action_url  6
  #----------------------- Optionnal parameters
  col_page_title  0
  col_action_lettrine  7
  col_action_icon      5
  col_action_language -1
  # Options : nul column or -1 is unused
  col_opt_isembeddedview -1
  col_page_autotrigger    -1
  # campaign name (to become page title on smartphone)
  doc_title      "Le titre"
  # campaign name (to become page title on smartphone)
  doc_title_line 0
  doc_title_col  2
  # page number offset (N to add to page numbers for title)
  doc_pageoffset_line -1
  doc_pageoffset_col  -1
  def_icon       "a362bf3c-47d7-4ee2-9f48-cfe0400b38a8"
  #------------------------ Icons tags
  icon_Video    "22b455d1-1b12-4606-98b9-e9a1fb17bcb3"
  icon_Audio    "d7e8f860-1b6e-432a-bb25-5aa00a6c2cbb"
  icon_Article  "89b2c8b8-0b44-43bc-9ebb-3da30f7f13ef"
  icon_Vue360   "be57f32c-c118-4d49-aeb2-d7a710225c0d"
  icon_WebDoc   "4068d201-81c7-44df-9781-81fa55af1610"
  icon_Siteweb  "9d3ec122-87ac-4455-b8c9-5918b1aa6b93"
  icon_Info     "40bd5c0a-abf2-4a36-8b92-e860cffe67d5"
  icon_Ref      "c23bd725-fbad-4878-8b6c-3d9d1295623a"
  icon_Diapo    "ec94af19-591a-439d-a957-878857572d5f"
  icon_Carte    "d7e8f860-1b6e-432a-bb25-5aa00a6c2cbb"
  icon_Quizz    "e777a36a-ea70-44e9-a4c1-35fe00deb4d5"
  icon_url  "a362bf3c-47d7-4ee2-9f48-cfe0400b38a8"
  icon_buy  "07c56727-40d1-4804-b866-b923bc799f05"
  #-------------------------- The end