FRAMEWORK CODE: On Error Resume Next Dim objapp As Object Dim ObjSEEC As Object

Transcription

1 Here is a piece of the sample Visual Basic code for the framework. Following are the steps mentions to specify about how to use the given sample code. Prerequisite: It is assumed that the action trigger is a button on the basic form. Else, the framework code may be placed appropriately in the action handler of the custom control. In the space between the Private Sub Command1_Click () and End Sub, Please copy / paste, the FRAMEWORK CODE provided below:- FRAMEWORK CODE: On Error Resume Next Dim objapp As Object Dim ObjSEEC As Object Dim Cleanup As Boolean Set objapp = Nothing Set ObjSEEC = Nothing Cleanup = False 'Create the object Set objapp = GetObject(, "SolidEdge.Application") If objapp Is Nothing Then MsgBox ("Could not locate an already running instance of SolidEdge Application, Creating a new instance") End If If Err.Number <> 0 Then Set objapp = CreateObject("SolidEdge.Application") objapp.visible = True Cleanup = True Err.Clear End If Set ObjSEEC = objapp.solidedgetce '############################################### 'Add API Specific Code Here '############################################### If Cleanup = True Then 'kill the instance of Solid Edge created objapp.quit 'Reset the dirty flag Cleanup = False End If 'Reset the object definition Set ObjSEEC = Nothing Set objapp = Nothing Note: Before creating any automation object we authenticate the user depending on the display_alerts flag set on the application. There are two conditions: Case 1 If the display-alert flag is ON then user will see the Auto-Login dialog where he can do AutoLogin or he can directly type in his UserName and password to authenticate him. If the user provides the wrong information then the value of the hr will return as S_FALSE. Case 2 If the value of the flag is OFF, then the authentication of the user is done by silent auto login. (i.e. without showing any Login dialog)

2 1 Sample Code (Required) Since each API has sample code associated with it, the code samples are placed alongside the API details. 1.1 TeamCenter Automation APIs CheckInDocumentsToTeamCenterServer CheckInDocumentsToTeamCenterServer Purpose: For checking in the documents checked out by the user from the TeamCenter server. User can pass multiple files to be Checkin/Upload at a single time. The API also honors the DisplayAlerts flag. If the flag is TRUE then Upload dialog will be shown while uploading and if the flag is FALSE then the dialog will not show. Syntax: Call ObjSEEC.CheckInDocumentsToTeamCenterServer (varinputlist, bonlyupload) varinputlist (Input): The variant array which contains the file list to be Checked in/ Upload. bonlyupload (Input): It is a Boolean flag. It has following possible values: o TRUE In case where it is required to only upload the given file to the Teamcenter database but don t want to check it in. o FALSE In case where it is required to both upload as well as check in. Note: The case in which if the display_alerts flag is off and the CPD dialog is suppressed, then it is the responsibility of the caller to put the item id/item rev correctly into the file storage. He can use the API AssignItemID to assign the item id/item rev. If the document which is going to be uploaded is without item-id in the document number field then the value of the hr will be returned as E_INVALIDARG. Dim varinputlist(1) As Variant varinputlist (0) = "F:\ par" varinputlist (1) = "F:\ par" Dim bonlyupload As Boolean bonlyupload = False Call ObjSEEC.CheckInDocumentsToTeamCenterServer(varInputList, bonlyupload) CheckOutDocumentsFromTeamCenterServer Purpose: Syntax: CheckOutDocumentsFromTeamCenterServer To Download and CheckOut the file from the TeamCenter Server. Call ObjSEEC.CheckOutDocumentsFromTeamCenterServer (FileItemID, FileItemRevID, bonlydownload) FileItemID (Input): Specifies the item-id of the item FileItemRevID(Input): Specifies the item-rev of the item bonlydownload (Input): It is a Boolean flag. It has following possible values:

3 o o TRUE In case where it is required to only download the given item from the Teamcenter database but don t want to check it out. FALSE In case where it is required to both download as well as checkout. Dim FileItemID As String Dim bonlydownload As Boolean FileItemID = "009431" bonlydownload = False Call ObjSEEC.CheckOutDocumentsFromTeamCenterServer(FileItemID, FileItemRevID, bonlydownload) DownloadDocumentsFromServer Purpose: Syntax: DownloadDocumentsFromTeamCenterServer Only to download the file from the TeamCenter Server. Call ObjSEEC.CheckOutDocumentsFromTeamCenterServer (FileItemID, FileItemRevID, bonlydownload) FileItemID (Input): Specifies the item-id of the item FileItemRevID(Input): Specifies the item-rev of the item bonlydownload (Input): It is a Boolean flag. It has following possible values: o o Dim FileItemID As String Dim bonlydownload As Boolean FileItemID = "009431" bonlydownload = True TRUE In case where it is required to only download the given item from the Teamcenter database but don t want to check it out. FALSE In case where it is required to both download as well as checkout. Call ObjSEEC.CheckOutDocumentsFromTeamCenterServer(FileItemID, FileItemRevID, bonlydownload)

4 1.1.4 DoesTeamCenterFileExists DoesTeamCenterFileExists Purpose: This API is used to check the availability of the UID in the TeamCenter database. Syntax: Call ObjSEEC.DoesTeamCenterFileExists(FileItemItemID, FileItemRevID, bisfileexists) Parameters: FileItemItemID (Input): Specifies the item-id of the item FileItemRevID (Input): Specifies the item-rev of the item bisfileexists (Output): It is a Boolean value. It has following possible values. o True If the given UID is present on the teamcenter server. o False - If the given UID is not present on the teamcenter server. Dim FileItemItemID As String Dim bisfileexists As Boolean FileItemItemID = "009431" Call ObjSEEC.DoesTeamCenterFileExists(FileItemItemID, FileItemRevID, bisfileexists) MsgBox (bisfileexists) GetDocumentUID GetDocumentUID Purpose: Returns the UID for the local path. Syntax: Call ObjSEEC.GetDocumentUID(strFileName, FileItemItemID, FileItemRevID) Parameters: strfilename (Input) : Specifies the local cache path of the file FileItemItemID (Output) : It is an output parameter and Specifies the item-id of the item FileItemRevID (Output) : It is an output parameter and Specifies the item-rev of the item Dim strfilename As String Dim FileItemItemID As String strfilename = "F:\ par" Call ObjSEEC.GetDocumentUID(strFileName, FileItemItemID, FileItemRevID) MsgBox (FileItemItemID) MsgBox (FileItemRevID) GetPDMCachePath GetPDMCachePath Purpose: Returns the cache path of an active connection. Syntax: Call ObjSEEC.GetPDMCachePath(bstrCacheFilePath)

5 Parameters: bstrcachefilepath (OutPut): Specifies the Cache path of an active connection Dim bstrcachefilepath As String Call ObjSEEC.GetPDMCachePath(bstrCacheFilePath) MsgBox (bstrcachefilepath) GetTeamCenterMode GetTeamCenterMode Purpose: Returns a Boolean parameter to specify whether the TeamCenter Mode is ON/OFF Syntax: Call ObjSEEC.GetTeamCenterMode(bGetTeamCenterMode) Parameters: bgetteamcentermode (OutPut) :It is an output parameter which has two possible values. o True: When the Team Center Mode is ON. o False: When the Team Center Mode is OFF. Dim bgetteamcentermode As Boolean Call ObjSEEC.GetTeamCenterMode(bGetTeamCenterMode) MsgBox (bgetteamcentermode) IsTeamCenterFileCheckedOut IsTeamCenterFileCheckedOut Purpose: The purpose of this API is to check the checkout status of the given file. Syntax: icheckedout = ObjSEEC.IsTeamCenterFileCheckedOut(FileName) Parameters: FileName(Input): The local cache file path of the file Note: This API returns an integer value icheckedout specifying whether the file is checked out to current user or another user or not checked out to any user. The value of the element icheckedout can be as follows: 0 Not Checked out to any body. 1 Checked out to me (i.e. current User) 2 Checked out to other user. Dim FileName As String

