# FinClip Mini Program Open Platform POC Guide Manual - On-Primise

Use this guide to evaluate the FinClip integration and management workflow in an on-premise environment. Prepare the server, network and cross-functional test team, install the platform, then verify the demo mini-program before testing your own mini-program against your business requirements.

​ FinClip is a mini-program runtime SDK. Whether it's a mobile app or devices such as computers, TVs, in-vehicle hosts, etc., after integrating the FinClip Mini-Program SDK, they can quickly acquire the ability to run mini-programs.

​ FinClip provides a mini-program SDK and a mini-program Administration Portal. Developers can migrate and deploy existing mini-programs in their own apps, thereby obtaining a sufficiently flexible mini-program development and management experience.

​ FinClip not only is compatible with WeChat Mini Program syntax but also provides a full set of Mini Program development and management toolkits. Developers do not need to learn new syntax and frameworks, and can use FinClip IDE, Mini Program Administration Portal, Mini Program Development Documentation, and FinClip App to complete all tasks from development and testing to preview and deployment at low cost and high quality.

​ FinClip can help enterprises quickly integrate their own and third-party business applications; assist enterprises in building super apps to achieve loose coupling of complex lines of business; and help enterprises develop platform-based operational thinking and organizational structure.

img

# 1.1 Purpose of POC

This POC Guide is designed to help you understand the main functions and advantages of the FinClip Mini Program Open Platform Management System through hands-on operations. Through this process, you can assess whether the product meets the actual needs of your enterprise, whether the real functions or performance of the product are consistent with the vendor's claims, evaluate the compatibility of the system with your business requirements, and use it as a basis for procurement decisions.

# 1.2 POC Objectives

The goal of this POC is to help you successfully experience the core functions of the FinClip Mini Program Open Platform Management System, including functional modules such as the FinClip Mini Program Container SDK, FinClip Mini Program Administration Portal, FinClip Ecosystem Building, and FinClip Mini Games. Through this process, it is expected to help you confirm the feasibility of the project, evaluate project performance, and assess project potential, providing important basis for subsequent decision-making.

# 2. Preparation Phase

# 2.1 Environmental Requirements

# 2.1.1 Operating System

The FinClip Mini Program Open Platform uses Docker for service deployment. We recommend using the Linux operating system to run the FinClip Mini Program service. Of course, if your operating system meets the requirements for running Docker, you can run the FinClip platform. We recommend that you use the following systems to run the FinClip Mini Program service:

Operating System Version Requirements
Ubuntu ≥ 20.04,22.04
CentOS ≥ 7.9
Debian ≥ 11

# 2.1.2 Hardware Configuration

The FinClip Mini Program Open System has no requirements for the operating environment; it can run on TCE-metal, virtual machines, or cloud servers. To ensure the normal operation of the system, the minimum server configuration required for FinClip to run is as follows:

Category Specification
Number of Servers 1 unit
Server Memory 8 G
Number of CPU Cores 4 C
Disk Space 200 G

# 2.1.3 Network Configuration

The internal communication of the FinClip Mini Program Open System Service uses Docker internal network communication. However, we need to provide an externally accessible port for the FinClip SDK and Web services to access our system. The default port of the system is 8000, and the communication protocol is TCP. Of course, you can also change the externally open port number, such as 80 or 443.

Protocol Port Description
TCP 8000 Organization and Operations Management Console and API

# 2.1.4 Operational Permissions

During the deployment process, the FinClip Mini Program Open System needs to use root privileges for the following operations:

  • Docker: Running Docker requires root privileges, and regular users without root privileges will not be able to operate Docker.
  • Change data directory permissions: During the service deployment process, it is necessary to change the permissions of the data storage directory to ensure successful data writing.

# 2.2 Requirements

To ensure that this POC can achieve the expected goals, a cross-functional team is required to work together, as the combination of professional knowledge and skills from different fields is crucial for improving the overall verification work and feasibility of the project. We need you to arrange the following roles to participate in the product testing:

No Role Number of people Function
1 Project Manager 1 1. Responsible for overall project control, including the formulation, execution, and monitoring of the POC solution, to ensure the smooth implementation of the entire POC solution and achieve the expected results. 2. Responsible for testing the core functions of FinClip Mini Program Platform. 3. Responsible for tasks such as organizing, summarizing, and reporting on the POC experience.
2 App Developer 2~3 1. Responsible for testing the FinClip Mini Program Container SDK, including iOS SDK, Android SDK, PC SDK, etc., and outputting SDK test reports. 2. Responsible for outputting installation packages for experience, demonstration, and reporting, including but not limited to apk, ipa, exe, dmg, etc.
3 Front-End Development 1 1. Responsible for testing the FinClip Studio Mini Program power builder and outputting the FinClip Studio test report. 2. Responsible for outputting an experienceable Mini Program, ensuring that the Mini Program runs correctly on FinClip Studio, and publishing it on the system Administration Portal of the FinClip Mini Program Platform.
4 Operation and Maintenance Engineer 1 1. Responsible for providing the operating environment of the FinClip Mini Program Digital Management System. 2. Responsible for the installation and deployment of the FinClip Mini Program Digital Management System, providing environmental support for the smooth execution of this POC, and participating in software functional testing and troubleshooting.

# 3. Installation and Deployment

If your server can be remotely accessed, Finogeeks Team engineers can provide installation and deployment services.

In this chapter, we will introduce how to set up a set of FinClip Mini Program Open Platform system on your privatized server.

# 3.1 Install Docker

The FinClip Mini Program Open System uses Docker (opens new window) for service deployment. Docker is an open-source project used to automatically deploy applications as portable, independent containers that can run in the cloud or locally. First, we need to install Docker on your server. For instructions on how to install Docker, please refer to: Install Docker Engine (opens new window)

# 3.2 Download the software installation package

FinClip Open System Software Installation Package includes Docker Mirroring and Docker Compose configuration files. We will regularly push our installation package to the designated repository. You can obtain different versions by version number Here we take FinClip version 1.3.1 as an example. You can download it directly through the download link: download link (opens new window), or through the command line. The command line is as follows:

wget https://temp-1251849568.cos.ap-guangzhou.myqcloud.com/finclip-cloud-v1.3.1.tar.gz

# 3.3 Load Mirroring

After downloading and completing the installation of the FinClip Mini Program Open System Software, you will obtain a Compressed Packet file with the suffix.gz. Unzip the Compressed Packet file to the directory where you need to install it, and then use Docker commands to load the mirroring file into Docker. You can complete this through the following command line:

  • Navigate to the location of the Compressed Packet and extract it
tar xvf ./finclip-cloud-v1.3.1.tar.gz
  • Load mirroring
cd finclip-cloud 
docker load -i images.tgz

# 3.4 Modify File Configuration

# 3.4.1 License Configuration

The startup and operation of the FinClip Mini Program Open System rely on a License. You can obtain the License for the FinClip Mini Program Open System by contacting the official website (opens new window) of FinClip or your business contact person with FinClip, and then configure the License in the fc-private.yaml file:

  • Edit the fc-private.yaml file and modify the License configuration information
LICENSE_ENCRYPTION_STR: " Fill in your License string "

# 3.4.2 Custom Configuration

This configuration item is optional.

  • Modify the service listening port for business access. The default port is :8000. Edit the.env file to modify the port configuration.
gateway_port: "Fill in your port"
  • Modify the database and static resource storage paths, default directory:./data, edit the.env file to modify
BASE_STORAGE_DIR: " Enter the storage path for your database and static resources"

# 3.5 Start the Service

After you confirm that the configuration content of the above documents is correct, we can start the service. First, we need to start the infrastructure service to ensure that the database, middleware, etc. are started successfully. Then, start the FinClip configuration service. Finally, start the business microservices of the FinClip Mini Program Open Platform Management System.

  • Initialize file storage information and grant special read and write permissions to the file directory
