CN108363760A - IETM display datas based on B/S models generate and Off-line control method - Google Patents

Abstract

The invention discloses a B/S model-based IETM display data generation and off-line control method, comprising the following steps: 1) an administrator enters data through a form with verification rules according to the information type; 2) the data is sent to the background server through 3) Obtain data information through query when users need information, and determine the local cache resources that need to be downloaded offline according to the information type; 4) Dynamically generate a manifest file to control the offline local cache; 5) Convert the obtained information Fill in the JSON format directly into the pre-customized ejs template to generate an HTML5 file; 6) Send the HTML5 file and the manifest file to the requesting client. Compared with the mainstream XML data converted into HTML data modules by adding XSL documents, the method of HTML5 files generated by the template makes the workload of publishing data writing smaller, and realizes offline access at the same time, solving the problem of no network under the B/S model A defect in which the connection cannot be used.

Description

IETM Display Data Generation and Offline Control Method Based on B/S Model

technical field

The invention relates to an interactive electronic manual technology, in particular to a browser/server (B/S) model-based interactive electronic manual display data module generation and off-line access control method.

Background technique

Interactive electronic manual, referred to as IETM (interactive electronic technical manual), is an electronic deliverable that has been born to solve the problem of basic-level maintenance of products in recent years. It uses computer multimedia, database and network technologies to convert complex operation manuals into , Maintenance manuals and other information are organically organized and managed, and various information forms such as text, tables, images, engineering graphics, sounds, videos, animations, etc. are displayed on the electronic screen in an optimized manner.

The main standards of IETM include the MIL-HDBK-511 standard issued by the US military in May 2000, the S1000D standard in Europe, and the GB/T 24463IETM series released in October 2009 as the domestic standard. Among them, the European S1000D standard is highly respected by major organizations in the world because of its extensive support and perfect maintenance system. The IETM standard in my country is also customized with reference to this standard. According to the domestic GB/T24463.1-2009 standard, there are four recommended IETM interoperability structures, namely C1 type: basic HTML/XML page; C2 type: simple downloadable components; S1 type: HTML+ application server ;S2 type: HTML+database server.

The IETM platform currently used by most of the military adopts a dedicated client, that is, a client/server (C/S) model. This model has higher security and can realize offline access and online update functions, but the installation cost and use cost are relatively high. For civilian equipment, in order to reduce the use cost and development cost, a browser/server (B/S) model can be adopted. At the same time, the use of a common browser can greatly reduce the user's learning costs. Under the B/S model, data display methods are currently divided into two modes:

One is a common XML data format, by adding XSL files, the data can be converted into HTML format, and then displayed on the browser. This form can generate unified XML format data after processing the information exported from the database, and then customize the XSL file in advance. In this way, the XML format and XSL format can be customized in advance, and the information can be divided into general structural information, graphical component information, descriptive information, procedural information, fault information, maintenance plan information, wiring information, personnel information, etc., and only It is necessary to customize the input template at the time of input, and then you can obtain the XML format of a certain format, and then match it with the XSL format of the corresponding information type. Because the XML format can be controlled by the information in the database, you only need to write a specific type of XSL document. Dramatically reduces the writing of display format data. However, the HTML generated in this way cannot use the new technology of HTML5 - offline application technology, and cannot perform offline local cache of data, and cannot be used when there is no Internet.

The other is to store each information content in the database, and then write the corresponding HTML file for each page after being retrieved by the background server. This form has better interactivity. Then the offline caching principle can be customized for the entire application to achieve offline access (no one has been found to implement it yet). But this kind of implementation needs to write HTML files and manifest files for each information page, and the workload is huge.

Contents of the invention

Purpose of the invention: In order to overcome the exchanging of data in XML data format in the prior art, offline access cannot be realized under the architecture of the B/S model, but exchanging and displaying data in HTML data format will lead to the need for each The page is written in HTML format, which increases the cost of system writing, and provides a B/S model-based IETM display data generation and offline access control method.

Technical solution: In order to achieve the above object, the present invention provides a B/S model-based IETM display data generation and offline access control method, including the following steps:

