CAD
`work station
`
`CAD
`work station
`
`B ase
`
`SAP Funclion
`Librar~
`
`AP Interface %
`x Program J
`
`SAP-CAD Dialog Interface
`
`The following Help Topics are available:
`
`PP
`
`For Help on Help, Press F1
`Version
`
`SAP-00000591
`
`

`
`Version
`Prepared for R/3 Release 2.2.
`August 94
`
`SAP-00000592
`
`

`
`Copyrights
`
`@1994 SAP AG. All rights reserved.
`Neither this documentation nor any part of it may be copied or reproduced in any form or by any
`means or translated into another language, without the prior consent of SAP AG.
`SAP AG makes no warranties or represenations with respect to the content hereof and specifically
`disclaims any implied warranties of merchantability or fitness for any particular purpose. SAP AG
`assumes no responsibility for any errors that may appear in this document. The information
`contained in this document is subject to change without notice. SAP AG reserves the right to
`make any such changes without obligation to notify any person of such revision or changes. SAP
`AG makes no commitment to keep the information contained herein up to date.
`
`SAP-00000593
`
`

`
`Introduction
`
`This section outlines the contents and structure of this guide.
`SAP-CAD interface and which areas it can be used in.
`
`It describes the functions of the
`
`SAP-00000594
`
`

`
`This Guide is Intended for
`
`This guide is mainly intended for engineers, designers and technicians who work with a CAD
`system and process data from a connected SAP System (PJ2 or R/3) using the SAP-CAD dialog
`interface. It describes the range of functions which can be carried out using the interface and the
`essential requirements for use.
`For information on how to configure the SAP-CAD interface and the connection program between
`the CAD system and the interface, see the SAP-CAD Dialog Interface.
`
`SAP-00000595
`
`

`
`Use of the SAP-CAD Dialog Interface
`
`Information systems within a company are traditionally divided into two main areas:
`¯ Engineering information systems
`¯ Commercial information systems
`Most companies have tended to develop these two areas independently from each other, the main
`concern being how well the system could solve the specific problems of the area concerned.
`Integration with other applications was only a minor consideration. The isolated solutions arising
`from this situation lead to a number of problems:
`Data needed in more than one system has to be entered manually several times and
`subsequently updated manually several times.
`As it is not possible to access data from other application areas, product development work may
`be duplicated or parallel developments may result. You do not have a central overview of
`existing data.
`Central control and monitoring of projects and transactions involving several departments is only
`possible with extensive organization.
`As flexibility and efficiency are becoming increasingly important to the performance of a company,
`the integration of information systems in different departments is becoming one of a company’s
`most important priorities. The essential aims of this process are:
`¯ Central storage of data to minimize data redundancy and reduce the data maintenance
`workload
`¯ Connections between and networking of the individual information systems, particularly between
`engineering and commercial application areas
`¯ Quicker access to existing data
`¯ Central control, analysis and monitoring of processes which involve more than one area
`If your company uses an SAP System for processing commercial data, this system can be
`connected to CAD work centers in your engineering information system using the SAP-CAD dialog
`interface. This enables you to access data in the production system and use this information (for
`example, information on existing materials and assemblies) in your work. As data can be
`transferred between the CAD system and the SAP System in both directions, inconsistency of the
`data in the two systems is avoided.
`
`SAP-00000596
`
`

`
`Features of the SAP-CAD Interface
`
`This section describes the structure of the SAP-CAD dialog interface.
`requirements need to be fulfilled before you can use the interface.
`
`It explains which
`
`SAP-00000597
`
`

`
`Structure of the Interface
`The SAP-CAD dialog interface enables you to set up an online connection between a CAD system
`or engineering information system and an SAP System. This connection allows you to transfer
`data in both directions between the two systems
`
`CAD
`work station
`
`CAD
`work station
`
`SAP Funclion
`Librar~
`
`Engineering
`Dala
`B ase
`
`The interface consists of two components:
`¯ SAP function library
`¯ SAP interface program
`
`SAP-00000598
`
`

`
`SAP Function Library
`
`The SAP function library is a collection of sub-programs in the programming language C. Each of
`these sub-programs carries out a specific function for communicating with the SAP interface
`program. Before you can access individual SAP functions from your CAD system, the function
`library must be integrated into the CAD program. This means you need to install an appropriate
`interface program in the CAD system. CPIC (Common Programming Interface Communication) is
`used as a transfer protocol.
`When you install the system, you can use SAP tables to configure most functions to suit your
`requirements. For example, you can define which data is transferred and in which order. In
`addition, you can define different field lengths from those defined in the R/3 Repository.
`
`SAP Interface Program
`
`The SAP interface program has the following functions:
`In response to the commands coming from the CAD system, the program reads data in the SAP
`database and converts it to the format required for transfer. This data is then transferred to the
`CAD system. If the data can be changed in the CAD system, the data is blocked for changes in
`the SAP System.
`¯ The program checks data coming from the CAD system for consistency, then transfers it to the
`appropriate SAP transactions so that an update can be made.
`¯ When data from the CAD system is saved in the SAP System, the program ensures that the
`same data is updated as for an SAP online transaction.
`
`SAP-00000599
`
`

`
`Requirements
`
`Before you can access an SAP System from your CAD system using the SAP-CAD interface, the
`following requirements must be fulfilled:
`¯ The SAP System must be activated.
`¯ The interface program for accessing the SAP function library must be available and installed in
`the CAD system.
`¯ The SAP function library must be installed in the CAD system.
`¯ A CPIC user must be created in the SAP System. You can give this CPIC user the same
`authorizations as an online user. This means that the SAP authorization system remains
`consistent, even when you access the system using the dialog interface.
`¯ All hardware and software requirements for data transfer must be met (Gateway activated, and
`SO on).
`
`SAP-00000600
`
`

