Technical documentation. Purpose of the programmer's manual What category of documentation does the programmer's manual belong to?

Goals and objectives

The programmer's guide is developed in three cases:

the software product, by its main purpose, is a development environment or library (like Delphi or Qt);
a complex or software product serves as a platform for developing programs or systems of a certain type (like 1C or Axapta);
the program is distributed along with source code or is constantly modified by the developers themselves.

You can certainly imagine other situations (for example, a software product is an operating system), but in life they are much less common.

The obvious task of the programmer's management is to provide the developer with information that will be enough for him to create his own programs or systems based on our software product. Another motive for creating such a document is the need for developers to record the state of the product from time to time, so as not to get confused in it and not to produce carriers of “sacred knowledge” in the team.

The programmer's manual should explain:

How the “world” into which the developer is immersed works. What objects the programmer deals with, where they are located, how long they exist and how they interact with each other. Which of them does he create himself, and which are provided to him initially by the environment, framework, library.
What other development tools (besides our software product) are needed to create an application or system? For example, if our software product is a library, then the programmer will need a compiler (possibly quite specific), some kind of development environment and other tools.
In what environment does the application or system operate? What will be his minimum requirements to the system? Will you need any additional software to run it: frameworks, runtimes, interpreters.
What constitutes a Minimum Operable Application or a Minimum Operable System. What objects need to be created in what sequence, and how to connect them to each other so that the application displays at least “Hello World”. True, there are applications that do not display text at all, but control a blast furnace or traffic on networks, but they still necessarily have some kind of minimal output.
How to (step by step) compile a working application or deploy a working system.

These are basic questions, without answers to which a programmer will not be able to work normally. If they are not communicated to him explicitly, he will be forced to do research. But there are many more additional ones: debugging methods and techniques, programming style, etc.

In addition to theory, the programmer's manual must contain complete descriptions of all objects provided in the software product. If these are functions, then their synopses should be given, if they are classes, then descriptions of their interfaces, etc.

If a software product involves the use of an original programming language and is equipped with its own compiler or interpreter, a description of it must be included in the programmer's manual. However, if it turns out to be quite voluminous, it is put into a separate document, which is called: description of the language (programming).

Methodology and style of presentation

The most important methodological requirements for the theoretical part of the programmer's manual are logic and consistency of presentation. In particular, the following rules must be observed in the text:

When introducing a new concept, we rely only on those concepts that were previously introduced explicitly or are considered obviously familiar to the reader. Just like in a math textbook.
The reader should never have the feeling that the author is creating entities unnecessarily. The introduction of each concept must be justified in some way.

The main requirement when describing individual objects is the completeness of the description of each of them. Unlike the user's manual, when compiling which you can, in principle, count on the ingenuity of the reader, who will look at the interface and figure it out himself, the programmer's manual describes very non-obvious things. And although the programmer can be expected to be more insightful than the user, he will have to make up for the lack of information by analyzing the source text, and if it is available, then by testing the “black box” and a debugger. This is a much longer process than wandering through menus and dialog boxes.

When describing objects, special attention should be paid to the following aspects:

What must necessarily precede the creation and use of an object.
What are the side effects of accessing the object.
Features of the object’s interpretation of the data transmitted to it.
Where “physically” (in which file, in which library) is the object located.

It is advisable to provide examples of use for each object, small code fragments demonstrating:

creating an object (if it needs to be created before using it);
passing input data to the object;
obtaining output data and interpreting it.

Descriptions of objects can be placed in a separate volume or document called “Programmer’s Handbook”. A good idea is to make it hypertext.

Between the theoretical part and the reference book on objects, it is useful to place a small section in which an example of a small, but complete, from the point of view of the platform used, application is considered. The example should be such that the reader can independently reproduce, debug and run this application. Obviously, to do this, all this must first be done by one of the authors of the programmer's manual.

Typical structure

The structure of the programmer's manual, fixed in GOST 19.504-79, is as follows:

Purpose and conditions of use of the program.
Characteristics of the program.
Access to the program.
Input and output data.
Messages.

