# Operation Guide (Private Deployment)
This operation guide is only applicable to the Community Edition and Private Deployment Edition, and is continuously being updated.
# 1. Registration and Login
Log in to the Developer Center that you have already deployed, and click "Free Registration" on the page.

You need to complete the account registration process through the following steps:
# Step 1: Fill in Account Information
Enter your phone number, verification code, email, and set a login password, then click "Complete" to successfully register.

# Step 2: Supplement Enterprise Information
After completing the registration, enter the Developer Center, and sequentially click "Username - Change to Enterprise Account" in the lower-left corner to access the enterprise authentication page.

On the enterprise authentication page, you need to fill in the enterprise's main information and administrator information respectively.

# Step 3: Upgrade the Current Team to an Enterprise Type
After submitting without errors, a submission success page will appear. You just need to wait for the Digital Center to review the enterprise information.

# 2. Role and Member Management
The Developer Center supports custom roles and can flexibly customize permissions according to roles to manage member account permissions. The specific operations are as follows:
# Step 1: Add a New Role
Click the "Add" button on the "User - Role Management" page;

# Step 2: Assign Permissions to the New Role
In the "Add Role" drawer, input the role name and check the corresponding Management Console and Developer Tools permissions, then click "Confirm" to save.

# Step 3: Assign Roles to Members
Members of the Developer Center are divided into Collaborative Members and Experience Members:
- Collaborative Members: Refers to personnel who can use Developer Tools, log in to the Developer Center, and view and manage Mini-Programs.
- Experience Members: Refers to personnel who can preview the development version or experience version of the organization's Mini-Program by scanning a QR code with the APP. No additional role configuration is required.
# Assigning Roles to Collaborative Members
Collaborative Members are "invitation-based," meaning users can join the organization via an invitation link. When sending an invitation, a role must be selected. After the user successfully joins, the administrator can edit their role again. If the user does not have an account on the Mini-Program platform, they must register before joining the new organization.
Method 1: Select a role when inviting
Click "User - Personnel Management - Collaborative Members - Invite," select a role in the pop-up window, generate a link, and copy the link. Users can join the enterprise through the invitation link.


Method 2: After the user joins the enterprise, the administrator assigns them a specific role
- Path 1: User - Role Management - Role - Manage Members

- Path 2: User - Personnel Management - Collaborative Members - User - Edit Role

# Adding Experience Members
Unlike collaborative members, experience members are "added manually" by adding the user ID of external personnel to designate them as experience members.
Here, the user ID should be taken from the unique identifier of the account system outside the Mini-Program platform. It serves as the credential for the APP system to verify whether the user has permission in the backend. It is recommended that the APP injects the phone number as the user ID when integrating the SDK, which makes importing the user ID in the backend more convenient.
Path: User - Personnel Management - Experience Members - Add

# 3. Create a Mini-Program
# 3.1 Create a New Mini-Program
You can enter the creation of a Mini-Program from the following two entry points:
Entry 1: After logging into the Developer Center, click "Create New Mini-Program" under "Home - My Mini-Programs."

Entry 2: In "Mini-Programs," click "Add New."

When creating a Mini-Program, you need to fill in basic information such as the Mini-Program name, type, category, and introduction, as shown in the figure below:

# 3.2 Modify Mini-Program Basic Information
After successfully creating the Mini-Program, click on the Mini-Program, expand the details on the right side, and click "Edit" in the "Basic Information" section to modify the Mini-Program information.

The basic information includes the Mini-Program name, Mini-Program type, category, introduction, and detailed description. Clicking "Language Configuration" in the lower-left corner allows you to enter the multi-language configuration page.

In the Mini-Program details, you can perform version management, privacy settings, gray release, etc.

# 3.3 View Created Mini-Programs
To view created Mini-Programs, you can enter through the "Home" or "Mini-Programs" menu:
- Path 1: Home - My Mini-Programs

- Path 2: Mini-Programs - Mini-Program List