`
`Integrating the Functions into the CAD Program
`
`Whether you can use the functions of the SAP dialog interface in your CAD system and which
`functions you can use depends on whether the CAD interface program uses the functions in the
`SAP function library and with which parameters. CAD system users can access the functions in
`the following ways:
`¯ By entering a command string in a field defined for that purpose
`¯ By selecting a function from the menu
`For information on how to implement a connection to the SAP dialog interface in your CAD
`program, please refer to the documentation for the CAD program.
`
`SAP-00000601
`
`

`
`Error Messages
`
`Selecting a function in the CAD system triggers a series of individual communication steps. If an
`error is recognized when these communication steps are processed, the function will, in most
`cases, be terminated. You may see the following types of error message:
`Error message for a transaction in the SAP System
`In this case, you see the same error message on the screen that would appear if you were
`working directly in the SAP System. The text is preceded by a six-character message ID,
`structured as follows:
`1st
`character: E (Error)
`character: message ID from SAP table 100
`2nd-3rd
`4th-6th
`character: error number from SAP table 100
`Error message from the SAP function library
`In these error messages, the text is preceded by a five-character message I D consisting of the
`letters "FB" and a three-figure error number.
`CPIC error message
`If a CPIC error occurs, the connection between the CAD system and the SAP System is
`automatically terminated.
`Error message from the CAD program
`For information on these error messages, please refer to the documentation for your CAD
`program.
`
`SAP-00000602
`
`

`
`Functions
`
`This section describes the individual functions of the SAP function library. The individual functions
`are described from the point of view of the end user.
`The SAP dialog interface can be used to access the following functions in the SAP System:
`
`.................................... i ..........
`
`SAP-00000603
`
`