6 Dim icheckedout As Integer FileName = "F:\ par" icheckedout = ObjSEEC.IsTeamCenterFileCheckedOut(FileName) MsgBox (icheckedout) SetTeamCenterMode SetTeamCenterMode Purpose: To toggle the TeamCenter Mode between ON\OFF. Syntax: Call ObjSEEC.SetTeamCenterMode(bMode) Parameters: bmode (Input): It is a boolean flag which is used to specify whether to make the TeamCenter Mode ON\OFF. It has two possible values: o True: Make TeamCenter mode ON. o False: Make TeamCenter mode OFF. Dim bmode As Boolean bmode = True Call ObjSEEC.SetTeamCenterMode(bMode) ValidateLogin ValidateLogin Purpose: This API is used to login into teamcenter. It accepts username/password if it is provided for the login purpose. Please note that from V20 the parameters required for this API have been changed. Following are the two cases for V19 and V20. Case 1. V19: Syntax: Call ObjSEEC.ValidateLogin( UserName, Password, Group) Parameters: UserName (Input): Specifies the UserName of the user to authenticate Password (Input): Specifies the password of the user to authenticate Group (Input): Specifies the group to which the user belongs. The default group is dba Note: The API actually uses the username/password if it is supplied to log in to the teamcenter. The behavior of the authentication process depends on the display_alerts flag. If the display_alerts flag is ON then user will see the Auto-Login dialog (for the login purpose) where he can do AutoLogin or he can directly type in his UserName and password to authenticate him. If the user provides the wrong information then the value of the hr will return as S_FALSE. If the value of the flag is OFF, then Validatelogin () method will use the username/password that is supplied, to login into teamcenter. But this time, no login dialog will be shown and the login will be done silently.

7 Dim UserName As String Dim Password As String Dim Group As String UserName = "mendke" Password = "mendke" Group = "dba" Call ObjSEEC.ValidateLogin(UserName, Password, Group) Case 2. V20: Syntax: Call ObjSEEC.ValidateLogin( UserName, Password, Group, Role, DBURL) Parameters: UserName (Input): Specifies the UserName of the user to authenticate Password (Input): Specifies the password of the user to authenticate Group (Input): Specifies the group to which the user belongs. The default group is dba Role (Input): Specifies the Role of the User in teamcenter. DBURL(Input): Specifies the server name to which the user wants to connect. Note: In V20 also, the behavior of the authentication process depends on the display_alerts flag. If the display_alerts flag is ON then user will see the Login dialog where he can directly type in his username, password, group, userrole and DatabaseUrl to authenticate him. If the user provides the wrong information then the value of the hr will return as S_FALSE. (Note: Please note that in V20 there is no facility of auto login.) If the value of the display_alerts flag is OFF, then Validatelogin () method will use the username, password, group, userrole and DatabaseUrl that is supplied, to login into teamcenter. But this time, no login dialog will be shown and the login will be done silently. Dim UserName As String Dim Password As String Dim Group As String Dim Role As String Dim DBURL As String UserName = "mendke" Password = "mendke" Group = "Engineering" Role = "Designer" DBURL = " Call ObjSEEC.ValidateLogin(UserName, Password, Group, Role, DBURL)

8 AssignItemID AssignItemID Purpose: This API is used to generate the new Item ID and Item Rev (i.e. GUID). Syntax: Call ObjSEEC.AssignItemID(FileItemItemID, FileItemRevID) Parameters: FileItemItemID (Output): Returns the newly created Item Id. FileItemRevID (Output): Returns the newly created Item Rev. Dim FileItemItemID As String 'Initialise the variables FileItemItemID = "" FileItemRevID = "" Call ObjSEEC.AssignItemID(FileItemItemID, FileItemRevID) MsgBox(FileItemItemID) MsgBox(FileItemRevID) UndoCheckOutDocumentsFromServer OnUndoCheckOutDocuments Purpose: To undo the check-out operation for specific files on the TeamCenter server. Syntax: Call ObjSEEC. OnUndoCheckOutDocuments (varinputlist) varinputlist (Input): The variant array which contains the file list to be UndoCheckOut. Dim varinputlist(1) As Variant varinputlist (0) = "F:\ asm" varinputlist (1) = "F:\ asm" Call ObjSEEC. OnUndoCheckOutDocuments (varinputlist) SynchronizeDocumentsInCache API Name Purpose Syntax : OnSynchronizeFile : To synchronize a list of out of date documents in local cache with server. : ObjSEEC.OnSynchronizeFile (varinputlist) Parameters varinputlist (Input): The variant array which contains the file list to be Synchronize.

