Administration reference

The Administration reference documents describe the different functions or activities used to administrate a Sage X3 platform and solution. An activity is launched from the web client through a launching URL corresponding to a class and a representation. In every document with such an activity, the components of the URL will be introduced.

Different categories of activity exist. The list of activities presented here is given in the order defined by the Administration default menu page:



The definition of all users able to connect on the platform.

The definition of groups; a set of users sharing access rights to endpoints and able to use a list of roles.

The definition of roles linked to personalized configurations for a user such as default dashboards, dedicated personalized pages, and so forth.

Security profiles
The definition of security profiles that controls the administrative rights and are assigned to roles.


License data
Defines the licenses available and the associated data.

Describes the assignment of badges to roles in order to handle license rights.

License upload
Management of license files.

Web services

Classic SOAP web services
The setup of ingoing SOAP web services defined in Classic mode and published from node.js web server.

SOAP pool
The setup of the pool that serves the ingoing SOAP web services.

REST Web Services
The setup of outgoing REST web services.


Global Settings
The definition of global authentication settings.

The definition of locale rules for data presentation and input such as dates, numbers, and so forth.

Password policies
Define a password policy on the signature code in order to ensure the compliance with CFR-21 Part 11 regulations.

Proxies configuration
The setup of proxy servers requested to access external services from the platform.


The setup of directories for LDAP authentication.

Oauth2 servers
The setup of servers for Oauth2 authentication.

SAML2 authentication
The setup of SAML2 authentication.

Connected applications
Allows to declare connected applications which will be used from a dedicated API.


The management of certificates.

Certificates of Certification authorities
The management of certificates signed by a certification authority.


The definition of the types of software connected to the node web server.

X3 solutions
The definition of the Sage X3 solution available to be connected on the node web server platform.

The definition of the data source associated with a widget or a page (a folder for the Sage X3 application).

Batch controller
Settings of Sage X3 batch controller for driving batch requests.


The definition of the different hosts used to run version V12 processes in a cluster environment.

Notification servers
The setup of servers that sends notification through email.

CTI services
Allows to define a CTI service for the Computer Telephony Integration.

BO servers
The definition of logical Business Objects severs corresponding to X3 Business Objects application servers.

BO profiles
The definition of Business Objects profiles associated to Business Objects servers.

HRM Portal

HRM Servers
Allows to creates HRM Servers configuration to be able to use HRM sites throught load balancer.

HRM Sites
Allows to creates HRM Sites configuration to be able to use Syracuse as HRM proxy.


The definition of lists of users sharing documents.

The definition of logical volumes used to store or access documents.


The documents shared by teams and managed in the mongodb document database.

Word templates
The templates predefined for Word reporting purposes.

Documents tags
The definition of tags associated with documents shared by teams.

Tags categories
The definition of categories for tags.


Notification events
The setup of events that will trigger automatic notifications to some users.

Mail templates
The setup of templates that describes how the body and the other characteristics of a mail sent from an entity is computed.

Notification themes
The setup of themes used as style sheets for emails sent by the platform.



Navigation pages
The definition of navigation pages that describes the organization of the links to the ERP pages organized as a "site map".

Home pages
The definition of home page (or landing pages) that contains blocks in which menu items are displayed to produce a user friendly page that contains indicators or processes.

Menu items
The definition of links on pages that appear in landing pages.

Menu submodules
List of menu item (links in home pages).

Menu modules
Super-blocks of links (organized in sub-modules) used in home pages

Menu categories
Categories assigned to menu items.
Customized pages
The description of the pages modified by personalization.


The menu items present here correspond to the new mobile/tablet client with auto-adaptative layout capabilities.

Mobile applications
Describes the new mobile applications .

Mobile dashboards
Allows to create mobile dashboards.

Mobile gadgets
Allows to create mobile gadgats included in the mobile dashboards.

Upgrade mobile dashboard
A tool that allows to generate new mobile applications from the previous mobile dashboards.



