Siemens SIMATIC PCS 7 Parts list manual

SIMATIC
Process Control System PCS 7
Advanced Process Functions (APF)
Function Manual
07/2016
A5E38719883-AA
Preface
Security information 1
Communication 2
Material management 3
Material lot management 4
Storage location
management 5
Parameter management 6
Order management 7
Archive management 8
Best before / UTC time supply 9
Data structures and data
formats 10
Additional information 11

Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified
personnel are those who, based on their training and experience, are capable of identifying risks and avoiding
potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in
this publication is reviewed regularly and any necessary corrections are included in subsequent editions.
Siemens AG
Division Process Industries and Drives
Postfach 48 48
90026 NÜRNBERG
GERMANY
A5E38719883-AA
Ⓟ 08/2016 Subject to change
Copyright © Siemens AG 2016.
All rights reserved

Preface
Purpose of the manual
This document contains reference information for configuration of the
Advanced Process Functions (APF) within the environment of SIMATIC PCS 7.
You can find additional information on APF in the following manuals:
● APF Installation and Configuration
● APF Engineering Manual
● APF Operating Manual
Core content
The following core issues are covered in this document:
● Functions and connections of the APF function blocks
● Structure of the APF user archives
● Available APF user interfaces
● Data structures
Validity
This documentation is valid for V2.1 of the APF software package.
Note
The process pictures may be available in different versions. For example, the material lot editor
(.pdl picture) available by default as FB_MAT_LOT_ED (recommended for resolution
1280x1024), is also additionally available as FB_MAT_LOT_ED-1920 optimized for 1920x1080
resolution and an improved form.
In this manual, the process picture name is used without a suffixed number for both versions.
The inserted screen representations correspond to the PDL pictures with a resolution of 1280
and generally also apply for the PDL pictures in higher resolution and improved display.
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 3

Preface
Advanced Process Functions (APF)
4Function Manual, 07/2016, A5E38719883-AA

Table of contents
Preface.........................................................................................................................................................3
1Security information....................................................................................................................................11
2 Communication...........................................................................................................................................13
2.1 FB_UA_RM............................................................................................................................13
2.1.1 Description.............................................................................................................................13
2.1.2 Functions................................................................................................................................14
2.1.3 I/Os.........................................................................................................................................15
2.1.4 Error handling.........................................................................................................................19
2.1.5 Messaging..............................................................................................................................19
2.2 FB_UA_WM............................................................................................................................20
2.2.1 Description.............................................................................................................................20
2.2.2 Functions................................................................................................................................22
2.2.3 I/Os.........................................................................................................................................24
2.2.4 Error handling.........................................................................................................................27
2.2.5 Messaging..............................................................................................................................28
2.3 User archives.........................................................................................................................29
2.4 Operator control and monitoring............................................................................................29
3 Material management.................................................................................................................................31
3.1 FB_XXXMA............................................................................................................................31
3.1.1 Description.............................................................................................................................31
3.1.2 Generation.............................................................................................................................32
3.1.3 Functions................................................................................................................................33
3.1.4 I/Os.........................................................................................................................................34
3.1.5 Error handling.........................................................................................................................37
3.1.6 Messaging..............................................................................................................................38
3.2 User archives.........................................................................................................................39
3.2.1 FB_MATCLASS.....................................................................................................................39
3.2.2 FB_MATTYPE_XXX, FB_MATTYPE.....................................................................................40
3.2.3 FB_MATATTRIB_XXX...........................................................................................................40
3.2.4 FB_MATERIAL_XXX..............................................................................................................41
3.3 Operator control and monitoring............................................................................................42
3.3.1 Block icons.............................................................................................................................42
3.3.2 Picture objects........................................................................................................................43
3.3.3 Messages...............................................................................................................................43
4 Material lot management............................................................................................................................45
4.1 FB_MLOT...............................................................................................................................45
4.1.1 Description.............................................................................................................................45
4.1.2 Generation.............................................................................................................................46
4.1.3 Functions................................................................................................................................47
4.1.4 I/Os.........................................................................................................................................50
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 5

