Sage X3 ERP

https://online-help.sagex3.com/erp/12/fr-fr/
Admin
Sage X3 ERP is an enterprise resource planning system that manages business operations across...
Tokens:425,285
Snippets:2,446
Trust Score:7.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install and Start Sage X3 Services (PowerShell)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-installation

This PowerShell command installs and starts the Sage X3 Services Windows service from the new installation folder. Successful execution will display 'Install complete.' and 'Start complete.' messages.

```powershell
PS D:\SageX3\x3-services> .\install.ps1
Install complete.
Start complete.
PS D:\SageX3\x3-services>
```

--------------------------------

### Sage X3 Developer Studio Configuration Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-dev-studio-installation

Example configuration for the `xtrem-config.yml` file used to connect the Sage X3 developer studio to Sage X3 services. It includes database connection details and API endpoints.

```yaml
development:
  api:
    driver: tedious
    hostname: localhost\SQL2K22FORX3
    port: 1433
    database: x3v12
    user: "user"
    password: "password"
    folderName: SEED
    reference: X3
    defaultLanguage: ENG
    url: http://x3erpv12:8124/xtrem/mutation
    secret: "YOUR_SECRET_KEY"
```

--------------------------------

### Install Sage X3 Developer Studio (Windows)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-dev-studio-installation

Installs the Sage X3 developer studio on a Windows operating system. This command cleans previous installations and sets up the studio for Windows environments.

```bash
npm run clean:install:win
```

--------------------------------

### Install Sage X3 Developer Studio (Unix)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-dev-studio-installation

Installs the Sage X3 developer studio on a Unix-like operating system. This command cleans previous installations and sets up the studio for Unix environments.

```bash
npm run clean:install:unix
```

--------------------------------

### Node.js Nanny Process Installation Command

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_load-balancer

This command installs the nanny process, typically during setup. It registers the local host in the 'host' entity and specifies the number of child processes and optional web service processes. The command itself does not start the nanny process.

```bash
node nanny install 8000 2
node nanny install 8000 2 3
```

--------------------------------

### Example: Get description for 'user' entity

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/how-to_how-to-transfer-administration-data

This example demonstrates how to specifically retrieve the description for the 'user' entity. The resulting JSON output provides a structured view of all properties, their types, capabilities, and relationships associated with the user entity.

```JSON
{
  "$type": "application/json",
  "$prototype": "{$baseUrl}/$prototypes('{$representation}.$details')",
  "$url": "{$baseUrl}/{$pluralType}('{$key}')",
  "$shortUrl": "{$baseUrl}/{$pluralType}('{$key}')",
  "$value": "{login}",
  "$title": "{firstName} {lastName}",
  "$key": "{$uuid}",
  "$description": "{firstName}'s profile",
  "$pluralType": "users",
  "$representation": "user",
  "$properties": {
    "login": {
      "$title": "Login",
      "$displayLength": 8,
      "$isUnique": true,
      "$isMandatory": true,
      "$capabilities": "sort,filter,alphaTab",
      "$links": {
        "$details": {
          "$type": "application/json;vnd.sage=syracuse",
          "$url": "{$baseUrl}/{$pluralType}('{$key}')?representation={$representation}.$details&role={$role}"
        }
      },
      "$type": "application/x-string"
    },
    "title": {
      "$title": "Title",
      "$displayLength": 4,
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-choice",
      "$value": {
        "$type": "application/x-string",
        "$enum": [
          {
            "$value": "mr",
            "$title": "Mr."
          },
          {
            "$value": "mrs",
            "$title": "Mrs."
          }
        ]
      }
    },
    "firstName": {
      "$title": "First name",
      "$displayLength": 12,
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-string"
    },
    "lastName": {
      "$title": "Last name",
      "$displayLength": 12,
      "$isMandatory": true,
      "$capabilities": "sort,filter,alphaTab",
      "$links": {
        "$details": {
          "$type": "application/json;vnd.sage=syracuse",
          "$url": "{$baseUrl}/{$pluralType}('{$key}')?representation={$representation}.$details&role={$role}"
        }
      },
      "$type": "application/x-string"
    },
    "active": {
      "$title": "Active",
      "$capabilities": "sort,filter",
      "$type": "application/x-boolean"
    },
    "authentication": {
      "$title": "Authentication",
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-choice",
      "$value": {
        "$type": "application/x-string",
        "$enum": [
          {
            "$value": "",
            "$title": "Standard"
          },
          {
            "$value": "db",
            "$title": "DB"
          },
          {
            "$value": "ldap",
            "$title": "LDAP"
          },
          {
            "$value": "oauth2",
            "$title": "OAuth2"
          }
        ]
      }
    },
    "authenticationName": {
      "$title": "Authentication name",
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-string"
    },
    "email": {
      "$title": "Email",
      "$displayLength": 30,
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-string",
      "$format": "$email"
    },
    "photo": {
      "$title": "Photo",
      "$capabilities": "",
      "$type": "image",
      "$url": "{$baseUrl}/{$pluralType}('{$key}')/photo"
    },
    "infov6": {
      "$title": "Connection information for V6",
      "$capabilities": "sort,filter",
      "$type": "application/x-boolean"
    },
    "userv6": {
      "$title": "User",
      "$capabilities": "sort,filter,alphaTab",
      "$type": "application/x-string"
    },
    "changePassword": {
      "$title": "Require password change",
      "$capabilities": "sort,filter",
      "$type": "application/x-boolean",
      "$isNullable": true
    },
    "explorer": {
      "$title": "Explorer",
      "$capabilities": "sort,filter",
      "$type": "application/x-graph",
      "$format": "d3.nodeChart",
      "$url": "{$baseUrl}/{$pluralType}('{$key}')/$graphs/explorer",
      "$linkCategories": [
        {
          "$name": "groups",
          "$title": "Groups"
        },
        {
          "$name": "groups.endPoints",
          "$title": "Endpoints"
        },
        {
          "$name": "groups.role",
          "$title": "Role"
        },
        {
          "$name": "adminTeams",
          "$title": "Teams administrator"
        },
        {
          "$name": "authorTeams",
          "$title": "Teams author"
        },
        {
          "$name": "memberTeams",
          "$title": "Teams member"
        }
      ],
      "$nodeCategories": [
        {
          "$name": "user",
          "$title": "Users",
          "$selected": true,
          "$prototype": {
            "$properties": {
              "$value": "{login}"
            }
          }
        },
        {
          "$name": "group",
        }
      ]
    }
  }
}
```

