CompuTec AppEngine

https://learn.computec.one/docs/appengine/
Admin
CompuTec AppEngine is a central hub for managing applications and business solutions, enabling...
Tokens:142,314
Snippets:399
Trust Score:6.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install CompuTec AppEngine Templates

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/framework/before-you-start

This command installs the CompuTec AppEngine templates, providing a starting point for developing plugins and customizations for SAP Business One. It requires a command prompt and the .NET SDK to be installed.

```dotnet
dotnet new install CompuTec.AppEngine.Templates
```

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

### PFI Installation Guidance

Source: https://learn.computec.one/docs/appengine/plugins-user-guide/pfi

Detailed instructions for installing the CompuTec AppEngine plugin, including PFI, are available in the administrator's guide. This section provides a link to the specific overview page for plugin configuration and administration.

```APIDOC
Installation of CompuTec AppEngine Plugins:
  Refer to: https://learn.computec.one/docs/appengine/administrators-guide/configuration-and-administration/plugins/overview
  This link provides comprehensive instructions for plugin installation and management.
```

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

### Implement PluginSetup Class in C#

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/udo-in-appengine-plugin

This C# code demonstrates the implementation of a Setup class for a CompuTec AppEngine plugin. It extends the PluginSetup base class and overrides key methods like CheckUpdate, Update, and Version to manage plugin installation and updates.

```csharp
using System;
using System.Collections.Generic;
using System.Text;
using CompuTec.AppEngine.Base.Infrastructure.Plugins;
using CompuTec.AppEngine.FirstPlugin.API;
using CompuTec.AppEngine.FirstPlugin.Setup.Tables;

namespace CompuTec.AppEngine.FirstPlugin.Plugin.AppStart
{
    /// Plugin Setup Implementation
    /// here you can implement all logic of plugin installation on a specific database
    public class Setup : PluginSetup
    {
        public override bool CheckUpdate(Version currentVersion)
        {
            return currentVersion < new Version(FirstPluginInfo.NameVersion);
        }

        public override Version Update(string token)
        {

            var info = new FirstPluginInfo();

            Console.WriteLine("Update");

            List<CompuTec.Core2.DI.Setup.UDO.Model.ICustomField> customUdoFieldList = CustomUDOFields.getCustomFields();
            CompuTec.Core2.DI.Setup.UDO.Setup setup = new CompuTec.Core2.DI.Setup.UDO.Setup(token, customUdoFieldList, false, System.Reflection.Assembly
                .GetAssembly(typeof(FirstPlugin.Setup.Tables.ToDo.ToDoTable)), "CompuTec.AppEngine.FirstPlugin.Setup.Tables", "CompuTec.AppEngine.FirstPlugin.Setup.Tables",
                "CompuTec.AppEngine.FirstPlugin.Setup.Tables", "CompuTec.AppEngine.FirstPlugin.Setup.Tables", "CompuTec.AppEngine.FirstPlugin.Setup.Tables");

            setup.BaseLibInformation = info;

            if (setup.IsUpdateRequiredNew(true))
            {
                Console.WriteLine("Instaling...");
                var updateResult = setup.Update();

                if (!updateResult.Success)
                {
                    var message = new StringBuilder();

                    updateResult.Errors.ForEach(e =>
                    {
                        message.Append(e.Message);
                    });

                    throw new Exception(message.ToString());
                }


                Console.WriteLine(updateResult.ToString());
            }

            Console.WriteLine("Install finish");

            return Version;
        }

        public override Version Version => new Version(FirstPluginInfo.NameVersion);
    }
}
```

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

### Plugin Installation and Management

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/configuration-and-administration/overview

Describes the process for installing, configuring, and activating plugins within CompuTec AppEngine. Plugins are provided in ZIP format and require a system restart after installation.