4.1.5 Error handling.........................................................................................................................54
4.1.6 Messaging..............................................................................................................................55
4.2 User archives.........................................................................................................................57
4.2.1 FB_MATERIAL_LOT..............................................................................................................57
4.2.2 FB_MATATTRIB_LOT............................................................................................................58
4.3 Operator control and monitoring............................................................................................60
4.3.1 Block icons.............................................................................................................................60
4.3.2 Picture objects........................................................................................................................60
4.3.3 Messages...............................................................................................................................61
5 Storage location management....................................................................................................................63
5.1 FB_STOR (FB_STORI, FB_STORR).....................................................................................63
5.1.1 Description.............................................................................................................................63
5.1.2 Generation.............................................................................................................................64
5.1.3 Functions................................................................................................................................66
5.1.4 I/Os.........................................................................................................................................69
5.1.5 Error handling.........................................................................................................................73
5.1.6 Messaging..............................................................................................................................74
5.2 FB_SACT...............................................................................................................................75
5.2.1 Description.............................................................................................................................75
5.2.2 Generation.............................................................................................................................76
5.2.3 Functions................................................................................................................................77
5.2.4 I/Os.........................................................................................................................................80
5.2.5 Error handling.........................................................................................................................82
5.2.6 Messaging..............................................................................................................................83
5.3 FB_ST_AC.............................................................................................................................84
5.3.1 Description.............................................................................................................................84
5.3.2 Generation.............................................................................................................................84
5.3.3 Functions................................................................................................................................85
5.3.4 I/Os.........................................................................................................................................87
5.3.5 Error handling.........................................................................................................................90
5.3.6 Messaging..............................................................................................................................92
5.4 FB_STLOC.............................................................................................................................93
5.4.1 Description.............................................................................................................................93
5.4.2 Generation.............................................................................................................................94
5.4.3 Functions................................................................................................................................95
5.4.4 I/Os.........................................................................................................................................96
5.4.5 Error handling.......................................................................................................................103
5.4.6 Messaging............................................................................................................................104
5.5 FB_STMAT...........................................................................................................................106
5.5.1 Description...........................................................................................................................106
5.5.2 Generation...........................................................................................................................107
5.5.3 Functions..............................................................................................................................107
5.5.4 I/Os.......................................................................................................................................110
5.5.5 Error handling.......................................................................................................................118
5.5.6 Messaging............................................................................................................................119
5.6 User archives.......................................................................................................................120
5.6.1 FB_STORGROUP................................................................................................................120
5.6.2 FB_STORATTRIB................................................................................................................121
Table of contents
Advanced Process Functions (APF)
6Function Manual, 07/2016, A5E38719883-AA

5.6.3 FB_STORVALUE.................................................................................................................123
5.6.4 FB_STORAGE.....................................................................................................................124
5.6.5 FB_STOR_ST_STATUS......................................................................................................127
5.6.6 FB_STOR_MAT_STATUS...................................................................................................128
5.6.7 FB_PROCEDURES.............................................................................................................128
5.7 Operator control and monitoring..........................................................................................129
5.7.1 Block icons...........................................................................................................................129
5.7.2 Picture objects......................................................................................................................130
5.7.3 Messages.............................................................................................................................131
5.8 Other....................................................................................................................................134
5.8.1 User-defined filter/sorting.....................................................................................................134
5.8.1.1 Basic procedure...................................................................................................................134
5.8.1.2 Configuration example C function........................................................................................136
5.8.1.3 Default values......................................................................................................................137
5.8.1.4 Restrictions..........................................................................................................................138
5.8.2 Two-step operation..............................................................................................................138
5.8.3 Use of remainder..................................................................................................................138
5.8.3.1 "Split" point...........................................................................................................................139
5.8.3.2 Selection of multiple storage locations.................................................................................139
5.8.3.3 Output of selected storage locations....................................................................................140
5.8.3.4 Switching the active storage location...................................................................................140
5.8.3.5 Reserving material quantities...............................................................................................140
5.8.3.6 Plausibility check for storage locations................................................................................140
5.8.3.7 Search with use of remainder..............................................................................................140
5.8.4 Material class / material type releases.................................................................................141
5.8.5 Static and dynamic procedure enables................................................................................143
5.8.6 Storage / material state........................................................................................................144
6 Parameter management...........................................................................................................................145
6.1 FB_XXXPA...........................................................................................................................145
6.1.1 Description...........................................................................................................................145
6.1.2 Generation...........................................................................................................................146
6.1.3 Functions..............................................................................................................................147
6.1.4 I/Os.......................................................................................................................................151
6.1.5 Error handling.......................................................................................................................155
6.1.6 Messaging............................................................................................................................155
6.2 FB_PA_ST............................................................................................................................157
6.2.1 Description...........................................................................................................................157
6.2.2 Generation...........................................................................................................................157
6.2.3 Functions..............................................................................................................................158
6.2.4 I/Os.......................................................................................................................................159
6.3 C functions for normalization/recalculation..........................................................................160
6.4 User archives.......................................................................................................................162
6.4.1 FB_PARAMGROUP.............................................................................................................162
6.4.2 FB_PARAMATTRIB_XXX....................................................................................................162
6.4.3 FB_PARAM_XXX.................................................................................................................164
6.4.4 FB_PARAM_CALC_XXX......................................................................................................165
6.5 Operator control and monitoring..........................................................................................166
6.5.1 Block icons...........................................................................................................................166
Table of contents
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 7