# 4. Develop a Mini-Program
# 4.1 Development Tools
The Mini-Programs on this platform are compatible with WeChat, ByteDance, Alipay, and other Mini-Programs. Developers are recommended to use FinClip Studio (opens new window) or WeChat Developer Tools (opens new window), or use VSCode (any development tool you are accustomed to) for development. Use FinClip Studio or WeChat Developer Tools for preview and debugging;
Before development, it is recommended to read the Mini-Program Development Guide (opens new window). Due to the high compatibility of this platform with WeChat Mini-Programs, you can also refer to the WeChat Mini-Program Development Documentation (opens new window) for development;
If you need to use third-party frameworks, it is recommended to use the following third-party frameworks with good compatibility:
- Mini-Program Development Frameworks
- Taro (opens new window)
- kbone (opens new window)
- uni-app (opens new window) (only supports Mini-Programs generated by uni-app)
- UI Frameworks
- Mini-Program Development Frameworks
# 4.2 Complete Domain Settings
To ensure sufficient security guarantees in the Mini-Program application, all network request domains in the Mini-Program need to be configured in advance. Only after configuration can they be accessed normally.
On the "Development - Domain Management" page, you can manage all available Mini-Program domains for the current team (i.e., one configuration applies to all Mini-Programs simultaneously). Enter all domain addresses used by the current team in the domain configuration and separate them with "Enter" before saving.

When filling in the domain, it needs to be filled in according to the requirements, such as entering the full address with the protocol header, e.g., https://example.com/page1.html (opens new window).

If the domain you need to configure only needs to take effect in a specific Mini-Program, you can configure it on the Mini-Program details page. The domain configured on the Mini-Program details page only takes effect for the current Mini-Program.

# 4.3 Preview and Debugging
You can use FinClip Studio for real-time preview and debugging, or set the Mini-Program as an experience version for debugging.
Method 1: Debugging through FinClip Studio

Method 2: Debugging through the experience version
After successfully uploading the code package, you can click "Configure Experience Version" on the "Mini-Program - Mini-Program - Details - Version Management" page to set the corresponding version of the Mini-Program as the experience version;

After configuration, scan the QR code using the FinClip App (for usage of the FinClip App, please refer to: FinClip App FAQs (opens new window)) to preview and test.

# 4.4 Uploading Code Package Using Studio
Please download FinClip Studio to complete the code package upload. FinClip Studio can compile Mini-Program code locally and directly upload the code package. For detailed operation instructions, please refer to: Developer Tools Operation Guide (opens new window).

After successful upload, you can view it in "Mini-Program - Details - Other - Historical Code Packages."

# 5. Mini-Program Submission for Review and Publishing/Unpublishing
# 5.1 Complete Privacy Settings
Privacy settings will be disclosed in scenarios such as the "More Info" page and authorization pop-ups when users use the Mini-Program.
Path: Mini-Program - Privacy Settings

Click "Configure" and follow the page guidance to supplement the corresponding Mini-Program privacy information interface.
- If you do not use any user-generated content (UGC) in the Mini-Program, select the first option: "The developer of this Mini-Program promises and guarantees that no user information has been processed in any way. If user information is processed later, the 'Mini-Program Privacy Protection Guidelines' will be updated promptly."
- Otherwise, follow the guidance to select the second option and enter the corresponding permissions.

# 5.2 Submit for Review
After configuring the domain, uploading the code package, and completing the privacy settings, you can add a new review and submit it in "Mini-Program - Details - Version Management." Fill in the supplementary review information and wait for the Digital Center to approve or reject it. The review result will be notified to you through the "Notification Center."
Path: Mini-Program - Details - Detailed Information - Version Management - Configure Review Version


In "Mini-Program - Details - Other - Mini-Program Historical Review Records," you can view the version review records of the current Mini-Program.

# 5.3 Mini-Program Publishing/Unpublishing
If you selected "Automatically publish after approval" when submitting the Mini-Program for review, the Mini-Program will automatically be published as the online version after passing the review; otherwise, you need to operate manually.
# Publishing/Unpublishing

Path: Mini-Program - Details - Version Management
- If there is no online version, you can "Configure Online Version."

- If there is an online version, you can operate "Export Offline Package," "Version Rollback," and "Version Unpublish."
- If there is an approved version, you can operate "Publish to Online Version"; if there is no approved version, you can "Configure Review Version."