`
`KGeneral Functions
`
`The following general functions are supported in the SAP dialog interface:
`¯ Logon to the SAP System
`¯ Logoff from the SAP System
`¯ Terminate a function
`¯ Synchronization
`¯ Display online documentation
`¯ Select possible entries
`
`Logon to SAP System
`
`This function is used to establish an online connection between the CAD system and the SAP
`System. If the connection is established successfully, the SAP System sends a message to the
`CAD system containing the logical identification of the SAP System and the release number.
`
`Logoff from SAP System
`
`This function is used to terminate the online connection between the CAD system and the SAP
`System. This function can be called at any time, even while another function is being processed.
`In this case, the other function is closed down properly before the connection is terminated.
`
`Terminate Function
`
`This command is used to terminate a function which consists of several communication steps.
`You can terminate a function whenever the CAD system is doing the processing. The current
`function is interrupted, all temporary data is deleted, and the CAD system is then ready for you to
`enter a new command.
`
`Synchronization
`
`The format of the data transferred between the CAD system and the SAP System when they
`communicate with each other is defined in tables in the SAP System. These tables must be
`transferred to the CAD system, so that data sent is in the same format as data received. However,
`you only need to make a transfer when one of the tables in the SAP System has been changed.
`The end user does not normally need to use this function.
`
`Display Online Documentation
`
`This function allows you to display the online documentation for a field, provided that
`documentation for the field exists in the SAP System.
`
`Display Possible Entries
`
`This function allows you to display the possible entries for a field, provided that a check table is
`assigned to the field in the SAP System.
`
`SAP-00000604
`
`

`
`Functions for Accessing Material Master Data
`
`The following functions for accessing material master data are supported in the SAP dialog
`interface:
`¯ Create material master
`¯ Reserve material number
`¯ Change material master
`¯ Display material master
`
`Create Material Master
`
`You can use the SAP-CAD dialog interface to create material masters in the SAP System from your
`CAD system. You can create all views on a material.
`When you create a material, you can either enter the material number or leave it to be assigned
`from an internal number range. You need to define the material type and industry sector.
`
`Reserve Material Number
`
`When you create a new material in the CAD system, it is saved to the database of the CAD system
`under a particular number. When the drawing is released, a material master for this material is to
`be created in the SAP System. To ensure that the number you require is still available when you
`come to create the material in the SAP System, you have the option of reserving a number within
`an internal number range from your CAD system. The number is transferred to the CAD system
`and can then be displayed or assigned to the object (material). The SAP System counts up the
`next number in the internal number range, but no material master is created. Once the design
`phase of the new material is completed, you can create the material in the SAP System under the
`number you reserved.
`This process ensures that you do not have to rename a material you created in the CAD system
`under a particular number when you create the material in the SAP System.
`
`Change Material Master
`
`You can change all views on a material from your CAD system. Settings in the relevant tables
`determine which data is transferred from the SAP System to the CAD system and back.
`You must enter the material number for the material you want to display.
`Depending on which fields from the SAP material master you want to display, you may have to
`make entries in other fields (such as plant or storage location).
`If the material is not found in the SAP System, the function is terminated. If a material is found
`under the number you entered, the data of this material is transferred to the CAD system. At the
`same time, the material is blocked for changes by other users in the SAP System.
`
`Display Material Master
`
`This function enables you to display data for a material in the SAP System, provided that the user
`you use to Iogon to the SAP System is authorized to process material master data. The following
`types of display are possible:
`¯ Display material master without classification data
`You need to enter the number of the material to be displayed.
`Depending on which fields from the SAP material master you want to display, you may have to
`make entries in other fields (such as plant or storage location).
`
`SAP-00000605
`
`

`
`¯ Display material master via matchcode selection
`Once the command for matchcode selection has been transferred to the SAP System, the SAP
`System transmits all the available matchcodes to the CAD system.
`If you know the structure of the matchcode you want to use, enter the matchcode ID followed by the
`data required. The SAP System determines which material numbers match this data and transfers
`them to the CAD system.
`If you do not know the structure of the matchcode you want to use, select the ID of the matchcode.
`The SAP System transfers the fields of this matchcode to the CAD system. Once you have made
`your entries, the materials that match your selection criteria are listed.
`
`SAP-00000606
`
`

`
`Functions for Accessing Document Info Records
`
`The SAP-CAD dialog interface can be used to transfer data from document info records between
`the SAP System and the CAD system. The following functions are supported:
`¯ Create document info record
`¯ Change document info record
`¯ Display document info record
`
`Create Document Info Record
`
`When you create a document info record from your CAD system, either you can enter a document
`number or the number can be assigned by the SAP System. If you choose the second option, a
`..... or "blank" must be transferred from the CAD system to the SAP System via the interface. The
`number determined by the system is transferred to the CAD system and can then be assigned to
`the object (document) for which the info record is to be created.
`The document version number can also be assigned either externally or internally. The document
`type and document part are required entries.
`
`Change Document Info Record
`
`This function enables you to change document info records stored in the SAP System from your
`CAD system. To select a document info record, the document number, document part, document
`type and version number must be transferred to the SAP System. If the document info record
`does not exist in the SAP System, the function is terminated. Otherwise, the data in the record is
`transferred to the CAD system and can be changed there. While you are changing the record in
`the CAD system, it is blocked in the SAP System.
`
`Display Document Info Record
`
`This function enables you to display data in a document info record stored in the SAP System,
`provided that the user you used to Iogon to the SAP System is authorized to display document info
`records of the selected document type. The following types of display are supported:
`¯ Display document info record directly
`To identify the document info record to be display, the document number, document part, document
`type and version number must be transferred to the SAP System.
`¯ Display document info record using matchcode selection
`To display a document using a matchcode, first select the matchcode ID. If you know the structure
`of the matchcode you want to use, enter the matchcode ID followed by the data required.
`Otherwise, select the matchcode ID only. The SAP System transfers the fields of this matchcode
`to the CAD system. Once you have made your entries, the materials that match your selection
`criteria are listed.
`
`SAP-00000607
`
`

