PDM/PLM (SmarTeam) 二次開發 - Lesson Five - 進階功能 - 建立專案時預建資料夾

在 SmarTeam 中所有物件的使用是非常彈性的，意思是端看使用者想怎麼增刪改，就決定其呈現的樣貌，這樣容易造成不同專案內所建立的文件或分類結果迥異，導致搜尋及閱讀上的困難

然而幾乎所有公司對專案所需的文件都會有一定的定義及分類，故在新增專案時若能自動建立對應的資料夾來管理分類，不僅可以節省 SmarTeam 使用者的時間，同時也能達到標準化。

例如 ##CONTINUE##

所以在使用建立專案時同時也在文件樹建立幾個預設資料夾的功能幾乎是 SmarTeam 的標準二次開發要求

那為何 SmarTeam 不把他列入標準功能呢？因為每間公司的分類結構不同，所以也無法寫成標準功能，所以就需要二次開發

P.S. 其實上面的畫面是由在使用 R19 + SDE 後就有的功能，但 SDE 產生那五個資料夾是固定無法更改的，所以還是要自己寫

以下就來介紹如何如何開發此功能，包含有階層的資料夾結構，同時在新增資料夾時 SmarTeam 不會一直問你是否要當專案子階

1. 首先當然一樣是建立一個 Script 檔，跟之前都一樣，所以只列重要的 function name
   Function CreateProjectFoldersTest(ApplHndl As Long,OpStr As String,FirstPar As Long,SecondPar As Long,ThirdPar As Long) As Integer
   　...略...
   
   　Set MyDll = CreateObject("MirdcPDMTool.Tools")
   　sRet = MyDll.CreateProjectFoldersTest(SmSession, SmOp, RecListIn1, RecListIn2, RecListOut)
   
   　...略...
   End Function
   
   
2. 在新增專案後加上 Hook
   
   
   
   
   