```APIDOC
Plugin Installation:
  1. Click 'Install Plugin' button.
  2. Upload plugin file (ZIP format, do not extract).
  3. Restart CompuTec AppEngine for the plugin to become available.

Plugin Configuration:
  1. Click the plugin tile in the Plugins section.
  2. Activate plugin for a specific database using the 'Activate' toggle.
  3. If database objects are required, click 'Update' and provide SAP Business One database credentials.
  4. Activated plugins are accessible in the Launchpad.
```

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

### Install CompuTec Tool

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/development-tools/ct-tool

Installs the CompuTec Tool globally using the .NET CLI. This is the first step to using its various functionalities.

```bash
dotnet tool install CompuTec.Tool
```

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

### Database Script Installation Configuration

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/framework/database-structure-setup

Details the configuration for installing database structures, including script nodes and directory structure. Script nodes define elements to install, specifying name, type (Procedure, Function, View), database compatibility (HANA, SQL, or both), and error handling behavior.

```APIDOC
Script Node:
  - Name: Must match the file name containing the view/procedure/function.
  - Type: P = Procedure, F = Function, V = View.
  - DatabaseType: A = Install on HANA and SQL systems, S = SQL only, H = HANA only.
  - ContinueOnError: Set to true or false based on whether errors should halt the setup process.

Directory Structure:
  - LoadOrder.xml:
    - HANA:
      - Procedures
      - Functions
      - Views
    - SQL:
      - Procedures
      - Functions
      - Views

Script Body:
  - The script body in the file must contain the complete procedure body and declaration, excluding the CREATE statement.
```

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

### Install Easy UI5 Generator

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/using-external-libraries-in-appengine

Installs the Easy UI5 Yeoman generator globally. This generator is used to scaffold new UI5 applications and extensions, simplifying project setup.

```npm
npm install -g yo generator-easy-ui5
```

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

### Add ActiveX Component Definition

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/sap-user-interface/active-x-insallation-guide

Demonstrates how to define an ActiveX component for installation within the `PluginInfo` configuration. It specifies the component's GUID (CLSID) and the relative path to its manifest DLL. This configuration is used by the system to manage ActiveX installations and updates.

```C#
ActiveXComponents = new ActiveXInstallDefinition[]  
{
  new("7B3C32C6-2856-1AB9-A132-CA5FBCC90115",  
  "ProcessForce.Gantt\CompuTec.ProcessForce.Gantt.dll")  
};  
```

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

### Plugin Description Manifest Example

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/framework/manifest

Example JSON structure for a plugin manifest file (manifest.json), outlining plugin identity, versioning, dependencies, and metadata.

```json
{
  "PluginCode": "Core.Example01.AE",
  "PluginName": "Example Plugin",
  "Icon": "sap-icon://activate",
  "Assembly": "ConsoleApp.AE.dll",
  "Company": "Your Company Name",
  "PluginVersion": "1.0.5",
  "Remarks": "Example Plugin Remarks that will be displayed in the plugin list",
  "ReadmeFile": "README.md",
  "ReleaseNotes": "RELEASE_NOTES.md",
  "DocumentationLink": "http://example.com/plugin-docs",
  "PluginType": "AppEnginePlugin",
  "MinimumCoreLevel": "1.0.0",
  "Dependencies": [
    {
      "PluginCode": "Core.Example01.API",
      "minVersion": "1.0"
    }
  ]
}
```

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

### Access CompuTec AppEngine Platform

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/installation

After successful installation, the CompuTec AppEngine service runs and can be accessed via a web browser using the specified address.

```APIDOC
Access CompuTec AppEngine:
  URL: http://{host}:54000
    - {host}: Placeholder for the server hostname or IP address where AppEngine is installed.
    - Port: 54000 is the default port for accessing the AppEngine platform.
```

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

### Install CompuTec AppEngine Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/plugin-templates

Installs the CompuTec AppEngine plugin templates package from NuGet. This command enables the creation of new plugin projects using predefined structures.

```dotnetcli
dotnet new --install CompuTec.AppEngine.Templates
```

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

