Skip to main content

orchard-documentation

Dashboard:​

  • DPL studio-old Is the Application name.

  • Standalone Is the Application Type.

##Application Type:

An Application Type defines the structure and behavior of applications within a platform. It sets the foundation for how applications are created and what configurations they support

Overview: The "Application Type" form is designed to configure and manage different types of applications within the system. It includes two main tabs: Details and Configuration

Fields:

  • Type: specify the name of the application type.

  • Description: A text area to provide a brief explanation or notes about the application type.

  • IsActive: A checkbox to indicate whether the application type is currently active.

  • RootOptionEnable: A checkbox to enable or disable root-level options for the application type.

Actions:

  • Cancel (Red Button): Discards any changes made and exits the form.

  • Save Next (Green Button): Saves the current form data and proceeds to the next step or tab.

Configuration:​

Overview: The Configuration tab is part of the "Application Type" form and is used to define key-value pairs for application-specific settings.

Fields:

  • ConfigKey: Input field to specify the name of the configuration setting.

  • ConfigValue: Input field to define the value associated with the configuration key.

Actions:

  • Add (Blue Button with Plus Sign): Adds a new configuration entry.

  • Delete (Red Button with Trash Icon): Removes the selected configuration entry.

  • Save (Green Button): Saves the current configuration settings.

We are incorporating this Config Key and Config Value by downloading the system configuration file of the Particular Application type we are created.

Application:

An application is an actual instance built using an application type. It includes specific configurations, files, connectors, and environment settings.

Application Details:​

The Details tabs is the first step in configuring a new application or editing an existing one. This tab allows users to define the basic metadata and status of the application.

Fields and Controls

  • Application Type
    Select the Application Type we are created.

  • Name
    Enter the name of the application.

  • Version
    Specify the version number.

    • Plus Icon: Add a new version. When we click on Add version

    • Select the build type for the version. Available options include:

  1. Production :(Only within the production can we view the products we have created)

  2. Development:

  3. QA
    We can add the version and Minor release ,Build Number based upon the application we created.

  • Description
    Provide a brief description of the application.

Checkbox Options

  • IsPreConfiguredBundle
    Indicates whether the application is a pre-configured bundle.

  • License
    Marks the application as licensed.
    For the applications information no need to check the license.

  • IsActive
    Activates the application in the system. 

  • Cancel (Red Button)
    Discards changes and exits the form.

  • Next (Green Button)
    Saves current details and proceeds to the next configuration tab.

Application Feature​

Feature Overview: The Feature tab is part of the application setup interface and is used to configure external connectors and features that integrate with the application. Here we are adding the Json file of the prescribed Json file.

Fields and Controls

  • Connector Type
    Select the type of connector to be used.

  • Connector Name
    Enter the name or identifier for the connector.

Action Buttons

  • Upload Features
    Initiates the process to upload feature configurations or files.

Document​

Overview: The Documents tab is used to upload and manage files related to an application. It allows users to define document details and attach files for reference or functionality. The document file types include Document, Build, Content Pack, and Link.

Fields and Controls

  • Document Name
    Enter the name or title of the document.

  • Document Type
    Select the type of document from predefined options. Options are
    Document, Build, Content Pack, and Link.

  • File Upload
    Choose a file from your system to upload.

Settings:​

Overview: This section displays key details about the connector used in the application setup.

Fields and Values

  • Connector_Name: 
    Represents the internal identifier that we used in Configurations file i,e System config File.

  • Product_Name: 
    Specifies the official name of the connector product being used.

Components:​

Here, we have included the NPM dependencies of the created applications, allowing users to see which NPM dependencies are being used.

  • Import / Export / DeleteAll Buttons:

    • Import: Allows users to bring external data into the system.

    • Export: Enables users to download or share the current data.

    • DeleteAll: Clears all existing data entries.

Search and Display Options:

  • Search Bar: Used to filter or locate specific entries.

Sellable Products:

A Sellable Product is the packaged version of the application that can be offered to customers. It includes licensing, pricing, and distribution settings.

Details Tabs:

  • Detail Tab : Displays core information about the product.

  • Feature Tab: Likely contains additional attributes or capabilities .

Fields in Detail Tab:

  • Sellable Product:

    • Value: Enter the Value of the Sellable Product.

  • Applications:

    • Entry: When we click on the tab, we see a list of the created applications.

  • IsActive Checkbox:

    • Status: Checked (indicating the product is active)

Sellable Features:​

In the Features tab, we maintain a list of connectors that can be assigned to the application via a JSON configuration file. This interface allows us to checkmark the specific connectors that should be linked to a particular sellable product.

License:

