+ All Categories
Home > Documents > Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual...

Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual...

Date post: 22-Mar-2018
Category:
Upload: trankhue
View: 239 times
Download: 11 times
Share this document with a friend
164
___________________ ___________________ ___________________ ___________________ ___________________ ___________________ ___________________ SINUMERIK SINUMERIK Integrate Access MyData (AMD) Function Manual Valid for: Control system SINUMERIK 840D, SINUMERIK 840D sl/ 840DE sl Software SINUMERIK Integrate, Version 4.1 SP6 SINUMERIK Integrate Access MyData 11/2016 A5E36812654B-AB Foreword Introduction 1 Fundamental safety instructions 2 Direct access to NC/PLC 3 Access to tool information 4 Access to NC program data 5 Project information A
Transcript
Page 1: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

___________________

___________________

___________________

___________________

___________________

___________________

___________________

SINUMERIK

SINUMERIK Integrate Access MyData (AMD)

Function Manual

Valid for: Control system SINUMERIK 840D, SINUMERIK 840D sl/ 840DE sl Software SINUMERIK Integrate, Version 4.1 SP6 SINUMERIK Integrate Access MyData

11/2016 A5E36812654B-AB

Foreword

Introduction 1

Fundamental safety instructions

2

Direct access to NC/PLC 3

Access to tool information 4

Access to NC program data 5

Project information A

Page 2: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Siemens AG Division Digital Factory Postfach 48 48 90026 NÜRNBERG GERMANY

A5E36812654B-AB Ⓟ 01/2017 Subject to change

Copyright © Siemens AG 2015 - 2016. All rights reserved

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.

Page 3: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 3

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:[email protected]).

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).

Page 4: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Foreword

Access MyData (AMD) 4 Function Manual, 11/2016, A5E36812654B-AB

Target group This publication is intended for:

● Project engineers

● Technologists (from machine manufacturers)

● System and machine commissioning engineers

● Programmers

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.

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.

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).

Page 5: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 5

Table of contents

Foreword ................................................................................................................................................ 3

1 Introduction ............................................................................................................................................. 9

2 Fundamental safety instructions ............................................................................................................ 11

2.1 General safety instructions ..................................................................................................... 11

2.2 Industrial security .................................................................................................................... 12

3 Direct access to NC/PLC ....................................................................................................................... 13

3.1 Introduction ............................................................................................................................. 13 3.1.1 Direct access to NC/PLC ........................................................................................................ 14 3.1.2 Target group ........................................................................................................................... 14 3.1.3 Overview ................................................................................................................................. 14

3.2 Concept ................................................................................................................................... 15 3.2.1 Overview ................................................................................................................................. 15 3.2.2 Activate interface .................................................................................................................... 16 3.2.3 Deactivate interface ................................................................................................................ 17

3.3 Service interfaces ................................................................................................................... 18 3.3.1 Machine Admin Service Interface ........................................................................................... 18 3.3.2 Basic Data Access Service Interface ...................................................................................... 19 3.3.2.1 Introduction ............................................................................................................................. 19 3.3.2.2 Basic Data Access Service Interface ...................................................................................... 22 3.3.2.3 Basic Data Configuration Service Interface ............................................................................ 23 3.3.2.4 Direct Data Access Service Interface ..................................................................................... 24 3.3.2.5 Direct Data Access Callback Service ..................................................................................... 25 3.3.3 Machinestatus Service Interface ............................................................................................. 26 3.3.4 ServerSideSynchronisation Service Interface ........................................................................ 26

3.4 Functionality and examples (C#) ............................................................................................ 27 3.4.1 Admin Service ......................................................................................................................... 27 3.4.2 Basic Service .......................................................................................................................... 29 3.4.3 Basic Service DirectAccess .................................................................................................... 34

3.5 Application example for Access MyData ................................................................................ 36 3.5.1 Content of CommonInterfaces.zip file ..................................................................................... 36 3.5.2 Installation of the AccessMyData application example ........................................................... 36 3.5.3 Creating a test organization .................................................................................................... 37 3.5.4 Executing the test program (parameters) ............................................................................... 37

4 Access to tool information ..................................................................................................................... 39

4.1 Introduction ............................................................................................................................. 39 4.1.1 Requirement ........................................................................................................................... 39

4.2 Basic information .................................................................................................................... 40 4.2.1 WebInterface - HTTP protocol ................................................................................................ 40 4.2.1.1 HTTP dual-channel ................................................................................................................. 41 4.2.1.2 Activation and parameterization of the interface .................................................................... 42

Page 6: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Table of contents

Access MyData (AMD) 6 Function Manual, 11/2016, A5E36812654B-AB

4.2.2 Balancing ............................................................................................................................... 43

4.3 Interface functions .................................................................................................................. 44 4.3.1 Example operational sequence/protocol sequence via the WebInterface ............................. 44 4.3.2 User-defined transformation of the actual tool data ............................................................... 46 4.3.3 Protocol for reading/writing/changing data ............................................................................ 51 4.3.3.1 Readout of the MMT configuration (Action 101) .................................................................... 51 4.3.3.2 Subscribe to tool transfer (Action 103) .................................................................................. 53 4.3.3.3 Read out tool container assignment "all parameters" (action 107) ........................................ 55 4.3.3.4 Read out tool container assignment (Action 108) .................................................................. 59 4.3.3.5 Read out tool node (Action 109) ............................................................................................ 61 4.3.3.6 Add/change external data (Action 114) ................................................................................. 63 4.3.3.7 Read out actual tool data via tool identifier/DuploNo. (Action 115) ....................................... 64 4.3.3.8 Read out actual tool data via ExternalId (Action 116)............................................................ 68 4.3.3.9 Import tool dataset (Action 117) ............................................................................................. 72 4.3.3.10 Set/reset the tool unload identifier (Action 118) ..................................................................... 74 4.3.3.11 Delete tool (Action 119) ......................................................................................................... 74 4.3.3.12 Read out master data overview (Action 120) ......................................................................... 76 4.3.3.13 Read out master data set (Action 121) .................................................................................. 77 4.3.3.14 Delete master data set (Action 122) ...................................................................................... 78 4.3.3.15 Create/change master data set (Action 123) ......................................................................... 79 4.3.3.16 Set master data set (Action 124) ........................................................................................... 81 4.3.3.17 Read out tool plan overview (Action 130) .............................................................................. 82 4.3.3.18 Read out tool plan (Action 131) ............................................................................................. 83 4.3.3.19 Delete tool plan (Action 132) .................................................................................................. 83 4.3.3.20 Create/change tool plan (Action 133) .................................................................................... 84 4.3.3.21 Read out tool plan overview (Action 134) .............................................................................. 85 4.3.3.22 Subscribing to a change of the setting list (Action 140) ......................................................... 86 4.3.3.23 Read out setting list (Action 141) ........................................................................................... 88 4.3.3.24 Set reservation ID (Action 142) .............................................................................................. 89 4.3.3.25 Transfer the transfer list (Action 160)..................................................................................... 91 4.3.3.26 Perform single handling (Action 162) ..................................................................................... 92 4.3.3.27 Read out machining sequences (Action 170) ........................................................................ 95 4.3.3.28 Create/change machining sequence (Action 171) ................................................................. 96 4.3.3.29 Disable/enable machining sequences (Action 172) ............................................................... 97 4.3.3.30 Delete machining sequences (Action 173) ............................................................................ 97 4.3.3.31 Move machining sequence (Action 174) ................................................................................ 98 4.3.3.32 Reset WebInterface (Action 1000) ......................................................................................... 98

4.4 Code examples for using the external interface .................................................................... 99 4.4.1 Installation and requirements ............................................................................................... 100 4.4.2 Initialization .......................................................................................................................... 100 4.4.3 Actions ................................................................................................................................. 102 4.4.3.1 Read out tool plan overview (Action 130) ............................................................................ 102 4.4.3.2 Read out tool plan (Action 131) ........................................................................................... 103 4.4.4 User interface ....................................................................................................................... 104 4.4.5 Synchronous query of data (requests) ................................................................................. 106 4.4.6 Response validation (synchronous requests) ...................................................................... 107 4.4.7 Subscribing to data changes ................................................................................................ 108 4.4.8 Example sequence Action 108 ............................................................................................ 109

4.5 Project information ............................................................................................................... 112 4.5.1 Error message logs .............................................................................................................. 112 4.5.2 Description of SINUMERIK tool parameter .......................................................................... 113

Page 7: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Table of contents

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 7

4.5.3 Description of Teamcenter tool parameters.......................................................................... 116

5 Access to NC program data ................................................................................................................ 127

5.1 Introduction ........................................................................................................................... 127

5.2 Requirement ......................................................................................................................... 128 5.2.1 Activate interface .................................................................................................................. 128 5.2.2 Deactivate interface .............................................................................................................. 128

5.3 Target group ......................................................................................................................... 129

5.4 Description of the interfaces ................................................................................................. 130

5.5 The type of a machine .......................................................................................................... 132

5.6 Terms .................................................................................................................................... 140

5.7 Programs on the machine ..................................................................................................... 144

5.8 The settings of the transfer ................................................................................................... 145

5.9 Information about the machines ........................................................................................... 146

5.10 The capabilities of a machine ............................................................................................... 147

5.11 Application example .............................................................................................................. 148 5.11.1 Introduction ........................................................................................................................... 148 5.11.2 Contents of the example application ..................................................................................... 148 5.11.3 Installing application examples ............................................................................................. 148 5.11.4 Creating a test organization .................................................................................................. 149

5.12 Test program ......................................................................................................................... 150

A Project information .............................................................................................................................. 161

A.1 List of abbreviations .............................................................................................................. 161

Page 8: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Table of contents

Access MyData (AMD) 8 Function Manual, 11/2016, A5E36812654B-AB

Page 9: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 9

Introduction 1

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.

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

Page 10: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Introduction

Access MyData (AMD) 10 Function Manual, 11/2016, A5E36812654B-AB

Note Released functions

The SINUMERIK Integrate Access MyData interface is released and expanded step by step. The readme file for SINUMERIK Integrate Access MyData in the subfolder "Sinumerik_Integrate_Server/Sinumerik_Integrate_Setup" of the product DVD determines the released functions.

Page 11: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 11

Fundamental safety instructions 2 2.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

Danger to life or malfunctions of the machine as a result of incorrect or changed parameterization

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. • Respond to possible malfunctions by applying suitable measures (e.g. EMERGENCY

STOP or EMERGENCY OFF).

Page 12: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Fundamental safety instructions 2.2 Industrial security

Access MyData (AMD) 12 Function Manual, 11/2016, A5E36812654B-AB

2.2 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 only represent one component of such a concept.

The customer is responsible for preventing unauthorized access to its plants, systems, machines and networks. Systems, machines and components should only be connected to the enterprise network or the internet if and to the extent necessary and with appropriate security measures (e.g. use of firewalls and network segmentation) in place.

Additionally, Siemens’ guidance on appropriate security measures should be taken into account. For more information about industrial security, please visit:

Industrial security (http://www.siemens.com/industrialsecurity).

Siemens’ products and solutions undergo continuous development to make them more secure. Siemens strongly recommends to apply product updates as soon as available and to always use the latest product versions. Use of product versions that are no longer supported, and failure to apply latest updates may increase customer’s exposure to cyber threats.

To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed at:

Industrial security (http://www.siemens.com/industrialsecurity).

WARNING

Danger to life as a result of 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.

Page 13: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 13

Direct access to NC/PLC 3 3.1 Introduction

Over the course of introducing Sinumerik Integrate Version 4.1, a new web service interface is introduced and published on the SI server.

These chapters describe the new web service interface (API interface) provided by the SI server.

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 supplemented.

Page 14: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.1 Introduction

Access MyData (AMD) 14 Function Manual, 11/2016, A5E36812654B-AB

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

3.1.2 Target group 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.

3.1.3 Overview This documentation describes the following aspects of the new API interface:

● Concept and principle of operation of the SI Infrastructure WebServices

● Using the SI Infrastructure WebServices

Page 15: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.2 Concept

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 15

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.

Page 16: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.2 Concept

Access MyData (AMD) 16 Function Manual, 11/2016, A5E36812654B-AB

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).

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.

Page 17: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.2 Concept

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 17

Activate services Then activate the required services following the same procedure:

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.

Page 18: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) 18 Function Manual, 11/2016, A5E36812654B-AB

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> GetMachines(string domainName, Ma-chineResultDesc machResult)

Contains the list of the machines which are available for the defined domain. The domain must be provided in the parameter domain-Name

Machine GetMachine (string domainName, MachineIdentifier machineId, Ma-chineResultDesc machResult)

Contains the master machine data of the machine defined with machineId. The domain must be provided in the parameter domain-Name The machine must be available for the domain that is defined in the parameter do-mainName.

Machine GetMachineByName (string do-mainName, string machineNameOEM, string organizationName, MachineRe-sultDesc machResult)

Contains the master machine data of the machine defined with machineName. The do-main must be provided in the parameter do-mainName The machine must be available for the domain that is defined in the parameter domainName.

Page 19: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 19

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.

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

Page 20: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) 20 Function Manual, 11/2016, A5E36812654B-AB

● 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.

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)

Page 21: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 21

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.

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

Page 22: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) 22 Function Manual, 11/2016, A5E36812654B-AB

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 domain-Name, string serverChannel, Int64 startId, int maxCount)

Depicts the data of a specified server channel beginning at a defined start ID.

long GetLastId(string domainName, string serverChannel) Shows the ID of the last data entry in a server

channel.

void SetProcessedLine(string domain-Name, string serverChannel, Int64 lastProcessedId)

Defines the data process line, so that the server can delete processed data of a server channel

Page 23: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 23

3.3.2.3 Basic Data Configuration Service Interface Use this interface to configure basic data recordings.

Namespace: Siemens.ISB.Interfaces.BasicServices.BasicDataAccess

Interface: IBasicDataConfiguration Name Description

void DefineServerDataChannels(string domainName, List<ServerDataChannelConfig> chan-nels)

Defines the server channels for a specific domain. Replaces the existing configuration with a new one. Old configura-tion is deleted.

List<ServerDataChannelConfig> GetServerDataChannels(string domain-Name)

Receipt of the server channel configuration for a domain.

void DefineClientDataChannels (string domainName, MachineIdentifier machineId, List<ClientDataChannelConfig> chan-nels)

Defining the client channel for a machine within a domain.

List<ClientDataChannelConfig> GetCli-entDataChannels(string domainName, MachineIdentifier machineId)

Receipt of the configured client channel for a defined machine within a domain.

void DefineDataRecordings(string do-mainName, MachineIdentifier machineId, List<DataRecordingConfig> recordings)

Defining the configuration for data recordings for a defined machine and domain. The exist-ing configuration is overwritten with the new one. Note: No more than five recordings may be defined for machines with HMI Advanced.

List<DataRecordingConfig> GetData-Recordings (string domainName, MachineIdentifier machineId)

Receipt of the data recording configuration for a defined machine within a domain.

void DefineSystemMachineVariableRe-cordings (string domainName, MachineIdentifier machineId, List<SystemMachineVariableRecording> recordings)

Defines the configuration for recordings of system machine variables in a specific do-main for a specific machine. Here, a user can define the server channel in which the system machine variables are sent. The existing configuration for the machine and domain is overwritten.

List<SystemMachineVariableRecording> GetSystemMachineVariableRecordings (string domainName, MachineIdentifier machineId)

Receipt of the system machine variable con-figuration for a defined machine within a do-main.

void DefineClientJobNotifications (string domainName, MachineIdentifier machineId, List<ClientJobNotificationConfiguration> configuration)

Defines the configuration for recordings of system machine variables in a specific do-main for a specific machine. Here, a user can define the client channel in which the system machine variables are provided. The existing configuration for the machine and domain is overwritten.

List<ClientJobNotificationConfiguration> GetClientJobNotifications (string domainName, MachineIdentifier machineId)

Receipt of the system machine variable con-figuration for a defined machine within a do-main.

Page 24: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) 24 Function Manual, 11/2016, A5E36812654B-AB

Name Description

BasicDataAccessMachineConfiguration GetMachineConfiguration (string domainName, MachineIdentifier machineId)

Receipt of the machine configuration for basic data access for a specific domain within a machine.

void DefineMachineConfiguration (string domainName, MachineIdentifier machine-Id,BasicDataAccessMachineConfiguration configuration)

Defining the machine configuration for basic data access for a specific domain within a machine.

3.3.2.4 Direct Data Access Service Interface Via this interface, you can conduct activities for the direct variable access on a machine.

Namespace: Siemens.ISB.Interfaces.BasicServices.BasicDataAccess

Interface: IDirectDataAccess Name Description

bool IsDirectDataAccessAvailable() Shows whether the SI server supports direct

variable access.

DirectDataAccessResult WriteToDevice (string domainName, MachineIdentifier machineId, string address, Recording-DataType dataType, string value, TimeSpan timeout)

Synchronous writing of a variable on the ma-chine.

Guid WriteToDeviceAsync (string do-mainName, MachineIdentifier machineId,string address, Recording-DataType dataType, string value, string callbackUrl,TimeSpan timeout)

Asynchronous writing of a variable on the machine.

DirectDataAccessResult ReadFromDevice (string domainName, achineIdentifier machineId, string address, RecordingDataType dataType, TimeSpan timeout)

