CAD Integration API for Integrating to 3rd party CAD and PDM Systems

This document describes about Integration API provided for development of different CAD integration between CAD tools and IFS Applications. Different CAD Adaptors can communicates with IFS using Activity API’s in the middle tier.

When to use this information:

Use this page when CAD adapters are developed using IFS CAD integration API.

Contents

Method list

Activity Method name Description
BrowseCadIntegrationLicense GetLicenseInfo Customers will typically purchase CAD Adaptor licenses (from third party vendor) for only a subset of IFS Applications users. This API was introduced to validate the CAD adapter vendor license key when a user logs into IFS though the CAD Adaptor. Not all users should be able to update the license key.
ManageCadIntegration QueryEcoOrder Queries Change Order records.
QueryEngPartDevelopLevel Queries Engineering Part Develop Level records
QueryEngineeringPartClass Queries Engineering Part Class records
ManageCadIntegrationLicense UpdateLicenseKey Customers will typically purchase CAD Adaptor licenses (from third party vendor)for only a subset of IFS Applications users. This API was introduced to save the vendor License key into the IFS Database. Not all users should be able to update the license key.
ManageEngineeringPart AddEngineeringPartAndCharacteristic Provide a single Activity API that creates a new engineering, but also accepts a technical class as input. The engineering part will not be created in case given technical class does not exist.
BulkAddEngineeringPartAndCharacteristic This is the Bulk version of ManageEngineeringPart.AddEngineeringPartAndCharacteristic
CheckExistEngineeringPart Check if Engineering Part exists
SaveEngineeringPart Add or Modify Engineering Part.(Cannot Delete)
GetEngineeringPart Returns Engineering Part by keys
ManageEngineeringPartMaster BulkExistEngineeringPartMaster Given a set of part numbers, return a set of Booleans, indicating the existence of corresponding engineering part masters.
ExistEngineeringPartMaster Given a part number, return a Boolean, indicating the existence of corresponding engineering part masters.
QueryCadEngineeringPartMaster Queries Engineering Part Master records.
SaveCadEngineeringPartMaster Add Modify or Delete Engineering Part Master records.
ManageEngineeringPartRevision AddEngineeringPartRevision Add Engineering Part revision. (PLSQL Method: CAD_INTEGRATION_UTIL_API.PART_REVISION_ADD)
QueryCadEngPartRevision Queries Engineering Part Revision Records (PDM Con/Parts/Engineering Part Revisions), Engineering Part Info (Engineering Part Tab) and Development Level Info. Only the query condition values given for attributes in the top level view (ENG_PART_REVISION) are considered
PartSearchAttributes Queries Engineering Part Revision Records (PDM Con/Parts/Engineering Part Revisions), Engineering Part Info (Engineering Part Tab) and Development Level Info. A query condition value given for attributes in the top level view (ENG_PART_REVISION) and aggregate views (ENG_PART_DEVELOP_LEVEL_BASE, ENG_PART_MASTER_BASE) are considered.
ReleaseEngineeringPart Sets an Engineering Part Revision’s status to Release
SaveEngineeringPartRevision Add, Modify or delete Engineering Part revision Records (PDM - Configuration /Parts/Engineering Part Revisions), Engineering Part Info (Engineering Part Tab) and Development Level Info.
SetActiveEngineeringPart Sets an Engineering Part Revision’s status to Active.
SetToObsoleteEngineeringPart Sets an Engineering Part Revision’s status to Obsolete
ManageEngineeringPartRevisionJournal QueryEngineeringPartRevisionJournal Queries Engineering Part Revision Journal records
SaveEngineeringPartRevisionJournal Add, Modify or Delete Engineering Part Revision Journal
SetDevelopmentLevel Set Development Level. (PLSQL Method: ENG_PART_REVISION_API.SET_DEVELOP_LEVEL__)
ManageEngineeringPartRevisionManuPart QueryEngPartRevManuf Queries Engineering Part Manufacturer information
QueryPartManuPartRev Queries Part Revisions per Manufacturer Part Number
SavePartManuPartRev Creates or updates Part Revisions per Manufacturer Part Number
ManageEngineeringPartStructure AddModifyEngineeringPartSubPartConnnetion This Activity API creates a non-existent part-part connection or updates the existing connection in Engineering Part Structure records. The return Action Type (ADDED or MODIFIED) can be used to find out what happened in IFS.
 