This interface displays and manages software licenses for the organization . Each license entry includes details about the user, project, product, access key, expiry date, and offline license type.

Add License:​

Here we can create a license based upon the sellable products and we need to have the enter the details for the application.

Create License Key Form Overview

This form is used to generate a new license key for a product within an organization. It includes fields for organizational details, license duration, activation settings, and product association. This license can be generated by PL admin or OEM

Form Fields

  • Organization:
    Dropdown to select the organization

  • User:
    Dropdown to select the user (-- Select User --)

  • Sellable Product:
    Dropdown to select the product (-- Select Sellable Product --)

  • Project ID:
    Enter the associated project ID

  • License Start Date:
    08/08/2025 10:51:50.058 AM

  • License Type Duration Options:

    • Number of Days

    • Fixed Date

    • Number of Years

    • Perpetual License (selected)

  • Expiration Date: Expiration Date

  • Activation Type:

    • You can activate a license using one of the following methods:

    • Online Activation

    • Choose this option to generate an online license key. You must agree to the terms and conditions before the key is created.

    • Offline Activation

    • This method allows you to activate the license using an offline certificate key. After agreeing to the terms and conditions, click on the Offline Certificate Key column in the license table to proceed.

    • Both

    • You can enable both online and offline activation methods for a license, offering flexibility based on your needs.

  • Activation Count:

  • Domain:
    Need to Know the Information

  • IsActive:
    Checkbox 

In the Table Columns​

The displayed information is organized based on the user's association with a specific organization type.
Organization
The name of the organization to which the license belongs

  • User
    The email ID of the user associated with the license.

  • Access Key
    Indicates the type of license key (e.g., Online Key).

  • Project ID
    The identifier for the project or application the license is tied to.

  • Sellable Product
    The product or bundle associated with the license (e.g., CData ODBC Connectors, DPL Studio).

  • Expiry Date
    The date when the license will expire.

  • Offline License
    Specifies the format of the offline license (typically by  Certificate File).

Activation Details​

System License Information Table

This table provides a structured view of license details for various systems. It includes the following columns:

  • System Details
    Information about the system or environment associated with the license.

  • Access Key
    The type or value of the license key used for activation. i,e Online, Offline or Both

  • Sellable Product
    The product or bundle linked to the license.

  • Activation Date
    The date when the license was activated.

  • Expiry Date
    The date when the license will expire.

  • Activation Type
    Indicates whether the license is activated online, offline, or both.

User Management

This interface displays a list of organizations along with their types and quick-access links for managing users, organizational settings, MFA configurations, and invitations.

Add Organization:​

Overview

This form allows administrators to create a new organization entry in the system. It includes fields for naming the organization, selecting its type, and providing a description.

Form Fields Explained

  • Name
    Enter the name of the organization. This should be unique and clearly identifiable.

  • Type
    Select the organization type from the dropdown:

    • PL -- Product Line

      • We have PL admin, PL User, Developer, QA.

    • OEM -- OEM Org Type

      • We have OEM admin and OEM User

    • Customer -- End-user

      • We have Customer Admin and Customer User.

  • Each role has its own permissions, and based on these roles, we map the corresponding screens.

  • Description
    Provide a brief description of the organization. This can include its purpose, scope, or any relevant notes.

Organization Information:​

The PL Admin has access to view details of all organizations and their users. Additionally, the PL Admin has the ability to create new organizations and user accounts.

  • Name
    The name of the organization Most be Unique.

  • Org Type
    Indicates the classification of the organization, such as:

    • PL (Product line )
      Each Org Type has Different Roles based upon the Org type .

      • PL Admin

      • PL User

      • Developer

      • QA

    • Customer
      Each Org Type has Different Roles based upon the Org type

      • Customer Admin

      • Customer User

    • OEM 
      Each Org Type has Different Roles based upon the Org type

      • OEM Admin

      • OEM User

  • User Details Links :
    Quick-access options for managing the organization:

    • Users -- View and manage users within the organization.

      • Based on the selected organization type, we provide options to either create a new user or invite an existing one

      • Create user Option we can create a user based upon the role.

First Name: Enter the user's given name.

Last Name: Enter the user's family name or surname.

Email: Provide a valid email address. This will be used for login and communication.

Password: Create a secure password for the user.

Confirm Password: Re-enter the password to confirm it matches.

Phone Number: Enter the user's contact number. Select the appropriate country code from the dropdown.

IsActive: Check this box to activate the user account immediately.

Roles Type:

OEM Admin: Grants administrative privileges within the OEM organization.

OEM User: Grants standard user access within the OEM organization.

Cancel: Discards the form and returns to the previous page.