6.5.2 Picture objects......................................................................................................................166
6.5.3 Messages.............................................................................................................................167
7 Order management..................................................................................................................................171
7.1 FB_JOB................................................................................................................................171
7.1.1 Description...........................................................................................................................171
7.1.2 Generation...........................................................................................................................173
7.1.3 Functions..............................................................................................................................174
7.1.4 I/Os.......................................................................................................................................188
7.1.5 Error handling.......................................................................................................................199
7.1.6 Messaging............................................................................................................................200
7.2 User archives.......................................................................................................................207
7.3 Operator control and monitoring..........................................................................................207
7.3.1 Block icons...........................................................................................................................207
7.3.2 Picture objects......................................................................................................................208
7.3.3 Messages.............................................................................................................................209
8 Archive management................................................................................................................................211
8.1 FB_XXXA (FB_XXXAI, FB_XXXAR)....................................................................................211
8.1.1 Description...........................................................................................................................211
8.1.2 Generation...........................................................................................................................212
8.1.3 Functions..............................................................................................................................214
8.1.4 I/Os.......................................................................................................................................216
8.1.5 Error handling.......................................................................................................................219
8.1.6 Messaging............................................................................................................................220
8.2 C functions for export and backup.......................................................................................221
8.2.1 Overview..............................................................................................................................221
8.2.2 Data export...........................................................................................................................222
8.2.3 Data backup.........................................................................................................................225
8.3 User archives.......................................................................................................................226
8.3.1 FB_ ARCHGROUP..............................................................................................................226
8.3.2 FB_ARCHVALUE_XXX........................................................................................................226
8.3.3 FB_ARCHIVING_XXX..........................................................................................................230
8.3.4 FB_JOB_STATUS, FB_STORAGE_STATUS, FB_MATERIAL_STATUS...........................231
8.3.5 AENUMERATION (name in ENUM_MAT)...........................................................................232
8.4 Operator control and monitoring..........................................................................................232
9 Best before / UTC time supply..................................................................................................................235
9.1 FB_BBD...............................................................................................................................235
9.1.1 Description...........................................................................................................................235
9.1.2 Functions..............................................................................................................................236
9.1.3 I/Os.......................................................................................................................................238
9.1.4 Error handling.......................................................................................................................239
9.2 User archives.......................................................................................................................240
9.3 Operator control and monitoring..........................................................................................240
10 Data structures and data formats.............................................................................................................241
10.1 UDT_UA_R_ST....................................................................................................................241
Table of contents
Advanced Process Functions (APF)
8Function Manual, 07/2016, A5E38719883-AA