9 Dim varinputlist(1) As Variant varinputlist (0) = "F:\ asm" varinputlist (1) = "F:\ asm" Call ObjSEEC.OnSynchronizeFile (varinputlist) Note: The same API can be called for SynchronizeAllDocumentsInCache DeleteFilesFromCache API Name Purpose Syntax : DeleteFilesFromCache : To delete the files present in cache. : ObjSEEC.DeleteFilesFromCache (psacachefiles) Parameters PsaCacheFiles (Input): The variant array which contains the file list to be Deleted from Cache. Dim psacachefiles (1) As Variant varinputlist (0) = "F:\ par" varinputlist (1) = "F:\ asm" Call ObjSEEC.DeleteFilesFromCache(psaCacheFiles) ImportDocumentsToServer API Name : ImportDocumentsToServer Purpose : To Import the unmanaged document to TeamCenter Server. Syntax :CallObjSEEC.ImportDocumentsToServer( NumberOfDocumentsFoldersToImport, ListOfDocumentsFoldersToImport, UserName, Password, Group, Role, DBURL) Parameters NumberOfDocumentsFoldersToImport (Input): The number of files and folders to be imported. ListOfDocumentsFoldersToImport(input) : Name of the folder of a file to be imported.

10 UserName (Input): Specifies the UserName of the user to authenticate. Password (Input): Specifies the password of the user to authenticate Group (Input): Specifies the group to which the user belongs. The default group is dba Role (Input): Specifies the Role of the User in teamcenter. DBURL(Input): Specifies the server name to which the user wants to connect. Dim NumberOfDocumentsFoldersToImport As Long Dim ListOfDocumentsFoldersToImport(0) As Variant Dim UserName As String Dim Password As String Dim Group As String Dim Role As String Dim DBURL As String NumberOfDocumentsFoldersToImport = 1 ListOfDocumentsFoldersToImport(0) = "D:\import" UserName = "shedage" Password = "shedage" Group = "Engineering" Role = "Designer" DBURL = Call ObjSEEC.ImportDocumentsToServer(NumberOfDocumentsFoldersToImport, ListOfDocumentsFoldersToImport, UserName, Password, Group, Role, DBURL) GetOutOfDateDocuments API Name Purpose Syntax : GetOutOfDateDocuments : To get out of Date Documents in cache. : ObjSEEC.GetOutOfDateDocuments (plistoffiles) Parameters plistoffiles (output): Returns the list of out of date documents from cache.

11 Dim plistoffiles As Variant ObjSEEC.GetOutOfDateDocuments (plistoffiles) GetUserLogMessages API Name Purpose Syntax : GetUserLogMessages : Get the user log messages generated during a session. : ObjSEEC.GetOutOfDateDocuments (pusermessages) Parameters pusermessages (output): Returns the user log messages generated during a session Dim pusermessages As Variant Call ObjSEEC.GetUserLogMessages(pusermessages) SaveASToTeamCenterServer Purpose: Syntax: SaveAsToTeamCenter Saves the document to the team center server with new properties. Call ObjSEEC.SaveAsToTeamCenter(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FolderName) FileItemID (Input): Specifies the item-id of the item FileItemRevID(Input): Specifies the item-rev of the item FileDataSetName (Input): DataSetName of the file FileRevisionRule(input): Revision Rule of the file. FolderName(input): name of the folder where the new file supposed to save. Note: - Last 2 parameters are optional