Synchronous reading of a variable from the machine.

Guid ReadFromDeviceAsync (string do-mainName, MachineIdentifier machineId,string address, Recording-DataType dataType, string callbackUrl, TimeSpan timeout)

Asynchronous reading of a variable from the machine.

Page 25: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 25

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).

Namespace: Siemens.ISB.Interfaces.BasicServices.BasicDataAccess

Interface: IDirectDataAccessCallback Name Description

DirectDataAccessCompleted (Direct-DataAccessResult result ) This method is called after an asynchronous

"direct variable access" call has been ended. Objects of the type "DirectDataAccessResult" contain the result of the call.

Page 26: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.3 Service interfaces

Access MyData (AMD) 26 Function Manual, 11/2016, A5E36812654B-AB

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

Interface: IMachineStatus Name Description

List<MachineStatusInfo> GetMachineStatusAllMachines(string domainName)

Receipt of the status of all of the machines available in a domain.

MachineStatusDetail GetMachineApplica-tionStatus(string domainName, Machin-eIdentifier machineId)

Receipt of the detailed status of a specific machine from a domain. (not yet available)

3.3.4 ServerSideSynchronisation Service Interface An interface for initiating server-side synchronization

Namespace: Siemens.ISB.Interfaces.BasicServices.InfrastructureService

Interface: IServerSideSynchronization Name Description

bool TriggerServerSideSynchroniza-tion(string domainName, MachineIdentifier machineId)

Initiating a sever-side synchronization.

SynchronizationInfo GetSynchroniza-tionInfo(string domainName, Machin-eIdentifier machineId)

Receipt of the synchronization information of the previously defined machine.

Page 27: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 27