3. 在 Visual Studio 新增 CreateProjectFoldersTest 方法
   之前有說過要建立具階層型的資料夾，第一層資料夾是與專案連結並新增於桌面(Desktop)，第二層資料夾則是當成第一層的子階，兩種的 link 是不同的，故再寫兩個 function 來新增這兩種 link，分別是 CreateProjectSubfolderTest() 與 CreateSubfolderTest()
   
   Function CreateProjectFoldersTest(ByVal SmSession As SmApplic.SmSession, ByVal Operation As SmApplic.ISmOperation, ByVal FirstPar As SmRecList.SmRecordList, ByVal SecondPar As SmRecList.SmRecordList, ByVal ThirdPar As SmRecList.SmRecordList) As String
   
   　Dim Project As ISmObject
   　Dim smObject As ISmObject
   　Dim sRetObjectID As String
   
   　Project = SmSession.ObjectStore.ObjectFromData(FirstPar.GetRecord(0), False)
   
   　Dim retObject As ISmObject
   　Dim tmpObject As ISmObject
   　Dim sProjectID As String = Project.Value("TDMX_ID").ToString()
   
   　'如果是第一層就呼叫CreateProjectSubfolderTest()
   　retObject = CreateProjectSubfolderTest(SmSession, "My Folder 1", Project)
   　tmpObject = CreateProjectSubfolderTest(SmSession, "My Folder 2", Project)
   　'把第一層的 Folder Object 傳回給 tmpObject ，並傳給 CreateSubfolderTest() 當成第二層的 parent
   　retObject = CreateSubfolderTest(SmSession, "My Folder 2-1", tmpObject)
   　retObject = CreateSubfolderTest(SmSession, "My Folder 2-2", tmpObject)
   　retObject = CreateProjectSubfolderTest(SmSession, "My Folder 3", Project)
   
   　Return sRetObjectID
   End Function
   
   Function CreateProjectSubfolderTest(ByVal SmSession As SmApplic.SmSession, ByVal sFolderName As String, ByVal parentObject As ISmObject) As ISmObject
   
   　Dim smObject As ISmObject
   　Dim sRetObjectID As String
   　Dim SessionUtil As SmarTeam.Std.Interop.SmarTeam.SmUtil.SmSessionUtil 　'main SmarTeam service object
   
   　Dim folderClass As ISmClass
   　folderClass = SmSession.MetaInfo.SmClassByName("Folder")
   　Dim MainClassId As Integer 'class id for Sm main class
   　Dim SmClassAttributes As SmApplic.ISmClassAttributes 'Sm object attributes
   　Dim SmClassAttribute As SmApplic.ISmClassAttribute 'Sm object attribute
   　Dim StartMask As String 'start mask for attribute
   　Dim NextMask As String 'next mask for attribute
   
   　MainClassId = folderClass.ClassId
   　SmClassAttributes = folderClass.Attributes
   　SmClassAttribute = SmClassAttributes.ItemByName("TDMX_ID")
   　SessionUtil = SmSession.GetService("SmUtil.SmSessionUtil")
   
   　StartMask = SessionUtil.RetrieveStartMaskValue(SmClassAttribute)
   　NextMask = SessionUtil.RetrieveNextMask(SmClassAttribute, StartMask)
   
   　smObject = SmSession.ObjectStore.NewObject(folderClass.ClassId)
   　smObject.AddAllAttributes()
   　smObject.AddAttributes("TDMX_ID")
   　smObject.AddAttributes("TDM_DESCRIPTION")
   　smObject.Value("TDMX_ID") = NextMask
   　　smObject.Value("TDM_DESCRIPTION") = sFolderName
   　'讓 SmarTeam 在產生 link 不一直彈出視窗問是否當子階的關鍵，把 Behavior 設成 Silent
   　Dim Silent As ISmBehavior
   　Silent = SmSession.ObjectStore.DefaultBehavior.Clone
   　Silent.ConfirmOperations = ConfirmOperationEnum.coYesToAll
   'Silent.InvokeScripts = True
   smObject.InsertEx(Silent)
   
   　Dim retObject As ISmObject = smObject.Clone()
   
   　' Adds object to desktop tree
   　Dim smLinkObject As ISmObject
   　Dim smLinkClassId As Integer = 0
   　smObject.AddToDesktopEx(parentObject, smLinkClassId, Silent, smLinkObject, smObject)
   
   　Return retObject
   End Function
   
   
   Function CreateSubfolderTest(ByVal SmSession As SmApplic.SmSession, ByVal sFolderName As String, ByVal parentObject As ISmObject) As ISmObject
   
   　Dim smObject As ISmObject
   　Dim sRetObjectID As String
   　Dim SessionUtil As SmarTeam.Std.Interop.SmarTeam.SmUtil.SmSessionUtil 'main SmarTeam service object
   
   　Dim folderClass As ISmClass
   　folderClass = SmSession.MetaInfo.SmClassByName("Folder")
   　Dim MainClassId As Integer 'class id for Sm main class
   　Dim SmClassAttributes As SmApplic.ISmClassAttributes 'Sm object attributes
   　Dim SmClassAttribute As SmApplic.ISmClassAttribute 'Sm object attribute
   　Dim StartMask As String 'start mask for attribute
   　Dim NextMask As String 'next mask for attribute
   
   　MainClassId = folderClass.ClassId
   　SmClassAttributes = folderClass.Attributes
   　SmClassAttribute = SmClassAttributes.ItemByName("TDMX_ID")
   　SessionUtil = SmSession.GetService("SmUtil.SmSessionUtil")
   　StartMask = SessionUtil.RetrieveStartMaskValue(SmClassAttribute)
   
   　NextMask = SessionUtil.RetrieveNextMask(SmClassAttribute, StartMask)
   
   　smObject = SmSession.ObjectStore.NewObject(folderClass.ClassId)
   　smObject.AddAllAttributes()
   　smObject.AddAttributes("TDMX_ID")
   　smObject.AddAttributes("TDM_DESCRIPTION")
   　smObject.Value("TDMX_ID") = NextMask
   　smObject.Value("TDM_DESCRIPTION") = sFolderName
   
   　Dim Silent As ISmBehavior
   　Silent = SmSession.ObjectStore.DefaultBehavior.Clone
   　Silent.ConfirmOperations = ConfirmOperationEnum.coYesToAll
   'Silent.InvokeScripts = True
   smObject.InsertEx(Silent)
   
   　Dim retObject As ISmObject = smObject.Clone()
   
   　' Add as Child
   　Dim LinkObject As ISmObject
   　Dim LinkClassId As Integer
   　LinkClassId = SmSession.MetaInfo.HierarchicalLinkClassByClasses(folderClass.ClassId, smObject.ClassId)
   　LinkObject = smObject.NewLinkToParent(LinkClassId, parentObject)
   　LinkObject.InsertEx(Silent)
   
   　Return retObject
   End Function
   
   
   