Impression of usefulness modern conditions such a structure does not produce. Rather, a separate object, say a function or class, can be described using this plan. We will not undertake to create a standard structure of a programmer’s manual for all occasions. Most likely, it will turn out to be superficial and equally of little use. Instead, here are two example structures:

Peculiarities

A complete programmer's guide can only be written by an author who has his own experience in professional program development.

The programmer's manual can be completed with various diagrams, for example, database diagrams, class diagrams, function call graphs (see example).

Examples

APK "Nostradamus". Programmer's Guide

The analytical software package "Nostradamus" is designed for creating analytical and reporting banking systems. It contains a set of specialized components from which the developer constructs the application in visual environment. If necessary, the program code can be written in Pascal (therefore, a description of the programming language is not required). The software package was developed by ProgramBank, and technical documentation by Philosoft by her order. In addition to the programmer's manual, the documentation set includes a comprehensive reference book on all components of the agro-industrial complex.

1. General information 1.1. Abbreviations 1.2. Purpose 1.3. Functionality 1.4. Terms of use 1.5. Requirements for developer qualifications 2. Application solution and its components 2.1. Architecture of the agro-industrial complex "Nostradamus". Concept of an applied solution 2.2. Requirements for the application solution 2.2.1. Basic requirements 2.2.2. Requirements for input data 2.2.3. Requirements for data calculation algorithms 2.2.4. Requirements for reports and the set of each of them 2.2.5. Requirements for access control and information security 2.3. Application solution components 2.3.1. Database structure 2.3.2. Loading source data 2.3.3. Organization of the user interface 2.3.4. User's work with data 2.3.5. Data processing and calculation 2.3.6. Data display 2.3.7. Tools for automatic loading and processing of data. System Agent 2.4. Differentiation of access rights in an application solution 2.4.1. User roles 2.4.2. User profiles 2.5. Life cycle applied solution 3. Example of application solution 3.1. Formulation of the problem. Determination of requirements for an application solution 3.2. Design of an application solution 3.2.1. Designing table structure and data loading procedures 3.2.2. User interface design 3.2.3. Design of calculation procedures and reports 3.3. Implementation of an application solution 3.3.1. Authorization in APK "Nostradamus" 3.3.2. Creation of a solution category 3.3.3. Creating tables 3.3.4. Creating data loading procedures 3.3.5. Creation of directories and visual forms for them 3.3.6. Creating calculation procedures in the language of stored database procedures 3.3.7. Creating reports 3.3.8. Creating user groups and creating a main menu for them 3.3.9. Creating a Procedure automatic update(downloading) data using the system agent 3.4. Deployment of an application solution 3.5. Testing the application solution 3.6. Complicating the problem 3.7. Finalization of the application solution 3.7.1. Creating an interactive report 3.7.2. Creating an interactive download 3.7.3. The final stage of making improvements to the application solution

e-port system dealer. Client-server protocol

The “e-port dealer” system is designed to accept and process instant payments when paying for services mobile communications, Internet access, etc. The central server of the system belongs to the e-port group, and anyone can open the payment acceptance point by installing a client program on their computer (connected to the Internet). Data exchange between the central server and the client program is carried out using a special protocol. The protocol is open, which allows various organizations: banks, retail chains, payment terminal networks, to make payments directly from their own systems. The protocol was developed by the e-port Group, and technical documentation by Philosoft by her order.

Introduction i. e-port dealer system: client-server protocol. Purpose and overview of capabilities ii. Protocol Objectives iii. Main advantages of using the protocol 1. Protocol implementation (gateway) 1.1. General information 1.2. Application structure 2. How the gateway works 2.1. Registration and reporting 2.1.1. Registration 2.1.2. Reporting 2.2. Data exchange with the server 2.2.1. Package structure 2.2.2. Directories 2.2.3. Packet exchange procedure 2.3. Operation processing cycle 2.3.1. Operation request 2.3.2. Queue 2.3.3. Analysis of the server response 2.3.4. Non-standard situations 3. Protocol specification 3.1. Structural elements of the package 3.2. Request header 3.3. Response header 3.4. Account replenishment 3.5. Purchasing a PIN code 3.6. Interrupting the transaction processing process 3.7. Transactional properties of the operation 3.8. Request for multiple operations 3.9. Handbook 3.10. Operation status 3.10.1. Examples of messages about the status of operations 3.10.2. Status codes for pending or completed transactions 3.11. System notifications 4. Glossary Applications Appendix 1. XML request DTD and comment XML request DTD Comment Appendix 2. XML response DTD Appendix 3. Rules for calculating sum fields Appendix 4. Examples of server requests and responses

