User Class


( Users registered on NLS/DS. )

<ASUser> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

User group
(User_UserGroup)

<Multi>
<Basic><Standard>
Group
<ASUser> Data Type

Object

User group. If added and managed user group for each role, it will be convenient when there are newly added or removed users.

 

User group member
(User_UserGroupMember)

<RO> <Multi>
<Standard>
GroupContent
<ASUser> Data Type

Object

All members of this group. Not contains user groups. It is set automatically.

 

User type
(User_UserType)

<RO>
<Basic><Standard>

Enum

Specify the user type. The user's rights is different depending on the type.


ValueNameDescription
UserNormal userGrants normal user priviledges.
AdministratorProject managerGrants control over normal users.

 

Project
(User_UserSite)

<RO>
<Basic><Standard>
ProjectName
<BSTR> Data Type

String

Project of this user.

 

Message
(User_UserMessage)

<Multi>
<Basic><Standard>
Message
<BSTR> Data Type

String

Message from this user. Users can share information to others through the User table.

 

Log in status
(User_LogInStatus)

<RO>
<Basic><Standard>

Enum

Currectly logged in or not.


ValueNameDescription
0Not logged inThe user is not logged in.
1Logged inThe user is logged in.

 

Project locked
(User_ProjectCheckOut)

<RO>
<Basic><Standard>
ProjectCheckOut

Enum

Whether the project is locked or not.


ValueNameDescription
0NoThe user did not lock the project.
1YesThe user locked the project.

 

Module type
(User_UserModuleType)

<RO>
<Basic><Standard>
ModuleType
<BSTR> Data Type

String

Module type of this user.

 

Serial No.
(User_UserSerialNumber)

<RO>
<Basic><Standard>
SerialNumber
<LONG> Data Type

Integer

The serial number of the user's license.

Rights

Currently editing object
(Object_UserDuringChange_Rev)

<RO> <Multi>
<Basic><Standard>
DuringChangeObjectList
<ASOObjectList> Data Type

Object

Object which is currently editing by this user. It means the right to edit the object is reserved by this user, or inherited right to edit the object from another object.

 

Object with right to edit
(Object_UserDuringCheckOut_Rev)

<RO> <Multi>
<Basic><Standard>
DuringCheckOutObjectList
<ASOObjectList> Data Type

Object

Object whose right to edit is reserved by this user.

 

Object owned by this user
(Object_OwnerUser_Rev)

<Multi>
<Standard>
ObjectListUsingThisAsOwner
<ASOObjectList> Data Type

Object

Object owned by this user.

 

Reserve right to edit during log in
(User_GetRightToChangeOnLogIn)

<Basic><Standard>
GetRightToChangeOnLogIn

Enum

Specify here whether to reserve right to edit during log in.


ValueNameDescription
0Not specifiedDo nothing.
1All (If user locks project)Reserve right of edit all the objects available for this user, if user locks the project. If cannot reserve, warning messages will be shown.
2AllReserve right of edit all the objects available for this user. If cannot reserve, warning messages will be shown.
3Owner (If user locks project)Reserve right of edit all the objects whose [Owner] is this user, if user locks the project. If cannot reserve, warning messages will be shown.
4OwnerReserve right of edit all the objects whose [Owner] is this user. If cannot reserve, warning messages will be shown.

Common

Code
(Code)

<Basic><Standard>

String

Name of the object used internally. The code does not need to be unique including objects such as order. In that case, however, other property should be added to the DBIO primary key for a merge process during import and synchronization. Also, in cases where orders are specified by code such as for next orders, behavior is undefined.

 

Display name
(DisplayString)

<Standard>

String