4. 測試看看，成果如下
   
   

以上就完成簡單但實用的一個功能，本篇的資料夾數目及結構是寫在程式當中，維護上較困難，更新時亦需一一去更新每個 User 端
故下篇會介紹一資料庫來管理資料夾的內容及階層關係，如此一來就可輕易調整

在 .Net 中透過 Excel 函數來計算並回傳值

*WinForm 或 Asp.Net 皆適用，本篇以 Asp.Net 為例

在 Excel 中有許多實用但計算功能複雜 function，所以很多人會使用 Excel 來做統計報表
但若要以程式實做這些功能耗時費力，所以若能直接利用 Excel 來幫忙計算可省去不少時間

在安裝 Excel 時，會同時將 Excel 註冊成 COM 元件，故在 .Net 可直接參考使用，如下圖##CONTINUE##

加入參考後當然就進行程式撰寫，程式流程如下

1. 產生 Excel 物件及工作表
2. 在 Cell 寫入數值及使用的 function(本範例使用 sum())
   
3. 把值帶回 .Net 的變數
   

程式範例如下

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
using Excel;

public partial class _Default : System.Web.UI.Page
{
　　protected void Page_Load(object sender, EventArgs e)
　　{
　　　　Application oExcel = new Application();
　　　　Workbook oWorkBook = (Workbook)oExcel.Workbooks.Add(true);
　　　　Worksheet oSheet = (Worksheet)oWorkBook.Sheets[1];
　　　　Range cells = (Range)oSheet.Cells;

　　　　cells[1, 1] = "1";
　　　　cells[1, 2] = "2";
　　　　Range oRet = (Range)cells[1, 3];

　　　　oRet.Formula = "=sum(A1,B1)";
　　　　Response.Write(oRet.Text.ToString());
　　}
}

PDM/PLM (SmarTeam) 二次開發 - Lesson Four - 使用 Visual Studio Run-time Debug Tool 來 Debug

上一篇有介紹如何使用 .Net 來開發 SmarTeam 的程式，其實 .Net 能呼叫的 SmarTeam API，用 Smart Script 都能呼叫，除非是要與其他系統連結或設計 WinForm 程式。
使用 .Net 來開發的原因其實很簡單

1. 連結異質系統
2. 開發其它表單
3. 容易 Debug(有 Visual Studio Run-time Debug Tool)
4. 較容易開發(有 IntelliSense 協助)，其實有時查 Script 的語法還頗麻煩##CONTINUE##

這些上一篇其實有提到一些些，故本篇就介紹如何來 Run-Time Debug SmarTeam 的程式

由於我們是另外開發附加的元件，所以直接在 Visual Studio 按 F5 來進入 Debug Mode 是沒有用滴，因為根本不是由 SmarTeam 來觸發
所以就需要有一些簡單的技巧