10.2 UDT_UA_R_REQ_ST...........................................................................................................242
10.3 UDT_UA_W_ST...................................................................................................................243
10.4 UDT_UA_W_REQ_ST..........................................................................................................244
10.5 UDT_ALARM_ST.................................................................................................................246
10.6 UDT_PA_REQ_ST...............................................................................................................247
10.7 UDT_PA_CON_ST...............................................................................................................247
11 Additional information...............................................................................................................................249
11.1 Configuration file..................................................................................................................249
11.2 Data backup of the user archives.........................................................................................249
11.2.1 General information..............................................................................................................249
11.2.2 Storage at the backup path..................................................................................................250
11.2.3 Data backup procedure........................................................................................................251
11.3 User archives.......................................................................................................................251
Table of contents
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 9

Table of contents
Advanced Process Functions (APF)
10 Function Manual, 07/2016, A5E38719883-AA

Security information 1
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, systems, machines and networks.
In order to protect plants, systems, machines and networks against cyber threats, it is
necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial
security concept. Siemens’ products and solutions only form one element of such a concept.
Customer is responsible to prevent unauthorized access to its plants, systems, machines and
networks. Systems, machines and components should only be connected to the enterprise
network or the internet if and to the extent necessary and with appropriate security measures
(e.g. use of firewalls and network segmentation) in place.
Additionally, Siemens’ guidance on appropriate security measures should be taken into
account. For more information about industrial security, please visit:
http://www.siemens.com/industrialsecurity
Siemens’ products and solutions undergo continuous development to make them more secure.
Siemens strongly recommends to apply product updates as soon as available and to always
use the latest product versions. Use of product versions that are no longer supported, and
failure to apply latest updates may increase customer’s exposure to cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS
Feed under:
http://www.siemens.com/industrialsecurity
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 11

Security information
Advanced Process Functions (APF)
12 Function Manual, 07/2016, A5E38719883-AA

Communication 2
2.1 FB_UA_RM
2.1.1 Description
Object properties
The following table shows the object properties of the "FB_UA_RM" block:
Name Number Family Module
FB_UA_RM FB1775 APF Communication
Area of application
The block executes the following functions:
● Reading one or more data records from the OS user archive to a data block on request
● Transferring read data to the requesting block
● Monitoring communication (generation of alarms)
Startup characteristics
The "FB_UA_RM" block is called from the startup OB upon CPU startup. This call is configured
during CFC configuration by the CFC editor. Internal data and outputs are reset upon startup.
Program execution starts once the "RUNUPCYC" cycles have elapsed.
During startup, the output "QRUN_UP" = 1.
Time characteristics
The block must be called from a cyclic interrupt OB.
Communication
Communication on the AS level between the requesting block and the "FB_UA_RM" block is
implemented with the "UDT_UA_R_REQ_ST" (request) and "UDT_UA_R_ST" (feedback)
structures.
The data is read through the "BRCV" block, which occurs twice in the "FB_UA_RM" block,
enabling the establishment of a redundant connection.
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 13

