Launching url

Every activity is initiated using a URL that can be different depending on the conditions. This document describes the structure of the URL used.

A user should never have to type a URL directly; this is done through menu items. It is helpful to know the different components of these URLs because they will be used to define the required menu items to access the corresponding pages.

Native version 7 activity

Every Sage X3 or administration activity developed in native version 7 mode is initiated using a URL that is:

ROOT_URL?url=/sdata/APPLI/CONTRACT/ENDPOINT/CLASS?representation=REPRES.$FACET

In the URL, the following elements are used:

• ROOT_URL is http://SERVER:SNUM/syracuse-main/html/main.html, SERVER, which is the server address and SNUM, which is the service port.
• APPLI, CONTRACT and ENDPOINT are the application name, contract, and endpoint. The values can be:
  • For an administration operation: APPLI is syracuse, CONTRACT is collaboration, and ENDPOINT is syracuse.
  • For a Sage X3 operation: APPLI is x3, CONTRACT is $$prod, and ENPOINT is the folder code.
• CLASS is the class that is the managed entity.
• REPRES is the representation code that is the UI definition associated with the class. Several representations can exist for a given entity, but a default value usually exists.
• FACET is the type of UI used for the operation. It can be a query for a list of entities with selection, details for a detailed entity record display, edit when a record edition starts, and cube for some dedicated multi-level data representations.

When **detail** or **edit** facets are used, the instance identification must be given with the following syntax:

.../CLASS('KEYVALUE')?representation=REPRES.$details
.../CLASS('KEYVALUE')?representation=REPRES.$edit

Classic page

The Classic mode is used when a Sage X3 function is not yet declared as a class and a representation. When a page is called in Classic mode, the URL becomes:

ROOT_URL?url=/trans/x3/$$prod/FOLDER/$sessions?f=FUNCTION/PARAMETERS

Where:

• ROOT_URL is the same as in the native version 7 URL.
• FOLDER is the Sage X3 folder.
• FUNCTION is the Sage X3 function code.
• PARAMETERS are additional elements.

Read-only pages

When a Sage X3 function is available in read mode only, the representation and the class have been described only for query and detail facets. In that case, the page is called as a version 7 native page for query or details, and an automatic switch is done to the corresponding Classic page when an edit activity is requested.

Header information in the Administration reference documents

In the Administration reference documents, a header describes the technical information related to the function depending on the case. The header will be:

Full version 7 function	Application/Contract	x3/$prod	Class	CLASS	Representation	REPRES

Administration Page	Application/Contract	Syracuse/Collaboration	Class	CLASS	Representation	REPRES

Read-only pages	Application/Contract	x3/$$prod	Class	CLASS	Representation	REPRES	Function code	FUNCTION

Classic function	Function code	FUNCTION