Wednesday, November 22, 2017

Defining Folders

An important task as a system administrator is creating and updating folders. Use Folders (GESADS) in the Setup > General parameters block to create and update a folder. A folder is a complete reference, identified by a code, which contains all the setup and management rules for the data used. The settings of a folder are defined in the Folder table. As long as the folder is not yet created and validated, you can modify the settings.

A folder is characterized by:
  • A root directory and a group of sub-directories on the application server. The SAFE X3 objects derived from the settings can be found there.
  • An Oracle user (or a user combination, login with SQL Server) defined for the database server. All the database tables are attached to it.
  • You can enter up to 10 text alphanumeric characters for the folder name.

General tab


Use the General tab to enter the main organizational information for the folder definition. Folders must be defined before you can start the setup and/or the entry of data. It is considered best practice to create the folder(s) directly with the settings that will be used in production.

  • This phase determines the correct initial sizing for the database and avoids having to use the tools of the database to resize the database.
  • In addition, in the production folder, a revalidation can be a relatively long operation and requires that no one be connected to the folder being processed.

Installed modules section

  • The grid displays the modules contained in the folder being generated. Only tables associated with activated modules are used in the folder once it is created.
    • You should only activate the modules that will be used in your solution.
    • This makes it possible to create only the tables and objects actually used and will keep the creation time and disk space to a minimum.
    • You can always add modules to your system at a later time. 

Basis section

  • The database type can be SQL Server or Oracle and is used to define the database in order to create the folder.
  • The volume number corresponds to the directory where the physical files (not in the database) describing the folder objects are placed on the process server.
    • The Safe X3 volumes are defined in the adxvolumes file in the installation directory (contained in the ADXDIR environment variable). The default volume is A, but other volumes can be defined when installing the software.

SQL server section

  • If using SQL server as the database, the File group field is used to define if separate files are created or not to store the indexes and the data.

Base sizing section

  • The values in the Base sizing section are used to size the data files and the index in the database and are expressed in megabytes.
  • The database size values in the Base sizing section are used when creating a folder.
    • These values are usually entered after the folder definition process and before the folder is created.
    • It is recommended that you first get an estimate for these values using the Tables tab.
    • You should also first define the table structure of the database using activity codes (options, screens, customizations, etc.).

Folder type

  • A reference folder is always the starting point for the creation of a folder. A reference folder is delivered with the software, but any other folder can act as the reference.
    • The reference folder must be an existing folder, where the data dictionary will be used during the initialization of the folder.
    • A link is established between a folder and a reference folder.
    • By default, if a resource cannot be found in the current folder, it is searched for in the reference folder by an inheritance mechanism.
  • The Copy folder field is the folder from which the data defined on the Initialize tab will be copied.
  • The Purge folder cannot be entered directly in the management of a folder. Rather, it is entered when an archiving folder is created after a live folder is created. The archiving folder is used to store the data that is not changing.
  • The Start date corresponds to the start date of the first financial year from which the enterprise data will be managed within the software. The start date cannot be changed at a later time.
    • It is important to start from the previous financial year that the installation will actually start with.
    • The Start date is used to define the date of the first financial year for a newly created folder.
    • By default, the value of the two supervisor parameters STRDAT and ENDDAT, which define the possible connection period, are defined by:
    • STRDAT = Entry date
    • ENDDAT = max(STRDAT + 12 months, Current date)
    • These two parameters, which can be modified later, are used on the connection to the folder. It is controlled so that the entry date is contained between the dates defined by these two parameters.
  • The Folder currency field makes it possible to update the parameter SYSCUR in the folder.
    • This parameter cannot be modified by the folder management after generating the folder.
  • The Test folder check box signifies that this folder is designed to receive a copy of the standard processes present in a patch. This allows you to test patch integration and folder behavior after patching.
    • If this check box is cleared, the patch processes are only integrated at the supervisor folder level.
    • If this check box is selected, you can carry out integration tests for patches in a folder.
    • A production folder must not have this check box selected.
  • The Specific folder check box signifies that the specific/custom processes present in a patch will be installed in the folder even if they did not previously exist.
    • The custom processes can start with the letters X, Y, or Z, or SPE or CNS.
    • If this check box is cleared, only the previously existing specific/custom processes will be replaced in the folder by the new version present in the patch.

Sizing section


In the Sizing section, you can determine the maximum size taken by default in the BLOB files (binary large objects) for images and CLOB fields (character large objects) for text stored in the database. The Image size field stores the BLOB file maximum size and the Text size field stores the CLOB field maximum size.
  • The values in this section correspond primarily to the images stored in the database.
  • These fields are defined as having the power of 2. 1 is equivalent to 2 KB, 2 is equivalent to 4 KB, and so on. The corresponding value is displayed up to 20, which is equivalent to 1 GB.
  • Note: Each CLOB file can be sized differently in the database.

