Benutzer eines Projekts - 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
Benutzer eines Projekts

Voraussetzung

Einleitung

Die Benutzer eines Projekts sind Benutzer, die lokal für ein Projekt angelegt werden. Ist ein Projekt standardmäßig geschützt, wird ein Benutzer angelegt und erhält die ES-Administratorrolle.

Sie können mit TIA Portal Openness die folgenden Aufgaben für Benutzer eines Projekts ausführen:

  • Alle Benutzer eines Projekts abrufen

  • Einen Benutzer eines Projekts anlegen

  • Einen Benutzer in einem Projekt anhand des Namens suchen

  • Die zugewiesenen Rollen für den Benutzer eines Projekts abrufen

  • Eine Rolle für den Benutzer eines Projekts hinzufügen/entfernen

  • Den Benutzer eines Projekts aktivieren/deaktivieren

  • Gibt an, ob der Benutzer des Projekts aktiv ist

  • Den Benutzernamen für den Projektbenutzer festlegen

Programmcode

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

private static void projectUser(Project project, SecureString password)

{

    UmacConfigurator UmacConfiguratorService = project.GetService<UmacConfigurator>();

    var projectUsers = UmacConfiguratorService.ProjectUsers;

    // Create a project user

    ProjectUser projectUser = projectUsers.Create("AdminUser", password);

    //Set user name for project user

    projectUser.SetName("AdminProjectUser");

    // Indicates whether the user is Active

    var isUserActive = projectUser.IsActive;

    //Change password of project user

    projectUser.SetPassword(password);

    //Change AuthenticationType of projectUser

    projectUser.ProjectUserAuthenticationType = AuthenticationType.Radius;

    // Iterate through existing project users

    foreach(projectUser in projectUsers)

    {

     string projectUserName = projectUser.Name;

    }

    // Find a project user

    var projectUser = projectUsers.Find("AdminProjectUser");

    //Retrieve custom roles in project

    var customRoles = UmacConfiguratorService.CustomRoles;

    var customRole = customRoles.Find("Role_1");

    var systemRole = customRoles.Find("Engineering administrator");

    // Deactivate project user

    projectUser.Deactivate();

    // Add a Custom Role to a deactivated Project User

    projectUser.Roles.Add(customRole);

    // Add a System Role to a deactivated Project User

    projectUser.Roles.Add(systemRole);

    // Remove a Custom Role from a deactivated Project User

    bool isSuccessfullyRemoved = projectUser.Roles.Remove(customRole);

    // Remove a System Role from a deactivated Project User

    isSuccessfullyRemoved =projectUser.Roles.Remove(systemRole);

    // Activate project user

    projectUser.Activate();

    // Delete the project user instance

    projectUser.Delete();

}