### Install CompuTec AppEngine .NET Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/sapui5

Installs the CompuTec.AppEngine.Templates NuGet package, which provides Visual Studio templates for creating CompuTec AppEngine plugins. This command makes the templates available for use with `dotnet new`.

```dotnetcli
dotnet new --install CompuTec.AppEngine.Templates::2.0.0
```

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

### BL Plugin Configuration Example (JSON)

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/development-tools/Configuration/dev-config-json

Example dev.config.json for a Business Logic (BL) plugin. It defines the source directory, the compiled output DLL path, and lists any plugin dependencies.

```JSON
{
  "SourceDirectory":"",
  "OutputDll":"bin\\Debug\\net8.0\\CT.VehOne.BL.dll",
  "Dependencies":[],
  "MapWwwAppFolder":false
}
```

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

### CompuTec AppEngine Plugin Configuration Example (JSON)

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/development-tools/Configuration/dev-config-json

Example dev.config.json for a CompuTec AppEngine plugin. This configuration includes the source directory, output DLL, dependencies, and the MapWwwAppFolder setting.

```JSON
{
  "SourceDirectory":"",
  "OutputDll":"bin\\Debug\\net8.0\\CT.VehOne.dll",
  "Dependencies":[
  "..\\CT.VehOne.BL\\dev.config.json"
  ],
  "MapWwwAppFolder":true
}
```

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

### List Installed AppEngine Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/computec-app-engine-plugin-template-for-typescipt

Lists all installed .NET templates that match the prefix 'AE', allowing verification of the CompuTec AppEngine templates installation.

```shell
dotnet new --list AE
```

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

### SAP UI Plugin Configuration Example (JSON)

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/development-tools/Configuration/dev-config-json

Example dev.config.json for a SAP UI plugin. It specifies the source directory, output DLL, whether to map the www app folder, and lists dependencies.

```JSON
{
  "SourceDirectory":"",
  "OutputDll":"bin\\Debug\\net8.0\\CT.VehOne.dll",
  "MapWwwAppFolder":true,
  "Dependencies":["..\\CT.VehOne.BL\\dev.config.json"]
}
```

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

### Install @computec/uicore

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/appengine-plugin/ae-ui

Installs the @computec/uicore library as a development dependency for your CompuTec AppEngine project. This library is crucial for building UI5 applications within the AppEngine Launchpad.

```bash
npm i @computec/uicore --save-dev
```

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

### List Available CompuTec .NET Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/sapui5

Lists all installed .NET templates that match the filter 'AE'. This command helps verify the installation of CompuTec templates and identify available plugin project types.

```dotnetcli
dotnet new --list AE
```

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

### Download Microsoft .NET Framework 4.7 Installers

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/requirements

Links to download the Microsoft .NET Framework 4.7 Web and Offline Installers. Ensure you have the correct version installed for CompuTec AppEngine 2.0.

```Link
https://support.microsoft.com/en-au/topic/the-net-framework-4-7-web-installer-for-windows-54cca588-519d-5e78-ea54-2ce5bd84a2ab
```

```Link
https://support.microsoft.com/en-gb/topic/the-net-framework-4-7-offline-installer-for-windows-f32bcb33-5f94-57ce-6120-62c9526a91f2
```

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

### CT Tool: Install Plugin Database Structure

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/development-tools/ct-tool

Installs the database structure for a given plugin DLL on the company server. Requires connection details and the path to the plugin DLL.

```APIDOC
dotnet ct install

Installs the database structure for a plugin.

Parameters:
  -s, --sld-server : Required. The SLD server address.
  -c, --company-name : The company name.
  -i, --company-id : The company ID.
  -u, --user-name : Required. The username for authentication.
  -p, --password : Required. The password for authentication.
  -d, --database-server : Required. The database server address and port.
  -t, --server-type : Required. The type of the database server (e.g., dst_HANADB, dst_MSSQL2019).
  <dll_path> : Required. The path to the plugin DLL file.

Example:
  dotnet ct install -s hanadev:40000 -c SBO_DB -u manager -p"password" -d"DEV@hanadev:30013" -t dst_HANADB "CT.VehOne\bin\Debug\net8.0\CT.VehOne.dll"
```

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

