DOCSEARCHbyAlgolia
Submit Docs

Forguncy Server API v8

website·Indexed 33 days ago

https://docs.forguncy.com/v10/

Developer documentation for the Forguncy Server API v8, featuring reference materials for data access (IDataAccess), email services (IEmailSender), user management (IUserInfos), and server-side API attributes.

Tokens
782.8K
Snippets
977
Records
6.1K
Agent score
56%

What's inside Forguncy

  1. Overview of the Forguncy 8 Report Designer Interface

    v8

    The Report Designer is composed of several key functional areas used to build report layouts:

    • Menu Bar: Contains global operations including Undo, Redo, Preview, Home, Report (for page management like adding/deleting/copying pages), and Parameters (for designing the custom parameter input UI).
    • Toolbar: Displays shortcut operations and context-specific settings based on the selected report control.
    • Toolbox: Contains the controls available to be dragged into the design area. It includes the Explorer (a tree view of report components in order of addition) and the Group Editor (displays grouping information for the current Tablix data area).
    • Design Area: The primary workspace where report controls are dragged and dropped to create the page layout.
    • Properties and Data Pane: A toggleable area used to configure properties of the report or selected elements, and to manage datasets, report parameters, and common values (e.g., current date/time, page numbers).
    • Footer/Status Area: Provides controls for the grid (visibility and snap settings), ruler visibility, zoom level, and property mode (switching between 'Basic Properties' for common items and 'Detailed Properties' for all available settings).

  2. Overview of the Inline Frame Tab plugin

    v8

    The Inline Frame Tab plugin for Forguncy 8 introduces the 'Inline Frame Tab' cell type and the 'Display page in inline frame tab' command. This allows developers to implement iframe functionality within a page and dynamically load content into these tabs.

    Critical Constraints:

    • Single Instance: Only one 'Inline Frame Tab' cell should be placed per page. If multiple are placed, the associated commands cannot target a specific cell.
    • Iframe Isolation: Because content is displayed via iframes (even for internal Forguncy pages), the content inside the tab cannot access elements outside the iframe. For example, you cannot reference external cells by name or execute a 'Close Popup' command to close a popup that exists outside the iframe.

  3. Overview of Forguncy Custom Web API

    v10

    The Custom Web API feature in Forguncy 10 allows developers to create custom server-side programs that can be triggered via HTTP requests or scheduled for periodic execution. To develop Custom Web APIs, Visual Studio with .NET 8 support is required.

    Security Warning: Custom Web APIs do not provide built-in authentication. By default, any computer capable of accessing the Forguncy Server can execute these APIs. If the application is exposed externally or requires restricted access, authentication and authorization logic must be manually implemented within the custom API code.

  4. Overview of the Menu/TreeView Cell Type Plugin

    v8
    The Menu/TreeView cell type plugin is a pre-installed plugin for Forguncy 8 that provides four specific cell types for UI development: TreeView cells, Menu cells, Mobile Icon Menu cells, and Mobile Pull-down Menu cells.

  5. Overview of Forguncy 10 Server-Side Processing

    v10

    Forguncy Server provides server-side processing capabilities through server objects, allowing developers to execute predefined logic on the server. There are two primary types of server-side processing:

    1. Scheduled Tasks: Used to execute predefined processes periodically on the Forguncy Server based on a specified start time and execution interval.
    2. Server-Side Commands: Used to trigger predefined processes on the Forguncy Server via HTTP requests.

  6. Overview of Forguncy 10 Push Notifications

    v10

    Forguncy 10 provides push notifications to enable real-time interaction between the server-side and the client (browser). This feature allows developers to implement advanced functionalities such as automatic pop-ups for pending messages, instant messaging, browser station messages, and online customer service.

    Push notifications rely on WebSocket communication. If the communication between the client and the Forguncy Server passes through a proxy, ensure that WebSocket traffic is permitted. If the connection is lost (e.g., due to application downtime), the connection must be re-established using the 'Subscribe to Notification' functionality.

  7. Overview of Forguncy 8 Components

    v8

    Forguncy 8 consists of two primary components:

    1. Forguncy Builder: Used for developing applications. This component is available exclusively for Windows.
    2. Forguncy Server: Used for publishing and operating applications. This component is available for both Windows and Linux.

  8. Overview of Forguncy 10 Workflow functionality

    v10

    Workflows in Forguncy 10 allow developers to systematize business processes, such as application and approval flows for expense reports or request forms. The system leverages organizational structures and user information defined in User Management to route approvals to supervisors or relevant departments.

    Key implementation details:

    • The user interface for workflow states and processes is provided via the 'Workflow Bar' cell.
    • Because workflow functionality relies on user authentication to manage assignees, the application must use one of the following authentication methods: Form Authentication, Windows Authentication, or an Authentication Provider.

  9. Overview of Forguncy 10 Authentication Modes

    v10

    Forguncy 10 provides several authentication modes to restrict application access to authorized users. The available modes are:

    • Forms Authentication: The default mode. Uses Forguncy's internal user management service.
    • Windows Authentication: Used for environments utilizing Active Directory and domain-joined computers.
    • Authentication Providers: Uses external providers to obtain user account information, removing the need to manually add users in Forguncy.
    • Hybrid Authentication: Allows users to choose between Forms Authentication or a specific Authentication Provider (Office 365/Microsoft Entra ID or SAML 2.0) at the login screen.

  10. Overview of Pivot Table cells in Forguncy 8

    v8
    Pivot Table cells in Forguncy 8 allow users to create two-dimensional aggregations and perform various data analyses based on data from a List View.

  11. Overview of the JSON Data Source plugin for Forguncy 8

    v8
    The 'JSON Data Source Command' plugin allows developers to set JSON data into either a list view or standard cells within Forguncy 8. Installing this plugin adds two specific commands to the platform: 'Set JSON Data (Normal Cell)' and 'Set JSON Data (List View)'.

  12. Overview of Server-Side Command components

    v8

    A Server-Side Command in Forguncy 8 consists of four primary elements. Of these, the 'Client Call' and the 'Server-Side Command' logic are mandatory configurations.

    1. Client Call (Call Server-Side Command): The trigger mechanism used to request execution from the web browser.
    2. Parameters: The mechanism used to pass values from the client page to the server, as server-side commands cannot directly reference page values.
    3. Command (Server-Side): The actual logic and set of commands executed on the server.
    4. Return Value: The result sent back to the client upon completion, consisting of a return code and a message.