--------------------------------

### Sage X3 Print Server Startup Command Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_print-server-presentation-and-operation-guide

This example demonstrates a typical command-line invocation for starting the Sage X3 Print Server. It utilizes options to run in console mode, enable verbose logging, and disable ODBC source control.

```bash
AdxSrvImp.exe /noservice /d /verbose /noodbc
```

--------------------------------

### GET /api/users/help

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/how-to_how-to-transfer-administration-data

Provides help documentation for user management. Links to external HTML resources.

```APIDOC
## GET /api/users/help

### Description
Provides help documentation for user management. Links to external HTML resources.

### Method
GET

### Endpoint
{$baseHelpUrl}/../Administration-reference/Users.html

### Parameters
(No specific parameters are defined for this help endpoint.)

### Request Example
(No request body example provided for GET requests.)

### Response
#### Success Response (200)
- The response is typically an HTML document providing help information.

#### Response Example
(The response would be an HTML file.)
```

--------------------------------

### Configure Load Balancer (GoBetween - TOML Example)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Provides a TOML configuration example for the GoBetween load balancer, defining server settings, protocol, bind address, and static discovery list for X3 runtimes. This setup enables traffic distribution and fault tolerance.

```toml
# FRPO402328
          [servers.FRPO402328]
          protocol = "tcp"
          bind = "FRPO402328:30000"
            [servers.FRPO402328.discovery]
            kind = "static"
            static_list = [
              "FRPO402328:20124 weight=40 priority=1",
                "FRPO402328:20125 weight=100 priority=0"
            ]
```

--------------------------------

### Example x3configureEngine.xml for Sage X3 Runtime

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

This XML file defines the configuration for a Sage X3 runtime module. It specifies details such as the solution name, server information, installation paths, runtime version, platform, and credentials for accessing the service and database. Adjust the paths, version, and credentials to match your specific Sage X3 installation.

```xml
<solution name="CLUSTERMM" type="X3">
  <label>Sage X3 on matrixw16sql17.sagefr.adinternal.com</label>
  <comment>
  </comment>
  <servername>matrixw16sql17.sagefr.adinternal.com</servername>
  <configpath>d:\Sage\CLUSTERMM\folders</configpath>
  <module name="CLUSTERMM2" family="RUNTIME" type="FULL">
    <component.runtime.installstatus>idle</component.runtime.installstatus>
    <component.runtime.name>CLUSTERMM2</component.runtime.name>
    <component.runtime.path>d:\Sage\CLUSTERMM\runtime</component.runtime.path>
    <component.runtime.platform>WIN64</component.runtime.platform>
    <component.runtime.servername>matrixw16sql17.sagefr.adinternal.com</component.runtime.servername>
    <component.runtime.version>R093.001.00007</component.runtime.version>
    <runtime.adxd.adxlan>eng</runtime.adxd.adxlan>
    <runtime.adxd.adxport>20101</runtime.adxd.adxport>
    <runtime.http.hostnamepublic>
    </runtime.http.hostnamepublic>
    <runtime.http.portpublic>
    </runtime.http.portpublic>
    <runtime.login.adxservicepwd>CRYPT:verkRgrsw3TmrdoxktvatccVr</runtime.login.adxservicepwd>
    <runtime.login.adxserviceusr>sagefr\QualityAdmin</runtime.login.adxserviceusr>
    <runtime.odbc.dbhome>
    </runtime.odbc.dbhome>
    <runtime.odbc.dblink>
    </runtime.odbc.dblink>
    <runtime.odbc.forcedblink>False</runtime.odbc.forcedblink>
    <runtime.odbc.tools>C:\Program Files\Microsoft SQL Server\Client SDK\ODBC\130\Tools</runtime.odbc.tools>
    <runtime.system.lowperformance>true</runtime.system.lowperformance>
  </module>
</solution>
```

--------------------------------

### Install and Use Node.js Version with NVM

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-dev-studio-installation

Installs and switches to a specific Node.js version required by the Sage X3 Services developer studio using NVM (Node Version Manager) or NVM-Windows. Ensure the version matches the one specified in the `.nvmrc` file.

```bash
nvm install [version]
nvm use [version]
```

