Skip to main content

aras Object (Aras Innovator Client Framework)

aras Object

Provides client side API.

Properties

Name Description
IomInnovatorGets Innovator instance.
utilsGets Utils instance.

Methods

Name Description
AlertErrorShows error message with stylish dialog.
AlertSuccessShows success message at bottom left of window.
AlertWarningShows warning message with stylish dialog.
applyAMLSends AML script to server and gets server response.
applyMethodExecutes a server side Method and gets server response.
calcMD5Generates MD5 hash.
clearClientMetadataCacheClears all client side metadata caches and empty contents in Work Window Object.
confirmShows confirm box with modal dialog. If showModalDialog method is unavailable, native JavaScript confirm box will be shown instead.
convertFromNeutralConverts neutral value to local value. Only effect on these data types: date, decimal, float.
convertToNeutralConverts local value to neutral value. Only effect on these data types: date, decimal, float.
downloadFileDownloads a file from vault server.
evalItemMethodExecutes a client side Method with Item node.
evalJavaScriptEvaluates JavaScript code in the Aras object space.
evalMethodExecutes a client side Method with Item node or XML string.
generateNewGUIDGenerates a new Item ID.
getCurrentLoginNameGets login name of current user.
getCurrentUserIDGets ID of current user.
getFormIdGets Form ID by Form name.
getIdentityListGets Identity list of current user.
getInnovatorUrlGet system entry url.
getIsAliasIdentityIDForLoggedUserGets Alias of current user.
getItemByIdGets Item node by Item ID. System will load data from server when:
  • Item node exists in cache and is dirty, but contained levels is less than requested levels.
  • Item node does not exists in cache.
Otherwise, cached data will be returned.
getItemByNameGets Item node by Item name. System will load data from server when:
  • Item node exists in cache and is dirty, but contained levels is less than requested levels.
  • Item node does not exists in cache.
Otherwise, cached data will be returned.
getItemPropertyGets property value with specified name from Item node.
getItemTypeIdGets ItemType ID by ItemType name.
getItemTypeNameGets ItemType name by ItemType ID.
getItemWhereUsedFinds Item where used.
getListFilterValuesGets List Filter Values by List ID.
getListIdGets List ID by List name.
getListValuesGets List Values by List ID.
getMostTopWindowWithArasGets the most top window object.
getRelatedItemGets Related Item node from Item node.
getRelationshipsGets Relationship Item nodes with specified RelationshipType name from Item node.
isDirtyExChecks the attribute "isDirty" from Item node.
isLockedChecks if Item is locked from Item node.
isLockedByUserChecks if Item is locked by current user from Item node.
isNewChecks if the action is "add" from Item node.
isTempExChecks the attribute "isTemp" from Item node.
lockItemLocks an Item by Item ID and ItemType name.
lockItemExLocks an Item by Item node.
newIOMItemCreates a new Item by Innovator instance.
promptShows prompt box with stylish dialog.
setItemPropertySet property value with specified name to Item node.
uiCloseWindowExCloses Item window by Item ID.
uiFindWindowExFinds Item window by Item ID.
uiGetFilteredListExGets filtered List Filter Values.
uiNewItemExExecutes "New Item" command for specified ItemType.
uiShowItemGets Item by Item ID and then shows the Item.
uiShowItemExShows Item with Item node.
unlockItemUnlocks an Item by Item ID and ItemType name. If the Item is dirty, confirm box will show before executing unlock action.
unlockItemExUnlocks an Item by Item node.

See Also

Aras Innovator Client Framework

Comments

Post a Comment

Popular posts from this blog

Trigger Sequence of Promotion Events in Aras Innovator

There are several Server Event could trigger Method during item promotion: ItemType: OnBeforePromote, OnAfterPromote; Life Cycle: Transition Pre, Transition Post. Trigger sequence of above events is shown in below figure: It's important to note that "Transition Post" cannot rollback while exception throws because item promotion is finished after "OnAfterPromote" That means even if throwing exception, the life cycle will still stay at promoted state. Please note, all above events will not be triggered when "OnPromote" event exists (due to this will overwrite original system process).
Post a Comment
Read more

aras.uiShowItemEx Method (aras Object)

aras.uiShowItemEx Method Shows Item with Item node. Syntax aras.uiShowItem( itemNd , viewMode , isOpenInTearOff ) Parameters Name Type Description itemNd Object Required. Item node. viewMode String Optional. Unknown purpose but only supports the following values: tab view (Default) openFile new ※Each supported value will get same result. Therefore, call method and pass undefined for this parameter is OK. isOpenInTearOff Boolean Optional. Specifies whether show Item with tear-off window. true - open in a tear-off window. false - open in a tab. (Default) Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework
Post a Comment
Read more

Account and Password Policy in Aras Innovator

Aras Innovator has prepared security policy for account and password and very simple to set up. Account Policy There are two system variables could handle account policy: AccountLockoutThreshold_triesNum: The maximum trying number of login, user account will be locked if exceed. AccountLockoutDuration_minutes: User account locking duration after reach maximum trying number. ※Account policy will only be effective when values of above two variables are greater than zero. Password Policy There are two system variables could handle password policy: User_pwd_symbols_min_number: The minimum characters that must be contained when user set new password. User_pwd_digits_min_number: The minimum digits that must be contained when user set new password.
Post a Comment
Read more