Software and hardware
water level blocking and protection

Programmer's Guide
Controller program structure

ANNOTATION

This document describes the purpose, conditions of use and characteristics of the application software (ASW) of a programmable logic controller (PLC). Applied software industrial computer(PC) is described in the Operator's Manual. Links to PC software are provided throughout this document as needed.

CONTENT
1. PURPOSE AND CONDITIONS OF USING THE PROGRAM
1.1.Purpose of software PLC
1.2.Conditions for using PPO PLC
2. PROGRAM CHARACTERISTICS
2.1. PPO PLC structure

2.3. Custom function blocks used in Unity software
3. ACCESS TO THE PROGRAM
4. INPUT AND OUTPUT DATA
5. MESSAGES

1. PURPOSE AND CONDITIONS OF USING THE PROGRAM
PTS of blocking and water level protection in steam generators of power units No. 1, 2 of the Power Plant is designed to protect the pipe system of steam generators when the water level decreases, as well as to protect the system from the influx of feed water into the flow part of the turbine when the level in the steam generator is increased.
Protection of the technological process is provided by a complex of technological equipment:
Fittings on the main feed water line (VP-9);
Fittings on the main feed water line (VP-10);
Fittings on the purge line (U5-01);
Fittings on the purge line (U5-02);
Fittings on the feed water bypass line (VP11);
Commands to turn on the emergency booster electric pump (APEN-1);
Commands to turn on the emergency booster electric pump (APEN-2);
Turbogenerator shutdown command (TG3);
Turbogenerator shutdown command (TG4);
Issuance of process alarms when the level decreases in 4 out of 6 steam generators
Issuing a process alarm for protection activation at +300mm
Command to turn off the power regulator on the purge line +75mm
Command to turn off the power regulator on the 500 ton purge line
Issuance of process alarms at +125mm
Issuance of process alarms at +75mm
Issuance of process alarms ±50mm
Issuance of process alarms at -120mm
Issuance of process alarms at 500t/hour

The functioning of the system is ensured by application software (ASW).
The software includes industrial computer application software (PC software) and programmable controller application software (PLC software).

1.1. Purpose of PPO PLC
PPO PLC as part of the PTS implements the following functions:
– redundancy of controllers;
– receiving and processing I/O signals from three identical I/O baskets;
– Receives and filters input discrete signals from possible “bouncing” contacts.
– Receives and processes input analog signals:
provides control over whether the signal exceeds the permissible limits (signal unreliability);
scales the analog signal;
carries out hysteresis of threshold values;
analyzes the states of three signals from the baskets and selects reliable values;
filters the signal based on the rate of increase or decrease of the signal value.
– Issuance of discrete signals to equipment (triggering of protection);
– Monitoring deviations of parameters from assignments and achievement of set values;
– Issuance of executive actions on process alarm lamps in the control room;
– Implementation of protection and blocking algorithms;
– Data exchange with adjacent systems via Modbus/TCP/IP channel;
– Checking the controller modules for errors, and generating messages for the workstation about the state of the controller equipment, as well as to the control room panel;
– Monitoring emergency situations of system equipment;
– PPO PLC provides the ability to receive keys from the industrial computer, as well as from the control room panel, that disable certain protections and system interlocks.

1.2. Conditions for using PPO PLC
The general architecture of the system is shown in Figure 1.

Figure 1. General software architecture