Display name held internally in Asprova. If a value is set here, the display name will be displayed in place of the code. Starting with Ver4, single quotations (') are not allowed.

 

Alias
(DisplayAlias)

<Standard>

String

Specify here an alias of the object. If a value is set here, the alias will be displayed in place of its code or display name.
To display an alias, you need to select User defined aliases from [Workspace] - [General] - [String display method] (The default is set to this value). Starting with Ver4, single quotations (') are not allowed.

 

Comments (common)
(Comment)

<Multi>
<Standard>

String

Enter comments here. This property is common to each class and you can use it for Properties to be copied to operation from order of the Project class and so on.

 

Object ID
(ObjectID)

<RO>
<Standard>

Unsigned integer

ID number defined by each object.

 

Parent
(Parent)

<RO>
<Standard>

Object

The object at one level higher than this object.

 

Children
(Child)

<RO> <Multi>
<Standard>

Object

Objects at one level lower than this object.

 

Class definition
(Object_ClassDef)

<RO>
<Standard>

Object

Object that defines the class information of this object.

 

Internal status flag
(Object_StatusFlag)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed within Asprova.


ValueNameDescription
 NoneThis record has not been changed.
ANewly addedThis record has been newly added.
MModifiedThis record has been modified.
DDeletedThis record has been deleted.

 

Status flag
(Object_StatusFlagExt)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed outside Asprova.


ValueNameDescription
 NoneThis record has not been changed externally.
ANewly addedThis record has been newly added externally.
MModifiedThis record has been modified externally.
DDeletedThis record has been deleted externally.

 

Invalid flag
(Object_InvalidFlag)

<RO>
<Standard>

Bool

Indicates whether the object is invalid or not.

 

Reason to be invalidated
(ReasonToBeInvalidated)

<RO> <Multi>
<Standard>

Enum

Reason why the invalid flag is on.


ValueNameDescription
NNo valid master for order explosionNo valid master exists when orders are exploded.
LBMaster loop (master object)Master object in which a loop was detected.
LNMaster loop (master input instruction)Master input instruction in which a loop was detected.
LIMaster loop (item)Item in which a loop was detected.
FOrder explosion failureOrder explosion failed at last execution.
LIntegrated master loopItem that is detected to have a loop in the integrated master, and it's auto replenishment flag is not No.
GFailed to build groupsGroup hierachy exceeded the maximum limit of 20 levels deep.
GLFound a loop inside groupA loop has been detected inside a group.
D  
RUnneeded result operationRegarded as unneeded during the last order explosion but was not deleted because results data was specified for the operation.

 

Update time
(FlagDate)

<RO>
<Standard>

Time

Updated when import/export/synchronization is executed. Note that this is not the time at which data is changed through the GUI, rescheduling, and so on.

Internal

IP address
(User_UserIPAddress)

<RO>
<Basic><Standard>
IPAddress
<BSTR> Data Type

String

IP address of this user.

 

Host
(User_UserHostName)

<RO>
<Basic><Standard>
HostName
<BSTR> Data Type

String

Host name of this user.

 

Host ID
(User_UserHostID)

<RO>
<Basic><Standard>
HostID
<BSTR> Data Type

String

Host ID of this user.

 

Working folder
(User_UserFolderName)

<RO>
<Basic><Standard>
FolderName
<BSTR> Data Type

String

Working folder on the machine of this user.

 

Standard sort key
(User_UserStandardSortKey)

<RO>

Float

(Not used)Standard sort key for displaying User table. If displayed in ascending order, the first one will be the current user, and the others will be sorted by [Log in status] and [Module type] and so on.

 

Original flag
(User_OriginalFlag)

<RO>
<Standard>
OriginalFlag

Enum

Used internally.


ValueNameDescription
0NoThe user is registered in NLS/DS, but not the first one logged in.
1YesThe user is registered in NLS/DS.

All Properties

User group code
(User_UserGroupCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting User group. Mapped in DBIO's [Field mapping].

 

User registered this user as group
(User_UserGroup_Rev)

<RO> <Multi>

Object

Used internally. This property may contains user groups. After expanding them all to real users, it will have the same value as [User group member].

 

User groups to which this user belongs
(User_UserGroupMember_Rev)

<RO> <Multi>

Object

User groups which this user belongs to. It is set automatically.

 

Editable users
(ASGWindowProps_EditableUser_Rev)

<RO> <Multi>

Object

List of users that can edit this style

 

Displayed users
(ASGWindowProps_UserDisplayStyleInMenu_Rev)

<RO> <Multi>

Object

List of users for whom this style will be displayed for. Users or user groups can be specified.
If left blank, it will be displayed to all users.
If used together with [Hidden users], the hidden user list has higher priority.

 

Hidden users
(ASGWindowProps_UserHideStyleInMenu_Rev)

<RO> <Multi>

Object

List of users for whom this style will be hidden for. Users or user groups can be specified.
If * is specified, it will be hidden to all users.
If used together with [Displayed users], the hidden user list has higher priority.
If ! is specified, it will be hidden if user is not using NLS/DS. (This is to maintain compatibility before Ver.15.0)

 

User
(Command_Menu_User_Rev)

<RO> <Multi>

Object

List of users and user groups that can use this menu. If left blank, all users can use this menu.

 

Code/Display name/Alias
(Object_CodeDisplayNameOrAlias)

String

Corresponds to the code, display name or alias depending on the setting in the property String display method of the workspace.

 

Currently editing user code
(Object_UserDuringChangeCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Currently editing user. Mapped in DBIO's [Field mapping].

 

User with right to edit code
(Object_UserDuringCheckOutCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Reserved right to edit user. Mapped in DBIO's [Field mapping].

 

Owner code
(Object_OwnerUserCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Owner. Mapped in DBIO's [Field mapping].

 
 
GroupCount
<LONG> Data Type
<RO>

 

Number of elements in Group property's array.

 
GroupContentCount
<LONG> Data Type
<RO>

 

Number of elements in GroupContent property's array.

 
GetDuringCheckOutObjectList
<ASOObjectList> Data Type
<Method>

 

GetDuringCheckOutObjectList is the list of objects whose rights to edit have been reserved by this user.

 
GetDuringChangeObjectList
<ASOObjectList> Data Type
<Method>

 

GetDuringCheckOutObjectList is the list of objects which are being editing by this user.


<RO> : Read-Only
<Multi> : Array Type (Starting From 1)

<Basic> : Displays in basic mode
<Standard> : Displays in standard mode

See Also

ASOObjectList


HelpNo.:C227

© Since 2019 Asprova Corporation, All rights reserved.