--------------------------------

### U212LText.dll Trace Log File Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_print-server-presentation-and-operation-guide

An example of a U212LText.dll trace log file, showing diagnostic information such as DLL version, location, caller module, start time, and potential warnings.

```plaintext
*****************************************
*\tSage® X3 Print Services\t*
*\t U212LText.dll Trace File\t*
*****************************************

  ==> Start Fct [InitForJob] - Id [4]
    - INFORMATION : DLL Version  [EDT.2.999]
    - INFORMATION : DLL Location [C:\windows\crystal\U212LText.dll]
    - INFORMATION : Caller Module Name[Edition Server V5 (220000)]
    - INFORMATION : Caller Module Full Name[C:\Source\X3\print-server224\src\server\bin\Debug\ConsolePrintNet.exe]
    - INFORMATION : Start Time   [3/30 21:33:40:958]
    - WARNING : Unable to find Default Language in General Registry [Software\Adonix\x3\0,1,4,0\]
```

--------------------------------

### JSON Item Example: badge Entity in Sage X3 ERP Export

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/how-to_how-to-transfer-administration-data

Provides an example of a badge entity within the item section of a Sage X3 ERP JSON export, showcasing its code, title, and key function attributes.

```json
{
  "$type": "badge",
  "code": "ERPTRAN",
  "title": "title_963b8544-7fe2-4b99-8b95-ff25b6e77df2",
  "keyFunction": "GESEXS,GESPSH",
  "keyFunction2": "GESEXS, GESPSH"
}
```

--------------------------------

### Initialize Daily Start Time Based on Capacity (Sage X3)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/OBJ/ADC_JALLIBB

This entry point initializes the daily start time. It allows users to implement their own logic for setting the start time, which can depend on factors like the charge station. The start time is determined based on the daily capacity (LDAYCAP).

```Sage X3
$ACTION
Case ACTION
When "STARTHOUR" : Gosub STARTHOUR
Endcase
Return
$STARTHOUR
If (LDAYCAP > 0 & LDAYCAP <= 10) : WSTARTC = "08:00" : Endif
If (LDAYCAP > 10 & LDAYCAP <= 20) : WSTARTC = "04:00" : Endif
Return
```

--------------------------------

### Sage X3 MAIN Runtime XML Configuration

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

This XML structure defines the configuration for a Sage X3 MAIN runtime. It includes solution-level details and specific runtime component settings such as installation status, path, platform, version, and language settings. This file is used by the LauncherSolution.exe for runtime setup.

```xml
<solution name="LOCAL95" type="X3">
                    <label>Sage X3 sur myhost.sagefr.com</label>
                    <comment>
                    </comment>
                    <servername>myhost.sagefr.com</servername>
                    <configpath>c:\Sage\LOCAL95\dossiers</configpath>
                    <module name="LOCAL95" family="RUNTIME" type="MAIN">
                      <component.runtime.installstatus>active</component.runtime.installstatus>
                      <component.runtime.name>LOCAL95</component.runtime.name>
                      <component.runtime.path>c:\Sage\LOCAL95\runtime</component.runtime.path>
                      <component.runtime.platform>WIN64</component.runtime.platform>
                      <component.runtime.servername>myhost.sagefr.com</component.runtime.servername>
                      <component.runtime.version>R095.001.00183</component.runtime.version>
                      <runtime.adxd.adxlan>fra</runtime.adxd.adxlan>
                      <runtime.adxd.adxport>20130</runtime.adxd.adxport>
                      <runtime.login.adxservicepwd>CRYPT:encryptedPassword</runtime.login.adxservicepwd>
                      <runtime.login.adxserviceusr>.\sageX3</runtime.login.adxserviceusr>
                      <runtime.odbc.dbhome>
                      </runtime.odbc.dbhome>
                      <runtime.odbc.dblink>
                      </runtime.odbc.dblink>
                      <runtime.odbc.forcedblink>False</runtime.odbc.forcedblink>
                      <runtime.odbc.tools>
                      </runtime.odbc.tools>
                      <runtime.powershell.path>C:\Program Files\PowerShell\7\pwsh.exe</runtime.powershell.path>
                    </module>
                  </solution>
```

--------------------------------

### Install PowerShell on Red Hat Architectures

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_sage-erp-x3-installation-procedure

Installs Microsoft PowerShell 7.2 or later on Red Hat systems. This involves connecting via PuTTY, obtaining root privileges, registering the Microsoft Red Hat repository, and then installing the PowerShell package using yum.

```bash
sudo -i
curl https://packages.microsoft.com/config/rhel/8/prod.repo | sudo tee /etc/yum.repos.d/microsoft.repo
sudo yum install --assumeyes powershell
pswh
exit
```

--------------------------------

### Install Microsoft SQL Server PowerShell Module

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_sage-erp-x3-installation-procedure

Installs the Microsoft SQL Server PowerShell module for version 7.2 or higher. Requires administrator rights to open an MS-DOS command prompt. Verifies installation and module presence.

```powershell
Pwsh.exe
$PSVersionTable
Install-Module -Name SqlServer -Scope AllUsers -force
Get-InstalledModule -Name SqlServer
```

--------------------------------

### Sage X3 Sample Command: Create Solution

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Example command to create a new X3 solution. It defines the solution's name, label, server, configuration path, and account credentials.