3.4 Functionality and examples (C#) The individual services are explained in the following chapter via example programs. The example codes are an excerpt from the example application, which was included with this document and implemented in C#. The examples are not the entire code. They only illustrate the actual calls of the services.

3.4.1 Admin Service The Admin Service is referenced with the following URL:

…/svc/Api/Admin/MachineAdminService.svc

The service allows all of the machines within a domain or a specific machine, which is identified by name or by machine identifier, to be determined.

The code for getting a list of the machines in a domain is: ... private static void readMachines() { try { IMachineAdmin client = ClientFactory.GetMachineAdminClient(); List<string> properties = new List<string>(); properties.Add("IsOnline"); properties.Add("PlatformInfo"); MachineResultDesc desc = new MachineResultDesc() { Properties = properties }; List<Machine> resultList = cli-ent.GetMachines(GlobalInfo.Instance.DomainName, desc); } catch (Exception e) { // handle errors here } } ...

The code for getting a specific machine is: ... private static void readMachineByName() { try { IMachineAdmin client = ClientFactory.GetMachineAdminClient(); List<string> properties = new List<string>(); properties.Add("IsOnline");

Page 28: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) 28 Function Manual, 11/2016, A5E36812654B-AB

properties.Add("PlatformInfo"); MachineResultDesc desc = new MachineResultDesc() { Properties = properties }; Machine result = client.GetMachineByName (GlobalInfo.Instance.DomainName, GlobalInfo.Instance.MachinenName, } catch (Exception e) { // handle errors here } } ...

Page 29: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 29

3.4.2 Basic Service Basic Service encompasses several services, which have been defined as a basic component of the API server and are referenced via the following URLs:

…/svc/Api/BasicServices/BasicDataAccessService/BasicDataAccessService.svc

…/svc/Api/BasicServices/BasicDataAccessService/BasicDataConfigurationService.svc

…/svc/Api/BasicServices/BasicDataAccessService/DirectDataAccessService.svc

The following example illustrates how a configuration for Basic Data Access can be transferred to the server.

The code for writing a configuration to the server is: ... private static void writeBasicDataConfiguration() { try { IBasicDataConfiguration client = ClientFacto-ry.GetBasicDataConfigurationClient(); try { List<ServerDataChannelConfig> serverChannels = new List<ServerDataChannelConfig>() { new ServerDataChannelConfig() { DelaySystemValues = true, MaxValuesInChannel = 100, Name = ServerChannel, UnusedValuesStoreTimespan = new TimeSpan(1, 1, 0), UsedValuesStoreTimespan = new TimeSpan(1, 1, 0), } }; client.DefineServerDataChannels (GlobalInfo.Instance.DomainName, serverChannels); } catch (Exception e) { // handle errors here } try { List<ClientDataChannelConfig> clientChannels = new List<ClientDataChannelConfig>() { new ClientDataChannelConfig() { BufferEntriesPerFile = 5, ChannelName = ClientChannel, MaxBufferFileCount = 10, MaxTimestampCorrection = 100,

Page 30: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) 30 Function Manual, 11/2016, A5E36812654B-AB

MinTimestampDifference = 10, RobustValueUpload = true, OnlineSignalConfig = new ClientChannelOnlineSignalConfig() { CycleInSeconds = 10, VariableDefinitions = new List<SystemVariableRecordingDetail>() { new SystemVariableRecordingDetail() { ServerChannelName = ServerChannel, VariableNameInChannel = MachineOn }, new SystemVariableRecordingDetail() { ServerChannelName = ServerChannel, VariableNameInChannel = MachineOnline } } } } }; client.DefineClientDataChannels (GlobalInfo.Instance.DomainName, GlobalInfo.Instance.MachineIdentifier, clientChannels); } catch (Exception e) { // handle errors here } } } ...

In the following example, the existing data of the previously configured "Channel" is accessed via Basic Data Access.

The code for reading data via the BasicDataAccess functionality is: ... private static void readBasicData() { try { IBasicDataAccess client = ClientFactory.GetBasicDataAccessClient(); long id = client.GetLastId(GlobalInfo.Instance.DomainName, ServerChannel); ChannelData data = client.ReadData (GlobalInfo.Instance.DomainName, ServerChannel, id, 10);

Page 31: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 31

} catch (Exception e) { // handle errors here } } ...

Page 32: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) 32 Function Manual, 11/2016, A5E36812654B-AB

InfrastructureService Machine statuses can be queried via the infrastructure services. The services are referenced via the following URLs:

…/svc/Api/BasicServices/InfrastructureService/MachineStatusService.svc

…/svc/Api/BasicServices/InfrastructureService/ServerSideSynchronizationService.svc

The following example illustrates how a user can get specific information about the synchronization status of a machine.

The code for querying the synchronization status of a machine is: ... private static void readMachinesyncStatus() { try { IServerSideSynchronization client = ClientFacto-ry.GetMachineServerSideSyncClient(); SynchronizationInfo info = client.GetSynchronizationInfo (GlobalInfo.Instance.DomainName, GlobalInfo.Instance.MachineIdentifier); } catch (Exception e) { // handle errors here } } ...

The following example illustrates how a user can initiate a server-side synchronization.

The code for initiating a server-side synchronization is: ... private static void serversideSynchronization() { try { IServerSideSynchronization client = ClientFactory.GetMachineServerSideSyncClient(); bool result = client.TriggerServerSideSynchronization (GlobalInfo.Instance.DomainName, GlobalInfo.Instance.MachineIdentifier); if (result) { Console.WriteLine ("Server-side synchronization has been triggered successfully!"); } else { Console.WriteLine("Server-side synchronization has not been triggered suc-cessfully!"); }

Page 33: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 33

} catch (Exception e) { // handle errors here } } ...

Page 34: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) 34 Function Manual, 11/2016, A5E36812654B-AB

3.4.3 Basic Service DirectAccess The service for the direct reading and writing to a controller is included in the Basic Service. However, since it represents independent processing, it is discussed in more detail here.

The service is referenced via the following URL:

…/svc/Api/BasicServices/BasicDataAccessService/DirectDataAccessService.svc

Internally, the direct writing or reading into the controller uses the "Direct Communication" infrastructure. To ensure that this function is available, this infrastructure must be "switched on" via web.config configuration. <ePS.Apps> … <directCommunication DirectCommunicationMode="longPolling" /> … </ePS.Apps>

Then the function provides the following features:

● Asynchronous reading with notification via WCF web service interface when the read procedure has completed

● Asynchronous writing with notification via WCF web service interface when the write procedure has completed

If a back channel is also configured in the infrastructure via web.config, then the following features are also available:

● Synchronous reading of variables

● Synchronous writing of variables

<ePS.Services> ... <BasicDataAccess InternalCallback-Url="http://localhost/svc/Api/BasicServices/BasicDataAccessService/DirectDataAccessCallbackService.svc" /> ... </ePS.Services>

The code for reading and writing data directly into the controller is: ... private static void readAndWriteClientDirectAccess() { try { IDirectDataAccess client = ClientFactory.GetDirectAccessClient(); bool isDirectDataAccessAvailable = client.IsDirectDataAccessAvailable(); if (isDirectDataAccessAvailable) { client.WriteToDevice (GlobalInfo.Instance.DomainName, GlobalInfo.Instance.MachineIdentifier, GlobalInfo.Instance.PlcAddress, RecordingDataType.String, "1", new TimeSpan(1, 1, 0));

Page 35: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.4 Functionality and examples (C#)

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 35

DirectDataAccessResult result = client.ReadFromDevice (GlobalInfo.Instance.DomainName, GlobalIno.Instance.MachineIdentifier, GlobalInfo.Instance.PlcAddress, recordingType, new TimeSpan(1, 1, 0)); } } catch (Exception e) { //do something } } ...

Page 36: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.5 Application example for Access MyData

Access MyData (AMD) 36 Function Manual, 11/2016, A5E36812654B-AB

3.5 Application example for Access MyData The scope of delivery of AMD contains an example code for using the interface for direct access to NC/PLC (Application example: "AccessMyData"). This is a C# console application in which selected function calls can be simulated.

All the files required for this can be found in the "CommonInterfaces.zip" archive.

The archive is located in the subfolder "Sinumerik_Integrate_Server/Sinumerik_Integrate_Setup/AMD-BASIC" on the product DVD.

The application example contains examples of the interface for direct access to NC/PLC.

3.5.1 Content of CommonInterfaces.zip file With the contents of the ZIP file CommonInterfaces.zip, it is possible to create the environment for an example application, which can be used to represent the functionality of the new API interface.

It contains:

● AccessMyData.sln – Visual Studio Solution C#

● Contract dlls

● WSDL files

● Chm files for the help of the individual service call-ups (Documentation.chm)

● Example program

3.5.2 Installation of the AccessMyData application example 1. Open AccessMyData.sln.

2. Compile the solution.

3. Adapt the project references (due to the build process, the DLLs are provided with a version and as a result, the project no longer recognizes the previously entered DLLs. Therefore, delete all of the references which have a warning sign and add new ones from the folder ..|InterfacesDll|).

4. Adapt the App.config file. The service endpoints must be set to the current SI server.

5. Call the individual API interface functions.

Page 37: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.5 Application example for Access MyData

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 37

3.5.3 Creating a test organization First, an organization and a machine must be created via the PC-UI of the SI server. This machine must be connected to a controller, only then can all of the examples of the application example be carried out.

To ensure that the application example can filter to the database, the app.config must first be adapted. Organization: Name of organization Machine: Machine name Domain: Domain under which the organization was created Address: PLC address to which is to be written or from which is to be read

After the project is successfully compiled, the individual examples can now be called.

3.5.4 Executing the test program (parameters) The test program can then be called with the following parameters:

Function name Explanation readmachines Returns a list of all of the machines of a specific organization readmachine Returns a specific machine readmachinebyid Returns specified machine information via a "global machine identifier" readmachinesyncstatus Returns the synchronization status of a machine readmachinestatus Returns the application status of a machine readbasicdata Accesses variables of a machine directly readandwriteclientdirectac-cessstring(readandwriteclientdirectaccessbinblock)

Writes and reads data directly from the controller

serversidesynchronization Synchronizes the server and machine triggerservertrigger Triggers a server trigger triggerservertriggergroup Triggers a server trigger group

Page 38: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Direct access to NC/PLC 3.5 Application example for Access MyData

Access MyData (AMD) 38 Function Manual, 11/2016, A5E36812654B-AB

Page 39: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 39

Access to tool information 4 4.1 Introduction

This document describes an external interface of SINUMERIK Integrate (SI).

The interface enables access to tool information, and is part of the product AMD (Access MyData).

The interface described here provides external applications with access to functions and data from MMT, e.g. for managing tool data. The WebInterface enables higher-level tool management systems, cutting edge setting stations, tool cabinets (e.g. endless tool conveyors, tool racks, etc.) to be connected to MMT. The interface enables selected tool and planning data to be read, written and changed in MMT. Tool cabinets and third-party controllers are mapped via the WebInterface as a separate component (node or container) in MMT.

The WebInterface uses defined the HTTP protocol with XML for data description to exchange data between MMT and an external application. The interface is implemented as a web service and is based on HTTP/XML technology.

This chapter describes the principle of operation and the functional scope of the interfaces' access to tool information and the WebInterface.

4.1.1 Requirement The use of the Webservice interface requires a previously installed and correctly configured SI server with version 4.1 or higher. A further requirement is that the user of the interface is familiar with the product MMT (Manage MyTools) and has sufficient knowledge in programming for web service interfaces (HTTP/XML).

Note Released functions

Only selected functions (actions) are released in the interface. There is no general product release. The readme file for AMD in the subfolder "Sinumerik_Integrate_Server/Sinumerik_Integrate_Setup/AMD-MMT" on the product DVD determines the released functions.

Page 40: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.2 Basic information

Access MyData (AMD) 40 Function Manual, 11/2016, A5E36812654B-AB

4.2 Basic information

4.2.1 WebInterface - HTTP protocol The WebInterface uses the Hypertext Transfer Protocol (HTTP) 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 is required in addition to an operational SI server.

HTTP belongs to the so-called application layer of established network models. The application layer is addressed by the application programs. In the ISO/OSI layer model, HTTP corresponds to the application layers 5 to 7. The connection to the WebInterface server via HTTP is based on the HTTP-GET and HTTP-POST commands.

Users of the WebInterface connect directly to the SI server as an HTTP Client (also called a WebInterface client in the following). The HTTP client is generally implemented by the user of the WebInterface.

Note

The user data (= actions) are transferred as XML with UTF-8 coding.

The communication with the SI server is defined by the following URL:

http://<Host>:<Port>/mmt/webinterface.xml

Host IP address or computer name of the installed MMT server Port Configured port of the installed MMT server, default: 3040

Note

Note uppercase/lowercase for the URL path!

To make asynchronous functions available via an HTTP client, bidirectional communication between the WebInterface server and the WebInterface client is required.

To ensure this bidirectional communication, the HTTP dual-channel procedure is used in communication.

HTTP communication comprises two separate, completely autonomous channels (dual-channel). When the dual-channel procedure is used, a distinction is made between synchronous and asynchronous operation.

Page 41: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.2 Basic information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 41

4.2.1.1 HTTP dual-channel

HTTP Channel 1 Synchronous operations are implemented by their own HTTP-POST requests. The WebInterface client sends an action to the WebInterface server in an HTTP-POST request, and immediately receives the requested user data in the response to the request.

Figure 4-1 Flow diagram HTTP-POST Request

HTTP Channel 2 Asynchronous operations are obtained from the WebInterface server using an HTTP-GET request.

For this purpose, the client cyclically makes an HTTP-GET request to the WebInterface server. The request is immediately answered if user data of an asynchronous operation is available for retrieving on the WebInterface server. 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 10 seconds), 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.

Page 42: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.2 Basic information

Access MyData (AMD) 42 Function Manual, 11/2016, A5E36812654B-AB

Figure 4-2 Flow diagram HTTP-GET Request

4.2.1.2 Activation and parameterization of the interface To activate the server interface, the following entry must be manually completed under the node "Modules" in the MMT configuration file "tdi_cfg.xml" (e.g. using Notepad): <OEM name="MMTWebInterface" assembly="MMTWebInterface.dll" subscription_timeout="300000" />

The subscription_timeout [ms] attribute specifies how long a subscription object is retained in the server if no other GET requests are temporarily sent from the client. This attribute is only relevant for the HTTP dual-channel procedure.

After restarting the TDIServer service, the WebInterface server is ready.

Page 43: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.2 Basic information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 43

4.2.2 Balancing When using the balancing function, the user must note that the database is subject to constant changes.

During balancing, the server queries the status of all of the machines in successive order. Balancing is then carried out with the collected data. This procedure takes some time, especially as the number of connected machines increases. Since the machines continue to produce, however, it can happen, for example, that a tool has become blocked in the mean time, but this has not yet been taken into consideration in the previously requested balancing result. This also applies if an operator of the MMT software carries out operator control actions which affect the tool data or an AMD client uses functions in the meantime which affect the tool data. This is not peculiar to the AMD interface. It is the standard behavior of MMT. This means that this behavior manifests itself in identical form on each PC client on which the MMT software is used.

Balancing is generally used to determine the tool needs for the next shift/week or production period. Fuzzy results, due to a change of the database during balancing, can generally be ignored.

Page 44: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 44 Function Manual, 11/2016, A5E36812654B-AB

4.3 Interface functions To exchange data between MMT and external systems via the WebInterface, actions (XML strings) are sent via HTTP. For each operation that is to be performed via the WebInterface, an XML schema has been defined for the request and for the response.

Note

The WebInterface protocols are "case sensitive"! I.e. they distinguish between uppercase and lowercase letters.

4.3.1 Example operational sequence/protocol sequence via the WebInterface This section shows an example of the sequence of an operation via the WebInterface.

In this sequence, the user wants to read out the tool assignment of the "Presetter2" magazine below the "Server" node.

In this example, the operation "Read tool container assignment – Action 108" is initiated and executed via the WebInterface.

1. Step: External application sends request to MMT

<Action ID="108" Places="All">

<MagList NodeId="NCUsl" ContainerId="Pick_Up"/>

<MagList NodeId="Server" ContainerId="Zoller"/>

</Action>

2. Step: MMT sends magazine assignment to external application

<Action ID="108">

<MagList NodeId="NCUsl">

<Mag Name="Pick_Up" ContainerState="SYNCHRON" />

<EmptyPlace PlaceNo="1" />

<EmptyPlace PlaceNo="2" />

<EmptyPlace PlaceNo="6" />

<EmptyPlace PlaceNo="7" />

<EmptyPlace PlaceNo="8" />

<EmptyPlace PlaceNo="9" />

<EmptyPlace PlaceNo="10" />

<ToolData>

<DataElem>

Page 45: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 45

<TC_TP>

<TC_TP1>3</TC_TP1>

<TC_TP2>tool</TC_TP2>

...

<TC_TP9>0</TC_TP9>

<MAG_PLACE>3</MAG_PLACE>

</TC_TP>

<DataElem Index="1">

<TC_MOP>

<TC_MOP1>0</TC_MOP1>

...

<TC_MOP13>0</TC_MOP13>

</TC_MOP>

</DataElem>

<TDI>

<TDI_OBJECT_ID>

</TDI_OBJECT_ID>

<TDI_EXTERN_ID>

</TDI_EXTERN_ID>

<TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE>

...

</TDI_LAST_ACCESS_TIME>

<TDI_PRESETTING_TIME>2015-07-03T13:27:47

</TDI_PRESETTING_TIME>

</TDI>

</DataElem>

</ToolData>

</MagList>

</Action>

Page 46: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 46 Function Manual, 11/2016, A5E36812654B-AB

4.3.2 User-defined transformation of the actual tool data

With the aid of XSL Transformation (XSLT), the format of the XML Response of the actual tool data can be specifically changed and adapted as required. Note that this function is only available for the actions 103, 107, 108, 109, 115, and 116.

To adapt the output, a suitable XSLT file must be saved in the XSLT folder of the MMT server. The requested file name is oriented toward the Action Response to be transformed, and therefore corresponds to the format Action_XXX.xslt, in which XXX stands for one of the above-mentioned actions.

Reference example <ToolList xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <A_TOOLMLN>1</A_TOOLMLN> <GlobalId>6251a4cf-d8f8-4b3d-ab08-fd1398580924</GlobalId> <DataFormat>dataFormatNCU</DataFormat> <Tool> <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_TP11>0</TC_TP11> </TC_TP> <TC_TPG> <TC_TPG1>0</TC_TPG1> <TC_TPG2>0</TC_TPG2> <TC_TPG3>0</TC_TPG3> <TC_TPG4>0</TC_TPG4> <TC_TPG5>0</TC_TPG5> <TC_TPG6>0</TC_TPG6> <TC_TPG7>0</TC_TPG7> <TC_TPG8>0</TC_TPG8> <TC_TPG9>0</TC_TPG9> </TC_TPG> <TC_TPC> <TC_TPC1>0</TC_TPC1> <TC_TPC10>0</TC_TPC10> <TC_TPC2>0</TC_TPC2> <TC_TPC3>0</TC_TPC3> <TC_TPC4>0</TC_TPC4> <TC_TPC5>0</TC_TPC5> <TC_TPC6>0</TC_TPC6> <TC_TPC7>0</TC_TPC7> <TC_TPC8>0</TC_TPC8>

Page 47: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 47

<TC_TPC9>0</TC_TPC9> </TC_TPC> <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_TIME>2014-02-14T14:11:11</TDI_TARGET_TIME> <TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE> <TDI_TARGET_PART>3</TDI_TARGET_PART> <TDI_TARGET_SPINDLENO>10</TDI_TARGET_SPINDLENO> <TDI_TARGET_WORK>Worksek1</TDI_TARGET_WORK> </TDI> <EDGES> <Edge> <EDGE>1</EDGE> <TC_DP> <TC_DP10>0</TC_DP10> <TC_DP11>0</TC_DP11> <TC_DP12>0</TC_DP12> <TC_DP13>0</TC_DP13> <TC_DP14>0</TC_DP14> <TC_DP15>0</TC_DP15> <TC_DP16>0</TC_DP16> <TC_DP17>0</TC_DP17> <TC_DP18>0</TC_DP18> <TC_DP19>0</TC_DP19> <TC_DP20>0</TC_DP20> <TC_DP21>0</TC_DP21> <TC_DP22>0</TC_DP22> <TC_DP23>0</TC_DP23> <TC_DP24>0</TC_DP24> <TC_DP25>0</TC_DP25> <TC_DP3>84.172</TC_DP3> <TC_DP4>54.172</TC_DP4> <TC_DP5>0</TC_DP5> <TC_DP6>0.8</TC_DP6> <TC_DP7>0</TC_DP7> <TC_DP8>0</TC_DP8> <TC_DP9>0</TC_DP9> <TC_DP1>500</TC_DP1> </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP11>0</TC_MOP11> <TC_MOP13>0</TC_MOP13>

Page 48: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 48 Function Manual, 11/2016, A5E36812654B-AB

<TC_MOP15>0</TC_MOP15> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> <TC_MOPC> <TC_MOPC1>0</TC_MOPC1> <TC_MOPC10>0</TC_MOPC10> <TC_MOPC2>0</TC_MOPC2> <TC_MOPC3>0</TC_MOPC3> <TC_MOPC4>0</TC_MOPC4> <TC_MOPC5>0</TC_MOPC5> <TC_MOPC6>0</TC_MOPC6> <TC_MOPC7>0</TC_MOPC7> <TC_MOPC8>0</TC_MOPC8> <TC_MOPC9>0</TC_MOPC9> </TC_MOPC> <TC_DPC> <TC_DPC1>0</TC_DPC1> <TC_DPC10>0</TC_DPC10> <TC_DPC2>0</TC_DPC2> <TC_DPC3>0</TC_DPC3> <TC_DPC4>0</TC_DPC4> <TC_DPC5>0</TC_DPC5> <TC_DPC6>0</TC_DPC6> <TC_DPC7>0</TC_DPC7> <TC_DPC8>0</TC_DPC8> <TC_DPC9>0</TC_DPC9> </TC_DPC> </Edge> </EDGES> </Tool> </ToolList>

With the aid of the following XSLT file (here: standard transformation) the format is now converted.

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output method="xml"/> <xsl:template match="/"> <ToolData> <DataElem> <TC_TP> <TC_TP1> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP1"/> </TC_TP1> <TC_TP2> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP2"/> </TC_TP2> <TC_TP3> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP3"/>

Page 49: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 49

</TC_TP3> <TC_TP4> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP4"/> </TC_TP4> <TC_TP5> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP5"/> </TC_TP5> <TC_TP6> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP6"/> </TC_TP6> <TC_TP7> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP7"/> </TC_TP7> <TC_TP8> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP8"/> </TC_TP8> <TC_TP9> <xsl:value-of select="ToolList/Tool/TC_TP/TC_TP9"/> </TC_TP9> <MAG_PLACE></MAG_PLACE> </TC_TP> <xsl:for-each select="ToolList/Tool/EDGES/Edge"> <xsl:element name="DataElem"> <xsl:attribute name="Index"> <xsl:value-of select="./EDGE"/> </xsl:attribute> <TC_MOP> <TC_MOP1> <xsl:value-of select="./TC_MOP/TC_MOP1"/> </TC_MOP1> <TC_MOP2> <xsl:value-of select="./TC_MOP/TC_MOP2"/> </TC_MOP2> <TC_MOP3> <xsl:value-of select="./TC_MOP/TC_MOP3"/> </TC_MOP3> <TC_MOP4> <xsl:value-of select="./TC_MOP/TC_MOP4"/> </TC_MOP4> <TC_MOP11> <xsl:value-of select="./TC_MOP/TC_MOP11"/> </TC_MOP11> <TC_MOP13> <xsl:value-of select="./TC_MOP/TC_MOP13"/> </TC_MOP13> </TC_MOP> </xsl:element> </xsl:for-each> <xsl:apply-templates mode="copy" select="ToolList/Tool/TDI" /> </DataElem> </ToolData> </xsl:template>

Page 50: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 50 Function Manual, 11/2016, A5E36812654B-AB

<!--Copy Whithout Namespace--> <xsl:template match="*" mode="copy"> <xsl:element name="{name()}" namespace="{namespace-uri()}"> <xsl:apply-templates select="@*|node()" mode="copy" /> </xsl:element> </xsl:template> <xsl:template match="@*|text()|comment()" mode="copy"> <xsl:copy/> </xsl:template> </xsl:stylesheet>

Result The user receives a user-defined XML output of the actual tool data (excerpt):

<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> <MAG_PLACE>1</MAG_PLACE> </TC_TP> <DataElem Index="1"> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP11>0</TC_MOP11> <TC_MOP13>0</TC_MOP13> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID>mill_200_Ar</TDI_OBJECT_ID> <TDI_EXTERN_ID>12345678905r</TDI_EXTERN_ID> <TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE> <TDI_TARGET_PART>3</TDI_TARGET_PART> <TDI_TARGET_SPINDLENO>10</TDI_TARGET_SPINDLENO> <TDI_TARGET_TIME>2014-02-14T14:11:11</TDI_TARGET_TIME> <TDI_TARGET_WORK>Worksek1</TDI_TARGET_WORK> <TDI_TOOL_COMMENT>millr</TDI_TOOL_COMMENT> <TDI_TOOLID_DESCRIPTION>tool_millr</TDI_TOOLID_DESCRIPTION> <TDI_ASSIGNED_CONTAINER> </TDI_ASSIGNED_CONTAINER>

Page 51: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 51

<TDI_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE> <TDI_LAST_ACCESS_PROG> </TDI_LAST_ACCESS_PROG> <TDI_LAST_ACCESS_TIME> </TDI_LAST_ACCESS_TIME> <TDI_PRESETTING_TIME> </TDI_PRESETTING_TIME </TDI> </DataElem> </ToolData>

If a corresponding Action_XXX.xslt file is now located in the XSLT folder, then this is used instead of the standard transformation. The user receives the self-defined results.

4.3.3 Protocol for reading/writing/changing data The following sections describe the protocols for reading out/writing/editing tool and/or planning data in MMT.

4.3.3.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 system configuration in MMT. The system configuration contains all of the information about the configured components (cabinets, units, groups, machines, magazines) within the MMT.

Request protocol <Action ID="101"/>

Response protocol <Action ID="101"> <Configuration versionLabel="" crc32="86F2EEE" distributed="1" ...> <Node nodeId="Server" nodeNo="1" globalId="FAFBD571-FD0F-4372-9BBE-8EB1C3FAFD9F" host="192.168.5.186"> <Modules Plant="0" Overview="1" Handling="1" Statistic="1" Machine="1" Planning="1" ...=""> <SinOpSupport name="TdiMcisInterfaces" param="localhost:8000" assem bly="TdiMcisInterface.dll" /> <OEM name="MMTWebInterface" assembly="MMTWebInterface.dll" subscrip-tion_timeout="300000" /> </Modules> <Container id="New magazine" ...="" /> <ContainerAssignment fromParent="0"> <ContainerToAssigne nodeId="Server" containerId="New magazine" asMoveDest="1" asLoad="1" />

Page 52: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 52 Function Manual, 11/2016, A5E36812654B-AB

</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" TPGener-ation="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>

Note

For a detailed description on the structure of the system configuration in MMT please refer to the MMT documentation.

Page 53: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 53

4.3.3.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 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.

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.

Page 54: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 54 Function Manual, 11/2016, A5E36812654B-AB

Example GET request:

http://192.168.6.75:3040/mmt/webinterface.xml?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>

Possible states of the attribute <State> are Add and Deleted.

Note

All tool data must be called by a further action if necessary.

Page 55: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 55

4.3.3.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 system 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 <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.

Response protocol (Solutionline) <Action ID="107"> <MagList NodeId="NCUsl"> <Mag Name="Pick_Up" ContainerState="SYNCHRON" /> <EmptyPlace PlaceNo="2" /> <EmptyPlace PlaceNo="3" /> <EmptyPlace PlaceNo="4" /> <EmptyPlace PlaceNo="5" /> <EmptyPlace PlaceNo="6" /> <EmptyPlace PlaceNo="7" /> <EmptyPlace PlaceNo="8" /> <EmptyPlace PlaceNo="9" /> <EmptyPlace PlaceNo="10" /> <ToolData> <DataElem> <TC_TP> <TC_TP1>3</TC_TP1> <TC_TP2>LUECKE</TC_TP2> <TC_TP3>1</TC_TP3>

Page 56: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 56 Function Manual, 11/2016, A5E36812654B-AB

<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_TPC10>0</TC_TPC10> ... <TC_TPC8>0</TC_TPC8> <TC_TPC9>0</TC_TPC9> </TC_TPC> <DataElem Index="1"> <TC_DP> <TC_DP10>0</TC_DP10> <TC_DP11>0</TC_DP11> <TC_DP12>0</TC_DP12> <TC_DP13>0</TC_DP13> <TC_DP14>0</TC_DP14> <TC_DP15>0</TC_DP15> <TC_DP16>0</TC_DP16> ... <TC_DPVN5>0</TC_DPVN5> <TC_DP1>120</TC_DP1> </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP11>0</TC_MOP11> ... <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> </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>

Page 57: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 57

Response protocol (Powerline) <Action ID="107"> <MagList NodeId="NCUpl"> <Mag Name="Pick_Up" ContainerState="SYNCHRON" /> <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_TP11>0</TC_TP11> </TC_TP> <TC_TPG> <TC_TPG1>0</TC_TPG1> <TC_TPG2>0</TC_TPG2> <TC_TPG3>0</TC_TPG3> ... </TC_TPG> <TC_TPC> <TC_TPC1>0</TC_TPC1> <TC_TPC10>0</TC_TPC10> <TC_TPC2>0</TC_TPC2> ... </TC_TPC> <DataElem Index="1"> <TC_DP> <TC_DP10>0</TC_DP10> <TC_DP11>0</TC_DP11> <TC_DP12>0</TC_DP12> ... </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> ... </TC_MOP> <TC_DPC> <TC_DPC1>0</TC_DPC1> <TC_DPC2>0</TC_DPC2> <TC_DPC3>0</TC_DPC3> ... </TC_DPC> <TC_MOPC>

Page 58: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 58 Function Manual, 11/2016, A5E36812654B-AB

<TC_MOPC1>0</TC_MOPC1> <TC_MOPC10>0</TC_MOPC10> <TC_MOPC2>0</TC_MOPC2> ... </TC_MOPC> </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_TIME>2014-02-14T14:11:11</TDI_TARGET_TIME> <TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE> <TDI_TARGET_PART>3</TDI_TARGET_PART> <TDI_TARGET_SPINDLENO>10</TDI_TARGET_SPINDLENO> <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"

Page 59: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 59

4.3.3.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 system 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 <Action ID="108" Places="All"> <MagList NodeId="NCUsl" ContainerId="Pick_Up"/> <MagList NodeId="Server" ContainerId="Zoller"/> </Action>

Response protocol <Action ID="108"> <MagList NodeId="NCUsl"> <Mag Name="Pick_Up" ContainerState="SYNCHRON" /> <EmptyPlace PlaceNo="1" /> <EmptyPlace PlaceNo="2" /> <EmptyPlace PlaceNo="6" /> <EmptyPlace PlaceNo="7" /> <EmptyPlace PlaceNo="8" /> <EmptyPlace PlaceNo="9" /> <EmptyPlace PlaceNo="10" /> <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> <DataElem Index="1"> <TC_MOP> <TC_MOP1>0</TC_MOP1> ... <TC_MOP13>0</TC_MOP13> </TC_MOP> </DataElem> <TDI>

Page 60: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 60 Function Manual, 11/2016, A5E36812654B-AB

<TDI_OBJECT_ID> </TDI_OBJECT_ID> <TDI_EXTERN_ID> </TDI_EXTERN_ID> <TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE> ... <TDI_PRESETTING_TIME>2015-07-03T13:27:47</TDI_PRESETTING_TIME> </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"

Page 61: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 61

4.3.3.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.) under the specified node are read out.

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 <Action ID="109" Places="All"> <MagList NodeId="NCUsl"/> </Action>

Response protocol <Action ID="109"> <MagList NodeId="NCUsl"> <Mag Name="Pick_Up" ContainerState="SYNCHRON"> <EmptyPlace PlaceNo="2" /> <EmptyPlace PlaceNo="3" /> <EmptyPlace PlaceNo="4" /> <EmptyPlace PlaceNo="5" /> <ToolData> <DataElem> <TC_TP> <TC_TP1>3</TC_TP1> <TC_TP2>LUECKE</TC_TP2> ... <MAG_PLACE>1</MAG_PLACE> </TC_TP> <DataElem Index="1"> <TC_MOP> <TC_MOP1>0</TC_MOP1> ... <TC_MOP13>0</TC_MOP13> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID /> <TDI_EXTERN_ID /> ... <TDI_LAST_ACCESS_TIME /> <TDI_PRESETTING_TIME /> </TDI> </DataElem>

Page 62: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 62 Function Manual, 11/2016, A5E36812654B-AB

</ToolData> </Mag> <Mag Name="MAG-2" ContainerState="SYNCHRON"> <EmptyPlace PlaceNo="7" /> <EmptyPlace PlaceNo="8" /> <EmptyPlace PlaceNo="9" /> <EmptyPlace PlaceNo="10" /> <ToolData> <DataElem> <TC_TP> <TC_TP1>7</TC_TP1> <TC_TP2>toolx</TC_TP2> ... <MAG_PLACE>1</MAG_PLACE> </TC_TP> <DataElem Index="1"> <TC_MOP> <TC_MOP1>0</TC_MOP1> ... <TC_MOP13>0</TC_MOP13> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID /> <TDI_EXTERN_ID /> <TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE> ... <TDI_LAST_ACCESS_PROG /> <TDI_LAST_ACCESS_TIME /> <TDI_PRESETTING_TIME>2015-06-19T09:50:42</TDI_PRESETTING_TIME> </TDI> </DataElem> </ToolData> </Mag> </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"

Page 63: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 63

4.3.3.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 system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51), 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 59) or Read out tool node (Action 109) (Page 61), the tool identifier and the duplo number are required.

Request protocol <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>

Page 64: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 64 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.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 system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51), the tool identifier and the duplo number are required.

Request protocol <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>

Note

The response protocol differs for Powerline and Solutionline controllers.

Response protocol (Solutionline) <Action ID="115"> <ToolData NodeState="OFFLINE"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>TAP</TC_TP2> <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_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> <DataElem Index="1">

Page 65: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 65

<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_DPV4>0</TC_DPV4> <TC_DPV5>0</TC_DPV5> <TC_DPVN3>0</TC_DPVN3> <TC_DPVN4>0</TC_DPVN4> <TC_DPVN5>0</TC_DPVN5> <TC_DP1>240</TC_DP1> </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP11>0</TC_MOP11> <TC_MOP13>0</TC_MOP13> <TC_MOP15>0</TC_MOP15> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID> </TDI_OBJECT_ID> <TDI_EXTERN_ID>15</TDI_EXTERN_ID> <TDI_TARGET_NODE /> <TDI_TARGET_PART /> <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_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE> <TDI_LAST_ACCESS_PROG> </TDI_LAST_ACCESS_PROG> <TDI_LAST_ACCESS_TIME> </TDI_LAST_ACCESS_TIME> <TDI_PRESETTING_TIME>2015-03-10T15:00:12</TDI_PRESETTING_TIME> </TDI> </DataElem> </ToolData> </Action>

Page 66: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 66 Function Manual, 11/2016, A5E36812654B-AB

Response protocol (Powerline) <Action ID="115"> <ToolData NodeState="SYNCHRON"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>TAP</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>1218</TC_TP8> <TC_TP9>0</TC_TP9> <TC_TP10>0</TC_TP10> <TC_TP11>0</TC_TP11> </TC_TP> <DataElem Index="1"> <TC_DP> <TC_DP10>0</TC_DP10> <TC_DP11>0</TC_DP11> <TC_DP12>0</TC_DP12> <TC_DP13>0</TC_DP13> <TC_DP14>0</TC_DP14> <TC_DP15>0</TC_DP15> <TC_DP16>0</TC_DP16> <TC_DP17>0</TC_DP17> <TC_DP18>0</TC_DP18> <TC_DP19>0</TC_DP19> <TC_DP2>9</TC_DP2> <TC_DP20>0</TC_DP20> <TC_DP21>0</TC_DP21> <TC_DP22>0</TC_DP22> <TC_DP23>0</TC_DP23> <TC_DP24>0</TC_DP24> <TC_DP25>0</TC_DP25> <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_MOP1>0</TC_MOP1> <TC_MOP11>0</TC_MOP11> <TC_MOP13>0</TC_MOP13> <TC_MOP15>0</TC_MOP15> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3>

Page 67: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 67

<TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID> </TDI_OBJECT_ID> <TDI_EXTERN_ID>15</TDI_EXTERN_ID> <TDI_TARGET_NODE /> <TDI_TARGET_PART /> <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_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE> <TDI_LAST_ACCESS_PROG> </TDI_LAST_ACCESS_PROG> <TDI_LAST_ACCESS_TIME> </TDI_LAST_ACCESS_TIME> <TDI_PRESETTING_TIME>2015-03-10T15:00:12</TDI_PRESETTING_TIME> </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"

Page 68: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 68 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.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 system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51) and an external ID (e.g. inventory or holder number) are transferred.

Note

If the NodeId attribute is blank, then all nodes are searched.

Request protocol <Action ID="116"> <ToolData NodeId="Server"> <DataElem> <TC_TP> <EXT_ID>Inventarnummer</EXT_ID> </TC_TP> </DataElem> </ToolData> </Action>

Response protocol (Solutionline) <Action ID="116"> <ToolData NodeState="SYNCHRON"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>TAP</TC_TP2> <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_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> <DataElem Index="1"> <TC_DP> <TC_DP8>0</TC_DP8>

Page 69: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 69

<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_DPV4>0</TC_DPV4> <TC_DPV5>0</TC_DPV5> <TC_DPVN3>0</TC_DPVN3> <TC_DPVN4>0</TC_DPVN4> <TC_DPVN5>0</TC_DPVN5> <TC_DP1>240</TC_DP1> </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP11>0</TC_MOP11> <TC_MOP13>0</TC_MOP13> <TC_MOP15>0</TC_MOP15> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> </DataElem> <TDI> <TDI_OBJECT_ID> </TDI_OBJECT_ID> <TDI_EXTERN_ID>15</TDI_EXTERN_ID> <TDI_TARGET_NODE /> <TDI_TARGET_PART /> <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_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE> <TDI_LAST_ACCESS_PROG> </TDI_LAST_ACCESS_PROG> <TDI_LAST_ACCESS_TIME> </TDI_LAST_ACCESS_TIME> <TDI_PRESETTING_TIME>2015-03-10T15:00:12</TDI_PRESETTING_TIME> </TDI> </DataElem> </ToolData> </Action>

Page 70: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 70 Function Manual, 11/2016, A5E36812654B-AB

Response protocol (Powerline) <Action ID="116"> <ToolData NodeState="SYNCHRON"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>OTTO</TC_TP2> <TC_TP3>1</TC_TP3> <TC_TP4>1</TC_TP4> ... <TC_TP11>0</TC_TP11> </TC_TP> <TC_TPG> <TC_TPG1>0</TC_TPG1> <TC_TPG2>0</TC_TPG2> ... <TC_TPG9>0</TC_TPG9> </TC_TPG> <TC_TPC> <TC_TPC1>0</TC_TPC1> <TC_TPC10>0</TC_TPC10> ... <TC_TPC9>0</TC_TPC9> </TC_TPC> <DataElem Index="1"> <TC_DP> <TC_DP10>0</TC_DP10> <TC_DP11>0</TC_DP11> ... <TC_DP8>0</TC_DP8> <TC_DP9>0</TC_DP9> <TC_DP1>110</TC_DP1> </TC_DP> <TC_MOP> <TC_MOP1>0</TC_MOP1> <TC_MOP11>90</TC_MOP11> ... <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> </TC_MOP> <TC_DPC> <TC_DPC1>0</TC_DPC1> <TC_DPC10>0</TC_DPC10> <TC_DPC2>0</TC_DPC2> ... <TC_DPC9>0</TC_DPC9> </TC_DPC> <TC_MOPC> <TC_MOPC1>0</TC_MOPC1> <TC_MOPC10>0</TC_MOPC10> ...

Page 71: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 71

<TC_MOPC9>0</TC_MOPC9> </TC_MOPC> </DataElem> <TDI> <TDI_OBJECT_ID> </TDI_OBJECT_ID> <TDI_EXTERN_ID>15</TDI_EXTERN_ID> <TDI_TARGET_NODE /> <TDI_TARGET_PART /> <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_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_LAST_ACCESS_EDGE>1</TDI_LAST_ACCESS_EDGE> <TDI_LAST_ACCESS_PROG> </TDI_LAST_ACCESS_PROG> <TDI_LAST_ACCESS_TIME> </TDI_LAST_ACCESS_TIME> <TDI_PRESETTING_TIME>2015-03-10T15:00:12</TDI_PRESETTING_TIME> </TDI> </DataElem> </ToolData> </Action>

Page 72: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 72 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.9 Import tool dataset (Action 117) The "Import tool data set (Action 117)" operation is used to import tool data sets into an MMT SQL presetter. The operation enables tool data to be transferred from tool setting 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 system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51)).

Request protocol <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_TPG1>0</TC_TPG1> <TC_TPG2>0</TC_TPG2> <TC_TPG3>0</TC_TPG3> <TC_TPG4>0</TC_TPG4> ... </TC_TPG> <DataElem Index="1"> <TC_DP> <TC_DP1>121</TC_DP1> <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_MOP1>0</TC_MOP1> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> <TC_MOP7>0</TC_MOP7> ... </TC_MOP> </DataElem> <TDI> <TDI_PRESETTING_TIME>2009-11-13T09:20:35</TDI_PRESETTING_TIME>

Page 73: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 73

<TDI_EXTTOOLSTATE>0</TDI_EXTTOOLSTATE> <TDI_ASSIGNED_CONTAINER/> </TDI> </DataElem> </ToolList> </Action>

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

It is only possible to import tool data sets in the SQL presetter of MMT!

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 "Options" in the 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.

Page 74: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 74 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.10 Set/reset the tool unload identifier (Action 118) The "Set/unset tool unload bit (Action 118)" operation is used to set and reset the unload identifier for tools (tool status - parameter: TC_TP8).

The node (NodeId), the tool identifier and the duplo number must be specified for this operation in order to identify the tool (NodeId can be determined from the MMT system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51).

Note

Setting and/or resetting the unload identifier is only possible for tools in machine magazines (NCU container).

The Value attribute must be assigned the value "1" in order to set the unload identifier at the tool, the value is set to "0" to reset it.

Request protocol <Action ID="118"> <ToolList NodeId="Machine1"> <Tool TC_TP2="Tool1" TC_TP1="1" Value="1"/> <Tool TC_TP2="Tool2" TC_TP1="1" Value="1"/> </ToolList> </Action>

Response protocol <Action ID="118"> <ToolList> <Tool TC_TP2="Tool1" TC_TP1="1">OK</Tool> <Tool TC_TP2="Tool2" TC_TP1="1">notOK</Tool> </ToolList> </Action>

4.3.3.11 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.

Page 75: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 75

Request protocol <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>

Page 76: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 76 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.12 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 <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> <TC_DP1>121</TC_DP1> <TC_MOP13>0</TC_MOP13> <BEZEICHNUNG></BEZEICHNUNG> <WZ_SCHRANK_ID>3</WZ_SCHRANK_ID> <TOOL_COMMENT></TOOL_COMMENT> <EDGES>1</EDGES> </TC_TP> </ToolData> </Action>

Page 77: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 77

4.3.3.13 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 <Action ID="121"> <ToolData> <DataElem> <TC_TP> <TC_TP2>Werkzeugbezeichner</TC_TP2> </TC_TP> </DataElem> </ToolData> </Action>

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_TP10>0</TC_TP10> <TC_TP11>0</TC_TP11> </TC_TP> <DataElem Index="1"> <TC_DP> <TC_DP1>120</TC_DP1> <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_MOP1>0</TC_MOP1> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3>

Page 78: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 78 Function Manual, 11/2016, A5E36812654B-AB

<TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> <TC_MOP6>0</TC_MOP6> ... </TC_MOP> </DataElem> <TDI> <TDI_WZSCHRANK_ID>3</TDI_WZSCHRANK_ID> <TDI_TOOLID_DESCRIPTION/> <TDI_TOOL_COMMENT/> </TDI> </DataElem> </ToolList> </Action>

4.3.3.14 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.

Request protocol <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>

Page 79: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 79

4.3.3.15 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.

Request protocol <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_TPG1>0</TC_TPG1> <TC_TPG2>0</TC_TPG2> <TC_TPG3>0</TC_TPG3> <TC_TPG4>0</TC_TPG4> ... </TC_TPG> <DataElem Index="1"> <TC_DP> <TC_DP1>120</TC_DP1> <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_MOP1>0</TC_MOP1> <TC_MOP2>0</TC_MOP2> <TC_MOP3>0</TC_MOP3> <TC_MOP4>0</TC_MOP4> <TC_MOP5>0</TC_MOP5> ... </TC_MOP> </DataElem> <TDI> <TDI_WZSCHRANK_ID>1</TDI_WZSCHRANK_ID>

Page 80: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 80 Function Manual, 11/2016, A5E36812654B-AB

<TDI_TOOLID_DESCRIPTION/> <TDI_TOOL_COMMENT/> </TDI> </DataElem> </ToolList> </Action>

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_TP2>Stammwerkzeug</TC_TP2> <STATE>CREATED</STATE> </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> <TC_TP2>Stammwerkzeug</TC_TP2> <STATE>CHANGED</STATE> </TC_TP> </DataElem> </ToolList> </Action>

Page 81: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 81

4.3.3.16 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 system configuration – see protocol: Readout of the MMT configuration (Action 101) (Page 51). 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 <Action ID="124"> <ToolList NodeId="Server" ContainerId=" Presetter1"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>Stammwerkzeug</TC_TP2> </TC_TP> </DataElem> </ToolList> </Action>

Response protocol <Action ID="124"> <ToolList NodeId="Server" ContainerId="Presetter1"> <DataElem> <TC_TP> <TC_TP1>1</TC_TP1> <TC_TP2>Stammwerkzeug</TC_TP2> <STATE>CREATED</STATE> </TC_TP> </DataElem> </ToolList> </Action>

Page 82: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 82 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.17 Read out tool plan overview (Action 130) The "Read toolplan overview (Action 130)" operation is used to read out an overview of the tool plans which are assigned to a node.

Request protocol <Action ID="130"> <ToolPlanList NodeId="Server"/> </Action>

Response protocol <Action ID="130"> <ToolPlanList> <ToolPlan ID="Base plate" Version="1" InUse="False" LastChange="2004-05- 16T11:17:20"/> <ToolPlan ID="Cylinder" Version="1" InUse="False" LastChange="2004-03- 14T11:17:47"/> <ToolPlan ID="corner" Version="1" InUse="True" LastChange="2004-05- 14T11:17:17"/> <ToolPlan ID="Rough cut" Version="4" InUse="True" LastChange="2004-06- 13T11:17:00"/> <ToolPlan ID="Rough cut2" Version="1" InUse="False" LastChange="2004-06- 13T11:17:10"/> </ToolPlanList> </Action>

Page 83: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 83

4.3.3.18 Read out tool plan (Action 131) The "Read tool plan (Action 131)" operation is used to read out a complete 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 <Action ID="131"> <ToolPlan NodeId="Server" ToolPlanId="Cylinder"/> </Action>

Response protocol <Action ID="131"> <ToolPlan id="Cylinder" nodeId="Server" version="1" prog="Prog2.MPF" duration="25" channel="1" lastChangeDate="2014-02-14T14:11:11" lastChangeName="User" reserve1="" reserve2="" reserve3=""> <Tool toolId="Bohrer2" objectid="bohrer123" occtype="" spindelNo="2" edgeNo="1" cutTime="3" cutCount="1" progPosition="" mon="1"/> <Tool toolId="Schuppenfraeser" edgeNo ="1" cutTime="6" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Eckfraeser" edgeNo ="1" cutTime="2" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Fraeser12" objectid="Fraeser123" occtype="" spindelNo="1" edgeNo ="1" cutTime="4" cutCount="1" progPosition ="" mon="1"/> </ToolPlan> </Action>

4.3.3.19 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 <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>

Page 84: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 84 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.20 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 <Action ID="133"> <ToolPlan id="Plan1" nodeId="Productionline 1" version="1" prog="Prog2.MPF" dura-tion="25" channel="1" lastChangeDate="2014-02-14T14:11:11" lastChangeName="User" reserve1="" reserve2="" reserve3=""> <Tool toolId="Bohrer2" objectid="bohrer123" occtype="" spindelNo="2" edgeNo="1" cutTime="3" cutCount="1" progPosition="" mon="1"/> <Tool toolId="Schuppenfraeser" edgeNo ="1" cutTime="6" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Eckfraeser" edgeNo ="1" cutTime="2" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Fraeser12" objectid="Fraeser123" occtype="" spindelNo="1" edgeNo ="1" cutTime="4" cutCount="1" progPosition ="" mon="1"/> </ToolPlan> </Action>

Response protocol If a tool plan has been successfully created, the following response is sent: <Action ID="133"> <ToolPlan nodeId="Productionline 1" id=" Plan1"> <STATE>CREATED</STATE> </ToolPlan> </Action>

If an existing tool plan is changed in MMT due to this operation, the following response is sent: <Action ID="133"> <ToolPlan nodeId="Productionline 1" id=" Plan1"> <STATE>CHANGED</STATE> </ToolPlan> </Action>

Page 85: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 85

4.3.3.21 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 <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>

Page 86: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 86 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.22 Subscribing to a change of the setting list (Action 140) The "Subscribing to a change of the setting list (Action 140)" operation allows a notification service for the balancing result (setting list) to be activated or deactivated in MMT. The notification service can be activated by the value of the parameter SUBSCRIBE in the request protocol (value "1") or deactivated (value "0"). The timeout defines the amount 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

Activate notification service <Action ID="140"> <SUBSCRIBE timeout="5000">1</SUBSCRIBE> </Action>

Deactivate notification service <Action ID="140" guid="9375c90c-d64a-4def-87f6-109b2ae8db28"> <SUBSCRIBE>0</SUBSCRIBE> </Action>

Note

The GUID returned upon activation must always be sent along with the HTTP GET requests and when the notification server is deactivated.

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

The following response is sent when the notification service is successfully deactivated: <Action ID="140" 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 ActionID and the GUID returned upon activation. The request is replied to immediately if user data is available for retrieval from the WebInterface server.

Page 87: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 87

Example of GET request:

http://192.168.6.75:3040/mmt/webinterface.xml?ActionId=140&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.

The subscriber receives the following response for each new release of the balancing result: <Action ID="140" guid="dcc2aedb-5dc5-4278-8f50-47f57d8b9e21"> <ToolList> <Place nodeId="Productionline 1" containerId="presetter" no="1"> <Tool id="SF2" state="2" type="9999" tool_ptype="1" mon="3" intern="-1"target-node="machine 11" target-part="1" target-count="1"> <CutEdge rtime="5."/> </Tool> </Place> <Place nodeId="Productionline 1" containerId="presetter" no="17"> <Tool id="PF25" state="2" type="9999" tool_ptype="1" mon="3" intern="-1"target-node="machine 21" target-time="2010-08-18T10:39:54"target-work="Cylinder head roughing" target-part="1" target-count="1"> <CutEdge rtime="35."/> </Tool> </Place> </ToolList> </Action>

Page 88: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 88 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.23 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.

Using the following request protocol, the balancing result of the entire system structure is always supplied:

Request protocol <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 allowed (RootNode, Group, Machine):

Request protocol <Action ID="141"> <NodeSelection NodeId="NCU 01"/> <NodeSelection NodeId="Gruppe 2"/> </Action>

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="" />

Page 89: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 89

</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.3.3.24 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

Request protocol

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_NODE>NCUsl</TDI_TARGET_NODE> <TDI_TARGET_TIME>2014-02-14T14:11:11</TDI_TARGET_TIME> <TDI_TARGET_WORK>work</TDI_TARGET_WORK> <TDI_TARGET_PART>3</TDI_TARGET_PART> <TDI_TARGET_SPINDLENO>1</TDI_TARGET_SPINDLENO> </TDI> </Tool> </Action>

Example 2: Removing the reservation ID <Action ID="142"> <Tool NodeId="Server" ContainerId="Zoller" PlaceNo="2" TC_TP2="toolk" TC_TP1="1"> </Tool> </Action>

Page 90: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 90 Function Manual, 11/2016, A5E36812654B-AB

Response protocol <Action ID="142"> <Tool NodeId="Server" ContainerId="Zoller" PlaceNo="2" TC_TP2="toolk" 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 system 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 59) or Read out tool node (Action 109) (Page 61).

Page 91: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 91

4.3.3.25 Transfer the transfer list (Action 160) The "Send tool transfer list (Action 160)" operation is used to add tool transfers in MMT. Each <Transfer> line contains a handling job. A load, unload or relocate job is defined by specifying the source magazine and destination magazine.

Note

This operation is only available for Solutionline machines.

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 59) or Read out tool node (Ac-tion 109) (Page 61))

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/ unloading 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/ unloading point must be specified for the transfer. Note: Parameter is only effective for NCU machine magazines

Request protocol <Action ID="160"> <ToolTransferList> <Transfer SrcNodeId="MASCH35" SrcMag="Kette_82" SrcLoc="5" SrcLoadingPoint="0" DstNodeId="Server" DstMag="Demontage" DstLoc="0" TC_TP2="Bohrer_12mm" TC_TP1="36"/> <Transfer SrcNodeId="Server" SrcMag="Import" SrcLoc="23" DstNodeId="MASCH35" DstMag="Kette_82" DstLoc="0" TC_TP2="Fraeser_35" TC_TP1="37" DstLoadingPoint="0"/> </ToolTransferList> </Action>

Page 92: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 92 Function Manual, 11/2016, A5E36812654B-AB

Response protocol <Action ID="160"> <ToolTransferList>Successful</ToolTransferList> </Action>

4.3.3.26 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- 2 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 59) or Read out tool node (Ac-tion 109) (Page 61))

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 load-ing/unloading 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 load-ing/unloading point must be specified for the transfer. Note: Parameter is only effective for NCU machine magazines