### List Installed AppEngine Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/plugin-templates

Lists all installed .NET templates that match the 'AE' short name, allowing developers to see available CompuTec AppEngine templates after installation.

```dotnetcli
dotnet new --list AE
```

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

### App.config.json Example for HTTPS

Source: https://learn.computec.one/docs/appengine/administrators-guide/configuration-and-administration/https-configuration

An example JSON configuration file demonstrating how to set up HTTPS for CompuTec AppEngine. This configuration specifies the use of a certificate file and defines the listening URLs.

```json
{
  "Hosting":{
    "OwnUrls":true,
    "Urls":["54001"],
    "PfxCertFilePath":"CompuTec.AppEngine.DefaultCert.pfx",
    "CertPassword":"1q2w3e4r",
    "UseCertificateStore":false,
    "FindType":"FindByThumbprint",
    "FindValue":"",
    "StoreLocation":"LocalMachine",
    "StoreName":"My"
  }
}
```

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

### Example Component.ts with External Library Integration

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/using-external-libraries-in-appengine

This TypeScript example shows a complete `Component.ts` file for an AppEngine application. It includes the necessary `sap.ui.loader.config` call within the constructor to map external library paths and demonstrates standard UI5 component initialization.

```typescript
import UIComponent from"computec/appengine/ui/core/UIComponent";
import{ $UIComponentSettings }from"sap/ui/core/UIComponent";

/**
* @namespace externallibs
*/
exportdefaultclassComponentextendsUIComponent{

constructor(mSettings?: $UIComponentSettings){
super(mSettings);
        sap.ui.loader.config(
{
                paths:{"xlsx": sap.ui.require.toUrl("externallibs/resources/xlsx")}
}
)
}
publicstatic metadata ={
        manifest:"json"
}

init(){
super.init();
super.onInit();
this.getRouter().initialize();
}
}

```

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

### Install @computec/common Library

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/appengine-plugin/ae-ui

Installs the @computec/common library as a development dependency for UI5 applications. This library provides essential controls, services, and helpers for building applications with the CompuTec AppEngine UI5 Plugin.

```javascript
npm i @computec/common --save-dev
```

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

### Complete manifest.json Example

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/embedding-plugin-form-in-processforce

An example of a complete manifest.json file for a CompuTec AppEngine plugin, including the 'sapForms' array within the 'ui.apps' section. This shows how the plugin configuration for embedding into SAP ProcessForce is integrated into the overall plugin structure.

```json
{
  "version":"1.0.0",
  "id":"FirstPlugin",
  "name":"FirstPlugin",
  "icon":"sap-icon://activate",
  "company":"",
  "api":{
    "routePrefix":"FirstPlugin",
    "setupAssembly":"CompuTec.AppEngine.FirstPlugin",
    "assemblies":[
      "CompuTec.AppEngine.FirstPlugin",
      "CompuTec.AppEngine.FirstPlugin.Models",
      "CompuTec.AppEngine.FirstPlugin.Serializer",
      "CompuTec.AppEngine.FirstPlugin.API",
      "CompuTec.AppEngine.FirstPlugin.Setup"
    ],
    "dependencies":{
    }
  },
  "ui":{
    "apps":[
      {
        "icon":"sap-icon://example",
        "namespace":"computec.appengine.firstplugin",
        "tile":"FirstPlugin",
        "target":"home",
        "type":"User",
        "sapForms":[
          {
            "uniqueId":"firstplugin_salesorder",
            "formMode":false,
            "url":"salesorder",
            "fatherUID":"2048",
            "menuItem":true,
            "menuCaption":"FP Sales Orders"
          }
        ]
      }
    ]
  }
}
```

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