1. 首先當然就是在程式中設中斷點，使用上一篇的程式來當範例
   
   
   
2. 開啟 SmarTeam 並登入，點選 Visual Studio 選單：「偵錯-->附加至處理序」
   
   
   
3. 選擇 SmarTeam.exe，附加
   
   
   
4. 啟動 SmarTeam Script Hook，由於本範例是寫在 SmarTeam OnLogin 後，而剛剛也已經 Login 進 SmarTeam 了，所以要從 SmarTeam 的選單來切換使用者
   
   
   
5. 跳至中斷點，大功告成，可直接在 Debug Mode 下看到 User ID 是 admin，當然在 Debug Mode 下還可做許多事，下許多指令，這裡就不贅述
   
   

PDM/PLM (SmarTeam) 二次開發 - Lesson Three - 使用 Script 呼叫 .Net 的 Client 端程式

上一篇有介紹用 Script 來開發 SmarTeam 的客製程式
本篇就介紹如何透過 Script 來呼叫 .Net 開發的客戶端程式
使用的開發工具為 Visual Studio 2005，基本上 2008 也行滴

要在 Visual Studio 中開發 SmarTeam 的應用程式，必須透過 SmarTeam 開放的 API
所以要把使用到的 SmarTeam DLL 加入參考
由於 SmarTeam 將程式安裝於 GAC，在系統中是無法找到相對應的 DLL 及 API 來使用
故首先必須把 GAC 中的檔案還原成 DLL，步驟如下##CONTINUE##

1. 建立 C:\Program Files\SMARTEAM\Bin\Assembly 來存放萃取出的 DLL 檔
   在命令提示字元中輸入
   if not exist "C:\Program Files\SMARTEAM\Bin\Assembly" md "C:\Program Files\SMARTEAM\Bin\Assembly"
2. 使用迴圈將 C:\WINDOWS\assembly 中屬於 SmarTeam 的 dll copy 至剛剛開的目錄
   在命令提示字元中輸入
   for /R C:\WINDOWS\assembly %f in (SmarTeam.*.dll) do copy %f "C:\Program Files\SMARTEAM\Bin\Assembly"
3. 將目錄資訊註冊於登錄檔在命令提示字元中輸入
   call regedit /s RegisterSmarTeamAssemblies.reg
   登錄檔 RegisterSmarTeamAssemblies.reg 內容如下
   [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders]
   [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\SMARTEAM]@="C:\\Program Files\\SMARTEAM\\Bin\\Assembly"
   

開發步驟如下

1. 取得 SmarTeam 的 DLL 後，當然就是開啟 Visual Studio 專案，加入參考
   開啟一個 Visual Basic 的類別庫專案，命名為 MySmarTeamTest
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
2. 加入下列參考，dll 檔剛剛才拿出來過，應該沒忘記放哪吧
   SmarTeam.Std.Interop.SmarTeam.SmApplic.dll
   SmarTeam.Std.Interop.SmarTeam.SmRecList.dll
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
3. 新增一類別，命名為 SmToolTest.vb
   本範例共有兩個 Function
   HelloWorld1 是從 Script 抓取 User ID 傳入 String 型態參數
   HelloWorld2 是將 Script 抓到的重要參數(如 Session)傳給 SmToolTest 來處理，由.Net 程式來抓取 User ID，這樣的好處是在 Visual Studio 開發較方便，有 IntelliSense 可以查 Function，還可以使用 .Net 的 Run-time Debug Tool 來除蟲
   內容如下，
   
   '別忘了 Import
   Imports SmarTeam.Std.Interop.SmarTeam.SmApplic
   Imports SmarTeam.Std.Interop.SmarTeam.SmRecList
   
   Public NotInheritable Class SmToolTest
   　Function HelloWorld1(ByVal sName As String)
   　　　MsgBox("Hi: " & sName)
   　　　Return ""
   　End Function
   
   　Function HelloWorld2(ByVal SmSession As SmSession, ByVal Operation As ISmOperation, ByVal FirstPar As SmRecordList, ByVal SecondPar As SmRecordList, ByVal ThirdPar As SmRecordList) As String
   　　　MsgBox("Hi: " & SmSession.UserMetaInfo.UserLogin)
   　　　Return ""
   　End Function
   End Class
   
   ' IntelliSense
   
   
   
   
   
   
   
   
   