bash init.bash
  • Start infrastructure services, including mysql, redis, minio, and consul services
docker compose up -d mysql redis minio consul elasticsearch && sleep 15
  • Start the FinClip Configuration Service
docker compose up -d quark && sleep 10
  • Start the business microservice of the FinClip Mini Program Open Platform Management System
docker compose up -d
  • Finally, you can quickly confirm whether all services are running properly through the following command line. When you see that the status of all services is "Up", it indicates that the services have been successfully started.
docker compose ps

# 3.6 Access System

After confirming that the service has started normally via Docker, you can access the system through the following link to confirm whether the system has been successfully set up.

Website Name Access Link Account Instructions
Administration Portal http://IP:PORT/ops#/ (opens new window) admin PORT: Port number, default 8000; IP: IP address of the server, e.g., 172.217.163.46
Developer Portal http://IP:PORT/dev#/ (opens new window) Self-register

# 4. Verification Steps

You need to prepare the following materials and content to complete the POC verification of FinClip.

# 4.1 Verification Preparation

# 4.1.1 Account Preparation

# 4.1.1.1 Get Verification Code

During system deployment, the SMS channel was not integrated, so all SMS verification functions within the system cannot be used.

You can obtain a universal verification code by logging into the Administration Portal, where the initial account is usually: admin, then navigating to [Administration Portal - Development Management - Custom Configuration - Product Security Configuration - Enable Universal Verification Code]. This verification code can be used for all verification entry points on the platform.

img

# 4.1.1.2 Register an Account
  • ① Enter the Developer Portal, and click "Register" on the page

img

  • ② Enter your account, email address, and verification code,set your login password, and then click "Register to successfully register
    • img
# 4.1.1.3 Upgrade to a Business Account
  • ③ Enter the Developer Portal, click sequentially on the bottom left corner "Username - Upgrade Account", and enter the enterprise authentication page