Setup kits tab


A Setup kit is a complete set, identified by a code, containing all the parameters, management rules, and data used to generate a new folder. The Setup kit is an optional package that can be selected and manually included on a folder.

  • When using Setup kits:
    • The Setup kit configuration is cumulative and may override some of the Deliverable configuration (describes the license policy)
    • A Setup kit may add data for an object, but it does not remove data.

Options tab


Use the Options tab to view the tables with activity codes relating to the data structure. The Active status of these codes can be set to Yes or No.


  • The activity codes selected activate the corresponding functionalities. For example, ABI activates the Business Intelligence functionalities.
  • Selecting Yes in the Active column activates the tables, screens, and fields belonging to the option.
  • Note: When a folder is created from a reference folder other than the supervisor folder, only the activity codes that are set to Yes in the reference folder can be set to Yes in the created folder.

Screens tab


Use the Screens tab to control the size of screens that are used to enter multi-line documents.


  • Two types of activity codes are used:
    • The first type of activity code defines a quantity of memory used for the screen. Modifying these values only involves revalidating the screens and windows involved. Caution should be taken not to oversize certain values. Doing so may increase the allocated memory for each workstation. You can, however, define additional memory quotas for menu profiles if functions consume large amounts of memory reserved to certain users.
    • For the second type of activity code, a dimension is entered to define the number of values that can be entered in the associated screens, but also the structure of the corresponding tables in the database. Modifying these values results in revalidating the tables in the folder.
  • The Screen size field is used to define the number of occurrences used in the screens and tables involved.
    • For a table, a minimum and maximum number can exist, which leads to the use of the following formula to size the tables.
    • Min(max(MIN,SCREEN),MAX)
  • The Min extension field is used to define the minimum number of columns stored in the database, independently of the number displayed in the screen, which can be lower.
    • This is used to avoid the standard reports from making references to columns that do not exist.
  • Use the Max extension field to define the maximum possible dimension taken into account in the table structures in the database. The maximum values should not be exceeded. Doing so results in a table with column or line sizes different from the allowed values.

Tables tab


Use the Tables tab to enter values for calculating sizing algorithms as follows:

  • For each database table, a physical storage size is estimated. This physical size is used during the definition of the table characteristics, such as planned size and extents management in Oracle.
  • Cumulative - the global size of the dataset.
  • Note: It is important to have good information for these settings, taking historic information into account.

  • The volume column displays the value associated with the sizing element of the line.
  • The sizing elements are used in the sizing formula calculations to estimate the number of lines planned for each table, which are used to calculate the planned size of the tables.

Initialize tab


Use the Initialize tab to view or modify the default values that are used when the folder is created. These settings influence the way a folder is revalidated.


  • If a module is added that activates a table that is not used yet, these settings are used when the folder is created or upon revalidation.

Transaction validation section


The Transaction validation grid is used to prevent all screens associated with a base screen from being revalidated. (A revalidation can take a while to perform.)

Languages section


In the Languages section, only select languages that are useful in order to speed up the folder creation.
  • In the Translation column, select the check box to indicate the current folder is a reference folder for translation purposes.
The Languages section allows you to define a list of languages that can be used when connected to the folder.
  • The Translation ref field is used to specify that the current folder is the reference folder for the translation of the language in question. This field can only be selected if the following two connections are met:
    • The language is not shipped as standard.
    • The language is not already selected for another folder in the current solution.

Copy data section


The options in the Copy data section are used to enter the data of some tables from the table content of another folder based on the entry made at the Copy folder field on the General tab.

  • Each line in the grid corresponds to a coherent group of tables in the copy folder. These are tables where the contents can be copied in the folder currently being modified during its creation.
  • The copy function is only carried out when creating a folder or in the case of creating tables following the activation of a new module.

Default values section


In the Default values section, select the language to use a default when it is not specified, for example, during batch processing.

Update section


The check boxes in the Update section are used to avoid the code regeneration associated with a certain number of elements in the dictionary during folder revalidation. This shortens the revalidation time.

  • For security reasons, these check boxes can only be cleared in a development folder and must be done so with caution.

Specific tab


