X3 Developer Notes: 2017

Tuesday, November 28, 2017

Working with Views

Use Views (GESAVW) in the Development > Data and Parameters block to create and modify views, by describing their characteristics in the data dictionary for the folder.

Views allow you to do the following:

Avoid opening a table in a folder, such as archived folders.

Access data in several folders for report development.

Use SQL Server functionality that was previously inaccessible, such as union or group by.

Views are accessed like files with the [F:xxx] method. Views can be accessed using the formula editor and Crystal Reports. Programming relating to a view is similar to programming for a table (it has its own class [F]). The following instructions are available for the views:

(local) File, close (local) File, Filter, For…Next, Read, Columns, Link

The view name cannot have the same name as a table in the dictionary. It is a unique identifier and can contain from 1 to 10 letters or numbers, but must start with a letter.

You can create views on tables from different folders.

Query tab

Use the Query tab to write the query that will be used to create the view.

The query must be written in the same programming language as the current database in the folder.

It is preferable not to hard code the folder name into the query so that the query can be used with another folder when it is copied.

The activity code and module are used in conjunction to identify whether the view will be created in the database of the folder.

If fields submitted to an activity code or folder name need to be specified in the query, it is recommended that you use formulas.

The Open access check box is used to restrict the access to the database table within the folder owning the table and certain authorized folders. Changing the setting at this field requires a re-validation of the table.

Fields tab

Use the Fields tab to define all the fields of the view. The description of the fields must be fully compatible between the Query tab and this tab (number, order, and field type).

The compatibility check is performed during validation.

These fields can exist in the table dictionary, although it is not mandatory.

The query must be written in the same language as the current database in the folder.

The Menu column defines the local menu associated with the field.

Keys tab

Use the Keys tab to define all the keys available to sort the view.

The Key code field corresponds to the name under which the key is known in Order By.

A list of fields that make up the index is entered in the Key description field. Fields are separated by a plus sign.

The standard naming convention for views consists of using the abbreviation for the view, followed by 0 for the principal key, by 1 for the second key, etc. For a customization, be sure to start the code with X, Y, or Z.

When copying views to other folders, the Copy button only copies the view description to the other folder. You must validate this description in the other folder so the view can be created.

Validation

Click Validation in the Right panel to create the view in the database.

Sage X3 and Sage Software are trademarks of Sage Software, Inc. Microsoft SQL Server, Microsoft SQL Enterprise Manager and SQL Server Management Studio are registered trademarks of Microsoft Corporation. Oracle is is a registered trademark or Oracle Corporation. All other product names used here are trademarks or registered trademarks of their respective owners.

Grouping Linked Tables

Use Data models (GESAWM) under Development setup in the Development > Data and Parameters block to define a group of linked tables (either directly or through cascade) by links of type (1,1) or (1,N) to a main table.

The data model (group of linked tables) can then be used in the following:

A workflow rule: Either because it features the only available context to describe the tables to be scanned (if using the Manual type), or to enrich the triggering context (if using the other types).

An allocation rule: Where the model is compulsory, it defines the group of tables containing the fields on which the user allocation rule is based. The data model associated with a workflow rule and the data model associated to the allocation rule must be absolutely identical.

The Template code identifies the current record.

The Properties section specifies the data model is linked to a structure, template with index, setup template, and/or a workflow.

The Main table field identifies the main table from which other tables are read using direct links or through cascade.

The Linked table identifies the table linked to the original table.

The abbreviation corresponds to the abbreviation under which the linked table is open.

If there is no entry at the Abbreviation field, the default abbreviation for the table is used.

It is particularly useful to enter an abbreviation if the table appears several times in the grid, because several linked lines in the same table need to be online simultaneously.

The Origin table field identifies the main table at the origin of the link described on the current line. It may be the main table, or one of the linked tables on the previous lines.

The Key field defines the table key code used to read the linked lines. By default, the first key of the table is used.

The Type field takes on one of the following values:

1,1: Means that for each line in the table of origin, only one line in the linked table is read (this line is defined by the key expression).

1,N: Several lines in the linked tables can be read. They are defined by the key expression that can be incomplete if it is divided into several parts.

The Link expression field is defined as one or more calculated expressions separated by a semicolon.

Each expression is evaluated, and the result used to identify the value of the key used to perform the join.

When multiple joins are authorized, only the first elements of the key can be given.