Page 93: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 93

Request protocol

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

Deactivate notification service <Action ID="162" guid="1e14fbaa-4965-4d43-af19-9884d50f5b76"> <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: <Action ID="162" guid="1e14fbaa-4965-4d43-af19-9884d50f5b76"> <Transfer>Started|Error</Transfer> </Action>

The following response is sent if the single handling has been successfully terminated/stopped: <Action ID="162" guid="1e14fbaa-4965-4d43-af19-9884d50f5b76"> <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.

Page 94: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 94 Function Manual, 11/2016, A5E36812654B-AB

Example of GET request http://192.168.6.75:3040/mmt/webinterface.xml?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.

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: <Action ID="162" guid="1e14fbaa-4965-4d43-af19-9884d50f5b76"> <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

Page 95: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 95

4.3.3.27 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.

Request protocol <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 ="" /> <WorkSeq NodeId="Masch1" WorkId="Plan2" WorkPos="2" ToolPlanId="Plan_2" Enabled ="True" PartCountDesired="200" PartCountBilance="100" PartCountReady="0" PartsCountingActiv="False" OrderId="" OrderDate="2004-05-14T11:17:17" OrderStep ="" /> <WorkSeq NodeId="Masch3" 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>

Page 96: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 96 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.28 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 <Action ID="171"> <WorkSeq NodeId="NCUsl" WorkId="Workseq10" ToolPlanId="Plan_1" Enabled ="true" PartCountDesired="200" PartCountBilance="100" PartCountReady="0" 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=""> <STATE>CREATED</STATE> </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=""> <STATE>CHANGED</STATE> </WorkSeq> </Action>

