Example: Use a lightweight application template-Application Composition Platform(BizWorks)-阿里云帮助中心

This topic explains how to manually install a lightweight application from a template.

Prerequisites

You have activated the public cloud version of BizWorks.
You have an available template. For information about how to create an application template, see Create and manage lightweight application templates.

Limitations

You can use template files only across different BizWorks tenants or in different projects within the same tenant. Otherwise, the import fails.

Lightweight application template example

A lightweight application helps you visually build low-code front-end applications that connect to middle-end services. The BizWorks team created this sample lightweight application based on an e-commerce management backend. The example introduces you to web application development with BizWorks lightweight applications, covering concepts such as model orchestration, service orchestration, and page orchestration.

Procedure

Step 1: Download the sample template

Download the Light App Template Sample File to your local machine.

Step 2: Install the template

On the Application List page, click Install Application from Template.
In the Install Application from Template dialog box, to install the template by using an Enterprise Application Template, follow these steps. Otherwise, skip this step.
1. In the Install Application from Template dialog box, select Enterprise Application Template and click OK.
2. In the Install from Enterprise Application Template panel, you can click the target enterprise lightweight application template on the Local Templates or Subscribed Templates tab and click Next.
  Important
  Only one template can be installed in a project at a time.
  If you have previously installed an application template in this project, the Install from Enterprise Application Template panel displays a notification:
  - If the previous installation failed, an Installation Failed message appears. Click View to see the failure reason.
  - If the previous installation was successful, an Installation Succeeded message appears with details about the installed application template.
  - If a template is currently being installed, the page displays a message: Installing in the background. You can leave this page and check the result later. Click Finish to exit the installation page.
3. Select a version and click Next.
In the Install Application from Template dialog box, to install the lightweight application template by using Import Template, follow these steps. Otherwise, skip this step.
1. In the Install Application from Template dialog box, select Import Template and click OK.
2. On the Install by Manually Importing Template panel, in the Upload Template File area, click inside the dashed box or drag the template file into it. After the file is uploaded, click Next.
Important
The platform only supports installing lightweight application templates.
The system retains information from the most recently uploaded template file.
After the template file is uploaded, a card for the template appears in the Install by Manually Importing Template panel. This card shows the template name, type (lightweight application), version number, and development status. Click the Basic Information tab to view more details, such as the update time, provider, contact information, and description. After reviewing the information, click Next.
Important
Only one template can be installed in a project at a time.
If you have previously installed an application template in this project, the Install by Manually Importing Template panel displays a notification:
- If the last installation failed, you are prompted with: Installation failed. You can also click Click to view to see the specific reason for the installation failure. If you want to reinstall a new template, you can click Delete. After you delete the old template, re-upload and install the new template. If the last installation failed, you are prompted with a message such as: Application template xxx Installation failed. You can click the Click to view link to see the specific reason for the installation failure.
- If the previous installation was successful, an Installation Succeeded message is displayed at the top of the page. The card for the installed template is shown below, with its basic information, such as name, version number, and status. To install a new template, click Delete to remove the old template, then upload and install a new one.
- If a template is currently being installed, the process goes through three steps: Dependency Configuration, Application Information Check, and Confirm Installation. At the confirmation step, the system installs in the background, and a message appears: "Installing in the background. You can leave this page and check the result later." After the installation is complete, click Finish.
On the Dependency Configuration page of the Install Application from Template wizard, click Next.
Note
The lightweight application in this template has no business domain dependencies, so no configuration is required here.
On the Application Information Check page of the Install Application from Template wizard, review and modify the Information of the Light App to Be Added, including the Light App Name, Application Version, and Description. Then, click Start Installation.
Note
You must review this information carefully, as the system automatically creates a new lightweight application version upon installation.
When you click Start Installation, a three-step process begins: Dependency Configuration, Application Information Check, and Confirm Installation. At the final step, the system installs in the background and a message appears: "Installing in the background. You can leave this page and check the result later." After the installation is complete, click Finish.
- If you are prompted with Installation successful, click Lightweight Application. After the installation is successful, click the Lightweight Application link in the prompt message.
  You are redirected to the overview page of the lightweight application installed from the template. The application code is bizworks-lightapp-template. On this page, you can view basic information such as the application type, owner, current version, and source. You can also see application statistics, including the number of dependent business domains, structure objects, service orchestrations, and page orchestrations. You can perform further actions using the Deploy App, Edit App Properties, App Version Management, and App Member Management buttons in the upper-right corner.