CheckExistEngineeringPartSubPartConnnetion Check if part-part connection exists
QueryEngineeringPartStructure Queries Engineering Part Structure
QueryEngineeringPartSubPartConnnetion Queries Engineering Part Structure Following CONNECT BY PRIOR relationship with part and part revision
 
SaveEngineeringPartSubPartConnnetion Add or Modify Engineering Part Structure (Cannot Delete)
ManagePartCharacteristics ChangeStatusPartCharacteristic Change Part Characteristic Status. (PLSQL Method: Part_Characteristics_UTIL_API. Change_Part_Char_Status)
CheckExistPartCharacteristic Check if Part Characteristic exists. (PLSQL Method: Part_Characteristics_UTIL_API.Check_Exist_Part_Char)
 
GetPartCharacteristic Return Part Characteristic record by key. (PLSQL Method: PART_CHARACTERISTICS_UTIL_API.Get_Part_Characteristic)
 
SavePartCharacteristics Add, Modify or Delete Part Characteristic
     
ManageCadApprovalRouting BulkSaveCadApprovalRouting A single API function that can create several approval steps under the same document revision in "bulk"
QueryCadApprovalRouting Queries Approval Routing on documents. It retrieves the data that is displayed in IFS Applications in form: Document Management/Document Info/Approval Tab. This API includes an aggregate record PERSON_INFO that has fields Person ID, Person Name and User ID.
SaveCadApprovalRouting Add, Modify or Delete approval steps under the same document revision.
ManageCadDocumentFileData GetDocumentFileData Return Document File Data by keys.
QueryDocumentFileData Queries Document File Data
SaveCadDocumentFileData Add or Modify Metadata related to CAD Drawings
ManageCadDocumentTitle BulkCreateNewDocument This Activity API is the Bulk version of CreateNewDocument Activity API
BulkExistDocumentNo Given a set of document numbers, return a set of Booleans, indicating the existence of corresponding document titles
CreateNewDocument This Activity API creates a new document and its initial revision, and sets the initial value of its ApprovalUpdate flag. The actual Document Class, Document Number, Revision, and Document Sheet of the newly created document revision will be returned. The Document Class and Document Title are mandatory inputs
ExistDocumentTitle Check if Document Title exists
ManageDocCadIntegration QueryDocumentFileReference Queries Document File References. The date fields CheckedInDate, CheckedOutDate in this API will return the date-time in UTC. Note that this Activity API return the same records that are returned by Activity API ManageDocumentFileReference.QueryDocumentFileReference, but it returns the CheckedInDate, CheckedOutDate in UTC instead of a time stamp based on the local time zone on the server
QueryDocumentGroup Queries Document Group Members. It retrieves the data is displayed in IFS Applications in form: Document Management/Basic Data/Document Basic /Person Group Tab (Header section)
QueryDocumentGroupMembers Queries Document Group Members. It retrieves the data is displayed in IFS Applications in form: Document Management/Basic Data/Document Basic /Person Group Tab (detail section)
QueryPartDoc Query attributes related Engineering Part and Document in the same record. This API was introduced a support a query window in the CAD Adaptor that is used to query a CAD Object using both part and document attributes
ManageDocObjectConnection AddOrModifyDocConnection This Activity API guarantees a particular connection will be in IFS no matter what existed in the IFS before and update its relative path if necessary
BulkAddOrModifyDocConnection This Activity API is the Bulk version of the AddOrModifyDocConnection Activity API
QueryDocumentObjectConnection Query Document Object Connection, Document Revision, Document Title, Document Class
SaveDocEngPartConnection Add or Remove Connection between Document and Engineering Part. (Cannot Modify)
ManageDocumentIssue BulkDocHasExactlyOneRevision This Activity API is the Bulk version of the DocHasExactlyOneRevision Activity API
DocHasExactlyOneRevision This Activity API returns a TRUE when given document class and document number has exactly one revision, or FALSE if it has >1 revisions. Returns ZERO when document class and number have no revisions
GetDocIssue Return Document Issue records by keys.
QueryDocIssue Queries Document Issues
ManageDocumentStatus BulkGetDocumentStatus This Activity API is the Bulk version of the GetDocumentStatus Activity API
  GetDocumentStatus This Activity API receives a document class, document number, document sheet and document revision and returns the following information:
  • Whether document title identified by class and number exists. If it does, return the actual title.
  • Whether document revision identified by document sheet and document revision exists.
  •  Approval status of the document revision. This is equivalent to the DocumentRevision.State returned from EditDocument.GetDocumentRevision. This could be NULL if a document revision is not found.
  • User ID of the user checked out the document
  • User ID of the user checked in the document
  • Document Revision Status (possible values: Checked In/Checked Out/NoFile)
     