The PTS complex includes the following hardware and purchased software components:
1) Two programmable logic controller(PLC) QUANTUM based on P266 CPU processor operating in hot standby mode. Runtime environment Unity Pro 4.1 XL.
2) Industrial computer consisting of:
– personal computer (embedded industrial computer);
– operating room Windows system XP Pro SP3;
– CITECT 7 visualization package
PLCs interact with external subsystems via Ethernet networks(from the PLC side) and via input/output channels.
The interaction between the PLC and the industrial computer is carried out via an Ethernet network.
The PTS includes application software components developed in accordance with this project:
Unity Pro application installed on the PLC.
Citect application installed on PC.

2. PROGRAM CHARACTERISTICS
2.1. PPO PLC structure
The PLC application software is implemented as an application (see Figure 1) written in the Unity v.4.1 environment. The name of the application is upg.stu.
The upg.stu application provides the implementation of system functionality implemented on the PLC for all operating modes.
Application contains:
hardware configuration and software;
a set of functional modules, each of which is implemented in sections written in LD (ladder diagram) language;
a set of functional blocks developed within the project;
database;
animation tables.
The application includes the following functional modules, each of which contains one or more software modules shown in Table 1.
Table 1

Init The section is executed during the first cycle after startup and ensures that all parameters are assigned initial values.
AI_to_AM Section for processing input analog signals. The appropriate signal block is called to assign a value to an internal variable and check the validity of the channel.
DI_to_DM Section for processing input discrete variables. The corresponding signal function block is called to assign a value to the internal variable and check the validity of the channel.
Comparing Section for comparing the received values from three different distributed I/O baskets. Signals are compared using 2 out of 3 logic. If two signals are identical and the third is different, then the latter is considered invalid.
Section name Functionality
Alarms Section for processing discrete and analog signals to determine whether limit values have been reached. Development of alarms and commands for the execution of blocking and protection.
INTERLOCK Section for generating the blocking and protection algorithm. In this section, records are made to variables associated with actuators.
SIM Section for controlling simulation and testing modes of the controller.
DIAGNOSTIC Section for generating controller diagnostic information.

The following subroutines are used within sections:
table 2
Section name Functionality
CompAI A functional block designed to compare three different analog values, output the resulting value, as well as diagnostic information for each channel.
CompDI A functional block designed to compare three discrete signals coming from three different baskets, output the resulting value, as well as diagnostic information for each channel.
BlockF Functional block designed to record an unacceptably rapid drop or gain of an analog value. In the event of a break or short circuit This FB will remove this signal from processing, which will not allow stopping the technological process.
GetDI A functional block designed to receive and process discrete signals. Filters out contact bounce.

Section name Functionality
HLLA4 Functional block designed to generate four threshold violations from one analog signal (HH, H, L, LL). The FB takes into account the parameters of hysteresis and dead zone for recording violations.
GetAI A functional block designed to receive and process analog signals. Performs value scaling and also performs partial smoothing functions.
SIMPMEHA Function block designed to generate sinusoidal interference. This noise is “mixed” into the simulated signal to add realism when working with modes such as “test”.
SIMPULSE A functional block designed to issue pulses of a given duration in the system.
SIMPV A function block designed to simulate an analog value when working with modes such as “probe”.
2.2. Data structures of software PLC
In total, each energy block contains six steam generators and the software elements of the software are made identically for each of them.
The controller software project uses the following data types:
Analog channel status word – word type;
Discrete channel status word – word type;
The word defining the value of the analog channel is the real type (two word words);
The status word of the QUANTUM controller is of word type (two words are reserved in total);
Violation status word – word type;
Lock status word – word type;
Unblocking key status word – word type;

An industrial computer allows control actions only on unlocking keys by changing the state of the bits through a control word. The PLC communicates its status via the status word. A description of individual fields (bits) of data words is given in the Programmer's Guide.

Variables in the PLC are coded as follows:
AI – analog input to the PLC;
AIM – internal analog input of PLC/PC;
DI – discrete input to the PLC;
DM – internal discrete input of PLC/PC;

2.3. Custom function blocks used in Unity software
2.3.1 CompAI Analog Channel Comparison Function Block

Figure 2. CompAI Analog Channel Comparison Function Block

This FB is used to compare three different analog values. If one of the analog parameters falls outside the average value of the other two, then its value is not taken into account and an error message is written to the property of this channel. If all three channels are healthy (are within an acceptable mismatch tolerance), then the resulting value will be the larger of the existing values.