OS tags are used to coordinate the data communication between the AS and OS. Appropriate
scripts associated with the function block and its functionalities are triggered for operator
control at the OS level.
The "ALARM_8P" structure is used to implement data communication with the OS message
system.
Note
For information on configuring the "FB_UA_RM" block, refer to the APF Engineering Manual.
2.1.2 Functions
Overview
The figure below provides an overview of how the "FB_UA_RM" block works:
5HTXHVWLQJEORFN,' HJ,' HJ,' HJ5HTXHVWLQJEORFN5HTXHVWLQJEORFN(UURU$/$50B3$ODUP6FULSW8VHUDUFKLYHV/RJJLQJ,2YDULDEOHV%5&9FB_UA_RM
8'7B8$B5B5(4B675(4B675(4B675(4B678'7B8$B5B6748$B675(4B' OS
How it works
Upon request, the "FB_UA_RM" function block reads data from an OS user archive via the
"BRCV" communication block (BlockReceive, SFB13). It transfers the read data to the
requesting block in the AS.
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
14 Function Manual, 07/2016, A5E38719883-AA

Communication between the requesting block and the "FB_UA_RM" function block occurs at
the AS level using the "UDT_UA_R_REQ_ST" (request) and "UDT_UA_R_ST" (feedback)
structures.
The "FB_UA_RM" block can manage a maximum of 128 requests. Each request occupies a
separate structure input (UDT_UA_R_REQ_ST). The requesting block transfers its uniquely
identifying ID (REQ_ID) to the structure.
The read data are made available at an output structure (UDT_UA_R_ST) and identified with
the REQ_ID associated with the job. As a result, the requesting block is able to recognize that
the data belong to its read request.
The block monitors the 128 input structures for valid requests. A request is valid if it fulfills the
following conditions:
● "REC_REQ" = 1
● "REQ_ID" <> 0
● "REC_ID" <> 0
● "ARCH_NA" <>' '
● "COLUMN" <> 0 and "NO_COL" <> 0 or "NO_COL" = 0
Each valid request is allocated a priority in the order of its occurrence. Priority is allocated as
consecutive numbers from 1 to 128; 1 is the highest priority and 128 the lowest.
If no read jobs are active and there is at least one valid request pending, the request data of
the input structure with the highest priority are entered in the coordination interface to the OS,
and the trigger for the OS script is activated. The receive mailbox is monitored for the arrival
of new data. Any new data are checked for validity and plausibility. Provided no errors have
occurred, the data are copied to the output structure where they remain pending until the
"REC_REQ" request is canceled by the requesting block. This ends the read job and a new
read job can then be executed.
A read job is aborted if the requesting block cancels the "REC_REQ" request during the job.
2.1.3 I/Os
Input parameters
The following table shows the input parameters of the "FB_UA_RM" block:
Parameter Description Type Default
RUNUPCYC Number of startup cycles INT 10
ID_1 Parameter ID for BRCV_1 WORD 0
ID_2 Parameter ID for BRCV_2 WORD 0
R_ID_1 Parameter R_ID for BRCV_1 DWORD 0
R_ID_2 Parameter R_ID for BRCV_2 DWORD 0
ID ID of the block INT 0
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 15

Parameter Description Type Default
REQ001_ST
….
REQ128_ST
Request 1
….
Request 128
UDT_UA_R_REQ_ST
MSG_EVID ALARM_8P: EV_ID DWORD 0
Output parameters
The following table shows the output parameters of the "FB_UA_RM" block:
Parameter Description Type Default
PRI_R1
…
PRI_R128
Priority index for request 1 - 128 INT 0
QRUN_UP Status display startup active = 1 BOOL FALSE
QNOT_OK Block flag "OK" not set,
Error = 1
BOOL FALSE
QGR_ERR Function block group error/fault BOOL FALSE
QPARAMF 1 = Parameter assignment error,
duplicate REQ_ID or
incorrect ID_1, R_ID_1 or ID_2,
R_ID_2
BOOL FALSE
QARCHERR 1 = Archive error,
invalid data in receive buffer or
script error in the OS
BOOL FALSE
QERR 1 = Read error,
requested data and read data do
not match
BOOL FALSE
QCOM_ERR 1 = Communication error,
Error message from "BRCV" cou‐
pling blocks
BOOL FALSE
QREQ_ERR Error ID of OS, 0 = No errors BOOL FALSE
QDATA_EN 1 = Auxiliary data cell active BOOL FALSE
QUA_ST Output structure UDT_UA_R_ST
QREQ_ID ID of the requesting block INT 0
QARCH_NA Archive name STRING[16] ''
QARCH_NO Archive number DINT 0
QREC_ID Record number in the user archive DINT 0
QNO_REC Number of rows to be read DINT 0
QCOLUMN Column number at which reading
commences;
0 = Entire row
DINT 0
QNO_COL Number of columns to be read DINT 0
QOFFSET Offset, application-specific value DINT 0
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
16 Function Manual, 07/2016, A5E38719883-AA

Parameter Description Type Default
QCAL_LEN Data length calculated in the OS
script,
application-specific value
DINT 0
QMSG_SUP ALARM_8P: 1=Message suppres‐
sion active
BOOL FALSE
QMSG_ERR ALARM_8P: ERROR BOOL FALSE
MSG_STAT ALARM_8P: STATUS WORD 0
MSG_ACK ALARM_8P: ACK_STATE WORD 0
QBR1_ERR BRCV 1 ERROR BOOL FALSE
QBR1_NDR BRCV 1 NDR BOOL FALSE
QBR1_STA BRCV 1 STATUS WORD 0
QBR1_LEN BRCV 1 LEN WORD 0
QBR2_ERR BRCV 2 ERROR BOOL FALSE
QBR2_NDR BRCV 2 NDR BOOL FALSE
QBR2_STA BRCV 2 STATUS WORD 0
QBR2_LEN BRCV 2 LEN WORD 0
REQ_ID ID of the requesting block INT 0
ARCH_NA Archive name STRING[16] ''
ARCH_NO Archive number DINT 0
REC_ID Record number in the user archive DINT 0
NO_REC Number of rows to be read DINT 0
COLUMN Column number at which reading
commences;
0 = Entire row
DINT 0
NO_COL Number of columns to be read DINT 0
WM_ID ID of the FB_UA_WM,
used with parameter management
to recalculate parameters;
INT 0
PARA_1 Associated value 1 for read job,
application-specific value
DINT 0
PARA_2 Associated value 2 for read job,
application-specific value
DINT 0
PARA_3 Associated value 3 for read job,
application-specific value
DINT 0
PARA_4 Associated value 4 for read job,
application-specific value
REAL 0.0
PARA_5 Associated value 5 for read job,
application-specific value
REAL 0.0
PARA_6 Associated value 6 for read job,
application-specific value
REAL 0.0
DATA_1
…
DATA_50
Auxiliary data cell (1 to 50) for read
job,
application-specific data
DWORD 0
QREQ_TYP Type ID of the requesting block INT 0
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 17

Parameter Description Type Default
QPRI_MIN Lowest priority index allocated INT 0
QPRI_MAX Higher priority index allocated INT 0
QPRI_ACT Number of highest-priority request INT 0
QPRI_IND Next priority index to be allocated INT 0
QGEN_OS Target generation version DWORD DW#16#0
GEN_AS Generation version DWORD DW#16#0
In/out parameters
The following table shows the in/out parameters of the "FB_UA_RM" block:
Parameter Description Type Default
REC_REQ 1 = OS read job active BOOL FALSE
RESET 1 = Reset read interface BOOL FALSE
REQ_ERR OS script error ID DINT 0
OS_TRIG OS trigger INT 0
Archive designation (transferred from requesting block)
The archive designation comprises the archive name and the archive number in the following
format:
"ARCH_NA"_"ARCH_NO"
Example:
ARCH_NA = "FB_MATERIAL" and ARCH_NO = "1"
This produces the archive designation "FB_MATERIAL_001" (the archive number is always 3-
digit).
If the archive designation comprises only the archive name, a "0" is entered for the "ARCH_NO"
parameter.
Column specification (COLUMN and NO_COL) (transferred from requesting block)
If the value of the "COLUMN" is equal to "0", the entire row is read. In this case, the value of
the "NO_COL" parameter is irrelevant.
If the value of the "COLUMN" is greater than "0", data are read starting from the column
specified. In this case, the value of the "NO_COL" parameter must be greater than "0".
Auxiliary data cell (transferred from requesting block)
The application-specific auxiliary data cell is activated with the "DATA_EN" parameter.
When "DATA_EN" = "1", the bytes configured with the "DATA" pointer (a max. of 200) are
entered in the communication interface to the OS as 50 "DWORD". The communication
interface to the OS consists of the AS outputs "DATA_1" to "DATA_50".
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
18 Function Manual, 07/2016, A5E38719883-AA

2.1.4 Error handling
Errors occurring in the block are signaled via the integrated "ALARM_8P" block, and are
entered in the output structure or displayed at digital outputs of the block. They can be analyzed
by the requesting block on the basis of the output structure. The error bits are available at the
block as output signals. The request signal "REC_REQ" must be canceled by the requesting
block if an error occurs. This confirms receipt. No additional read jobs can be processed until
the "REC_REQ" request signal has been canceled.
The following error messages can be generated:
Output structure Output Message text Meaning
QERR QERR QERR RCV UA "arch_na""arch_no"
ID "req_id" REC_ID "rec_id" NO
"no_rec" COL "column"/"no_col"
Requested data and read data do
not match
QARCHERR QARCHERR QARCHERR RCV UA
"arch_na""arch_no" ID "req_id"
REC_ID "rec_id" NO "no_rec" COL
"column"/"no_col"
Archive error, invalid data in the re‐
ceive buffer or a script error in the
OS
QCOM_ERR QCOM_ERR QCOM_ERR RCV UA communica‐
tion error
Communication error, error mes‐
sage from "BRCV" coupling blocks
QBR1_ERR QBR1_ERR communication error Error message from first "BRCV"
coupling block
QBR2_ERR QBR2_ERR communication error Error message from second
"BRCV" coupling block
QPARAMF QPARAMF QPARAMF RCV UA ID/R_ID incor‐
rect
Parameter assignment error, incor‐
rect ID_1, R_ID_1 or ID_2, R_ID_2
Multiple QPARAMF RCV UA "req_id"
IDs
Parameter assignment error, dupli‐
cate REQ_ID
2.1.5 Messaging
The block uses the "ALARM_8P" block to generate messages. Following CPU startup,
messages are suppressed (QMSG_SUP = 1) until the "RUNUPCYC" cycles have elapsed.
The following process control messages can be generated:
Message Message class Event Message text
SIG_1 AS process control
Message - error
Parameter assignment error, incorrect
ID_1, R_ID_1 or ID_2, R_ID_2
$$BlockComment$$ QPARAMF RCV
UA ID/R_ID incorrect
SIG_2 AS process control
Message - fault
Communication error, error message
from "BRCV" coupling blocks
$$BlockComment$$ QCOM_ERR RCV
UA communication error
SIG_3 AS process control
Message - fault
Archive error, invalid data in the receive
buffer or a script error in the OS
$$BlockComment$$ QERR RCV UA
@4%s@@5%d@ ID @8%d@ REC_ID
@9%d@ NO @10%d@ COL @6%d@/
@7%d@
SIG_4 AS process control
Message - fault
requested data and read data do not
match
$$BlockComment$$ QARCHERR RCV
UA @4%s@@5%d@ ID @8%d@
REC_ID @9%d@ NO @10%d@ COL
@6%d@/@7%d@
Communication
2.1 FB_UA_RM
Advanced Process Functions (APF)
Function Manual, 07/2016, A5E38719883-AA 19

Message Message class Event Message text
SIG_5 AS process control
Message - error
Parameter assignment error, duplicate
REQ_ID
$$BlockComment$$ QPARAMF RCV
Multiple UA @8%d@ IDs
SIG_6 AS process control
Message - fault
QBR1_ERR $$BlockComment$$ QBR1_ERR com‐
munication error
SIG_7 AS process control
Message - fault
QBR2_ERR $$BlockComment$$ QBR2_ERR com‐
munication error
SIG_8 No message - -
The following keywords are used:
● $$BlockComment$$: This keyword inserts the instance-specific block comment before the
message text.
● $$HID$$ source
● $$AREA$$: OS_AREA
The following associated values are used:
Associated value Format Value
SD_1 -
SD_2 -
SD_3 -
SD_4 @4%s@ ARCH_NA
SD_5 @5%d@ ARCH_NO
SD_6 @6%d@ COLUMN
SD_7 @7%d@ NO_COL
SD_8 @8%d@ REQ_ID
SD_9 @9%d@ REC_ID
SD_10 @10%d@ NO_REC
2.2 FB_UA_WM
2.2.1 Description
Object properties
The following table shows the object properties of the "FB_UA_WM" block:
Name Number Family Module
FB_UA_WM FB1776 APF Communication
Communication
2.2 FB_UA_WM
Advanced Process Functions (APF)
20 Function Manual, 07/2016, A5E38719883-AA