Index

The developer guide includes the following documents:

Classes Management

• Developer Guide Classes: Introduces the context of classes, linked to more detailed documents.
• Developer Guide Classes Dictionaries: Describes how a class is defined in dictionaries.
• Developer Guide Classes Script: Describes the Sage X3 script instructions and functions supporting the classes.
• Developer Guide Classes Standard Methods: Describes the standard methods available for classes.
• Developer Guide Classes Events: Describes the general principles of event execution.

Representations

• Developer Guide Representations: Introduces the context of representations, linked to more detailed documents.
• Developer Guide Representations Events: Describes the general principles of event execution in representations.

Development Tools and Techniques

• Developer Guide Constants: Describes how to create and use constants.
• Developer Guide Context: Describes the context resources that includes global variables, cached classes, parameter values, license control and access rights. Every component stored in the context is described in a dedicated document:
  • Developer guide context global variables: Describes the implementation of the context variables.
  • Developer guide context parameters: Describes how the parameter values are handled in context.
  • Developer Guide Cached Classes: Describes how to manage "read" cache in the context.
  • Developer guide license: Describes how to access to license definition in context.
  • Developer guide access rights: Describes how to check the rights on functions in context.
• Developer Guide Restricted Formula for Key and Parameter Values: Describes the subset of a formula available for some parameter and key segment values that need to be evaluated locally by the client.
• Developer Guide AVOID Parameters: Describes a void class used when a parameter passed by address is meaningless in the calling context and thus will be ignored.
• Developer Guide Error Handling: Describes the methods, variables, and functions available to manage the errors.
• Developer Guide Managing Log Files: Describes how to manage the log files.
• Developer Guide Profiling Code: Describes how to profile the script execution to analyze potential performance issues.
• Developer Guide Snapshots: Describes the general principles of snapshot use.
• Developer Guide Technical Columns of Database: Describes the columns automatically managed by the database tables.
• Developer Guide memory requirements on the server: Describes how the memory is managed on the server.
• Developer Guide optimistic lock: Describes how the CRUD operations manage the concurrency conflicts for updates.
• Asynchronous operation management: Describes how to handle and control asynchronous operations.
• Developer Guide Hybrid: Describes how to use Classic UI with classes.
• Call between classic code and V7+ code: Describes how to perform calls of Classic routine within V7+ code and vice-versa.
• Upgrade Developer Guide: Describes the upgrade global process and in attached documents: the data upgrade process, how to update upgrade processes and performance rules.
• Developer Tools Panel: Describes the panel available for developers containing the most used links.

Administration tools

• Developer Guide Search Engine: Describes the general principles of the search engine included in the platform.
• Developer Guide Item menu parameters: Describes the standard parameters that can be sent in a menu item.
• Authentication and single sign on principles: Describes the main principles used for authentication.
• Main principles about badges: Describes how the badges are working.
• Release numbers: Describes the functions that returns release numbers for the platform and the different folders.
• Developer Tools Panel: Describes the panel available for developers containing the most used links.