12 Dim FileItemID As String Dim FileDataSetName As String Dim FileRevisionRule As String Dim FolderName As String FileItemID = "020670" FileDataSetName = " par" FileRevisionRule = "" FolderName = "" Call ObjSEEC.SaveAsToTeamCenter(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FolderName) ReviseToTeamCenterServer Purpose: Syntax: ReviseToTeamCenter Saves the document to the team center server with new properties. Call ObjSEEC.ReviseToTeamCenter(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FolderName) FileItemID (Input): Specifies the item-id of the item FileItemRevID(Input): Specifies the item-rev of the item FileDataSetName (Input): DataSetName of the file FileRevisionRule(input): Revision Rule of the file. FolderName(input): name of the folder where the new file supposed to save. Note:- Last 2 parameters are optional Dim FileItemID As String Dim FileDataSetName As String Dim FileRevisionRule As String Dim FolderName As String FileItemID = "020670" FileDataSetName = " par" FileRevisionRule = "" FolderName = "" Call ObjSEEC.SToTeamCenter(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FolderName)

13 OnGetWhereUsedForAutomation Purpose: Syntax: OnGetWhereUsedForAutomation Gives the list of documents for whereused. Call ObjSEEC. OnGetWhereUsedForAutomation (FileItemID, FileItemRevID, FileDataSetName, listoffiles) FileItemID (Input): Specifies the item-id of the item FileItemRevID(Input): Specifies the item-rev of the item FileDataSetName (Input): DataSetName of the file Listoffiles(output): Returns the list of whereused results. Dim FileItemID As String Dim FileDataSetName As String Dim listoffiles As Variant FileItemID = "020670" FileDataSetName = " par" Call ObjSEEC. OnGetWhereUsedForAutomation (FileItemID, FileItemRevID, FileDataSetName, listoffiles) CreateNewProject CreateNewProject Purpose: Creates new project with the name given by the user. Syntax: Call ObjSEEC.CreateNewProject(ProjectName) ProjectName (Input): Specifies the Name of the new project which user wants to create. Dim ProjectName As String ProjectName = "TEST" Call ObjSEEC.CreateNewProject(FileItemID)

14 DeleteProject DeleteProject Purpose: This function will delete a project given by the user. Syntax: Call ObjSEEC.CreateNewProject(ProjectName) ProjectName (Input): Specifies the Name of the project which user wants to Delete. Dim ProjectName As String ProjectName = "TEST" Call ObjSEEC.DeleteProject(ProjectName) DeleteAllProjects DeleteAllProjects Purpose: This function will delete all projects created by user and after it creates a default project. Syntax: Call ObjSEEC.CreateNewProject() Call ObjSEEC.DeleteAllProjects() DownladDocumentsFromServerWithOptions Purpose: Syntax: DownladDocumentsFromServerWithOptions This function will download the document with options provided by user. ObjSEEC.DownladDocumentsFromServerWithOptions(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FileVariantRule, vbreadonly, vballlevel) FileItemID (Input): Specifies the Item Id of the file which user wants to download. FileItemRevID (Input): Specifies the Revision of the file to be downloaded. FileDataSetName (Input): Specifies the Data set name of the file which is to be downloaded. FileRevisionRule (Input): Revision rule of the file. FileVariantRule (Input): Variant rule of the file. vbreadonly (Input): It is a Boolean flag. It has following possible values: o o TRUE In case where it is required to only download the given item from the Teamcenter database but don t want to check it out. FALSE In case where it is required to both download as well as checkout.

