aras Object (Aras Innovator Client Framework)

aras Object

Provides client side API.

Properties

Name	Description
IomInnovator	Gets Innovator instance.
utils	Gets Utils instance.

Methods

Name	Description
AlertError	Shows error message with stylish dialog.
AlertSuccess	Shows success message at bottom left of window.
AlertWarning	Shows warning message with stylish dialog.
applyAML	Sends AML script to server and gets server response.
applyMethod	Executes a server side Method and gets server response.
calcMD5	Generates MD5 hash.
clearClientMetadataCache	Clears all client side metadata caches and empty contents in Work Window Object.
confirm	Shows confirm box with modal dialog. If showModalDialog method is unavailable, native JavaScript confirm box will be shown instead.
convertFromNeutral	Converts neutral value to local value. Only effect on these data types: date, decimal, float.
convertToNeutral	Converts local value to neutral value. Only effect on these data types: date, decimal, float.
downloadFile	Downloads a file from vault server.
evalItemMethod	Executes a client side Method with Item node.
evalJavaScript	Evaluates JavaScript code in the Aras object space.
evalMethod	Executes a client side Method with Item node or XML string.
generateNewGUID	Generates a new Item ID.
getCurrentLoginName	Gets login name of current user.
getCurrentUserID	Gets ID of current user.
getFormId	Gets Form ID by Form name.
getIdentityList	Gets Identity list of current user.
getInnovatorUrl	Get system entry url.
getIsAliasIdentityIDForLoggedUser	Gets Alias of current user.
getItemById	Gets 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.
getItemByName	Gets 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.
getItemProperty	Gets property value with specified name from Item node.
getItemTypeId	Gets ItemType ID by ItemType name.
getItemTypeName	Gets ItemType name by ItemType ID.
getItemWhereUsed	Finds Item where used.
getListFilterValues	Gets List Filter Values by List ID.
getListId	Gets List ID by List name.
getListValues	Gets List Values by List ID.
getMostTopWindowWithAras	Gets the most top window object.
getRelatedItem	Gets Related Item node from Item node.
getRelationships	Gets Relationship Item nodes with specified RelationshipType name from Item node.
isDirtyEx	Checks the attribute "isDirty" from Item node.
isLocked	Checks if Item is locked from Item node.
isLockedByUser	Checks if Item is locked by current user from Item node.
isNew	Checks if the action is "add" from Item node.
isTempEx	Checks the attribute "isTemp" from Item node.
lockItem	Locks an Item by Item ID and ItemType name.
lockItemEx	Locks an Item by Item node.
newIOMItem	Creates a new Item by Innovator instance.
prompt	Shows prompt box with stylish dialog.
setItemProperty	Set property value with specified name to Item node.
uiCloseWindowEx	Closes Item window by Item ID.
uiFindWindowEx	Finds Item window by Item ID.
uiGetFilteredListEx	Gets filtered List Filter Values.
uiNewItemEx	Executes "New Item" command for specified ItemType.
uiShowItem	Gets Item by Item ID and then shows the Item.
uiShowItemEx	Shows Item with Item node.
unlockItem	Unlocks an Item by Item ID and ItemType name. If the Item is dirty, confirm box will show before executing unlock action.
unlockItemEx	Unlocks an Item by Item node.

See Also

Aras Innovator Client Framework