- If an Installation Failed message appears, the system shows the failure reason. Follow the guidance in the message or contact BizWorks technical support for help.
  Note
  After a failed installation, you can try to install the template again in the same project.

Step 3: Template contents

Content	Description
Model Management	The lightweight application includes custom-created structure objects. After you associate a business domain with the lightweight application, you can also reuse structure objects from that business domain. On the Structure Object page of Model Management, the template provides the following pre-built structure objects: Quarterly & Stage PV (`ActionQuaterPV`), Buyer (`Buyer`), Daily Channel Order (`DailyChannelOrder`), Item (`Item`), Login Account (`LoginAccount`), Order (`Order`), and Order Display Info (`OrderDisplayInfo`). You can Edit, Copy, or Delete each structure object.
Service Orchestration	The service orchestration includes pre-built service methods: Service methods in the Workbench Charts group simulate data sources for charts on the workbench page. Service methods in the Order-related Data Sources group simulate data sources related to orders. Service methods in the Login group are called during the user login action. In a real-world scenario, you would retrieve data by using application service methods from a dependent business domain. The groups contain the following service methods: Workbench Charts includes getQuarterActionPV and getWeeklyOdersChannel; Order-related Data Sources includes getBuyerList, getItemList, and getOrderList; Login includes checkPassword, listUserBasicInfo, login, logout, getLoginedUser, and getUserBasicInfo. System methods include addCookie_bw and getCookie_bw. For example, the getLoginedUser service orchestrates a flow that starts by getting a cookie (getCookie_bw). It then uses an exclusive gateway to check if accountName exists. If not, the session has expired. Otherwise, it calls getUserBasicInfo to retrieve user information, then the flow ends.
Page Orchestration	Page orchestration includes five pages built with visual orchestration: Login Page Workbench Order Management Order Registration Order Details You can enter the page designer to view the content of each page, including canvas components, variable management, logic flow, and JavaScript code.
Configure Page Framework	The page framework is pre-configured. It uses left-side navigation with a white background and includes configurations for user information and a user drop-down menu. In the Properties panel of the application framework, the Navigation Configuration section lets you set the navigation layout (Left-side Navigation, Top Navigation, Top + Left-side Navigation), navigation background color (Theme Color, White, Black), and toggle switches for Collapse Navigation by Default, Automatically Load Navigation Menu, and Multi-tab. The User Information Configuration section lets you toggle the display of user information, user name, user avatar source (system file or external link), and image file. The User Information Drop-down Menu section allows you to manage menu items (such as Logout) and add new ones by using the Add Item button.
Menu Management	The menu includes the Workbench and Order Backend groups, which contain the Order Management and Order Details menu items. In the Edit Menu Configuration panel, you can set the Configuration Name (for example, "Operation Management System") and Unique Identifier (for example, `orderMngmtSystem`). The Application Menu Configuration area is divided into two columns: the left column lists available Menu Item options (Order Management, Order Registration, Workbench), and the right column displays the configured menu tree. You can organize menu items into groups by using the Create Group button (for example, the "Order Backend" group contains "Order Registration" and "Order Management").

Step 4: Develop the application

You can customize the application by associating business domains, building additional service methods and pages, and changing the page framework and menu configuration. For more information, see the following topics:

Model management:
- Associate and manage dependent data sources
- Create and manage structure objects
Visually orchestrate service methods
Page management:
- Visually orchestrate pages
- Configure page navigation and frameworks
Extension mechanism:
- Develop and manage custom pages
- Develop and manage custom components
Manage resources

Step 5: Deploy the application

After you finish developing the application, you can deploy it to a cluster and view its running status. After deployment, the sample application functions as follows: The Order Management page includes a filter area to search by Order ID and Item ID, and supports switching between order statuses (All, To be paid, To be shipped, Shipped, Completed, Closed). The table displays columns such as Item ID, Quantity, Discount, Total Price, Buyer Information (masked), Order Status, and Order Time, with a Details link at the end of each row. The application's Workbench page displays an order management dashboard. It includes quick navigation entries (Order Management, Item Management, Promotion Management, and Category Management), a dashboard (a line chart for the order trend in the last 7 days and a transaction funnel chart), a Pending Items section (orders to be shipped, returns to be reviewed, and returns to be received), and a Latest Announcements module.

For more information, see Deploy and manage lightweight applications.