Save: Submits the form and creates the user account.

  • Org -- Access organizational settings.

  • MFA Setting -- Configure Multi-Factor Authentication.

  • Invite -- Send invitations to new users.

Configuration:​

SMTP Settings:​

  • SMTP Address: Enter the address of your SMTP server.

  • SMTP Port: Specify the port used for SMTP communication.

  • Username: Provide the email address or username used to authenticate with the SMTP server.

  • Password: Enter the password or app-specific password associated with the SMTP account.

  • Mail From: Specify the email address that will appear in the "From" field of outgoing emails.

Azure Config:​

This page allows you to securely configure access to your Azure Key Vault, which is used to store and manage sensitive information such as secrets, keys, and certificates.

  • Key Vault Name: The name of your Azure Key Vault instance.

  • Client ID: The Application (client) ID registered in Azure Active Directory.

  • Tenant ID: The Directory (tenant) ID associated with your Azure subscription.

  • Client Secret: A secure password or secret key used to authenticate the application with Azure Key Vault.

  • Secret Name: The name of the specific secret stored in the Key Vault that your application will access.

  • Save: Click to store the entered configuration securely and enable integration with Azure Key Vault.

Azure Storage:​

This page allows you to configure access to your Azure Storage account, enabling secure storage and retrieval of data within your application.

  • Account Name: The name of your Azure Storage account.

  • Account Key: A secure access key used to authenticate and authorize access to the storage account.

  • Cancel: Discards any changes and exits the configuration screen.

  • Save: Stores the entered Azure Storage credentials and enables integration.

Service Desk:​

This page allows you to configure integration settings for your Service Desk system, enabling seamless ticketing and support workflows.

  • Domain: Enter the domain URL of your Service Desk platform.

  • Token: Provide the authentication token used to securely connect to the Service Desk API.

  • ServiceDeskId: Enter the unique identifier for your Service Desk instance or project.

  • EmailId: Specify the email address associated with the Service Desk account or used for notifications.

  • Active: Check this box to enable the Service Desk integration. Uncheck to disable it.

  • Cancel: Discards any changes and exits the configuration screen.

  • Save: Stores the entered Service Desk settings and activates the integration.

Settings:​

This page displays the application's terms and conditions, and provides an option to edit them as needed.

Demo Download:​

This page displays a list of users who have downloaded the  application, along with relevant metadata such as version, email, expiry date, and download date.

  • Application: The name of the application.

  • Version: The version number of the application downloaded.
    Example: 7.0.0

  • User Email: The email address of the user who downloaded the application.

  • Expiry date: The date and time when the user's access to the application will expire.

  • Download Date: The date and time when the application was downloaded by the user.

Chatpion Configuration:​

Attribute Mapping:​

This page allows administrators to define and manage attribute mappings for sellable products, including licensing and activation settings.

  • Attribute: Displays the name of the attribute being configured.

  • Sellable Product: Select the product from the dropdown that this attribute is associated with.

  • ProjectID: Enter the unique identifier for the associated project.

  • Activation Count: Specify the number of times the product can be activated.
    Default: 0

  • Activation Type: Choose the type of activation:

    • Both

    • Number of Days

    • Number of Years

    • Perpetual License

  • License Type Duration: Select the license duration type and specify the value:

    • Number of Days

    • Number of Years

    • Perpetual License

  • IsActive: Enable or disable the attribute mapping.

  • IsApplication: Indicates if the attribute is linked to an application.

  • IsLicenseTypeApp: Specifies if the license type is application-specific.

  • Attribute value mapping with Feature: Click to configure feature-level mappings for the selected attribute.

  • Cancel: Discards changes and exits the configuration screen.

  • Save: Saves the current attribute mapping settings.

Users:​

This page displays the status of user invitations sent through the system. It helps administrators track which users have been invited, their current status, and provides options to resend invitation links.

  • User Name: The name of the invited user.

  • User Email: The email address to which the invitation was sent.

  • Created Date: The date and time when the invitation was generated.

  • Status: Indicates whether the invitation is pending, accepted, or expired.

  • Resend Link: Allows you to resend the invitation email to the user.

License Status:​

This page provides an overview of user licenses and invitation statuses for sellable products. It allows administrators to monitor license validity, user activity, and manage invitations.

  • Email: The email address of the user associated with the license or invitation.

  • Sellable Product: The product linked to the user's license.

  • License Expiration: The date when the user's license will expire.

  • License Status: Indicates whether the license is active, expired, or pending.

  • User Status: Shows the current status of the user (e.g., active, inactive).

  • Created Date: The date when the license or invitation was created.

  • Resend Invite: Option to resend the invitation email to the user.