```CLI
LauncherSolution.exe -solutioninfo:'name=X3V12;label=X3V12 label;servername=test.myhost.com;configpath=D:\Sage\X3V12\folders;' -account:'host=test.myhost.com;user=sage;pass=CRYPT:encryptedPassword' -create
```

--------------------------------

### OBJAYZ Object Creation Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/FCT/GESAY_ADV_AJAX

Example demonstrating how to create an instance of the OBJAYZ object using the Xtend object interface and display the response.

```APIDOC
## POST /xtend/ajax/SOLPAIE/PAIE/FDBTEST/INT/OBJAYZ/S

### Description
Creates an instance of the OBJAYZ object with specified parameters and returns the creation result.

### Method
POST

### Endpoint
http://ecfdalbopro:28980/xtend/ajax/SOLPAIE/PAIE/FDBTEST/INT/OBJAYZ/S

### Parameters
#### Query Parameters
None

#### Request Body
```json
{
  "TTL": "Titre du formulaire",
  "MAICOD": "frdal@sage.com",
  "CMT": "Commentaire"
}
```

### Request Example
```javascript
var wClassCaller=Class.create(XTENDWSVC.classCallerObject,{
  onSuccess :function(response){
    response.xtdDisplay();
  }
});
var wJSONOpts=new XTENDWSVC.classJsonOpt().noGroups();
var wParams=new XTENDWSVC.classParamObject(null,wJSONOpts);
wParams.add("TTL","Titre du formulaire");
wParams.add("MAICOD","frdal@sage.com");
wParams.add("CMT","Commentaire");
new wClassCaller("OBJAYZ").actCreate(wParams);
```

### Response
#### Success Response (200)
```json
{
  "FRMCOD": "0902000005",
  "FCYCOD": "FDBTEST",
  "ZFCYCOD": "Site de test fdalbo",
  "TYP": "OTH",
  "ZTYP": "Divers",
  "STATUT": "1",
  "STATUT_LBL": "A traiter",
  "TTL": "Titre du formulaire",
  "MAICOD": "frdal@sage.com",
  "CREDAT": "20090227",
  "CREHEURE": "184431",
  "CMT": "Commentaire",
  "PARCOD": [],
  "PARVAL": [],
  "WW_MODSTAMP": "000000000000",
  "WW_MODUSER": ""
}
```

#### Response Example
```json
{
  "FRMCOD": "0902000005",
  "FCYCOD": "FDBTEST",
  "ZFCYCOD": "Site de test fdalbo",
  "TYP": "OTH",
  "ZTYP": "Divers",
  "STATUT": "1",
  "STATUT_LBL": "A traiter",
  "TTL": "Titre du formulaire",
  "MAICOD": "frdal@sage.com",
  "CREDAT": "20090227",
  "CREHEURE": "184431",
  "CMT": "Commentaire",
  "PARCOD": [],
  "PARVAL": [],
  "WW_MODSTAMP": "000000000000",
  "WW_MODUSER": ""
}
```
```

--------------------------------

### SQL Configuration: sqlnet.ora Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

This snippet shows an example of the `sqlnet.ora` file, which is part of the Oracle Net Services configuration. It includes commented-out examples of authentication service configurations, relevant for database connectivity.

```text
# This file is actually generated by netca. But if customers choose to             # install "Software Only", this file wont exist and without the native             # authentication, they will not be able to connect to the database on NT.            #SQLNET.AUTHENTICATION_SERVICES = (NTS)            #SQLNET.AUTHENTICATION_SERVICES = (ALL)            #SQLNET.AUTHENTICATION_SERVICES = (NONE)            #SQLNET.ALLOWED_LOGON_VERSION=8            
```

--------------------------------

### Example API GET Request for Storage Volume Details

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-get-details

An example of an HTTP GET request to retrieve the detailed information for a specific storage volume, identified by its UUID. This demonstrates the practical application of the general syntax.

```HTTP
http://my_server:8124/syracuse/collaboration/syracuse/storageVolumes(('32..8a')?representation=storageVolume.$details
```

--------------------------------

### Example GET Request for Endpoints

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-get-query_representation=REPRESENTATION

This example demonstrates a specific GET request to retrieve a list of endpoints from the collaboration service. It specifies the server, application, contract, endpoint, and representation, along with a 'count' parameter to limit results.

```http
http://my_server:8124/api1/syracuse/collaboration/syracuse/endPoints?representation=endPoints.%24query&count=100
```

--------------------------------

### Sage X3 Solution Creation and Management

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Commands for creating solutions.xml files and console solutions, or configuring applications and runtimes. Requires specifying solution details, server information, account credentials, and target files. The '-create' option initiates solution creation.

```CLI
-create or -C : create solutions.xml file and Console solution 
-confighome:[HomeProfile directory] Default=C:\Users\[user]\AppData\Roaming\Sage\Console. ex : 'C:\Sage\consoleprofile'
```

--------------------------------

### Sage X3 Get Description SOAP Request Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_soap-web-services

Example SOAP request to get the description of a Sage X3 Web service, specifically for the 'SIH' object.