4. 完成後進行編譯，在專案目錄下會產生 MySmarTeamTest.dll
   但 SmarTeam 是透過底層的 COM 來呼叫，故需把 MySmarTeamTest.dll 註冊成 COM
   在 MySmarTeamTest.dll 同層目錄中新增一文字檔，命名為 regCOM.bat
   檔案內容如下
   
   c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe /u MySmarTeamTest.dll
   c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe /tlb /codebase MySmarTeamTest.dll
   
   完成後執行 regCOM.bat 來註冊
   
5. 撰寫與 SmarTeam Hook 的 Script 檔
   於 SmarTeam\script 資料夾中新增一文字檔，命名為 Helloworld.ebs
   內容為
   Function HelloWorld(ApplHndl As Long,OpStr As String,FirstPar As Long,SecondPar As Long,ThirdPar As Long) As Integer
   
   　Dim MyDll As Object
   　Dim sRet As String
   　Dim SmSession As SmApplic.SmSession
   　Set SmSession = SCREXT_ObjectForInterface(ApplHndl)
   
   　'呼叫剛剛註冊於 COM 的物件
   　Set MyDll = CreateObject("MySmarTeamTest.SmToolTest")
   　'呼叫 HelloWorld1，傳入 USer ID
   　sRet = MyDll.HelloWorld1( SmSession.UserMetaInfo.UserLogin )
   
   　'把 Session 取出來傳給 HelloWorld2
   　Dim RecListIn1 As Object
   　Dim RecListIn2 As Object
   　Dim RecListOut As Object
   
   　Dim SmOp As SmApplic.ISmOperation
   　Dim ObjectStore As ISmObjectStore
   　Dim RecordListIn As SmRecordList
   
   　On Error GoTo ErrorDetected
   　Set ObjectStore = smSession.ObjectStore
   
   　CONV_RecListToComRecordList FirstPar, RecListIn1
   　CONV_RecListToComRecordList SecondPar, RecListIn2
   　CONV_RecListToComRecordList ThirdPar, RecListOut
   
   　'呼叫 HelloWorld2
   　sRet = MyDll.HelloWorld2(SmSession, SmOp, RecListIn1, RecListIn2, RecListOut)
   
   　Set MyDll = Nothing
   　HelloWorld = ERR_None
   Exit Function
   
6. 掛上 SmarTeam Hook 點，掛在 On Login 後(會管理 SmarTeam 應該都會開啟 Scrip Maintainance 管理工具吧?)
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
7. 登入 SmarTeam 就會看到兩次歡迎視窗，大功告成
   

PDM/PLM (SmarTeam) 二次開發 - Lesson Two - Hello World & 呼叫 COM

不免俗的，還是要來個 Hello World!!
在上一篇有介紹如何在 Form 的按鈕中觸發程式
在正式撰寫程式前，首先需先 Check 是否能真的抓到按鈕的 click 事件來觸發程式
故就先寫個 Hello World

程式如下

Function GetProjectData(ApplHndl As Long,OpStr As String,FirstPar As Long,SecondPar As Long,ThirdPar As Long) As Integer
　　MsgBox "Hello World!!"
　　GetProjectData = ERR_None
Exit Function

確定能攔截 SmarTeam 的事件後，便可進行更進一步的程式開發
在 SmarTeam 觸發事件後，會傳送五個參數給 Script Function
標準的 SmarTeam Script Function 如下
##CONTINUE##
Function GetProjectData(ApplHndl As Long,OpStr As String,FirstPar As Long,SecondPar As Long,ThirdPar As Long) As Integer

