powered by CADENAS

Manual

Manual

3.3.10.5. Teamcenter Zusatzfunktionen (teamcenter_public_api.vbb)

Allgemeine Info

Die Teamcenter Public API kann dazu verwendet werden, um bestimmte Aktionen auf einem Teamcenter Server durchzuführen (Daten abfragen, manipulieren).

Im Folgenden wird auf die wichtigsten direkt (über die Konfigurationsdatei .cfg konfigurierbar) verfügbaren Methoden eingegangen, alles andere kann der Dokumentation in %CADENAS_SETUP%\scripts\plm\autoexec\teamcenter_public_api.vbb entnommen werden.

Diese können z.B. verwendet werden, wenn Teamcenter custom code beim Kunden geschrieben werden muss.

Es werden u.a. folgende Funktionalitäten angeboten (direkt über die Konfigurationsdatei steuerbar):

  • MoveToNewFolder: Teamcenter Item zu einem Ordner hinzufügen / in einen Ordner Verschieben

  • ChangeOwnership: Besitzer eines Teamcenter Items ändern

  • SetReleaseStatus: Den Freigabestatus eines Teamcenter Items setzen

  • CreateProcessInstance: Einen Workflow in Teamcenter starten und einem Teamcenter Item zuweisen

  • GetXRevisionId: Wenn aktiv, kann hiermit immer die letzte Revision geladen werden – unabhängig von der in der PLMTable2/Cfg hinterlegten Revision.

  • CreateAndRelateItem: Ein Teamcenter Item (zusätzlich – dient nur der Verwaltung/Gruppierung – z.B. MasterItem) anlegen und das/die gerade durch den Export erstellte(n) Item(s) zu diesem hinzufügen.

    Außerdem ist es möglich, im [ReturnMapping] Block der jeweiligen PDM-Schnittstelle folgendes zu verwenden:

    ERPTABLE.<COLUMNNAME>=?"'%Master_Item_Id%'"

    Der Teil vor dem '=' gibt hier wie üblich die Tabelle und Spalte an und der hintere Teil den für diese Funktionalität zu verwendenden Platzhalter. Dadurch kann die ItemId (welche unter Umständen erst bei der Generierung von Teamcenter erzeugt wird) in der PLINKDB gespeichert werden. Wenn das Teil später für eine andere CAD-PDM-Kombination exportiert wird, kann hier der Wert für ItemId ausgelesen werden und das neue Item wird dann zum selben MasterItem hinzugefügt.

Voraussetzung zur Verwendung der Zusatzfunktionen

In den Konfigurationsdateien der Teamcenter PDM-Schnittstellen (ifnxteamcenter.cfg, ifproeteamcenter.cfg, ifseteamcenter.cfg, ifinvteamcenter.cfg) gibt es einen Block namens [PDM], in welchem folgende Schlüssel vorhanden sind:

  • PdmOnCheckin (Zusatzfunktionen für neu eingecheckte Items) (Standard)

    PdmOnCheckin=_START_CHAINCALL(_ACTIVE_IF_MODULE.checkin1(para.item(0)) , 1 , 1)
    .chainCall(_TC_HOOK_SERVICE.completeHookService(para.item(0)) , 1, 0).finish()

    ODER

    PdmOnEndCheckinTransaction (Zusatzfunktionen für alle Items des Exports)

    PdmOnEndCheckinTransaction=_START_CHAINCALL(_ACTIVE_IF_MODULE.endCheckinTransaction
    (para.item(0)) , 1 , 1).chainCall(_TC_HOOK_SERVICE.completeHookServiceList
    (para.item(0)) , 1, 0).finish()

    [Hinweis] Hinweis

    Einer dieser beiden Schlüssel muss gesetzt sein, damit die im Folgenden erläuterten Zusatzfunktionen verwendet werden können.

  • PdmOnBeginCheckoutTransaction

    [Hinweis] Hinweis

    Dieser Schlüssel muss zusätzlich gesetzt sein, wenn der Schlüssel (die Zusatzfunktion) GetXRevisionId benutzt wird.

    PdmOnBeginCheckoutTransaction=_START_CHAINCALL(_TC_HOOK_SERVICE.getXRevisionIdList
    (para.item(0)) , 0, 0).chainCall(_ACTIVE_IF_MODULE.beginCheckoutTransaction
    (para.item(0)) , 1 , 1).finish()
Hinweise

2-Tier Teamcenter Server ohne WebTier: Es muss eine IIOP Verbindung genutzt werden. Dazu muss evtl. ein spezielles Script des 2-Tier RichClients kopiert/angepasst werden, um den Service auf einem bestimmten Port zu starten.

Ob die unten angegebenen Konfigurationsschlüssel optional sind oder nicht, kann der Dokumentation in der Datei teamcenter_public_api.vbb entnommen werden. Dort sind auch weitere technische Beschreibungen der einzelnen Funktionen zu finden ebenso wie weitere hier nicht aufgeführte Methoden.

Schlüssel der Zusatzfunktionen im Einzelnen

[Hinweis] Hinweis

Die folgenden Schlüssel müssen im Block [CreationOptions] angelegt werden.

  • Teamcenter Login (Schlüssel welche von allen Zusatzfunktionen benötigt werden)

    • User:

      Caution: Only one value per key supported here (no categories) ! Caution: This user must have the right to access the objects owned by the user logged in to TC in NX.

      TC_HookService_Login_USER= <<hier muss der für den Teamcenter Login zu verwendende 
      Benutzername hinterlegt werden>>
    • Password:

      Caution: Only one value per key supported here (no categories) !

      TC_HookService_Login_PASS= <<hier muss das für den Teamcenter Login zu verwendende 
      Passwort hinterlegt werden>>
    • Host:

      Caution: Only one value per key supported here (no categories) !

      TC_HookService_Login_HOST= <<hier muss der für den Teamcenter Login zu verwendende 
      Host hinterlegt werden – 2Tier -> IIOP | 4Tier -> HTTP>>
  • MoveToNewFolder

    • The folder that will be used for moveToNewFolder (-> if this is empty moveToNewFolder will only bind the item to the folder given by TC_DESTINATION_FOLDER).

      Otherwise this must be the Teamcenter folder the item to move is stored in -> MoveToNewFolder will remove the item from this folder before binding it to <TC_HookService_MoveToNewFolder_DESTINATION_FOLDER>. E.g. "Home/Folder0"

      TC_HookService_MoveToNewFolder_SOURCE_FOLDER=
    • The folder that will be used for moveToNewFolder as destination folder. MoveToNewFolder binds the item to this folder. E.g. "Home/Folder1"

      TC_HookService_MoveToNewFolder_DESTINATION_FOLDER(is3dPart)= 
    • The parameter <Bitfield> for moveToNewFolder. For details see moveToNewFolder method description.

      TC_HookService_MoveToNewFolder_Flags=
    • The user that will be used for moveToNewFolder (-> user is owner of the source folder). E.g. "infodba"

      TC_HookService_MoveToNewFolder_SourceFolder_User=
    • The user that will be used for moveToNewFolder (-> user is owner of the destination folder). E.g. "infodba"

      TC_HookService_MoveToNewFolder_DestinationFolder_User=
    • If moveToNewFolder has to create a new folder the description will be set to this value. Default is: "Folder created by CADENAS".

      TC_HookService_MoveToNewFolder_CREATE_FOLDER_DESCRIPTION=
  • ChangeOwnership

    • The user that will be used for changeOwnership (-> user will be the new owner of the item). E.g. "infodba"

      TC_HookService_ChangeOwnership_User=
    • TC_HookService_ChangeOwnership_Group will be used together with TC_HookService_ChangeOwnership_User for changeOwnership.

      (analog to TC_HookService_ChangeOwnership_User). E.g. "Engineering"

      TC_HookService_ChangeOwnership_Group=
    • The parameter <Bitfield> for ChangeOwner. For details see ChangeOwner method description.

      TC_HookService_ChangeOwnership_Flags=
  • SetReleaseStatus

    • The parameter <newReleaseType> for setReleaseStatus. For details see setReleaseStatus method description.

      Commented out -> setReleaseStatus will not work. "" as value is supported.

      Different values for different items of one export possible.

      TC_HookService_setReleaseStatus_newReleaseType=
    • The parameter <operation> for setReleaseStatus. For details see setReleaseStatus method description.

      Different values for different items of one export possible.

      TC_HookService_setReleaseStatus_operation=
    • The parameter <oldReleaseType> for setReleaseStatus. For details see setReleaseStatus method description.

      Different values for different items of one export possible.

      TC_HookService_setReleaseStatus_oldReleaseType=
    • The parameter <Bitfield> for setReleaseStatus. For details see setReleaseStatus method description.

      TC_HookService_setReleaseStatus_Flags=
  • CreateProcessInstance

    • The parameter <startImmediately> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_startImmediately=
    • The parameter <observerKey> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_observerKey=
    • The parameter <name> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_name=
    • The parameter <subject> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_subject=
    • The parameter <processTemplate> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Mandatory.

      TC_HookService_createProcessInstance_processTemplate=
    • The parameter <description> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_description=
    • The parameter <processOwner> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_processOwner=
    • The parameter <deadline> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_deadline=
    • The parameter <container> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_container=
    • The parameter <relationType> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_relationType=
    • The parameter <processAssignmentList> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_processAssignmentList=
    • The parameter <dependencyTask> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_dependencyTask=
    • The parameter <remoteParent> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_remoteParent=
    • The parameter <remoteParentAppGuid> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_remoteParentAppGuid=
    • The parameter <remoteParentURL> for createProcessInstance. For details see createProcessInstance method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createProcessInstance_remoteParentURL=
    • The parameter <Bitfield> for createProcessInstance. For details see createProcessInstance method description.

      TC_HookService_createProcessInstance_Flags=
  • GetXRevisionId

    • Defines which RevisionID is put into PLMTable2 by getXRevisionId. Values: {"first","latest")(default is "latest"}

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_getXRevisionId_TargetRevision=
  • CreateAndRelateItem

    ### Item creation ###

    • Controls if the method is executed by the CompleteHookService-methods. Values: {"1","0")(default is "0"}

      Different values for different items of one export possible. Mandatory.

      TC_HookService_createItem_EXECUTE=
    • The itemId of the item (MasterItem) to create. Default is "" (get Id from Teamcenter). For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_itemId=
    • The revisionId of the item (MasterItem) to create. Default is "" (get Id from Teamcenter). For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_revisionId=
    • The itemtype of the item (MasterItem) to create. Default is "Item". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_type=
    • The name for the item (MasterItem) to create. Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_name=
    • The description for the item (MasterItem) to create. Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_description=
    • The clientId for the createItem call. Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_clientId= 
    • The UOM for the createItem call. Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_UOM=

    #### Link MasterItem to folder ####

    • The parent folder for the new item. Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_parentFolderPath=
    • The owner of the parent folder. Default is "" (use logged in user). For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_parentFolderOwner= 
    • The description for the parent folder (if it has to be created). Default is "". For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_parentFolderDesc=

    ### Link <it> to the (new) MasterItem ###

    • This key controls if and how the item this method is called for gets linked to the (new) MasterItem. No Default.

      For details see createAndRelateItem method description.

      Different values for different items of one export possible. Not mandatory.

      TC_HookService_createItem_childRelation=