Eplan Platform API
EPLAN API / API Reference / Actions / partsmanagementapi
In This Topic
    partsmanagementapi
    In This Topic
    Action class for exporting and importing parts and other parts management items like parts, addresses, constructions, terminals, accessory lists and accessory placements.
    

    Parameter Description

    TYPE

    Type of task to be performed:
    IMPORT: Import parts lists
    EXPORT: Export parts lists
    EXPORTPARTS: Exports parts list with the given number of properties
    EXPORTMANUFACTURERS: Exports manufacturers list with the given number of properties
    EXPORTCONSTRUCTIONS: Exports construction list with the given number of properties
    EXPORTCONNECTIONPATTERNS: Exports connection point pattern list with the given number of properties
    EXPORTACCESSORYLISTS: Exports accessory list with the given number of properties
    EXPORTACCESSORYPLACEMENTS: Exports accessory placements list with the given number of properties
    

    IMPORTFILE

    The directory and the file name of the file to be imported must be specified here. This only applies to IMPORT.
    

    EXPORTFILE

    The directory and the file name of the file to be exported must be specified here. The file extension is automatically added by the system. This only applies to EXPORT.
    

    FORMAT

    Optional: File format ("XPamImportXml","XPamExportXml", or user-defined format). IXPartsImportExportEdz - export to .edz and import from .edz.
    XPamExportXml is the default format value for tasks of 'TYPE': EXPORT.
    XPamImportXml is the default format value for tasks of 'TYPE': IMPORT.
    

    PARTNUMBER

    Optional: Used for exporting parts. Part number of article. 
    

    MANUFACTURER

    Optional: Used for exporting addresses. Long name of an address.
    

    CONSTRUCTION

    Optional: Used for exporting constructions. Name of construction.
    

    CONNECTIONPOINTPATTERN

    Optional: Used for exporting terminals. Name of terminal.
    

    ACCESSORYLIST

    Optional: Used for exporting accessory lists. Name of accessorylist. 
    

    ACCESSORYPLACEMENT

    Optional: Used for exporting accessory placements. Name of accessoryplacement.
    

    MODE

    Optional: Used for Importing: Import mode.
    Supported modes are:
    0: append new records only
    1: update existing records only
    2: update existing records and append new ones
    Default value= 0, append new records only. If an invalid value is set, the default value 0 will be used.
    

    ADDITIONAL_LANGUAGE

    Optional.Valid only when TYPE has 'IMPORT' value.
    If the value of this parameter is 1, multi-language properties will be updated with another language values rather than being replaced with the file's content.
    If the parameter is omitted, content of the file replaces values of multi-language properties.
    

    FILTERSCHEME

    Configuration scheme for export parts. 
    Default value is empty. Using scheme allows to filter and export parts.
    

    PROPERTYIDn

    Article property number. Where n in PROPERTYIDn is a number corresponding to n number in PROPERTYVALUEn.
    

    PROPERTYVALUEn

    Value for given article property number. Where n in PROPERTYVALUEn is a number corresponding to n number in PROPERTYIDn.
    

    Remarks
    In order to export more than item, please use parameter item type + counter with following number of exported item (for example /PARTNUMBER1:A-B.100-C09EJ01 /PARTNUMBER2:A-B.140M-C-AFA11, etc)
    

    Example
    partsmanagementapi /TYPE:EXPORT /EXPORTFILE:C:\temp\PartsList.xml /PARTNUMBER:A-B.100-C09EJ01 /MANUFACTURER:LAPP /CONSTRUCTION:A-B.100-C_FS0_I_CH_DP
    
    partsmanagementapi /TYPE:EXPORT /EXPORTFILE:C:\temp\PartsList.xml /PARTNUMBER1:A-B.100-C09EJ01 /PARTNUMBER2:A-B.140M-C-AFA11 /MANUFACTURER1:LAPP /MANUFACTURER2:Rittal
    
    partsmanagementapi /TYPE:EXPORT /FORMAT:IXPartsImportExportEdz /EXPORTFILE:C:\temp\PartsList.edz /PARTNUMBER1:*
    
    partsmanagementapi /TYPE:IMPORT /MODE:1 /IMPORTFILE:C:\temp\PartsList.xml
    
    partsmanagementapi /TYPE:IMPORT /FORMAT:IXPartsImportExportEdz /IMPORTFILE:C:\temp\PartsList.edz
    
    partsmanagementapi /TYPE:IMPORT /MODE:0 /FORMAT:IXPartsImportExportEdz /IMPORTFILE:C:\temp\PartsList.edz
    
    partsmanagementapi /TYPE:EXPORT /FILTERSCHEME:ExportFilterScheme /EXPORTFILE:C:\temp\PartsList.xml
    
    partsmanagementapi /TYPE:EXPORTPARTS /PROPERTYID1:22024 /PROPERTYVALUE1:2 /PROPERTYID2:22007 /PROPERTYVALUE2:ABB /EXPORTFILE:C:\temp\PartsList
    
    partsmanagementapi /TYPE:EXPORTCONSTRUCTIONS /PROPERTYID1:22931 /PROPERTYVALUE1:FES.130642 /PROPERTYID2:22931 /PROPERTYVALUE2:RIT.SV9677x65 /EXPORTFILE:C:\temp\ConstructionsList
    
    partsmanagementapi /TYPE:EXPORTMANUFACTURERS /FORMAT:IXPartsImportExportEdz /PROPERTYID1:22900 /PROPERTYVALUE1:PXC /EXPORTFILE:C:\temp\Manufactures