### Fetch Simple View Data using Curl

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/rest-odata-api/simple-views

Demonstrates how to retrieve data from a Simple View using a GET request via curl. This example fetches ItemCode, ItemName, and OnHand quantity for the 'OITM' data source, limiting the results to the top 1 record.

```curl
curl -X GET --header 'Accept: application/json' 'http://localhost:54000/odata/CustomViews/Views.Simple(DataSource='OITM')?$select=ItemCode%2C%20ItemName%2C%20OnHand&$top=1'
```

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

### Override PluginInfo Methods for Custom Logic (C#)

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/framework/database-structure-setup

This snippet demonstrates how to override specific methods in the PluginInfo class to execute custom logic during different plugin lifecycle events. These events include uninstall, before install, installation started, installation error, and after successful installation. Each overridden method accepts an ICoreConnection parameter, and some handle specific installation details like version numbers, results, and exceptions.

```csharp
public override void OnUninstall(ICoreConnection connection) { base.OnUninstall(connection); }
public override void BeforeInstall(ICoreConnection connection) { base.BeforeInstall(connection); }
public override void PluginInstalling(ICoreConnection connection) { base.PluginInstalling(connection); }
public override void OnInstallError(PluginInstalldVersion? current_DB_Number, PluginInstalldVersion final_DB_Number, Result actionResult, Exception ex = null) { base.OnInstallError(current_DB_Number, final_DB_Number, actionResult, ex); }
public override void AfterStructureWasInstalled(PluginInstalldVersion? current_DB_Number, PluginInstalldVersion final_DB_Number, ICoreConnection coreConnection) { base.AfterStructureWasInstalled(current_DB_Number, final_DB_Number, coreConnection); }
```

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

### System Details and Actions

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/configuration-and-administration/overview

Outlines key system management actions for CompuTec AppEngine, including restarting the installation, updating passwords, and generating a configuration file for support.

```APIDOC
System Details and Actions:
1. Restart the CompuTec AppEngine installation.
2. Update the CompuTec AppEngine password.
3. Generate and download a configuration file containing:
   - CompuTec AppEngine version
   - Installed plugins and versions

Configuration file is used for support tickets.
```

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

### SAP Business One AppEngine Configuration Steps

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/configuration-and-administration/overview

Provides a step-by-step guide to configure AppEngine settings within SAP Business One after activating a plugin. Includes server address and opening mode selection.

```APIDOC
SAP Business One (with ProcessForce installed) main menu → Administration → System Initialization → General Settings → ProcessForce tab → AppEngine tab

Configuration Steps:
1. Check the configuration checkbox.
2. Enter the server address (default: `http://localhost:54000`).
3. Select the opening mode:
   * In Form: within SAP Business One forms.
   * In Browser: in the system's default web browser.
   * Both: accessible in both forms and browser.
4. Click Save and restart SAP Business One.
```

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

### Minimal API Controller Example (C#)

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/appengine-plugin/ae-controllers

Shows how to create a minimal API controller by inheriting from `AeSecureMinimalApiEndpointBuilder`. It defines a route and maps a GET endpoint using `[FromServices]` for dependency injection of services like `ITranslationService`.

```C#
public class MyOpenApiBuilder : AeSecureMinimalApiEndpointBuilder
{
    public override string Route => "MyApiRoute";

    public override void Configure(RouteGroupBuilder endpointRouteBuilder)
    {
        endpointRouteBuilder.MapGet("/Test", Test);
    }

    private IResult Test([FromServices]ITranslationService translationService)
    => Results.Ok(translationService.Value.GetTranslatedMessage("VehOne.VinIsMissing"));
}
```

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

### Custom Database Upgrade Actions

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/framework/database-structure-setup

Enables execution of custom code before or after the database installation process using classes derived from SetupCustomAction. The Run method must be implemented, and the ExecuteInstallAction attribute is used to specify execution conditions.

```APIDOC
Class Definition:
  - Create a class derived from `SetupCustomAction`.
  - Implement the `public override Result Run()` method for the activity.