ApproveAndRejectApprovalStep ApproveStep Calls PLSQL Method: APPROVAL_ROUTING_API.SET_NEXT_APP_STEP
ApproveDocument Approve Approves Document Structure.
StartApproval Start Call PLSQL Method: DOC_ISSUE_API.PROMOTE_TO_APP_IN_PROGRESS__
ManageApprovalRouting QueryApprovalRouting Queries Approval Routing on documents. It retrieves the data that is displayed in IFS Applications in form: Document Management/Document Info/Approval Tab
SaveApprovalRouting Add, Modify or Delete approval steps under the same document revision
CreateNewDocument CreateDocument Creates new Document
ListDocumentClass Queries Document Classes
ObsoleteDocument PromoteToObsolete Calls PLSQL Method: DOC_ISSUE_API.PROMOTE_TO_OBSOLETE__
ReviseDocument CreateNewRevision Creates new Document Revision
DeleteDocument Delete Calls PLSQL Method: DOC_ISSUE_API.DELETE_DOCUMENT_ISSUE_
DeleteDocumentFile DeleteFiles Delete Document File
ViewDocumentFileType QueryDocumentFileType Queries Document File Types
SearchDocument SearchByAttributes Searches Document Title records based on values of Attributes
SearchByContents Searches Document Title records based on Document Content
SearchByObjectConnections Searches Document Title records based on Object Connections
QueryDocumentSearchResult Queries the view DOC_ISSUE_SEARCH_RESULT
ManageDocumentRevision GetDocumentRevision Return Document Revision record by keys
QueryDocumentRevision Queries Document Revisions
SaveDocumentRevision Add, Modify or Remove Document Revision
ManageDocumentFileReference QueryDocumentFileReference Queries Document File References
ManageDocumentObjectConnection QueryDocumentObjectConnection Queries Document Object Connections
SaveDocumentObjectConnection Add, Modify or Remove Document Object Connections
ManageDocumentTitle QueryDocumentTitle Queries Document Titles
GetDocumentTitle Return Document Title record by keys
SaveDocumentTitle Add, Modify or Remove Document Title
ManageSubDocument GetSubDocument Return Sub Document record by keys. (View DOC_STRUCTURE)
QuerySubDocument Queries Sub Documents
SaveSubDocument Add, Modify or Remove Sub Document
     
ManageTechnicalObjectReference ListTechnicalClassDetail Queries Technical Classes
ListISOUnit Queries ISO Units
ManageMobileTechnicalObjectReference QueryTechnicalAttribNumeric Queries Technical Attrib Numeric
     
ManageManufacturerInfo SaveManufacturerInfo Add, Modify or Delete Part Manufacturer
PrepareAndSaveManufacturerInfo Call PrepareManufacturerInfo and then SaveManufacturerInfo
PrepareManufacturerInfo Get Default values For a Part Manufacturer record
QueryManufacturerInfo Queries Part Manufacturer
PersonLov QueryPersonInfo Queries Person Info.
     
ManageStandardNames QueryStandardNames Queries Standard Names
ManagePartManufacturer QueryPartManufacturer Queries Part Manufacturer
SavePartManufacturer Add, Modify or Delete Part Manufacturer
SetPreferred Sets the Manufacturer as the preferred one
ManagePartManuPartNo QueryPartManuPartNo Queries Manufacturer Part Number
SavePartManuPartNo Add, Modify or Delete Manufacturer Part Number
SetPreferred Sets a manufacturer’s part no as the preferred one
ManageEngPartMainGroup QueryEngPartMainGroup Queries Engineering Part Main Groups
     
ClientApplication IdentifyCurrentUser Identify Current User.