Endpoints
Administration Page | Application/Contract | Syracuse/Collaboration | Class | endPoints | Representation | endPoint |
---|
An endpoint is a connection point associated with a service. From an SData point of view, the endpoints described are dataset endpoints. There are two types of endpoints:
A portal vignette giving access to a page with activity is always linked to an endpoint. The access to endpoints is granted to the users through their membership in groups.
The information that must be entered for an endpoint is as follows in different sections:
Name of the endpoint that will be displayed when the endpoint is referenced in another page, for example, groups.
User-friendly description of the endpoint.
The application defines the type of software the endpoint refers to. Currently, only two types of application exist:
This section describes the connection parameters. Its content depends on the application type.
The information to be entered is as follows:
Defines that the database settings are those defined in the nodelocal configuration file rather than on the endpoint. It is preferable to set the corresponding checkbox to activated because it simplifies the administration.
Currently, mongodb is the mandatory entry.
Defines the server where the administration platform has been installed.
The port through which the database is connected; it is dependent on how the server is installed. The default value is usually 27017.
The information to be entered is as follows:
Refers to a Sage X3 solution that supports several folders.
Defines the Sage X3 folder code the endpoint is connected to.
Defines that the Sage X3 folder code the endpoint is connected to.
Defines a category of endpoint associated to a color code. The color code appears on the top bar just in front of the current endpoint name to help the user to identify quickly on which repository type he is connected.
Base URL for online help that overrides the URL for the global cloud-based online help.
List of groups that are allowed to connect to the endpoints. Groups can be added through the add link (the selection window that allows multiple selection).
This is available only for Sage X3 endpoints.
In this grid, X3 menu profiles are associated to different users' roles. This information is mainly used by the X3 users import function but could also be used to simplify the entry of the "Role to profession mapping" grid. In this case this grid as to be entered and validated prior to enter the second grid.
A service called Update menu profile mappings present as a link in the right panel can be used to get the menu profiles from the endpoint and fill the first column of this grid.
The information to be entered is the following:
This column refers to the menu profile to be associated with a users' role.
This column indicates the users' role where the menu profile applies.
This is available only for Sage X3 endpoints.
In this grid, X3 profession codes are associated to different users' roles. This information is used for creating X3 users from platform users in the users entity. The information to be entered is as follows:
This column refers to the profession code to be associated with a users' role (you can edit profession codes in GESAME
function).
This column indicates the users' role where the profession code applies.
A service called Update profession code mappings present as a link in the right panel allows to get the profession codes from the endpoint. This service only changes the contents of the page being eduted but does not save it. If the Menu profiles to roles mapping grid has been filled, the system will be able to fill the associated role by selecting the role that is associated to the menu profile of the profession code.
This service only changes the page contents but does not save it. The following schema shows how the columns is filled:
This check box defines if the record is supplied as a factory record. When this happens, a factory code is also displayed and can be entered if you are a factory provider. This features allows to prevent some modifications on records supplied by defaut by Sage or by a vertical solution provider. More information about this feature is given in the following document.
The following services are available from the right panel of the Endpoint entity:
Associates the corresponding endpoint by default for the application. It replaces a previous default endpoint assignment.
Checks the connection to the server, and returns a diagnose on the upper panel.
Base help URL is reachableGET / -- status: 200GET /en-US/index.htm -- status: 200GET /en-US/FCT/AIMP.htm -- status: 200GET /en-US/FLD/A.htm -- status: 200
This service launches the import of the personalizations and menus items delivered in a X3 folder. For this you need the technical setting rights defined in the security profile.
The personalizations and menus items are stored and imported from the folder/'folder'/SYRDEF directory.
Otherwise, the standard personalizations and menus items are in the root 'folder'. They must be applied only once, during the installation procedure.
Notice that after this initialization phase, the updates are managed with the easypatching procedure.