```xml
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wss="http://www.adonix.com/WSS">
   <soapenv:Header/>
   <soapenv:Body>
      <wss:getDescription soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <callContext xsi:type="wss:CAdxCallContext">
            <codeLang xsi:type="xsd:string">ENG</codeLang>
            <poolAlias xsi:type="xsd:string">AWS</poolAlias>
            <poolId xsi:type="xsd:string"></poolId>
            <requestConfig xsi:type="xsd:string">xsd:string">adxwss.optreturn=JSON&adxwss.beautify=true</requestConfig>
         </callContext>
         <publicName xsi:type="xsd:string">SIH</publicName>
      </wss:getDescription>
   </soapenv:Body>
</soapenv:Envelope>
```

--------------------------------

### Start or Update the AWS SOAP Pool via REST API

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/administration-reference_soapClassicPool

An example demonstrating how to start or update the 'AWS' SOAP pool using a POST request. It includes the necessary 'Authorization' header with basic authentication credentials. This is a concrete example of the general 'Start or Update a Single SOAP Pool' method.

```http
POST http://localhost:8124/api1/syracuse/collaboration/syracuse/soapClassicPools(alias eq 'AWS')/$service/start
Authorization: Basic YWRtaW46YWRtaW4=
```

--------------------------------

### Sample Folder Export Command

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

An example command demonstrating how to export the 'SEED' folder with its data to the 'MYSGV2020' directory, including solution information and account credentials.

```command-line
LauncherSolution.exe 
/export:'folder=SEED;svg=MYSGV2020;nodata=0;'
/solutioninfo:'name=UPDV12U90;configpath=d:\Sage\UPDV12U90\folders;servername=MATRIXW16SQL16.sagefr.adinternal.com;'
/account:'host=MATRIXW16SQL16.sagefr.adinternal.com;user=sagefr\qualityadmin;pass=CRYPT:verkRgrsw3TmrdoxktvatccVr;port=1802;'
```

--------------------------------

### Example Response Payload for Endpoints

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-get-query_representation=REPRESENTATION

This is an example of the JSON response received after making a GET request for the endpoints resource. It includes metadata like URL, descriptor, total results, and an array of resources, each with its own properties and metadata.

```json
{
  "$url": "http://my_server:8124/api1/syracuse/collaboration/syracuse/endPoints?representation=endPoints.%24query&count=100",
  "$descriptor": "endPoints",
  "$startIndex": 1,
  "$itemsPerPage": 100,
  "$totalResults": 3,
  "$ui": {},
  "$resources": [
    {
      "$uuid": "20a5550c-5412-476d-a4ad-2c85074176ea",
      "$key": "20a5550c-5412-476d-a4ad-2c85074176ea",
      "$url": "/api1/syracuse/collaboration/syracuse/endPoints('20a5550c-5412-476d-a4ad-2c85074176ea')?representation=endPoint.$details",
      "$etag": 1,
      "$creUser": "admin",
      "$creDate": "2013-12-07T13:44:21.304Z",
      "$updUser": "admin",
      "$updDate": "2013-12-07T13:44:21.304Z",
      "$properties": {
        "databaseDriver": {
          "$isMandatory": false,
          "$isHidden": true
        },
        "menuProfileToRoles": {
          "$isHidden": false
        }
      },
      "description": "SEED folder on demo Syracuse solution",
      "application": "x3",
      "contract": "erp",
      "protocol": "x3",
      "dataset": "SEED",
      "databaseDriver": "mongodb",
      "x3ServerFolder": "SEED",
      "x3SolutionName": "DEMOSYR",
      "applicationRef": {
        "$uuid": "46976d3e-127f-4e66-9cf0-c8fb985b4aa0",
        "$key": "46976d3e-127f-4e66-9cf0-c8fb985b4aa0",
        "description": "X3 ERP"
      },
      "x3server": {},
      "$value": "SEED folder on demo Syracuse solution"
    }
  ],
  "$links": {
    "$excel": {
      "$url": null,
      "$title": "Excel",
      "$type": "application/syracuse-excel-worksheet"
    }
  },
  "$template": {}
}
```

--------------------------------

### Sage X3 Console Command Line Help

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Displays the help information for the `launcherSolution.exe` command-line tool. This is useful for understanding available options and their syntax.

```bash
LauncherSolution.exe /help
```

--------------------------------

### Print Server Service Configuration Examples

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Demonstrates how multiple Sage X3 Print Server services can be configured to run on the same host, each associated with a different profile. Each service entry includes the service name, display name, and the executable path with its configuration parameter.

```text
          SAFE_X3_SE_V2DEFAULT 
          Safe_X3_SrvEdt_V2_EDT_DEFAULT
          c:\\Sage\\SafeX3\\EDTV2\\EDTSRVFRDEP\\srvedit\\AdxSrvImp.exe  /cfg:DEFAULT
          SAFE_X3_SE_V2FRA
          Safe_X3_SrvEdt_V2_EDT_FRA
          c:\\Sage\\SafeX3\\EDTV2\\EDTSRVFRDEP\\srvedit\\AdxSrvImp.exe  /cfg:FRA
          SAFE_X3_SE_V2PREVIEWS
          Safe_X3_SrvEdt_V2_EDT_PREVIEWS
          c:\\Sage\\SafeX3\\EDTV2\\EDTSRVFRDEP\\srvedit\\AdxSrvImp.exe  /cfg:PREVIEWS
        
```

--------------------------------

### Sage X3: Initialisation des zones MFGHEADTRK à la création

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/OBJ/ADC_SCALEXCHAN

