Skip to content

Client Initial Setup Tool

Javapackage: com.etendoerp.copilot.devassistant

Overview

The ClientInitTool assists with initializing a new client in the Etendo system. It interactively collects all required information, invokes the backend function to provision the client and its administrator, and validates successful creation.

Info

To be able to include this functionality, the Copilot Extensions Bundle must be installed. To do that, follow the instructions from the marketplace: Copilot Extensions Bundle. For more information about the available versions, core compatibility and new features, visit Copilot Extensions - Release notes.

Functionality

This tool automates the client provisioning process in Etendo by:

  • Receiving Parameters

    • Accepts an input object with:

      • client_name (string)
      • client_username (string)
      • password (string)
      • confirm_password (string)
      • currency (string)
      • sysadmin_user (string or null)
      • sysadmin_password (string or null)
      • remote_host (string or null)

  • Creating the Client

    • Validates matching passwords.
    • Calls the ClientInitTool function to create the client environment and administrator account, using inferred host and credentials if not supplied.

  • Returning the Result

    • Returns a JSON response indicating success or failure.
    • On success: includes a confirmation message, the new client ID, and admin username.

Usage Example

Provisioning a new client

Input 

{
  "client_name": "ACME Corp",
  "client_username": "acmeadmin",
  "password": "Secret123!",
  "confirm_password": "Secret123!",
  "currency": "USD"
}

Output

Output Json
{
  "status": "success",
  "client_id": "12345",
  "admin_username": "acmeadmin",
  "message": "Client 'ACME Corp' initialized successfully."
}

Note

After successful creation, instruct the user to log in with the newly created administrator credentials, configure wizard access for the client, and proceed with organization setup.