DOCSEARCHbyAlgolia
Submit Docs

SimpleOne Platform Documentation

website·Indexed 33 days ago

https://docs.simpleone.ru

Technical documentation for the SimpleOne platform, covering administration, developer tools, and the SDLC module. Includes guides on Client-Side and Server-Side APIs, SimpleEngine features, Scripted REST API, and system configuration for versions 1.33.0 through 1.35.0.

Tokens
7.3M
Snippets
20.5K
Records
55.6K
Agent score
33%

What's inside SimpleOne

  1. Overview of UI Action types and locations

    User Interface (UI) actions are interactive elements such as buttons, links, and context menu items. They are categorized by where they appear in the interface:

    On Forms:

    • Header left / Header right
    • Burger menu
    • Field label context menu
    • Link
    • Bottom

    On Lists:

    • Header left / Header right
    • Burger menu
    • Column header context menu
    • Row context menu
    • Link
    • Bottom

    Other:

    • Button context menu
    • Dependency map context menu

    Note: The admin role is required to manage these actions.

  2. Overview of the SimpleOne Knowledge Base

    The SimpleOne Knowledge Base is a self-service online library providing information on company products and services. The interface is divided into two primary views: the category page and the article page.

    Category Page Elements:

    • Breadcrumbs: Used for navigating the portal page structure.
    • Side Menu: Displays all available Knowledge Base categories.
    • Main Area: Displays the articles belonging to the selected category. Users can select a card to open a specific article.

    Article Page Elements:

    • Breadcrumbs: Used for navigating the portal page structure.
    • Side Menu: Provides access to all Knowledge Base categories.
    • Article Form: Contains the main body of the article and supplementary information.

  3. Overview of User Delegation in SimpleOne

    Delegation allows an Employee to grant a Delegate the authority to view and interact with their assigned tasks and approvals, and receive copies of their notifications for a specific period.

    There are four delegation categories:

    • Access: Grants the employee's business role to the delegate.
    • Approvals: Allows the delegate to handle approval tickets.
    • Tasks: Allows the delegate to see the employee's open/non-canceled tasks.
    • Notification: Allows the delegate to receive the employee's email notifications.

    Key Constraints:

    • A delegate cannot transfer delegated rights to a third person.
    • If a delegate's own business role has fewer privileges than the employee's, they can only perform actions according to their own role unless Access is specifically delegated.
    • To ensure a delegate can access specific task or approval objects, Access delegation is recommended.

  5. Overview of SimpleOne Design Tokens

    Design tokens are atomic units of the visual interface that store design values (color, typography, spacing, corner radius) in a machine-readable format. They are implemented as CSS variables and are available in component styles, client scripts, and widget scripts. In version 1.33.0, only the color and font-family token categories are supported.
    .Filter {
    background: var(--color-fill-background-container-basic-primary);
    border-bottom: 1px solid var(--color-stroke-basic-primary);
    border-top: 1px solid var(--color-stroke-basic-primary);
    padding: 24px;

    &.compact {
        padding-top: 0;
    }
}

  6. Overview of the CRM Customer Contact Information widget

    The CRM Customer Contact Information widget is used within the B2B CRM application agent interface to display key details about a contact related to a specific record. By default, it is available on forms for the Partnership Applications (crm_partnership_application) table. The widget provides quick access to the contact's name, job title, phone numbers, email, and a direct link to the contact record.

  7. Overview of Record Subscriptions

    Subscriptions allow users to track changes in records. When a record is updated, all subscribed users are notified via email.

    Constraints:

    • You can only subscribe to records from tables that are explicitly marked as available for subscription.
    • Subscriptions can only be created for active users.

    Role Permissions:

    • admin: Can create, update, and delete all subscriptions.
    • user: Can read subscriptions and create/update their own subscriptions. They can also manage subscriptions for others if they have the right to update the specific record.

  8. Overview of SimpleOne Developer API categories

    The SimpleOne platform provides several API groups to allow developers and administrators to optimize work logic and instance settings without switching applications. The API is divided into three primary categories:

    1. Client-Side API: Used for reading and updating records, managing pop-up windows, and controlling other UI features.
    2. Server-Side API: Used to modify business rule scripts, system appearance, and behavior. It handles attachments, cache operations, automatic outgoing emails/messages, and the management of records, requests, and users.
    3. Widgets API: Used to create and configure informative widgets using HTML, including their form view, content, and user interaction patterns.

  9. Overview of Inbound Email Actions

    Inbound email actions allow the SimpleOne platform to process incoming emails and perform automated tasks based on defined conditions. They are similar to business rules in that they use scripts and conditions to interact with records in the system. There are two primary types of actions:

    1. Record action: Executes a specified script to perform operations on a target table (e.g., creating an incident record if the subject contains "Incident").
    2. Reply email: Sends an automated reply email.

    To use inbound email actions, a default email account must be configured in the system.

  10. Overview of SimpleOne System Events

    System events are used to trigger server-side script execution or send notifications at specific points in time. To implement a system event, you must first create a record in the Event Register (sys_event_register) table. Once registered, events can be handled by:

    1. Defining a server script in the Event Script Actions (sys_event_script_action) table.
    2. Defining a notification rule to send alerts.
    3. Combining both scripts and notifications.

  11. Overview of SimpleStorage for client-side data management

    SimpleStorage is an object storage utility similar to the JavaScript Map object. It allows developers to store and manage key-value pairs for use within client-side scripts for widgets or forms.
    if (SimpleStorage.hasItem('portalLogo')) {
  s_widget.setFieldValue("HasLogo", true);
  s_widget.setFieldValue("logo", SimpleStorage.getItem("portalLogo"));
} else {
  await s_widget.serverUpdate();
  SimpleStorage.setItem('portalLogo', s_widget.getFieldValue("logo"));
}

  12. Overview of SimpleOne API categories

    The SimpleOne platform provides three primary groups of APIs for developers and administrators to customize business logic and UI behavior without switching applications:

    1. Client-Side API: Used for reading and updating records, managing pop-up windows, and controlling other UI features.
    2. Server-Side API: Used to modify business rule scripts, system appearance, behavior, cache operations, automatic emails/messages, and management of records, requests, and users.
    3. Widgets API: Used to create and configure informative widgets using HTML, defining their form view, content, and user interaction patterns.