Click "Publish to Online Version," and you can choose:
- Full Release
- Gradual Release by User Ratio: Can be regarded as a quick gradual release by user ratio dimension
- Create Gradual Release Plan: Detailed gradual release plan can be set

# Gray Release
Create a gray release plan that can be published according to specified rules, as shown in the figure below. For more rule configurations, go to "Development - Gray Rules" for settings.

Additionally, you can view all Mini-Program versions with statuses such as "Ready to Publish," "Publishing," "Pending Release," or "Completed" under "Mini-Program - Details - Gray Release." For versions marked as "Ready to Publish," you can also click "Create" to perform detailed gray release operations.

# 6. Associate Mobile Applications
After completing the addition of Mini-Programs, we need to configure the relevant information of the Host-App in the FinClip Mini-Program Open Platform. Only after configuring the Host-App's information can the Mini-Program run properly within the designated Host-App.
# 6.1 Add Application
Path: Application - Add

When adding an application, you need to fill in the application name and the enterprise name to which the application belongs, upload an icon, and determine whether it is visible to other teams and whether the BundleID is visible to other teams. Among these:
- The application name can be modified later.
- The enterprise to which the application belongs cannot be modified.

# 6.2 Configure BundleID
After adding an application, you also need to configure the related Bundle ID to generate the corresponding SDK KEY and SDK SECRET, thereby completing the application association operation.
Path: Application - Details - BundleID - Configuration


If the Bundle ID for iOS and Android is the same, you only need to check "Android/iOS Universal" and add one Bundle ID:
# 6.3 Configure SDK Key & Secret
When opening a Mini-Program in the Host-App, the SDK decrypts based on the current App's BundleID, SDK Key, and Secret. Only when configured correctly can the Mini-Program run normally.
Therefore, you need to copy the corresponding Key and Secret from the right side of the corresponding BundleID and fill them into the SDK initialization fields according to the SDK configuration documentation.

# 6.4 Associate Mini-Program
To open a Mini-Program in a specified application, you need to associate the Mini-Program with the application.
Path: Application - Details - Associate Mini-Program - Edit Mini-Program

In the pop-up window, select the Mini-Program for association, as shown in the figure below. After selecting the Mini-Program, third-party applications also need to add a Mini-Program entry in their APP so that users can access it normally.

Note:
For private customers after procurement, you can set whether digital center review is required here. That is, after the development center adds a new associated Mini-Program, it needs to wait for the digital center review. If the digital center does not pass the review, the Mini-Program in the development center will not be able to open in the corresponding application.
When associating a Mini-Program with a Host-App, note the following:
- The cooperative application must integrate the FinClip Mini-Program SDK and configure the corresponding SDK Key and Secret.
- Enterprises need to associate the listed Mini-Programs with the cooperative application to open the corresponding Mini-Program.
- The Mini-Program Open Platform will verify the SDK KEY, application Bundle ID, and the association relationship of the Mini-Program. If not associated, the Mini-Program cannot be opened normally.
For SDK integration instructions, please refer to:
# 7. User Feedback
The Mini-Program SDK of the Open Platform provides an entry point for collecting user feedback. Click the "..." in the upper left corner of the Mini-Program to see the complaint and feedback entry, as shown in the figure below:

Feedback on "Function Abnormalities" and "Product Suggestions" will be collected in the Home - To-Do Center of the Development Center. Please handle them promptly.


Of course, the above complaint information can also be viewed and processed in the ticket management at the lower-left corner of the screen.

# 8. To-Do Center
For other pending actions, you can enter through the "To-Do Center" entry on the homepage, which will include relevant business processes that you need to handle (such as Mini-Program review, Mini-Program binding, custom API calls, etc.). Through the To-Do Center, you can quickly enter the business processes that need to be handled, helping you carry out related tasks.

# 9. FinClip APP Usage Instructions
Developers can obtain rich development assistance through the "FinClip APP." Download it here: FinClip APP Download Link (opens new window)
Usage Instructions:
- Install the "FinClip APP" and "Log In."
- Scan the code to open the Mini-Program: You can open all Mini-Programs within the platform, facilitating developer debugging.
- Manage Mini-Programs: Developers can quickly view the Mini-Programs they have created and conveniently open previously uploaded code packages.