2.3.2 CompDI analog channel comparison function block

Figure 3. CompDI discrete channel comparison function block

This FB is used to compare three pairs of discrete signals. If two values in a pair of signals are the same, this will indicate an open or short circuit. In this case, this pair is not taken into account and is removed from circulation. The system displays a message about the nature of the violation that caused it. If the total value in three different pairs differs, then the block algorithm removes from circulation those that do not match the previous two.
2.3.3 Function block for calculating the decay rate of an analog value BlockF

Figure 4. Function block for calculating the decay rate of an analog value BlockF

This FB is used to calculate the rate of rise and fall of values on analog channels. If there is a wire break on the analog sensor or a sharp drop in the physical value, the parameter read from this sensor will begin to drop sharply. This FB is designed to record events about a short circuit or break and record an error sign in the channel status word. That is, if a break or short circuit occurs this channel will be withdrawn from circulation.

2.3.4 GetAI Analog Channel Scaling Function Block

Figure 5. GetAI Analog Channel Scaling Function Block

This FB is used to convert controller program units (INT) into values of real process units (REAL). If the parameter goes beyond the permissible error limits (OFFSET), an error is not generated on the channel and the parameter stops at the maximum or minimum value. If a parameter stands out stronger than the normalized error, an error is generated on the channel with a decoding of the nature of the violation.

2.3.5 GetDI discrete channel processing function block

Figure 6. Function block for processing a discrete channel GetDI

This FB is used to filter “bounce” on a discrete channel. In case of loss of connection with the channel, the specified value is written to the input of this FB, as a result of which the value specified by default will be written to the resulting output at the output of the functional block.

2.3.6 Functional block for generating threshold violations HLLA4

Figure 7. Functional block for generating HLLA4 threshold violations

This FB is used to implement four threshold violations, which can be used both to issue system violations and to implement them in algorithms for implementing blocking and protection. To ensure that the violation does not disappear immediately upon returning to the area of the set value, a hysteresis function is provided that affects the nature of the issuance of violation signals.

2.3.7 Functional block for generating sinusoidal interference SIMPMEHA

Figure 8. Functional block for generating sinusoidal interference SIMPMEHA

This FB is used to implement controller modes associated with debugging and simulating the operation of the installation. This signal on the diagram looks like a sinusoidal curve, with a spread range specified by the limits (input variables). This interference is designed to “add in” to the magnitude of the analog signal and give it dynamic properties and visual realism.

2.3.8 Functional block for generating pulses of a given length SIMPULSE

Figure 9. Functional block for generating pulses of a given length SIMPULSE

This FB is used to implement controller modes associated with debugging and simulating the operation of the installation. This signal on the chart looks like a meander, with different ranges of peaks and troughs. Temporary values of the meander vertices are specified by time limits (input variables).

2.3.9 Analog variable generation function block SIMPV

Figure 10. SIMPV analog variable generation function block

This FB is used to generate analog signals for modes of simulating device operation and debugging the controller.
3. ACCESS TO THE PROGRAM
When working on site, the program is configured to start automatically when the controller is turned on. The program status is shown on the controller display. The program parameters can be configured from a laptop computer included in the system delivery.

4. INPUT AND OUTPUT DATA
The input data of the system is information received from the control object to the PTS through communication devices with the object (distributed periphery), as well as commands entered by the operator from a PC.
The output data of the system is the information transmitted to the control object from the PTS through a communication device with the object. The information is displayed on the PC in the form of screen forms and is sent as an alarm to the control room panel.

5. MESSAGES
Messages transmitted via the PLC-PC interface are described in the document “Programmer’s Guide. Part 2. PLC-PC interface." Messages issued to the operator are described in the document “Operator's Manual”.

#Manual, #programmer, #description, #PLC, #PTS, #interface, #analog, #controller

The programmer's manual refers to operational and technical documentation. Such a document is being developed for software products. Intended for familiarization by a programmer who will solve certain problems related to the operation of this program.

When is programmer guidance needed?