1) The administrator enters data through a form with verification rules according to the type of information;

2) The data is sent to the background server and inserted into the database after processing;

3) Obtain data information through query when the user needs information, and determine the local cache resources that need to be downloaded offline according to the type of information;

4) Dynamically generate the manifest file to control the offline local cache;

5) Convert the obtained information into JSON format and directly fill it into the pre-customized ejs template to generate HTML5 files;

6) Send the HTML5 file and the manifest file to the requesting client.

Further, the type of information of the database and the type of the interface in the step 2) need to be designed in advance, and then the template of the interface is written, and different ejs templates are written according to different information types, and the obtained information is filled into different templates to form an access Connection, the information types of the database are divided into: general structure information, diagram parts information, descriptive information, procedural information, fault information, maintenance plan information, wiring information, personnel information, etc. according to types.

Further, the HTML5 interface in the system can be cached offline. When the user visits for the first time, the background server will determine the resources to be cached offline and locally according to the obtained information, and dynamically generate a manifest file. When the user visits for the second time The manifest file will control the behavior of the user's browser, so that when accessing the system without the Internet, the offline data inside the browser will be used. At the same time, the background server system can control whether to regenerate the manifest file according to the update flag. When there is a change between the newly generated manifest file and the old manifest file on the browser side, the browser will perform local cache again.

Further, according to the type of information requested by the user, the information is taken out from the database and filled into different information templates, and in the process, according to the acquired information, it is determined that the resources that need to be cached offline and locally on the client side are dynamically generated to control the offline cache manifest file.

Further, the various data information is exported in the form of XML in the database, and after being processed, it becomes a common XML data format, so as to ensure that data can be exchanged with other IETM systems.

The modules mainly included in the system of the present invention include a data entry interface (web page form), a background server, a database server, and a data display module (browser).

The data entry interface needs to write verification rules and determine the data type, and the data type is divided into general structural information, graphical component information, descriptive information, procedural information, fault information, maintenance plan information, wiring information, personnel information, etc., so that Restrict the format of entered data.

After the input is completed, it is submitted to the background application server, and the application server processes the data and adds the information to the data table of the corresponding database according to the data type.

After receiving the data, the database server stores the data in the respective corresponding data tables. At the same time, the database provides the function of exporting the data as XML data. The XML data directly exported from the table can be used as a standard middle-level data after being processed by the background server system. It can exchange data with other IETM systems, but this method will not be used in this system.

When user A requests data a for the first time, the background application server fetches the data from the database server according to the requested data type. Since the data type is already known, it knows which resources need to be cached offline locally (for example, graphic component information, it is necessary to cache component drawings, 3D model resources, etc. locally). Write these resources that require local caching into the manifest file that controls offline local caching. Then convert the data information into JSON format, fill in the corresponding ejs template file to generate HTML5 file. Then send the HTML5 file to the requesting user. After receiving the HTML5 file, the user's browser finds a manifest link, then requests the manifest file from the server, and downloads the offline local cached file according to the command after obtaining the manifest.

When user B requests data a, the background server still checks whether there is a manifest file first, and then checks the update flag after finding the manifest file (the update flag is set by the administrator user), and returns the HTML5 file directly if no update is required. If you need to update, open the manifest file corresponding to this HTML5 file in the form of "w+" ("w+" means that if there is such a file, it will be overwritten and rewritten; if there is no such file, it will be created and modified), and rewriting needs Offline locally cached resources, and then send the HTML5 file to the user, so that the file that controls the offline local cache has been updated.

If user A accesses data a again at this time, the browser first reads the resource display in the local cache, and then obtains the manifest file on the server, and finds that the manifest file has been updated, then user A's browser needs to download this page offline and local cache again Resources, so that the update of the offline application is realized.

At the same time, this implementation method is to cache a page offline and locally every time the user visits a page, which will not affect the user's use, and also reduce the offline download of unnecessary resources.