Execution Attributes:
  - `[ExecuteInstallAction(true)]`: Run Once.
  - `[ExecuteInstallAction(ProcessForceVersionSettings.PF93.PL13)]`: Run on Version Upgrade.
  - `[ExecuteInstallAction(RunBeforeInstallingObjects = "true")]`: Run Before Object Installation.
```

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

### Get Current DB Version

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/udo-in-appengine-plugin

This C# function retrieves the current database version number. It is used to determine if a setup trigger is needed during updates. The function takes a token for authentication and returns a double representing the version.

```csharp
/// <summary>
/// This Function is used to determine the current instation number used in the update to obain if setup needs to be triggered
/// </summary>
/// <param name="Token"></param>
/// <returns></returns>
publicoverridedoubleGetCurrentDBVersion(string Token)
{
return1.0d;
}
```

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

### Add Custom User-Defined Field to SAP Object (C#)

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/udo-in-appengine-plugin

Provides a method to define and install custom user-defined fields (UDFs) for standard SAP objects. This example adds an alphanumeric field named 'FistUDF' to the 'OITM' (Item Master Data) table.

```csharp
usingCompuTec.Core2.DI.Setup.UDO.Model;
usingSystem.Collections.Generic;
usingCompuTec.BaseLayer.DI;

namespaceCompuTec.AppEngine.FirstPlugin.Setup.Tables
{
  publicclassCustomUDOFields
  {
    /// <summary>
    /// Lists all UDF fields to be installed with the plugin.
    /// </summary>
    /// <returns>A list of custom fields.</returns>
    publicstaticList<ICustomField>getCustomFields()
    {
      var list = newList<ICustomField>();
      
      // UDF 'FistUDF' of type alphanumeric with size 20 will be added to the Items object (OITM)
      var udf = new TableCustomField();
      udf.SetName("FistUDF");
      udf.SetDescription("Fisrst Plugin First UDF");
      udf.SetTableName("OITM");
      udf.SetEditSize(20);
      udf.SetType(BaseLayer.DI.BoFieldTypes.db_Alpha);
      list.Add(udf);

      return list;
    }
  }
}
```

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

### Fetch Business Partner Payment Terms API

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/rest-odata-api/custom-views

Demonstrates how to fetch the 'BusinessPartnerPaymentTerms' custom view using a GET request to the AppEngine REST API. Includes the curl command, the request URL, and an example of the expected JSON response body.

```apidoc
GET /odata/CustomViews/Views.Custom(Id='MYPLUGIN:BusinessPartnerPaymentTerms')

Request:
  curl -X GET --header 'Accept: application/json' '<http://localhost:54000/odata/CustomViews/Views.Custom(Id='MYPLUGIN:BusinessPartnerPaymentTerms')>'

Response:
  {
    "@odata.context": "<http://localhost:54000/odata/$metadata#Custom>",
    "value": [
      {
        "No": 1,
        "PymntGroup": "- Cash Basic -",
        "CardCode": "00001",
        "CardName": "ABC Inc"
      },
      {
        "No": 2,
        "PymntGroup": "- Cash Basic -",
        "CardCode": "00002",
        "CardName": "Hanks Deliveries"
      },
      {
        "No": 3,
        "PymntGroup": "- Cash Basic -",
        "CardCode": "TEST",
        "CardName": ""
      }
    ]
  }
