approved by ceo of 2019. of 2019.€¦ · functional role of "oms 2.0 admin". the...
TRANSCRIPT
Sig
natu
re a
nd d
ate
Inv.
No. of dupl.
Inste
ad o
f in
v.
No.
Sig
natu
re a
nd d
ate
Inv. N
o. sig
n.
2019
AGREED APPROVED BY CEO
ООО "CRPT" _______________/ / ___________________ /A.V. Zakhozhiy/
_____ of _________ 2019. _____ of _________ 2019.
ORDER MANAGEMENT STATION 2.0
Special Software
Software Package "Web-interface Module"
Administrator's Manual
RU 15861920.620111-01 34 02
Approval sheet
Sig
natu
re a
nd d
ate
Inv.
No. of dupl.
Inste
ad o
f in
v.
No.
Sig
natu
re a
nd d
ate
Inv. N
o. sig
n.
2019
APPROVED
RU 15861920.620111-01 34 02-LU
ORDER MANAGEMENT STATION 2.0
Special Software
Software Package "Web-interface Module"
Administrator's Manual
RU 15861920.620111-01 34 02
Sheets 37
2
RU 15861920.620111-01 34 02
ANNOTATION
This document "Order management station 2.0. Special Software. Software Package
"Web-interface Module". Administrator's Manual" RU 15861920.620111-01 34 02 is intended for
the employees operating information services provided via Web Interface Module software
complex, a part of the specialized software (SSW) of the "Order management station 2.0"
automated system (OMS AS 2.0). The document describes actions taken by users with the
functional role of "OMS 2.0 Admin". The document is developed in compliance with GOST 19.505-
79 "Unified software documentation system. Operator's manual".
This document uses the following designations:
1) Elements of the on-screen entry forms are designated as ‹Field›, ‹Button› or ‹Menu
item›;
2) PC keys are designated as [Key]. Combinations of simultaneously pressed keys are
designated as [Key1+Key2].
3
RU 15861920.620111-01 34 02
CONTENTS
1. INTENDED USE OF THE PROGRAM 4 2. EXECUTION ENVIRONMENT 11 3. PROGRAM EXECUTION 13 4. MESSAGES TO OPERATORS 29 LIST OF TERMS 30
LIST OF ABBREVIATIONS 32 LIST OF PICTURES 33 LIST OF TABLES 35
4
RU 15861920.620111-01 34 02
1. INTENDED USE OF THE PROGRAM
This specialized software is intended to enable the performance of the targeted OMS AS
2.0 functionalities including:
1) Placement of MC emission orders.
2) Application of MC.
3) Verification of MC application.
4) Aggregation of ready and packed products marked with identification tools (IT).
5
RU 15861920.620111-01 34 02
1.1. Program structure
OM
S A
S 2
.0 a
rch
itec
ture
Pic
ture
1
6
RU 15861920.620111-01 34 02
Picture 1 shows OMS AS 2.0 architecture as collections of the information services and
a set of technical tools (including computing, software and information tools) intended to enable
targeted system functionalities (see section 1).
OMS AS 2.0 comprises the following subsystems:
1) Visualisation subsystem that provides information services to OMS AS 2.0 users.
2) Enquiries Receipt and Processing subsystem.
3) Configuration Management subsystem.
4) An Interface with Allied Systems subsystem.
OMS AS 2.0 SSW comprises the following features:
1) As part of Visualisation subsystem:
− Web Interface software complex
2) As a part of Configuration Management subsystem:
− Devices Registry software complex.
− Economic Agents software complex.
− Users software complex.
− Enterprise Profile Management software complex.
− Emission Monitors software complex.
3) As a part of Enquiries Receipt and Processing subsystem:
− Order Management software complex.
− Aggregation Management software complex.
− Rejection Management software complex.
4) As a part of Interface with Allied Systems subsystem:
− Interface with ATPMS software complex.
− Interface with IS MP software complex.
− Interface with MC EM software complex.
7
RU 15861920.620111-01 34 02
1.2. Interface with allied systems
1.2.1. General information
In the course of deployment, OMS AS 2.0 gets embedded into the technology
infrastructure of the economic agent. Picture 2 shows commercial use of OMS AS 2.0.
Co
mm
erc
ial u
se o
f O
MS
AS
2.0
Pic
ture
2
8
RU 15861920.620111-01 34 02
In the course of operation, OMS AS 2.0, as part of an informational, communicational and
functional interface, performs data exchange with the allied systems listed in Table 1.
Table 1 List of allied systems
Legend Description
Informational and communicational interface
Information Gateway AS as part of ATPMS (Inexto Gate)
The following interactions with Inexto Gate are implemented in OMS AS 2.0 Interface with Allied Systems subsystem:
− Interface between OMS AS 2.0 and Inexto Gate as part of processing the commercial orders for marking codes emission;
− Interface between OMS AS 2.0 and Inexto Gate as a part of providing the emitted marking codes to be applied to the products;
− Interface between OMS AS 2.0 and Inexto Gate as a part of processing the reports on the use of marking codes;
− Interface between OMS AS 2.0 and Inexto Gate as a part of processing the reports on aggregation;
− Interface between OMS AS 2.0 and Inexto Gate as a part of processing the reports on the use of marking codes;
The interface is implemented using open interfacing protocols (HTTP, REST), data exchange format is JSON.
Emission Monitor (EM) AS The following interactions with EM are implemented in OMS AS 2.0 Interface with Allied Systems subsystem:
− Interface between OMS AS 2.0 and EM as a part of providing the orders for marking codes emission;
− Interface between OMS AS 2.0 and EM as a part of receiving the emitted marking codes to be applied to the products;
− Interface between OMS AS 2.0 and EM as a part of providing the reports on the use of marking codes;
− Interface between OMS AS 2.0 and EM as a part of providing the reports on the retirement/rejection of marking codes;
The interface is implemented using the binary protocol, the protocol is defined by EM manufacturer.
9
RU 15861920.620111-01 34 02
Legend Description
Track & Trace Information System for Marking and Monitor the Tobacco Products Circulation (IS MOTP) AS
The following interactions with IS MP are implemented in OMS AS 2.0 Interface with Allied Systems subsystem:
− Interface between OMS AS 2.0 and IS MP as a part of providing the reports on the aggregation of marking codes;
− Interface between OMS AS 2.0 and IS MP as a part of providing the reports on the retirement/rejection of marking codes;
The interface is implemented using open interfacing protocols (HTTP, REST), data exchange format is JSON
Data collection terminals (DCT) The following interactions with DCTs are implemented in OMS AS 2.0 Interface with Allied Systems subsystem:
− Interface between OMS AS 2.0 and DCTs as a part of processing the reports on the retirement/rejection of marking codes;
The interface is implemented using open interfacing protocols (HTTP, REST), data exchange format is JSON.
Functional interface via Information Gateway AS
Enterprise Resource Planning (ERP) system
The receipt of the commercial orders for marking codes emission from Enterprise Resource Planning (ERP) system is implemented as a part of the interface between OMS AS 2.0 and Inexto Gate (part of ATPMS) in terms of processing commercial orders for marking codes emission;
Marking application system, part of ATPMS (Inexto LIZ)
Provision of emitted marking codes to be applied to the products is implemented in Inexto LIZ as a part of the interface between OMS AS 2.0 with Inexto Gate (part of ATPMS) in terms of provision of emitted marking codes to be applied to the products;
Aggregation stations, part of ATPMS (Inexto INEXPRESS /Fracture Code)
The receipt of reports on aggregation of marking codes from Inexto INEXPRESS/Fracture Code is implemented as a part of the interface between OMS AS 2.0 and Inexto Gate (part of ATPMS) in terms of processing the reports on aggregation; .
10
RU 15861920.620111-01 34 02
Legend Description
Functional interface via Emission Monitor AS
Emission Server (ES) AS Submitting orders for emission of marking codes to ES is implemented as part of the interface between OMS AS 2.0 and EM within the context of provision of orders for marking codes emission; The receipt of emitted marking codes from ES is implemented as part of the interface between OMS AS 2.0 and EM in terms of receipt of emitted marking codes to be applied to the products; Provision of reports on the use of marking codes in ES and IS MP is implemented as part of the interface between OMS AS 2.0 and EM in terms of provision of reports on the use of marking codes; Provision of reports on the retirement/rejection of marking codes in ES and IS MP is implemented as a part of the interface between OMS AS 2.0 and EM in terms of provision of reports on the retirement/rejection of marking codes;
11
RU 15861920.620111-01 34 02
2. EXECUTION ENVIRONMENT
2.1. PC pre-requisites
To operate information services provided by Web Interface Module software complex (part
of OMS AS 2.0), the following computing tools (CTs) must be used:
1) Individual user's CTs:
− AWP of a user having the functional role of OMS 2.0 Admin (OMS Admin AWP), which
is a PC compliant with the recommended requirements to Microsoft Windows OS (8.1 or
higher) and NIC that provides information and communication link to OMS AS 2.0 HCS.
2.2. Software required for the functioning of the program
To operate information services provided by Web Interface Module software complex
(part of OMS AS 2.0), the following components of the general software (GSW) are required:
1) Microsoft Windows OS 8.1 or higher;
2) Web- browser:
− Mozilla Firefox 40 or higher.
− Internet Explorer 9 or higher.
− Google Chrome 37 or higher.
2.3. Requirements to personnel
OMS AS 2.0 SSW must be operated where OMS AS 2.0 HCS is deployed. Access to
information services provided by Web Interface Module software complex (part of OMS AS 2.0
SSW) is granted via information and communication links connecting OMS Admin AWP and OMS
AS 2.0 HCS.
The following users are granted access to operate information services provided by Web
Interface Module software complex (part of OMS AS 2.0 SSW):
1) experienced in PC operation and fully mastered to operate the Microsoft Windows OS
GUI and its functionalities;
12
RU 15861920.620111-01 34 02
2) having skills in web surfing and fully mastered in operating GUI of one of the following
recommended web -browsers;
3) trained to operate OMS AS 2.0;
4) familiar with the intended use and basic operation principles of secure infrastructure
for marking codes emission.
To differentiate access to the information services provided by Web Interface Module
software complex (part of OMS AS 2.0 SSW), the role model is used.The employee competency
levels must comply with the functional roles utilized by the model:
1) OMS Admin.
2) OMS Operator.
2.3.1. OMS Operator
OMS Operator must have sufficient knowledge and skills to perform the following tasks:
1) Creation and management of commercial orders.
2) Maintaining the list of aggregation notifications.
3) Maintaining the list of notifications on the retirement of rejected products by the
production department.
4) Configuring parameters for information and communication links to emission monitors.
2.3.2. OMS Admin
OMS Admin must have sufficient knowledge and skills to perform the following tasks:
1) Management of OMS AS 2.0 user accounts.
2) Configuring parameters for information and communication links to emission monitors.
3) Setup and configuration of end devices (client devices) parameters.
4) Entering and editing economic agents data.
5) Control over OMS server state.
13
RU 15861920.620111-01 34 02
3. PROGRAM EXECUTION
3.1. Loading and starting the program
3.1.1. Starting the program
The program is loaded to RAM of the OMS Admin's AWP as JavaScript software
modules in the course of accessing information services provided by Web Interface Module
software complex (part of OMS AS 2.0 SSW).
To access information services of Web Interface Module software complex, OMS
Admin must:
1) Load web -browser to RAM using a Microsoft Windows OS functionality (OS Main
menu, Desktop Shortcut, OS taskbar, etc.);
2) In the address bar of the web -browser, enter the address to be requested from the
program developer.
3) Enter username and password into the on-screen login form (Picture 3) and press the
Login button. Users can view the entered password by clicking the eye icon in the right
area of the field.
14
RU 15861920.620111-01 34 02
On-screen login form Picture 3
If the entered username and password are correct and valid, the browser window
shows the program homepage (Picture 4).
15
RU 15861920.620111-01 34 02
Program homepage Picture 4
The on-screen login form (Picture 3) also contains ‹REST documentation› and ‹Swagger
documentation› hyperlinks. When you click on them, new web browser windows appear,
containing hypertext descriptions (Picture 5 and Picture 6) for the corresponding application
programming interfaces (API).
16
RU 15861920.620111-01 34 02
REST API hypertext description Picture 5
Swagger API hypertext description Picture 6
17
RU 15861920.620111-01 34 02
3.2. Program execution
3.2.1. Program homepage
After entering the system, user gets access to the information services provided by the
user interface of the program homepage (Picture 4).
Program homepage consists of the following main elements (Picture 7):
1) Main menu (highlighted in red).
2) Data display area (highlighted in purple).
3) Information panel (highlighted in green).
Program homepage Picture 7
18
RU 15861920.620111-01 34 02
Program homepage in the downsized browser window Picture 8
When the web browser window is downsized, the main menu and the information panel
disappear from the program homepage (Picture 8), and to display them on the screen again,
controls in the top corners of the homepage are used (Picture 9) – the control in the left top corner
(highlighted in red) is used to display the menu, the one in the right top corner (highlighted in
purple) is used to display the panel.
Controls to display the main menu or the information panel on the screen in the downsized browser window
Picture 9
19
RU 15861920.620111-01 34 02
3.2.1.1. Main menu
Program main menu Picture 10
Program main menu (Picture 10) consists of the following items:
1) ‹Company Profile› item.
2) ‹Users› item.
3) Display mode switch
20
RU 15861920.620111-01 34 02
Display mode switch to Pop-up mode Picture 11
Display mode switch to Docked mode Picture 12
The Main menu has two display modes: the Pop-up mode and the Docked mode. To
switch between them, a display mode switch is used (Picture 11 and Picture 12). When the Pop-
up mode is used, the menu only displays item icons (Picture 4), the entire menu displays when
it's moused over (Picture 13) and disappears when the cursor is taken away. In this case, the
menu partially overlaps the data display area.
Program main menu in Pop-up mode Picture 13
When using the Docked mode, the entire menu is displayed permanently(Picture 14), and
in this case, the data display area moves to the right without overlapping the menu.
21
RU 15861920.620111-01 34 02
Program main menu in Docked mode Picture 14
22
RU 15861920.620111-01 34 02
3.2.1.2. Data display area
The data display area is used to input and output the information relating to the various
information services of Web Interface Module software complex.
The appearance of the data display area is defined by the selected main menu item (see
clause 3.2.1.1), however, in most cases it contains the tabular data display (Picture 15).
The appearance of the data display area with ‹Users› item selected Picture 15
3.2.1.3. Information panel
The information panel contains ‹Admin› hyperlink that exits the program (see subsection
3.3).
23
RU 15861920.620111-01 34 02
3.2.2. General interface elements
3.2.2.1. Working with tables
To select data in the table, user must hover the mouse over the desired row which gets
highlighted with a contrasting colour bar (Picture 16).
Selecting a row in the table Picture 16
If the number of rows exceeds the visible part of the table, it is divided into pages, and
navigation across the pages is performed via the navigation panel (Picture 17) located in the left
bottom corner of the table.
Navigation panel of the table Picture 17
The navigation panel contains ‹<› and ‹>› buttons used to move to the previous or the
next page of the table, and the list of table pages located between the buttons. The current page
is highlighted with the yellow box. You can single-click to move to the desired page.
24
RU 15861920.620111-01 34 02
3.2.2.2. Methods to fill in the fields
The following methods to fill in the fields are available:
1) A user can enter a value directly into the field.
2) Or, the user can enter a value into the field by selecting it from the drop-down list that
opens by clicking the ‹▼› button in the right area of the field (Picture 18).
Drop-down list with values Picture 18
25
RU 15861920.620111-01 34 02
3.2.3. Working with information services
3.2.3.1. Working with company profile
To work with the company profile, select ‹Company profile› item in the main menu (see
clause 3.2.1.1), after which the data display area (see subclause 3.2.1.2) displays two
tables - containing data of the current company profile and data of the company profile provided
by OMS AS Server (Picture 19).
Tables containing data of company profiles Picture 19
View All Data of Company Profiles button Picture 20
To view all the data of company profiles, click the corresponding button in the left column
of any table (Picture 20).
26
RU 15861920.620111-01 34 02
Tables containing all data of company profiles Picture 21
If the data contained in the company profile provided by OMS AS Server are correct, you
can set the profile as the current profile by clicking the ‹Apply new profile› button (Picture 22)
located above the table that contains data of the company profile provided by OMS AS Server.
‹Apply new profile› button Picture 22
27
RU 15861920.620111-01 34 02
3.2.3.2. Working with the list of users
To work with the list of users, you must select ‹Users› in the main menu (see clause
3.2.1.1), after which the data display area (see subclause 3.2.1.2) shows the table containing the
list of users (Picture 23).
Table containing the list of users Picture 23
Full functionality of this information service will be implemented in the following versions
of OMS AS 3.0 SSW.
28
RU 15861920.620111-01 34 02
3.3. Completing program
To complete the program, click the ‹Admin› hyperlink in the right pane of the information
panel. After that, select ‹Exit account› option in the appearing pop-up menu(Picture 24).
‹Admin› hyperlink pop-up menu Picture 24
After you select the ‹Account exit› option, your program session is over, and an on-screen
login form appears (Picture 3). After that, you may close your web browser using any valid
method. No additional action is required to unload the program from OMS Admin AWP RAM.
29
RU 15861920.620111-01 34 02
4. Messages to operators
4.1. Messages to admin transmitted via GUI
4.1.1. Information windows
If any errors occur in the course of program execution, the web browser window displays
a red pop-up window containing two message types:
1) Program entry error message (Picture 25).
Program entry error message Picture 25
2) System error message (Picture 26).
System error message Picture 26
30
RU 15861920.620111-01 34 02
LIST OF TERMS
This document uses the following terms:
1) Computing tools (CTs) – PC (personal computer) or any other computing equipment
(mainframe, mini PC, micro PC, pocket PC, computer terminal).
2) Individual user's CTs – computing equipment that ensures:
− automation for the computing component of daily activities of the Customer's
employees;
− access to the information services that provide automation for business workflow across
the Customer's company.
3) Multiple-access CTs – computing equipment intended for:
− arrangement of a computing platform that enables automation of Customer's business
workflow;
− controlling and configuring CTs that are part of the automated system;
− accumulation and processing of data used for automation of Customer's business
workflow.
4) General software – a collection of software components that provides CTs minimum
functionality:
− an environment to launch and operate the rest of the software components (operating
system);
− tools for working with structured data sets (DBMS);
− tools to access Internet resources (web browser);
− tools to publish CTs resources on the Internet (web server).
5) Specialised software – a collection of software components that are specifically
developed for this particular CT (not an "out-of-the-box SW").
31
RU 15861920.620111-01 34 02
6) End devices – devices managed by the automated system directly (via information and
communication links) or indirectly (via the functional interface with the allied systems),
and intended to perform technological functions (printer, scanner, monitor, controller,
etc.).
32
RU 15861920.620111-01 34 02
LIST OF ABBREVIATIONS
AWP Automated workplace AS Automated system ATPMS Automated technological process management system IS Information security IS MP Track & trace information system for marking products MC Marking code HCS Hardware components set LAN Local area network UAA Unauthorised access LAN Local area network ED End devices OS Operating system GSW General software SW Software HSC Hardware and software complex PC Personal computer OM Operations monitor EM Emission monitor AVP Anti-virus protection CT Computer tool IT Identification tools SCS Structured cabling system IPT Information protection tool SSW Specialised software NIT Network interface tools OMS Order management station ES Emission server ToR Terms of reference TC Test computer
33
RU 15861920.620111-01 34 02
LIST OF PICTURES
Picture 1 ....................................................................................................................................... 5
Picture 2 ....................................................................................................................................... 7
Picture 3 ..................................................................................................................................... 14
Picture 4 ..................................................................................................................................... 15
Picture 5 ..................................................................................................................................... 16
Picture 6 ..................................................................................................................................... 16
Picture 7 ..................................................................................................................................... 17
Picture 8 ..................................................................................................................................... 18
Picture 9 ..................................................................................................................................... 18
Picture 10 ................................................................................................................................... 19
Picture 11 ................................................................................................................................... 20
Picture 12 ................................................................................................................................... 20
Picture 13 ................................................................................................................................... 20
Picture 14 ................................................................................................................................... 21
Picture 15 ................................................................................................................................... 22
Picture 16 ................................................................................................................................... 23
Picture 17 ................................................................................................................................... 23
Picture 18 ................................................................................................................................... 24
Picture 19 ................................................................................................................................... 25
Picture 20 ................................................................................................................................... 25
Picture 21 ................................................................................................................................... 26
Picture 22 ................................................................................................................................... 26
Picture 23 ................................................................................................................................... 27
Picture 24 ................................................................................................................................... 28
Picture 25 ................................................................................................................................... 29
34
RU 15861920.620111-01 34 02
Picture 26 ................................................................................................................................... 29
35
RU 15861920.620111-01 34 02
LIST OF TABLES
Table 1 List of allied systems ....................................................................................................... 8
36
RU 15861920.620111-01 34 02
Revision record sheet
Sheet (page) numbers
Total sheets (pages) in the doc.
Document No. Accompanying
doc. ref. No. and date
Sign. Date Rev.
of modified of replaced of new of cance-lled