CAD Interface (CA-CAD)
Introduction to the CAD Interface
Before You Use the CAD Interface
This Guide is Intended for:
Use of the CAD Interface
Applications of the CAD Interface
Structure of the CAD Interface
CAD Interfaces in the SAP System
Dialog Interface
Dialog RFC Interface
Comparison of the Dialog Interface and the Dialog
Integration of the Dialog Interface and the Dialog
Installing Functions in the External Application
Overview of Functions in the CAD Dialog Interface
Material Master Record Functions (CAD Dialog Inter
Document Management Functions (CAD Dialog Interfac
BOM Functions (CAD Dialog Interface)
Engineering Change Management Functions (CAD Dialo
Plant Maintenance Functions (CAD Dialog Interface)
General Functions (CAD Dialog Interface)
Overview of Functions in the Dialog RFC Interface
Material Master Record Functions (Dialog RFC Inter
Document Management Functions (Dialog RFC Interfac
BOM Functions (Dialog RFC Interface)
Engineering Change Management Functions (Dialog RF
Plant Maintenance Functions (Dialog RFC Interface)
Mail and Workflow Functions (Dialog RFC Interface)
General Functions (Dialog RFC Interface)
Examples of How the CAD Dialog Interface Can be Us
Finding a Document Info Record via Matchcode
Designing a Single-Part Drawing
Designing a Single-Part Drawing by Copying
Designing an Assembly Drawing
CAD Interface (CA-CAD)
Technical Description of the CAD Dialog Interface
General Information on the CAD Dialog Interface
SAP Function Library
SAP Interface Program
Notes on Installation
Customizing the SAP-CAD Function Library
Before You Use the SAP-CAD Function Library
Configuration File sideinfo
Configuration File saprfc.ini
Customizing the SAP System
General Information on Customizing
Control Parameters
Customizing General Data
User-Defined Functions
Example: Settings for Displaying a Where-Used List
Example: Settings for a User-Defined Function
Including RCCADCOM in User-Defined Functions
Emulation of the SAP System
Emulation Library
Data File cademu.r3
General Functions in the CAD Dialog Interface
General Information
Data Transfer Using Data Strings
General Functions in the CAD Interface
CONNC - Establishing a Connection to the SAP Syste
DISCO - Terminating a Connection to the SAP System
BREAK - Terminating the Current Function
SYSRQ - System Functions
Displaying System Parameters
Displaying Configuration Tables TCIM, TCIU, and TC
Displaying Technical Field Information for a Funct
HLPRQ - Help Functions
Displaying ONLINE Field Documentation (F1 Help)
Displaying Possible Entries (F4 Help)
Displaying Allowed Values for Several Characterist
Displaying the Long Text for an Error Message
Functions for Material Master Records
MATCR - Creating a Material Master Record
Creating a Material Master Record Without Classifi
Creating a Material Master Record With Classificat
Setting up Strings for Characteristics and Values
Characteristics Data for a Class
Values for Characteristics
Assigned Characteristic Values
MATCH - Changing a Material Master Record
Changing a Material Master Record Without Classifi
Changing A Material Master Record With Classificat
List of All Classes
MATCH MC: Creating an Allocation to an Additional
MATCH MC: Deleting an Existing Allocation to a Cla
MATRQ - Displaying a Material Master Record
Displaying a Material Master Record Without Classi
Displaying a Material Master Record With Classific
Finding a Material Master Record via Matchcode
Displaying Material Master Record Data for Several
RSRVE - Reserving a Material Number
Functions for Document Management
DOCCR - Creating a Document Info Record
Creating a Document Info Record Without Classifica
Creating a Document Info Record With Classificatio
DOCCH - Changing a Document Info Record
Changing a Document Info Record Without Classifica
Changing a Document Info Record With Classificatio
Changing a Document Info Record (Object Links Only
DOCRQ - Displaying a Document Info Record
Displaying a Document Info Record Without Classifi
Displaying a Document Info Record With Classificat
Finding a Document Info Record via Matchcode
Finding a Document Info Record Using Transaction C
Displaying a Document Info Record (Object Links On
Displaying the Status History of a Document Info R
DOCCI - Check In Functions for Original Application Files
Check In for Original Application Files
Displaying a List of All Available Vaults
DOCCO - Check Out Functions for Original Applicati
Check Out for Original Application Files
Displaying an Original Application File
Functions for BOMs
BOMCR – Creating a BOM
BOMCN – Changing a BOM
BOMRQ – Displaying a BOM
BOMWU – Displaying a Where-Used List
CadBomCreateSubItem – Creating a BOM With Sub-Item
CadBomChangeSubItemRead – Reading and Changing a B
CadBomChangeSubItem – Changing a BOM with Sub-Item
CadBomDisplaySubItem – Displaying a BOM With Sub-I
Functions for Engineering Change Management
CHGCR - Creating a Change Master Record
Creating a Change Master Record Without Classifica
Creating a Change Master Record With Classificatio
CHGCH - Changing a Change Master Record
Changing a Change Master Record Without Classifica
Changing a Change Master Record with Classification
CHGRQ - Displaying a Change Master Record
Displaying a Change Master Record Without Classifi
Displaying a Change Master Record With Classification
Finding a Change Master Record via Matchcode
ECRCR - Creating an ECR
Creating an ECR Without Classification
Creating an ECR With Classification
ECRCH - Changing an ECR
Changing an ECR Without Classification
Changing an ECR with Classification
ECRRQ - Displaying an ECR
Displaying an ECR Without Classification
Displaying an ECR With Classification
Finding an ECR via Matchcode
Functions for Plant Maintenance
EQICR - Creating an Equipment Master Record
Creating an Equipment Master Record Without Classi
Creating an Equipment Master Record With Classific
EQICH - Changing an Equipment Master Record
Changing an Equipment Master Record Without Classi
Changing an Equipment Master Record With Classific
Dismantling Equipment Master Records
EQIRQ - Displaying an Equipment Master Record
Displaying an Equipment Master Record Without Clas
Displaying an Equipment Master Record With Classif
Finding an Equipment via Matchcode
Displaying an Equipment Hierarchy
PMNCR - Creating a Maintenance Notification
TPCCR - Creating a Functional Location
Creating a Functional Location Without Classificat
Creating a Functional Location With Classification
TPCCH - Changing a Functional Location
Changing a Functional Location Without Classificat
Changing a Functional Location With Classification
TPCRQ - Displaying a Functional Location
Displaying a Functional Location Without Classific
Displaying a Functional Location With Classificati
Finding a Functional Location via Matchcode
Displaying a Functional Location Hierarchy
Displaying a Functional Location with Installed Eq
Classification System Functions
SLCLS - Finding Classes - Navigating in a Class Ne
Finding Classes by Catchwords (Matchcode)
Finding Classes by Generic Entry
Finding Classes without a Superior Class
Displaying Superior and Subordinate Classes for a
SLOBJ - Finding Objects in Classes
Displaying the Characteristics of a Class
Displaying All Objects in a Class
Finding Objects via Classes
Setting a New View in Table INDX
Initializing Class Data
Office Functions
SMAIL - Office Functions
Reading Your Inbox
Reading Your Outbox
Reading Your Mail Trash
Reading a Document
Reading the Attachments to a Document
Setting a Document to “In Process” Status
Setting a Document to “Done” Status
Deleting a Document
Displaying the Recipient List for a Document
Sending a Document
Finding an SAP User Name Generically
Description of Function Library caddialg
General Information on the Function Library
Header Files and Libraries Required
Structure of Function Calls
Transfer Fields
Status Information
Syntax
Description of Functions
General functions
Functions for Material Master Records
Classification System Functions
Functions for Document Management
Functions for Plant Maintenance
Functions for Engineering Change Management
Functions for BOMs
Office Functions
User-Defined Functions
General Rules for Data Transfer
Functions of the CAD Toolbox Library
Introduction
Installation and Implementation
Functions
General Functions
Configure Toolbox
Init Toolbox
Load Configuration Data
Load Error Message
Load Version of Toolbox
Save Configuration Parameters
Save Configuration Tables
Utility Functions
Delete Table Entry
Load Attribute Name
Print Internal Table
Find Attribute
Master Record Functions
Count Table Entries (Master Record Functions)
Create Internal Table
Create and Fill Internal Table
Create Send String
Create Send String for BOM Header Data (R/3)
Fill Internal Table
Load Attribute Value for Record Number
Load Attribute Value for Attribute Name
Change Table Value
Save Table Value
Classification Functions
Count Table Entries (Classification Functions)
Count Characteristic Values (R/3)
Create Send String for Allowed Characteristic Valu
Create Send String for Characteristics Data (R/2 a
Create Send String for Class Data (R/3)
Create Send String for Class Scope (R/3)
Create Send String for Finding Classes(R/3)
Create Send String for Finding Objects via Classes
Create and Fill Class Hierarchy Table(R/3)
Create and Fill Classification Table (R/3)
Create and Fill Characteristic Values Table(R/3)
Create Characteristics Data Table
Delete Search Result (R/2)
Load Classification Data for Characteristic Number
Load Classification Data for Characteristic Name (
Load Classification Data for Characteristic Number
Load Classification Data for Characteristic Name (
Load Characteristic Value Data (R/3)
Load Object Oata (R/3)
Load Class Data (R/3)
Load Class Hierarchy Data (R/3)
Load Search Result Data (R/3)
Save Characteristic Value and Description
Save Search Result
Matchcode Functions
Count Matchcode Records
Create and Fill Internal Matchcode Table
Create Send String for Matchcode
Load Matchcode Fields
Save Matchcode Field Value
Online Help Functions
Count Table Entries (Help Functions)
Fill Internal Table for Online Help
Create Send String for Online Help
Create Send String for Long Text of SAP Message (R
Fill Internal Table for Online Help
Load Online Help Data
Mail Functions (R/3 2.1/2.2)
Count Table Entries (Mail Functions)
Create Send String for Mail Data
Create Internal Table for Mail Data
Load Mail Data from Table
Mail Field Names
Save Mail Data to Table
User-Defined Functions
Create Internal Table for User-Defined Functions
Appendix
Files
CADTMES.DAT
CADTTAB.DAT
CADTOOLC.H
Structures
SAPOBJ_R3
SAPSML_R3
SAPCLAS_R3
SAPCLAS_S_R3
SAPCLAS_H_R3
SAPMES
SAPATT
Tables
TCIM
TCIT
TCID
TCIU
Technical Description of the Dialog RFC Interface
General Information on the Dialog RFC Interface
How the Dialog RFC Interface Works
Applications of the Dialog RFC Interface
Notes on Installation
Customizing the Dialog RFC Interface
Configuration File cadrfc.ini
Default Values for BOMs
Default Values for Document Management
Default Values for Material Master Records
Default Values for Plant Maintenance
General Default Values
Description of the Available RFC Function Modules
Transfer Tables SAP_FIELD_DATA and DMS_CLASS_DATA
Functions for Document Management
Creating a Document Info Record
Changing a Document Info Record
Displaying a Document Info Record
Finding a Document Info Record
Inserting a Document Info Record
Reading a Document Info Record
Inserting and Checking Out Documents
Reading Data for the Drawing Header
Functions for Material Master Records
Creating a Material Master Record
Changing a Material Master Record
Displaying a Material Master Record
Reading a Material Master Record
Functions for Engineering Change Management
Creating a Change Master Record
Changing a Change Master Record
Displaying a Change Master Record
Functions for BOMs
Creating a Material BOM
Changing a Material BOM
Displaying a Material BOM
Functions for Plant Maintenance
Creating an Equipment Master Record
Changing an Equipment Master Record
Displaying an Equipment Master Record
Reading an Equipment Master Record
Creating a Functional Location
Changing a Functional Location
Displaying a Functional Location
Reading a Functional Location
Creating a Maintenance Notification
Changing a Maintenance Notification
Displaying a Maintenance Notification
Creating a Maintenance Order
Changing a Maintenance Order
Displaying a Maintenance Order
Mail and Workflow Functions
Displaying a Mail Inbox
Displaying a Mail Outbox
Displaying a Workflow Inbox
General Functions in the SAP Environment
Displaying a Product Structure
Displaying a Where-Used List for a Material or Doc
Finding Objects via Matchcode
Finding Objects in Classes
Requesting SAP System Parameters
Description of Dialog RFC Function Library cadrfc00
The Dialog RFC Function Library
Header Files and Libraries Required
Header File cadrfc.h
Table Structures
General Functions
Establishing an RFC Connection (Starting from Exte
Terminating an RFC Connection
Initializing Transfer Structures
Querying a Communication Handle
Defining a Communication Handle
Return of Error Messages
Functions for Material Master Records
Creating a Material Master Record
Changing a Material Master Record
Displaying a Material Master Record
Reading a Material Master Record
Functions for Document Management
Creating a Document Info Record
Changing a Document Info Record
Displaying a Document Info Record
Finding a Document Info Record
Inserting a Document Info Record
Reading a Document Info Record
Functions for BOMs
Creating a Material BOM
Changing a Material BOM
Displaying a Material BOM
Filling out the BOM Item Table
Reading the BOM Item Table
Functions for Engineering Change Management
Creating a Change Master Record
Changing a Change Master Record
Displaying a Change Master Record
Functions for Plant Maintenance
Creating an Equipment Master Record
Changing an Equipment Master Record
Displaying an Equipment Master Record
Reading an Equipment Master Record
Creating a Functional Location
Changing a Functional Location
Displaying a Functional Location
Reading a Functional Location
Creating a Maintenance Notification
Changing a Maintenance Notification
Displaying a Maintenance Notification
Creating a Maintenance Order
Changing a Maintenance Order
Displaying a Maintenance Order
Mail and Workflow Functions
Displaying a Mail Inbox
Displaying a Mail Outbox
Displaying a Workflow Inbox
General Functions in the SAP Environment
Displaying a Product Structure
Requesting SAP System Parameters
Displaying a Where-Used List for a Material or Doc
Finding Objects via Matchcode
Return of Last RFC Error Message
Reading an Entry in Table SAP_FIELD_DATA
Reading an Entry in Table DMS_CLASS_DATA
Making an Entry in Table SAP_FIELD_DATA
Making an Entry Table DMS_CLASS_DATA
Finding Objects in Classes
Example of a Call
Using Calls in the SAP-CAD Function Library
Appendix
Error messages in function library caddialg
CPIC Communication Errors and CPIC Error Codes
Return Codes from the SAP System
Return codes of the SAP-CAD function library
Return Codes in the cadrfc00 Library
File sideinfo
File saprfc.ini
File cadrfc.ini
File caddialg.h
File cadrfc.h
File cadtst1.c