Ce point d'entrée Sage X3 permet d'initialiser des zones spécifiques du fichier MFGHEADTRK juste avant son écriture. Il est utilisé lors de la création d'enregistrements pour assurer la cohérence des données. Les contextes de transaction et de fichier trace sont disponibles. Le fichier MFGHEADTRK et les tables associées comme WEIGHING sont accessibles.

```Sage X3 Language
## CRE_MTK : Initialisation de zones spécifiques du fichier MFGHEADTRK
Ce point d’entrée permet de prendre la main lors de la création d’enregistrement dans la table MFGHEADTRK (ceci permettant par exemple d’initialiser des zones spécifiques) . Il est placé juste avant l’instruction write [MTK].
```

--------------------------------

### Sage X3 Sample Command: Import Folder (Linux + Mono)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Example command to import a folder on a Linux system using Mono. It specifies solution information, server details, account credentials, and the folder to import with its SVG.

```CLI
mono LauncherSolution.exe  -solutioninfo:'name=SQLLINUX01;configpath=/Sage/SQLLINUX01/folders;servername=myhost.sagefr.com;' -account:'host=myhost.sagefr.com;user=sage;pass=CRYPT:XXXX' -folder:'folder=MYSEED;svg=SVG'
```

--------------------------------

### Get Number from JSON using Get$

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/4gl_get%24

This example illustrates how to extract a numeric value from a JSON document using the Get$ function. The function returns the number as stored in the JSON.

```Sage X3 Script
Funprog Get_Int()
	 Local Cblfile SRCJSON
	 SRCJSON = '{"foo": 42, "bar":"abc"}'
        Local Instance OBJ using Object
        ParseInstance OBJ with SRCJSON
        Local Boolean MYINT
        Local Boolean R
        R = OBJ.GET$("/foo", MYINT)
        FreeGroup OBJ
End MYINT -> Returns 42
```

--------------------------------

### Example HTTP GET Request and Response Payload

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-get-query

This example shows a concrete HTTP GET request to retrieve a list of endpoints with a count limit, along with the corresponding JSON response payload. The response includes metadata like total results and items per page, an array of resources (endpoints in this case), and links for additional actions.

```http
http://my_server:8124/api1/syracuse/collaboration/syracuse/endPoints?representation=endPoints.%24query&count=100
```

```json
{
  "$url": "http://my_server:8124/api1/syracuse/collaboration/syracuse/endPoints?representation=endPoints.%24query&count=100",
  "$descriptor": "endPoints",
  "$startIndex": 1,
  "$itemsPerPage": 100,
  "$totalResults": 3,
  "$ui": {},
  "$resources": [
    {
      "$uuid": "20a5550c-5412-476d-a4ad-2c85074176ea",
      "$key": "20a5550c-5412-476d-a4ad-2c85074176ea",
      "$url": "/api1/syracuse/collaboration/syracuse/endPoints('20a5550c-5412-476d-a4ad-2c85074176ea')?representation=endPoint.$details",
      "$etag": 1,
      "$creUser": "admin",
      "$creDate": "2013-12-07T13:44:21.304Z",
      "$updUser": "admin",
      "$updDate": "2013-12-07T13:44:21.304Z",
      "$properties": {
        "databaseDriver": {
          "$isMandatory": false,
          "$isHidden": true
        },
        "menuProfileToRoles": {
          "$isHidden": false
        }
      },
      "description": "SEED folder on demo Syracuse solution",
      "application": "x3",
      "contract": "erp",
      "protocol": "x3",
      "dataset": "SEED",
      "databaseDriver": "mongodb",
      "x3ServerFolder": "SEED",
      "x3SolutionName": "DEMOSYR",
      "applicationRef": {
        "$uuid": "46976d3e-127f-4e66-9cf0-c8fb985b4aa0",
        "$key": "46976d3e-127f-4e66-9cf0-c8fb985b4aa0",
        "description": "X3 ERP"
      },
      "x3server": {},
      "$value": "SEED folder on demo Syracuse solution"
    }
  ],
  "$links": {
    "$excel": {
      "$url": ".",
      "$title": "Excel",
      "$type": "application/syracuse-excel-worksheet"
    }
  },
  "$template": {}
}
```

--------------------------------

### Sage X3: Batch Configuration Initialization and Execution

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/FCT/FUNCFG

Outlines the necessary steps for initiating and executing a configuration in batch mode. This includes calling specific subroutines for initialization and execution, and populating question masks.

```Sage X3
Initialiser le scénario (gosub CFGINITBAT)
Alimenter toutes les questions nécessaires au scénario dans le masque CFGFUN
Lancer l'exécution du scénario (gosub CFGEXEBAT).
```

--------------------------------

### Get Boolean from JSON using Get$

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/4gl_get%24

This example shows how to retrieve a boolean value from a JSON document using the Get$ function. The result will be represented as 1 for true and 0 for false.

```Sage X3 Script
Funprog Get_Bol()
	 Local Clbfile SRCJSON
	 SRCJSON = '{"foo": true, "bar": "abc"}'
        Local Instance OBJ using Object
        ParseInstance OBJ with SRCJSON
        Local Char MYBOOL
        Local Boolean R
        R = OBJ.Get$("/foo", MYBOL)
        FreeGroup OBJ
End MyBol -> Returns 1
```

--------------------------------