Programmer's guidance is needed in several cases:

The program for which documentation is compiled is a development environment or library.
This software product provides a platform for writing standard programs or systems.
The product is distributed in conjunction with program code or it is constantly modified by the developer.

With the help of such a document, the programmer should be presented with all necessary information, which can be used to create your own software products based on this system. Information must be provided in sufficient quantity. Developers, with the help of the programmer's manual, have the opportunity to record the current state of the released product in order to avoid confusion when releasing new products.

Typical tasks of such a document include:

Clarification and explanation to the specialist of the current state of objects, their location and methods of interaction. Also, the programmer's management must clearly distinguish between objects that are initially included in the system and objects that the programmer creates independently.
Transfer additional funds developments that will be required when working, in addition to the current product.
Clarification of system requirements, software environment, and tools required for launch.

UFA STATE AVIATION TECHNICAL UNIVERSITY

DEPARTMENT OF COMPUTATIONAL MATHEMATICS AND CYBERNETICS

Application software for recording applications and monitoring their execution using the example of Integrated Transport Network LLC.

Programmer's Guide

annotation

A software programmer's guide is provided for recording applications and monitoring their execution using the example of Integrated Transport Network LLC.

A software product must be developed for an organization designed to automate customer interaction strategies, in particular, to increase sales, improve customer service by storing information about customers and their personal data. An email distribution to users of this product should also be implemented, as well as statistics showing how many requests the user has made per day, per month.

The programmer's manual discusses the purpose, characteristics, conditions necessary for executing the program

Purpose of the program

The software product will be used at NetTrans (Integrated Transport Network LLC) in the technical support, subscriber and construction departments as an interaction model that believes that the center of the entire business philosophy is the client, and the main activities are measures to support sales and customer service. This software can only be used by registered users; registration, in turn, is carried out only by the administrator, by adding a new user to the database; it is also possible to maintain operator statistics that make up subscriber applications.

2. Conditions necessary for program execution

To operate the software product, the following hardware and software configuration is required:

Windows 7,Windows Server 2003 Service Pack 2,Windows Server 2008,Windows Server 2008 R2, Windows Vista, Windows Vista Service Pack 1,Windows XP Service Pack 2,Windows XP Service Pack 3;

32-bit systems: A computer equipped with an Intel or compatible processor running at 1 GHz or faster (2 GHz or faster recommended, only one processor supported);

64-bit systems: processor with clock frequency 1.4 GHz or higher (2 GHz or higher recommended, only one processor supported);

1 GB of free disk space;

Availability DBMS: MS SQL 2008;

3. Program characteristics

3.1. Program operating mode

Dialog. Web interface in the browser (with HTML5 support).

3.2.Means for checking the correct execution of the program

The correct operation of the program is verified by running specific examples. The program displays a message when entering incorrect data (Fig. 2.20):

Rice. 2.20. Invalid phone number entry

3.3. Program operation after failures

In the event of an emergency termination of the program caused by external reasons, the program is loaded again when the cause of the failure is eliminated. Any data not saved before the failure will be lost.

Access to the program

To start the program you must perform the following steps:

Run the program on a PC that supports the Microsoft .NET Framework (or on remote server), if it is not already running;

Open your favorite browser (for example chrome, internet explorer, mozilla firefox);

Enter in address bar Server IP address, with a predefined port;

The home page will open;

Start working with clients.

Send your good work in the knowledge base is simple. Use the form below

Students, graduate students, young scientists who use the knowledge base in their studies and work will be very grateful to you.

Posted on http://www.allbest.ru/

Programmer's Guide

1. Purpose and conditions of use
2. Characteristics of the program
3. Access to the program
4. Complete list of modules and components
5. Message to the user

1 . Purpose and conditions of use

This software product can be used directly to carry out activities in the Prof&Elite organization, which is engaged in the installation of plastic structures, including windows. software plastic window

The Prof&Elite software product is used to collect information about clients, employees, and measurement data for the manufacture and production of products. Provides centralized data storage. The product has a simple and intuitive interface, so the user will not have problems mastering it.