Page 97: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 97

4.3.3.29 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 <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.3.3.30 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 <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>

Page 98: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.3 Interface functions

Access MyData (AMD) 98 Function Manual, 11/2016, A5E36812654B-AB

4.3.3.31 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.

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 <Action ID="174"> <WorkSeq WorkId="work7" Direction ="down" /> </Action>

Response protocol <Action ID="174"> <WorkSeq WorkId="work7">OK</WorkSeq> </Action>

4.3.3.32 Reset WebInterface (Action 1000) The "Reset WebInterface (Action 1000)" operation is used to reset the currently used WebInterface.

Request protocol <Action ID="1000"/>

Response protocol <Action ID="1000"> <Reset>Successful</Reset> </Action>

Page 99: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 99

4.4 Code examples for using the external interface To demonstrate the use of the interface, an example code (C#) is provided in the form of a test program. The test program demonstrates the functionality of the individual interface functions.

Figure 4-3 Code example "MMT WebInterface Tester"

The test tool sends HTTP requests to the MMT WebInterface and displays the responses.

The connection to the MMT server via HTTP is based on the HTTP-GET and HTTP-POST commands. The "MMT WebInterface Tester" connects as an HTTP client to the MMT WebServer. The user data is transferred as XML in UTF-8 coding.

Page 100: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 100 Function Manual, 11/2016, A5E36812654B-AB

4.4.1 Installation and requirements

Installation ● The ZIP archive MMT_InterfaceTester.zip must be unzipped. The archive contains the

test program in the form of a Visual Studio solution.

● The user must ensure that the MMT server can be reached via the network.

Requirements An operational SI server version 4.1 and at least one connected machine are needed as well as the operational application MMT on the SI server. Knowledge is required of SINUMERIK Integrate, Manage MyTools, C# programming and web service technology.

● Version 4.0 of .NET Framework must be installed on the computer.

● The Config.xml file (contains the initialization parameters for the MMT-WebInterface Tester) must be in the same folder as the MMT_InterfaceTester.exe.

● The Requests folder must be in the same folder as the MMT_InterfaceTester.exe and all the actions specified in the Config.xml contained as .xml with the corresponding name.

4.4.2 Initialization When the MMT WebInterface Tester is started, the program reads its initialization parameters from the Config.xml file.

Table 4- 3 Explanation of the parameters

Attribute Description <machine> Parameter with which the MMT WebInterface Tester addresses the

MMT WebInterface <port> Parameter with which the MMT WebInterface Tester addresses the

MMT WebInterface <requests> Contains the path for the folder requests.

Example: "Requests" - all of the request files must then be saved in this folder in the form of XML files

<actions> Requests that are loaded by the MMT WebInterface Tester <dualchan-nel actions> Actions that can be subscribed by the MMT WebInterface Tester <XSD> Contains the path for the folder XSD.

Example: "XSD" - all of the XSD files must then be saved in this folder

Page 101: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 101

<config> <machine>192.168.5.186</machine> <port>3040</port> <requests>C:\Users\Admin\Desktop\testtool_New\Requests</requests> <XSD>C:\Users\Admin\Desktop\testtool_New\XSD</XSD> <actions> <Action_101>Read MMT configuration</Action_101> <Action_103>Subscribe to tool data change</Action_103> <Action_107>Read tool container assignment „All parameters"</Action_107> <Action_108>Read tool container assignment</Action_108> <Action_109>Read node tool assignment</Action_109> <Action_115>Read Tooldata by toolident/ DuploNo</Action_115> <Action_116>Read Tooldata by ExternId</Action_116> <Action_117>Import new tool</Action_117> <Action_118>Set / unset unload bit</Action_118> <Action_119>Delete tool</Action_119> <Action_120>Read master data overview</Action_120> <Action_121>Read mastser data "details"</Action_121> <Action_122>Delete master data</Action_122> <Action_123>Create / Change masterdata set</Action_123> <Action_124>Create new tool from masterdata</Action_124> <Action_130>Read toolplan overview</Action_130> <Action_131>Read toolplan (details)</Action_131> <Action_132>Delete toolplan</Action_132> <Action_133>Add / Change toolplan</Action_133> <Action_134>Read toolplan overview</Action_134> <Action_140>Subscribe / Unsubscribe balancing result</Action_140> <Action_141>Read balancing result</Action_141> <Action_142>Release balancing result</Action_142> <Action_150>Read teamcenter tool catalog data</Action_150> <Action_160>Send tool transferlist</Action_160> <Action_170>Read work sequences</Action_170> <Action_171>Add / Change work sequences</Action_171> <Action_172>Enable/Disable work sequences</Action_172> <Action_173>Delete work sequences</Action_173> <Action_174>Move work sequences</Action_174> <Action_180>Subscribe to load requests</Action_180> <Action_181>Subscribe to tool unloading process</Action_181> <Action_502>Report place assignment</Action_502> <Action_504>Subscribe to transfer list</Action_504> <Action_506>Change magazine connection status</Action_506> <Action_1000>Reset Interface</Action_1000> </actions> <dualchannel_actions> <Action_140>Subscribe / Unsubscribe balancing result</Action_140> <Action_103>Subscribe / Unsubscribe tool assignment</Action_103> </dualchannel_actions> </config>

Page 102: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 102 Function Manual, 11/2016, A5E36812654B-AB

4.4.3 Actions The available functions are called "Actions", and are available in XML format.

Two examples of actions and the received responses are described below.

4.4.3.1 Read out tool plan overview (Action 130) The "Read toolplan overview (Action 130)" operation is used to read out an overview of the tool plans which are assigned to a node. In this example, the list of tool plans is queried by the "server".

Request protocol <Action ID="130"> <ToolPlanList NodeId="Server"/> </Action>

Response protocol <Action ID="130"> <ToolPlanList> <ToolPlan ID="Base plate" Version="1" InUse="False" LastChange="2004-05- 16T11:17:20"/> <ToolPlan ID="Cylinder" Version="1" InUse="False" LastChange="2004-03- 14T11:17:47"/> <ToolPlan ID="corner" Version="1" InUse="True" LastChange="2004-05- 14T11:17:17"/> <ToolPlan ID="Rough cut" Version="4" InUse="True" LastChange="2004-06- 13T11:17:00"/> <ToolPlan ID="Rough cut2" Version="1" InUse="False" LastChange="2004-06- 13T11:17:10"/> </ToolPlanList> </Action>

Page 103: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 103

4.4.3.2 Read out tool plan (Action 131) The "Read tool plan (Action 131)" operation is used to read out a complete 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 <Action ID="131"> <ToolPlan NodeId="Server" ToolPlanId="Cylinder"/> </Action>

Response protocol <Action ID="131"> <ToolPlan id="Cylinder" nodeId="Server" version="1" prog="Prog2.MPF" duration="25" channel="1" lastChangeDate="2014-02-14T14:11:11" lastChangeName="User" reserve1="" reserve2="" reserve3=""> <Tool toolId="Bohrer2" objectid="bohrer123" occtype="" spindelNo="2" edgeNo="1" cutTime="3" cutCount="1" progPosition="" mon="1"/> <Tool toolId="Schuppenfraeser" edgeNo ="1" cutTime="6" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Eckfraeser" edgeNo ="1" cutTime="2" cutCount="1" progPosition ="" mon="1"/> <Tool toolId="Fraeser12" objectid="Fraeser123" occtype="" spindelNo="1" edgeNo ="1" cutTime="4" cutCount="1" progPosition ="" mon="1"/> </ToolPlan> </Action>

Page 104: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 104 Function Manual, 11/2016, A5E36812654B-AB

4.4.4 User interface

Explanation of the functions

Page 105: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 105

① Entry field for the port of the MMT server ⑧ "Clear" button for "Dual Channel_actions Response" output field: deletes the con-tents of the output field

② "Requests" table: List of all available actions ⑨ "Dual Channel_actions Request" table: lists all of the actions that can be subscribed

③ "Send" button: sends the selected action ⑩ "Response" output field: displays the re-sponse received as text

④ "Subscribe" button: subscribes the selected action ⑪ "Clear" button for output field: deletes the contents of the output field

⑤ "Unsubscribe" button: unsubscribes the selected action ⑫ "Save" button for output field: saves the contents of the output field as .txt or .xml

⑥ "Get_Requests" checkbox: sends cyclic GET requests for the selected action

⑬ "Request" input field: displays the XML code to be sent, can be edited

⑦ "Dual Channel_actions Response" output field ⑤ Input field for the IP address of the MMT server

Figure 4-4 MMT WebInterface Tester HMI

Page 106: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 106 Function Manual, 11/2016, A5E36812654B-AB

4.4.5 Synchronous query of data (requests) Synchronous operations are implemented by their own HTTP-POST requests. The MMT WebInterface Tester sends an action to the MMT server in an HTTP-POST request, and immediately receives the requested user data in the response to the query.

Proceed as follows to send a request:

1. Select the required action in the Request table via mouse click or with Enter

2. The corresponding request is displayed in the Request entry field It can be edited

3. Click "Send" to send the request

If the Request entry cannot be read as XML, an appropriate message box is opened

4. The received response is displayed in the Response output field for POST requests

Figure 4-5 Sequence of synchronous requests

Page 107: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 107

4.4.6 Response validation (synchronous requests) To ensure that the XML responses are free of errors and adhere to specific rules, these are validated using the XML scheme if the options "Validate response" is selected.

An XSD scheme, called an XSD file in the following, also has the format XML and is given to a parser, together with the XML file. This imports an XML document and checks whether the rules have been adhered to. The result of the validation check is displayed in the validation check field.

Page 108: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 108 Function Manual, 11/2016, A5E36812654B-AB

4.4.7 Subscribing to data changes In addition to the synchronous queries of data (requests), a notification of data changes can also be subscribed (Dual Channel, Subscription).

To do this, the client must first start the data subscription with an HTTP-POST request.

The client must then continue to send GET requests cyclically until the server has determined the data and sent it back. 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 10 seconds), 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. This procedure is also called "HTTP Dual Channel".

In order to be notified of data changes, proceed as follows:

1. Click the "Subscribe" button to subscribe to the action. The client receives a reply with a GUID from the server.

2. The status of the subscription is displayed in the response output field.

3. To send an HTTP-GET request cyclically to the WebInterface Server, place a checkmark in the Get_Requests column against the already subscribed action.

4. The responses of the GET requests are displayed in the response output field.

Figure 4-6 Dual Channel test sequence

Page 109: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 109

4.4.8 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 system configuration (unless this data is known).

1. Sending Action 101 in order to get the system configuration as a response. For this purpose, the following XML-encoded string must be sent to the MMT server via the HTTP protocol:

<Action ID="101"/>

2. After receipt has been confirmed, the server sends an XML-encoded response via HTTP.

3. The name of the machine nodeId and of the magazine containerId must be determined from the response. The response returns the complete plant tree, which the user sees as tree topology on the right in the basic "Overview" screen of the MMT user interface:

