SI AMD FCT Man 0718 en-US

Foreword
Fundamental safety
instructions 1
Introduction 2
SINUMERIK
Direct access to NC/PLC 3
SINUMERIK Integrate
Access MyData (AMD)
Access to tool information 4
Access to NC program data 5

Function Manual
Project information A
Valid for:
Control system
SINUMERIK 840D, SINUMERIK 840D sl / 840DE sl
Software
SINUMERIK Integrate, version 4.1 SP8
Access MyData, version 1.0 SP6
07/2018
A5E36812654B AD
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 A5E36812654B AD Copyright © Siemens AG 2015 - 2018.

Division Digital Factory Ⓟ 07/2018 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Foreword
SINUMERIK documentation
The SINUMERIK documentation is organized into the following categories:
● General documentation/catalogs
● User documentation
● Manufacturer/service documentation
Additional information
You can find information on the following topics at the following address (https://
support.industry.siemens.com/cs/de/en/view/108464614):
● Ordering documentation/overview of documentation
● Additional links to download documents
● Using documentation online (find and search in manuals/information)
If you have any questions regarding the technical documentation (e.g. suggestions,
corrections), please send an e-mail to the following address
(mailto:docu.motioncontrol@siemens.com).
mySupport/Documentation
At the following address (https://support.industry.siemens.com/My/ww/en/documentation),
you can find information on how to create your own individual documentation based on
Siemens' content, and adapt it for your own machine documentation.
Training
At the following address (http://www.siemens.com/sitrain), you can find information about
SITRAIN (Siemens training on products, systems and solutions for automation and drives).
FAQs
You can find Frequently Asked Questions in the Service&Support pages under Product
Support (https://support.industry.siemens.com/cs/de/en/ps/faq).
SINUMERIK
You can find information about SINUMERIK at the following address (http://www.siemens.com/
sinumerik).
Access MyData (AMD)

Function Manual, 07/2018, A5E36812654B AD 3
Foreword
Target group
This publication is intended for:
● Project engineers
● Technologists (from machine manufacturers)
● System and machine commissioning engineers
● Programmers
● Software developers who develop their own product functions and want to exchange NC
or PLC data with the lower-level machine tools via the SI server.
Benefits
The function manual describes the functions so that the target group knows them and can
select them. It provides the target group with the information required to implement the
functions.
Standard scope
This documentation only describes the functionality of the standard version. Additions or
revisions made by the machine manufacturer are documented by the machine manufacturer.
Other functions not described in this documentation might be executable in the control. This
does not, however, represent an obligation to supply such functions with a new control or when
servicing.
For the sake of simplicity, this documentation does not contain all detailed information about
all types of the product and cannot cover every conceivable case of installation, operation, or
maintenance.
Note regarding the General Data Protection Regulation

Siemens respects the principles of data privacy, in particular the data minimization rules
(privacy by design). For SINUMERIK Integrate products this means:
The products process the following personal data: Name, first name, email address, telephone
number. It does not involve data from the personal or private sphere. The above mentioned
data is required for the access restriction function (login). The data saved is limited to the
absolute minimum as this is absolutely necessary to make a differentiation between access
rights and notification. The above-mentioned data cannot be saved with anonymity or with
pseudo-anonymity as the objective of differentiating access rights would not be possible. Our
products do not automatically delete the data mentioned above. If necessary, this data can be
deleted in the corresponding user administration. If you have any questions, then please
contact our customer support organization.
Technical Support
Country-specific telephone numbers for technical support are provided in the Internet at the
following address (https://support.industry.siemens.com/sc/ww/en/sc/2090) in the "Contact"
area.
Access MyData (AMD)

4 Function Manual, 07/2018, A5E36812654B AD
Foreword
Security information on the product
NOTICE
Misuse of data
It is essential to use secure data storage when saving your data - particularly your confidential
data. It is best to store this data encrypted locally or encrypted on the network. Make sure
that this data cannot be accessed by unauthorized personnel.
This applies to the following data:
● Archive files
● Image files
● Project files
● Trace files
● Safety-relevant files
Further information on secure data storage can be found at Industrial Security Configuration
Manual (https://support.industry.siemens.com/cs/us/en/view/108862708).
NOTICE
Danger due to insecure Internet connection
Before establishing a network connection, ensure your PC is connected to the Internet via a
secure connection. Pay attention to the security-relevant notes. Further information about
communications security can be found at Industrial Security Configuration Manual (https://
support.industry.siemens.com/cs/us/en/view/108862708).
NOTICE
Security risk through administrator rights
If you operate a PC with permanent administrator rights, there is an increased security risk.
Therefore, ensure that there is a secure operating environment, and assign administrator
rights only temporarily and selectively.
Further information on the secure administration of user accounts and the assignment of
rights can be found at Industrial Security Configuration Manual (https://
support.industry.siemens.com/cs/us/en/view/108862708).
EC Declaration of Conformity
The EC Declaration of Conformity for the EMC Directive can be found on the Internet at the
following address (https://support.industry.siemens.com/cs/https://
support.industry.siemens.com/cs/ww/de/ps/14604/certww/en/ps/13231/cert).
Access MyData (AMD)

Foreword
Access MyData (AMD)

Table of contents
Foreword......................................................................................................................................................3
1 Fundamental safety instructions.................................................................................................................11
1.1 General safety instructions.....................................................................................................11
1.2 Warranty and liability for application examples......................................................................12
1.3 Industrial security...................................................................................................................13
2 Introduction.................................................................................................................................................15
2.1 Requirement...........................................................................................................................17
3 Direct access to NC/PLC............................................................................................................................19
3.1 Introduction............................................................................................................................19
3.1.1 Direct access to NC/PLC.......................................................................................................19
3.2 Concept..................................................................................................................................20
3.2.1 Overview................................................................................................................................20
3.2.2 Activate interface....................................................................................................................20
3.2.3 Deactivate interface...............................................................................................................22
3.3 Service interfaces...................................................................................................................23
3.3.1 Machine Admin Service Interface..........................................................................................23
3.3.2 Basic Data Access Service Interface.....................................................................................23
3.3.2.1 Introduction............................................................................................................................23
3.3.2.2 Basic Data Access Service Interface.....................................................................................26
3.3.2.3 Basic Data Configuration Service Interface...........................................................................26
3.3.2.4 Direct Data Access Service Interface.....................................................................................28
3.3.2.5 Direct Data Access Callback Service.....................................................................................29
3.3.3 Machinestatus Service Interface............................................................................................29
3.3.4 ServerSideSynchronisation Service Interface........................................................................30
4 Access to tool information..........................................................................................................................31
4.1 Introduction............................................................................................................................31
4.2 Basic information....................................................................................................................32
4.2.1 Web service interface.............................................................................................................32
4.2.2 Error messages......................................................................................................................32
4.2.2.1 Handling errors.......................................................................................................................32
4.2.2.2 Error message logs................................................................................................................33
4.2.2.3 Data is illogical or contains errors..........................................................................................33
4.2.2.4 Error codes.............................................................................................................................33
4.3 Certification............................................................................................................................35
4.4 Interface functions..................................................................................................................36
4.4.1 Protocol for reading/writing/changing data - MMT.................................................................36
4.4.1.1 Readout of the MMT configuration (Action 101)....................................................................36
4.4.1.2 Subscribe to tool transfer (Action 103)...................................................................................38
4.4.1.3 Read out tool container assignment "all parameters" (action 107)........................................40
Access MyData (AMD)

Table of contents
4.4.1.4 Read out tool container assignment (Action 108)..................................................................44

4.4.1.5 Read out tool node (Action 109)............................................................................................47
4.4.1.6 Add/change external data (Action 114)..................................................................................49
4.4.1.7 Read out actual tool data via tool identifier/DuploNo. (Action 115)........................................50
4.4.1.8 Read out actual tool data via ExternalId (Action 116)............................................................55
4.4.1.9 Import tool dataset (Action 117).............................................................................................60
4.4.1.10 Delete tool (Action 119)..........................................................................................................62
4.4.1.11 Read out master data overview (Action 120) ........................................................................63
4.4.1.12 Read out master data set (Action 121)..................................................................................64
4.4.1.13 Delete master data set (Action 122).......................................................................................66
4.4.1.14 Create/change master data set (Action 123).........................................................................67
4.4.1.15 Set master data set (Action 124)............................................................................................70
4.4.1.16 Read out tool plan (Action 131)..............................................................................................71
4.4.1.17 Delete tool plan (Action 132)..................................................................................................72
4.4.1.18 Create/change tool plan (Action 133).....................................................................................73
4.4.1.19 Read out tool plan overview (Action 134)..............................................................................74
4.4.1.20 Read out setting list (Action 141)...........................................................................................75
4.4.1.21 Set reservation ID (Action 142)..............................................................................................76
4.4.1.22 Perform single handling (Action 162).....................................................................................78
4.4.1.23 Read out machining sequences (Action 170)........................................................................80
4.4.1.24 Create/change machining sequence (Action 171).................................................................81
4.4.1.25 Disable/enable machining sequences (Action 172)...............................................................82
4.4.1.26 Delete machining sequences (Action 173).............................................................................83
4.4.1.27 Move machining sequence (Action 174)................................................................................83
4.4.2 Protocols for reading/writing/changing data - SFI..................................................................84
4.4.2.1 Presetting list (GET)...............................................................................................................84
4.4.2.2 Presetting list (GET) {invNO}.................................................................................................85
4.4.2.3 Presetting data (PUT)............................................................................................................89
4.4.2.4 Measuring programs (GET)...................................................................................................91
4.4.2.5 Measuring programs (PUT)....................................................................................................93
4.5 Example sequence Action 108...............................................................................................95
4.6 Project information.................................................................................................................98
4.6.1 Description of SINUMERIK tool parameter............................................................................98
4.6.2 Description of Teamcenter tool parameters.........................................................................101
4.6.3 Description of the SFI tolerance values...............................................................................111
4.6.3.1 Tolerance values and calculation.........................................................................................111
4.6.3.2 Input.....................................................................................................................................112
4.6.4 Transforming catalog data into the SINUMERIK 840D format.............................................113
4.6.4.1 Adapting catalog data project-specifically............................................................................113
4.6.4.2 Tool parameters...................................................................................................................114
4.6.4.3 Cutting edge parameters......................................................................................................115
4.6.4.4 Cutting edge-related tool monitoring parameters.................................................................116
4.6.4.5 External user parameters.....................................................................................................116
5 Access to NC program data.....................................................................................................................119
5.1 Introduction..........................................................................................................................119
5.2 Concept................................................................................................................................120
5.2.1 Requirement.........................................................................................................................120
5.2.2 Activate interface..................................................................................................................120
5.2.3 Deactivate interface.............................................................................................................120
Access MyData (AMD)

Table of contents
5.3 Description of the interfaces.................................................................................................121

5.4 The type of a machine..........................................................................................................123
5.5 Terms...................................................................................................................................131
5.6 Programs on the machine....................................................................................................135
5.7 The settings of the transfer..................................................................................................136
5.8 Information about the machines...........................................................................................137
5.9 The capabilities of a machine...............................................................................................138
5.10 Test program........................................................................................................................139
A Project information....................................................................................................................................149
A.1 List of abbreviations.............................................................................................................149
Access MyData (AMD)

Table of contents
Access MyData (AMD)

Fundamental safety instructions 1
1.1 General safety instructions
WARNING
Danger to life if the safety instructions and residual risks are not observed
If the safety instructions and residual risks in the associated hardware documentation are not
observed, accidents involving severe injuries or death can occur.
● Observe the safety instructions given in the hardware documentation.
● Consider the residual risks for the risk evaluation.
WARNING
Malfunctions of the machine as a result of incorrect or changed parameter settings
As a result of incorrect or changed parameterization, machines can malfunction, which in turn
can lead to injuries or death.
● Protect the parameterization (parameter assignments) against unauthorized access.
● Handle possible malfunctions by taking suitable measures, e.g. emergency stop or
emergency off.
Access MyData (AMD)

Fundamental safety instructions
1.2 Warranty and liability for application examples
1.2 Warranty and liability for application examples

Application examples are not binding and do not claim to be complete regarding configuration,
equipment or any eventuality which may arise. Application examples do not represent specific
customer solutions, but are only intended to provide support for typical tasks.
As the user you yourself are responsible for ensuring that the products described are operated
correctly. Application examples do not relieve you of your responsibility for safe handling when
using, installing, operating and maintaining the equipment.
Access MyData (AMD)

1.3 Industrial security
Note
Industrial security
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 constitute one element of such a concept.
Customers are responsible for preventing unauthorized access to their plants, systems,
machines and networks. Such systems, machines and components should only be connected
to an enterprise network or the Internet if and to the extent such a connection is necessary
and only when appropriate security measures (e.g. firewalls and/or network segmentation) are
in place.
For additional information on industrial security measures that may be implemented, please
visit:
Industrial security (http://www.siemens.com/industrialsecurity)
Siemens’ products and solutions undergo continuous development to make them more secure.
Siemens strongly recommends that product updates are applied as soon as they are available
and that the latest product versions are used. Use of product versions that are no longer
supported, and failure to apply the latest updates may increase customer’s exposure to cyber
threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS
Feed at:
Industrial security (http://www.siemens.com/industrialsecurity)
Further information is provided on the Internet:

Industrial Security Configuration Manual (https://support.industry.siemens.com/cs/ww/en/
view/108862708)
Access MyData (AMD)

WARNING
Unsafe operating states resulting from software manipulation
Software manipulations (e.g. viruses, trojans, malware or worms) can cause unsafe operating
states in your system that may lead to death, serious injury, and property damage.
● Keep the software up to date.
● Incorporate the automation and drive components into a holistic, state-of-the-art industrial
security concept for the installation or machine.
● Make sure that you include all installed products into the holistic industrial security concept.
● Protect files stored on exchangeable storage media from malicious software by with
suitable protection measures, e.g. virus scanners.
● Protect the drive against unauthorized changes by activating the "know-how protection"
drive function.
Access MyData (AMD)

Introduction 2
Overview
SINUMERIK Integrate Access MyData is an open, flexible software interface and enables the
data exchange between SINUMERIK Integrate applications and higher-level software systems.
SINUMERIK Integrate Access MyData provides data and services for higher-level or
supplementary software systems for this specific purpose. The basis for this is standardized
web services, e.g. on the basis of Microsoft .NET Windows. Communication Foundation
(WCF). The software interface Access MyData is provided by the SINUMERIK Integrate server
and is divided into functional modules.
+LJKHUOHYHORUVXSSOHPHQWDO
)OH[LEOH $XWRPDWHG VRIWZDUHV\VWHP
$FFHVVWRGDWDRIWKH&1&VYLD,QWHJUDWH6HUYHU SURGXFWLRQ
$FFHVVWRGDWDDQGVHUYLFHVRIWKH6,180(5,.,QWHJUDWH
DSSOLFDWLRQV
:HE6HUYLFHV
(DV\WRXVH 6,180(5,.
,QWHJUDWH6HUYHU ]%0LFURVRIW1(7
8VHRILQWURGXFHG:HE6HUYLFHWHFKQRORJLHV
:&)WHFKQRORJ\
,QGXVWULDOVWDQGDUGVRIWKH:RUOG:LGH:HE&RQVRUWLXP
,QGXVWULDO
(IILFLHQWDQGVHFXUH (WKHUQHW
8WLOL]DWLRQRIWKHH[LVWLQJ6,180(5,.,QWHJUDWHFOLHQWVHUYHU
LQVWDOODWLRQZLWKRXWDGGLWLRQDOKDUGZDUHLQWHUIDFHV
6,180(5,.,QWHJUDWH&OLHQWV
The principle of Access MyData can be summarized as follows:

● Communications interface between higher-level or supplementary software systems and
a SINUMERIK Integrate server
● Defined, open communications interface in the form of standardized web services and
WSDL descriptions or XML via HTTP.
● Interface modules with selected functions for SINUMERIK Integrate applications:
– Access to tool information: Interface (requiring a license) to Manage MyTools (MMT)
– Access to NC program data: Interface (requiring a license) to Manage MyPrograms
(MMP)
– Direct access to NC/PLC: Interface to basic functions, including access to NC/PLC data
of the CNCs via the SINUMERIK Integrate server
Delivery form
The latest packages and further information on the applications are stored on PridaNet and
can be downloaded directly from there.
Access MyData (AMD)

Introduction
Additional software
SINUMERIK Integrate also uses the following software:
Software that was developed for "OpenSSL" in order to use the "OpenSSL Toolkit" (http://
www.openssl.org/ (http://www.openssl.org/)).
Software that was developed for "Openevidence" in order to use the "OpenEvidence Toolkit"
(http://www.open-evidence.com/about/). (http://www.open-evidence.com/about/)
Cryptographic software written by Eric Young (eay@cryptsoft.com (eay@cryptsoft.com)).
Software written by Tim Hudson (tjh@cryptsoft.com). (tjh@cryptsoft.com)
Software developed by Bodo Moeller.
Access MyData (AMD)

Introduction
2.1 Requirement
2.1 Requirement
They must be installed and configured in order to user the Web service interfaces.
A further requirement is that the user is familiar with the Manage MyPrograms (MMP), Manage
MyTools (MMT) and Shop Floor Integrate (SFI) applications and has sufficient knowledge in
programming of Web service interfaces (HTTP/XML).
The "Access to tool information" interface is activated by the setup, see the documentation:
SINUMERIK Integrate MMP, MMT, AMC, AMP, AMM/E, AMD Installation Manual, Section:
AMD access to tool information.
Access MyData (AMD)

Introduction
2.1 Requirement
Access MyData (AMD)

Direct access to NC/PLC 3
3.1 Introduction
This section describes an external interface of SINUMERIK Integrate (SI).
An introduction of the SI server and the underlying data structures (domain, organizations,
machines, control monitors, variable monitors, triggers, events, etc.) would exceed the scope
of this document, we therefore refer you to the documentation that is available on the SI server
installation CD. These documents contain important information and explanations, which are
required for understanding and using the web service interface.
The general manuals can be found under:
\Documentation\de for German documentation or
\Documentation\en for English documentation.
Note
The interface for direct access to NC/PLC is being continually enhanced.
3.1.1 Direct access to NC/PLC

The infrastructure services provided by the SI server as a web service are part of the product
SINUMERIK Integrate Access MyData (AMD).
● The interface for direct access to NC/PLC identifies the web services that are published
free of charge. These are not explicitly indicated in the following chapters.
① Access to NC and PLC data

② Machine online detection, application state, system messages
③ Reading of the list of machines/nodes/GUID, no editing/creating/deleting
Access MyData (AMD)

Direct access to NC/PLC
3.2 Concept
3.2 Concept
The following chapters describe in an overview how the API interface functions and which
items are involved in the function and which must be configured, if applicable.
Note
Interface also on SINUMERIK Integrate server (SI server)
The AMD interface "Direct access to PC/PLC" is only available locally on the SI server (IIS/
localhost). The customer application that uses the AMD interface must also be on the SI server.
3.2.1 Overview
All of the functions described here for using the new API interface are based on the Windows
Communication Foundation, or WCF for short.
The following basic packages are available. These are divided into task-specific sub-packages:
● Admin
Machine administration
● BasicServices
– BasicDataAccessService
New simplified data acquisition
– InfrastructureService
Machine status/synchronization
– BasicDataConfigurationServices
Configuration of basic data recordings
For licensing questions, please contact your Siemens sales representative.
3.2.2 Activate interface

The interface for direct access to NC/PLC is not active after installation. The corresponding
directories are not created as "Application" in the IIS during the installation. The WebServices
must first be activated in the IIS before the first use (default website / svc/ Api).
Access MyData (AMD)

3.2 Concept
Activate interface
To activate the AMD interfaces, you must convert the directory "Api" to an "Application" in the
IIS.
1. To do this, select the "Api" directory and open the shortcut menu with a right-click.
2. Select the entry "Convert to Application" in the shortcut menu.
Activate services
Then activate the required services following the same procedure:
'LUHFWDFFHVV
WR1&3/&
Access MyData (AMD)

3.2 Concept
3.2.3 Deactivate interface
Procedure
To deactivate the AMD interfaces, the "application" must be deleted from the IIS.
1. To do this, select the directory "Api" and open the shortcut menu with a right-click.
2. Select the entry "Remove" in the shortcut menu.
The individual services under "Api" are deactivated according to the same principle.
Access MyData (AMD)

3.3 Service interfaces

The individual interfaces of the services are listed below. The description of the call-up
parameters or return values has been omitted at this point to enhance the overview. This can
be found in exhaustive detail with example codes in the corresponding interface file.
3.3.1 Machine Admin Service Interface

Provides access to machine master data to receive information on the runtime of machines.
Namespace: Siemens.ISB.Interfaces.MachineAdmin
Interface: IMachineAdmin
Name Description
List<Machine> Contains the list of the machines which are
GetMachines(string domainName, available for the defined domain. The domain
MachineResultDesc machResult) must be provided in the parameter
domainName
Machine GetMachine (string Contains the master machine data of the ma‐
domainName, MachineIdentifier chine defined with machineId. The domain
machineId, MachineResultDesc must be provided in the parameter
machResult) domainName The machine must be available
for the domain that is defined in the parameter
domainName.
Machine GetMachineByName (string Contains the master machine data of the ma‐
domainName, string chine defined with machineName. The domain
machineNameOEM, string must be provided in the parameter
organizationName, domainName The machine must be available
MachineResultDesc machResult) for the domain that is defined in the parameter
domainName.
3.3.2 Basic Data Access Service Interface
3.3.2.1 Introduction
Introduction
This chapter contains an introductory description of how the SI server itself records the data
before making it available via the AMD interface.
Three types of data recording are available on the controller:
● Recording of data whenever there is a change
● Recording of data in a time cycle (every x seconds)
● Synchronized recording of data. The recording is initiated by setting a synchronization
value. After the recording, the system automatically resets the synchronization value.
Access MyData (AMD)

Note
No notification service (subscription, hotlink) is available to the end user in the AMD interface.
A monitoring function can be configured between the client and server via AMD for collecting
data. The end user must read the results via the AMD interface either cyclically or as needed.
The recorded values are forwarded within the client to a client channel. The configuration of
the corresponding client channel defines whether data will be buffered in the event the server
connection is lost and how large the buffer should be, if applicable.
The client channel ultimately ensures the transfer of data to the server. There, the data is
entered into a server channel, depending on the configuration of the corresponding data
recording. Data from different machines can be entered into one and the same server channel
if the configuration of the corresponding data recordings on different machines contains the
same server channel as the destination.
Via the server channel, the data can be called and, if applicable, marked as processed via an
application on the SI server interface.
The individual data recordings define the following:
● When a recording is to be made (when there is a change, cyclically, synchronized)
● What data is to be recorded (addresses in BTSS syntax)
● The client channel via which the data is to be transported to the server
● The server channel in which the data will be entered
In addition to recording the user data, the individual elements of the simplified data recording
provide system variables, which can be recorded in addition to user data. This system data
encompasses:
General machine-related data
● Machine was switched on/off
● Machine goes offline/online
● Machine was synchronized
● Machine configurations were changed – the machine is no longer synchronized
● Application and synchronization status of the machine (OK/Warning/Error respectively)
Client channel
Client channels are used to transfer recorded data to the server. Among other things, they
have buffer mechanisms, via which data can be temporarily saved when the connection to the
server is lost.
Access MyData (AMD)

Server channel
Server channels are used for storing the recorded data until it is processed. A user can
configure how long the data is to be stored:
● Delete unprocessed data after ... (time period)
● Delete processed data after ... (time period)
● Maximum number of values in the server channel
Recording in the event of a change (OnChange Recording)

Via OnChange Recording, the values of individual variables of the controller can be recorded
when the corresponding value changes.
OnChange Recording provides the following functions:
● Recording each time a value is changed
● Recording if the value of the last recorded value differs by a minimum interval
● After a successful recording, there is a waiting period, within which no other values for the
same variable are recorded.
● Optimized recording (only one hotlink per address, even across domains)
Synchronized recording of data (Synchronized Recording)

The synchronized recording of values allows the recording of one or more values via a
synchronization variable.
The system waits until the synchronization variable assumes a configured value. Then the
system reads out the configured values and transfers them in a block to the configured client
channel. The system then resets the synchronization variable to a different configured value
so that the PLC, for example, can set new values.
The synchronized readout has a safety mechanism, which, if the hotlink does not detect the
configured start value for the reading process, ensures that the system still starts the readout
after 20 seconds at the latest, and then resets the synchronization variable. This is to prevent
the synchronized readout from "stopping" when there is a single failure of the hotlink.
Synchronized Recording provides the following functions:
● Configurable synchronization variable
● Start value for readout procedure can be configured
● Value set after the readout procedure has finished becomes configurable
● Transfer of all of the values read in a procedure for performance optimization
● Recording of values only if they differ from the last read value by at least a notable interval
● Automatic compilation of fragmented read-out values within a readout procedure for a bit
array
Cyclic recording of values (Cyclic Recording)

One or more values are cyclically recorded every n seconds.
Access MyData (AMD)

Cyclic Recording provides the following functions:

● Transfer of all of the values read in a procedure for performance optimization
● Recording of values only if they differ from the last read value by at least a configurable
interval
● Automatic compilation of fragmented read-out values within a readout procedure for a bit
array
Direct Data Access

In addition to the previously described functions for recording data in the background, the
simple data recording provides functions for the "online" reading and writing of variables in the
controller. Internally, the function uses the "Direct Communication" infrastructure.
Direct Data Access provides the following functions:
● Synchronous reading of variables (latency period for Direct Communication via semaphore)
● Asynchronous reading with notification via WCF web service interface when the read
procedure has completed
● Synchronous writing of variables (latency period for Direct Communication via semaphore)
● Asynchronous writing with notification via WCF web service interface when the write
procedure has completed
In order to be able to use all of the functions of the simple data recording, the SI server must
be configured accordingly. The configuration can be done with the aid of the Basic Data
Configuration Service Interface, which is displayed in the following section.
3.3.2.2 Basic Data Access Service Interface

Use this interface to access saved data.
Namespace: Siemens.ISB.Interfaces.BasicServices.BasicDataAccess
Interface: IBasicDataAccess
Name Description
ChannelData ReadData (string Depicts the data of a specified server channel
domainName, string serverChannel, beginning at a defined start ID.
Int64 startId, int maxCount)
long GetLastId(string domain Name, Shows the ID of the last data entry in a server
string serverChannel) channel.
void SetProcessedLine(string Defines the data process line, so that the serv‐
domainName, string serverChannel, er can delete processed data of a server chan‐
Int64 lastProcessedId) nel.
3.3.2.3 Basic Data Configuration Service Interface

Use this interface to configure basic data recordings.
Access MyData (AMD)

Interface: IBasicDataConfiguration
Name Description
void Defines the server channels for a specific do‐
DefineServerDataChannels(string main. Replaces the existing configuration with
domainName, a new one. Old configuration is deleted.
List<ServerDataChannelConfig>
channels)
List<ServerDataChannelConfig> Receipt of the server channel configuration for
GetServerDataChannels(string a domain.
domain- Name)
void DefineClientDataChannels Defining the client channel for a machine within
(string domainName, a domain.
MachineIdentifier machineId,
List<ClientDataChannelConfig>
channels)
List<ClientDataChannelConfig> Receipt of the configured client channel for a
GetClientDataChannels(string defined machine within a domain.
domainName, MachineIdentifier
machineId)
void DefineDataRecordings(string Defining the configuration for data recordings
do- mainName, MachineIdentifier for a defined machine and domain. The exist‐
machineId, ing configuration is overwritten with the new
List<DataRecordingConfig> one.
recordings) Note:
No more than five recordings may be defined
for machines with HMI-Advanced.
List<DataRecordingConfig> GetData- Receipt of the data recording configuration for
Recordings a defined machine within a domain.
(string domainName,
MachineIdentifier machineId)
void Defines the configuration for recordings of sys‐
DefineSystemMachineVariableRe- tem machine variables in a specific domain for
cordings a specific machine. Here, a user can define the
(string domainName, server channel in which the system machine
MachineIdentifier machineId, variables are sent. The existing configuration
for the machine and domain is overwritten.
List<SystemMachineVariableRecordin
g> recordings)
List<SystemMachineVariableRecordin Receipt of the system machine variable config‐
g> uration for a defined machine within a domain.
GetSystemMachineVariableRecordings
(string domainName,
void DefineClientJobNotifications Defines the configuration for recordings of sys‐
(string domainName, tem machine variables in a specific domain for
MachineIdentifier machineId, a specific machine. Here, a user can define the
List<ClientJobNotificationConfigur client channel in which the system machine
ation> configuration) variables are provided. The existing configura‐
tion for the machine and domain is overwritten.
Access MyData (AMD)

Name Description
List<ClientJobNotificationConfigur Receipt of the system machine variable config‐
ation> GetClientJobNotifications uration for a defined machine within a domain.
(string domainName,
BasicDataAccessMachineConfiguratio Receipt of the machine configuration for basic
n GetMachineConfiguration data access for a specific domain within a ma‐
(string domainName, chine.
void DefineMachineConfiguration Defining the machine configuration for basic
(string domainName, data access for a specific domain within a ma‐
MachineIdentifier machine- chine.
Id,BasicDataAccessMachineConfigura
tion configuration)
3.3.2.4 Direct Data Access Service Interface

Via this interface, you can conduct activities for the direct variable access on a machine.
Interface: IDirectDataAccess
Name Description
bool IsDirectDataAccessAvailable() Shows whether the SI server supports direct
variable access.
DirectDataAccessResult Synchronous writing of a variable on the ma‐
WriteToDevice (string domainName, chine.
MachineIdentifier machineId,
string address, RecordingDataType
dataType, string value, TimeSpan
timeout)
Guid WriteToDeviceAsync (string Asynchronous writing of a variable on the ma‐
domainName, MachineIdentifier chine.
machineId,string address,
RecordingDataType dataType,
string value, string
callbackUrl,TimeSpan timeout)
DirectDataAccessResult Synchronous reading of a variable from the
ReadFromDevice (string domainName, machine.
achineIdentifier machineId,
string address, RecordingDataType
dataType, TimeSpan timeout)
Guid ReadFromDeviceAsync (string Asynchronous reading of a variable from the
domainName, MachineIdentifier machine.
machineId,string address,
RecordingDataType dataType,
string callbackUrl, TimeSpan
timeout)
Access MyData (AMD)

Note
Reading or writing of bin blocks on HMI-Advanced
After a new installation of HMI-Advanced on Windows XP or an upgrade, the integrated
OPC server of the HMI-Advanced might no longer function correctly.
As a result, the methods "WriteToDevice" or "ReadFromDevice" no longer function in the
described interface. The user cannot write bin blocks anymore.
The OPC server of the HMI-Advanced must be set to an operational state again. Advanced
Windows expertise is required for these steps. Execute the following steps as administrator:
1. Check whether the file "MCVar.dll" exists in the directory "F:\mmc2". If the file is missing,
reinstall HMI-Advanced using the "Repair" functionality in the Windows program list.
2. Use the "Regedit" tool to check whether the OPC server is registered in the Windows
registry (name: "OPC.Sinumerik.Machineswitch"). If this entry is missing, execute the
following command in the Windows command line to register the OPC server:
"F:\mmc2\opc\dataaccess\SOPC_MachineSwitch /RegServer"
3. Restart the HMI-Advanced after the changes.
3.3.2.5 Direct Data Access Callback Service

Via this interface, you are notified if a value for which you have set an asynchronous read
procedure has changed (direct variable access).
Interface: IDirectDataAccessCallback
Name Description
DirectDataAccessCompleted This method is called after an asynchronous
(DirectDataAccessResult result ) "direct variable access" call has been ended.
Objects of the type "DirectDataAccessResult"
contain the result of the call.
3.3.3 Machinestatus Service Interface

Use this interface to call up status information about machines in a domain.
Namespace: Siemens.ISB.Interfaces.BasicServices.InfrastructureService
Access MyData (AMD)

Interface: IMachineStatus
Name Description
List<MachineStatusInfo> Receipt of the status of all of the machines
GetMachineStatusAllMachines(string available in a domain.
domainName)
MachineStatusDetail Receipt of the detailed status of a specific ma‐
GetMachineApplicationStatus(string chine from a domain.
domainName, MachineIdentifier (not yet available)
machineId)
3.3.4 ServerSideSynchronisation Service Interface

An interface for initiating server-side synchronization
Namespace: Siemens.ISB.Interfaces.BasicServices.InfrastructureService
Interface: IServerSideSynchronization
Name Description
bool Initiating a sever-side synchronization.
TriggerServerSideSynchronization(s
tring domainName,
SynchronizationInfo Receipt of the synchronization information of
GetSynchronizationInfo(string the previously defined machine.
domainName, MachineIdentifier
machineId)
Access MyData (AMD)

Access to tool information 4
4.1 Introduction
This section describes an external interface of SINUMERIK Integrate (SI). The interface
described here provides external applications with access to functions and data from MMT,
e.g. for managing tool information. The interface is implemented as Web service.
The interface enables access to tool data and is part of the AMD (Access MyData) product.
The interface requires an operational SINUMERIK Integrate server and the operationally
installed Manage MyTools (MMT) or Shop Floor Integrate (SFI) application.
This Web service interface has several interfaces that allow clients access to the functionality
of this service; refer to "/amd/tools"; e.g. " ... /amd/tools/v1/PressettingList".
For further information, refer to the functions of MMT and SFI.
Access MyData (AMD)

Access to tool information
4.2 Basic information
4.2.1 Web service interface
The Web service interface uses the Hypertext Transfer Protocol for connecting to and
transferring data between the SI server and an external application. The functions are made
available within SINUMERIK Integrate (SI) by the MMT server. Therefore, an operational
MMT server is required in addition to an operational SI server.
4.2.2 Error messages
4.2.2.1 Handling errors

The AMD interface enables a type-based input value check for the backend and outputs the
following different error messages / actions. The following table contains an overview of the
actions and their causes, and provides recommendations for their remedy.
Overview
Action Message Causes and remedy

404 (Not found) Status code The function call is unknown under the URL used.
Error message Check the URL.
301 (Moved permanently) Status code If AMD tools are used with SFI RM installed, the Actions
Error message 117 and 141 are forwarded to another function call.
405 (Method not allowed) Status code The call of the method has not been enabled or is not
Error message permitted under the current configuration.
400 (Bad request) Status code The function call could not be executed.
Error message Check the parameters of the function call.
With each function call, the user is informed whether the execution Sends the request to the client:
was successful or if an error occurred. Status code and message, content type header, re‐
sponse body
504 (Gateway timeout) Status code The time for executing the function call has been ex‐
Error message ceeded.
502 (Bad gateway) Status code The required service cannot be accessed.
Error message The function cannot be executed.
500 (Internal server error) Status code An error occurred while executing the function.
Error message The detailed cause cannot be determined.
Access MyData (AMD)

4.2.2.2 Error message logs

The AMD interface signals its own errors. The error codes between 100 and 199 are directly
from the AMD interface.
If the AMD interface detects a problem with the URL request, the validation or backend
connection, and cannot send a response from the backend, an error is signaled.
The HTTP status of the error describes different error causes and is documented in the "Errors
of the AMD interface" area.
4.2.2.3 Data is illogical or contains errors
Response protocol
All errors are displayed in this format:
<Error errorCode="<ErrorCode>" errorMessage="<ErrorText>"/>
Note
errorCode error detection
If the clients use errorCode for the error detection, the error description is in English. This
message refers mainly to API users.
The error message must not contain any call tracking or exception details. UIs should use the
error code.
4.2.2.4 Error codes

The following table provides an overview of the error codes of the AMD interface.
Error Description Causes and remedy

code
101 Protocol violation The target lacks the content in <Body>.
Complete the content.
102 Internal server error An internal problem occurred in the service while exe‐
cuting the function.
103 Unexpected error An error occurred while executing the function.
The detailed cause cannot be determined.
104 Timeout for request Define the timeout in the "web.config" file of the AMD
The target URL does not respond within the specified interface.
time. ● Default setting: 30 s
<add key="ConnectionTimeout"
value="00:00:30"/>
105 Request failed The URL is incorrectly configured.
An error occurs when attempting to access the target Correct the URL.
URL.
106 Create request failed The URL is incorrectly configured.
The error occurs during the creation of the request. Correct the URL.
Access MyData (AMD)

Error Description Causes and remedy

code
107 Invalid request Check and correct the content of the request.
108 Invalid request on account of excessive size The request was rejected because the size in "body"
was exceeded.
Specify the size of the request:
● Characters
Default value: 20000 (characters)
<add key=”MaxCharactersInDocument”
value= ”20000”/>
● Bytes
Default value: 104857600 (100 MB)
<add key=”MaxRequestBodySizeInBytes”
value=”104857600”/>
109 Invalid request, no SSL The request was rejected because requests are sent
only via an HTTPS method.
110 Invalid request certification The request was rejected because there is no valid X509
certification.
Format the certificates correspondingly.
111 Illegal HTTP method The response was rejected because the HTTP method
is not permitted.
Valid HTTP methods are: GET, POST or PUT
Access MyData (AMD)

4.3 Certification
4.3 Certification
For secured communication (HTTPS) between the SI Server and the clients, you require a
digital certificate that confirms the identity of the server.
The connection is an SSL connection.
The following certificates are required for communication:
● SSL certificate: This certificate must be present on the server.
● Root certificate: This certificate must be present on the server and the clients.
Requirement
The certificate has already been generated or updated.
Note
Client authentication/connection problems
● The client authentication allows the user secure access to a server or remote computer by
exchanging a digital certificate.
● Editing is not possible in the event of connection problems. The function is only guaranteed
for an existing SSL connection.
In this case, the error code of the Web service interface changes to 108; see also: Error
codes (Page 33).
References
The procedure for generating and configuring the certificate is described in the following
Installation Manual: SINUMERIK Integrate MMP, MMT, AMC, AMP, AMM/E, AMD,
Section: Setting up an encrypted connection
Section: AMD access to tool information, generating/selecting the server certificate.
Access MyData (AMD)

4.4 Interface functions
4.4.1 Protocol for reading/writing/changing data - MMT
The following sections describe the protocols for reading/writing/changing tool and/or planning
data in MMT.
There are two different methods to use this function on the one hand for POST requests and
on the other hand for GET requests.
4.4.1.1 Readout of the MMT configuration (Action 101)

The "Read MMT configuration (Action 101)" operation is used to read out the currently loaded
and used shopfloor configuration in MMT. The shopfloor configuration contains all of the
information about the configured components (cabinets, units, groups, machines, magazines)
within the MMT.
Request protocol
● Method:
POST
● AMD tools URL:
https://<AMD–Tools server IP>/amd/tools/v1/Actions
● Header content type:
application/xml
● Body:
<Action ID="101"/>
Access MyData (AMD)

Response protocol
<Action ID="101">
<Configuration versionLabel="" crc32="86F2EEE" distributed="1" ...>
<Node nodeId="Server" nodeNo="1" globalId="FAFBD571-FD0F-4372-9BBE-8EB1C3FAFD9F"
host="<AMD-Tools server IP">
<Modules Plant="0" Overview="1" Handling="1" Statistic="1" Machine="1"
Planning="1" ...="">
<SinOpSupport name="TdiMcisInterfaces" param="localhost:8000"
assembly="TdiMcisInterface.dll" />
<OEM name="MMTWebInterface" assembly="MMTWebInterface.dll"
subscription_timeout="300000" />
</Modules>
<Container id="New magazine" ...="" />
<ContainerAssignment fromParent="0">
<ContainerToAssigne nodeId="Server" containerId="New magazine" asMoveDest="1"
asLoad="1" />
</ContainerAssignment>
<Node nodeId="NCUsl" orgName="Org" globalId="21CD79E2-0B73-11E4-8000-001FF80DBF91"
nodeNo="3" ...="">
<HolderDependencies>
<TOA linkedToa="1" numOfChn="1">
<HolderAssignment chn="1" numOfToolHld="1" toolHolder="1" />
</TOA>
</HolderDependencies>
<Container id="Pick_Up" no="1" nodeNo="4"...>
...
</Container>
<Container id="MAG-2" no="2" nodeNo="5"...>
...
</Container>
<Container id="SONDERMAGAZIN" no="5" nodeNo="6"...>
...
</Container>
<Container id="Belademagazin1" no="8" nodeNo="7"...>
...
</Container>
</Node>
<Node nodeId="NCU" nodeNo="13"...>
<Modules Overview="1" Handling="1" Statistic="1" Machine="1" Planning="1"
TPGeneration="1" ...=""/>
<Container id="Pick_Up" globalId="2D4BBEED-C0F1-48BF-9F43-6D0ACD5C7B3A"...>
...
</Container>
<Container id="ZM87_2" globalId="34047B59-BDD0-405E-8219-D2FFAF638DD1"...>
...
</Container>
</Node>
</Node>
<UserDataDefinition>
...
</UserDataDefinition>
</Configuration>
</Action>
Access MyData (AMD)

Note
For a detailed description on the structure of the shopfloor configuration in MMT please refer
to the MMT documentation.
4.4.1.2 Subscribe to tool transfer (Action 103)

The "Subscribe to tool change (Action 103)" operation allows a notification service for tool
transfers in MMT to be activated or deactivated. The value of the SUBSCRIBE parameter in
the request protocol activates (value "1") or deactivates (value "0") the notification service.
The timeout defines the period of time after which the GET Requests are answered if no user
data is available for retrieval on the WebInterface server. The timeout attribute is optional
and can be omitted. The default value is (10000 ms)
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Start the subscription:
<Action ID="103">
<SUBSCRIBE timeout="5000">1</SUBSCRIBE>
</Action>
End the subscription:
<Action ID="103" guid="9375c90c-d64a-4def-87f6-109b2ae8db28">

<SUBSCRIBE>0</SUBSCRIBE>
</Action>
Response protocol
Note
The GUID returned upon activation must always be sent along with the HTTP GET requests
and when the notification server is deactivated.
Access MyData (AMD)

The following response is sent when the notification service is successfully activated:
<Action ID="103" guid="1e14fbaa-4965-4d43-af19-9884d50f5b76">

<SUBSCRIPTION>Successful</SUBSCRIPTION>
</Action>
The following response is sent when the notification service is successfully deactivated:
<Action ID="103" guid="dcc2aedb-5dc5-4278-8f50-47f57d8b9e21">

<UNSUBSCRIPTION>Successful</UNSUBSCRIPTION>
</Action>
After activation of the notification service, an HTTP-GET request must be sent cyclically to the
WebInterface server. This contains as parameters the Action ID and the GUID returned on
activation. The request is replied to immediately if user data is available for retrieval from the
WebInterface server.
GET request:
● Method:
GET
● AMD tool URL:
https://<AMD-Tools server IP>/amd/tools/v1/Actions?
actionId=103&guid=dcc2aedb-5dc5-4278-8f50-47f57d8b9e21
If no user data from an asynchronous operation is available at the WebInterface server, the
server response is delayed until an asynchronous operation is available at the
WebInterface server. After the timeout period (user-defined or default of 10000 milliseconds),
the HTTP-GET call returns with no data. The client can recognize from the size of the answer
whether user data of the asynchronous operation is available.
For each new transfer of tools, the subscriber gets a response similar to the following example:
Response protocol
<Action ID="103" guid="dcc2aedb-5dc5-4278-8f50-47f57d8b9e21">
<ToolData State="Add|Deleted" NodeId="NCU2" ContainerId="PAT1"
PlaceNo="4">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TC_TP2>2SCHNEIDEN</TC_TP2>
</TC_TP>
<TDI>
<TDI_EXTERN_ID>nxt_mill_2000</TDI_EXTERN_ID>
<TDI_OBJECT_ID>0</TDI_OBJECT_ID>
</TDI>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)

Possible states of the attribute <State> are Add and Deleted.
Note
All tool data must be called by a further action if necessary.
4.4.1.3 Read out tool container assignment "all parameters" (action 107)
The "Read out tool container assignment "all parameters" (action 107)" function allows tool
data (including all parameters) to be read out from one or more tool containers.
For every container to be read out, the ContainerId and its higher-level NodeId (this can
be determined from the MMT shopfloor configuration) must be specified.
The values that should be contained in the response can be defined by entering the optional
parameter Place in the request.
● All: Tools + empty locations
● ToolsOnly: Tools
● Empty: Empty locations
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="107" Places="All | ToolsOnly | Empty">

<MagList NodeId="NCUpl" ContainerId="Mag1"/>
<MagList NodeId="NCUsl" ContainerId="Pick_Up"/>
</Action>
Note
The response protocol differs for Powerline and Solutionline control systems.
The response protocol for Solutionline control systems contains additional elements in node
<TC_TP> in addition to the <TC_TPx> elements. The Powerline control systems do not contain
the additional elements.
Access MyData (AMD)

Response protocol (Solutionline)

<Action ID="107">
<MagList NodeId="NCUsl">
<Mag Name="Pick_Up" ContainerState="SYNCHRON" />
<EmptyPlace PlaceNo="2" />
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>3</TC_TP1>
<TC_TP2>LUECKE</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
...
<TC_TP_PROTA />
<TC_TP_MAX_VELO>0</TC_TP_MAX_VELO>
<TC_TP_MAX_ACC>0</TC_TP_MAX_ACC>
<A_TOOLMTN>0</A_TOOLMTN>
<A_TOOLMTLN>0</A_TOOLMTLN>
<A_MYMTN>0</A_MYMTN>
<A_MYMTLN>0</A_MYMTLN>
</TC_TP>
<TC_TPC>
<TC_TPC1>0</TC_TPC1>
...
</TC_TPC>
<DataElem Index="1">
<TC_DP>
<TC_DP10>0</TC_DP10>
...
<TC_DPVN5>0</TC_DPVN5>
</TC_DP>
<TC_MOP>
<TC_MOP1>0</TC_MOP1>
...
</TC_MOP>
Access MyData (AMD)

</DataElem>
<TDI>
<TDI_TARGET_TIME>2014-02-14T14:11:11</TDI_TARGET_TIME>
<TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE>
<TDI_TARGET_PART>5</TDI_TARGET_PART>
<TDI_TARGET_SPINDLENO>1</TDI_TARGET_SPINDLENO>
<TDI_TARGET_WORK>Work</TDI_TARGET_WORK>
</TDI>
</DataElem>
</ToolData>
</MagList>
</Action>
Access MyData (AMD)

Response protocol (Powerline)

<Action ID="107">
<MagList NodeId="NCUpl">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TC_TP2>123456</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>2058</TC_TP8>
<TC_TP9>0</TC_TP9>
<TC_TP10>0</TC_TP10>
</TC_TP>
<TC_TPG>
<TC_TPG1>0</TC_TPG1>
...
</TC_TPG>
<TC_TPC>
...
</TC_TPC>
<TC_DP>
...
</TC_DP>
<TC_MOP>
...
</TC_MOP>
<TC_DPC>
<TC_DPC1>0</TC_DPC1>
...
</TC_DPC>
<TC_MOPC>
<TC_MOPC1>0</TC_MOPC1>
...
</TC_MOPC>
Access MyData (AMD)

</DataElem>
<TDI>
<TDI_OBJECT_ID>mill_200_Ar</TDI_OBJECT_ID>
<TDI_EXTERN_ID>12345678905r</TDI_EXTERN_ID>
<TDI_TOOLID_DESCRIPTION>tool_millr</TDI_TOOLID_DESCRIPTION>
<TDI_TOOL_COMMENT>millr</TDI_TOOL_COMMENT>
<TDI_PRESETTING_TIME />
<TDI_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE>
<TDI_ASSIGNED_CONTAINER />
<TDI_LAST_ACCESS_PROG />
<TDI_LAST_ACCESS_TIME />
<TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE>
<TDI_TARGET_WORK>Worksek1</TDI_TARGET_WORK>
</TDI>
</DataElem>
</ToolData>
</MagList>
</Action>
Note
● Nodes and containers that do not contain any tool data are not listed for the response.
● The attribute <ContainerState> shows whether or not the tool container is connected.
Possible states are:
– ContainerState="SYNCHRON"
– ContainerState="IN_SYNC"
– ContainerState="OFFLINE"
4.4.1.4 Read out tool container assignment (Action 108)

The "Read tool container assignment (Action 108)" function allows tool data to be read out
from one or more tool containers.
For every container to be read out, the ContainerID and its higher-level NodeId (this can
be determined from the MMT shopfloor configuration) must be specified.
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="108" Places="All">

<MagList NodeId="NCUsl" ContainerId="Pick_Up"/>
<MagList NodeId="Server" ContainerId="Zoller"/>
</Action>
Access MyData (AMD)

Response protocol
<Action ID="108">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>3</TC_TP1>
<TC_TP2>tool</TC_TP2>
...
<TC_TP9>0</TC_TP9>
<MAG_PLACE>3</MAG_PLACE>
</TC_TP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_OBJECT_ID>
</TDI_OBJECT_ID>
<TDI_EXTERN_ID>
</TDI_EXTERN_ID>
...
<TDI_PRESETTING_TIME>2015-07-03T13:27:47</TDI_PRESETTING_TIME>
</TDI>
</DataElem>
</ToolData>
</MagList>
</Action>
Note
Access MyData (AMD)

4.4.1.5 Read out tool node (Action 109)

The "Read node tool (Action 109)" operation is used to read out one or more MMT nodes
(groups/units/machines). During this operation, all of the containers (magazines, cabinets, etc.)
below the specified node are read out.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="109" Places="All">

<MagList NodeId="NCUsl"/>
</Action>
Access MyData (AMD)

Response protocol
<Action ID="109">
<Mag Name="Pick_Up" ContainerState="SYNCHRON">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>3</TC_TP1>
<TC_TP2>LUECKE</TC_TP2>
...
</TC_TP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_OBJECT_ID />
<TDI_EXTERN_ID />
...
<TDI_PRESETTING_TIME />
</TDI>
</DataElem>
</ToolData>
</Mag>
<Mag Name="MAG-2" ContainerState="SYNCHRON">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>7</TC_TP1>
<TC_TP2>toolx</TC_TP2>
...
</TC_TP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_OBJECT_ID />
<TDI_EXTERN_ID />
Access MyData (AMD)

...
<TDI_LAST_ACCESS_PROG />
</TDI>
</DataElem>
</ToolData>
</Mag>
</MagList>
</Action>
Note
4.4.1.6 Add/change external data (Action 114)

The "Add/change external data (Action 114)" operation is used to add/change the external
data in a tool. To identify the tool, for the Request protocol, the associated node and container
(NodeId and ContainerId) can be determined from the MMT shopfloor configuration – see
protocol: Readout of the MMT configuration (Action 101) (Page 36), the location number (the
location number can be determined by means of the Action_108/109 – see protocol: Read out
tool container assignment (Action 108) (Page 44) or Read out tool node (Action 109)
(Page 47), the tool identifier and the duplo number are required.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="114">
<Tool NodeId="Server" ContainerId="Zoller" PlaceNo="1" TC_TP2="mill200A"
TC_TP1="1">
<TDI>
<TDI_OBJECT_ID>mill_200_A</TDI_OBJECT_ID>
<TDI_EXTERN_ID>1234</TDI_EXTERN_ID>
<TDI_TOOLID_DESCRIPTION>tool_mill</TDI_TOOLID_DESCRIPTION>
<TDI_TOOL_COMMENT>mill</TDI_TOOL_COMMENT>
</TDI>
</Tool>
</Action>
Response protocol
<Action ID="114">
<Tool NodeId="Server" ContainerId="Zoller" PlaceNo="1" TC_TP2="123456"
TC_TP1="1">OK
</Tool>
</Action>
4.4.1.7 Read out actual tool data via tool identifier/DuploNo. (Action 115)
The "Read actual Tooldata by toolident/DuploNo. (Action 115)" operation enables an entire
tool dataset to be read out. To identify the tool, for the Request protocol, the associated node
(NodeId) can be determined from the MMT shopfloor configuration – see protocol: Readout
of the MMT configuration (Action 101) (Page 36), the tool identifier and the duplo number are
required.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="115">
<ToolData NodeId="NCUpl-Mark">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TC_TP2>TAP</TC_TP2>
</TC_TP>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)

Note
The response protocol differs for Powerline and Solutionline control systems.
Access MyData (AMD)


<Action ID="115">
<ToolData NodeState="OFFLINE">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TNO>6</TNO>
...
<A_TOOLMN>1</A_TOOLMN>
<A_TOOLMLN>3</A_TOOLMLN>
<P_TOOLND>1</P_TOOLND>
<A_MYMN>1</A_MYMN>
<A_MYMLN>3</A_MYMLN>
<TC_TP_PROTA />
</TC_TP>
<TC_DP>
<TC_DP8>0</TC_DP8>
<TC_DP9>0</TC_DP9>
...
<TC_DPH>0</TC_DPH>
<TC_DPNT>0</TC_DPNT>
<TC_DPV>0</TC_DPV>
<TC_DPV3>0</TC_DPV3>
</TC_DP>
<TC_MOP>
</TC_MOP>
</DataElem>
<TDI>
<TDI_OBJECT_ID>
</TDI_OBJECT_ID>
<TDI_TARGET_NODE />
<TDI_TARGET_PART />
Access MyData (AMD)

<TDI_TARGET_SPINDLENO />
<TDI_TARGET_TIME />
<TDI_TARGET_WORK />
<TDI_TOOL_COMMENT>Kommentar</TDI_TOOL_COMMENT>
<TDI_TOOLID_DESCRIPTION>Beschreibung</TDI_TOOLID_DESCRIPTION>
<TDI_ASSIGNED_CONTAINER>
</TDI_ASSIGNED_CONTAINER>
<TDI_LAST_ACCESS_PROG>
</TDI_LAST_ACCESS_PROG>
<TDI_LAST_ACCESS_TIME>
</TDI_LAST_ACCESS_TIME>
</TDI>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)


<Action ID="115">
<ToolData NodeState="SYNCHRON">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>1218</TC_TP8>
<TC_TP9>0</TC_TP9>
</TC_TP>
<TC_DP>
<TC_DP2>9</TC_DP2>
<TC_DP3>0</TC_DP3>
<TC_DP4>0</TC_DP4>
<TC_DP5>0</TC_DP5>
<TC_DP6>0</TC_DP6>
<TC_DP7>0</TC_DP7>
<TC_DP8>0</TC_DP8>
<TC_DP9>0</TC_DP9>
</TC_DP>
<TC_MOP>
</TC_MOP>
</DataElem>
Access MyData (AMD)

<TDI>
<TDI_OBJECT_ID>
</TDI_OBJECT_ID>
<TDI_TARGET_NODE />
<TDI_TARGET_PART />
<TDI_TARGET_TIME />
<TDI_TARGET_WORK />
</TDI>
</DataElem>
</ToolData>
</Action>
Note
● The attribute <NodeState> shows whether or not the node (machine, groups, etc.) is
connected.
● Possible states are:
– NodeState="SYNCHRON"
– NodeState="OFFLINE"
4.4.1.8 Read out actual tool data via ExternalId (Action 116).
The "Read actual tool data (Action 116)" operation enables a complete tool data set to be read
out. To identify the tool, for the Request protocol, the associated node (NodeId) can be
determined from the MMT shopfloor configuration – see protocol: Readout of the MMT
configuration (Action 101) (Page 36) and an external ID (e.g. inventory or holder number) are
transferred.
Note
If the NodeId attribute is blank, then all nodes are searched.
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="116">
<ToolData NodeId="Server">
<DataElem>
<TC_TP>
<EXT_ID>Inventarnummer</EXT_ID>
</TC_TP>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)


<Action ID="116">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TNO>6</TNO>
...
<A_TOOLMN>1</A_TOOLMN>
<A_TOOLMLN>3</A_TOOLMLN>
<P_TOOLND>1</P_TOOLND>
<A_MYMN>1</A_MYMN>
<A_MYMLN>3</A_MYMLN>
<TC_TP_PROTA />
</TC_TP>
<TC_DP>
<TC_DP8>0</TC_DP8>
<TC_DP9>0</TC_DP9>
...
<TC_DPH>0</TC_DPH>
<TC_DPNT>0</TC_DPNT>
<TC_DPV>0</TC_DPV>
</TC_DP>
<TC_MOP>
</TC_MOP>
</DataElem>
<TDI>
<TDI_OBJECT_ID>
</TDI_OBJECT_ID>
<TDI_TARGET_NODE />
<TDI_TARGET_PART />
Access MyData (AMD)

<TDI_TARGET_TIME />
<TDI_TARGET_WORK />
</TDI>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)


<Action ID="116">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
<TC_TP2>OTTO</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
...
</TC_TP>
<TC_TPG>
...
</TC_TPG>
<TC_TPC>
...
</TC_TPC>
<TC_DP>
...
<TC_DP8>0</TC_DP8>
<TC_DP9>0</TC_DP9>
</TC_DP>
<TC_MOP>
...
</TC_MOP>
<TC_DPC>
...
</TC_DPC>
<TC_MOPC>
...
</TC_MOPC>
</DataElem>
<TDI>
<TDI_OBJECT_ID>
Access MyData (AMD)

</TDI_OBJECT_ID>
<TDI_TARGET_NODE />
<TDI_TARGET_PART />
<TDI_TARGET_TIME />
<TDI_TARGET_WORK />
</TDI>
</DataElem>
</ToolData>
</Action>
4.4.1.9 Import tool dataset (Action 117)

The "Import tool data set (Action 117)" operation imports tool data sets into an MMT SQL
presetter. The operation enables tool data to be transferred from tool presetting stations.
For this operation, all tool data, the target container, and the associated node must be
transferred. NodeId and ContainerId can be determined from the MMT shopfloor configuration
– see protocol: Readout of the MMT configuration (Action 101) (Page 36).
Action 117 is not available when SFI is installed. In this case, access to action 117 via the
AMD interface is prevented. In this case, the setting container PUT is used ("…/amd/tools/v1/
PresettingList/{invNo}"). To prevent access to action 117, the AMD interface must read the
request and confirm that it is not a call of action 117.
If SFI is installed and a client still calls action 117, the AMD interface sends status code 301
(Moved Permanently) to the client. This is an indication to use a different URL address (…/
amd/tools/v1/PresettingList/{invNo}).
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="117">
<ToolList NodeId="Server" ContainerId="Import">
<DataElem>
<TC_TP>
<TC_TP1>17</TC_TP1>
<TC_TP2>Bohrerxy</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
...
</TC_TP>
<TC_TPG>
...
</TC_TPG>
<TC_DP>
<TC_DP2>0</TC_DP2>
<TC_DP3>00185.000</TC_DP3>
<TC_DP4>0</TC_DP4>
<TC_DP5>0</TC_DP5>
<TC_DP6>10</TC_DP6>
...
</TC_DP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_ASSIGNED_CONTAINER/>
</TDI>
</DataElem>
</ToolList>
</Action>
Access MyData (AMD)

Response protocol
<Action ID="117">
<ToolList NodeId="Server" ContainerId="Import">
<DataElem>
<TC_TP>
<TC_TP1>17</TC_TP1>
<TC_TP2>Bohrerxy</TC_TP2>
<STATE>CREATED</STATE>
</TC_TP>
</DataElem>
</ToolList>
</Action>
Note
When creating a tool using Action 117, the TDI_EXTERN_ID can be defined, among others.
The MMT server must be correspondingly configured (no automatic assignment of the
ExternId).
The following steps must be performed for this purpose:
1. Open the "Options" tab in the MMT configuration program (Manage MyTools configuration).
2. Click "Tool identification", and select "Global tool identification (e.g. holder number) defined
by ExternId".
3. Accept and save this setting.
4. Then restart the MMT server.
Otherwise the entered ExternId will be replaced by an automatically generated character string
if the automatic assignment of the ExternId has been configured in the MMT server.
4.4.1.10 Delete tool (Action 119)

The operation "Delete tool (Action 119)" is used to delete tools from the disassembly container.
To identify a tool, either the NodeId, ContainerId and location number or the ExternId
must be specified.
Note
The Response protocol specifies whether the deletion was successful for the respective tool.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="119">
<ActionDeleteTool>
<Place nodeId="NCUsl" containerId="Pick_Up" no="1"/>
</ActionDeleteTool>
<ActionDeleteTool>
<Place nodeId="NCUsl" containerId="Pick_Up" no="3"/>
</ActionDeleteTool>
<ActionDeleteTool>
<Place externId="eine externe WZ-Identifikation"/>
</ActionDeleteTool>
</Action>
Response protocol
<Action ID="119">
<ActionDeleteTool>
<Place nodeId="NCUsl" containerId="Pick_Up" no="1">Deleted</Place>
</ActionDeleteTool>
<ActionDeleteTool>
<Place nodeId="NCUsl" containerId="Pick_Up" no="3">Deleted</Place>
</ActionDeleteTool>
<ActionDeleteTool>
<Place externId="eine externe WZ-Identifikation">Deleted</Place>
</ActionDeleteTool>
</Action>
4.4.1.11 Read out master data overview (Action 120)

The "Read master data overview (Action 120)" operation is used to read out all the master
data created in MMT. The result can be restricted by specifying the filter parameters TC_TP2,
TC_DP1 and/or TOOL_COMMENT in the protocol.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="120">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP2>457111</TC_TP2>
<TC_DP1/>
<TOOL_COMMENT/>
</TC_TP>
</DataElem>
</ToolData>
</Action>
Response protocol
<Action ID="120">
<ToolData>
<TC_TP>
<TC_TP2>457111</TC_TP2>
<TC_TP9>0</TC_TP9>
<BEZEICHNUNG></BEZEICHNUNG>
<WZ_SCHRANK_ID>3</WZ_SCHRANK_ID>
<TOOL_COMMENT></TOOL_COMMENT>
<EDGES>1</EDGES>
</TC_TP>
</ToolData>
</Action>
4.4.1.12 Read out master data set (Action 121)

The "Read master data (Action 121)" operation is used to read out a complete master data
set. In the protocol, the master data set is uniquely identified using parameter "TC_TP2".
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="121">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP2>Werkzeugbezeichner</TC_TP2>
</TC_TP>
</DataElem>
</ToolData>
</Action>
Access MyData (AMD)

Response protocol
<Action ID="121">
<ToolList>
<DataElem>
<TC_TP>
<TC_TP1>0</TC_TP1>
<TC_TP2>WZ-Werkzeugbezeichner</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>0</TC_TP8>
<TC_TP9>0</TC_TP9>
</TC_TP>
<TC_DP>
<TC_DP2>0</TC_DP2>
<TC_DP3>0</TC_DP3>
<TC_DP4>0</TC_DP4>
<TC_DP5>0</TC_DP5>
<TC_DP6>0</TC_DP6>
<TC_DP7>0</TC_DP7>
<TC_DP8>0</TC_DP8>
...
</TC_DP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_WZSCHRANK_ID>3</TDI_WZSCHRANK_ID>
<TDI_TOOLID_DESCRIPTION/>
<TDI_TOOL_COMMENT/>
</TDI>
</DataElem>
</ToolList>
</Action>
4.4.1.13 Delete master data set (Action 122)

The "Delete master data (Action 122)" operation is used to delete an existing data set in MMT.
The master data set can be uniquely identified in the protocol using parameter TC_TP2.
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="122">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP2>Werkzeugbezeichner</TC_TP2>
</TC_TP>
</DataElem>
</ToolData>
</Action>
Response protocol
<Action ID="122">
<ToolData>
<DataElem>
<TC_TP>
<TC_TP2>SF2</TC_TP2>
<STATE>DELETED</STATE>
</TC_TP>
</DataElem>
</ToolData>
</Action>
4.4.1.14 Create/change master data set (Action 123)

The "Create/change master data set (Action 123)" operation is used to create a new or change
an existing master data set in MMT.
Internal sequence:
When performing the operation, first of all the tool identifier (parameter TC_TP2) is used to
check whether the master data set already exists in the MMT. If the identifier already exists in
MMT, the associated master data set is overwritten with the new values from the request
protocol. If the tool identifier does not exist, then a new master data set is created in MMT.
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="123">
<ToolList>
<DataElem>
<TC_TP>
<TC_TP1>0</TC_TP1>
<TC_TP2>Stammwerkzeug</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
...
</TC_TP>
<TC_TPG>
...
</TC_TPG>
<TC_DP>
<TC_DP2>0</TC_DP2>
<TC_DP3>0</TC_DP3>
<TC_DP4>0</TC_DP4>
<TC_DP5>0</TC_DP5>
...
</TC_DP>
<TC_MOP>
...
</TC_MOP>
</DataElem>
<TDI>
<TDI_WZSCHRANK_ID>1</TDI_WZSCHRANK_ID>
<TDI_TOOLID_DESCRIPTION/>
<TDI_TOOL_COMMENT/>
</TDI>
</DataElem>
</ToolList>
</Action>
Access MyData (AMD)

Response protocol
If a master data set has been successfully created from new in MMT, then the following
response is sent:
<Action ID="123">
<ToolList>
<DataElem>
<TC_TP>
</TC_TP>
</DataElem>
</ToolList>
</Action>
If an existing tool master data set is successfully changed in MMT, the following response is
sent:
<Action ID="123">
<ToolList>
<DataElem>
<TC_TP>
<STATE>CHANGED</STATE>
</TC_TP>
</DataElem>
</ToolList>
</Action>
4.4.1.15 Set master data set (Action 124)

The "Set master data set (Action 124)" operation is used to create a tool based on a selected
master data set in a presetter. For the query for this operation, the master data set is uniquely
identified by parameter TC_TP2, the node and the container must be specified for the target
container (NodeId and ContainerId can be determined from the MMT shopfloor
configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 36). The
parameter TC_TP1 (duplo number) has the value range from 0 to 32,000.
Note
The target container for the tool must be of the "presetter" type.
The data (identifier and duplo number) is not checked for unambiguity. This allows tools with
the duplo number 0 to be set, even double tools can be set.
Request protocol
● Method:
POST
● AMD tools URL:
Access MyData (AMD)


application/xml
● Body:
<Action ID="124">
<ToolList NodeId="Server" ContainerId=" Presetter1">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
</TC_TP>
</DataElem>
</ToolList>
</Action>
Response protocol
<Action ID="124">
<ToolList NodeId="Server" ContainerId="Presetter1">
<DataElem>
<TC_TP>
<TC_TP1>1</TC_TP1>
</TC_TP>
</DataElem>
</ToolList>
</Action>
4.4.1.16 Read out tool plan (Action 131)

The "Read tool plan (Action 131)" operation is used to read out an assembly plan in MMT. In
the request protocol, the tool plan must be uniquely identified using the ToolPlanId
parameter and the assigned NodeId.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="131">
<ToolPlan NodeId="node_id" ToolPlanId="plan_id"/>
</Action>
Access MyData (AMD)

Response protocol
<Action ID="131">
<ToolPlan id="plan_id" nodeId="node_id" version="1" prog="Prog" duration="25"
channel="1" lastChangeDate="2014-02-14T14:11:11" lastChangeName="User" reserve1=""
reserve2="" reserve3="">
<Tool toolId="tool_id1" objectid="object_id1" occtype="" spindelNo="1" edgeNo="1"
cutTime="3" cutCount="1" progPosition="" mon="1"/>
<Tool toolId="tool_id2" edgeNo ="1" cutTime="6" cutCount="1" progPosition =""
mon="1"/>
mon="1"/>
<Tool toolId="tool_id4" objectid="object_id4" occtype="" targetMagazineNodeNo="1"
edgeNo ="1"
cutTime="4" cutCount="1" progPosition ="" mon="1"/>
<Tool toolId="tool_id5" objectid="object_id5" occtype="" spindleNo="2"
targetMaganzineNodeNo="1"
edgeNo="1" cutCount="1" progPosition="" mon="1"/>
</ToolPlan>
</Action>
4.4.1.17 Delete tool plan (Action 132)

The "Delete toolplan (Action 132)" operation is used to delete an existing tool plan in MMT. In
the request protocol, the tool plan must be uniquely identified using the ToolPlanId
parameter and the assigned NodeId.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="132">
<ToolPlan NodeId="Server" ToolPlanId="Base plate"/>
</Action>
Response protocol
<Action ID="132">
<ToolPlan NodeId="Server" ToolPlanId="Base plate">
<STATE>DELETED</STATE>
</ToolPlan>
</Action>
Access MyData (AMD)

4.4.1.18 Create/change tool plan (Action 133)

The "Create/change tool plan (Action 133)" operation is used to create a new or change an
existing tool plan in MMT. To assign the tool plan, the ToolPlanId and NodeId parameters
must be specified for the request protocol.
Internal sequence:
When performing this operation, in a first step it must be checked as to whether the tool plan
already exists in MMT. If the tool plan already exists, the tool plan is overwritten with the
transferred data of the request protocol.
If the tool plan ID does not exist, a new tool plan is created in MMT.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="133">
<ToolPlan id="plan_id" nodeId="node_id" version="1" prog="Progname" duration="25"
channel="1" lastChangeDate="2014-02-14T14:11:11" lastChangeName="User_id" reserve1=""
reserve2="" reserve3="">
<Tool toolId="tool_id1" objectid="object_id1" occtype="" targetMagazineNodeNo="2
edgeNo="1"
cutTime="3" cutCount="1" progPosition="" mon="1"/>
mon="1"/>
mon="1"/>
<Tool toolId="toold_id4" objectid="object_id4" occtype="" spindelNo="1" edgeNo ="1"
<Tool toolId="tool_id5" objectid="object_id5" occtype="" spindleNo="2" edgeNo="1"
</ToolPlan>
</Action>
Response protocol
If a tool plan has been successfully created, the following response is sent:
<Action ID="133">
<ToolPlan nodeId="node_id1" id="plan_id">
</ToolPlan>
</Action>
Access MyData (AMD)

If an existing tool plan is changed in MMT due to this operation, the following response is sent:
<Action ID="133">
<ToolPlan nodeId="node_id" id="plan_id">
</ToolPlan>
</Action>
4.4.1.19 Read out tool plan overview (Action 134)

The "Read toolplan overview "recursive" (Action 134)" operation is used to read out an
overview of the tool plans which are assigned to a node.
Setting the Recursive attribute in the request protocol to true (value "1") or false (value
"0") allows the request to be output recursively or non-recursively.
The Recursive attribute is optional and can be omitted if the request is not output recursively.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="134">
<ToolPlanList NodeId="Server" Recursive="1"/>
</Action>
Response protocol
<Action ID="134">
<ToolPlanList>
<ToolPlan NodeId="Masch1" ID="Base plate" Version="1" InUse="False"
LastChange="2004-05-14T11:17:17"/>
<ToolPlan NodeId="Masch1" ID="Cylinder" Version="1" InUse="False"
LastChange="2004-05-14T11:17:17"/>
<ToolPlan NodeId="Masch2" ID="corner" Version="1" InUse="True"
LastChange="2004-05-14T11:17:17"/>
<ToolPlan NodeId="Masch3" ID="Rough cut" Version="4" InUse="True"
LastChange="2004-05-14T11:17:17"/>
<ToolPlan NodeId="Masch3" ID="Rough cut" Version="1" InUse="False"
LastChange="2004-05-14T11:17:17"/>
</ToolPlanList>
</Action>
Access MyData (AMD)

4.4.1.20 Read out setting list (Action 141)

The operation "Read out setting list (Action 141)" allows the setting list (a balancing result) to
be read out in MMT.
Action 141 is not available when SFI is installed. In this case, access to action 141 via the
AMD interface is prevented.
If SFI is installed and a client still calls action 141, the AMD interface sends status code 301
(Moved Permanently) to the client. This is an indication to use a different URL address (…/
amd/tools/v1/PresettingList).
Using the following request protocol, the balancing result of the entire shopfloor structure is
always supplied:
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="141"/>
Using the following optional extension of the request protocol, the readout of the balancing
result can be restricted to the specified node(s). MMT configuration nodes of the following
types are permitted (RootNode, Group and Machine):
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="141">
<NodeSelection NodeId="NCU 01"/>
<NodeSelection NodeId="Gruppe 2"/>
</Action>
Access MyData (AMD)

Response protocol
The following example response is received if there is a need for tools:
<Action ID="141">
<ToolList>
<Place NodeId="Fertigung" containerId="Zoller" no="10">
<Tool id="nxt_mill_1010_100_A" state="2" type="0" tool_ptype="9999" mon="1"
intern="-1" target-node="MAG_NBV_700_MT" target-time="2013-10-17T11:23:21"
target-work="WorkSeq1" target-part="1" target-count="1" toolPlanId="Plan_1"
TDI_OBJECT_ID="nxt_mill_1010_100/A" TDI_EXTERN_ID="" TDI_TOOLID_DESCRIPTION=""
TDI_TOOL_COMMENT="" TDI_PRESETTING_TIME="" TDI_MANDATORY="0"
TDI_EXTTOOLSTATE="0" TDI_ASSIGNED_CONTAINER="" TDI_LAST_ACCESS_PROG=""
TDI_LAST_ACCESS_TIME="" TDI_LAST_ACCESS_EDGE="1"
TDI_TARGET_WEAROUT_AT="2013- 10-17T11:30:21" TDI_TARGET_SPINDLENO="1">
<CutEdge rtime="" />
</Tool>
</Place>
<Place NodeId="Fertigung" containerId="Zoller" no="12">
<Tool id="nxt_mill_1020_100_A" state="2" type="0" tool_ptype="9999" mon="1"
intern="-1" target-node="MAG_NBV_700_MT" target-time="2013-10-17T11:27:21"
target-work="WorkSeq1" target-part="1" target-count="1" toolPlanId="Plan_1"
TDI_OBJECT_ID="nxt_mill_1020_100/A" TDI_EXTERN_ID="" TDI_TOOLID_DESCRIPTION=""
TDI_TOOL_COMMENT="" TDI_PRESETTING_TIME="" TDI_MANDATORY="0"
TDI_EXTTOOLSTATE="0" TDI_ASSIGNED_CONTAINER="" TDI_LAST_ACCESS_PROG=""
TDI_LAST_ACCESS_TIME="" TDI_LAST_ACCESS_EDGE="1"
TDI_TARGET_WEAROUT_AT="2013- 10-17T11:34:21" TDI_TARGET_SPINDLENO="1">
<CutEdge rtime="" />
</Tool>
</Place>
</ToolList>
</Action>
The following example response is received if no tools are available in the setting list:
<Action ID="141">
<ToolList/>
</Action>
4.4.1.21 Set reservation ID (Action 142)

The "Set reservation ID" operation allows the reservation ID to be set or deleted for a real tool
in a magazine.
A reservation ID consists of the following 5 data items:
● TDI_TARGET_NODE: The destination machine for which this tool is reserved.
● TDI_TARGET_TIME: Provision time
● TDI_TARGET_WORK: Name of the machining sequence which triggered the need.
● TDI_TARGET_PART: Workpiece number
● TDI_TARGET_SPINDLENO: Spindle number
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Example 1: Setting the reservation ID
<Action ID="142">
<Tool NodeId="Server" ContainerId="Zoller" PlaceNo="2" TC_TP2="toolk"
TC_TP1="1">
<TDI>
<TDI_TARGET_WORK>work</TDI_TARGET_WORK>
</TDI>
</Tool>
</Action>
Example 2: Removing the reservation ID
<Action ID="142">
TC_TP1="1">
</Tool>
</Action>
Response protocol
<Action ID="142">
TC_TP1="1">OK |
NOT OK>
</Tool>
</Action>
Note
● The target machine <TDI_TARGET_NODE> for which the tool is reserved must actually exist
in the shopfloor configuration.
● The item <TDI_TARGET_TIME> must be available in ISO 8601 format.
● The location number can be determined using the Action_108/109 – see protocol: Read
out tool container assignment (Action 108) (Page 44) or Read out tool node (Action 109)
(Page 47).
Access MyData (AMD)

4.4.1.22 Perform single handling (Action 162)

The operation "Perform single handling (Action 162)" permits defined tool handling to be also
performed directly via the interface. Handling can be started (value "1") or ended (value "0")
using the value of the Transfer parameter in the request protocol.
The timeout defines the period of time after which the GET requests are answered if no user
data is available for retrieval on the WebInterface server. The timeout attribute is optional
and can be omitted. The default value is 10000 ms.
Table 4-1 Description of the attributes of the request protocol:
Attribute Description
SrcNodeId Name of the source machine as in the MMT configuration
SrcMag Name of the source magazine as in the MMT configuration
SrcLoc Location of the source magazine
(SrcLoc can be determined using the Action_108/109 – see protocol: Read out
tool container assignment (Action 108) (Page 44) or Read out tool node (Action
109) (Page 47))
TC_TP2 Tool identifier same as in NC program
TC_TP1 Duplo number
SrcLoadingPoint Loading/unloading point of the source machine
(0 corresponds to the automatic use of the suitable loading point). If multiple
loading/unloading points are available on a machine, the relevant loading/un‐
loading point must be specified for the transfer.
Note:
Parameter is only effective for NCU machine magazines
DstNodeId Name of the destination machine as in the MMT configuration
DstMag Name of the destination magazine as in the MMT configuration
DstLoc Location of the destination magazine (0 corresponds to an automatic search for
an empty location)
DstLoadingPoint Loading/unloading point of the source machine
(0 corresponds to the automatic use of the suitable loading point). If multiple
loading/unloading points are available on a machine, the relevant loading/un‐
loading point must be specified for the transfer.
Note:
Parameter is only effective for NCU machine magazines
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

Activate notification service
<Action ID="162">
<Transfer SrcNodeId="Server" SrcMag="Zoller" SrcLoc="0"
SrcLoadingPoint="0"
DstNodeId="Server" DstMag="Mag" DstLoc="0" TC_TP2="Bohrerxy" TC_TP1="17"
DstLoadingPoint="0" timeout="5000">1
</Transfer>
</Action>
Deactivate notification service

<Transfer>0</Transfer>
</Action>
Note
The GUID returned for HTTP-POST Response must always be sent along with the returned
GET requests and when the notification server is deactivated.
Response protocol
The following response is sent if the single handling has been successfully started:

<Transfer>Started|Error</Transfer>
</Action>
The following response is sent if the single handling has been successfully terminated/stopped:

<Transfer>Terminated</Transfer>
</Action>
After starting single handling, an HTTP-GET request to the WebInterface server must be
placed cyclically. This contains the ActionId and the GUID provided upon activation as
parameters. The request is replied to immediately if a new status is available for retrieval at
the WebInterface server.
GET request
● Method:
GET
● AMD tools URL:
https://<AMD–Tools server IP>/amd/tools/v1/Actions?actionId=162&
guid=1e14fbaa-4965-4d43-af19-9884d50f5b76
If a new handling status of an asynchronous operation is not available at the
WebInterface server, the server response is delayed until an asynchronous operation is
available at the WebInterface server.
Access MyData (AMD)

After the timeout period (user-defined or default of 10 seconds), the HTTP-GET call returns
with the old status. The subscriber receives the following response for each change to the
handling status:

<Transfer SrcNodeId="Server" SrcMag="Zoller" SrcLoc="0"
DstNodeId="Server" DstMag="Mag"
DstLoc="5" TC_TP2="Bohrerxy" TC_TP1="17">S_HANDLING_READY</Transfer>
</Action>
The following states are possible during handling:

● HS_INIT
● HS_SOURCE_ALLOCATION
● HS_TARGET_ALLOCATION
● HS_ALLOCATED
● HS_TARGET_SEARCH
● HS_UNLOAD_PREPARING
● HS_LOAD_PREPARING
● HS_UNLOAD_START
● HS_UNLOAD_STARTED
● HS_LOAD_START
● HS_LOAD_STARTED
● HS_UNLOAD_COMMITING
● HS_HANDLING_READY
● HS_SETTING_SOURCE_OPTIONS
● HS_SETTING_TARGET_OPTIONS
● HS_DEALOCATION
● HS_SOURCE_DEALOCATED
● HS_TARGET_DEALOCATED
● HS_UNLOAD_WAITING
● HS_LOAD_WAITING
● HS_ABORTED
● Error
4.4.1.23 Read out machining sequences (Action 170)

The "Read work sequences (Action 170)" operation is used to read out machining sequences
which are assigned to a node.
Access MyData (AMD)

Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="170">
<WorkSeqList NodeId="Server"/>
</Action>
Response protocol
<Action ID="170">
<WorkSeqList >
<WorkSeq NodeId="Masch1" WorkId="Plan1" WorkPos="1" ToolPlanId="Plan_1" Enabled ="True"
PartCountDesired="200" PartCountBilance="100" PartCountReady="0"
PartsCountingActiv="False" OrderId="" OrderDate="2004-05-14T11:17:17" OrderStep ="" />
</WorkSeqList >
</Action>
4.4.1.24 Create/change machining sequence (Action 171)

The "Create/change machining sequence (Action 171)" operation is used to create a new or
change an existing machining sequence in MMT. To assign the machining sequence, the
WorkId parameter must be specified for the request protocol.
Internal sequence:
When performing this operation, in a first step it must be checked as to whether the machining
sequence already exists in MMT. If the machining sequence already exists, the machining
sequence is overwritten with the transferred data of the request protocol. If the machining
sequence does not yet exist, a new one will be generated.
Request protocol
● Method:
POST
● AMD tools URL:
Access MyData (AMD)


application/xml
● Body:
<Action ID="171">
<WorkSeq NodeId="NCUsl" WorkId="Workseq10" ToolPlanId="Plan_1" Enabled ="true"
PartsCountingActiv="false" OrderId="" OrderDate="2014-11-12T11:10:00" OrderStep ="" />
</Action>
Response protocol
If a machining sequence has been successfully created, the following response is sent:
<Action ID="171">
<WorkSeq NodeId="NCUsl" WorkId="Workseq10" WorkPos="3" ToolPlanId="Plan_1"
Enabled="true" PartCountDesired="200" PartCountBilance="100" PartCountReady="0"
PartsCountingActiv="false" OrderId="" OrderDate="2014-11-12T11:10:00" OrderStep="">
</WorkSeq>
</Action>
If an existing machining sequence is changed in MMT by this operation, the following response
is sent:
<Action ID="171">
<WorkSeq NodeId="NCUsl" WorkId="Workseq10" WorkPos="3" ToolPlanId="Plan_1"
Enabled="true" PartCountDesired="200" PartCountBilance="100" PartCountReady="0"
PartsCountingActiv="false" OrderId="" OrderDate="2014-11-12T11:10:00" OrderStep="">
</WorkSeq>
</Action>
4.4.1.25 Disable/enable machining sequences (Action 172)

The "Enable/disable work sequences (Action 172)" operation is used to disable or enable one
or more machining sequences for balancing in MMT. In the request protocol, the machining
sequence must be uniquely identified by the WorkId parameter. To disable a machining
sequence for the balancing, the attribute Enabled must be supplied with the value false.
To enable it, the value must be set to true.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
Access MyData (AMD)

<Action ID="172">
<WorkSeq WorkId="Workseq100" Enabled ="false" />
<WorkSeq WorkId="Workseq10" Enabled ="true" />
</Action>
Response protocol
<Action ID="172">
<WorkSeq WorkId="Workseq100">OK</WorkSeq>
<WorkSeq WorkId="Workseq10">OK</WorkSeq>
</Action>
4.4.1.26 Delete machining sequences (Action 173)

The "Delete work sequences (Action 173)" operation is used to delete one or more machining
sequences in MMT. In the request protocol, the machining sequence must be uniquely
identified by the WorkId parameter.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="173">
<WorkSeq WorkId="work2" />
<WorkSeq WorkId="work9" />
</Action>
Response protocol
<Action ID="173">
<WorkSeq WorkId="work9">WORK SEQUENCE NOT FOUND</WorkSeq>
<WorkSeq WorkId="work2">DELETED</WorkSeq>
</Action>
4.4.1.27 Move machining sequence (Action 174)

The "Move work sequences (Action 174)" operation is used to move an existing machining
sequence in MMT. By moving machining sequences, the execution sequence changes. In the
request protocol, the machining sequence must be uniquely identified by the WorkId
parameter.
Access MyData (AMD)

To move a machining sequence up, the attribute Direction must be supplied with the value
up. To move it down, the value must be set to down.
Request protocol
● Method:
POST
● AMD tools URL:
application/xml
● Body:
<Action ID="174">
<WorkSeq WorkId="work7" Direction ="down" />
</Action>
Response protocol
<Action ID="174">
<WorkSeq WorkId="work7">OK</WorkSeq>
</Action>
4.4.2 Protocols for reading/writing/changing data - SFI
4.4.2.1 Presetting list (GET)

The "Presetting list (GET)" operation allows the settings list to be read from SFI.
The following request protocol always returns the settings list of the entire system structure.
Requirement
"Presetting list (GET)" is only available when SFI RM is installed. Otherwise, access to this
operation via the AMD interface is prevented.
If SFI is not installed and a client still calls the "Presetting list (GET)" operation, the AMD
interface sends status code 503 (Service Unavailable) to the client. This is an indication to use
a different action "Action 141" and another URL address (…/amd/tools/v1/Actions).
Request protocol
● Method:
GET
● AMD tools URL:
https://<AMD–Tools server IP>/amd/tools/v1/PresettingList
Access MyData (AMD)

Response protocol
Example: Tools are required.

<?xml version="1.0" encoding="utf-8"?>
<PresettingList xmlns= "http://www.siemens.com/sinumerik/integrate">
<PresettingTool InventarNo="inventarNo" ObjectId="objectID"
PartNo="partNo" ToolId="toolId" ContainerId="containerId"
DuploNo="duploNo"TargetNode="targetNode"TargetTime="
targetTime" WorkId="workId" />
<PresettingTool InventarNo="inventarNo2" ObjectId="objectID2"
PartNo="partNo2" ToolId="toolId2" ContainerId="containerId2"
DuploNo="duploNo2"TargetNode="targetNode2"TargetTime="
targetTime2" WorkId="workId2" />
</PresettingList>
Example: There are no tools in the settings list

<?xml version=”1.0” encoding=”utf-8”?>
<PresettingList xmlns= "http://www.siemens.com/sinumerik/integrate">
</PresettingList>
Note
Further information
Information on the input and calculation of tolerance values in SFI can be found in Chapter:
Description of the SFI tolerance values (Page 111).
4.4.2.2 Presetting list (GET) {invNO}

The "Presetting list (GET) {invNo}" operation allows the tool data of individual tools to be read
from the settings list in SFI.
For this operation, the parameters "Inventory number" and "Transformation" (optional) are
transferred.
Depending on the format in which the tool master data is required (depends on the tool setting
stations), the "Transformation" parameter must be transferred. The parameter must
correspond to the file name of the xslt script in SF1.
The tool master data is transformed in SFI.
Requirement
"Presetting list (GET) {invNo}" is only available when SFI is installed. Otherwise, access to this
operation via the AMD interface is prevented.
If SFI is not installed and a client still calls the "Presetting list (GET) {invNo}" operation, the
AMD interface sends status code 503 (Service Unavailable) to the client.
The "Presetting list (GET) {invNo}" operation then returns the data in a suitable format.
Access MyData (AMD)

Request protocol
● Method:
GET
● AMD tools URL:
https://<AMD–Tools server IP>/amd/tools/v1/PresettingList/<Inventory_number>?
Transformation=<Format>
Response protocol
Example: No "Transformation" parameter was transferred.

<PresettingData >
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>0</TC_TP1>
<TC_TP2>HSK-Drill-6-5-E-2</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>10</TC_TP8>
</TC_TP>
<TC_DP>
<TC_DP3>-191.000</TC_DP3>
<TC_DP4>000.000</TC_DP4>
<TC_DP5>000.000</TC_DP5>
</TC_DP>
</DataElem>
<TC_DP>
<TC_DP3>-183.000</TC_DP3>
<TC_DP4>000.000</TC_DP4>
<TC_DP5>000.000</TC_DP5>
</TC_DP>
</DataElem>
<TDI>
<TDI_OBJECT_ID>nxt_drill_02_00038/A</TDI_OBJECT_ID>
<TDI_TOOLID_DESCRIPTION>D15.0 Zapfensenker/HSK63</
TDI_TOOLID_DESCRIPTION>
<TDI_TARGET_NODE>Helene</TDI_TARGET_NODE>
<TDI_TARGET_MAGAZINE>Kette_120</TDI_TARGET_MAGAZINE>
<TDI_TARGET_WORK>Legacy</TDI_TARGET_WORK>
Access MyData (AMD)

</TDI>
</DataElem>
</ToolData>
</PresettingData>
Example: The "Transformation" parameter, e.g. Kelch, has been transferred.

<PresettingData >
<ToolData>
<DataElem>
<TC_TP>
<TC_TP1>0</TC_TP1>
<TC_TP2>HSK-Drill-6-5-E-2</TC_TP2>
<TC_TP3>1</TC_TP3>
<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>10</TC_TP8>
</TC_TP>
<TC_DP>
<TC_DP3>-191.000</TC_DP3>
<TC_DP4>000.000</TC_DP4>
<TC_DP5>000.000</TC_DP5>
</TC_DP>
</DataElem>
<TC_DP>
<TC_DP3>-183.000</TC_DP3>
<TC_DP4>000.000</TC_DP4>
<TC_DP5>000.000</TC_DP5>
</TC_DP>
</DataElem>
<TDI>
<TDI_OBJECT_ID>nxt_drill_02_00038/A</TDI_OBJECT_ID>
<TDI_TOOLID_DESCRIPTION>D15.0 Zapfensenker/HSK63</
TDI_TOOLID_DESCRIPTION>
<TDI_TARGET_NODE>Helene</TDI_TARGET_NODE>
<TDI_TARGET_MAGAZINE>Kette_120</TDI_TARGET_MAGAZINE>
<TDI_TARGET_WORK>Legacy</TDI_TARGET_WORK>
</TDI>
</DataElem>
</ToolData>
<TransformationResult><![CDATA[
Startsequenz
#ST
Access MyData (AMD)

Einrichtplanname
#SA MatNr._Halter.
Maschinenname aus der Konfiguration
#MA
Adapter (Aufnahme
#MF
Programmname, hier wird aber der Name der Bearbeitungsfolge
eingetragen (TDI_WORK)
#PG
Werkzeugbezeichner hier Baugruppennummer
#WZ Werkzeugbeschreibung (-45001 Tool Description)
#WT D15.0 Zapfensenker/HSK63
Werkzeugbezeichner wie im NC-Programm
#TN HSK-Drill-6-5-E-2
ObjectID aus Teamcenter (Referenz)
#VA nxt_drill_02_00038/A
Halternummer (Materialnummer des Werkzeughalters)
#VB
Adapternummer
#VD
Schneidstoffnummer
#VE
#VM default
#VN default
Werkzeuggroessen
#VL 1
#VR 1
#VO 1
#VU 1
SCH1 = -191.000
SCH2 = -183.000
SCH3 =
SCH1 =
SCH2 =
SCH3 =
SCH1 =
SCH2 =
SCH3 =
SCH1 = 000.000
SCH2 = 000.000
SCH3 =
SCH1 =
SCH2 =
SCH3 =
SCH1 =
SCH2 =
SCH3 =
Messungsnummer (Schneiden)
#MP 1
Werkzeugtyp
#TA 231
Soll-Wert 1. Achse (Einstellmass_X) AP nicht definiert
Access MyData (AMD)

#G1 -191.000
Obere Toleranz 1. Achse
#O1
Untere Toleranz 1. Achse
#U1
Soll-Wert 2. Achse (Einstellmass_Z)
#G2 000.000
Obere Toleranz 2. Achse
#O2
Untere Toleranz 2. Achse
#U2
Messvorschrift Schneidentyp_1
Messungsnummer (Schneiden)
#MP 2
Werkzeugtyp
#TA 231
Messvorschrift Schneidentyp_1
#EN
]]></TransformationResult>
</PresettingData>
4.4.2.3 Presetting data (PUT)

The "Presetting data (PUT)" operation imports tool data sets into SFI.
The operation enables tool data to be transferred from tool setting stations.
For this operation, all tool data must be transferred.
Requirement
The "Presetting data (PUT)" operation is only available when SFI is installed. Otherwise,
access to this operation via the AMD interface is prevented.
If SFI is not installed and a client still calls the "Presetting data (PUT)" operation, the AMD
interface sends status code 503 (Service Unavailable) to the client. This is an indication to use
a different action "Action 117" and another URL address (…/amd/tools/v1/Actions).
Request protocol
● Method:
PUT
● AMD tools URL:
https://<AMD–Tools server IP>/amd/tools/v1/PresettingList/InventarNo
● Body:
<ToolData xmlns= "http://www.siemens.com/sinumerik/integrate">
<DataElem>
<TC_TP>
<TC_TP1>0</TC_TP1>
<TC_TP2>toolId</TC_TP2>
<TC_TP3>1</TC_TP3>
Access MyData (AMD)

<TC_TP4>1</TC_TP4>
<TC_TP5>1</TC_TP5>
<TC_TP6>1</TC_TP6>
<TC_TP7>1</TC_TP7>
<TC_TP8>10</TC_TP8>
<TC_TP9>0</TC_TP9>
</TC_TP>
<TC_DP>
<TC_DP2>1</TC_DP2>
<TC_DP6>0</TC_DP6>
<TC_DP7>0</TC_DP7>
<TC_DP8>0</TC_DP8>
<TC_DP9>0</TC_DP9>
</TC_DP>
<TC_MOP>
</TC_MOP>
</DataElem>
<TC_DP>
Access MyData (AMD)

<TC_DP2>1</TC_DP2>
</TC_DP>
</DataElem>
<TC_DP>
<TC_DP2>1</TC_DP2>
</TC_DP>
</DataElem>
<TDI>
<TDI_EXTERN_ID>externId</TDI_EXTERN_ID>
<TDI_OBJECT_ID>objectId</TDI_OBJECT_ID>
</TDI>
</DataElem>
</ToolData>
Response protocol
● Response code:
Empty body / 200 - ok
4.4.2.4 Measuring programs (GET)

The "Measuring programs (GET)" operation allows the measuring programs of Teamcenter to
be read via SFI.
Requirement
The "Measuring programs (GET)" operation is only available when SFI is installed. Otherwise,
If SFI is not installed and a client still calls the "Measuring programs (GET)" operation, the
AMD interface sends status code 503 (Service Unavailable) to the client.
Request protocol
● Method:
GET
● AMD tools URL:
https://<AMD–Tools server IP>/sfrm/svc/amd/MeasuringPrograms/Presetters/presetterId/
ObjectIDs/objectId
● Parameters:
presetterId (string(64))
objectId (string(64))
Access MyData (AMD)

Response protocol
Arbitrary XML content
Example
<?xml version="1.0" encoding="utf-8" standalone ="yes"?>
<Data>
<SettingSheet>
<SettingSheetId></SettingSheetId>
<Machine>
<MachineId></MachineId>
<MachineName>TDI_MACHINE</MachineName>
</Machine>
<Adapter>
<AdapterId></AdapterId>
</Adapter>
<ToolList>
<ToolInList>
<Position>1</Position>
<Tool>
<Operation></Operation>
<SiemensTDIClassID></SiemensTDIClassID>
<SiemensTDIObjectID></SiemensTDIObjectID>
<ToolId></ToolId>
<DuploNo></DuploNo>
<LifetimeCondition></LifetimeCondition>
<Description></Description>
<LongComment></LongComment>
<TNo></TNo>
<TNoString></TNoString>
<Type></Type>
<Weight></Weight>
<Code></Code>
<ToolAngleNominal></ToolAngleNominal>
<Step>
<Position></Position>
<Type></Type>
<CES></CES>
<MsrMode></MsrMode>
<Focus></Focus>
<MsrRangeWidth></MsrRangeWidth>
<MsrRangeHeight></MsrRangeHeight>
<XNominal></XNominal>
<XUpperTol></XUpperTol>
<XLowerTol></XLowerTol>
<YNominal></YNominal>
<YUpperTol></YUpperTol>
<YLowerTol></YLowerTol>
<ZNominal></ZNominal>
<ZUpperTol></ZUpperTol>
<ZLowerTol></ZLowerTol>
<RadiusNominal></RadiusNominal>
<RadiusUpperTol></RadiusUpperTol>
Access MyData (AMD)

<RadiusLowerTol></RadiusLowerTol>
DoMeasure>True</DoMeasure>
<MsrProgram OwnerTypeFullName="" Number=""/>
</Step>
</Tool>
</ToolInList>
</ToolList>
</SettingSheet>
</Data>
4.4.2.5 Measuring programs (PUT)

The "Measuring programs (PUT)" operation allows measuring programs to be written in
Teamcenter via SFI.
Requirement
The "Measuring programs (PUT)" operation is only available when SFI is installed. Otherwise,
If SFI is not installed and a client still calls the "Measuring programs (PUT)" operation, the AMD
interface sends status code 503 (Service Unavailable) to the client.
Request protocol
● Method:
PUT
● AMD tools URL:
https://<AMD–Tools server IP>/sfrm/svc/amd/MeasuringPrograms/Presetters/presetterId/
ObjectIDs/objectId ObjectIDs/objectId
● Parameters
presetterId (string(64))
objectId (string(64))
● Body
Arbitrary XML content
Example
<?xml version="1.0" encoding="utf-8" standalone ="yes"?>
<Data>
<SettingSheet>
<SettingSheetId></SettingSheetId>
<Machine>
<MachineId></MachineId>
<MachineName>TDI_MACHINE</MachineName>
</Machine>
<Adapter>
<AdapterId></AdapterId>
</Adapter>
<ToolList>
<ToolInList>
Access MyData (AMD)

<Position>1</Position>
<Tool>
<Operation></Operation>
<SiemensTDIClassID></SiemensTDIClassID>
<SiemensTDIObjectID></SiemensTDIObjectID>
<ToolId></ToolId>
<DuploNo></DuploNo>
<LifetimeCondition></LifetimeCondition>
<Description></Description>
<LongComment></LongComment>
<TNo></TNo>
<TNoString></TNoString>
<Type></Type>
<Weight></Weight>
<Code></Code>
<ToolAngleNominal></ToolAngleNominal>
<Step>
<Position></Position>
<Type></Type>
<CES></CES>
<MsrMode></MsrMode>
<Focus></Focus>
<MsrRangeWidth></MsrRangeWidth>
<MsrRangeHeight></MsrRangeHeight>
<XNominal></XNominal>
<XUpperTol></XUpperTol>
<XLowerTol></XLowerTol>
<YNominal></YNominal>
<YUpperTol></YUpperTol>
<YLowerTol></YLowerTol>
<ZNominal></ZNominal>
<ZUpperTol></ZUpperTol>
<ZLowerTol></ZLowerTol>
<RadiusNominal></RadiusNominal>
<RadiusUpperTol></RadiusUpperTol>
<RadiusLowerTol></RadiusLowerTol>
<DoMeasure>True</DoMeasure>
<MsrProgram OwnerTypeFullName="" Number=""/>
</Step>
</Tool>
</ToolInList>
</ToolList>
</SettingSheet>
</Data>
Response protocol
● Response code:
Empty body / 200 - ok
Access MyData (AMD)

4.5 Example sequence Action 108

Using examples, this text describes the procedure for getting a list of the tools in a tool
magazine via the interface.
Requirements
● The MMT server must be installed and ready for use on the SI server.
● The MMT WebInterface must be activated.
● Ensure that the following entry exists under the Modules node in the MMT configuration
file "tdi_cfg.xml":
<OEM name="MMTWebInterface" assembly="MMTWebInterface.dll"
subscription_timeout="60000" response_validation="0" />
Procedure
To ensure that the tool container assignment of a machine can be read with the aid of Action
108, the name of the machine nodeId and of the magazine containerId must be known.
This must first be determined with the aid of Action 101 from the MMT shopfloor configuration
(unless this data is known).
1. Sending Action 101 in order to get the shopfloor configuration as a response. For this
purpose, the following XML-encoded string must be sent to the MMT server:
<Action ID="101"/>
2. After receipt has been confirmed, the server sends an XML-encoded response.
Access MyData (AMD)

3. The name of the machine nodeId and of the magazine containerId must be determined
from the response. The response returns the complete shopfloor tree, which the user sees
as a tree topology on the left in the basic "Overview" screen of the MMT user interface:
Figure 4-1 Procedure example
Access MyData (AMD)

4. Sending the Action 108 with the desired nodeId and containerId. For this purpose, the
following XML-encoded string must be sent to the MMT server:
<Action ID="108" Places="TOOlsOnly>
<MagList NodeId="nodeId" ContainerId="containerID"/>
</Action>
5. The MMT server sends a response, which contains the tool container assignment.
Figure 4-2 Result example
Access MyData (AMD)

4.6 Project information
4.6.1 Description of SINUMERIK tool parameter

The following table lists the parameters used by MMT for the WebInterface protocols, and
provides a short description of the individual parameters.
Parameter Description Example

EXT_ID Inventory number / external identification number
TC_TP1 Duplo number (number of the sister tool) "1"
TC_TP2 Tool identifier "DRILL012"
TC_TP3 Size to left in half locations "1"
TC_TP4 Size to right in half locations "1"
TC_TP5 Size upwards in half locations "1"
TC_TP6 Size downwards in half locations "1"
TC_TP7 Magazine location type of the tool "1" Default "9999"
TC_TP8 Tool status Transferred with "10" (re‐
0: Not released leased and measured).
1: Active tool (A)
2: Released (F)
4: blocked (G)
8: Measured (M)
16: Prewarning limit reached (P)
32: Tool is being changed (W)
64: Fixed-location-coded (P)
128: Tool has been used (E)
TC_TP9 Tool monitoring method
0: No tool monitoring
1: Tool life monitoring
2: Workpiece count monitoring
4: Monitoring cutting edge wear parameters using the wear limit
8: Monitoring the additive offset parameters using the wear limit
TC_TP10 Tool search type for replacement tools "0"
0: No strategy
1: Next duplo No.
2: Shortest way
TC_TPG1 Spindle number to which the monitoring data and the "Constant grinding
wheel peripheral speed" function (GWPS) refers.
Access MyData (AMD)


TC_TPG2 Chaining rule. Using this parameter, which is defined bit-by-bit, it is defined
as to which tool parameters from cutting edge 2 and cutting edge 1 are
chained with one another. If the value of one of the chained parameters is
changed, then this is automatically accepted for the other chained param‐
eter.
If the following bits are set, the corresponding parameters from D1 and D2
are chained:
Bit0: Tool type
Bit2: Geometry length1
Bit11: Wear length1
Bit12: Wear length2
Bit13: Wear length3
Bit20: Basic dimension / adapter dimension length1
TC_TPG3 Minimum wheel diameter
TC_TPG4 Minimum grinding wheel width
TC_TPG5 Actual width of grinding wheel
TC_TPG6 Maximum grinding wheel speed
TC_TPG7 Maximum grinding wheel peripheral speed
TC_TPG8 Inclination angle of inclined wheel in the current plane
TC_TPG9 Correction parameter for the "Constant grinding wheel peripheral speed"
function (GWPS). This specifies which correction value is used for GWPS,
tool monitoring and for centerless grinding. The value always refers to cut‐
ting edge D1.
3: Länge 1
4: Länge 2
5: Länge 3
6: Radius
TC_TPC1 User-defined tool parameter1
TC_TPC9 User-defined tool parameter9 "0"
TC_TPC10 User-defined tool parameter10 "0"
TC_DP1 Geometry - tool type
TC_DP2 Geometry - cutting edge position "1"
TC_DP3 Geometry – length 1 "120"
Access MyData (AMD)


TC_DP6 Geometry – radius "0"
TC_DP7 Geometry – corner radius (tool type 700; slotting saw) "0"
TC_DP8 Geometry – length 4 (tool type 700; slotting saw) "0"
TC_DP10 Geometry – Angle 1
TC_DP11 Geometry – angle 2 for tapered milling tools
TC_DP12 Wear – Length 1 "0"
TC_DP15 Wear – Radius "0"
TC_DP16 Wear – Groove width b / rounding radius "0"
TC_DP17 Wear – Projection k "0"
TC_DP19 Wear – Angle 1 "0"
TC_DP20 Wear – Angle 2 for tapered milling tools "0"
TC_DP21 Adapter – length 1 "0"
TC_DP24 Undercut angle "0"
TC_MOP Start of the cutting edge monitoring data "0"
TC_MOP1 Prewarning limit for tool life in minutes
TC_MOP2 Remaining tool life in minutes
TC_MOP3 Prewarning limit for workpiece count "0"
TC_MOP4 Remaining workpiece count "0"
TC_MOP11 Planned tool life "0"
TC_MOP13 Target unit quantity "0"
TC_MOP5 Prewarning limit for wear (prewarning limit) "0"
TC_MOP6 Remaining wear (actual value) "0"
TC_MOP15 Setpoint for wear "0"
TC_DPC1 User-defined tool cutting edge parameter 1 "0"
TC_DPC10 User-defined tool edge parameter 10 "0"
TC_MOPC1 Monitoring user data 1 "0"
Access MyData (AMD)


4.6.2 Description of Teamcenter tool parameters

The following table lists all attributes of the Tooling Library (TLCUA).
Attribute Attribute Name Attribute Name Units Annotation

English German
-500000 Main Edge Clear‐ Hauptschn.-Frei‐ °° Alpha A ALPHA
ance Angle winkel
-500001 Edge-Clearance Nebenschn.-Frei‐ °° Alpha 2 A ALPHA2
Angle winkel
-500002 Incline Angle Nom/ Neigungswinkel °° Delta n A APPRO
Max. Nom/Max
-500003 Cutting Edge An‐ Schneideckenfa‐ °° KF A CHAMF
gle senwinkel
-500004 Taper Angle Kegelwinkel °° Alpha C A CONE
-500005 Rake Angle Spanwinkel °° Gamma A GAMMA
-500006 Helix Angle Drallwinkel °° Lambda A HELIX
-500007 Setting Angle Einstellwinkel °° Kappa A KAPPA
-500008 Setting Angle Left Einstellwinkel °° Kappa L A KAPPAL
Links
-500009 Setting Angle Right Einstellwinkel °° Kappa R A KAPPAR
Rechts
-500010 Immersion Angle Eintauchwinkel Al‐ °° Alpha 3 A PLUNGE
Alpha pha
-500011 Tip Angle Spitzenwinkel °° Sigma A SIGMA
-500012 Step Angle 1 Stufenwinkel 1 °° Phi 1 A STEP
-500013 Step Angle 2 Stufenwinkel 2 °° Phi 2 A STEP2
-500021 Incline Angle Min. Neigungswinkel °° Delta m A2APPRO
Min.
Access MyData (AMD)


English German
-500022 Setting Angle 2 Einstellwinkel2 °° Kappa2L A2KAPPAL
Left Links
-500023 Setting Angle 2 Einstellwinkel2 °° Kappa2R A2KAPPAR
Right Rechts
-500024 Cutting Depth Max. Schnitttiefe Max. mm inch ap max CUTDEPTH
-500025 Tool Holder Diam‐ Aufnahmendurch‐ mm inch DA D
eter messer
-500026 Internal Circle Eingeschriebener mm inch D CIRCLE
Kreis
-500027 Diameter Rough Vorbohrdurch‐ mm inch D Drill D CORE
Drilling messer
-500028 Front-Face Inner Stirnflächeninnen‐ mm inch Df D CORE
Diameter durchmesser
-500029 Body Diameter Anschlussdurch‐ mm inch DHB D HUB
messer
-500030 Minor Diameter Innendurchmesser mm inch Di D INSIDE
-500031 Max. Diameter Max. Durchmesser mm inch Dmax D MAX
-500032 Min. Diameter Min. Durchmesser mm inch Dmin D MIN
-500033 Min. Insert Diame‐ Min. Einsatzdurch‐ mm inch Dminax D MIN AX
ter Axial messer Axial
-500034 Min. Insert Diame‐ Min. Einsatzdurch‐ mm inch Dminrad D MIN RA
ter Radial messer Radial
-500035 Pin Diameter Zapfendurchmess‐ mm inch DP D PIN
er
-500036 Shank Diameter Schaftdurchmess‐ mm inch DS D SHANK
er
-500037 Diameter Profile Profilkreisdurch‐ mm inch d D SHAPE
Circle messer
-500038 Thread Diameter Gewindedurch‐ mm inch DT max D TMAX
Max messer Max.
-500039 Thread Diameter Gewindedurch‐ mm inch DT min D TMIN
Min. messer Min.
-500040 Major Diameter Außendurchmess‐ mm inch D1 D1
Step 1 er Stufe1
-500041 External Diameter Außendurchmess‐ mm inch D2 D2
Step 2 er Stufe2
-500042 External Diameter Außendurchmess‐ mm inch D3 D3
Step 3 er Stufe3
-500043 Shoulder Diameter Bunddurchmesser mm inch DSH DA
-500044 Cutting Depth Min. Schnitttiefe Min. mm inch ap min DCUT MIN
-500045 Profile Name Profilname CED DESIGN
-500046 Diameter Refer‐ Durchmesser mm inch DRC1 DT1
ence Circle 1 Teilkreis 1
-500047 Diameter Refer‐ Durchmesser mm inch DRC2 DT2
ence Circle 2 Teilkreis 2
Access MyData (AMD)


English German
-500048 Chamfer Cutting Schneideckenfase mm inch F FACET
Edge
-500049 Flat End Planschneiden‐ mm inch F2 FACET W
fase
-500050 Finishing? Schlichten? FIN FINISH
-500051 Shank Height Schafthöhe mm inch H H
-500052 Height Of Milling Fräserhöhe mm inch Lh H
Tools
-500053 Height Höhe mm inch H HEIGHT
-500054 Twist Direction Drallrichtung Helix HELIX
-500055 Internal Coolant Kühlung IC ICOOLANT
-500056 Tip Length Spitzenlänge mm inch a L AMASS
-500057 Displace Length Versatzlänge mm inch a L AMASS
-500058 Front-Face Depth Stirnflächentiefe mm inch Lf L CORE
-500059 Square Length Vierkant Länge mm inch LSQ L SQUARE
-500060 Total Length Com‐ Gesamtlänge mm inch ltot L TOTAL
ponent Komponente
-500061 Length Step 1 Länge Stufe1 mm inch L1 L1
-500062 Cutting Edge Schneidkanten‐ mm inch CEL1 L1 EDGE
Length 1 länge 1
-500064 Cutting Edge Schneidkanten‐ mm inch CEL2 L2 EDGE
Length 2 länge 2
-500066 Max. Machining Max. Arbeitstiefe mm inch L4 L4
Depth
-500067 Cutting Edge Schneidenlänge mm inch Ls LC
Length
-500068 Restricted Edge Begrenzte Schnei‐ mm inch RCEL LC EDGE
Length denlänge
-500069 Max. Drilling Max. Bohrtiefe mm inch max BDH LH DRILL
Depth Horizontal Horizontal
-500070 Max. Drilling Max. Bohrtiefe mm inch max BDV LV DRILL
Depth Vertical Vertikal
-500071 Hub Length Nabenlänge mm inch HBL NB
-500072 Setup Overhead? Einspannung OVH OVERHEAD
Überkopf?
-500073 Pitch Nom/Max. Gewindesteigung mm inch p max PITCH T
Nom/Max.
-500074 Pitch Min. Gewindesteigung mm inch pitch m PITCHMIN
Min.
-500075 Cutting Edge Radi‐ Schneideckenra‐ mm inch RE1 R CORNER
us 1 dius1
-500076 Form Radius 1 Formradius1 mm inch R1 R FORM
-500077 Form Radius 2 Formradius2 mm inch R2 R KONKAV
Access MyData (AMD)


English German
-500078 Cutting Edge Radi‐ Schneideckenra‐ mm inch RE2 R2CORNER
us 2 dius2
-500079 Insert Seat Size Plattensitzgröße mm inch ISS SIZE
-500080 Cutting Direction Drehrichtung CDL SPIN
-500081 Key Width Schlüsselweite mm inch KW SW
-500082 Main Edge Clear‐ Hauptschn.-Frei‐ Alpha 1 T ALPHA
ance Angle (Iso winkel Iso-Code
Code)
-500083 Machining Tech‐ Zerspanungstech‐ BA T METHOD
nology nologie
-500084 Insert Tolerance Plattentoleranz T T TOL
Iso-Code Iso-Code
-500086 Size Indexable In‐ Wendeplatten‐ T TYP
sert größe
-500087 Cutting Edges Schneidkante‐ CET TCUTEDGE
nausführung
-500088 Chamfer Form Anschnitt-Form CF TECHAM
-500089 Pitch Thread/Inch Steigung Gang/ Gear/In TEETH
Zoll
-500090 Theorethical Point Theoretischer mm inch TPX THEO X
X Punkt X
-500091 Theoretical Point Z Theoretischer mm inch TPZ THEO Z
Punkt Z
-500092 Thickness Of Cut‐ Schneidplatten‐ mm inch S THICKN
ting Insert dicke
-500093 Type Of Thread Gewindeart THS THRDFORM
-500094 Tool Tolerance Toleranz Werk‐ TT TOLERANC
zeug
-500095 Construction Code Konstruktion‐ CC TRAIT
smerkmal
-500096 Grooving Width Stechbreite mm inch wp W CUT
-500097 Width Of True Breite Spanflä‐ mm inch TRF-W W FACET
Rake Flat chenfase
-500098 Max. Tool Width Max. Werkzeug‐ mm inch W W MAX
breite
-500099 Width/Diameter Of Schaftbreite/ mm inch SW/D1 W SHANK
Shank Schaftdurchmess‐
er
-500100 Sitting Width Max. Schnittbreite Max. mm inch ae max WCUT MAX
-500101 Sitting Width Min. Schnittbreite Min. mm inch ae min WCUT MIN
-500102 Weight Gewicht kg kg WEIGHT
-500103 Coil Length Bundlänge mm inch LC WIDTH
-500104 Gauge Length Auskraglänge mm inch xs XS
Component Komponente
-500105 Gauge Length Min. Auskraglänge Min. mm inch Xsmin XS MIN
Access MyData (AMD)


English German
-500106 Cutting Edge Schneidenlänge 2 mm inch Ls2 XS2
Length 2
-500107 Gauge Length 2 Auskraglänge 2 mm inch Xs2 XS2
Length 3
Length 4
Length 5
Length 6
Length 7
Length 8
Length 9
-500117 Wheel Diameter Scheibendurch‐ mm inch Dc YS
messer
-500118 Cutting Diameter Schneidendurch‐ mm inch Dc YS
messer
-500119 Movement Tool Wkz-Schneiden‐ mm inch Ys YS
Edges verschiebung
-500120 Wheel Diameter Scheibendurchm. mm inch Dcmax YS MAX
Max. Max.
-500121 Wheel Diameter Scheibendurchm. mm inch Dcmin YS MIN
Min. Min.
-500122 Ys100 Powered Ys100 Angetrie‐ mm inch YS100 YS100
ben
-500123 Cutting Diameter 2 Schneidendurch‐ mm inch Dc2 YS2
messer 2
-500124 Movement Tool Wkz-Schneiden‐ mm inch Ys2 YS2
Edges 2 verschiebung 2
messer 3
messer 4
messer 5
messer 6
Access MyData (AMD)


English German
messer 7
messer 8
messer 9
-500134 Corner Angle Schneidenecken‐ °° Sigma AISIGMA
winkel
-501000 Tool Holder Aufnahme ADAPTERID
-501001 Insert Geometry 1 Plattengeometrie 1 IT1
-501005 Number Insert Ge‐ Anzahl Plattengeo‐ COUNTWSP1
ometry 1 metrie 1
ometry 2 metrie 2
ometry 3 metrie 3
ometry 4 metrie 4
-501009 Cartridge Seat 1 Kassettensitz 1 CARTRIDGE1
-501010 Cartridge Seat 2 Kassettensitz 2 CARTRIDGE2
-501011 No. Teeth Anzahl Schneiden Z
-501012 Cutter Material Schneidstoff CUTGRADEID
-501013 Supplier Lieferant SHORTNAME
-501014 Interface To Work‐ Trennstelle Werk‐ CONNECTORI‐
piece stückseitig DIN
-501015 Interface To Ma‐ Trennstelle Ma‐ CONNECTORID‐
chine schinenseitig OUT
-501016 Size Interface To Größe Trennstelle sizein
Workpiece Werkstückseitig
-501017 Size Interface To Größe Trennstelle sizeout
Machine Maschinenseitig
-501018 Description Bezeichnung NAME
-501019 Macro Name Makroname TEMPLATE
-501020 Model Name Modellname MODEL
-501021 No. Steps Anzahl Stufen COUNTSTAGE
-501022 Order Number Bestellnummer ORDERNUMBER
-501023 Interface To Work‐ Trennstelle Werk‐ COLLETNAME
piece Graphical stückseitig Grafik
-501024 Master Insert Meisterplatte INS MASTER
-501026 Tool Number Toolnummer TOOLNUMBER
-501029 Length 1 Länge 1 mm inch TCLGTH1
-501030 Diameter 1 Durchmesser 1 mm inch TCDIA1
Access MyData (AMD)


English German
-501039 List Of Insert Passende Wende‐ INSERTID1
Types 1 plattentypen 1
-501043 Total Length Gesamtlänge mm inch Ltot LTOTTOT
-501044 Gauge Length Auskraglänge mm inch Xs XSTOT
-501045 Interface To Ma‐ Trennstelle Ma‐ ADAPTERNAME
chine Graphical schinenseitig Gra‐
fik
-501046 Setup X-Value Einstellmaß X mm inch
-501047 Setup Y-Value Einstellmaß Y mm inch
-501058 Tracking Point Schneidenlage TRP
-501061 Cutter Material Schneidstoff Norm CUTGRADE‐
Norm NAME
-501062 Catalog Object Id Katalog Object Id
-501063 Catalog Refer‐ Katalog Referenz‐
ence Date datum
Access MyData (AMD)


English German
-501094 Taper Angle 1 Kegelwinkel 1 °°
-501095 Taper Angle 2 Kegelwinkel 2 °° TCTA2
-501114 Corner Radius 1 Eckenradius 1 mm inch TCCR1
Access MyData (AMD)


English German
-501134 NX Tool Type NX Werkzeugtyp
-501135 Taper Angle 20 Kegelwinkel 20 °° TSTA20
-501136 Length 20 Länge 20 mm inch TSLGTH20
-501137 Diameter 20 Durchmesser 20 mm inch TSDIA20
Access MyData (AMD)


English German
-501195 Adapter Axis Adapterachse ADAX
-501196 Rotation Axis Rotationsachse ROAX
-501200 Rad Id Rad Id
-501201 Adjust Register Adjust Register
-501202 Cutcom Register Cutcom Register
-501203 Form Of Indexable Wendeplattenform T SIGMA
Insert
-501294 Side Angle Seitenwinkel °° a2 A A2
Access MyData (AMD)


English German
-501295 Orientation Angle Orientierungswin‐ °° A KAPPAO
kel
-501296 Insert Shape Stechplattenform INSHAP
4.6.3 Description of the SFI tolerance values
4.6.3.1 Tolerance values and calculation

Tolerance values are defined in order to be able to intercept unrealistic actual values that could
cause damage to the machine or the tool setting station.
These tolerance values can be optionally stored by the user for all geometry data in the
Teamcenter catalog (MRL: Manufacturer resource Library).
Cutting edge parameters
SINUMERIK attribute TC attribute Attribute ID Description

TC_DP3 Nominal setup X value -45002 Geometry length X
Attribute "upperTolerance" of Upper tolerance for X value -43004 Upper tolerance limit for the X axis
TC_DP3 Is attached to the "TC_DP3" XML tag as
attribute, if available.
Attribute "lowerTolerance" of Lower tolerance for X value -43005 Lower tolerance limit for the X axis
TC_DP4 Nominal setup Y value -45003 Geometry length Y
Attribute "upperTolerance" of Upper tolerance for Y value -43006 Upper tolerance limit for the Y axis
Attribute "lowerTolerance" of Lower tolerance for Y value -43007 Lower tolerance limit for the Y axis
TC_DP5 Nominal setup Z value -45004 Geometry length Z
Attribute "upperTolerance" of Upper tolerance for Z value -43008 Upper tolerance limit for the Z axis
Attribute "lowerTolerance" of Lower tolerance for Z value -43009 Lower tolerance limit for the Z axis
Specification of nominal and tolerance values

The nominal values (setup X, setup Y and setup Z) are always specified as specific
coordinates. Each value mirrors the position in 3D space.
Access MyData (AMD)

In contrast, tolerance values always describe the "difference". They are always incremental
values.
The upper tolerance is a positive value and the lower tolerance is a negative value. The "valid
range" is calculated through the addition of the nominal values with the tolerance values.
"Valid range" sample calculation

The valid range for a setup X tracking point is:
From: <Setup X> + <X_LT>

To: <Setup X> + <X_UT>
Values:
X= -123
X_UT (upper tolerance) = 0.4
X_LT (lower tolerance) = -0.3
Calculation and result
From: -123 + -0.3 =-123.3

To: -123 + 0.4 = -122.6
4.6.3.2 Input
The input of the tolerance values is optional. If no tolerance values are stored in the
Teamcenter, then there is no check with regard to compliance with the tolerance values. It is
possible to only store the upper or only the lower tolerance value in the Teamcenter.
In SFI, the catalog data from Teamcenter is transformed on the basis of a transformation to
the SINUMERIK NCU840D format, and treated internally as an XML document. Whereby, TC
attributes are converted to the SINUMERIK tool parameters.
Example of transformed data:

Example: The TC attribute -45002 "Nominal Setup X value" is transformed to the TC_DP2
–"length 1".
<TC_DP3>10</TC_DP3>
<TC_DP4>20</TC_DP4>
<TC_DP5>-134.900</TC_DP5>
Example of the extension of the transformation by tolerance values:

The transformation must be extended by the tolerance values defined by the user in
Teamcenter.
<TC_DP3 upperTolerance="0.500" lowerTolerance="-0.5000">10</TC_DP3>

<TC_DP4 lowerTolerance"-1.200">20<TC_DP4>
<TC_DP5>-134.900<TC_DP5>
Access MyData (AMD)

Error
In this section, error means that the tolerances have not been complied with.
In this case, the interface is acknowledged negatively with an error code. If the tolerance values
are not defined in the Teamcenter, there is no tolerance check.
<TC_DP>
<TC_DP3 upperTolerance="000.100"lowerTolerance="-000.200">-005.000</TC_DP3>
<TC_DP6>000.000</TC_DP6>
</TC_DP>
In order to inform the tool presetting station of the tolerance values, they are provided in the
NCU840D format (with additional attributes) via the transformation file at „.../amd/tools/v1/
PresettingList/{inventarNo}“ (GET). The tolerance values are then visualized on the tool
presetting station for the user.
Action 117 is extended by the check of the actual values with regard to compliance with the
tolerances. The check is only performed when the tool master data is used. In case of an error,
action 117 is acknowledged negatively with an error code. If the tolerance values are not
defined in the tool master data, there is no check.
Example: Reference value = -5
<TC_DP>
<TC_DP6>000.000</TC_DP6>
</TC_DP>
In this case, the following message appears:

Status: 400 Bad Request - actual value is too high
4.6.4 Transforming catalog data into the SINUMERIK 840D format
4.6.4.1 Adapting catalog data project-specifically

In order to set tools in Manage MyTools, the catalog data from Teamcenter must be
transformed into the format of SINUMERIK 840D.
The transformation is performed via a script, the transformation script. The script is an XML
document.
Access MyData (AMD)

Since the attributes in Teamcenter are freely assigned, you must adapt the script project-
specifically according to the attribute IDs. Which attribute from the catalog corresponds to
which XML tag in the template is specified in the script, see also the following Section:
● Tool parameters (Page 114)
● Cutting edge parameters (Page 115)
● Cutting edge-related tool monitoring parameters (Page 116)
● External user parameters (Page 116)
Since the script is overwritten with the transformation script from the current software delivery
at every new installation, store the project-specific script with the same name, "NCU840D.xml",
in a different directory.
Note
Name of the transformation script
The standard file name is "NCU840D". Note that with a project-specific adaptation, the name
of the template must match the name of the transformation script. When using the functions
to access tool information, transfer the file name subsequently as "transformation" parameter,
otherwise the standard transformation script "NCU840D.xslt" is used.
Procedure
1. Open the ...\Siemens\SINUMERIK_Integrate\webapp\Scripts directory.
2. Open the "NCU840D.xml" XML file.
3. Adapt the parameters, see Section: Presetting data (PUT) (Page 89).
4. Save the file with the same name in the following directory: ...\Siemens
\SINUMERIK_Integrate\Database\webapp\Scripts.
4.6.4.2 Tool parameters
Overview
The following parameters are available for the tool data:
SINUMERIK pa‐ TC attribute Attribute ID Description

rameters
TC_TP1 Duplo number
Enter the duplo number.
Enter the value "0" if you want to assign
the duplo numbers automatically.
TC_TP2 Tool identifier
Enter the identifier.
TC_TP3 Size to the left
Default value = 1
Access MyData (AMD)


rameters
TC_TP4 Size to the right
Default value = 1
TC_TP5 Size upward
Default value = 1
TC_TP6 Size downward
Default value = 1
TC_TP7 Magazine location type
TC_TP8 Status
TC_TP9 Lifetime condition -40925 Tool monitoring method
Further information on tool parameters can be found in Section: Description of SINUMERIK

tool parameter (Page 98)
4.6.4.3 Cutting edge parameters
Overview
The following parameters are available for the cutting edge data:

rameters
TC_DP1 Class ID -611 Tool type
Is determined via the Class ID.
TC_DP2 Tracking point -45015 Cutting edge position
Only for turning tools (tool types
500-599).
TC_DP3 Nomin. setup X -45002 Geometry length X
value
"upperTolerance" Upper tolerance -43004 Upper tolerance limit for the X axis.
attribute of for X value Is attached to the "TC_DP3" XML tag as
TC_DP3 attribute, if available.
"lowerTolerance" Lower tolerance -43005 Lower tolerance limit for the X axis.
attribute of for X value Is attached to the "TC_DP3" XML tag as
TC_DP4 Nomin. setup Y -45003 Geometry length Y
value
"upperTolerance" Upper tolerance -43006 Upper tolerance limit for the Y axis.
attribute of for Y value Is attached to the "TC_DP4" XML tag as
"lowerTolerance" Lower tolerance -43007 Lower tolerance limit for the Y axis
attribute of for Y value Is attached to the "TC_DP4" XML tag as
TC_DP5 Nomin. setup Z -45004 Geometry length Z
value
Access MyData (AMD)


rameters
"upperTolerance" Upper tolerance -43008 Upper tolerance limit for the Z axis
attribute of for Z value Is attached to the "TC_DP5" XML tag as
"lowerTolerance" Lower tolerance -43009 Lower tolerance limit for the Z axis
attribute of for Z value Is attached to the "TC_DP5" XML tag as
TC_DP6 Circle radius -40091 (not for Geometry radius
tool type 520)
"upperTolerance" Upper tolerance -43010 Upper tolerance limit for the radius
attribute of for corner radius Is attached to the "TC_DP6" XML tag as
"lowerTolerance" Lower tolerance -43011 Lower tolerance limit for the radius
attribute of for corner radius Is attached to the "TC_DP6" XML tag as
4.6.4.4 Cutting edge-related tool monitoring parameters
Overview
The following parameters are available for the cutting edge-related tool monitoring data:

rameters
TC_MOP1 Warning time -40926 Prewarning limit
TC_MOP2 Default tool life -40925 Residual tool life corresponds to the be‐
ginning of the planned tool life
TC_MOP11 Default tool life -40925 Planned tool life
4.6.4.5 External user parameters
Overview
The following parameters are available for the external user data:

rameters
TDI_CLASS_ID Class ID -611 Class ID
This TC attribute is also used to deter‐
mine the tool type.
TDI_OBJECT_ID Object ID -599 Catalog ID
TDI_TOOLID_DE‐ Description -45001 Description
SCRIPTION
TDI_TOOL_COM‐ Comment -41210 Comment
MENT
Access MyData (AMD)


rameters
TDI_TOOL_NUM‐ Tool number -45235 Tool number
BER
TDI_EXTERN_ID Inventory number
The inventory number is used for the
clear identification of the tool.
This attribute is determined via SFI.
TDI_TAR‐ Specifies the scheduled supply date.
GET_TIME This attribute is determined via the res‐
ervation in SFI.
TDI_TAR‐ Specifies the target machine for which
GET_NODE the tool is reserved.
This attribute is determined via the res‐
ervation in SFI.
TDI_TAR‐ Specifies the target magazine for which
GET_MAGAZINE the tool is reserved.
ervation in SFI.
TDI_TAR‐ Specifies the machining sequence for
GET_WORK which the tool is reserved.
ervation in SFI.
TDI_TAR‐ Specifies the number for which work‐
GET_PART piece in the machining sequence the
tool is reserved.
ervation in SFI.
Access MyData (AMD)

Access MyData (AMD)

Access to NC program data 5
5.1 Introduction
This section describes an external interface of SINUMERIK Integrate (SI). The interface
described here provides external applications with access to functions and data of MMP, e.g.
for managing NC programs. The interface is implemented as Web service and is based
on .NET and WCF technology.
The interface enables access to NC program data and is part of the product AMD (Access
MyData).
The interface requires an operational SINUMERIK Integrate server and the operationally
installed Manage MyPrograms (MMP) application.
The interface is divided into the parts: Plant layout (PlantLayout), managed NC data in the
MMP server (DncContent) and NC data directly in the file system of the machine
(MachineDncFunctions). In the same way, the plant structure is displayed in the left area in
the MMP user interface, the managed data on the server on the right, and the data in the file
system of the machine in the transfer-back dialog.
Access MyData (AMD)

Access to NC program data
5.2 Concept
5.2 Concept
5.2.1 Requirement
The use of the interface requires a previously installed and correctly configured SI server with
version 4.1 or higher. Version 4.0 or higher of .NET Framework is also required.
A further requirement is that the user of the interface is familiar with the product MMP (Manage
MyPrograms) and has sufficient knowledge in programming for web service interfaces.
It is only possible to use identifiers.
The interfaces (implement the DNC functions for NC programs) are not active after the
installation. To activate the interface, you must edit the file "....\DNC\AMD-DNC\web.config" in
the installation directory of the MMP server.
5.2.2 Activate interface
Procedure
To activate the server interface, you must edit the "....\DNC\AMD-DNC\web.config" file in the
installation directory of the MMP server. For the entry httpRuntime, you must change the
attribute enable to true.
<system.web>


<httpRuntime enable="true" maxRequestLength="2147483647"
executionTimeout="103600"/>
</system.web>
5.2.3 Deactivate interface
Procedure
To deactivate the server interface, you must edit the "....\DNC\AMD-DNC\web.config" file in
the installation directory of the MMP server. For the entry httpRuntime, you must change
the attribute enable to false.
<system.web>


<httpRuntime enable="false" maxRequestLength="2147483647"
executionTimeout="103600"/>
</system.web>
Access MyData (AMD)

5.3 Description of the interfaces
Overview of the web service interface
Access MyData (AMD)

Interface for the plant structure

NodeIdentifiers are needed to access the levels of the MMP administrative structure and
to address the machines. Going from this level, the subordinate items (e.g. folders and files)
are referenced in the MMP administrative structure and in the file system of the machine.
° Name Description
List<PlantLayoutNode> Lists the nodes that belong to the plant struc‐
ListNodes( NodeIdentifier parent, ture.
PlantLayoutFilter filter ) The function only lists one level.
ListNodesWithChildren( NodeIdentif ture.
ier parent, PlantLayoutFilter The function lists all of the levels under the pa‐
filter ) rent node.
To receive all of the nodes from the topmost level of the plant structure on, use the constant
null as Id for the parameter parent. With the parameter filter, you can restrict the result
by node names and node types of the plant structure. To get exactly one node in the plant
structure, it is sufficient to filter by the node name (nodes with the same name cannot have
the same predecessor (parent)). For ListNodesWithChildren(), it is possible that
several nodes with the same name will be found on different levels of the plant structure. The
filter for the name of the node is case sensitive.
Access MyData (AMD)

5.4 The type of a machine

A type is assigned to each machine in the MMP system. The type is defined when a machine
is created in MMP. Depending on this setting, various operations are possible in the file system
of the machine.
The returned identifiers can be changed while the MMP server is operating by deleting and
adding groups and machines in the plant hierarchy, and should not be saved outside the MMP
system.
Interface for NC data on the MMP server
IDNCContent
This interface provides access to the workpieces, NC packages, NC files, file attachments,
and the assigned metadata that is managed by the MMP server.
Name Description
void Remove nodes from the MMP server.
DeleteNodes( List<NodeIdentifier> Deletes nodes of the type ContentNode.
identifiers )
Delete a list of nodes with specified ID
StreamingTicket Export attachment from the MMP server.
ExportAttachment( NodeIdentifier With the StreamingTicket, the FileTransfer in‐
id, out AttachmentNodeInfo info ) terface (DownloadFile) must then be used to
access the contents of the file.
The AttachmentNodeInfo object contains
metadata for the file attachment
ExportPackageInfo Export package from the MMP server.
ExportPackage( NodeIdentifier id ) The return value contains information about
the contents of the package and the associated
StreamingTickets for the file contents. With the
StreamingTicket, the file contents must then be
read out on the FileTransfer interface (Down‐
loadFile).
StreamingTicket Export NC file from the MMP server.
ExportPartProgram( NodeIdentifier With the StreamingTicket, the FileTransfer in‐
id, out PartProgramNodeInfo terface (DownloadFile) must then be used to
partProgramInfo ) access the contents of the file. The object
PartProgramNodeInfo contains the meta‐
data from MMP.
ContentNode Complete upload.
FinalizeUpload( StreamingTicket Completes the upload of an imported item. On‐
ticket ) ly in this way is the data in the MMP adminis‐
tration saved.
Access MyData (AMD)

Name Description
StreamingTicket Import attachment into the MMP server.
ImportAttachment( NodeIdentifier Imports an attachment under an NC file or an
parent, AttachmentNodeInfo info ) NC package.
With the StreamingTicket, the FileTransfer in‐
terface (UploadFile) must then be used to
transfer the contents of the file.
The import procedure must be completed with
a FinalizeUpload
ContentNode Create package in the MMP server.
ImportPackage( NodeIdentifier Regardless of the type attribute, this creates
parent, PackageNodeInfo info ) an NC package or a workpiece folder under a
machine group or machine node. Only the
name and the type attributes need to be set in
the PackageNodeInfo parameter for a work‐
piece folder. Then the assigned NC files can
be imported with the returned ContentNode.
StreamingTicket Import NC file into the MMP server.
ImportPartProgram( NodeIdentifier Imports an NC file under a machine group
parent, PartProgramNodeInfo node, machine node, workpiece node, or NC
partProgramInfo, string package node.
versionToOverwrite )
terface (UploadFile) must then be used to send
the contents of the file to the server.
If versionToOverwrite is not equal to "0",
the part program is imported with the specified
version and any existing version of the NC file
is overwritten.
a FinalizeUpload
List<ContentNode> List nodes in the MMP server.
ListNodes( NodeIdentifier parent, Lists the nodes of the type ContentNode lying
Filter filter ) directly under the parent node with a specified
filter.
ListNodesWithChildren( NodeIdentif Lists all the nodes of the type ContentNode un‐
ier parent, Filter filter ) der the parent node and all the subnodes with
a specified filter.
Access MyData (AMD)

Name Description
void Sets the trial cut ID or the
SetAvailableForTrialCutFlag( NodeI AvailableForTrialCut flag.
dentifier id, string Without trial cut ID or release ID, an NC file
versionToSetFlag, bool value ) cannot be transferred to the machine.
This function is used to set the trial cut ID for a
node with the specified version.
void Sets the Released flag.
SetReleasedFlag( NodeIdentifier Without trial cut ID or release ID, an NC file
id, bool value, bool cannot be transferred to the machine.
resetAvailableForTrialCutFlag )
Sets the release ID of a node
The trial cut ID can be reset at the same time.
If the release ID for a part program is set, the
release ID of the previously released version
of the NC file is automatically reset.
The parent NodeIdentifiers reference nodes of the PlantLayout interface (e.g. to reference
the machine level in the plant tree as the target of an operation) or of the DNCContent interface
(e.g. to reference a workpiece folder of a machine as a target of an operation). The id
NodeIdentifiers reference items as they are returned by the system as lists via the
ListNodes() or ListNodesWithChildren().
The returned identifiers can be changed while the MMP server is operating by deleting and
adding files and folders, and should not be saved outside the MMP system.
A ContentFilter can be transferred to restrict the result list of the methods ListNodes() and
ListNodesWithChildren().
Interface for access to the file system of the machine
IMachineDncFunctions
The functions of this interface are for direct access to the machines and the data in the file
system of the machine. Not all of the methods are supported by all machine types. Therefore,
before calling a method using GetCapabilities(), a check should be made as to whether
the machine can process the desired operation. Operations in the file system of the machine
can only be successful if the machine is online. Therefore, before calling a method using
Access MyData (AMD)

GetMachineStatus(), a check should be made as to whether the machine can process the
jobs.
Name Description
void Deletes a list of items on a machine.
DeleteOnMachine( NodeIdentifier
machine, List<MachineDncItem>
itemsToDelete )
List<DncMachineCapabilities> Provides the capabilities of a machine. De‐
GetCapabilities( NodeIdentifier pending on the machine technology and the
machine ) type of connection to MMP, only a part of the
scope of functions of the interface can be used.
MachineDncStatus Returns the status of a machine ("online", "off‐
GetMachineStatus( NodeIdentifier line", "unknown").
machine )
List<MachineDncItem> Lists the items on a machine.
ListItemsOnMachine( NodeIdentifier
machine )
void Transfers a list of items from the file system of
TransferFromMachine( NodeIdentifie a machine to a level in the administrative struc‐
r machine, NodeIdentifier parent, ture on the MMP server.
List<MachineDncItem>
itemsToTransfer )
void Transfers a list of items to a destination speci‐
TransferToMachine( NodeIdentifier fied with the TransferOptions object in the file
machine, List<NodeIdentifier> system of the machine.
itemsToTransfer, TransferOptions
transferOptions )
void SelectItem(NodeIdentifier Selects an item for a channel.
machine, MachineDncItemIdentifier
item, uint channel )
void DeselectItem(NodeIdentifier Deselects the selected NC program in a chan‐
machine, uint channel ) nel.
StreamingTicket Imports an NC file directly into the file system
ImportToMachine( NodeIdentifier of the machine
machine, MachineDncItem The program is not registered in the MMP sys‐
machineDncItem ) tem but only stored in temporary memory.
transfer the contents of the file to the server.
Access MyData (AMD)

Name Description
ExportMachineDncItem Exports an NC file directly from the file system
ExportFromMachine( NodeIdentifier of the machine.
machine, MachineDncItemIdentifier The program is not registered in the MMP sys‐
item ) tem but only stored in temporary memory.
The returned ExportMachineDncItem object
contains the file information and a streaming
ticket.
terface (DownloadFile) must then be used to
read the contents of the file from the server.
MachineDncItem Complete upload.
ticket ) ly in this way is the data saved on the machine.
The machine NodeIdentifiers reference machines in the plant structure of the MMP server
and thus indirectly the machine itself. These identifiers are received from the PlantLayout
interface. The parent NodeIdentifiers reference nodes of the PlantLayout interface (e.g. to
reference the machine level in the plant tree as the target of an operation) or of the DNCContent
interface (e.g. to reference a workpiece folder of a machine as a target of an operation). The
id NodeIdentifiers reference items as they are returned by the DncContent interface as lists
via the ListNodes() or ListNodesWithChildren().
The item NodeIdentifiers reference items in the file system of the machine. These are formed
by the method ListItemsOnMachine() from the file system of the machine. The returned
identifiers can be changed while the MMP server is operating by deleting and adding files and
folders in the machine, and should not be saved outside the MMP system.
If a StreamingTicket is created by the methods, then it is possible to use this ticket to make a
one-time access to the contents of the file with the "FileTransfer" interface. StreamingTickets
become invalid when the MMP software is restarted on the server.
Interface for transferring the contents of files
Access MyData (AMD)

The interface provides access to the file contents, which were initiated by a previous call of
the DncContent or DncMachineFunctions interface.
Name Description
Stream Receipt of the file contents from the MMP serv‐
DownloadFile(StreamingTicket er, identified by a DownloadTicket
downloadRequest)
StreamingTicket UploadFile(String Sending a file to the MMP server, identified by
CheckSum, String FileName, an upload ticket.
StreamingTicket streamingTicket, The checksum is currently not evaluated and
Stream FileByteStream) can remain blank. The file name must be iden‐
tical to the file name when the ticket is initiated
Note
For the transfer of larger file contents, the parameters for the maximum file size must be
adapted to the client application if necessary (MaxReceivedMessageSize and
maxBufferSize (e.g. 8388608 = 8 Mbyte)).
Interface for change notifications
Note
The interface for change notifications is not available in SINUMERIK Integrate.
IDNCNotificationRegistry
The external applications can subscribe to notifications for specific nodes. The notification is
then done via the INotificationCallback Interface, which of course must then also be
implemented in the external application
Access MyData (AMD)

Name Description
List<NotificationConfiguration> Returns the configuration of a notification.
GetNotificationConfiguration( Noti
ficationTarget target )
void Subscribing to a notification.
RegisterForNotification( Notificat
ionTarget target,
List<NotificationConfiguration>
notificationConfiguration )
void Unsubscribing a notification.
UnregisterForNotification( Notific
ationTarget target )
INotificationCallback
Clients must implement this interface for the notification.
Name Description
void Callback for the OnEvent.
OnEvent( List<DncNotificationEvent
> events )
Exceptions
If a call on the interface fails, exceptions with error information are initiated.
GeneralFault
Name Description
String Details The details of the error.
String Issue The issue of the error.
Access MyData (AMD)

ConnectionFault
ImportFault
DataReaderFault
UnknownFault
UploadFault
Access MyData (AMD)

5.5 Terms
5.5 Terms
Node, NodeInfo, ContentNode, PlantLayoutNode
A higher-level item is defined via the ParentNodeIdentifier attribute for each item. The
following table illustrates the possible relations. Only the topmost item Root, which itself has
no higher-level item, takes up a special position.
Parent
PlantLayoutNode ContentNode
Child Root Group Machine NC Work‐ NC file Attach‐
package piece ment
Group ✓ ✓ --- --- --- --- ---
Machine ✓ ✓ --- --- --- --- ---
NC package --- ✓ ✓ --- --- --- ---
Workpiece --- ✓ ✓ --- --- --- ---
NC file --- ✓ ✓ ✓ ✓ --- ---
Attachment --- --- --- ✓ --- ✓ ---
--- = not permitted ✓ = permitted
Access MyData (AMD)

5.5 Terms
Attachments can only be assigned to NC files and NC packages. NC files can be assigned to
groups, machines, NC packages, and workpieces. Workpieces and NC packages can be
assigned to groups and machines.
Access MyData (AMD)

5.5 Terms
Identifier
The nodes can be reached either with the ID of the MMP system or via the path supplemented
with the version.
Note
Only NodeByIdentifier is supported in SINUMERIK Integrate.
Package
In the external interface, a distinction is made between workpieces and NC packages by the
type attribute.
ExportPackageInfo
After an ExportPackage task, the client receives an ExportPackageInfo, which contains the
StreamingTickets for the export of the content of the package, the StreamingTickets for the
export of the attachments of the package, and the PackageNodeInfo.
Access MyData (AMD)

5.5 Terms
StreamingTicket
After an import job, the client receives a StreamingTicket. With the aid of this ticket, the contents
can be imported.
Access MyData (AMD)

5.6 Programs on the machine
5.6 Programs on the machine

The MachineDncItem class provides information on the NC files on a machine. The Repository
shows exactly where the item will be saved in the file system of the machine.
Access MyData (AMD)

5.7 The settings of the transfer
5.7 The settings of the transfer

It is possible to enter the destination during the transfer. The Repository shows exactly where
the item will be saved in the file system of the machine.
Access MyData (AMD)

5.8 Information about the machines
5.8 Information about the machines

A distinction is made between three statuses for each machine: Online, Offline, Unknown.
The states Online and Offline are only reported for machines which have "MachineStatus"
capability.
Access MyData (AMD)

5.9 The capabilities of a machine
5.9 The capabilities of a machine

It is possible to request the capabilities of any machine.
Ability Description
DeleteItem It is possible to delete files in the file system of the machine.
TransferItem It is possible to transfer files from the MMP management to the machine and vice
versa.
DirectTransferI‐ It is possible to transfer files past the MMP management to and from the machine.
tem The data is not saved in the administrative structure of the MMP server during this.
ListItems It is possible to obtain the contents of the file system of the machine as a list. The
respective MMP client software on the machine determines the contents of the list.
SelectItem It is possible to select NC programs for processing in a channel. This option is
currently only offered by machines with the SINUMERIK Powerline and Solutionline
controllers.
MachineStatus The user can see on the interface whether the MMP software client (MMP IFC for
SINUMERIK, MMP for Operate, MMP interface client for third-party controllers) is
active. Machine types that require interactive operation (serial connection, ma‐
chines of the Filesystem type) do not provide an "online" signal.
The technological capabilities of the machine determine which operations are possible in the
file system of the machine.
Access MyData (AMD)

5.10 Test program
5.10 Test program

Relevant functions are used in examples in the test program.
The functions of the test program are described in the following sections. The test program is
divided into 3 areas:

① Area 1 provides functions for displaying and filtering the plant structure and encompasses the top left area and the
project tree under it.
② Area 2 provides functions for displaying and filtering the file management and encompasses the top center area
and the file tree under it.
③ Area 3 provides functions for importing, exporting, transferring and querying settings.
Range 1: Plant structure
Checkbox Description
Powerline Shows all Powerline controllers configured in MMP
Solutionline Shows all Solutionline controllers configured in MMP
Third-party controller Shows all of the third-party controllers configured in MMP
File system Shows all of the file systems configured in MMP
Serial interface Shows all of the controllers with a serial interface configured in MMP
All levels per call Shows all of the levels in the plant structure
In the top left area, filter properties can be set for the plant structure with the aid of the
checkboxes. Click the "Refresh" button to update the underlying plant tree with the following
function:
If the "All levels per call" checkbox is enabled:
Name Description
ListNodesWithChildren( NodeIdentif ture.
ier parent, PlantLayoutFilter The function lists all the levels below the "pa‐
filter ) rent" node.
If the "All levels per call" checkbox is not enabled:
Name Description
ListNodes( NodeIdentifier parent, ture.
PlantLayoutFilter filter ) The function only lists one level.
Access MyData (AMD)

5.10 Test program
Range 2: File Management
Checkbox Description
Programs Shows NC programs which are saved on the server for the selected machine
Packages Shows NC packages, which are saved on the server for the selected machine
Attachments Shows attachments which are saved on the server for the selected machine
All levels per call Shows all of the levels in the file management
In the top central area, filter properties can be set for the file management with the aid of the
checkboxes. Click the "Refresh" button to update the underlying plant tree with the following
function:
If the "All levels per call" checkbox is enabled:
Name Description
ListNodesWithChildren( NodeIdentif Lists all the nodes of the type ContentNode
ier parent, Filter filter ) under the "parent" node and all the subnodes
with a specified filter.
If the "All levels per call" checkbox is not enabled:
Name Description
ListNodes( NodeIdentifier parent, Lists the nodes of the type ContentNode lying
Filter filter ) directly under the parent node with a specified
filter.
Access MyData (AMD)

5.10 Test program
Range 3: Functions
Button Description
Machine Opens a dialog in which data is displayed for the machine selected in the plant tree.
Additional buttons are displayed which can be used to initiate the MMP functions.
Properties Opens a dialog in which the trial cut ID and release flag are set.
Delete Deletes selected items from the MMP server.
Transfer Opens a dialog with which an item is transferred to the machine.
Imp. package Opens a dialog with which an NC package is created on the server.
Imp. partprog. Opens a dialog with which an NC program is imported into the server.
Imp. attach‐ Opens a dialog with which the attachments are imported into the server.
ment
Machine status Queries the status of the selected controller.
M Capabilities Returns the capabilities of the selected controller which are supported or not suppor‐
ted.
Exp. package Opens a dialog with which NC packages are exported from the server.
Exp. partprog. Opens a dialog with which NC programs are exported from the server.
Exp. attach‐ Opens a dialog with which the attachments are exported from the server.
ment
Machine
The "Machine" button opens a dialog in which data is displayed for the machine selected in
the plant tree. Additional buttons are displayed which can be used to initiate the MMP functions.
The following function is used for this purpose:
Name Description
List<MachineDncItem> Lists the items on a machine
ListItemsOnMachine( NodeIdentifier
machine )
There are buttons for additional functions on the right side of the dialog.
Access MyData (AMD)

5.10 Test program
Transfer back
Name Description
void Transfers a list of items from the file system of
TransferFromMachine( NodeIdentifie a machine to a level in the administrative struc‐
r machine, NodeIdentifier parent, ture on the MMP server.
List<MachineDncItem>
itemsToTransfer )
Delete
Name Description
void Deletes a list of items on a machine
DeleteOnMachine( NodeIdentifier
machine, List<MachineDncItem>
itemsToDelete )
select
Name Description
void SelectItem(NodeIdentifier Selects an item for a channel
machine, MachineDncItemIdentifier
item, uint channel )
deselect
Name Description
void DeselectItem(NodeIdentifier Deselects the selected NC program in a chan‐
machine, uint channel ) nel
Access MyData (AMD)

5.10 Test program
Imp. to machine
First, the following function is carried out:
Name Description
StreamingTicket Imports an NC file directly into the file system
ImportToMachine( NodeIdentifier of the machine
machine, MachineDncItem The program is not registered in the MMP sys‐
machineDncItem ) tem but only stored in temporary memory.
The following function is then executed with the "StreamingTicket":
Name Description
StreamingTicket UploadFile(String Sending a file to the MMP server, identified by
CheckSum, String FileName, an upload ticket. The checksum is currently not
StreamingTicket streamingTicket, evaluated and can remain blank. The file name
Stream FileByteStream) must be identical to the file name when the
ticket is initiated
Finally the following function must be executed:
Name Description
MachineDncItem Complete upload.
ticket ) ly in this way is the data saved on the machine.
Exp. from machine

First, the following function is carried out:
Name Description
ExportMachineDncItem Exports an NC file directly from the file system
ExportFromMachine( NodeIdentifier of the machine.
machine, MachineDncItemIdentifier The program is not registered in the MMP sys‐
item ) tem but only stored in temporary memory.
The returned ExportMachineDncItem object
contains the file information and a streaming
ticket.
terface (DownloadFile) must then be used to
read the contents of the file from the server.
The following function is then executed:
Name Description
downloadRequest)
Access MyData (AMD)

5.10 Test program
Properties
This dialog shows the current status of the trial cut ID and of the release ID. Pressing the "OK"
button sets the IDs and flags to the respective status of the checkboxes.
The following functions are used:
Name Description
void Sets the trial cut ID or the
SetAvailableForTrialCutFlag( NodeI AvailableForTrialCutFlag
dentifier id, string Without trial cut ID or release ID, an NC file
versionToSetFlag, bool value ) cannot be transferred to the machine.
This function is used to set the trial cut ID for a
node with the specified version.
void Sets the SetReleasedFlag
SetReleasedFlag( NodeIdentifier Without trial cut ID or release ID, an NC file
id, bool value, bool cannot be transferred to the machine.
resetAvailableForTrialCutFlag )
Sets the release ID of a node
The trial cut ID can be reset at the same time.
If the release ID for a part program is set, the
release ID of the previously released version
of the NC file is automatically reset.
Delete
This button deletes selected items on the server.
The following function is used:
Name Description
void Remove nodes from the MMP server.
DeleteNodes( List<NodeIdentifier> Deletes nodes of the type ContentNode.
identifiers )
Delete a list of nodes with specified ID
Access MyData (AMD)

5.10 Test program
Transfer
This dialog transfers selected items into the specified path to the controller.
Name Description
void Transfers a list of items to a destination speci‐
TransferToMachine( NodeIdentifier fied with the TransferOptions object in the
machine, List<NodeIdentifier> file system of the machine.
itemsToTransfer, TransferOptions
transferOptions )
The following function is used:
Imp. package
The button opens a dialog in which a new NC package with the selected properties is created
on the server.
The following function is used for creating:
Name Description
ContentNode Create package in the MMP server.
ImportPackage( NodeIdentifier Regardless of the type attribute, this creates
parent, PackageNodeInfo info ) an NC package or a workpiece folder under a
machine group or machine node. Only the
name and the type attributes need to be set in
the PackageNodeInfo parameter for a work‐
piece folder. The assigned NC files can then
be imported with the returned ContentNode.
Imp. partprog.
The button opens a dialog in which the NC program is selected for import.
Access MyData (AMD)

5.10 Test program
The following function is used for this:
Name Description
StreamingTicket Import NC file into the MMP server.
ImportPartProgram( NodeIdentifier Imports an NC file under a machine group
parent, PartProgramNodeInfo node, machine node, workpiece node, or NC
partProgramInfo, string package node.
versionToOverwrite )
If versionToOverwrite is not equal to "0",
the part program is imported with the specified
version and any existing version of the NC file
is overwritten.
a FinalizeUpload.
Imp. attachment
The button opens a dialog in which an attachment is selected for import.
Name Description
StreamingTicket Import attachment into the MMP server.
ImportAttachment( NodeIdentifier Imports an attachment under an NC file or an
parent, AttachmentNodeInfo info ) NC package.
terface (.UploadFile) must then be used to
transfer the contents of the file.
a FinalizeUpload
Machine status
The button opens a dialog in which the current status of the controller is displayed.
Name Description
MachineDncStatus Returns the status of a machine ("online", "off‐
GetMachineStatus( NodeIdentifier line", "unknown").
machine )
M Capabilities
The button opens a dialog in which the supported functions are displayed.
Access MyData (AMD)

5.10 Test program
Name Description
List<DncMachineCapabilities> Provides the capabilities of a machine.
GetCapabilities( NodeIdentifier Depending on the machine technology and the
machine ) type of connection to MMP, only a part of the
scope of functions of the interface can be used.
Exp. package
The button opens a dialog in which the save location is selected.
Name Description
ExportPackageInfo Export package from the MMP server.
ExportPackage( NodeIdentifier id ) The return value contains information about
the contents of the package and the associated
StreamingTickets for the file contents.
With the StreamingTicket, the file contents
must then be read out on the FileTransfer in‐
terface (DownloadFile).
Name Description
downloadRequest)
Exp. partprog.
Name Description
StreamingTicket Export NC file from the MMP server.
ExportPartProgram( NodeIdentifier With the StreamingTicket, the FileTransfer in‐
id, out PartProgramNodeInfo terface (DownloadFile) must then be used to
partProgramInfo ) access the contents of the file.
The object PartProgramNodeInfo contains
the metadata from MMP.
Name Description
downloadRequest)
Access MyData (AMD)

5.10 Test program
Exp. attachment
Name Description
StreamingTicket Export attachment from the MMP server.
ExportAttachment( NodeIdentifier With the StreamingTicket, the FileTransfer in‐
id, out AttachmentNodeInfo info ) terface (DownloadFile) must then be used to
access the contents of the file.
The AttachmentNodeInfo object contains
metadata for the file attachment
Name Description
downloadRequest)
Access MyData (AMD)

Project information A
A.1 List of abbreviations
Admin Administrator (user role)

AMC Analyze MyCondition
AMD Access MyData
AMM/E Access MyMachine/Ethernet
AMP Analyze MyPerformance
AMT Access MyTool ID
API Application programming interface: interface to the application programming
ASC Access MyMachine/Ethernet Service Client
ASCII American Standard Code for Information Interchange
BA Operating Instructions
CAM Computer-Aided Manufacturing
CF card CompactFlash Card: Memory card
CNC Computerized Numerical Control:
CoL Certificate of License
COM Communication
COM Component Object Protocol (programming model of Microsoft®)
CU Control Unit
CP Communication Processor
CPU Central Processing Unit:
DB Data Block (PLC)
DBB Data Block Byte (PLC)
DBW Data Block Word (PLC)
DCOM Distributed Component Object Model
Dbxy Data Block (e.g. B 59)
DHCP Dynamic Host Configuration Protocol: Dynamic assignment of an IP address and other
configuration parameters on a computer in a network
DNC Direct Numeric Control
DIR Directory:
DW Data Word
FCC File Client Cache
ET Equability axis test
h Hour
HMI Human Machine Interface: SINUMERIK user interface
HD Hard Disk: Hard disk
HTTP Hypertext Transfer Protocol
HTTPS HyperText Transfer Protocol Secure,
HW Hardware
Access MyData (AMD)

Project information
IAC InterActive Client

IB Commissioning engineer (user role)
IE Internet Explorer
IFC Interface Client
IH Maintenance
IIS Microsoft Internet Information Service
CT Circularity Test
MB Megabyte
MCIS Motion Control Information System
MCIS MDA MCIS Machine Data Aquisition: Machine data management
MCP Machine Control Panel:
MD Machine Data
MHComm Machine Handler Communication
MCS Machine Coordinate System
MLFB Machine-Readable Product Code
MMP Manage MyPrograms
MMP IFC Manage MyPrograms InterFace Client
MMT Manage MyTools
MO Machine Operator: Machine operator (user role)
MPI Multi Port Interface: Multiport Interface
MRL Manufacturing Resource Library
MS Microsoft
MSDE Database software Microsoft Data Engine or Microsoft Desktop Engine
MSI Microsoft Software Installation
MSP MindSphere platform
MSTT Machine control panel
NC Numerical Control: Numerical control
NCK Numerical Control Kernel: Numeric kernel with block preparation
NCU Numerical Control Unit: NCK hardware unit
NFS Network File System
NTLM NT LAN Manager: Authentication procedure for computer networks
OB Organization block in the PLC
ODBC Open Database Connectivity
OEM Original Equipment Manufacturer
OLE Object Linking & Embedding
OP Operation Panel: Operating equipment
OPI Operation Panel Interface: Interface for connection to the operator panel
OPC OLE for Process Control
PC Personal Computer
PCMCIA Personal Computer Memory Card International Association (memory card standardi‐
zation)
PCU PC Unit: Computer unit
PG Programming device
PDA Production Data Acquisition: Production data acquisition
Access MyData (AMD)

Project information
PLC Programmable Logic Control: PLC

PMT Parts Monitoring & Tracking: Parts tracking
PO POWER ON
ProToolPro Configuration tool
PWS Personal Web Server
RFC Requests for Comments
ROM Read Only Memory
SC Service Client
SE Service Engineer
SEC Service Engineer Client
SEG Tool presetter
SFI or SFI RM Shop Floor Integrate or Shop Floor Integrate Resource Management
SI SINUMERIK Integrate
SK Softkey
SSL Secure Socket Layer
SW Software
TDI Tool Data Information
TC Teamcenter
TCP Transmission Control Protocol
TLCA Tool Library CA: Tool catalog data
TLCU Tool Library Customer: Customer tool catalog data
TLCUA Tool Library Customer Assemblies: Complete tools
UAT Universal Axis Test
UNC Uniform naming convention
VB Visual Basic
VC Visual C
VNCK Virtual numerical control core
WCS Workpiece Coordinate System
T Tool
TLC Tool Length Compensation
WOP Workshop-Oriented Programming
WPD Work Piece Directory: Workpiece directory
TRC Tool Radius Compensation
WSDL Web Services Description Language
T Tool
TO Tool Offset
MT Machine Tool
TM Tool Management
TC Tool Change
XML Extensible Markup Language
Access MyData (AMD)

Project information
Access MyData (AMD)

SI AMD FCT Man 0718 en-US

Uploaded by

Copyright:

Available Formats

You might also like

SI AMD FCT Man 0718 en-US

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SI AMD FCT Man 0718 en-US

Uploaded by

Copyright:

Available Formats

Foreword

Access to NC program data 5

Siemens AG A5E36812654B AD Copyright © Siemens AG 2015 - 2018.

Access MyData (AMD)

Note regarding the General Data Protection Regulation

Access MyData (AMD)

Security information on the product

Access MyData (AMD)

Access MyData (AMD)

Access MyData (AMD)

4.4.1.4 Read out tool container assignment (Action 108)..................................................................44

Access MyData (AMD)

5.3 Description of the interfaces.................................................................................................121

Access MyData (AMD)

Access MyData (AMD)

Access MyData (AMD)

1.2 Warranty and liability for application examples

Access MyData (AMD)

1.3 Industrial security

Further information is provided on the Internet:

Access MyData (AMD)

Access MyData (AMD)

The principle of Access MyData can be summarized as follows:

Access MyData (AMD)

Access MyData (AMD)

Access MyData (AMD)

Access MyData (AMD)

3.1.1 Direct access to NC/PLC

① Access to NC and PLC data

Access MyData (AMD)

3.2.2 Activate interface

Access MyData (AMD)

Access MyData (AMD)

3.2.3 Deactivate interface

Access MyData (AMD)

3.3 Service interfaces

3.3.1 Machine Admin Service Interface

3.3.2 Basic Data Access Service Interface

Access MyData (AMD)

Access MyData (AMD)

Recording in the event of a change (OnChange Recording)

Synchronized recording of data (Synchronized Recording)

Cyclic recording of values (Cyclic Recording)

Access MyData (AMD)

Cyclic Recording provides the following functions:

Direct Data Access

3.3.2.2 Basic Data Access Service Interface

3.3.2.3 Basic Data Configuration Service Interface

Access MyData (AMD)

Access MyData (AMD)

3.3.2.4 Direct Data Access Service Interface

Access MyData (AMD)

3.3.2.5 Direct Data Access Callback Service

3.3.3 Machinestatus Service Interface

Access MyData (AMD)

3.3.4 ServerSideSynchronisation Service Interface

Access MyData (AMD)

Access MyData (AMD)