### Get String from JSON using Get$

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/4gl_get%24

This example demonstrates how to extract a string value from a JSON document using the Get$ function. It requires a JSON object parsed using ParseInstance.

```Sage X3 Script
Funprog Get_Str()
	 Local Clbfile SRCJSON
	 SRCJSON = '{"foo": "bar", "bar": "abc"}'
        Local Instance OBJ using Object
        ParseInstance OBJ with SRCJSON
        Local Char MYSTR(56)
        Local Boolean R
        R = OBJ.Get$("/bar", MYSTR)
        FreeGroup OBJ
End MYSTR -> Returns "abc"
```

--------------------------------

### Sage X3 Sample Command: Configure Runtime

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Example command to configure an X3 runtime. It specifies the target XML file for runtime configuration, account details, and a log file. The '/main' flag indicates the main runtime configuration.

```CLI
"LauncherSolution.exe" - target:'x3ConfigureRUNTIMEs.xml' / main ^
              -account:'host=test.myhost.com;user=sage;pass=ENTER_THE_ACCOUNT_PASSWORD;port=1895;' - logfile:'x3ConfigureRUNTIMEs.tra'
```

--------------------------------

### Sage X3 Sample Command: Configure Application

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

Example command to configure an X3 application. It specifies the target XML file for configuration, account details, and a log file for the operation.

```CLI
"LauncherSolution.exe" - target:'d:\Sage\x3ConfigureAPPLICATION.xml' - application ^
              -account:'host=test.myhost.com;user=sage;pass=ENTER_THE_ACCOUNT_PASSWORD;port=1895;' - logfile:'x3Configure APPLICATION.tra'
```

--------------------------------

### Response for Starting SOAP Pools

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/administration-reference_soapClassicPool

Example of a successful response when starting SOAP pools. It includes a list of diagnoses indicating the status of each pool and an 'aliases' array confirming which pools were successfully started.

```json
{
    "$diagnoses": [
        {
            "$severity": "info",
            "$message": "SOAP pool ALIASPOOL1 starting."
        },
        {
            "$severity": "info",
            "$message": "[X3Pid=998] channel ready"
        },
        {
            "$severity": "info",
            "$message": "[X3Pid=1006] channel ready"
        },
        {
            "$severity": "success",
            "$message": "[Host:Port Pid] pool started"
        },
        {
            "$severity": "success",
            "$message": "SOAP pool ALIASPOOL1 started."
        }
    ],
    "aliases": [
        "ALIASPOOL1"
    ]
}
```

--------------------------------

### Sage X3 ERP: Example of HTTP GET Request using EXEC_HTTP

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-asyrwebser

Provides an example of how to use the EXEC_HTTP function to perform an HTTP GET request. It sets up the necessary header arrays for the URL and method, prepares an empty body, calls EXEC_HTTP, and checks the status code for success (200).

```Sage X3 ERP Script
Funprog HTTP_GET(RESHEAD, RESBODY)
 Variable Clbfile RESHEAD()
 Variable Clbfile RESBODY()
 Local Char HEADERCOD(64)(3)
 Local Char HEADERVAL(255)(3)
 HEADERCOD(0) = "url"
 HEADERVAL(0) = "http://footballpool.dataaccess.eu/data/info.wso?wsdl"
 HEADERCOD(1) = "method"
 HEADERVAL(1) = "GET"
 Local Clbfile BODY(0)
 BODY = '{}'
 Local Integer STATUSCODE
 STATUSCODE = func ASYRWEBSER.EXEC_HTTP(HEADERCOD, HEADERVAL, BODY, RESHEAD, RESBODY)
 If STATUSCODE <> 200
   Goto END_HTTP_GET
 Endif
 $END_HTTP_GET
 End STATUSCODE
```

--------------------------------

### Advanced Class Instantiation with Parameters

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/developer-guide_classes-script

This example demonstrates how to instantiate a class with specific parameters, allowing the definition to be loaded from a different folder. It includes parameters for context (CTX), unique ID (UID), line number (LINE), parent instance (IPA), and parent instance name (PPA).

```Sage X3 Language
MYINSTANCE=Newinstance =expression_returning_a_character_string , C_CLASSNAME(CTX,UID,LINE,IPA,PPA)
```

--------------------------------

### Uninstall Sage X3 Services (PowerShell)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_Sage-X3-Services-installation

This PowerShell command uninstalls any running Sage X3 Services from the previous installation folder. It requires administrator privileges to execute.

```powershell
PS D:\SageX3\x3-services> .\uninstall.ps1
```

--------------------------------

### Launch Executable Program (Windows)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/api-guide_api-reference-guide

A library allows launching an executable program on Windows from the browser, requiring user approval for security reasons.

```APIDOC
## Launch Executable Program (Windows)

### Description
Allows launching an executable program on a Windows system directly from the browser.

### Security
For security purposes, users must approve the execution from the browser upon first use.

### Usage Context
Primarily intended for use within classic code.
```

--------------------------------

### Get Sage X3 Installation Directory (4GL)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/4gl_dir%24

The dir$ function in 4GL returns the path of the directory where the Sage X3 runtime engine is installed on the process server. The result is of type Char.

```4GL
Local Char INSTALLDIR(200)
INSTALLDIR=dir$
```

--------------------------------

### Basic Sandbox Configuration (JSON)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_sandbox-configuration-file