img

  • ④ Fill in the enterprise entity information and administrator information respectively (during the testing phase, the following information will not be verified, and you can fill it in at will, including materials such as the enterprise's business license)

img

  • ⑤ After successful submission, a page indicating successful submission will appear.

img

  • ⑥ Log in to the Administration Portal, and then click "Pass" through [Administration Portal - Ecosystem - Self-organized Organization Management - Organization Details - Click Pass] to pass the enterprise review.

# 4.1.2 Log in to FinClip Studio

  • ① Download Please ensure that your version of FinClip Studio (opens new window) is the latest version. If not, you can download our latest version of FinClip Studio (opens new window).
  • ② Configure the server The default connection address of FinClip Studio is the FinClip SAAS environment. You need to change it to your private environment, then log in. Open FinClip Studio, click 「Login - Server Configuration - Custom Server - Enter the domain name or IP for accessing the FinClip service」 in the bottom left corner:

img

  • ③ Log in to the account After the service configuration is completed, enter the account and password prepared in "Section 4.1.1", click "Log in", and you can complete the login to FinClip Studio.

img

# 4.1.3 Log in to FinClip App

  • ① Download iPhone users please log in to the App Store and search for 「 FinClip (opens new window) 」 to download. Android users please click 「 Download Link (opens new window) 」 or go to 「Tencent MyApp」, 「Google Play Store」 to download the latest version of the FinClip APP.
  • ② Download The default connection address of the FinClip App is the FinClip SAAS environment. You need to change it to your private environment and then log in. The operations are as follows:

img

# 4.1.4 Demo

If you wish to obtain some demo, you can download it via the following method; otherwise, you can skip this step

Type Name Development Language Download URL Notes
Mini Program Example Mini Program WeChat Native https://gitee.com/finclip/miniprogram-demo FinClip Sample Mini Program, which can be used to test the capabilities of relevant APIs and components in Mini Programs
SDK Android SDK Java https://gitee.com/finclip/android-demo Android demo(implementation of initialization, opening Mini Programs, custom APIs, etc.)
iOS SDK https://gitee.com/finclip/ios-demo iOS demo(implementation of initialization, opening Mini Programs, custom APIs, etc.)
PC SDK https://gitee.com/finclip/finclip-desktop-demo PC-side demo(implementation of initialization, opening Mini Program, custom API, etc.)

# 4.2 Verification Plan

For the POC verification process, verifying the main process first helps to identify major issues that may affect the entire project at an early stage. After confirming the feasibility of the main process, conducting functional verification can avoid wasting resources on testing specific functions when the basic process is not feasible. Therefore, the verification plan for this POC provides a detailed description of the verification of the main process.

# 4.2.1 Main Process Verification

To ensure the integrity of the main process verification, in this step, please first use our sample code Mini Program. Run our sample code Mini Program in your App to ensure the integrity of the main process, then replace it with your Mini Program, and finally perform the corresponding functional verification.

# 4.2.2 Verification Objectives

Run the FinClip Example Mini Program correctly on the target software App through the capabilities provided by the FinClip Mini Program Open Platform system.

# 4.2.3 Verification Process

img

# 4.2.4 Verification Steps

# 4.2.4.1 Create Mini Program
Category Content
Test Number M0001
Test Item FinClip Mini Program Digital Management System - Developer Portal
Test Function Create Mini Program
Preconditions On the browser, open the FinClip Mini Program Platform - "Developer Portal" and log in successfully.
Test steps 1. Enter the "Mini Program" directory, click the "New" button, and a Mini Program text box will pop up. 2. Fill in the information such as "Mini Program Name", "Project Type: Select Mini-Program", "Category: Select Tool", "Project Summary", "Project Description", "Icon" in sequence, and click "Confirm" to create a Mini Program. 3. Click the newly created Mini Program, view the details, enter "Information Details" - "Privacy Setting" - "Configure", and a Mini Program Data Policy will pop up. 4. Select "No information of users will be processed in any way" and click "Confirm" .
Expected Effect 1. After successfully creating a Mini Program, enter the "Mini Program" directory, and you can view the Mini Program you just created from the list. 2. Click on the corresponding Mini Program to view its basic information, including the name, AppID, and other details.
# 4.2.4.2 Add Domain Name/IP Allowlist
Category Content
Test Number M0002
Test Item FinClip Mini Program Digital Management System - Administration Portal
Test Function Add Domain Name/IP Allowlist
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Development" and log in successfully.
Test steps 1. Enter the "Development - Domain" directory, click the "Domain Configuration" button, and a domain name management input box will pop up. 2. In the allowlist input box, enter the business domain name or IP that the Mini Program needs to access, and click "Confirm" .
Expected Effect 1. The domain name allowlist has been successfully configured. Navigate to the "Development - Domain " directory to view the corresponding domain name and the allowlist/blocklist.
# 4.2.4.3 Create a Mini Program Project
Category Content
Test Number M0003
Test Item FinClip Mini Program Open Platform Management System - FinClip Studio
Test Function Create a Mini Program Project
Preconditions Open FinClip Studio and complete the login.
Test steps 1. Open FinClip Studio, click the 「+」 button, and a page for creating a mini-program will pop up. 2. Enter 「Project Name」, select 「Project Directory」, choose 「Mini-program」 for the type, select 「Template」 for the project template, and click the 「Create」 button in the lower right corner.
Expected Effect 1. FinClip Studio automatically creates projects and compiles them. 2. In FinClip Studio, you can preview the mini-program example template.
# 4.2.4.4 Upload Mini Program Code Package
Category Content
Test Number M0004
Test Item FinClip Mini Program Open Platform Management System - FinClip Studio
Test Function Upload Mini Program code package
Preconditions Open FinClip Studio and complete the login.
Test steps 1. Click the "Upload" button at the top of FinClip Studio to pop up the Mini Program upload page. 2. Select the AppID, which is the Mini Program ID created in Step 1, enter the "Version", enter the "Description", and click "Confirm" .
Expected Effect Mini Program uploaded successfully, and a "Upload Success" prompt message popped up.
# 4.2.4.5 Submit Mini Program for Review
Category Content
Test Number M0005
Test Item FinClip Mini Program Open Platform Management System - Developer Portal
Test Function Submit Mini Program for review
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Development" and log in successfully.
Test steps 1. Enter the "Mini Program" directory, click on the newly created Mini Program, view details, and enter "Information Details" - "Version" - "Review Version". 2. Follow the steps of "Submit for review" - "Fill in review information (optional)" - "Confirm information" - "Next " - "Confirm" to submit for review.
Expected Effect In the review version, you can view the review version information and submission information.
# 4.2.4.6 Review Mini Program
Category Content
Test Number M0006
Test Item FinClip Mini Program Open Platform Management System - Administration Portal
Test Function Review Mini Program
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Administration Portal" and log in successfully.
Test steps 1. Enter 「Home」 - 「To-Dos」 - 「Review Status」, find the Mini Program submitted for review in the above steps, click 「Details」, and the Mini Program review page will pop up. 2. Check the Mini Program information, and after confirmation, click the 「Pass」 button at the bottom of the page, and the review is successful.
Expected Effect 1. The Mini Program has passed the review, and the above Mini Program pending review will be removed from the to-do list. 2. Enter the "Developer Portal", go to the "Mini Program" directory, click on the Mini Program to view details, and the Mini Program will show as Good to go.
# 4.2.4.7 Launch Mini Program
Category Content
Test Number M0007
Test Item FinClip Mini Program Open Platform Management System - Developer Portal
Test Function Launch Mini Program
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Developer Portal" and log in successfully.
Test steps 1. Enter the <Mini Program> directory, click on the newly created mini program, view details, enter <Information Details> - <Version> - <Review Version>, click <Publish to Online Version>, and a release pop-up window will appear. 2. Select <Full Release>, click <Confirm>, and the release of the mini program is completed.
Expected Effect Refresh the page, and the status of the mini-program changes to - Published.
# 4.2.4.8 Create Host Application

If you do not have a host app, you can skip this step and go directly to Section 4.2.4.12 to open the Mini Program preview via [Method 2] FinClip App.

Category Content
Test Number M0008
Test Item FinClip Mini Program Open Platform Management System - Developer Portal
Test Function Create Host Application
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Developer Portal" and log in successfully.
Test steps 1. Enter the "Host-App" directory, click the "New" button, and a new application input box will pop up. 2. Fill in the information such as "App Name", "Affiliation Organization", "Summary", "The other teams can see it - No", "Application automatically associates with mini programs - Yes", "Upload Icon" in sequence, and click "Confirm" to create the application. 3. Enter the "Host-App" directory, click the "Host App Name ", enter "BundleID" - "Add the BundleID", and a pop-up window for adding a BundleID will appear. 4. Select the BundleID application platform, here choose "Android"/"iOS ", enter the App's BundleID, and click "Confirm" to complete the addition.
Expected Effect Enter the "Host App" directory, click on "Host App Name ", enter "BundleID", and you can see a new piece of data added, where you can view information such as API Server, SDK Key, and SDK Secret.
# 4.2.4.9 Associated Mini Program
Category Content
Test Number M0009
Test Item FinClip Mini Program Open Platform Management System - Developer Portal
Test Function Binding Mini Programs
Preconditions On the browser, open the FinClip Mini Program Open Platform - "Developer Portal" and log in successfully.
Test steps 1. Enter the "Host-App" directory, click on "Host App Name ", enter "Binding Mini Programs" - "Configure Mini Programs", and a pop-up window for editing the mini program will appear. 2. Check the published mini program, click "Confirm" to complete the mini program association.
Expected Effect Enter the "Host-App" directory, click on "Host App Name ", enter "Binding Mini Programs", and you can see a new piece of data added, and view the list of Binding Mini Programs.
# 4.2.4.10 Integrated SDK
Category Content
Test Number M00010
Test Item FinClip Mini Program Open Platform Management System - FinClip SDK
Test Function Integration of FinClip SDK
Preconditions Owns the host App and has runnable source code.
Test steps 1. Android App Integration :Android Integration Guide 2. iOS App Integration :iOS Integration Guide 3. HarmonyOS App Integration:HarmonyOS Integration Guide 4. Desktop App Integration :PC Integration Guide For more FinClip SDK guides, please refer to :FinClip SDK Documentation Center
Expected Effect App successfully integrated the SDK, and after integration, the code compiled without errors, with processes such as App compilation and packaging passing.
# 4.2.4.11 Initialize the SDK
Category Content
Test Number M0011
Test Item FinClip Mini Program Open Platform Management System - FinClip SDK
Test Function Integration of FinClip SDK
Preconditions App successfully integrated with FinClip SDK
Test steps 1. Android SDK Initialization:Android Initialization Guide 2. iOS SDK Initialization:iOS Initialization Guide 3. HarmonyOS SDK Initialization :HarmonyOS Initialization Guide 4. Desktop SDK Initialization :PC Initialization Guide For more FinClip SDK initialization guides, please refer to :FinClip SDK Documentation Center
Expected Effect FinClip SDK initialization succeeded. Through the API callback information of initializing the SDK, it returns that the initialization was successful.
# 4.2.4.12 Open Mini Program
Category Content
Test Number M0012
Test Item FinClip Mini Program Open Platform Management System - FinClip SDK
Test Function Integration of FinClip SDK
Preconditions 1. Mini Program successfully launched. 2. App integrated with FinClip SDK and initialized successfully. 3. [Optional] Downloaded and logged in to FinClip App
Test steps [Method 1] Open the Mini Program via the Host App 1. Steps to open the Mini Program on Android App:Guide to opening the Mini Program on Android 2. Steps to open the Mini Program on iOS App:Guide to opening the Mini Program on iOS 3. Steps to open the Mini Program on HarmonyOS App:Guide to opening the Mini Program on HarmonyOS 4. Steps to open the Mini Program on Desktop:Guide to opening the Mini Program on PC For more guides on opening the Mini Program with FinClip SDK, please refer to :FinClip SDK Documentation Center [Method 2] Open the Mini Program by scanning the QR code via FinClip App 1. Obtain the Mini Program QR code: Go to 「FinClip Management Console - Developer Portal - Mini Program - Version」 to view the QR code. 2. Open the FinClip App, go to the home page, click the QR code scanning button, and you can open the Mini Program.
Expected Effect Open the Mini Program in the App and preview it

# 5. References

Category Material Name Material Link
Developer Portal Operation Manual Operation Manual (opens new window)
Operation Video Operation Video (opens new window)
FinClip SDK iOS SDK Guide Documentation SDK Guide Documentation (opens new window)
iOS SDK Integration Video SDK Integration Video (opens new window)
Android SDK Guide Documentation SDK Guide Documentation (opens new window)
Android SDK Integration Video SDK Integration Video (opens new window)
Desktop SDK Guide Document SDK Guide Documentation (opens new window)
FinClip Studio Mini Program Development Guide Mini Program Development Guide (opens new window)
User Manual User Manual (opens new window)
Instructional Video Instructional Video (opens new window)
FinClip App Operation Manual Operation Manual (opens new window)
Frequently Asked Questions Frequently Asked Questions Frequently Asked Questions (opens new window)

# 6. Conclusion

Thank you for your experience. Now the POC main process testing of the FinClip Mini Program Management Platform system has been done, and you can continue to conduct functional verification of the FinClip Mini Program Management Platform system.

© FinClip with ❤ , Since 2017