`
`Functions for Accessing Bills of Material
`
`The SAP-CAD dialog interface can be used to transfer data from bills of material between the SAP
`System and your CAD system. The following functions are supported:
`¯ Create bill of material
`¯ Change bill of material
`¯ Display bill of material
`
`Create Bill of Material
`
`A bill of material in the SAP System is made up of two main parts: the BOM header and the BOM
`items. Both parts must be entered and transferred to the SAP System when you create a bill of
`material in the CAD system. You cannot make entries in the following fields from the CAD system:
`¯ Long text indicator (you can only enter long texts from the SAP System)
`¯ CAD indicator (this is set internally by the SAP interface program)
`You can create both variant BOMs and multiple BOMs.
`
`Change Bill of Material
`
`This function enables you to change bills of material stored in the SAP System from your CAD
`system. To uniquely identify the bill of material, you must enter the material number of the BOM
`material, the BOM usage and the plant. You also need to enter a change number, as you can only
`make changes to bills of material with history.
`You can only change a field in a bill of material from the CAD system if it is one of the fields in
`which you can make an entry when creating a BOM from the CAD system. Only BOM items which
`were created from the CAD system, and therefore contain the CAD indicator, can be changed from
`the CAD system.
`If the bill of material or change number you enter does not exist in the SAP System, or is not valid
`on the date specified, the SAP interface program terminates the function. Otherwise, the BOM
`header data and all CAD items are transferred to the CAD system. Once you have made your
`changes, all of this data is transferred back to the SAP System via the dialog interface. The SAP
`System compares the data it receives with the data previously stored in the system, and
`determines which items are to be updated in the database.
`
`Display Bill of Material
`
`This function enables you to display data from a bill of material in the SAP System, provided that
`the user you use to Iogon to the SAP System is authorized to display bills of material of the
`appropriate BOM category in the selected plant. The following types of display are supported:
`¯ Display bill of material (single-level)
`¯ Display BOM level by level
`¯ Display multi-level BOM
`¯ Display summarized BOM
`To uniquely identify the bill of material, you need to enter the material number, the plant, and the
`usage. If the bill of material is a multiple BOM, you also enter the alternative or the required
`quantity. If no valid-from date is specified from the CAD system, the SAP System uses the current
`date.
`
`SAP-00000608
`
`