Use the Specific tab to define the connection characteristics of the folder, such as the information in the connection screen of the workstation connecting to the folder.

  • The information entered here is used to update a configuration file located on the server in the root directory of the supervisor folder. This is the ADXAPPLI.Ux3a file.
  • The Code field defines the custom activity codes starting with X, Y, or Z, which can be activated in the folder.
  • If the Active field is set to Yes, the fields marked by the activity in the dictionary are activated.
  • The dimension associated with a custom activity code is used to size the grids and fields marked by the activity code.
  • The Vertical field must be set to Yes in the following situations:
    • A three-level architecture is being used (reference folder, development folder and live folder).
    • The associated customizations are automatically transferred to the lowest level folder when revalidating or patching.
    • If the Vertical field is set to No, the customizations are not updated when revalidating, if they already exist.

Miscellaneous tab


Use the Miscellaneous tab to define the engine/database processes to maximize performance. The data entered is stored in a configuration file named APL.ini, which is located on the server in the folder root directory, after it is created. These settings have a minimum value that is used if the values in this tab are not sufficient.

Note: Be sure to save memory for other processes and the operating system on the
server.


  • The memory entered is the size used for the local data during the execution of the server process.
  • The Database process memory field defines the memory size allocated to the process accessing the database.
  • The Programs field is used to define the maximum number of processes open simultaneously in the software session.
    • The default value is 200 with a minimum value of 100.
    • A higher number improves the performance by limiting the reloading of processes.
    • The system variable asxmpr is used to identify the current value during a session.
  • The Open tables field is used to define the maximum number of tables in the database simultaneously online in a software session.
    • The default value is 150 and is appropriate in most cases.
    • The system variable adxmto is used to determine the current value during a session.
  • The Sequential files field is used to define the maximum number of sequential files open simultaneously in a software session.
    • The default value is 10, with the minimum value being 10.
    • Except in a few cases, there is no reason to modify this value.
    • The system variable adxmso is used to identify the current value during a session. 

Links tab


Use the Links tab to define the links to folders located on other solutions (that is on another server or another connection service, or both). This makes it easier when sharing or updating common data. A typical example is when updating financials located on a remote folder.


  • The Application server is the name or the network address of the application server.
  • The Port field defines the TCP/IP port on which the connection server expects the connection requests from the folder.
    • The Access path field displays the path of the root directory of the folder as it is defined on the application server.
    • It is defined as a function of the volume entered in the first tab of the folder record.
    • When connected to the folder, this information can be determined by entering Filepath(“ “, “ “, “ ”).
  • The Process server field corresponds to the name or the network address of the process server proposed by default. (There may be more than one name or network address and by default it can be the application server.)
    • A process server is a server on which the application code transmitted by the application server is executed.
  • The Publication directory corresponds to the application’s server directory from which the XML elements defining the user interface are created.

Access rights to the folder


The Access rights to the folder grid allows you to specify how this folder can access other folders on runtime. The choices are None, Read, and All.

Folder links outside of the solution


The Folder links outside of solution grid allows you to define links used external to the solution.
  • Link type: Define the type of link as with a miscellaneous link, which must be managed as specific/custom in the process, or as a characterized link, (such as To Accounting, To Fixed Assets, To Pay, or To Logistics). This type of link is managed by the software when required. A single link for each type may exist for a given folder.
  • Active link: This is a display-only field that identifies whether the link is active.
  • Machine: This is the network path defining the remote server to which to be connected.
  • Service: This is the number of the remote server to which the connection is made.
  • Directory: This is the installation disk address for the remote solution. It is this location that the directory that is used in the remote connection will be created if a folder of the same code as the current folder does not exist. This address corresponds to a database directory (volume 0 in adxvolumes) on the application server.
  • Type of OS: This defines the operating system of the server to which the link is made.
  • Linked folder: This defines the linked folder to be connected to. This information is mandatory when the link is characterized, but not for a miscellaneous link.
  • Solution: This field provides the name of the solution, if this can be found in the configuration.xml file.
  • Database type: This defines the database type to which the user is to be connected.
  • Name of the database: This corresponds to the name of the remote database.
  • Data source: This field gives the name of the ODBC data source if this can be found in the configuration.xml file.
  • DBMS user: This defines the user code (in the database sense) used for the connection.
  • Password: This defines the password (in the database sense) for the user to connect to the remote database.
  • System user: This is the platform used by the Java Bridge to open a remote session.
  • Password: This is the password of the user platform used by the Java Bridge to open a remote session.

Archiving a folder


Use Create archive folders (CREHISTO) under Folders in the Development > Utilities block to transfer data to an archive database considered as closed. Only inquiries can be carried out on the data; the data cannot be viewed simultaneously with non-archived data.

  • The archiving of data is carried out by the transfer of data from a folder table to a table with the same structure, with two additional fields (CREHISAT and CREHISUSER), making it possible to determine the dates and operators that archive the data.
    • This table is defined in a dedicated folder, which uses the current folder as the parent folder.


-
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.
-