A straightforward sandbox configuration that permits broad system command execution. It defines directories with specific extensions and allows any command pattern to be spawned. It does not enforce strict limitations on potentially harmful commands.

```json
{
  "sandbox": {
    "directories": [
      {
        "path": "c:\\program files\\Sage X3\\runtime\\log",
        "writable": true,
        "extensions": ["log","tra"]
      }, {
        "path": "D:\\Sage_X3\\Folders",
        "extensions": ["*"]
      }, {
        "others" : "D:\\Sage_X3\\\Tmp",
        "writable": true,
        "extensions": ["*"]
      }, {
        "path": "D:\\Othervolumes",
        "volume": "A",
        "extensions": ["*"]
      }
    ]
  },
  "spawn": [
    {
      "pattern": ".*",
      "path": "*"
    }
  ],
  {
    "allowConsole" : false
  }
}
```

--------------------------------

### Example Menu File Path (Sage X3)

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_print-server-presentation-and-operation-guide

An example of the directory path where menu files are stored by the Print Server. These files are crucial for the U212LText.dll functions to retrieve localized text and menu descriptions.

```Windows Batch
C:\Sage\SafeX3\EDTV2\EDTSRVFRDEP\srvedit\Data\SEED_po027493_20192\GEN\ALL\MENL
```

--------------------------------

### Insa Function Syntax and Examples

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/4gl_insa

Demonstrates the syntax and usage of the Insa function for inserting elements into arrays. It explains the parameters START, NUMBER, and LIMIT, and provides two examples showing the effect of the insertion on array data.

```Sage X3 Language
Insa START ARRAY_LIST
Insa START, NUMBER ARRAY_LIST
Insa START, NUMBER, LIMIT ARRAY_LIST
```

```Sage X3 Language
Insa 1,2 COMPOSER, NAME, BIRTH_YEAR
```

```Sage X3 Language
Insa 6,2,10 COMPOSER, NAME, BIRTH_YEAR
```

--------------------------------

### AmountToWordTest Executable Usage and Examples

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/getting-started_print-server-presentation-and-operation-guide

Demonstrates the command-line usage of the `AmountToWordTest.exe` utility, which calls the `AmountToWord()` function from `U212ltoword.dll`. It shows the required arguments for language, currency, and amount range, along with sample output for converting numbers to words.

```bash
Usage AmountToWordTest.exe -lang [ENG, FRA, ITA... ] -cur [EUR, USD, ...]  -start [number]   -end [number]

AmountToWordTest.exe -lang FRA -cur EUR -start 3 -end 10

AmountToWord 3.000000 EUR  ENG  three Euros
AmountToWord 4.000000 EUR  ENG  four Euros
AmountToWord 5.000000 EUR  ENG  five Euros
AmountToWord 6.000000 EUR  ENG  six Euros
AmountToWord 7.000000 EUR  ENG  seven Euros
AmountToWord 8.000000 EUR  ENG  eight Euros
AmountToWord 9.000000 EUR  ENG  nine Euros
AmountToWord 10.000000 EUR  ENG  ten Euros
```

--------------------------------

### User Entity Example

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/how-to_how-to-transfer-administration-data

This JSON object represents an example of a user entity in Sage X3 ERP 12. It includes properties like login, name, and group memberships. This structure is fundamental for user management within the system.

```json
{
  "$type": "user",
  "login": "ADMNA",
  "title": "mr",
  "firstName": "NA",
  "lastName": "System Administrator",
  "active": true,
  "groups": [
        "description_54c329ea-a303-4fb6-a76c-fe863d65452b",
        "description_af4172b4-4766-4794-b1e4-350baca31ce5"
        ]
}
```

--------------------------------

### Configure Sage X3 Runtime with LauncherSolution.exe

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/configuration-console_console

This command launches the Sage X3 configuration engine to set up a full runtime environment. It requires specifying the target configuration file, runtime type (full), account credentials, and a log file for tracking the process. Ensure the account credentials and file paths are correct for your environment.

```bash
LauncherSolution.exe /target:'x3configureEngine.xml' /full /account:'host=matrixw16sql17.sagefr.adinternal.com;user=sagefr\qualityAdmin;pass=CRYPT:verkRgrsw3XXXXXXVr;port=1895;' /logfile:'x3configureEngine.tra'
```

--------------------------------

### OAuth2 Instance API

Source: https://online-help.sagex3.com/erp/12/fr-fr/Content/V7DEV/how-to_how-to-transfer-administration-data

Documentation for the OAuth2 Instance API, which manages configurations for OAuth 2.0 authentication providers.

```APIDOC
## OAuth2 Instance API

### Description
Provides access to OAuth 2.0 instance configurations used for third-party authentication and authorization.

### Method
GET

### Endpoint
/oauth2/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique identifier for the OAuth2 instance.

#### Query Parameters
- **representation** (string) - Optional - The representation of the OAuth2 instance data.
- **role** (string) - Optional - The role associated with the OAuth2 instance.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **oauth2** (object) - Represents a single OAuth2 instance.
  - **key** (string) - The identifier of the OAuth2 instance.
  - **name** (string) - The name of the OAuth2 instance.

#### Response Example
```json
{
  "oauth2": {
    "key": "google_oauth",
    "name": "Google Authentication"
  }
}
```
```
Tokens:
Raw