Page 110: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) 110 Function Manual, 11/2016, A5E36812654B-AB

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 via the HTTP protocol:

<Action ID="108">

<MagList NodeId="NCUsl" ContainerId="Pick_Up"/>

</Action>

5. The MMT server sends a response, which contains the tool container assignment. For the magazine with the designation 'Pick_Up', a list of ToolData nodes appears; each of these nodes contains the data of a tool. The meanings of the individual items can be found in this manual.

<Action ID="108">

<MagList NodeId="NCUsl">

<Mag Name="Pick_Up" ContainerState="SYNCHRON" />

<EmptyPlace PlaceNo="1" />

<EmptyPlace PlaceNo="2" />

<EmptyPlace PlaceNo="6" />

<EmptyPlace PlaceNo="7" />

<EmptyPlace PlaceNo="8" />

<EmptyPlace PlaceNo="9" />

<EmptyPlace PlaceNo="10" />

<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>

<DataElem Index="1">

<TC_MOP>

<TC_MOP1>0</TC_MOP1>

...

<TC_MOP13>0</TC_MOP13>

</TC_MOP>

</DataElem>

<TDI>

Page 111: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.4 Code examples for using the external interface

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 111

<TDI_OBJECT_ID>

</TDI_OBJECT_ID>

<TDI_EXTERN_ID>

</TDI_EXTERN_ID>

<TDI_TARGET_NODE>NCUsl</TDI_TARGET_NODE>

...

<TDI_PRESETTING_TIME>2015-07-03T13:27:47</TDI_PRESETTING_TIME>

</TDI>

</DataElem>

</ToolData>

</MagList>

</Action>

Page 112: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 112 Function Manual, 11/2016, A5E36812654B-AB

4.5 Project information

4.5.1 Error message logs For all the above-mentioned WebInterface protocols, one of the following error messages can also be sent as a response to a request to the calling external application.

The list of ErrorText messages below is not a complete list of all possible messages, but merely selected examples.

Data is illogical or contains errors The transferred data (XML string) is illogical or contains errors.

Possible ErrorText messages:

● System.Xml.XmlException

Response protocol: <Error TraceNo="7660/3">ErrorText</Error>

Unknown ActionID A reported action cannot be processed, as an unknown ActionId has been transferred.

Possible ErrorText messages:

● System.NullReferenceException: Object reference not set to an instance of an object.

Response protocol: <Action ID="102"> Request is not valid / Value cannot be null. Parameter name: stream </Action>

Data for request could not be determined No data for a request could be determined.

Possible ErrorText messages:

● Node not found

● ContainerIds could not be found in the TDI configuration

● ContainerIds or NodeIds could not be found in the TDI configuration

Response protocol: <Action ID="108">ErrorText</Action>

Page 113: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 113

4.5.2 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 replacement 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

0: Not released 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)

Transferred with "10" (re-leased and measured).

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: No strategy 1: Next duplo No. 2: Shortest way

"0"

TC_TPG1 Spindle number to which the monitoring data and the "Constant grinding wheel peripheral speed" function (GWPS) refers.

Page 114: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 114 Function Manual, 11/2016, A5E36812654B-AB

Parameter Description Example TC_TPG2 Chaining rule. Using this parameter, which is defined bit-by-bit, it is de-

fined 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 parame-ters is changed, then this is automatically accepted for the other chained parameter. If the following bits are set, the corresponding parameters from D1 and D2 are chained: Bit0: Tool type Bit2: Geometry length1 Bit3: Geometry length2 Bit4: Geometry length3 Bit11: Wear length1 Bit12: Wear length2 Bit13: Wear length3 Bit20: Basic dimension / adapter dimension length1 Bit21: Basic dimension / adapter dimension length2 Bit22: Basic dimension / adapter dimension length3

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 cutting edge D1. 3: Länge 1 4: Länge 2 5: Länge 3 6: Radius

TC_TPC1 User-defined tool parameter1 TC_TPC2 User-defined tool parameter2 TC_TPC3 User-defined tool parameter3 TC_TPC4 User-defined tool parameter4 TC_TPC5 User-defined tool parameter5 TC_TPC6 User-defined tool parameter6 TC_TPC7 User-defined tool parameter7 TC_TPC8 User-defined tool parameter8 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"

Page 115: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 115

Parameter Description Example TC_DP4 Geometry – length 2 "0" TC_DP5 Geometry – length 3 "0" 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_DP9 Geometry – length 5 "0" TC_DP10 Geometry – Angle 1 TC_DP11 Geometry – angle 2 for tapered milling tools TC_DP12 Wear – Length 1 "0" TC_DP13 Wear – Length 2 "0" TC_DP14 Wear – Length 3 "0" TC_DP15 Wear – Radius "0" TC_DP16 Wear – Groove width b / rounding radius "0" TC_DP17 Wear – Projection k "0" TC_DP18 Wear – Length 5 "0" TC_DP19 Wear – Angle 1 "0" TC_DP20 Wear – Angle 2 for tapered milling tools "0" TC_DP21 Adapter -- length 1 "0" TC_DP22 Adapter – length 2 "0" TC_DP23 Adapter – length 3 "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_DPC2 User-defined tool cutting edge parameter 2 "0" TC_DPC3 User-defined tool cutting edge parameter 3 "0" TC_DPC4 User-defined tool cutting edge parameter 4 "0" TC_DPC5 User-defined tool cutting edge parameter 5 "0" TC_DPC6 User-defined tool cutting edge parameter 6 "0" TC_DPC7 User-defined tool cutting edge parameter 7 "0" TC_DPC8 User-defined tool cutting edge parameter 8 "0" TC_DPC9 User-defined tool cutting edge parameter 9 "0" TC_DPC10 User-defined tool edge parameter 10 "0" TC_MOPC1 Monitoring user data 1 "0"

Page 116: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 116 Function Manual, 11/2016, A5E36812654B-AB

Parameter Description Example TC_MOPC2 Monitoring user data 2 "0" TC_MOPC3 Monitoring user data 3 "0" TC_MOPC4 Monitoring user data 4 "0" TC_MOPC5 Monitoring user data 5 "0" TC_MOPC6 Monitoring user data 6 "0" TC_MOPC7 Monitoring user data 7 "0" TC_MOPC8 Monitoring user data 8 "0" TC_MOPC9 Monitoring user data 9 "0" TC_MOPC10 Monitoring user data 10 "0"

4.5.3 Description of Teamcenter tool parameters The following table lists all attributes of the Tooling Library (TLCUA).

Attribute Attribute Name

English Attribute Name German

Units Annotation

-500000 Main Edge Clear-ance Angle

Hauptschn.-Freiwinkel

° ° Alpha A ALPHA

-500001 Edge-Clearance Angle

Nebenschn.-Freiwinkel

° ° Alpha 2 A ALPHA2

-500002 Incline Angle Nom/Max.

Neigungswinkel Nom/Max

° ° Delta n A APPRO

-500003 Cutting Edge An-gle

Schneideckenfasenwinkel

° ° KF A CHAMF

-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

Links ° ° Kappa L A KAPPAL

-500009 Setting Angle Right

Einstellwinkel Rechts

° ° Kappa R A KAPPAR

-500010 Immersion Angle Alpha

Eintauchwinkel Alpha

° ° Alpha 3 A PLUNGE

-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 -500014 Step Angle 3 Stufenwinkel 3 ° ° Phi 3 A STEP3 -500015 Step Angle 4 Stufenwinkel 4 ° ° Phi 4 A STEP4 -500016 Step Angle 5 Stufenwinkel 5 ° ° Phi 5 A STEP5 -500017 Step Angle 6 Stufenwinkel 6 ° ° Phi 6 A STEP6 -500018 Step Angle 7 Stufenwinkel 7 ° ° Phi 7 A STEP7 -500019 Step Angle 8 Stufenwinkel 8 ° ° Phi 8 A STEP8

Page 117: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 117

Attribute Attribute Name English

Attribute Name German

Units Annotation

-500020 Step Angle 9 Stufenwinkel 9 ° ° Phi 9 A STEP9 -500021 Incline Angle Min. Neigungswinkel

Min. ° ° Delta m A2APPRO

-500022 Setting Angle 2 Left

Einstellwinkel2 Links

° ° Kappa2L A2KAPPAL

-500023 Setting Angle 2 Right

Einstellwinkel2 Rechts

° ° Kappa2R A2KAPPAR

-500024 Cutting Depth Max.

Schnitttiefe Max. mm inch ap max CUTDEPTH

-500025 Tool Holder Diam-eter

Aufnahmen-durchmesser

mm inch DA D

-500026 Internal Circle Eingeschriebener Kreis

mm inch D CIRCLE

-500027 Diameter Rough Drilling

Vorbohrdurch-messer

mm inch D Drill D CORE

-500028 Front-Face Inner Diameter

Stirnflächeninnen-durchmesser

mm inch Df D CORE

-500029 Body Diameter Anschlussdurch-messer

mm inch DHB D HUB

-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-

ter Axial Min. Einsatzdurchmes-ser Axial

mm inch Dminax D MIN AX

-500034 Min. Insert Diame-ter Radial

Min. Einsatzdurchmes-ser Radial

mm inch Dminrad D MIN RA

-500035 Pin Diameter Zapfendurchmes-ser

mm inch DP D PIN

-500036 Shank Diameter Schaftdurchmes-ser

mm inch DS D SHANK

-500037 Diameter Profile Circle

Profilkreisdurch-messer

mm inch d D SHAPE

-500038 Thread Diameter Max

Gewindedurch-messer Max.

mm inch DT max D TMAX

-500039 Thread Diameter Min.

Gewindedurch-messer Min.

mm inch DT min D TMIN

-500040 Major Diameter Step 1

Außendurchmes-ser Stufe1

mm inch D1 D1

-500041 External Diameter Step 2

Außendurchmes-ser Stufe2

mm inch D2 D2

-500042 External Diameter Step 3

Außendurchmes-ser Stufe3

mm inch D3 D3

-500043 Shoulder Diameter Bunddurchmesser mm inch DSH DA -500044 Cutting Depth Min. Schnitttiefe Min. mm inch ap min DCUT MIN

Page 118: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 118 Function Manual, 11/2016, A5E36812654B-AB

Attribute Attribute Name English

Attribute Name German

Units Annotation

-500045 Profile Name Profilname CED DESIGN -500046 Diameter Refer-

ence Circle 1 Durchmesser Teilkreis 1

mm inch DRC1 DT1

-500047 Diameter Refer-ence Circle 2

Durchmesser Teilkreis 2

mm inch DRC2 DT2

-500048 Chamfer Cutting Edge

Schneideckenfase mm inch F FACET

-500049 Flat End Planschnei-denfase

mm inch F2 FACET W

-500050 Finishing? Schlichten? FIN FINISH -500051 Shank Height Schafthöhe mm inch H H -500052 Height Of Milling

Tools Fräserhöhe mm inch Lh H

-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

Component Gesamtlänge Komponente

mm inch ltot L TOTAL

-500061 Length Step 1 Länge Stufe1 mm inch L1 L1 -500062 Cutting Edge

Length 1 Schneidkan-tenlänge 1

mm inch CEL1 L1 EDGE

-500063 Length Step 2 Länge Stufe2 mm inch L2 L2 -500064 Cutting Edge

Length 2 Schneidkan-tenlänge 2

mm inch CEL2 L2 EDGE

-500065 Length Step 3 Länge Stufe3 mm inch L3 L3 -500066 Max. Machining

Depth Max. Arbeitstiefe mm inch L4 L4

-500067 Cutting Edge Length

Schneidenlänge mm inch Ls LC

-500068 Restricted Edge Length

Begrenzte Schneidenlänge

mm inch RCEL LC EDGE

-500069 Max. Drilling Depth Horizontal

Max. Bohrtiefe Horizontal

mm inch max BDH LH DRILL

-500070 Max. Drilling Depth Vertical

Max. Bohrtiefe Vertikal

mm inch max BDV LV DRILL

-500071 Hub Length Nabenlänge mm inch HBL NB -500072 Setup Overhead? Einspannung

Überkopf? OVH OVERHEAD

-500073 Pitch Nom/Max. Gewindesteigung Nom/Max.

mm inch p max PITCH T

Page 119: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 119

Attribute Attribute Name English

Attribute Name German

Units Annotation

-500074 Pitch Min. Gewindesteigung Min.

mm inch pitch m PITCHMIN

-500075 Cutting Edge Ra-dius 1

Schneideckenra-dius1

mm inch RE1 R CORNER

-500076 Form Radius 1 Formradius1 mm inch R1 R FORM -500077 Form Radius 2 Formradius2 mm inch R2 R KONKAV -500078 Cutting Edge Ra-

dius 2 Schneideckenra-dius2

mm inch RE2 R2CORNER

-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-

ance Angle (Iso Code)

Hauptschn.-Freiwinkel Iso-Code

Alpha 1 T ALPHA

-500083 Machining Tech-nology

Zerspanungstech-nologie

BA T METHOD

-500084 Insert Tolerance Iso-Code

Plattentoleranz Iso-Code

T T TOL

-500086 Size Indexable Insert

Wendeplatten-größe

T TYP

-500087 Cutting Edges Schneidkan-tenausführung

CET TCUTEDGE

-500088 Chamfer Form Anschnitt-Form CF TECHAM -500089 Pitch Thread/Inch Steigung

Gang/Zoll Gear/In TEETH

-500090 Theorethical Point X

Theoretischer Punkt X

mm inch TPX THEO X

-500091 Theoretical Point Z Theoretischer Punkt Z

mm inch TPZ THEO Z

-500092 Thickness Of Cutting Insert

Schneidplat-tendicke

mm inch S THICKN

-500093 Type Of Thread Gewindeart THS THRDFORM -500094 Tool Tolerance Toleranz

Werkzeug TT TOLERANC

-500095 Construction Code Kon-struktionsmerkmal

CC TRAIT

-500096 Grooving Width Stechbreite mm inch wp W CUT -500097 Width Of True

Rake Flat Breite Spanflächenfase

mm inch TRF-W W FACET

-500098 Max. Tool Width Max. Werkzeug-breite

mm inch W W MAX

-500099 Width/Diameter Of Shank

Schaft-breite/Schaftdurchmesser

mm inch SW/D1 W SHANK

-500100 Sitting Width Max. Schnittbreite Max. mm inch ae max WCUT MAX -500101 Sitting Width Min. Schnittbreite Min. mm inch ae min WCUT MIN

Page 120: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 120 Function Manual, 11/2016, A5E36812654B-AB

Attribute Attribute Name English

Attribute Name German

Units Annotation

-500102 Weight Gewicht kg kg WEIGHT -500103 Coil Length Bundlänge mm inch LC WIDTH -500104 Gauge Length

Component Auskraglänge Komponente

mm inch xs XS

-500105 Gauge Length Min.

Auskraglänge Min. mm inch Xsmin XS MIN

-500106 Cutting Edge Length 2

Schneidenlänge 2 mm inch Ls2 XS2

-500107 Gauge Length 2 Auskraglänge 2 mm inch Xs2 XS2 -500108 Cutting Edge

Length 3 Schneidenlänge 3 mm inch Ls3 XS3

-500109 Gauge Length 3 Auskraglänge 3 mm inch Xs3 XS3 -500110 Cutting Edge

Length 4 Schneidenlänge 4 mm inch Ls4 XS4

-500111 Gauge Length 4 Auskraglänge 4 mm inch Xs4 XS4 -500112 Cutting Edge

Length 5 Schneidenlänge 5 mm inch Ls5 XS5

-500113 Cutting Edge Length 6

Schneidenlänge 6 mm inch Ls6 XS6

-500114 Cutting Edge Length 7

Schneidenlänge 7 mm inch Ls7 XS7

-500115 Cutting Edge Length 8

Schneidenlänge 8 mm inch Ls8 XS8

-500116 Cutting Edge Length 9

Schneidenlänge 9 mm inch Ls9 XS9

-500117 Wheel Diameter Scheibendurch-messer

mm inch Dc YS

-500118 Cutting Diameter Schneidendurch-messer

mm inch Dc YS

-500119 Movement Tool Edges

Wkz-Schnei-denverschiebung

mm inch Ys YS

-500120 Wheel Diameter Max.

Scheibendurchm. Max.

mm inch Dcmax YS MAX

-500121 Wheel Diameter Min.

Scheibendurchm. Min.

mm inch Dcmin YS MIN

-500122 Ys100 Powered Ys100 An-getrieben

mm inch YS100 YS100

-500123 Cutting Diameter 2 Schneidendurch-messer 2

mm inch Dc2 YS2

-500124 Movement Tool Edges 2

Wkz-Schnei-denverschiebung 2

mm inch Ys2 YS2

-500125 Cutting Diameter 3 Schneidendurch-messer 3

mm inch Dc3 YS3

Page 121: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 121

Attribute Attribute Name English

Attribute Name German

Units Annotation

-500126 Movement Tool Edges 3

Wkz-Schnei-denverschiebung 3

mm inch Ys3 YS3

-500127 Cutting Diameter 4 Schneidendurch-messer 4

mm inch Dc4 YS4

-500128 Movement Tool Edges 4

Wkz-Schnei-denverschiebung 4

mm inch Ys4 YS4

-500129 Cutting Diameter 5 Schneidendurch-messer 5