```

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

### CompuTec AppEngine 2.0 Pre-Installation Steps

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/requirements

Lists the essential components and software that must be installed before setting up CompuTec AppEngine 2.0. This includes SAP Business One DI API and CompuTec ProcessForce API.

```List
1. Install SAP Business One DI API 64-bit on the client machine.
2. Install CompuTec ProcessForce API 64-bit (required for certain plugins).
3. Microsoft ODBC Driver 17 for SQL Server (installed with SAP Business One Client).
4. Microsoft SQL Server Native Client 11.0 (installed with SAP Business One Client).
```

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

### Install CompuTec AppEngine Templates

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/computec-app-engine-plugin-template-for-typescipt

Installs the CompuTec AppEngine plugin template package for .NET. This command requires Node.js version 12 or higher to be installed.

```shell
dotnet new --install CompuTec.AppEngine.Templates::2.0.0
```

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

### Configure .NET Project for Code Generation

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/appengine-plugin/generator

Sets up the .NET project file to include necessary configurations for code generation. It defines the OneUpFolder and specifies the SDK used.

```xml
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OneUpFolder>$(MSBuildProjectDirectory)\..</OneUpFolder>
  </PropertyGroup>
</Project>
```

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

### CompuTec AppEngine API Examples (Postman Collection)

Source: https://learn.computec.one/docs/appengine/developers-guide/rest-odata-api/rest-odata-api-documentation

This section details how to access the CompuTec AppEngine REST/OData API documentation. It includes a Postman collection with examples for authentication (OAuth2 Token and Cookie) and common operations like retrieving and updating Manufacturing Orders. The examples demonstrate API endpoints, request methods, headers, and body payloads.

```APIDOC
Project: CompuTec.AppEngine

API Access:
On-demand REST/OData API Swagger documentation is generated by choosing the API documentation panel in the main menu.

Postman Collection Examples:

1. Login - OAuth2 [Token]
   - Method: POST
   - URL: http://localhost:54000/Token
   - Headers:
     - Content-Type: application/x-www-form-urlencoded; charset=utf-8
   - Body:
     - grant_type=password&username=manager&password=1234&serverInstance=PLZG001&companySchema=PFDemoGB

2. Login - OAuth2 [Cookie]
   - Method: POST
   - URL: http://localhost:54000/api/Login
   - Headers:
     - Content-Type: application/json
   - Body:
     {
       "ServerInstance": "PLZG001",
       "CompanySchema": "PFDemoGB",
       "UserName": "manager",
       "Password": "1234",
       "Language": "ln_English_Gb"
     }

3. ManufacturingOrder - GET [Token]
   - Method: GET
   - URL: http://localhost:54000/api/ProcessForce/ManufacturingOrder
   - Headers:
     - Authorization: Bearer <token>
     - Content-Type: application/json
   - Tests (JavaScript):
     - pm.test("Status code is 200", function () { pm.response.to.have.status(200); });
     - pm.test("Object expected", function () { var jsonData = pm.response.json(); pm.expect(jsonData[0].Object).to.eql("CT_PF_ManufacOrd"); });
     - pm.test("Object count", function () { var jsonData = pm.response.json(); pm.expect(jsonData.length).to.be.at.least(0); });

4. ManufacturingOrder - GET [Cookie]
   - Method: GET
   - URL: http://localhost:54000/api/ProcessForce/ManufacturingOrder
   - Headers:
     - Content-Type: application/json
   - Tests (JavaScript):
     - pm.test("Status code is 200", function () { pm.response.to.have.status(200); });
     - pm.test("Object expected", function () { var jsonData = pm.response.json(); pm.expect(jsonData[0].Object).to.eql("CT_PF_ManufacOrd"); });
     - pm.test("Object count", function () { var jsonData = pm.response.json(); pm.expect(jsonData.length).to.be.at.least(0); });

5. ManufacturingOrder - PATCH
   - Method: PATCH
   - URL: http://localhost:54000/api/ProcessForce/ManufacturingOrder/1
   - Headers:
     - Authorization: Bearer <token>
     - Content-Type: application/json
   - Tests (JavaScript):
     - pm.test("Status code is 200", function () { pm.response.to.have.status(200); });