`
`Examples
`
`This section describes some of the processes which might occur when you use a CAD system
`together with the SAP-CAD dialog interface. The following processes are described:
`
`These process flows are divided into a series of sub-processes, shown in a diagram. The
`diagrams are structured as follows:
`On the left of the diagram, you see the individual steps which make up the process, in the form
`of a flowchart. Each box represents an activity in the CAD system or a function of the
`SAP-CAD dialog interface.
`On the right of the diagram, you see the syntax from the SAP function library for the function in
`each step in the process.
`The processes shown are examples only and should not be regarded as representing a general
`rule.
`In these examples, the drawings are released in the engineering system (CAD system). The SAP
`System is to be regarded as a follow-on application area.
`
`SAP-00000609
`
`

`
`Finding a Document Info Record using a Matchcode
`
`This example shows a possible sequence of functions for finding a document info record by using a
`matchcode.
`First, display all the matchcodes for selecting document info records via the SAP-CAD dialog
`interface. You have the following two options:
`If you know the structure of the matchcode you require, enter the matchcode I D, together with
`the selection criteria for the matchcode. You then see a list of all the document info records
`which match your selection criteria.
`If you do not know the structure of the matchcode you require, first enter the matchcode I D.
`The SAP System transfers the selection fields of this matchcode to the CAD system. Enter
`your selection criteria in these fields. You then see a list of all the document info records which
`match your selection criteria.
`If none of the document info records listed is for the object you are looking for, repeat the search
`process using different selection criteria or a different matchcode.
`
`SAP-00000610
`
`

`
`forfindinga
`document info
`record
`
`I~
`F
`I
`
`ICall matchcode I
`Iaelect matchco de
`
`Select matchcode
`~thout entering
`selection criteria
`
`nd enter
`election criteria
`
`DOCRQ RL
`
`DOKRQID
`
`DOKRQRF
`
`selection criteria
`
`IEnter I
`IList all document
`
`info recordsfound
`using rnatchcode
`
`Y
`
`SAP-00000611
`
`

`
`Creating a Single-part Drawing without a Reference
`
`This example shows a possible sequence of functions for creating a drawing for a single part
`without using an existing drawing as a reference to copy data from.
`First, reserve a material number in the SAP System for the object (material) you want to create.
`Then start to create your drawing. This process may be spread over a long period of time. The
`drawing is saved in the local system under a drawing number.
`Once the single-part drawing is finished, assign the material number you reserved in the SAP
`System to the drawing. You can then release the drawing.
`Finally, create a material master (with the reserved number) and a document info record in the SAP
`System for the drawing you just created.
`
`Reservematerial
`number in
`SAPSystem
`t
`Create
`drawing
`
`Save drawing
`in local system
`
`~sign reserved
`material numbert
`singlepart
`
`Release
`drawing
`t
`
`Create
`material master in
`SAP System
`
`Create document
`info record in
`SAP System
`
`RSRVE MT
`
`MATCR MA
`
`DOCCR MR
`
`SAP-00000612
`
`

`
`Creating a Single-part Drawing from a Reference
`
`This example shows a possible sequence of functions for creating a single-part drawing, using an
`existing drawing as a reference to copy from.
`First, select the drawing you want to copy from. Provided that document info records have been
`created in the SAP System for all drawings, you can find the drawing you are looking for using a
`matchcode. This process is described under ~a [3Q£um~rlt !r~[QF~ec~[d usinq a Ma~chc~de.
`Once you have found the document info record of the drawing you want to copy from, load the
`drawing to the CAD system. Change the drawing as required and save it under a new drawing
`number in the CAD system.
`Reserve a material number in the SAP System and assign this number to the object (material)
`which the new drawing represents.
`Once the drawing is finished, release the drawing. Then create a material master (with the
`reserved number) and a document info record in the SAP System via the SAP-CAD interface.
`
`SAP-00000613
`
`

`
`Fin a document into
`reoord of referenoe
`arawingusing
`matchoode
`t
`Load arawingto
`CAD S~tem and
`changearawing
`
`Save drawing under
`new drawing
`number
`
`Re6 erve m ateri al
`numberin
`SAPSystem
`
`Assign res erred
`material numberto
`singlepart
`
`I
`
`Release drawing
`
`I
`
`Create m ateri al
`masterin SAPS~stem
`
`Create aocu ment
`into record in
`SAPS~stem
`
`RSRVE MT
`
`MATCR MA
`
`DOCCR MR
`
`SAP-00000614
`
`

`
`Creating an Assembly Drawing
`
`This example shows a possible sequence of functions for creating an assembly drawing.
`First, select the single-part drawings you want to use in your assembly drawing. Provided that
`document info records have been created in the SAP System for all drawings, you can find the
`drawings you are looking for using a matchcode.
`Once you have found the document info records of the single-part drawings, load these drawings to
`the CAD system and put them together in one drawing. Assign the individual objects in the
`drawing to a group.
`Once you have released the drawing, create a material master, a document info record, and a bill
`of material for the assembly in the SAP System.
`
`SAP-00000615
`
`

`
`Find document into
`records of
`single-part drawings
`
`Load drawings to
`CAD System and use
`in assemblydrawing
`
`Assign individual
`objects to a
`group
`
`Release
`drawing
`t
`Create material
`master for assembly
`in SAP System
`
`Create document
`into record in
`8APSystem
`t
`Create bill of material
`for assembly in
`SAP System
`
`DOCRQ RL
`
`MATCRMA
`
`DOCCR M R
`
`BOMCRMP
`
`SAP-00000616
`
`

`
`K terminate function
`
`SAP-00000617