Beneficial effects: Compared with the prior art, the present invention can control the format of data exported from the database table by adopting the agreed data entry format and data storage format, so that it can maintain standard compatibility with other systems, It is also possible to directly fill in the ejs template inside the system. Through the agreed rules of information entry, the information can be filled in the pre-customized ejs template instead of writing HTML5 files for each information, which greatly reduces the writing time of display data, and at the same time When filling in detailed information for each file, the specific content of each information will be obtained, so as to determine the content of each file that needs to be cached offline, so that the entire page will be saved offline to the offline data of the browser. It can not only reduce traffic consumption when accessing, but also access information when there is no network connection, realize offline access, and solve the defect that the B/S model cannot be used without network connection.

Description of drawings

Fig. 1 is the schematic diagram of overall system;

Figure 2 is a flow chart of processing the manifest file after the background server receives the browser request;

Fig. 3 is a schematic diagram of the input interface;

Figure 4 is a general data module structure diagram.

Detailed ways

As shown in Figure 1, the present invention provides a kind of IETM display data generation and off-line access control method based on B/S model, comprises the following steps:

1) The administrator enters data through a form with verification rules according to the type of information;

2) The data is sent to the background server and inserted into the database after processing: the information types of the database and the types of the interface need to be designed in advance, and then the template of the interface is written, and different HTML5 templates are written according to different information types, and the obtained information is filled into different templates , forming an access connection, the information types of the database are divided into: general structure information, graphic parts information, descriptive information, procedural information, fault information, maintenance plan information, wiring information, personnel information, etc. according to types;

3) Obtain data information through query when the user needs information, and determine the local cache resources that need to be downloaded offline according to the type of information;

4) Dynamically generate a manifest file to control offline local caching: the HTML interface in the system can be cached offline. When the user visits for the first time, the background server will determine the resources to be cached offline and locally according to the obtained information, and dynamically generate the manifest file. , when the user visits for the second time, the manifest file will control the behavior of the user's browser, so that the offline data inside the browser will be used when accessing the system without the Internet, and the background server system can be controlled according to the update flag Do you need to regenerate the manifest file? When the newly generated manifest file changes with the old manifest file on the browser side, the browser will re-do the local cache;

5) Convert the obtained information into JSON format and directly fill it into the pre-customized ejs template to generate HTML5 files;

6) Send the HTML5 file and the manifest file to the requesting client.

When user A requests data a for the first time, the background application server fetches the data from the database server according to the requested data type. Since the data type is already known, it knows which resources need to be cached offline locally (for example, graphic component information, it is necessary to cache component drawings, 3D model resources, etc. locally). Write these resources that require local caching into the manifest file that controls offline local caching. Then convert the data information into JSON format, fill in the corresponding ejs template file to generate HTML5 file. Then send the HTML5 file to the requesting user. After receiving the HTML5 file, the user's browser finds a manifest link, then requests the manifest file from the server, and downloads the offline local cached file according to the command after obtaining the manifest.

When user B requests data a, the background server still checks whether there is a manifest file first, and then checks the update flag after finding the manifest file (the update flag is set by the administrator user), and returns the HTML5 file directly if no update is required. If you need to update, open the manifest file corresponding to this HTML5 file in the form of "w+" ("w+" means that if there is such a file, it will be overwritten and rewritten; if there is no such file, it will be created and modified), and rewriting needs Offline locally cached resources, and then send the HTML5 file to the user, so that the file that controls the offline local cache has been updated.

If user A accesses data a again at this time, the browser first reads the resource display in the local cache, and then obtains the manifest file on the server, and finds that the manifest file has been updated, then user A's browser needs to download this page offline and local cache again Resources, so that the update of the offline application is realized.

The following describes in detail how to reduce the writing of HTML templates and realize offline caching in the aspect of generating display data with reference to the accompanying drawings.

The database used in this embodiment is mysql, and the background server is built using the express framework of nodejs.

As shown in Figure 4, first write the general information structure of the part information, according to the recommendation of GB/T 24463IETM, the general data module structure, according to Figure 4, write the part information input interface as shown in Figure 3 below, and input the information through Figure 3 The verification makes the input information conform to the rules, the information enters the background server, and the background server fills the data into the database after processing. The background processing program includes storing the picture in the corresponding folder and storing the path of the picture in the database.