```

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

### AppEngine Settings Categories

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/configuration-and-administration/overview

Details the different categories of configuration settings available for the CompuTec AppEngine installation, covering development, server details, general options, administration credentials, and component management.

```APIDOC
AppEngine Configuration Settings:
- Development: Plugin development-related settings.
- SLD Servers: Settings from the SLD Servers section.
- General: Default attachment folder and default ports.
- Administration: CompuTec AppEngine username and password.
- Components: Manage installed plugins and their settings.
```

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

### Import Certificate via Command Line

Source: https://learn.computec.one/docs/appengine/2.0/administrators-guide/configuration-and-administration/https-configuration

Command to open the Local Machine certificate console for importing SSL certificates required for HTTPS communication.

```Windows Command
certlm.msc
```

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

### Create AppEngine UI Plugin Project

Source: https://learn.computec.one/docs/appengine/developers-guide/basic-and-business-logic/appengine-plugin/ae-ui

Utilizes the `dotnet new` command with the `ctaeaeproject` template to create a new CompuTec AppEngine UI5 Plugin project. The `--RoutePrefix` parameter sets the initial route, and the plugin ID can be specified with `--name`.

```Bash
dotnet new ctaeaeproject --RoutePrefix CTVehOne
```

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

### CompuTec AppEngine 3.0 Main Sections

Source: https://learn.computec.one/docs/appengine/appengine-users-guide/overview

The main window of CompuTec AppEngine 3.0 provides access to three primary sections: Launchpad for user operations, Configuration and Administration for system management, and REST/OData API for integration and development.

```APIDOC
CompuTec AppEngine 3.0 Navigation:

Main Sections:
  1. Launchpad:
     - Access: https://learn.computec.one/docs/appengine/appengine-users-guide/launchpad
     - Purpose: User interface for core functionalities.

  2. Configuration and Administration:
     - Access: https://learn.computec.one/docs/appengine/administrators-guide/configuration-and-administration/configuration
     - Purpose: Manage system settings and administrative tasks.

  3. REST/OData API Documentation:
     - Access: https://learn.computec.one/docs/appengine/developers-guide/rest-odata-api/rest-odata-api-documentation
     - Purpose: For developers integrating with AppEngine or building custom solutions.
```

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

### Complete PluginSettings Implementation

Source: https://learn.computec.one/docs/appengine/2.0/developers-guide/sapui5-plugins/plugin-configuration

Provides the final implementation of the `PluginSettings` class, integrating the definition of job-related configuration nodes and their respective settings, including the `TaskPriority` with its validation.

```C#
using CompuTec.AppEngine.Base.Infrastructure.Configuration;
using CompuTec.AppEngine.Base.Infrastructure.Exceptions;
using CompuTec.AppEngine.Base.Infrastructure.Plugins;
using CompuTec.AppEngine.FirstPlugin.API.Enums;
using System;
using System.Collections.Generic;

namespace CompuTec.AppEngine.FirstPlugin.AppStart
{
publicclass PluginSettings : SettingsCollection<IPluginConfiguration>
{
publicoverride List<SettingDefinition> GetSettings()
{
List<SettingDefinition> settings = new List<SettingDefinition>();

#region SalesOrderToApproveEventJob node
settings.Add(new SettingDefinition<Dictionary<string, object>>("SalesOrderToApproveEventJob", new Dictionary<string, object>(), false, true));

settings.Add(new SettingDefinition<string>($"SalesOrderToApproveEventJob:TaskPriority", ToDoPriority.Medium.ToString(), PriorityValidation, null, false, true));
#endregion

return settings;
}

publicstaticvoid PriorityValidation(string key, string newStatus, IConfiguration configuration)
{
if (!Enum.TryParse<ToDoPriority>(newStatus, out var a))
{
List<string> allowedPriorities = new List<string>();
foreach (var e in (typeof(ToDoPriority).GetEnumValues()))
{
allowedPriorities.Add(e.ToString());
}

throw new AppEngineException($"Incorrect value for Priority: {newStatus}. Allowed values: {string.Join(",", allowedPriorities)}");
}

}
}
}
```
Tokens:
Raw