mm inch Dc5 YS5

-500130 Cutting Diameter 6 Schneidendurch-messer 6

mm inch Dc6 YS6

-500131 Cutting Diameter 7 Schneidendurch-messer 7

mm inch Dc7 YS7

-500132 Cutting Diameter 8 Schneidendurch-messer 8

mm inch Dc8 YS8

-500133 Cutting Diameter 9 Schneidendurch-messer 9

mm inch Dc9 YS9

-500134 Corner Angle Schneidenecken-winkel

° ° Sigma AISIGMA

-501000 Tool Holder Aufnahme ADAPTERID -501001 Insert Geometry 1 Plattengeometrie 1 IT1 -501002 Insert Geometry 2 Plattengeometrie 2 IT2 -501003 Insert Geometry 3 Plattengeometrie 3 IT3 -501004 Insert Geometry 4 Plattengeometrie 4 IT4 -501005 Number Insert

Geometry 1 Anzahl Platten-geometrie 1

COUNTWSP1

-501006 Number Insert Geometry 2

Anzahl Platten-geometrie 2

COUNTWSP2

-501007 Number Insert Geometry 3

Anzahl Platten-geometrie 3

COUNTWSP3

-501008 Number Insert Geometry 4

Anzahl Platten-geometrie 4

COUNTWSP4

-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

Workpiece Trennstelle Werkstückseitig

CONNECTORIDIN

-501015 Interface To Ma-chine

Trennstelle Mas-chinenseitig

CONNECTORIDOUT

-501016 Size Interface To Workpiece

Größe Trennstelle Werkstückseitig

sizein

Page 122: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 122 Function Manual, 11/2016, A5E36812654B-AB

Attribute Attribute Name English

Attribute Name German

Units Annotation

-501017 Size Interface To Machine

Größe Trennstelle Maschinenseitig

sizeout

-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

Workpiece Graph-ical

Trennstelle Werkstückseitig Grafik

COLLETNAME

-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 -501031 Length 2 Länge 2 mm inch TCLGTH2 -501032 Diameter 2 Durchmesser 2 mm inch TCDIA2 -501033 Length 3 Länge 3 mm inch TCLGTH3 -501034 Diameter 3 Durchmesser 3 mm inch TCDIA3 -501035 Length 4 Länge 4 mm inch TCLGTH4 -501036 Diameter 4 Durchmesser 4 mm inch TCDIA4 -501037 Length 5 Länge 5 mm inch TCLGTH5 -501038 Diameter 5 Durchmesser 5 mm inch TCDIA5 -501039 List Of Insert

Types 1 Passende Wendeplatten-typen 1

INSERTID1

-501040 List Of Insert Types 2

Passende Wendeplatten-typen 2

INSERTID2

-501041 List Of Insert Types 3

Passende Wendeplatten-typen 3

INSERTID3

-501042 List Of Insert Types 4

Passende Wendeplatten-typen 4

INSERTID4

-501043 Total Length Gesamtlänge mm inch Ltot LTOTTOT -501044 Gauge Length Auskraglänge mm inch Xs XSTOT -501045 Interface To Ma-

chine Graphical Trennstelle Mas-chinenseitig Grafik

ADAPTERNAME

-501046 Setup X-Value Einstellmaß X mm inch -501047 Setup Y-Value Einstellmaß Y mm inch -501058 Tracking Point Schneidenlage TRP -501061 Cutter Material

Norm Schneidstoff Norm CUTGRADENAM

E -501062 Catalog Object Id Katalog Object Id

Page 123: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 123

Attribute Attribute Name English

Attribute Name German

Units Annotation

-501063 Catalog Reference Date

Katalog Refer-enzdatum

-501064 Diameter 6 Durchmesser 6 mm inch TCDIA6 -501065 Diameter 7 Durchmesser 7 mm inch TCDIA7 -501066 Diameter 8 Durchmesser 8 mm inch TCDIA8 -501067 Diameter 9 Durchmesser 9 mm inch TCDIA9 -501068 Diameter 10 Durchmesser 10 mm inch TCDIA10 -501069 Diameter 11 Durchmesser 11 mm inch TCDIA11 -501070 Diameter 12 Durchmesser 12 mm inch TCDIA12 -501071 Diameter 13 Durchmesser 13 mm inch TCDIA13 -501072 Diameter 14 Durchmesser 14 mm inch TCDIA14 -501073 Diameter 15 Durchmesser 15 mm inch TCDIA15 -501074 Diameter 16 Durchmesser 16 mm inch TCDIA16 -501075 Diameter 17 Durchmesser 17 mm inch TCDIA17 -501076 Diameter 18 Durchmesser 18 mm inch TCDIA18 -501077 Diameter 19 Durchmesser 19 mm inch TCDIA19 -501078 Diameter 20 Durchmesser 20 mm inch TCDIA20 -501079 Length 6 Länge 6 mm inch TCLGTH6 -501080 Length 7 Länge 7 mm inch TCLGTH7 -501081 Length 8 Länge 8 mm inch TCLGTH8 -501082 Length 9 Länge 9 mm inch TCLGTH9 -501083 Length 10 Länge 10 mm inch TCLGTH10 -501084 Length 11 Länge 11 mm inch TCLGTH11 -501085 Length 12 Länge 12 mm inch TCLGTH12 -501086 Length 13 Länge 13 mm inch TCLGTH13 -501087 Length 14 Länge 14 mm inch TCLGTH14 -501088 Length 15 Länge 15 mm inch TCLGTH15 -501089 Length 16 Länge 16 mm inch TCLGTH16 -501090 Length 17 Länge 17 mm inch TCLGTH17 -501091 Length 18 Länge 18 mm inch TCLGTH18 -501092 Length 19 Länge 19 mm inch TCLGTH19 -501093 Length 20 Länge 20 mm inch TCLGTH20 -501094 Taper Angle 1 Kegelwinkel 1 ° ° -501095 Taper Angle 2 Kegelwinkel 2 ° ° TCTA2 -501096 Taper Angle 3 Kegelwinkel 3 ° ° TCTA3 -501097 Taper Angle 4 Kegelwinkel 4 ° ° TCTA4 -501098 Taper Angle 5 Kegelwinkel 5 ° ° TCTA5 -501099 Taper Angle 6 Kegelwinkel 6 ° ° TCTA6 -501100 Taper Angle 7 Kegelwinkel 7 ° ° TCTA7 -501101 Taper Angle 8 Kegelwinkel 8 ° ° TCTA8 -501102 Taper Angle 9 Kegelwinkel 9 ° ° TCTA9

Page 124: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 124 Function Manual, 11/2016, A5E36812654B-AB

Attribute Attribute Name English

Attribute Name German

Units Annotation

-501103 Taper Angle 10 Kegelwinkel 10 ° ° TCTA10 -501104 Taper Angle 11 Kegelwinkel 11 ° ° TCTA11 -501105 Taper Angle 12 Kegelwinkel 12 ° ° TCTA12 -501106 Taper Angle 13 Kegelwinkel 13 ° ° TCTA13 -501107 Taper Angle 14 Kegelwinkel 14 ° ° TCTA14 -501108 Taper Angle 15 Kegelwinkel 15 ° ° TCTA15 -501109 Taper Angle 16 Kegelwinkel 16 ° ° TCTA16 -501110 Taper Angle 17 Kegelwinkel 17 ° ° TCTA17 -501111 Taper Angle 18 Kegelwinkel 18 ° ° TCTA18 -501112 Taper Angle 19 Kegelwinkel 19 ° ° TCTA19 -501113 Taper Angle 20 Kegelwinkel 20 ° ° TCTA20 -501114 Corner Radius 1 Eckenradius 1 mm inch TCCR1 -501115 Corner Radius 2 Eckenradius 2 mm inch TCCR2 -501116 Corner Radius 3 Eckenradius 3 mm inch TCCR3 -501117 Corner Radius 4 Eckenradius 4 mm inch TCCR4 -501118 Corner Radius 5 Eckenradius 5 mm inch TCCR5 -501119 Corner Radius 6 Eckenradius 6 mm inch TCCR6 -501120 Corner Radius 7 Eckenradius 7 mm inch TCCR7 -501121 Corner Radius 8 Eckenradius 8 mm inch TCCR8 -501122 Corner Radius 9 Eckenradius 9 mm inch TCCR9 -501123 Corner Radius 10 Eckenradius 10 mm inch TCCR10 -501124 Corner Radius 11 Eckenradius 11 mm inch TCCR11 -501125 Corner Radius 12 Eckenradius 12 mm inch TCCR12 -501126 Corner Radius 13 Eckenradius 13 mm inch TCCR13 -501127 Corner Radius 14 Eckenradius 14 mm inch TCCR14 -501128 Corner Radius 15 Eckenradius 15 mm inch TCCR15 -501129 Corner Radius 16 Eckenradius 16 mm inch TCCR16 -501130 Corner Radius 17 Eckenradius 17 mm inch TCCR17 -501131 Corner Radius 18 Eckenradius 18 mm inch TCCR18 -501132 Corner Radius 19 Eckenradius 19 mm inch TCCR19 -501133 Corner Radius 20 Eckenradius 20 mm inch TCCR20 -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 -501138 Taper Angle 19 Kegelwinkel 19 ° ° TSTA19 -501139 Length 19 Länge 19 mm inch TSLGTH19 -501140 Diameter 19 Durchmesser 19 mm inch TSDIA19 -501141 Taper Angle 18 Kegelwinkel 18 ° ° TSTA18 -501142 Length 18 Länge 18 mm inch TSLGTH18 -501143 Diameter 18 Durchmesser 18 mm inch TSDIA18

Page 125: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 125

Attribute Attribute Name English

Attribute Name German

Units Annotation

-501144 Taper Angle 17 Kegelwinkel 17 ° ° TSTA17 -501145 Length 17 Länge 17 mm inch TSLGTH17 -501146 Diameter 17 Durchmesser 17 mm inch TSDIA17 -501147 Taper Angle 16 Kegelwinkel 16 ° ° TSTA16 -501148 Length 16 Länge 16 mm inch TSLGTH16 -501149 Diameter 16 Durchmesser 16 mm inch TSDIA16 -501150 Taper Angle 15 Kegelwinkel 15 ° ° TSTA15 -501151 Length 15 Länge 15 mm inch TSLGTH15 -501152 Diameter 15 Durchmesser 15 mm inch TSDIA15 -501153 Taper Angle 14 Kegelwinkel 14 ° ° TSTA14 -501154 Length 14 Länge 14 mm inch TSLGTH14 -501155 Diameter 14 Durchmesser 14 mm inch TSDIA14 -501156 Taper Angle 13 Kegelwinkel 13 ° ° TSTA13 -501157 Length 13 Länge 13 mm inch TSLGTH13 -501158 Diameter 13 Durchmesser 13 mm inch TSDIA13 -501159 Taper Angle 12 Kegelwinkel 12 ° ° TSTA12 -501160 Length 12 Länge 12 mm inch TSLGTH12 -501161 Diameter 12 Durchmesser 12 mm inch TSDIA12 -501162 Taper Angle 11 Kegelwinkel 11 ° ° TSTA11 -501163 Length 11 Länge 11 mm inch TSLGTH11 -501164 Diameter 11 Durchmesser 11 mm inch TSDIA11 -501165 Taper Angle 10 Kegelwinkel 10 ° ° TSTA10 -501166 Length 10 Länge 10 mm inch TSLGTH10 -501167 Diameter 10 Durchmesser 10 mm inch TSDIA10 -501168 Taper Angle 9 Kegelwinkel 9 ° ° TSTA9 -501169 Length 9 Länge 9 mm inch TSLGTH9 -501170 Diameter 9 Durchmesser 9 mm inch TSDIA9 -501171 Taper Angle 8 Kegelwinkel 8 ° ° TSTA8 -501172 Length 8 Länge 8 mm inch TSLGTH8 -501173 Diameter 8 Durchmesser 8 mm inch TSDIA8 -501174 Taper Angle 7 Kegelwinkel 7 ° ° TSTA7 -501175 Length 7 Länge 7 mm inch TSLGTH7 -501176 Diameter 7 Durchmesser 7 mm inch TSDIA7 -501177 Taper Angle 6 Kegelwinkel 6 ° ° TSTA6 -501178 Length 6 Länge 6 mm inch TSLGTH6 -501179 Diameter 6 Durchmesser 6 mm inch TSDIA6 -501180 Taper Angle 5 Kegelwinkel 5 ° ° TSTA5 -501181 Length 5 Länge 5 mm inch TSLGTH5 -501182 Diameter 5 Durchmesser 5 mm inch TSDIA5 -501183 Taper Angle 4 Kegelwinkel 4 ° ° TSTA4 -501184 Length 4 Länge 4 mm inch TSLGTH4

Page 126: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to tool information 4.5 Project information

Access MyData (AMD) 126 Function Manual, 11/2016, A5E36812654B-AB

Attribute Attribute Name English

Attribute Name German

Units Annotation

-501185 Diameter 4 Durchmesser 4 mm inch TSDIA4 -501186 Taper Angle 3 Kegelwinkel 3 ° ° TSTA3 -501187 Length 3 Länge 3 mm inch TSLGTH3 -501188 Diameter 3 Durchmesser 3 mm inch TSDIA3 -501189 Taper Angle 2 Kegelwinkel 2 ° ° TSTA2 -501190 Length 2 Länge 2 mm inch TSLGTH2 -501191 Diameter 2 Durchmesser 2 mm inch TSDIA2 -501192 Taper Angle 1 Kegelwinkel 1 ° ° TSTA1 -501193 Length 1 Länge 1 mm inch TSLGTH1 -501194 Diameter 1 Durchmesser 1 mm inch TSDIA1 -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

Insert Wendeplattenform T SIGMA

-501294 Side Angle Seitenwinkel ° ° a2 A A2 -501295 Orientation Angle Orientierungswin-

kel ° ° A KAPPAO

-501296 Insert Shape Stechplattenform INSHAP

Page 127: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 127

Access to NC program data 5 5.1 Introduction

This document 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 a 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 product MMP (Manage MyPrograms).

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.

Page 128: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.2 Requirement

Access MyData (AMD) 128 Function Manual, 11/2016, A5E36812654B-AB

5.2 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.1 Activate interface

Procedure To activate the server interface, you must edit the file "....\DNC\AMD-DNC\web.config" in the installation directory of the MMP server. For the entry httpRuntime, you must change the attribute enable to true. <system.web> <!-- to enable the AMD-DNC interface setenable="true" --> <httpRuntime enable="true" maxRequestLength="2147483647" execution-Timeout="103600"/> </system.web>

5.2.2 Deactivate interface

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

Page 129: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.3 Target group

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 129

5.3 Target group Software developers who develop their own product functions and NC program data/information with the SI server and want to replace the lower-level machine tools.

Page 130: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.4 Description of the interfaces

Access MyData (AMD) 130 Function Manual, 11/2016, A5E36812654B-AB

5.4 Description of the interfaces

Overview of the web service interface

Page 131: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.4 Description of the interfaces

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 131

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> ListNodes( No-deIdentifier parent, PlantLayoutFilter filter )

Lists the nodes that belong to the plant struc-ture. The function only lists one level.

List<PlantLayoutNode> ListNodesWith-Children( NodeIdentifier parent, PlantLayoutFilter filter )

Lists the nodes that belong to the plant struc-ture. The function lists all of the levels under the parent 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.

Page 132: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) 132 Function Manual, 11/2016, A5E36812654B-AB

5.5 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 DeleteNodes( List<NodeIdentifier> identifiers ) Remove nodes from the MMP server.

Deletes nodes of the type ContentNode. Delete a list of nodes with specified ID

StreamingTicket ExportAttachment( No-deIdentifier id, out AttachmentNodeIn-fo info )

Export attachment from the MMP server. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to access the contents of the file. The AttachmentNodeInfo object contains metadata for the file attachment

ExportPackageInfo ExportPackage( No-deIdentifier id ) Export package from the MMP server.

The return value contains information about the contents of the package and the associat-ed StreamingTickets for the file contents. With the StreamingTicket, the file contents must then be read out on the FileTransfer interface (DownloadFile).

StreamingTicket ExportPartProgram( NodeIdentifier id, out PartProgramNo-deInfo partProgramInfo )

Export NC file from the MMP server. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to access the contents of the file. The object PartProgramNodeInfo contains the metadata from MMP.

ContentNode FinalizeUpload( Streaming-Ticket ticket ) Complete upload.

Completes the upload of an imported item. Only in this way is the data in the MMP ad-ministration saved.

Page 133: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 133

Name Description

StreamingTicket ImportAttachment( No-deIdentifier parent, AttachmentNodeIn-fo info )

Import attachment into the MMP server. Imports an attachment under an NC file or an NC package. With the StreamingTicket, the FileTransfer interface (UploadFile) must then be used to transfer the contents of the file. The import procedure must be completed with a FinalizeUpload

ContentNode ImportPackage( NodeIdenti-fier parent, PackageNodeInfo info ) Create package in the MMP server.

Regardless of the type attribute, this creates 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 ImportPartProgram( NodeIdentifier parent, PartProgramNo-deInfo partProgramInfo, string ver-sionToOverwrite )