Export profiles
The definition export profiles used to export data and meta data from Endpoints.

Personalizations management
The tool that allows to define filter used to extract dashboards, portlets, menu items, and personalized pages information in a format that makes it possible to import them in another repository.

Resources packs
Set of export files.


Returns technical information about the platform installed.

A new way to upgrade folder in "one click"


Import tool
Tool used to import data in the administration database.

X3 Users import
A tool that allows to read the user in a folder database in order to create or update users in the administrattion database.

Menu profile import
Allows to import menu items from a Sage X3 folder

Import sessions
The import session management.

Sage EDI Online

DSN submissions
List of DSN submissions sent to Sage EDI Online.

CRM requests
List of CRM requests sent to Sage EDI Online.

Sage EDI Online portal
Direct access to the Sage EDI Online portal.


Install addin for Office
A link to download the Office plugin

Install addin for Outlook
A link to download the Outlook plugin

Ilog Connector
A link to download the connector for Scales and Gantt Ilog modules

Report developer Connector
A link to download the plugin that allows local development on Crystal Reports. For more information, see the following document


Search index management
The definition of the parameters for the search index updates.

User broadcasts
The definition of the parameters for user broadcasts.


The definition of scheduled tasks (automation).

Server logs
The management of logs on operations that runs on the administration server.

Sessions management

License display
Displays the current license consumption.

Web client Sessions
The sessions currently active on the node server.

Classic client sessions
List of X3 sessions dedicated to classic pages.

Clients reused list
Another view of the classic sessions that displays only the sessions not yet used.


Host trace
The management of technical traces for support purposes.

MongoDB traceability
Traceability of the modifications on the MongoDB database.

Engine trace
Allows to creates log on the X3 engine associated to the current session for debugging purposes.

Miscellaneous documents

These documents refers:

The following pages are available:
* Administration reference Super Administrator: The definition of a super administrator with administration rights on the platform.
* Administration reference Dashboards: The definition of portal pages containing portlets that can be menus, ERP or administration pages, and external pages. This entity has been replaced by home pages and navigation pages and is now only used for the description of mobile applications.
* Administration reference widgets: The autonomous components found in a dashboard.
* Administration reference Configuration File: A file located on the node web server that defines default parameters.
* Administration reference Friend servers: The definition of other node servers on which the platform can connect.
* Administration reference Outgoing REST Web services: Definition of external web services that can be called from SAFE X3 platform.

Supervisor Setup functions

In this section, you will find the supervisor functions that have already been switched to Versions 7 and above technology, and the new functions related to Versions 7 and above technology. These functions are related to a Sage X3 endpoint, and handle meta data stored in a Sage X3 folder. The links are organized by supervisor menus.


The supervisor development menu handles all the functions related to the workbench. The corresponding documentation can be found here.


This sub-menu of development contains tools that didn't change since the version 6, except for the following list:


This menu gives access to setup operation at the folder level:

In the setup menu, we also have several sub-menus:


In this menu, the definition of the statistical functions are present. On all these functions, the same user interface than in V6 is used, and the way the data is stored didn't change since version 6. But the validation of the statistics generates a script that accesses to the statistical data from Versions 7 and above native pages. This is described in the following link:


In this menu, the requester functions are present. On all these functions, the same user interface than in V6 is used. But for the Query tool and the Graphical query tool, the validation of the queries generates a script that runs differently the queries in order to access to the query data from Versions 7 and above native pages. This is described in the following link:


This menu includes some tools related to the administration platform. The following functions are related to the new platform or have been changed in version V12:

Interactive dashboards

This menu includes some tools related to the version 6 dashboards and some features are still relevant for the home page, especially:
* the portal view that define default values usable as query parameters (parameter &portview=value). See the requester documentation for more details.
* the visual process editor, that works like previously and is documented in the version 6 setup menu pages documentation. Some tricks are described to implement the links in the following documentation.