CheckInDocumentsToTeamCenterServerEx Method

This is a two dimensional array. Each row contains data per document. Each column will contain input information. For a document to be uploaded and checked in:

First column represents cache filename to be uploaded and checked in. (in) This is mandatory.
Second column represents container wise properties to support field set. (in) This is mandatory. Caller should set to nothing if they do not want to send any value.
Third column represents the Project IDs in which the given item is to be added. These project Ids will be separated by semi comma.
Fourth column represents the Project IDs from which the given item is to be removed. These project Ids will be separated by semi comma.

Third and fourth columns are added in order to add the items to projects while doing checking of item in order to not break the existing APIs we make these parameters optional.

Third and fourth columns are added in order to add the items to projects while doing check-in of item in order to not break the existing APIs we make these parameters optional.

Description

CheckIn the Documents to the Server

Syntax

Visual Basic
Public Sub CheckInDocumentsToTeamCenterServerEx( _ ByRef pvarFilesToBeCheckedInInfo As Variant, _ ByRef pvarArguments As Variant _ )

Parameters

pvarFilesToBeCheckedInInfo

This is a two dimensional array. Each row contains data per document. Each column will contain input information. For a document to be uploaded and checked in:

First column represents cache filename to be uploaded and checked in. (in) This is mandatory.
Second column represents container wise properties to support field set. (in) This is mandatory. Caller should set to nothing if they do not want to send any value.
Third column represents the Project IDs in which the given item is to be added. These project Ids will be separated by semi comma.
Fourth column represents the Project IDs from which the given item is to be removed. These project Ids will be separated by semi comma.

Third and fourth columns are added in order to add the items to projects while doing checking of item in order to not break the existing APIs we make these parameters optional.

Third and fourth columns are added in order to add the items to projects while doing check-in of item in order to not break the existing APIs we make these parameters optional.

pvarArguments

This is an one dimensional array for sending arguments. The first element should contain Boolean flag to tell whether only upload files and not checked in. This is second argument passed to CheckInDocumentsToTeamCenterServer API. In future, more arguments can be supported.

Remarks

This API is similar to CheckInDocumentsToTeamCenterServer but with additional provision of inputs as per need. If user wants support for field sets, then, they need to send container wise properties in XML sting returned by GetSmartCodes API.

Example

Example (Visual Basic)

Option Explicit

Sub Example()
    Dim objApplication As SolidEdgeFramework.Application
    Dim objTCE As SolidEdgeFramework.SolidEdgeTCE
    Dim SmartCodesInfo(1, 5) As Object
    Dim FilesToBeCheckedInInfo(1, 1) As Object
    Dim bUpload As Boolean
    Dim ObjArgs(0) As Object
    
    Set objApplication = GetObject(, "SolidEdge.Application")
    Set objTCE = objApplication.SolidEdgeTCE

    SmartCodesInfo(0, 0) = "Assign1"    'Input - Unique ID
    SmartCodesInfo(0, 1) = "Item"       'Input - Item Type
    SmartCodesInfo(0, 2) = Nothing      'Output ? Smart Code Number
    SmartCodesInfo(0, 3) = Nothing      'Output - Revision
    SmartCodesInfo(0, 4) = Nothing      'Output ? Container wise props in XML string
    SmartCodesInfo(0, 5) = Nothing      'Output ? Unget info in XML string

    SmartCodesInfo(1, 0) = "Assign2"    'Unique ID
    SmartCodesInfo(1, 1) = "Item"       'Item Type
    SmartCodesInfo(1, 2) = Nothing
    SmartCodesInfo(1, 3) = Nothing
    SmartCodesInfo(1, 4) = Nothing
    SmartCodesInfo(1, 5) = Nothing

    Call objTCE.GetSmartCodes(SmartCodesInfo)
    
    'Example takes two documents to be checked in To Teamcenter. Caller should fill two
    'dimensional array with two rows and two columns as filename and container wise props
    'for smart code field set support.
    FilesToBeCheckedInInfo(0, 0) = "D:\300120.par" 'Cache Path
    FilesToBeCheckedInInfo(0, 1) = SmartCodesInfo(0, 4)
    FilesToBeCheckedInInfo(1, 0) = "D:\400120.par" 'Cache Path
    FilesToBeCheckedInInfo(1, 1) = SmartCodesInfo(1, 4)
    
    'Set Boolean upload flag
    bUpload = False
    
    'Fill array with first element with Upload flag.
    ObjArgs(0) = bUpload
    
    Call objTCE.CheckInDocumentsToTeamCenterServerEx(FilesToBeCheckedInInfo, ObjArgs)

    If Not objApplication Is Nothing Then
        Call objApplication.Quit
    End If
    
    Set objTCE = Nothing
    Set objApplication = Nothing
End Sub