Checkout für Datensatz in Teamcenter abbrechen - TIAPortal

TIA Portal Openness: API für die Automatisierung von Engineering-Workflows

ft:publication_title
TIA Portal Openness: API für die Automatisierung von Engineering-Workflows
Product
TIAPortal
Version
V20
Publication date
01/2025
Language
de-DE
Checkout für Datensatz in Teamcenter abbrechen

Voraussetzung

Verwendung

Sie können mit TIA Portal Openness das Auschecken eines Datensatzes für ein TIA Portal-Projekt und die globale Bibliothek in Teamcenter abbrechen. Sie können ferner CancelCheckoutDataset() verwenden, um die Sperre eines Datensatzes in Teamcenter aufzulösen.

Parameter

Parametername

Datentyp

Obligatorisch

Beschreibung

tcGatewayConnectionInfo

Siemens.Engineering.TeamcenterGateway.TcGatewayConnectionInfo

Ja

Gibt während des Verbindungsaufbaus zu Teamcenter tcGatewayConnectionInfo zurück. tcGatewayConnectionInfo Muss übergeben werden und mit der tcGatewayConnectionInfo der aktiven Verbindung übereinstimmen.

itemID

System.String

Ja

Gibt die ID für das TIA-Projekt / die Bibliothek in Teamcenter an.

revisionID

System.String

Ja

Gibt die Versions-ID für das TIA-Projekt / die Bibliothek in Teamcenter an, mit dem/der der Datensatz verbunden ist.

datasetType

Siemens.Engineering.TeamcenterGateway.DatasetType

Ja

Gibt den Typ des Teamcenter-Datensatzes für ein(e) Projekt / Bibliothek an, der ausgecheckt werden soll. Beispiel: T4TiaProjectDataset / T4TiaLibraryDataset.

datasetName

System.String

Ja

Gibt den Namen des Teamcenter-Datensatzes für ein(e) Projekt / Bibliothek an, der ausgecheckt werden soll.

Hinweis

Wird einer der oben aufgeführten obligatorischen Parameter für den Abbruch der Aktion "Datensatz für Projekt / Bibliothek in Teamcenter auschecken" nicht übertragen, wird eine Siemens.Engineering-Ausnahme des Typs TcGatewayException ausgelöst.

Programmcode

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

//Program code: Cancel checkout datatset in Teamcenter

private void CancelCheckoutDataset(SecureString password)

{

    // Refer Connecting to the TIA Portal section

    TiaPortal tiaPortal = new TiaPortal();

    // Retrieve the TcGatewayConnectionProvider and TcGatewayLockProvider

    // from GetService() using tiaPortal instance

    TeamcenterConnectionProvider tcGatewayConnectionProvider = tiaPortal.GetService<TeamcenterConnectionProvider>();

    TcGatewayLockProvider tcGatewayLockProvider = tiaPortal.GetService<TcGatewayLockProvider>();

    try

    {

    // Define user specific credentials and connection details

    string userName = "your_username";

    string userRole = "your_userrole";

    string userGroup = "your_usergroup";//Group

    string serverURL = "teamcenterserverURL";

    string teamcenterInstance = "teamcenterInstance";

    // Connect to Teamcenter using provided credentials

    TcGatewayConnectionInfo connectionInfo = tcGatewayConnectionProvider.Connect(userName, password,

    userGroup, userRole, serverURL, teamcenterInstance);

    //User can perform saving of Changes of TIA Project to the checked out dataset

    //using TcGateway Save APIs.

    tcGatewayLockProvider.CheckoutDataset(connectionInfo, "000495", "A", DatasetType.T4TiaProjectDataset, "Project30");

    //Cancel checkout on dataset to release the lock on dataset and undo the changes

    //done on dataset

    tcGatewayLockProvider.CancelCheckoutDataset(connectionInfo, "000495", "A", DatasetType.T4TiaProjectDataset, "Project30");

    }

    catch (TcGatewayException ex)

    {

    // other operations

    }

}