The design of this software product will help automate the work of the dealer relationship manager.

Hardware requirements:

· Intel processor Pentium IV and higher;

· RAM 512 MB and above;

· AGP/PCI Express video card 64 MB or higher;

· free disk space 12 MB;

· video monitor with a resolution of 1024x768;

· keyboard;

· mouse;

· printer for printing reports;

· operating system Windows 98/2000/XP/Vista/7/8;

· Microsoft Access, Borland Delphi 7.

2 . Program characteristics

In test mode, a request was made to the input/output form and data was entered into the main table, which made it possible to visually assess the workload central processor(CPU) and the use of allocated (virtual) memory using the “Task Manager”, as shown in Fig. B.1 and Fig. B.2.

Fig.B.2 - Allocated memory and loading time

3 . Access to the program

The application can be launched by clicking on the icon of the program itself, located in a special directory. After launching the application, the main window is displayed on the screen, with which you can control all the functions of the application described in section 4 of this user manual.

Launch this program can be done directly through the Delphi shell. To do this, you need to open the project file Project1.dbr, located in the directory with the program. Next, press F9 to compile and run the application.

It is possible to launch the program via the command line. Launch the command line “Start/All Programs/Accessories/Command Prompt” Next in command line You must enter the full path to the program, then write the name of the program (Project1.exe) and press Enter. The program has started.

Another way to start the program: from the Start menu, select Run. As a result, the “Program Execution” window will open on the screen. In the Open field of the Run a Program window, enter the path to the file of the program you want to run.

You can exit the application by clicking the “Close” button or using the program menu item “File/Exit”, or you can also use the Alt+F4 key combination.

4 . Complete list of modules and components

The main form contains a list of all modules used in the program and several executable statements that ensure the creation of the necessary windows and the connection of the program with the Windows OS. All the main work of the program is controlled by the code contained in the modules.

This software product includes the following modules:

Unit1.pas is the main module of the program, where data on orders is directly filled in;

Unit2.pas - sending an order to the dealer (dealer terminal);

Unit3.pas - program module where data on product (window) measurements is filled in;

Unit4.pas - program module where data on the installation of the product (window) is filled in;

Unit5.pas - search, filtering, sorting by orders;

Unit6.pas - module “About the program”.

The main form contains the components shown in Fig. B.3. The figure also shows a “tree” of all components of the form (Fig. B.4).

Figure B.3 - Main form components

Main form components:

TADOConnection - used to specify the database and work with transactions;

TADOTable - table accessible via ADO;

DataSource provides a mechanism for linking data access components (Table) with visual components that display data (DBGrid, DBEdit, DBListBox, etc.)

TADOQuery - performs a query (selection) to the database;

TMainMenu - creates the main menu of the program;

TDBGrid - displays data from the database in the form of a table;

TEdit - field for entering text messages;

TButton - button;

TComboBox - drop-down list;

TDBCtrlGrid - used to display the table in the form of “bricks”;

TLabel - labels;

TGroupBox - a panel as a separate element with other components;

TDBNavigator - component for managing navigation and data editing;

TDBEdit - database record editing field;

TDateTimePicker - date picker;

TSpeedButton - quick button;

TBitBtn - a button that transfers an action to the form;

TBevel - designed in an application to simply outline something with a frame.

The main form components are necessary for displaying tables from the database, for changing, adding, deleting, filtering, searching, moving to other forms, and for other actions.

Figure B.4 - Component structure

5 . Message to user

If the user has entered incorrect values to filter database data, the message shown in Figure B.5 is displayed.

Fig.B.5 - Error message

If an error occurred when deleting data, then the error message shown in Fig. B.6 is displayed.

software plastic window

Fig.B.6 - Error message.

The user forgot to enter the invoice number when saving the order, then the error message shown in Fig. B.7 is displayed.

Fig.B.7 - Error message

When you try to delete, the message shown in Figure B.8 is displayed.

Fig.B.8 - Dialogue with the user

If the user has already entered the number of an existing invoice when saving the order, the message shown in Fig. B.9 is displayed.

Fig.B.9 - Dialogue with the user

Posted on Allbest.ru

...