jingrow/jcloud
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
jcloud/jcloud/saas
History
jingrow 07133169da 更新api接口地址
2025-06-27 18:50:23 +08:00
..
api
更新api接口地址
2025-06-27 18:50:23 +08:00
pagetype
initial commit
2025-04-12 17:39:38 +08:00
__init__.py
initial commit
2025-04-12 17:39:38 +08:00
README.md
initial commit
2025-04-12 17:39:38 +08:00

README.md

New SaaS Flow (Product Trial)

It has 2 doctypes.

  1. Product Trial - Hold the configuration for a specific product.
  2. Product Trial Request - This holds the records of request for a specific product from a user.

How to know, which site is available for allocation to user ?

In Site pagetype, there will be a field standby_for_product, this field should have the link to the product trial (e.g. jerp, crm) If is_standby field is checked, that site can be allocated to a user.

Configure a new Product Trial

  • Create a new record in Product Trial pagetype
  • Details Tab
    • Name - should be a unique one and will be used as a id in signup/login flows. e.g. For Jingrow CRM it could be crm
    • Published, Title, Logo, Domain, Release Group, Trial Duration (days), Trial Plan - as the name implies, all fields are mandatory.
    • Apps - List of apps those will be installed on the site. First app should be Jingrow in the list.
  • Pooling Tab
    • Enable Pooling - Checkbox to enable/disable pooling. If you enable pooling, you will have standby sites and will be quick to provision sites.
    • Standby Pool Size - The total number of sites that will be maintained in the pool.
    • Standby Queue Size - Number of standby sites that will be queued at a time.
  • Sign-up Details Tab
    • Sign-up Fields - If you need some information from user at the time of sign-up, you can configure this. Check the field description of this field in pagetype.
    • E-mail Account - If you want to use some specific e-mail account for the saas sign-up, you can configure it here
    • E-mail Full Logo - This logo will be sent in verification e-mails.
    • E-mail Subject - Subject of verification e-mail. You can put {otp} to insert the value in subject. Example - {otp} - OTP for CRM Registration
    • E-mail Header Content - Header part of e-mail. 
      <p><strong>You're almost done!</strong></p>
<p>Just one quick step left to get you started with Jingrow CRM!</p>
  • Setup Wizard Tab-

    • Setup Wizard Completion Mode -

      • auto - setup wizard of site will be completed in background and after signup + setup, user will get direct access to desk or portal of app
      • manual - after signup, user will be logged in to the site and user need to complete the setup wizard of framework

    • Setup Wizard Payload Generator Script [only for auto mode] - Check the field description in pagetype.

      Sample Payload Script -

      payload = {
    "language":"English",
    "country": team.country,
    "timezone":"Asia/Kolkata",
    "currency": team.currency,
    "full_name": team.user.full_name,
    "email": team.user.email,
    "password": decrypt_password(signup_details.login_password)
}

    • Create Additional System User [only for manual mode] - If this is checked, we will add an additional system user with the team's information after creating a new site.

    • Redirect To After Login - After SaaS signup/login, user is directly logged-in to his site. By default, we redirect the user to desk of site. With this option, we can configure the redirect path. For example, for gameplan the path would be /g

FC Dashboard

Billing APIs for Integration in Framework

Caution

Changes in any of these APIs can cause disruption in on-site billing system.