In the expressions, constants can be used, as well as fields coming from tables previously defined in the link list.

Table Maintenance

Use In lines (GMAINT) under Maintenances in the Development > Utilities block to modify the data in any table in the database without performing data validation or database integrity checking.

Warning: This function should only be performed by a developer. Access to this function should not be provided to unauthorized users. (Only users with the administrator profile ADMUSER should access this function.) Inappropriate use may corrupt the integrity of the data stored in the database.

After selecting the folder and table to perform maintenance on, click OK.

By default, the current folder is proposed; however, you can enter the name of another folder using the following syntax:

Folder: Directly enter the name of the folder. In this case, the folder must be accessible on the same server and service.

server@Folder: Enter the name for the server where the folder is located. An adxd service must work on the current service number to allow the connection.

Server:service@Folder: This uses the same principle as server@Folder, but the service number can be different. For example, this gives the syntax server_01:1811@DEMO.

Warning: These last two syntaxes assume the folder exists on the remote server. Entering an incorrect network name can result in a long wait time.

This function is primarily used to view data within the Sage X3 database.

Records can be modified, created, or deleted.

Key values appear in the first section of the window, while all other fields are listed spanning across several tabs.

The code in the header area is associated with each record.

The table fields are displayed over several tabs (not all are necessarily filled in alphabetical order.

Managing Tables

Use Tables (GESATB) under Tables in the Development > Data and Parameters block to view and manage tables inside the Sage X3 interface. This allows you to define the table structure and indexes. You can create or modify tables in the database by describing their characteristics in the data dictionary for the folder. Activity codes can be used to inhibit certain tables and/or indexes.

Note: Tables should never be modified outside of the Sage X3 Developer’s Toolkit.

At the Table code field, a table is identified by its name and also has an abbreviation. These identifiers must be unique.

In addition to the table structure, the following can also be defined in the data dictionary:

Links to other tables (referential integrity links). These links are used by the cancellation utilities, by the import/export functions, and other tools of this type.

Information proposed by default in the screens created from these tables.

When creating a table, the following limitations exist:

Keys are limited to 256 characters and 16 fields.

The number of open tables is limited to 255.

A record under SQL Server is limited to 8060 bytes. Under Oracle, there is no limit; but the Sage X3 limit is fixed to 32 K.

There is a limit of 255 fields per table and 512 columns.

The name and abbreviation of the table must be unique; no two tables can have the same name.

A table can be managed with the help of an object, providing that the necessary screens are created.

General tab

Use the General tab to enter or view general information relative to the table and its management.

The Activity code field is used in conjunction with the Module field to determine whether or not the table will be created in the database of the folder.

The title fields are used to identify the fields that have title in the table. This information is used to automatically display the title of a record where the key is known.

The Database type field is the base type for which the table must be generated.

A table starting with X, Y, or Z is considered to be specific/custom and is not affected by a version change. These activity codes can be placed at the line level.

Note the following dependencies of modules:

Supervisor and Common data: Must be installed as a minimum. The Stock, Development, and General accounting modules can then be installed after these.

Stock: After installing the Stock module, the Sales, Purchasing, and Production modules can be installed.

Sales: After installing the Sales module, the CRM and Commercial actions can be installed.

General accounting: After installing the General accounting module, you can install Fixed Assets and AR/AP.

Table management

If Folder is selected as the base type, a table is generated in the folder record for all the files of the folder.

The Number of records field is used to define the size of the table in the database. This value can be used to increase/decrease the size of the table in the database; however, if the actual physical size of the table is larger than the entered amount, then the physical size is used.

This value is entered when the folder and tables are created resulting from the evaluation of sizing formulas.

The sizing formulas use variables for which the values are entered in the folder parameters.

During revalidation of a folder, the number of records is re-evaluated, but the result is only re-written if it is greater than the value found in the table.

The Generate translated text check box is used to define the method used in Crystal Reports for the translated text in this table.

If the check box is selected, text is generated in sequential files textrafra, textraeng, etc. and used in the Crystal Report by the function X3TranslatedText.

If the check box is cleared, there is no file generation. The Crystal Report acting on this table uses a view.

The Reset to zero check box is used by the Return to Zero function, which removes all transactional data, but allows static data like product numbers, descriptions, customers, and addresses to remain in their files. Performing this allows you to start with a clean system in preparation for the first day of production, for example.

Select the Open access check box to restrict or allow access to the data table within the folder.

If this check box is selected, all the folders for the solution can access the table to read or write the data in the table.

If this check box is cleared, access to this table is made as a function of the rights to the call folder, which can be authorized or not for read/write.

Folder management

The Table type field is used to class the tables according to a classification used by folder management and can have the following values:

Application: This type corresponds to the default case (standard tables for a folder). These tables are present or not according to the activity code and module management.

Supervisor: The table becomes part of the supervisor data managed in each folder outside of the dictionary (users, operation logs, attachments, etc.).

Sage X3 System: The table is part of the general data not attached to a given folder (tables linked to the folder management, batch server, etc.).

Dictionary: The table, which is always present, forms part of the dictionary in each folder (reports, actions, screens, data types, etc.). The folder management takes into account, the tables in the dictionary during update management. The Copy type and Copy option fields are not available for this table type.

Internal: No table of this type is shipped and this table type is only used in the software development process.

The Copy type field determines if the creation of the table implies a transfer of the data between the reference folder and the folder to be created during the creation of the folder. This parameter can take the following values:

No Copy: The table is created with no data.

Automatic Copy: The data in the table is recovered from the data existing in the source folder (the reference folder by default).

Conditional Copy: The table data is copied by logical groups. A group is created by a choice from the local menu 26, entered in the Copy option field.

The Copy option field is available if the Conditional Copy option is selected at the Copy type field. Tables can be copied from the reference folder during the initialization of the generated folder if needed.

The Delivery type field is used internally. The options allow you to define the table for delivery or not and with data or not.

Columns tab

Use the Columns tab to add or modify columns (fields) in a table.

You can enter the title using three different lengths. The normal title is 20 characters, the abbreviated title is 12 characters, and the long title is 35 characters in length.

In the Column column, the field name for the table is defined.

The Menu column defines the local menu number associated with the field being defined.

You can use standard fields, which are automatically updated if they exist in object management. The standard fields include the following:

CREDAT and UPDDAT: These fields are the creation and update dates.

CRETIM and UPDTIM: These fields are the creation and last update times.

CREUSER and UPDUSR: These fields are the user codes associated with the creation and last update fields.

EXPNUM: This field is a sequential number used to date the records with respect to the import/export module (that makes it possible to only export that which has been updated since the last export).

The ENAFLG field is also inserted in each table. This field corresponds to the Active check box.

The Type field to define the type of field, such as alphanumeric, integer, decimal, etc. Many pre-defined type exist. Below are some of the main generic types:

A: Alphanumeric

C: Short integer

L: Long integer

DCB: Decimal

D: Date

M: Local menu

MM: Local menu with filter

ACB: CLOB

ABB: BLOB

Note: To view all the data types available, use the Data types function under Tables in the Development > Data And Parameters block. For more information, see the Data Types section.

The Length field defines the length of the field when the field uses a generic data type where the length is not fixed, as in the case of types A (alphanumeric) and DCB (decimal).

The Dim field is used to enter the dimension of a field. A dimension is the maximum value of an array.

The Key Work Help field provides help text that is linked to the current field.

Understanding field options

You can enter options for the field, such as centered, aligned to the left, etc.

For an alphanumeric field, the following options are possible.

Option	Meaning
A	Uppercase letters only: The characters entered are automatically transformed to uppercase.
#	Numbers only
T	Tokenization: Keywords are understood in the entry of a calculation formula.
D	No key word are authorized
C	Format the key
z	Non-displayed comments
X	Entry masked (passwords)
U	File format: (You can choose a file on the server or the local workstation. The path and file name are recovered.)
M	File format: (You can choose a file on the server or the local workstation. The path and file name are recovered.)
L	Complete length for the field.

For a numeric type field, the following options are possible:

Option	Meaning
z	Zero values not displayed
+	Only positive numbers
3	Separation if groups of 3 integers
F	Floating numbers: Used to provide precise control at the level of decimals. In the .srf file, a decimal section is generated whose length is the minimum integer (integer - 1) or to (28 - integer).
0	Display of 0 before numbers
-	Display sign +
D	Sign after the number

For a date type field, the following options are possible:

Option	Meaning
Z	Blank data authorized
z	Blank value not displayed
1	Date in the form: 18-01-11
2	Date in the form: 18-01-2011
3	Date in the form: 18 JAN 2011
4	Date in the form: 18 January 2011
5	Date in the form: 18-01
6	Date in the form: 01-02
7	Date in the form: 01-2011

For all field types, the following options are possible:

Option	Meaning
c	Display of a field in color according to the pcolor variable (managed only on the fields in grid block).
W	Contents of the field displayed at the bottom of the screen (only on the displayed screen).

Linked tables and expressions

The Linked table field displays a code for a table linked to that modified by the current field. For the data types referencing an object, this field is assigned automatically.

The Link expression field is only entered if a linked table has been specified. If this field is not assigned, the link is made directly from the field in the current line (which supposes that the primary linked table key is not the only component).

In the case where the primary key has several components, the link expression must be indicated under the form: comp1;comp2;comp3;… (where comp1,comp2, comp3 are the components of the key).

If a field MYFIELD is controlled in one of the miscellaneous tables (such as table number 43), the value 43;MYFIELD is placed in the Linked table column linked to the value ATABDIV and in the Link expression column.

If a field MYFIELD is indexed, the expression can use the index variable that can vary between 0 and dim(MYFIELD)-1. Examples include: the multiple statistics groups (products, suppliers, customers etc.) whose key structure is the group number followed by a statistic code. The key expression is then written in the form index+1;MYFIELD (index). If the key component is a global variable, you must specify the [V] class before the name of the variable.

During the cancellation of a line in a linked table (source table), an action can be carried out on the table that is currently being modified or created (destination table). This action is defined from the following:

Block: Cancellation of the record in the source table is not possible if a link exists with the table currently being defined.

Delete: Deletion of the records in the current table, verifying the link with the source table.

RTZ: Set the field in the current table to zero, verifying the link with the source table.

Other: No particular process is carried out.

The Verification field is used to indicate if the verification utility must verify the link.

The Mandatory field is used to define if the field can be empty or if it is mandatory that it contain a value. An empty field can be a string with an empty length, a null numeric value, a local menu values equal to zero, or an empty date [0/0/0].

When the field is the key field in a table, if the cancellation control is set to the RTZ value, the link cannot be mandatory, because the cancellation can erase the value of the key field. The Mandatory field is then set to No.

The RTZ field makes it possible to reset the field to zero when used in conjunction with the Reset to zero utility.

Index tab

Use the Index tab to define the different indexes defined in the table. The first index is the primary key of the table.

The Index code field corresponds to the name under which the index is known in the database.

The Index descriptor is where the list of fields that make up the index are entered. The fields are separated by a plus sign, if there are several fields.

The Duplicates column is used to define whether the key can or cannot accept homonyms.

If the Activity field is not assigned, the index is always present.

If this field corresponds to an inactive activity code, the index will not be generated.

You can add a specific/custom key by an activity code starting with X, Y, or Z.

Configuration file

Use the Configuration file section to describe the technical configuration of the table in the database.

This text is recorded in a .cfg file in the FIL directory of the application.

This file is used by the valfil instruction.

Audit tab

Use the Audit tab to track changes to records. Settings are used to log, by means of automatically generated database triggers, the insertions, deletions, and modifications carried out on a table. The “before” and “after” values are stored, if needed, for certain fields. The modification of the record is logged if one of the conditions on the field has been verified. The “trigger” technique is used to log the operations even if a program other than Sage X3 is used.

Audit settings are not shipped with the standard software. This tab is therefore reserved for customizations and no protection is required by activity code X, Y, or Z.

Use the check boxes in the Type of audit section to define the operations to be logged for the records in the table.

Select the Workflow check box to automate a workflow notification process.

In the Tracking key section, specify the key for the table. You should not use a homonym in order to aid the reading of the record in the audit.

Sage X3 triggers create SQL triggers in the database (either SQL Server or Oracle). This means as long as the trigger is active, regardless how the data is manipulated, SQL will audit the changes. In Sage X3, these are referred to as audit triggers.

Note: Audit triggers, particularly on tables that have a high change rate, may affect performance.

Clicking Validation creates the SQL triggers.

Workflow

At the Workflow field, a workflow batch task triggers an event for each line of the AUDITH table where the workflow status is to be processed.

The Audit BI check box is used for the incremental synchronization of the BI facts table and is active only if the ABI activity code is active.

Fields audited

The Fields audited section lists the fields to be audited. Do not enter this grid if a log of only the operations carried out on a record is required.

A log is generated for a modified record if at least one of the conditions on the fields is verified by the new values of the field. A log is generated if a record is created or deleted.

The audit is globally set by the activity code AUDIT.

The log is stored in two dedicated tables: AUDITH and AUTITL.

The following cannot be audited:

The audit tables themselves.

The fields of type CLOB and BLOB.

The fields whose data type is AXX.

The SUBTRIGGER process contains the description of the triggers as a function of the database.

The SPETRIGGER process is reserved for customization in order to personalize their description, if required.

Validation

After saving changes to a table or creating a new table, you must click Validation. The validation creates the SQL triggers.

-

Monday, November 27, 2017

Resetting a Folder to Zero

Use Reset folder to zero (RAZDOS) under Folders in the Development > Utilities block to reset the folder transactions to zero. (Static or common data is untouched.)

This may be useful to perform after startup in test mode or after recovery of a folder’s permanent data (chart of accounts, customers, products, etc.).

For example, you may want to purge the database of the transactions created in the test phase, just before the import of actual transactions and the operational startup of a folder.

Note: Order numbers are not re-ordered.

Warning: This process is irreversible and can lead to loss of transaction data in a folder. Therefore, you should use extreme caution when running this utility. Be sure to back up your data in order to recover it if needed.

Users should be logged out of the system before running this utility.

Each table structure has a Reset to Zero (RTZ) flag at the table level and the field level.

If the RTZ check box is selected, this utility will clear all the records from that table.

If a field has the RTZ check box selected, this utility will clear that field in every record in the table.

You can also reset to zero at the table level (Development > Data and parameters > Tables).

Working with Activity Codes

Activity codes are applied to Sage X3 dictionary elements. Activity codes are used to perform a variety of functions, such as protecting and identifying specific developments, and activating/de-activating tables, screens, fields, etc. For example, the LOT activity code is used to manage the activity of lots in Inventory.

A folder’s activity codes are stored in the X3.ADOSACT table for all the folders (contains all the activity codes for the environment), and in the ACTIV table in every folder.

In the X3 folder: Folders > Folders

In the child folders: Development > Data dictionary > Activity codes

Use Activity codes (GESACV) under Development setup in the Development > Data and parameters block to activate or de-activate elements in the dictionary, such as tables, table indexes, tabs, screen sections, or fields. For example, you can activate or de-activate certain fields on screens.

Sizing activity code

Functional activity code

You can mark an activity code as a Sizing type and then use it to control, for example, how many lines are available to add to a shipment.

When an activity code is modified in the child folder (ACTIV) table, changes are automatically made to the value of the child folder’s activity code in the reference folder (Folders > Folders, table ADOSACT).

An activity code can be activated only if it is already active for the reference folder.

When an activity code is modified, it is necessary to revalidate all linked objects in the folder in order for the modification to be taken into account (access Dictionary under Dictionary >Validation in the Development > Utilities block).

As discussed in the previous lesson, activity codes that are linked to the sizing (dimension) can be viewed or modified using the Screens tab in Folders (Setup > General parameters).

The screen’s table is set to the dimension based on the activity code.

Personalization Management

Use Personalizations management in the Administration > Utilities block to define a set of filters on the administration data and to allow quick extraction of the data associated with dashboards, gadgets, menu items, and personalized pages. The created format is a JSON format that can be integrated in another version 7 repository using the Import session function. The import tool allows you to import data in the version 7 repository and create a journal of the modifications that can be displayed.

Note: This function should only be used by advanced users.

After selecting a personalization link in the list, a window appears allowing you to modify the Information, Dashboards, Pages, Navigation pages, Home pages, and Menu fields. Click Edit to make modifications to an existing personalization management.

Scheduling personalizations

Click Schedule Personalizations update to schedule the export of personalizations.

Defining Menu Categories

Menu categories are used to further organize menu items within menu sub modules (blocks) on navigation pages as shown below. You can expand or collapse individual menu categories or use the arrows in the upper right corner of a block to expand or collapse all of the menu categories in a block at one time.

Accessing the Menu categories function

Use Menu categories in the Administration > Authoring block to define menu categories for organizing menu items on a navigation page.

Creating a menu category

To add a menu category, click New menu category in the Right panel in the List of menu categories window. To modify a menu category, click the pencil icon for the menu category in the List of categories.

Modifying a menu category

To modify a menu category, click the pencil icon for the menu category in the List of menu categories or click the Edit button from the Right panel in the Menu categories function window.

Defining Menu Items

Menu items are located within sub menus (blocks) on navigation pages as shown below. Menu items can be used to link to representations, functions, processes, queries, statistics, dashboard pages, and external links.

Accessing the Menu items function

Use Menu items under Pages in the Administration > Authoring block to define menu item links.

Information

Use the Information section to define the main characteristics of the link, including the following:

Code: Not mandatory. If no entry is made, it will be assigned with an internal code that will not be displayed.

Title: This field is mandatory and appears when a menu item is referenced. For Classic functions, it is recommended to use the function code. For Entities / Representations pages, it is recommended to use the representation code.

Description: This is a user-friendly description of the menu item.

Link type: Indicates what kind of page will be called if the link is activated. The following choices are available:

Representation is a page that manages a facet of an entity. Thus, the user will have to enter an entity, an associated representation and a facet.

Function (Classic) is a page that manages a function in Classic mode. Therefore, the function code must be entered.

Dashboard page is a link that brings the user to another dashboard. The code of the dashboard is required.

External link is used when the menu item links to a URL that will have to be given.

Icon: Indicates the file name and repository of the icon to display.

Application menu: This check box is used to define how the menu item appears on mobile clients. This is subject to change in a near future.

Content

Use the Content section to define additional information:

Application: Entered for Representation and Function (Classic) link types. This field refers to the application used for the link.

The Syracuse collaboration application is used to connect administrative, collaboration, and authoring pages directly managed by the node server.

The application is mandatory if the link is a Classic type link.

Endpoint: Can only be entered for Representation and Function (Classic) link types. If entered, the link will automatically be displayed in a vignette (if the vignette is associated with the right endpoint).

Representation: Entered for Representation link types only. Defines the representation used for the user interface. This representation is linked to the entity; therefore, only some representations are available for a given entity. A selection is possible in the same conditions as for the entity definition. Only a representation attached to the previous entity can be used.

Action: Entered for Representation link types only. Determines the facet of the representation that will be used. The following facets can be selected:

Query is used to display a page that lists the entity values and allows to display the detail of an entity instance, or to edit it, or to create a new instance.

Details is used to display the detail of an entity instance. A key value must be entered.

Edit is used to modify the detail of an entity instance. A key value must be entered.

Statistics is used when a statistical inquiry page is displayed.

Parameters

Use the Parameter section contains additional values depending on the link previously defined. The value that can be sent to the function is usually for the object types function called GESxxx_.

Depending on the entity, additional parameters may have to be entered. If this is the case, the name and title columns will be filled and the value column must be entered.

The parameters available may depend from the page called. But some standard parameters exist especially for query facets, and are documented here.

Display

Open in: The choice can be:

Same window: where the page opened by the menu item link will replace the current page,

New window: where a new tab will open in the browser to display the page called by the item link.

Classification

The Classification section is used for organization purposes and is optional.

Module: Select the module where you want to place the menu item.

Categories: Item menus can be associated with categories. The assignment can be done in categories with a selection window allowing multiple selections.

Creating a menu item

To create a menu item, click Create menu item in the Right panel from the List of menu items window.

Modifying a menu item

To modify a menu items, click the pencil icon for the menu submodule in the List of menu items or click the Edit button from the Right panel in the Menu items function window.

Defining Menu Submodules

Menu sub modules contain menu items on navigation pages as shown below. Menu submodules are also known as “blocks” and help organize menu items on a navigation page.

Accessing the Menu submodule function

Use Menu submodules under Pages in the Administration > Authoring block to define menu submodules that are organized under menu modules on navigation pages.

Creating a Menu submodule

To add a menu sub module, click Create menu submodule in the Right panel from the List of menu submodules window.

Modifying a Menu submodule

To modify a menu submodule, click the pencil icon for the menu submodule in the List of menu submodules or click the Edit button from the Right panel in the Menu submodule function window.

Defining Menu Modules

Menu modules are located on the left side of navigation pages as shown below and allow you to access sub modules (blocks) and menu items specific to the module.

Accessing the Menu module function

Use Menu modules pages under Page in the Administration > Authoring block to define menu modules on a navigation page.

Creating a menu module

To add a menu module, click Create menu module in the Right panel in the List of menu modules window.

You can assign submodules, endpoints, and navigation pages as well as the application.

Modifying a menu module

To modify an existing menu module, click the pencil icon for the menu module in the List of menu modules or click the Edit button from the Right panel in the Menu module function window.

Defining Home Pages

Home pages are based on the user's identity and role. Additional landing pages can be defined to be used as alternative home pages.

What is a home page? A home page typically displays landing pages containing information such as requests, statistics, as well as process maps and small information pages. You can access home pages by click the Home icon in the Upper bar.

An example of a home page with the A/R accounting manager landing pages is shown below.

Accessing the Home page function

Use Home pages under Pages in the Administration > Authoring block to define or create home pages (landing pages).

Creating a home page (landing page)

To create a new home page (landing page), click Create home page in the Right panel in the List of Home pages window.

You can assign vignettes to a home page by selecting vignettes (menu items) and endpoints.

You can also assign roles and an owner for the home page.

Modifying a home page (landing page)

Click Edit page content in the Right panel to open a graphical interface allowing you to edit or personalize the content of a home page (landing page).

Use the editing tools to add gadgets, refresh the page and personalize the page.

Defining Navigation Pages

The Navigation pages function associates modules and roles with a navigation page. What is a navigation page? A navigation page is considered a “site map” and is accessed from other pages by clicking the Navigation icon (compass icon) in the Upper bar.

An example of a navigation page is shown below.

Accessing the Navigation page function

Use Navigation pages Under Pages in the Administration > Authoring block to define navigation pages. Click a page name link to open an existing Navigation page.

Creating a navigation page

To create a new navigation page, click Create navigation page in the Right panel in the List of Navigation pages window.

You can add new modules to the navigation page.

You can add new roles to the navigation page.

Modifying a navigation page

To modify an existing page definition, click the pencil icon for the navigation page in the List of Navigation pages or click the Edit button from the Right panel in the Navigation page function window.

Defining the Main Page Characteristics

Use Pages under Customized pages in the Administration > Authoring block to define the main characteristics of the page. A page defines a description made by the authoring function that changes the default layout of a page sent by the endpoint with which it is associated. A page can have several variants associated with different use cases. Deleting the page will restore it to its default layout. To add a page, click Create customized page in the Right panel in the List of page definitions window. To modify a page definition, click the pencil icon for the page definition in the List of page definitions that initially displays.

Only the pages that have been modified by authoring will appear on the list of pages.

The code that is present only on the query, defines the activity the page is linked to. The format of the code:

Type of page	Code
Administration page for entity xxx and for facet fff	syracuse.collaboration.xxx.$fff
page for representation rrr and for facet fff	x3.erp.rrr.$fff
Classic page for window xxx	x3.erp.xxx.$fusion

Information tab

Use the Information tab to define the main characteristics of the page, including the Code, Title, Description, Representation, Facet, Device, Application, Author, and Author type.

The device corresponds to the device the page is designed for, such as Desktop or Phone.

The Application field defines the application the representation is originated from. It can be either Syracuse Collaboration or X3 ERP.

Facets that can be selected include: Query, Details, Edit, Lookup, Select, and Convergence (Classic).

After selecting a page from the list of pages, a window appears with Information and Variants tabs. Click Edit to make modifications to an existing page.

Variants tab

Use the Variant tab to list different available variants. At least one variant exists. For every variant, you can define a list of roles, users, and endpoints the variant applies to.

When clicking the chevron on the line associated with a variant, three tabs appear:

Applies to Roles: A list of roles can be provided. If no role is provided, the page can be used by every role; otherwise, only the listed roles can have access to it.

Applies to Users: A list of users can be provided. If no user is provided, the page can be used by every user; otherwise, only the listed users can have access to it.

Applies to Endpoints: A list of endpoints can be provided. Only endpoints attached to the right application can be chosen. If no endpoint is provided, the page can be used by every endpoint; otherwise, only the listed endpoints can have access to it. If the Is factory check box is selected, the variant is the default value that was originally supplied with the software.

Note: The only actions possible on this grid are to delete a variant or to modify its characteristics. No insertion of a variant is possible. The variants are created by the authoring action and their name is given by default when the authored page is saved.