15 vballleveli(input) It is the Boolean flag. Which will decide the download level of the file o TRUE - This is going to download the files for one level. o FALSE- Going to download the files for ALL levels. Dim FileItemID As String Dim FileDataSetName As String Dim FileRevisionRule As String Dim FileVariantRule As String Dim vbreadonly As Boolean Dim vballlevel As Boolean FileItemID = "020147" FileDataSetName = " par" FileRevisionRule = "latest working" FileVariantRule = "" vbreadonly = True vballlevel = False ObjSEEC.DownladDocumentsFromServerWithOptions(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FileVariantRule, vbreadonly, vballlevel) GetListOfIndirectFilesForGivenFile Purpose: Syntax: GetListOfIndirectFilesForGivenFile This function will Return the list of indirect file names for the given file. Call ObjSEEC.GetListOfIndirectFilesForGivenFile(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FileVariantRule, listoffiles) FileItemID (Input): Specifies the Item Id of the file which user wants to download. FileItemRevID (Input): Specifies the Revision of the file to be downloaded. FileDataSetName (Input): Specifies the Data set name of the file which is to be downloaded. FileRevisionRule (Input): Revision rule of the file. FileVariantRule (Input): Variant rule of the file. listoffiles (output): Returns the names of the indirect file names.

16 Dim FileItemID As String Dim FileDataSetName As String Dim FileRevisionRule As String Dim FileVariantRule As String FileItemID = "020147" FileDataSetName = " par" FileRevisionRule = "latest working" FileVariantRule = "" Call ObjSEEC.GetListOfIndirectFilesForGivenFile(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FileVariantRule, listoffiles) GetMappedPropertiesForGivenFile Purpose: Syntax: GetListOfIndirectFilesForGivenFile This function will Return the list of indirect file names for the given file. Call ObjSEEC.GetListOfIndirectFilesForGivenFile(FileItemID, FileItemRevID, FileDataSetName, FileRevisionRule, FileVariantRule, listoffiles) FileItemID (Input): Specifies the Item Id of the file which user wants to download. FileItemRevID (Input): Specifies the Revision of the file to be downloaded. FileDataSetName (Input): Specifies the Data set name of the file which is to be downloaded. listoffiles (output): Returns the mapped property name and values of the given file. Dim FileItemID As String Dim FileDataSetName As String Dim listoffiles As Variant FileItemID = "022456" FileDataSetName = " par" Call ObjSEEC.GetMappedPropertiesForGivenFile(FileItemID, FileItemRevID, FileDataSetName, listoffiles) InitializeNewFileDataManager. InitializeNewFileDataManager Purpose: This function will initialize the new file data manager. Initialization of New File Data Manager is required before saving or doing Save-As of any file to Teamcenter using generic automation APIs for Save or SaveAs.

17 Syntax: objseec.initializenewfiledatamanager(itemid_beforesaveas, Rev_BeforeSaveAs, strnewfilename, True, PropInfo, OldNewITemIDRevFileName) ItemID_BeforeSaveAs (Input): Specifies the Item Id of the file which user wants to SaveAs.(It is not required if user wants to do save) Rev_BeforeSaveAs (Input): Specifies the Revision of the file for which user wants to SaveAs..(It is not required if user wants to do save) strnewfilename (Input): Specifies the new file name of the file for which user wants to do Save As or save. Bool BIsCalledForSaveAs(input) For SaveAs true, For New File Save False. PropInfo (input): Object array of properties to be given for new file. OldNewITemIDRevFileName (output):this will be out in case of SaveAs only.object array of Old and new data of file such as ItemID,Rev and FileName. Dim OldNewITemIDRevFileName(,) As Object = Nothing Dim PropInfo(3, 2) As Object PropInfo(0, 0) = "Item ID" Property Display Name PropInfo(0, 1) = "Document Number" Property Internal Name PropInfo(0, 2) = strnewitemid PropInfo(1, 0) = "Revision" PropInfo(1, 1) = "Revision" PropInfo(1, 2) = strnewrev PropInfo(2, 0) = "Item Name" PropInfo(2, 1) = "Project Name" PropInfo(2, 2) = strnewitemid PropInfo(3, 0) = "Dataset Name" PropInfo(3, 1) = "Dataset Name" PropInfo(3, 2) = strnewitemid + "/" + strnewrev objseec.initializenewfiledatamanager(itemid_beforesaveas, Rev_BeforeSaveAs, strnewfilename, True, PropInfo, OldNewITemIDRevFileName)