When the user clicks on the page to obtain the corresponding part information, the background server judges the type of information obtained according to the path of HTTP. The path of the information of the part type is /parts/part_name as an example. When the path is obtained in the background, it will be based on The process shown in Figure 2 handles and controls the manifest file downloaded offline. The specific process is as follows:

(1) Perform database query according to the part_name background server, and convert the query result into JSON data format;

(2) Determine whether there is a control manifest file for offline caching, if not, generate a manifest file, open the file with the "w+" sign in the specified folder of the system, the "w+" sign indicates that if there is no file, create a file, if If so, overwrite the original file;

(3) After opening the manifest file, you need to know which of the resources returned from the database are pictures and video files, because the pictures and videos that need to be downloaded offline for each HTML5 file are not certain, because the format of the input data is controlled in advance , so the resources to be included in the manifest file can be known according to different information types, and the resources to be downloaded offline can be dynamically written for each manifest file according to the information.

(4) If the manifest file already exists, update the manifest file by judging whether it needs to be updated according to the system logo, and finally get the required target manifest file. The offline resources in the browser can be controlled through the manifest file, even if Deleting the browser cache will not affect offline files.

After the offline download control file is generated, the HTML template is generated. This method uses the syntax of the ejs template to write a template for each file, and fills in the data in JSON format when the background server renders the ejs part template. The following code is the ejs template that generates the HTML format data of the part:

The essence of the present invention is to classify information in advance, and determine the specific content to be contained in each type of information, and then control the input format of each type of information, so that multimedia resources such as pictures that need to be downloaded offline can be determined when generating display data. Then dynamically generate the manifest file to control the files that need to be cached offline and locally. After the manifest file is generated, fill in the information into the pre-written ejs template file, and the background server compiles the ejs template file to generate an HTML5 file and sends it to the browser, so that users can access data offline after the first visit At the same time, because the HTML5 file is generated by the pre-written ejs template, the writing of publishing data can be greatly reduced. In general, the present invention dynamically generates a manifest file for each HTML5 file while using a template to generate HTML5 release data, improves the efficiency of release data generation, improves user experience, and realizes offline access under the B/S model.

Claims (5)

1. the IETM display datas based on B/S models generate and offline access control method, it is characterised in that：Including walking as follows Suddenly：

1) administrator passes through the list logging data of tape verifying rule according to information type；

2) data are sent to background server and are inserted into database by processing；

3) data information is got by inquiry when user needs information, the sheet for needing to download offline is determined according to information type Ground cache resources；

4) the offline local cache of dynamic generation manifest document controls；

5) information got is converted to JSON formats and is directly filled into generation HTML5 texts in the ejs templates customized in advance Part；

6) HTML5 files and manifest files are sent to the client of request together.

2. the IETM display datas according to claim 1 based on B/S models generate and offline access control method, special Sign is：The information category of database and the type at interface need designed in advance in the step 2), then write the mould at interface Plate writes different ejs templates according to different information types, and the information of acquisition is inserted to different templates, forms the company of access It connects.

3. the IETM display datas according to claim 2 based on B/S models generate and offline access control method, special Sign is：The information category of the database is respectively divided into according to type：Universal architecture information, diagram components information, description Property information, procedural information, fault message, maintenance project information, wiring information, personal information.

4. the IETM display datas according to claim 1 based on B/S models generate and offline access control method, special Sign is：The interfaces HTML5 in the system can carry out offline cache, when user is in first time access, background server It can determine that the resource for wanting offline local cache, dynamic generation manifest files are visited for second as user according to the information of acquisition Manifest files can control the behavior of user browser when asking so that access system in the case of no Internet When can use offline data inside browser, while background server system can be controlled whether according to update mark It needs to regenerate manifest files, when the old manifest files of newly-generated manifest files and browser end have change When change, browser will re-start local cache.

5. the IETM display datas according to claim 2 based on B/S models generate and offline access control method, special Sign is：Information is inserted from taking-up in database in different information models according to the type of user request information, and herein Determine that it needs in client the resource of offline local cache according to the information of acquirement in the process, then dynamic generation control is offline The manifest files of caching.