1. ApplHndl-->Converts to SmSession using the function SCREXT_ObjectForInterface
2. OpStr--> A string parameter that contains the name of the standard SMARTEAM operation of the script hook
3. FirstPar-->A pointer to a record list containing object information received from SMARTEAM.
4. SecondPar-->A pointer to a record list that contains object, task, or link information.
5. ThirdPar--> A pointer to a record list containing object or task information to be returned to SMARTEAM.
6. Return Value-->One of the error-code constants in Table 2. You should always assign a return value.
   

簡單的說
可透過 ApplHndl 來取得目前的 SmSession
透過 FirstPar 及 SecondPar 來取得當前物件的資訊
若要將運算完的資料傳回 SmarTeam 則透過 ThirdPar

以下以一個例子來說明如何運作
由於在另一個系統中已有公司所有專案的完整資訊
故希望在 SmarTeam 中新增專案時能透過專案ID去該系統取得專案資訊
以減少在 SmarTeam 的重覆輸入及避免發生輸入錯誤
PS. 取另一系統專案資料的程式已透過 .Net 來撰寫並註冊成 COM，程式類別名稱為 PDMTool.Tools

故此程式首先要接收Form 中的專案代號欄位(TextBox)的值
透過此值至另一個系統取得專案的其他資訊後回傳給 SmarTeam 的其他欄位後儲存專案
程式大致如下

Function GetProjectData(ApplHndl As Long,OpStr As String,FirstPar As Long,SecondPar As Long,ThirdPar As Long) As Integer

　　'宣告三個物件用來存放 FirstPar, SecondPar 及 ThirdPar
　　Dim RecListIn1 As Object
　　Dim RecListIn2 As Object
　　Dim RecListOut As Object

　　Dim SmSession As SmApplic.SmSession
　　Dim SmOp As SmApplic.ISmOperation
　　Dim ObjectStore As ISmObjectStore
　　Dim RecordListIn As SmRecordList

　　Dim MyDll As Object
　　Dim ColumnName As String
　　Dim sRet As String

　　'將 ApplHndl 轉換成 SmSession
　　Set SmSession = SCREXT_ObjectForInterface(ApplHndl)
　　Set ObjectStore = smSession.ObjectStore

　　'將 FirstPar 轉換至 RecListIn1 物件
　　CONV_RecListToComRecordList FirstPar, RecListIn1
　　CONV_RecListToComRecordList SecondPar, RecListIn2
　　CONV_RecListToComRecordList ThirdPar, RecListOut

　　'取得 COM 物件
　　Set MyDll = CreateObject("PDMTool.Tools")

　　'取得Form的專案代號，其欄位為 CN_DOCUNO
　　Dim CN_DOCUNO As String
　　CN_DOCUNO = RecListIn1.GetRecord(0).ValueAsString("CN_DOCUNO")

　　'透過PDMTool.Toolsk的GetProjectData()來取得專案資料，並分別存於 RecListOut 物件，並指派為 SmarTeam Form 的 CN_FIXNO 及 CN_INDATE 欄
　　ColumnName = "CN_FIXNO"
　　sRet = MyDll.GetProjectData(CN_DOCUNO, "WORKNO")
　　RecListOut.AddHeader ColumnName,50 ,sdtChar
　　RecListOut.Value(ColumnName,0) = sRet

　　ColumnName = "CN_INDATE"
　　sRet = MyDll.GetProjectData(CN_DOCUNO, "RDATE")
　　RecListOut.AddHeader ColumnName,50 ,sdtChar
　　RecListOut.Value(ColumnName,0) = sRet

　　'將 RecListOut 透過 ThirdPar 送回給SmarTeam
　　CONV_ComRecListToRecordList RecListOut, ThirdPar

　　Set MyDll = Nothing
　　MIRDC_SH_GetProjectData = ERR_None
Exit Function