> For the complete documentation index, see [llms.txt](https://asus-isg-aidc.gitbook.io/guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://asus-isg-aidc.gitbook.io/guide/latest/portal/license.md).
# License
| Developer | Last modified |
| --------- | ------------- |
| AIDC Team | 2026/01/27 |
***
## 1. Feature Overview
The License Activation and Management feature allows you to complete system license configuration and management. Through this feature, you can:
* Activate system license during initial installation
* View license status and expiration date
* Add or import new license keys
* Monitor license usage
* Manage multiple licenses (active and expired)
### Usage Flow Overview
```
First-time Use
↓
Login to System
↓
Enter License Activation Page → Enter License Key → Wait for Verification → Activation Success
↓
Start Using System
↓
Ongoing Management: Enter License Management Page → View License Status → Add/Manage Licenses
```
***
## 2. License Activation (First-time Use)
### Page Interface Description
When you first install the system or need to activate a new license, you will enter the License Activation page:
**Main Page Elements:**
* **Progress Bar**: Shows activation flow (Login → Activation → Usage)
* **Title**: Software License Activation
* **Description Text**: Authentication passed, please enter license key to complete activation
* **Input Box**: License Key input field
* **Activation Button**: Submit license key for verification
### Activation Operation Steps
#### Step 1: Prepare License Key
Before starting activation, please confirm you have received the license key:
* License key format: `XXXXX-XXXXX-XXXXX-XXXXX` (4 segments, 5 characters each)
* Please keep the license key safe
#### Step 2: Enter License Key
**Manual Input:**
1. Enter your license key in the "License Key" input box
2. The system will automatically format it for you:
* Automatically convert to uppercase letters
* Automatically remove special characters
* Automatically add hyphen "-" every 5 characters
3. The final format will automatically display as: `XXXXX-XXXXX-XXXXX-XXXXX`
**Direct Paste:**
1. Copy the complete license key from email or document
2. Paste directly in the input box (Ctrl+V or right-click paste)
3. The system will automatically format it to the correct format
4. No need to manually adjust format or case
💡 **Tip:**
* The input box will display format hint: "Format: XXXXX-XXXXX-XXXXX-XXXXX"
* You can enter the key with or without hyphens, the system will handle it automatically
* Case insensitive, the system will automatically convert
#### Step 3: Submit Activation
1. Confirm the entered license key is complete (20 characters total)
2. Click the "Activate License" button
3. The button will become unclickable to prevent duplicate submissions
#### Step 4: Wait for Verification
After submission, the system will start verifying the license:
* Screen displays loading animation
* Text displays "Activating License..."
* Verification process usually takes 10-25 seconds
* System automatically checks if license is successfully activated
💡 **Tip:** Keep network connection during verification, do not close or refresh the page.
#### Step 5: View Results
**Activation Success:**
* Displays green success message: "✓ License activated successfully!"
* Displays "Redirecting to system..."
* Automatically enters system main page after 4 seconds
* Progress bar updates to "Usage" step
**Activation Failed:**
System will display red error messages, common errors include:
| Error Message | Reason | Solution |
| --------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------ |
| Invalid License Key format or license not found | License key format error or does not exist | Check if key is complete and correct, re-enter |
| You do not have permission to activate this license | No activation permission | Contact system administrator to confirm permission |
| This License Key has already been activated | License key already used | Check for duplicate activation, or contact technical support |
| License activation failed: invalid license key, or please check your network connection | Network connection issue or invalid key | Check network connection, confirm key is correct and retry |
| Server error. Please try again later | Server error | Try again later, or contact technical support |
**Retry After Failure:**
1. Read the error message to understand the failure reason
2. Fix the problem (e.g., re-enter correct key)
3. Click "Activate License" button again
4. System will re-execute verification process
***
## 3. License Management
### Enter License Management Page
After successful activation, you can enter the License Management page at any time:
1. Find "License Management" option in the system main menu
2. Click to enter License Management page
3. The page will automatically load and display all license information
### Page Interface Description
The License Management page is divided into three main areas:
#### Area 1: License Status Card
Located at the top of the page, displays the overall status of the main license.
**Card Color Description:**
| Color | Status | Description |
| ---------- | --------------------- | ------------------------------------------------------------------------------ |
| **Green** | License Active | License is normally active, system can be used normally |
| **Yellow** | License Expiring Soon | License expiring soon (60 days or less remaining), need to prepare for renewal |
| **Red** | License Expired | License has expired, system functions may be limited |
**Display Content:**
* License status icon (● dot) and status text
* Days remaining (e.g., "12 days remaining")
* License key (format: XXXXX-XXXXX-...)
* Customer name
#### Area 2: License Category Tabs
**Active (Active Licenses) Tab**
* Displays all unexpired licenses
* Sorted by remaining days, longest expiring first
* Green tab: License normal (more than 60 days remaining)
* Yellow tab: Expiring soon (60 days or less remaining)
**Expired (Expired Licenses) Tab**
* Displays all expired licenses
* Displayed in gray tabs
* For historical record query only
#### Area 3: License Details Card
After clicking any license tab, the complete information of that license will be displayed below:
**License Basic Information**
* License Key: Complete license key
* Active Date: Activation date (e.g., 2023-06-15)
* Expiry Date: Expiration date (e.g., 2024-06-14)
* Days Remaining: Days remaining
**License Usage Status**
* Usage: Current number of nodes used / Total number of nodes allowed by license
* Displays usage percentage progress bar
* Example: "40 / 100 nodes (40%)"
**Warning Alert**
* When license has less than 60 days remaining
* Card will be highlighted with yellow border and background
* Displays "⚠️ Backup License Alert" message
***
## 4. License Management Operations
### View License Status
**View Main License Status:**
1. Enter License Management page
2. Status card at the top displays current main license information
3. Judge license status based on card color:
* Green = Normal
* Yellow = Expiring soon
* Red = Expired
**View All Active Licenses:**
1. "Active" tab is displayed by default
2. List shows all unexpired licenses
3. Click any license tab to view detailed information
**View Expired Licenses:**
1. Click "Expired" tab
2. List shows all expired licenses
3. Displayed in gray, for record query only
### View License Details
1. Find the license you want to view in the license list
2. Click the license tab (displayed as XXXXX-XXXXX)
3. The details card below will update to display:
* Complete license key
* Activation date and expiration date
* Days remaining
* Node usage (used / total)
* Usage percentage progress bar
4. Card color will automatically change based on license status
### Import New License
When you need to add a license (e.g., purchase new license, renewal, expand node capacity):
#### Step 1: Open Import Form
1. Find the "Import License" button at the top of the License Management page
2. Click the button
3. A license key input window will pop up
💡 **Tip:** When a license is about to expire, the page will display a "Reminder" button.
#### Step 2: Enter License Key
In the pop-up input window:
1. Enter the new license key in the "License Key" input box
2. The system will automatically format:
* Automatically convert to uppercase
* Automatically remove special characters
* Automatically add hyphen every 5 characters
* Final format: `XXXXX-XXXXX-XXXXX-XXXXX`
3. Confirm the input is complete (20 characters total, divided into 4 segments)
**Input Methods:**
* Manual input: Type directly in the input box
* Paste key: Copy and paste from email or document, system will automatically format
#### Step 3: Submit for Verification
1. Confirm the license key is complete and correct
2. Click the "Submit" button
3. Submit button will temporarily become unclickable to avoid duplicate submissions
4. System starts verifying the license key
#### Step 4: Wait for Verification
During verification:
* System will display processing status
* Continuously checks if license is successfully activated
* Automatically checks every 2 seconds
* Verification process usually takes 2-25 seconds
* If it takes more than 25 seconds, system will display timeout message
💡 **Tip:** Please keep network connection stable during verification.
#### Step 5: View Results
**Import Success:**
* Displays green success message
* Input window automatically closes
* New license will automatically appear in the "Active" tab list
* If the new license has more remaining days, it may become the new main license
**Import Failed:**
Displays red error messages, common errors:
| Error Type | Possible Cause | Solution |
| ------------------------ | ------------------------------------------------- | ------------------------------------------------------ |
| License key format error | Entered key is incomplete or format incorrect | Check if key is 20 characters, re-enter |
| Invalid license key | Key does not exist or has been revoked | Confirm key source, contact supplier |
| License already used | This key has already been activated in the system | Check for duplicate import, view existing license list |
| Network connection error | Cannot connect to verification server | Check network connection, retry later |
| Verification timeout | Did not complete verification in 25 seconds | Check network speed, try again |
**Retry After Failure:**
1. Read the error message to understand the failure reason
2. Fix the problem
3. Modify or re-enter the key in the input window
4. Click the "Submit" button again
### Check Expiration Warning
When a license is about to expire:
1. License status card will turn yellow
2. Page may display "Reminder" button
3. Click the button to view list of all licenses about to expire
4. Recommend preparing for renewal in time to avoid service interruption
***
## 5. License Status Description
### License Status Types
Licenses in the system will have the following statuses:
| Status | Display Color | Status Text | Description | Recommended Action |
| ----------------- | ------------- | ------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Normal Active** | Green | License Active
XX days remaining
| License is still within valid period, more than 60 days remaining | No action needed, system can be used normally |
| **Expiring Soon** | Yellow | License Expiring Soon
XX days remaining
| License has 60 days or less remaining | Prepare for renewal to avoid service interruption |
| **Expired** | Red | License Expired | License has passed expiration date | Immediately renew or import new license, system functions may be limited |
### Remaining Days Calculation
**Calculation Method:**
* Days remaining = Expiration date - Today's date
* Example: Expiry date 2024-06-14, today 2024-06-02, 12 days remaining
**Display Description:**
* Positive number: e.g., "12 days remaining" = 12 days until expiration
* 0 days: Today is the last day
* Negative number: Expired X days ago
### Node Usage Status
**Usage Rate Display:**
```
Usage: 40 / 100 nodes (40%)
↑ ↑ ↑
Used Total Percentage
```
**Status Description:**
| Usage Rate | Status | Description | Recommendation |
| ---------- | ---------- | --------------------------- | --------------------------------------- |
| 0-50% | Normal use | Sufficient node capacity | No action needed |
| 51-80% | High usage | Approaching license limit | Monitor and consider expansion |
| 81-95% | Near limit | May affect adding new nodes | Recommend purchasing additional license |
| 96-100% | At limit | Cannot add more nodes | Must purchase additional license |
***
## 6. Field Description
### License Key Format
**Standard Format:**
```
XXXXX-XXXXX-XXXXX-XXXXX
↑ ↑ ↑ ↑
Seg 1 Seg 2 Seg 3 Seg 4
```
**Format Rules:**
* Total length: 20 characters (excluding hyphens)
* Segments: 4 segments, 5 characters each
* Hyphens: 3 (used for separation)
* Allowed characters: Uppercase English letters (A-Z) and numbers (0-9)
* Example: `AB34C-D67EF-GH123-45678`
### Date Fields
**Active Date**
* Format: YYYY-MM-DD (e.g., 2023-06-15)
* Description: Date when license was first activated
* Purpose: Record when license started being used
**Expiry Date**
* Format: YYYY-MM-DD (e.g., 2024-06-14)
* Description: Date when license becomes invalid
* Purpose: Determine if license is still valid
**Days Remaining**
* Format: Number (e.g., 12)
* Description: How many days until expiration date
* Calculation: Expiry date - Today's date
### Usage Status Fields
**Node Count**
* Used nodes: Number of nodes currently in use in the system
* Total nodes: Maximum number of nodes allowed by license
* Example: "40 / 100" means 40 used out of 100 available
**Usage Percentage**
* Calculation: (Used nodes ÷ Total nodes) × 100%
* Display: Numeric percentage + progress bar
* Example: 40%, progress bar shows 40% filled
***
## 7. Frequently Asked Questions
### License Activation Related
**Q1: How to activate the system during initial installation?**
A: Follow these steps:
1. After logging in, you will automatically enter the License Activation page
2. Enter the license key you received (format: XXXXX-XXXXX-XXXXX-XXXXX)
3. Click the "Activate License" button
4. Wait 10-25 seconds for verification to complete
5. After success, you will automatically enter the system
**Q2: Where to obtain the license key?**
A: License keys are usually provided in the following places:
* Confirmation email received after purchase
* License certificate document
* License document provided by supplier If you cannot find it, please contact the supplier or sales representative.
**Q3: What to pay attention to when entering the license key?**
A: Don't worry too much about format issues:
* System will automatically convert case (all become uppercase)
* Automatically remove special characters
* Automatically add hyphen separators
* You can directly copy and paste, no need to manually adjust format
**Q4: What to do if license activation fails?**
A: Handle based on error message:
* Check if license key is complete (should be 20 characters)
* Confirm network connection is normal
* Check if already activated key is being used repeatedly
* If it continues to fail, please contact technical support
**Q5: How long does license verification take?**
A: Usually takes 10-25 seconds:
* System automatically checks if license is successfully activated
* Checks every 10 seconds
* Will display timeout message if exceeds 25 seconds
* Please keep network connection stable
### License Management Related
**Q6: How to know when license is about to expire?**
A: System will automatically remind:
* When 60 days or less remaining, license card and tab turn yellow
* Page may display "Reminder" button at the top
* Main license status card will display "License Expiring Soon"
* Recommend renewing at least 30 days before expiration
**Q7: How to add a license?**
A: Through the "Import License" feature:
1. Enter License Management page
2. Click "Import License" button
3. Enter new license key
4. Click submit, wait for verification (about 2-25 seconds)
5. After success, new license will appear in the list
**Q8: Can I have multiple licenses at the same time?**
A: Yes, the system supports multiple licenses:
* View all active licenses in the "Active" tab
* View expired licenses in the "Expired" tab
* Click different license tabs to view their respective detailed information
* System will automatically use the license with the longest remaining days as the main license
**Q9: What to do if license import fails?**
A: Troubleshoot with the following steps:
1. Confirm license key format is correct (XXXXX-XXXXX-XXXXX-XXXXX)
2. Check if network connection is normal
3. Confirm key has not been used repeatedly
4. Check if it is a valid license key
5. If it continues to fail, please contact technical support and provide error message
**Q10: How to view license usage?**
A: In the license details card:
1. Click any license tab
2. Card below displays "Usage" field
3. Display format: Used nodes / Total nodes (percentage)
4. Progress bar visualizes usage percentage
***
## 8. Important Reminders
### License Activation Precautions
**First Activation:**
* Please confirm license key source is correct and trustworthy
* Keep network connection stable during activation
* Do not close or refresh the page
* Keep license key safe to avoid leakage
**Network Requirements:**
* Activation and license import require network connection
* Ensure ability to connect to verification server
* Recommend operating in a stable network environment
### License Management Recommendations
**Regular Checks:**
* Recommend checking license status at least once a month
* Pay attention to expiration date and remaining days
* Monitor node usage rate
* Handle licenses about to expire in time
**Renewal Planning:**
* Start preparing for renewal at least 30 days before license expiration
* System will start displaying expiration reminders 60 days in advance
* Plan ahead to avoid service interruption
* Keep old license records for reference
### Security Precautions
**License Key Protection:**
* Keep all license keys safe
* Do not share with unauthorized personnel
* Recommend creating license management documentation
* Regularly backup license information
***