Index
All those documents stated here are intended to help you start using the new Versions 7 and above web technology.
If you are a user who has already access to the node.js platform and if you want to understand how to navigate through the pages and enter data, you may refer directly to the User interface description pages.
For a better understanding of the platform associated to the Versions 7 and above, you will find 3 types of documents:
* A set of documents introducing the main concepts of this platform.
* A set of documents describing the installation and the prerequisites to use the platform.
* A set of documents explaining how to start the setup process and connect the platform to X3 folders.
Installing Sage X3 People V7 requires to install the X3 servers and the node.js administration server. The procedure for installing the X3 server is almost the same as for the V6 servers. The installation of the Version 7 node.js server is new. When both are installed, it will become necessary to connect them together and to perform some administration operations in order to be able to use the HRM function on Version 7.
A demo folder is supplied in standard with Sage X3 People. The name of this folder is SEED, this means that the first endpoint which you can connect on (aside from the root folder X3) is the SEED endpoint. Once the complete installation path has been done, you can play with this folder as a self-training material.
Using Sage X3 People will manage data in the relational database as well as in the mongoDB database. It is your responsibility to ensure the access security to mongoDB and to the relational database. The following document explains the main precautions to take.
The documents that explains how to install the server are here:
Sage X3 People is a licensed software, protected by copyright. The use of the software is only permitted if you have acquired a valid license. The license is defined by a license file that must be installed on the server, and that gives you a given number of access rights identified by badges. The information that are inside the file are described in the following documentation.
You need at least one license supplied by Sage to run the product, but Sage can grant to partners the possibility to define additional licences files with their corresponding policy file.
The license file and the corresponding policy file are used to define the number of badges to connect as well as additional parameter values. The corresponding parameter values can be also seen in a dedicated function. A developer can have access to these parameter values in the context class.
When all the servers are installed, a connection phase remains. Several operations have to be done:
* Connection parameters: in the administration repository, technical information must be added to describe the connection between Version 7 web server and the X3 folders.
* Sandbox configuration file: on the SAFE X3 hierarchy, a configuration file that indicates the directories the X3 engine has access to must be set up.
* Certificate installation: In order to allow the connections between node.js repository and X3 servers to be established in a secured way, certificates have to be created and installed.
* User creation tool: A user repository is managed on the administration platform. It enables controlling safe connections to several folders from the node.js platform through a single sign-on. This tool allows to generate by default the user repository from user tables found in a folder.
* Portal generation tool: This tool allows to create default dashboards, vignettes, and menu items from V6 portal and user menus.
* Meta data switching tools: This tool is an assistant dedicated to developers who want to create Versions 7 and above dictionary items (classes, representation) and to use V6 objects in read-only pages mode.
* Visual process recodification tools: This tool generates additional meta data in dictionaries in order to handle version 6 visual processes in version 7.
Another point has to be noticed: the SEED demo folder is supplied with data, but the data is not indexed by the search engine, that means that the search index is delivered empty. This means that one of the first steps you have to do if you want the search box to return results is to index the Endpoints your platform has been connected to : at least the administration Endpoint and the SEED Endpoint, and of course other Endpoints whenever they exist.
This task is done through the Search index administration page.
Some technical documentations will be found in this section: