SessionSettings Class¶
-
class
NXOpen.PDM.SessionSettings¶ Bases:
NXOpen.TransientObjectValues for the settings that affect the current Teamcenter session.
Any changes will only take effect when
PDM.SessionSettings.Apply()is callsed. .. versionadded:: NX4.0.0
Properties¶
| Property | Description |
|---|---|
| AdministrationBypass | Returns or sets a flag controlling the Teamcenter administrator’s bypass option. |
| AdministrationLogging | Returns or sets a flag controlling Teamcenter administration logging. |
| ApplicationLogging | Returns or sets a flag controlling Teamcenter application logging |
| Group | Returns or sets the Teamcenter group in which the user acts. |
| IsAdministrator | Returns a flag indicating if the user has Teamcenter administator privileges. |
| Journaling | Returns or sets a flag controlling Teamcenter journaling |
| Project | Returns or sets the Teamcenter project in which the user acts. |
| Role | Returns or sets the Teamcenter role in which the user acts. |
| SecurityLogging | Returns or sets a flag controlling Teamcenter security logging. |
| Volume | Returns or sets the Teamcenter role in which the user acts. |
Methods¶
| Method | Description |
|---|---|
| Apply | Applies any changes to the settings |
| Dispose | Free resources associated with the instance. |
| DumpValidationInfo | Dump the validation info . |
| GetGroups | Gets the names of the Teamcenter groups to which the user belongs. |
| GetProjects | Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty. |
| GetRoles | Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM.SessionSettings.Group(). |
| GetVolumes | Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM.SessionSettings.Group(). |
Property Detail¶
AdministrationBypass¶
-
SessionSettings.AdministrationBypass¶ Returns or sets a flag controlling the Teamcenter administrator’s bypass option.
Only available to administrators.
-------------------------------------Getter Method
Signature
AdministrationBypass()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AdministrationBypass(adminBypassOn)Parameters: adminBypassOn (bool) – New in version NX4.0.0.
License requirements: None.
AdministrationLogging¶
-
SessionSettings.AdministrationLogging¶ Returns or sets a flag controlling Teamcenter administration logging.
Only available to administrators.
-------------------------------------Getter Method
Signature
AdministrationLogging()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AdministrationLogging(adminLoggingOn)Parameters: adminLoggingOn (bool) – New in version NX4.0.0.
License requirements: None.
ApplicationLogging¶
-
SessionSettings.ApplicationLogging¶ Returns or sets a flag controlling Teamcenter application logging
-------------------------------------Getter Method
Signature
ApplicationLogging()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ApplicationLogging(appLoggingOn)Parameters: appLoggingOn (bool) – New in version NX4.0.0.
License requirements: None.
Group¶
-
SessionSettings.Group¶ Returns or sets the Teamcenter group in which the user acts.
Should be one of those given by
PDM.SessionSettings.GetGroups()-------------------------------------Getter Method
Signature
Group()Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Group(group)Parameters: group (str) – New in version NX4.0.0.
License requirements: None.
IsAdministrator¶
-
SessionSettings.IsAdministrator¶ Returns a flag indicating if the user has Teamcenter administator privileges.
Some settings can are only available to administrators, and will raise errors if non-administrators try to access them.
-------------------------------------Getter Method
Signature
IsAdministrator()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
Journaling¶
-
SessionSettings.Journaling¶ Returns or sets a flag controlling Teamcenter journaling
-------------------------------------Getter Method
Signature
Journaling()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Journaling(journalingOn)Parameters: journalingOn (bool) – New in version NX4.0.0.
License requirements: None.
Project¶
-
SessionSettings.Project¶ Returns or sets the Teamcenter project in which the user acts.
Should be one of those given by
PDM.SessionSettings.GetProjects()-------------------------------------Getter Method
Signature
Project()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Project(project)Parameters: project (str) – New in version NX8.5.0.
License requirements: None.
Role¶
-
SessionSettings.Role¶ Returns or sets the Teamcenter role in which the user acts.
Should be one of those given by
PDM.SessionSettings.GetRoles()-------------------------------------Getter Method
Signature
Role()Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Role(role)Parameters: role (str) – New in version NX4.0.0.
License requirements: None.
SecurityLogging¶
-
SessionSettings.SecurityLogging¶ Returns or sets a flag controlling Teamcenter security logging.
Only available to administrators.
-------------------------------------Getter Method
Signature
SecurityLogging()Returns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SecurityLogging(securityLoggingOn)Parameters: securityLoggingOn (bool) – New in version NX4.0.0.
License requirements: None.
Volume¶
-
SessionSettings.Volume¶ Returns or sets the Teamcenter role in which the user acts.
Should be one of those given by
PDM.SessionSettings.GetVolumes()-------------------------------------Getter Method
Signature
Volume()Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Volume(volume)Parameters: volume (str) – New in version NX4.0.0.
License requirements: None.
Method Detail¶
Apply¶
-
SessionSettings.Apply¶ Applies any changes to the settings
Signature
Apply()New in version NX4.0.0.
License requirements: None.
Dispose¶
-
SessionSettings.Dispose¶ Free resources associated with the instance.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()New in version NX4.0.0.
License requirements: None.
DumpValidationInfo¶
-
SessionSettings.DumpValidationInfo¶ Dump the validation info .
This API can be used to expose the current state from the UGMGR session, typically the information about the session,assembly,components,their states etc.
Signature
DumpValidationInfo(logFileName)Parameters: logFileName (str) – log file name New in version NX6.0.0.
License requirements: None.
GetGroups¶
-
SessionSettings.GetGroups¶ Gets the names of the Teamcenter groups to which the user belongs.
Signature
GetGroups()Returns: the names of the groups Return type: list of str New in version NX4.0.0.
License requirements: None.
GetProjects¶
-
SessionSettings.GetProjects¶ Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty.
Signature
GetProjects()Returns: the names of the projects Return type: list of str New in version NX8.5.0.
License requirements: None.
GetRoles¶
-
SessionSettings.GetRoles¶ Gets the names of the Teamcenter roles in which the user may act, given the current group returned by
PDM.SessionSettings.Group().Signature
GetRoles()Returns: the names of the roles Return type: list of str New in version NX4.0.0.
License requirements: None.
GetVolumes¶
-
SessionSettings.GetVolumes¶ Gets the names of the Teamcenter volumes which the user may use, given the current group returned by
PDM.SessionSettings.Group().Signature
GetVolumes()Returns: the names of the volumes Return type: list of str New in version NX4.0.0.
License requirements: None.