Home > Installation

First Start Wizard

EBX.Platform Wizard helps you to configure the default properties of your initial repository. This tool is launched when EBX.Platform repository does not exist.

Before starting the configuration of the repository, please ensure that EBX.Platform is correctly deployed on your application server. For more explanation about EBX.Platform deployment, you can see the online documentation.

Check also that ebx.properties is correctly configured.

The configuration of the repository will process the following steps:

  1. Validation of the license agreement.
  2. Input of the license key.
  3. Input of information about the repository.
  4. Input of information about the directory which will be used by EBX.Platform (if a custom directory is not defined).
  5. Validation of information.
  6. Installation of the repository.

Validation of the license agreement

The first step presents the license agreement. This agreement has to be accepted in order to continue the configuration.

Input of the license key

You have to get a valid license key in order to use EBX.Platform. If you don't have a license key, you can get a trial license key.

The license key is validated and then saved in ebx.properties.

Input of the repository's information

This step allows to input the properties of the repository and displays some information about the database defined in ebx.properties.

  • Id of the repository (repositoryId) : it has to identify uniquely a repository (at least in the scope of the enterprise). It is coded on 48 bits (6 bytes) and it is usually represented with 12 hexadecimal digits. This information is used for generating UUID (Universally Unique Identifier) of entities created in the repository and also of transactions logged in the history (it plays the role of the « UUID node » part, as specified by RFC 4122).

  • Repository label : it provides a label for the user so that he knows the purpose of the repository. The label will be displayed in EBX.Manager.

  • Installation of a sample adaptation model : you can install a sample adaptation and its data. This adaptation sample contains data that represents a fictitious publishing business. You can refer to the online documentation for more explanation about this sample. Please ensure that ebx-tutorial module is correctly deployed on your application server. For more explanation about ebx-tutorial module deployment, you can see the online documentation.

Input of the directory's information

If a specific directory is not defined in ebx.properties, EBX.Platform configuration assistant allows to define default users for the directory which will be used by EBX.Platorm. For more information about the directory, you can see the online documentation.

Note that an administrator has to be defined. You can also define an optional user.

Validation of information

Before the repository installation, a page summarizing the input information is displayed. It is possible to modify this information by navigating into previous pages.

After input data checking, you can then proceed to the repository installation.

Repository installation

The repository installation is performed with the information that you have provided. At the end of the installation, a confirmation page is displayed.

After the repository installation, you can then access to EBX.Manager.

 

License key update

 

The license key update page is automatically displayed when your license key is invalid (license key not filled in file ebx.properties or licence key expired).

If you do not have a license key, you can get a trial license key here.

Assistant premier démarrage

EBX.Platform fournit un outil permettant de configurer un référentiel initial. Cet outil est automatiquement lancé par EBX.Manager lorsqu'aucun référentiel EBX.Platform n'existe.

Avant de démarrer la configuration du référentiel, veuillez vous assurer que EBX.Platform est correctement déployé sur votre serveur d'application. Pour plus d'explications sur le déploiement d'EBX.Platform, vous pouvez vous référer à la documentation en ligne.

Veuillez aussi vous assurer que ebx.properties est correctement configuré.

La configuration du référentiel se déroule en plusieurs étapes :

  1. Validation de l'accord de licence.
  2. Saisie de la clé de licence.
  3. Saisie des informations du référentiel.
  4. Saisie des informations concernant l'annuaire qui sera utilisé par EBX.Platform (si un annuaire non spécifique est utilisé).
  5. Validation des informations saisies.
  6. Installation du référentiel.

Validation de l'accord de licence

La première étape consiste à prendre connaissance de l'accord de licence permettant d'utiliser EBX.Platform. Cet accord doit être accepté pour pouvoir poursuivre la configuration du référentiel.

Saisie de la clé de licence

Pour utiliser EBX.Platform vous devez posséder une clé de license valide. Si vous ne possédez pas de clé de licence, vous pouvez obtenir une clé d'évaluation.

La clé de licence saisie est validée puis est enregistrée dans le fichier ebx.properties.

Saisie des informations du référentiel

Cette étape permet de saisir les propriétés du référentiel et affiche les informations concernant la base de données définie dans ebx.properties.

  • Identifiant du référentiel (repositoryId) : cette propriété doit identifier de façon unique un référentiel (au moins au niveau d'une entreprise). Il est codé sur 48 bits (6 octets) et il est généralement représenté avec 12 chiffres hexadécimaux. Cette information est utilisée pour générer l'UUID (Universally Unique Identifier) des entités créées dans le référentiel et également des transactions enregistrées dans l'historique (cela joue le rôle de la partie « noeud UUID », comme spécifiée par le RFC 4122).

  • Libellé du référentiel : cette propriété permet de définir le libellé du référentiel qui sera affiché dans EBX.Manager.

  • Installation d'un exemple de modèle d'adaptation : vous pouvez installer un exemple de modèle d'adaptation et ses données. Cette adaptation définit un modèle de données représentant un environnement fictif de publication d'ouvrages. Vous pouvez vous reporter à la documentation en ligne pour obtenir plus d'informations sur cette adaptation. Veuillez vous assurer que le module ebx-tutorial est correctement déployé sur votre serveur d'application. Pour plus d'explications sur le déploiement de ce module, vous pouvez vous référer à la documentation en ligne.

Saisie des informations de l'annuaire

Si aucun annuaire spécifique n'est déclaré dans ebx.properties, l'outil de configuration permet de définir les utilisateurs par défaut de l'annuaire qui sera utilisé par EBX.Platform. Pour plus d'informations concernant la notion d'annuaire, vous pouvez vous reporter à la documentation en ligne.

Notons qu'un utilisateur de type administrateur doit obligatoirement être défini. Il est de plus possible de définir un utilisateur optionnel.

Validation des informations saisies

Avant de procéder à l'installation du référentiel, une page résumant les données saisies est affichée. Il est possible de modifier les informations saisies en navigant dans les pages précédentes.

Après vérification des données saisies, vous pouvez procéder à l'installation du référentiel.

Installation du référentiel

Le référentiel sera installé avec les propriétés que vous aurez définies dans cet outil de configuration. A la fin de la procédure d'installation, une page de confirmation est affichée.

Après confirmation de l'installation du référentiel, vous pouvez accéder à EBX.Manager.

 

Mise à jour d'une clé de licence

 

Une page de mise à jour de licence est automatiquement affichée par EBX.Manager lorsque votre clé de licence est invalide (clé non renseignée dans ebx.properties ou clé devenue obsolète).

Si vous ne possédez pas de clé de licence vous pouvez obtenir une clé d'évaluation.

 

Home > Installation