Import NC file into the MMP server. Imports an NC file under a machine group node, machine node, workpiece node, or NC package node. With the StreamingTicket, the FileTransfer interface (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. The import procedure must be completed with a FinalizeUpload

List<ContentNode> ListNodes( NodeIden-tifier parent, Filter filter ) List nodes in the MMP server.

Lists the nodes of the type ContentNode lying directly under the parent node with a specified filter.

List<ContentNode> ListNodesWithChil-dren( NodeIdentifier parent, Filter filter )

List nodes in the MMP server. Lists all the nodes of the type ContentNode under the parent node and all the subnodes with a specified filter.

Page 134: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) 134 Function Manual, 11/2016, A5E36812654B-AB

Name Description

void SetAvailableForTrialCutFlag( No-deIdentifier id, string versionToSet-Flag, bool value )

Sets the trial cut ID or the Available-ForTrialCut flag. Without trial cut ID or release ID, an NC file cannot be transferred to the machine. This function is used to set the trial cut ID for a node with the specified version.

void SetReleasedFlag( NodeIdentifier id, bool value, bool resetAvailable-ForTrialCutFlag )

Sets the Released flag. Without trial cut ID or release ID, an NC file cannot be transferred to the machine. 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().

Page 135: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 135

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 GetMachineStatus(), a check should be made as to whether the machine can process the jobs. Name Description

void DeleteOnMachine( NodeIdentifier machine, List<MachineDncItem> item-sToDelete )

Deletes a list of items on a machine.

List<DncMachineCapabilities> GetCapa-bilities( NodeIdentifier machine ) Provides the capabilities of a machine. De-

pending on the machine technology and the type of connection to MMP, only a part of the scope of functions of the interface can be used.

MachineDncStatus GetMachineStatus( NodeIdentifier machine ) Returns the status of a machine ("online",

"offline", "unknown").

List<MachineDncItem> ListItemsOnMa-chine( NodeIdentifier machine ) Lists the items on a machine.

void TransferFromMachine( NodeIdenti-fier machine, NodeIdentifier parent, List<MachineDncItem> itemsToTransfer )

Transfers a list of items from the file system of a machine to a level in the administrative structure on the MMP server.

void TransferToMachine( NodeIdentifier machine, List<NodeIdentifier> itemsTo-Transfer, TransferOptions trans-ferOptions )

Transfers a list of items to a destination speci-fied with the TransferOptions object in the file system of the machine.

void SelectItem(NodeIdentifier ma-chine, MachineDncItemIdentifier item, uint channel )

Selects an item for a channel.

void DeselectItem(NodeIdentifier ma-chine, uint channel ) Deselects the selected NC program in a

channel.

StreamingTicket ImportToMachine( No-deIdentifier machine, MachineDncItem machineDncItem )

Imports an NC file directly into the file system of the machine The program is not registered in the MMP system but only stored in temporary memory. With the StreamingTicket, the FileTransfer interface (UploadFile) must then be used to transfer the contents of the file to the server.

Page 136: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) 136 Function Manual, 11/2016, A5E36812654B-AB

Name Description

ExportMachineDncItem ExportFromMa-chine( NodeIdentifier machine, Ma-chineDncItemIdentifier item )

Exports an NC file directly from the file system of the machine. The program is not registered in the MMP system but only stored in temporary memory. The returned ExportMachineDncItem object contains the file information and a streaming ticket. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to read the contents of the file from the server.

MachineDncItem FinalizeUpload( Stream-ingTicket ticket ) Complete upload.

Completes the upload of an imported item. Only 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.

Page 137: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 137

Interface for transferring the contents of files

The interface provides access to the file contents, which were initiated by a previous call of the DncContent or DncMachineFunctions interface. Name Description

Stream DownloadFile(StreamingTicket downloadRequest) Receipt of the file contents from the

MMP server, identified by a DownloadTicket

StreamingTicket UploadFile(String CheckSum, String FileName, Streaming-Ticket streamingTicket, Stream File-ByteStream)

Sending a file to the MMP server, identified by an upload ticket. The checksum is currently not evaluated and can remain blank. The file name must be identical 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)).

Page 138: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) 138 Function Manual, 11/2016, A5E36812654B-AB

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

Name Description

List<NotificationConfiguration> Get-NotificationConfiguration( Notifica-tionTarget target )

Returns the configuration of a notification.

void RegisterForNotification( Notifi-cationTarget target, List<NotificationConfiguration> noti-ficationConfiguration )

Subscribing to a notification.

void UnregisterForNotification( Noti-ficationTarget target ) Unsubscribing a notification.

INotificationCallback

Clients must implement this interface for the notification. Name Description

void OnEvent( List<DncNotificationEvent> events ) Callback for the OnEvent.

Page 139: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.5 The type of a machine

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 139

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.

ConnectionFault

ImportFault

DataReaderFault

UnknownFault

UploadFault

Page 140: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.6 Terms

Access MyData (AMD) 140 Function Manual, 11/2016, A5E36812654B-AB

5.6 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

package Work-piece

NC file Attach-ment

Group ✓ ✓ --- --- --- --- --- Machine ✓ ✓ --- --- --- --- --- NC package --- ✓ ✓ --- --- --- --- Workpiece --- ✓ ✓ --- --- --- --- NC file --- ✓ ✓ ✓ ✓ --- --- Attachment --- --- --- ✓ --- ✓ ---

--- = not permitted ✓ = permitted

Page 141: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.6 Terms

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 141

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.

Page 142: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.6 Terms

Access MyData (AMD) 142 Function Manual, 11/2016, A5E36812654B-AB

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.

Page 143: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.6 Terms

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 143

StreamingTicket After an import job, the client receives a StreamingTicket. With the aid of this ticket, the contents can be imported.

Page 144: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.7 Programs on the machine

Access MyData (AMD) 144 Function Manual, 11/2016, A5E36812654B-AB

5.7 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.

Page 145: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.8 The settings of the transfer

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 145

5.8 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.

Page 146: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.9 Information about the machines

Access MyData (AMD) 146 Function Manual, 11/2016, A5E36812654B-AB

5.9 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.

Page 147: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.10 The capabilities of a machine

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 147

5.10 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. DirectTrans-ferItem

It is possible to transfer files past the MMP management to and from the ma-chine. 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 Solu-tionline 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.

Page 148: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.11 Application example

Access MyData (AMD) 148 Function Manual, 11/2016, A5E36812654B-AB

5.11 Application example To demonstrate the use of the interface, an example code (C#) is provided in the form of a test program. The test program demonstrates the functionality of the individual interface functions. An operational SI server and at least one connected machine are needed. In addition, the operational product MMP on the SI server and the machine. Knowledge is required of SI, the MMP product, C# programming and web service technology.

5.11.1 Introduction The scope of delivery of SINUMERIK Integrate Access includes an example of code (Application example "Testclient_AMD") to use the functions of the access to NC program data. This is a C# Windows form application in which selected function calls can be simulated.

All of the files required for this can be found in the "Testclient_AMD.zip" archive.

The archive is located in the subfolder "Sinumerik_Integrate_Server/Sinumerik_Integrate_Setup/AMD-MMP" on the product DVD. The example application contains examples for accessing NC program data.

5.11.2 Contents of the example application With the contents of the ZIP file "Testclient_AMD.zip", it is possible to create the environment for an example application, which can be used to represent the functionality of the new API interface. It contains:

● Testclient_AMD.sln – Visual Studio 2010 Solution (C#)

● Contract dlls

● WSDL files

● Chm files for the help of the individual service call-ups (Documentation.chm)

● Example program

5.11.3 Installing application examples

Procedure 1. Open the test client "Testclient_AMD.sln".

2. Compile the solution.

3. Adapt the "web.config" file. The service endpoints must be set to the current SI server.

4. Start the test client.

Page 149: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.11 Application example

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 149

5.11.4 Creating a test organization

Procedure 1. First, you create an organization.

2. Then create a machine via the PC UI of the SI server and a machine of the same name via the MMP Admin.

3. Connect the machine to a controller. Only then can all of the functions of the example application be executed.

4. After the project has been successfully compiled, the individual functions can be called from the user interface.

Page 150: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 150 Function Manual, 11/2016, A5E36812654B-AB

5.12 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

List<PlantLayoutNode> ListNodesWithChildren( NodeIdentifier parent, PlantLayoutFilter filter )

Lists the nodes that belong to the plant struc-ture. The function lists all the levels below the "par-ent" node.

If the "All levels per call" checkbox is not enabled: Name Description

List<PlantLayoutNode> ListNodes( NodeIdentifier parent, PlantLayoutFilter filter )

Lists the nodes that belong to the plant struc-ture. The function only lists one level.

Page 151: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 151

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

List<ContentNode> ListNodesWithChildren( NodeIdentifier parent, Filter filter )

List nodes in the MMP server. Lists all the nodes of the type ContentNode under the "parent" node and all the subnodes with a specified filter.

If the "All levels per call" checkbox is not enabled: Name Description

List<ContentNode> ListNodes( NodeIdentifier parent, Fil-ter filter )

List nodes in the MMP server. Lists the nodes of the type ContentNode lying directly under the parent node with a specified filter.

Page 152: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 152 Function Manual, 11/2016, A5E36812654B-AB

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-ment

Opens a dialog with which the attachments are imported into the server.

Machine status Queries the status of the selected controller. M Capabilities Returns the capabilities of the selected controller which are supported or not sup-

ported. 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-ment

Opens a dialog with which the attachments are exported from the server.

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> ListItemsOnMa-chine( NodeIdentifier machine ) Lists the items on a machine

Page 153: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 153

There are buttons for additional functions on the right side of the dialog.

Transfer back Name Description

void TransferFromMachine( NodeIdenti-fier machine, NodeIdentifier parent, List<MachineDncItem> itemsToTransfer )

Transfers a list of items from the file system of a machine to a level in the administrative structure on the MMP server.

Delete Name Description

void DeleteOnMachine( NodeIdentifier machine, List<MachineDncItem> item-sToDelete )

Deletes a list of items on a machine

select Name Description

void SelectItem(NodeIdentifier ma-chine, MachineDncItemIdentifier item, uint channel )

Selects an item for a channel

deselect Name Description

void DeselectItem(NodeIdentifier ma-chine, uint channel ) Deselects the selected NC program in a

channel

Page 154: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 154 Function Manual, 11/2016, A5E36812654B-AB

Imp. to machine

First, the following function is carried out: Name Description

StreamingTicket ImportToMachine( No-deIdentifier machine, MachineDncItem machineDncItem )

Imports an NC file directly into the file system of the machine The program is not registered in the MMP system but only stored in temporary memory. With the StreamingTicket, the FileTransfer interface (UploadFile) must then be used to transfer the contents of the file to the server.

The following function is then executed with the "StreamingTicket": Name Description

StreamingTicket UploadFile(String CheckSum, String FileName, Streaming-Ticket streamingTicket, Stream File-ByteStream)

Sending a file to the MMP server, identified by an upload ticket. The checksum is currently not evaluated and can remain blank. The file name must be identical to the file name when the ticket is initiated

Finally the following function must be executed: Name Description

MachineDncItem FinalizeUpload( Stream-ingTicket ticket ) Complete upload.

Completes the upload of an imported item. Only in this way is the data saved on the machine.

Exp. from machine

First, the following function is carried out: Name Description

ExportMachineDncItem ExportFromMa-chine( NodeIdentifier machine, Ma-chineDncItemIdentifier item )

Exports an NC file directly from the file system of the machine. The program is not registered in the MMP system but only stored in temporary memory. The returned ExportMachineDncItem object contains the file information and a streaming ticket. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to read the contents of the file from the server.

The following function is then executed: Name Description

Stream DownloadFile(StreamingTicket downloadRequest) Receipt of the file contents from the

MMP server, identified by a DownloadTicket

Page 155: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 155

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 SetAvailableForTrialCutFlag( No-deIdentifier id, string versionToSet-Flag, bool value )

Sets the trial cut ID or the Available-ForTrialCutFlag Without trial cut ID or release ID, an NC file cannot be transferred to the machine. This function is used to set the trial cut ID for a node with the specified version.

void SetReleasedFlag( NodeIdentifier id, bool value, bool resetAvailable-ForTrialCutFlag )

Sets the SetReleasedFlag Without trial cut ID or release ID, an NC file cannot be transferred to the machine. 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 DeleteNodes( List<NodeIdentifier> identifiers ) Remove nodes from the MMP server.

Deletes nodes of the type ContentNode. Delete a list of nodes with specified ID

Page 156: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 156 Function Manual, 11/2016, A5E36812654B-AB

Transfer This dialog transfers selected items into the specified path to the controller. Name Description

void TransferToMachine( NodeIdentifier machine, List<NodeIdentifier> itemsTo-Transfer, TransferOptions trans-ferOptions )

Transfers a list of items to a destination speci-fied with the TransferOptions object in the file system of the machine.

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 ImportPackage( NodeIdenti-fier parent, PackageNodeInfo info ) Create package in the MMP server.

Regardless of the type attribute, this creates 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.

Page 157: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 157

Imp. partprog. The button opens a dialog in which the NC program is selected for import.

The following function is used for this: Name Description

StreamingTicket ImportPartProgram( NodeIdentifier parent, PartProgramNo-deInfo partProgramInfo, string ver-sionToOverwrite )

Import NC file into the MMP server. Imports an NC file under a machine group node, machine node, workpiece node, or NC package node. With the StreamingTicket, the FileTransfer interface (UploadFile) must then be used to transfer 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. The import procedure must be completed with a FinalizeUpload.

Imp. attachment The button opens a dialog in which an attachment is selected for import.

The following function is used for this: Name Description

StreamingTicket ImportAttachment( No-deIdentifier parent, AttachmentNodeIn-fo info )

Import attachment into the MMP server. Imports an attachment under an NC file or an NC package. With the StreamingTicket, the FileTransfer interface (.UploadFile) must then be used to transfer the contents of the file. The import procedure must be completed with a FinalizeUpload

Machine status The button opens a dialog in which the current status of the controller is displayed.

The following function is used for this: Name Description

MachineDncStatus GetMachineStatus( NodeIdentifier machine ) Returns the status of a machine ("online",

"offline", "unknown").

Page 158: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 158 Function Manual, 11/2016, A5E36812654B-AB

M Capabilities The button opens a dialog in which the supported functions are displayed.

The following function is used for this: Name Description

List<DncMachineCapabilities> GetCapa-bilities( NodeIdentifier machine ) Provides the capabilities of a machine.

Depending on the machine technology and the 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.

The following function is used for this: Name Description

ExportPackageInfo ExportPackage( No-deIdentifier id ) Export package from the MMP server.

The return value contains information about the contents of the package and the associat-ed StreamingTickets for the file contents. With the StreamingTicket, the file contents must then be read out on the FileTransfer interface (DownloadFile).

The following function is then executed: Name Description

Stream DownloadFile(StreamingTicket downloadRequest) Receipt of the file contents from the

MMP server, identified by a DownloadTicket

Page 159: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 159

Exp. partprog. The button opens a dialog in which the save location is selected.

The following function is used for this: Name Description

StreamingTicket ExportPartProgram( NodeIdentifier id, out PartProgramNo-deInfo partProgramInfo )

Export NC file from the MMP server. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to access the contents of the file. The object PartProgramNodeInfo contains the metadata from MMP.

The following function is then executed: Name Description

Stream DownloadFile(StreamingTicket downloadRequest) Receipt of the file contents from the

MMP server, identified by a DownloadTicket

Exp. attachment The button opens a dialog in which the save location is selected.

The following function is used for this: Name Description

StreamingTicket ExportAttachment( No-deIdentifier id, out AttachmentNodeIn-fo info )

Export attachment from the MMP server. With the StreamingTicket, the FileTransfer interface (DownloadFile) must then be used to access the contents of the file. The AttachmentNodeInfo object contains metadata for the file attachment

The following function is then executed: Name Description

Stream DownloadFile(StreamingTicket downloadRequest) Receipt of the file contents from the

MMP server, identified by a DownloadTicket

Page 160: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access to NC program data 5.12 Test program

Access MyData (AMD) 160 Function Manual, 11/2016, A5E36812654B-AB

Page 161: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 161

Project information A A.1 List of abbreviations Admin Administrator (user role) AMB Access MyBackup AMC Analyze MyCondition AMD Access MyData AMM/E Access MyMachine/Ethernet AMP Analyze MyPerformance AMT Access MyTool ID ASCII American Standard Code for Information Interchange ASP Application Service Provider-Variante 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,

Page 162: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Project information A.1 List of abbreviations

Access MyData (AMD) 162 Function Manual, 11/2016, A5E36812654B-AB

HW Hardware 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 MS Microsoft MSDE Microsoft Data Engine or Microsoft Desktop Engine database software MSI Microsoft Software Installation 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

Page 163: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Project information A.1 List of abbreviations

Access MyData (AMD) Function Manual, 11/2016, A5E36812654B-AB 163

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 setting station SFI Shop Floor Integrate SI SINUMERIK Integrate SK Softkey 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: Tool assemblies 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

Page 164: Function Manual Access MyData (AMD) - Siemens · PDF fileAccess MyData (AMD) Function Manual Valid for: ... systems and solutions for automation and ... represent an obligation to

Project information A.1 List of abbreviations

Access MyData (AMD) 164 Function Manual, 11/2016, A5E36812654B-AB


Recommended