CyL's nOtE

aras.unlockItemEx Method Unlocks an Item by Item node. Syntax aras.unlockItemEx( itemNode , saveChanges ) Parameters Name Type Description itemNode Object Required. Item node. saveChanges Boolean Optional. Pass true to automatically save changes. If not set and the Item is dirty, confirm box will show before executing unlock action. Return Value An Object or Null. Returns Item node if unlock action executes successfully, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.unlockItem Method Unlocks an Item by Item ID and ItemType name. If the Item is dirty, confirm box will show before executing unlock action. Syntax aras.unlockItem( itemID , itemTypeName ) Parameters Name Type Description itemID String Required. Item ID. itemTypeName String Required. ItemType name. Return Value An Object or Null. Returns Item node if unlock action executes successfully, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.uiNewItemEx Method Executes "New Item" command for specified ItemType. Syntax aras.uiNewItemEx( itemTypeName ) Parameters Name Type Description itemTypeName String Required. ItemType name. Return Value An Object. Returns a new Item node. See Also aras Object Aras Innovator Client Framework

aras.uiFindWindowEx Method Finds Item window by Item ID. Syntax aras.uiFindWindowEx( itemID ) Parameters Name Type Description itemID String Required. Item ID. Return Value An Item Window Object or Null. Returns Item Window Object if Item window exists, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.uiCloseWindowEx Method Closes Item window by Item ID. Syntax aras.uiCloseWindowEx( itemID ) Parameters Name Type Description itemID String Required. Item ID. See Also aras Object Aras Innovator Client Framework

aras.setItemProperty Method Set property value with specified name to Item node. Syntax aras.setItemProperty( srcNode , element , value , apply_the_change_to_all_found , itemTypeNd ) Parameters Name Type Description srcNode Object Required. Item node. element String Required. Property name. value String Required. Property value. apply_the_change_to_all_found Boolean Optional. Specify if apply to all cached data. Default is true. itemTypeNd Object Optional. ItemType node for checking whether the data type of specified property is "Item". If not set, the function will get it automatically. See Also aras Object Aras Innovator Client Framework

aras.lockItemEx Method Locks an Item by Item node. Syntax aras.lockItemEx( itemNode ) Parameters Name Type Description itemNode Object Required. Item node. Return Value An Object or Null. Returns Item node if lock action executes successfully, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.lockItem Method Locks an Item by Item ID and ItemType name. Syntax aras.lockItem( itemID , itemTypeName ) Parameters Name Type Description itemID String Required. Item ID. itemTypeName String Required. ItemType name. Return Value An Object or Null. Returns Item node if lock action executes successfully, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.getRelationships Method Gets Relationship Item nodes with specified RelationshipType name from Item node. Syntax aras.getRelationships( item , typeName ) Parameters Name Type Description item Object Required. Item node. typeName String Required. RelationshipType name. Return Value An Array, containing Relationship Item nodes. See Also aras Object Aras Innovator Client Framework

aras.getRelatedItem Method Gets Related Item node from Item node. Syntax aras.getRelatedItem( item ) Parameters Name Type Description item Object Required. Item node. Return Value An Object or Null. Returns Related Item node if Related Item exists, otherwise returns Null. See Also aras Object Aras Innovator Client Framework

aras.getItemTypeName Method Gets ItemType name by ItemType ID. Syntax aras.getItemTypeName( id ) Parameters Name Type Description id String Required. ItemType ID. Return Value A String or undefined. Returns ItemType name if specified ID exists, otherwise returns undefined. See Also aras Object Aras Innovator Client Framework

aras.getItemTypeId Method Gets ItemType ID by ItemType name. Syntax aras.getItemTypeId( name ) Parameters Name Type Description name String Required. ItemType name. Return Value A String or undefined. Returns ItemType ID if specified name exists, otherwise returns undefined. See Also aras Object Aras Innovator Client Framework

aras.getItemProperty Method Gets property value with specified name from Item node. Syntax aras.getItemProperty( node , element , defaultVal ) Parameters Name Type Description node Object Required. Item node. element String Required. Property name. defaultVal String Optional. Property default value. If not set, the function will use empty String. Return Value A String. Returns property value if property exists, otherwise returns defaultVal. See Also aras Object Aras Innovator Client Framework

aras.generateNewGUID Method Generates a new Item ID. Syntax aras.generateNewGUID() Return Value A String. See Also aras Object Aras Innovator Client Framework

There are two actions can handle versionable Item modification: edit: when ItemType's versioning discipline is "Automatic", system will create new version Item when updating. version: create new version Item. Basically, edit action will lock, update, unlock an Item. Therefore, relevant ItemType Server Events include: OnBeforeLock OnAfterLock OnBeforeUpdate OnAfterUpdate OnBeforeUnlock OnAfterUnlock As for version action, mainly triggering below events: OnBeforeVersion OnAfterVersion Edit Action If versioning discipline is automatic, system will execute version action in background. That makes the process is a little complex, trigger sequence of relevant events is shown as Figure 1. Figure 1. Trigger sequence of edit action. Please note, all update and version events will not be triggered when "OnUpdate" event exists (due to this will overwrite original system process). Version Action This action mainly use for manually creating a ne

In Aras Innovator, List Value contains "Label" and "Value" to respectively indicate "text" and "value" of HTML select element. Instead of the "value" of list option, Activity Variable Value is written with the "text" of list option while voting (shown as Figure 1). This may cause programming mistake or wrong multilingual text. Figure 1 Solution Open "\Innovator\Client\scripts\InBasket\InBasket-VoteDialog.apsx". Find JavaScript function "processVote" (default at line 588). Move to if statement which handles variable type check (default at line 679, shown as Figure 2). Change "options[...].text" to "options[...].value" (default at line 681, circled at Figure 3). Save file. Figure 2 Figure 3

In Workflow Map, Activity Variable could be set default value and specified if it must be filled out before submitting. Normally, the list option may be ignored if it has default value. So, configuration will be set as Figure 1, default value is blank and checks "Required". But actually, list variable is already set while vote dialog opens (shown as Figure 2). That makes required setting useless and users are not necessary to review list options. Figure 1. Variable setting of Workflow Activity. Figure 2. Vote dialog variables. The reason is vote dialog does not handle this action (HTML will use first option as default if there is no any treatment). Therefore, "InBasket-VoteDialog.apsx" need to do some modification. Solution Open "\Innovator\Client\scripts\InBasket\InBasket-VoteDialog.apsx". Find JavaScript function "populateVariables" (default at line 187). Move to if statement which handles variable type check (default at lin

aras.applyMethod Method Executes a server side Method and gets server response. Syntax aras.applyMethod( action , body ) Parameters Name Type Description action String Required. Server side Method name. body String Optional. Method Item context. Return Value An Boolean or a String. Returns false and shows alert message if the server response contains fault code, otherwise returns result body of server response. See Also aras Object Aras Innovator Client Framework

aras.newIOMItem Method Creates a new Item by Innovator instance. Syntax aras.newIOMItem( itemTypeName , action ) Parameters Name Type Description itemTypeName String Optional. ItemType name. action String Optional. Action name. Return Value An Item object. Details of Item object can refer to Aras Innovator official online API guide . See Also aras Object Aras Innovator Client Framework

aras.getFormId Method Gets Form ID by Form name Syntax aras.getFormId( name ) Parameters Name Type Description name String Required. Form name. Return Value A String. Returns undefined if specified Form name does not exist, otherwise returns Form ID. See Also aras Object Aras Innovator Client Framework

aras.applyAML Method Sends AML script to server and gets server response. Syntax aras.applyAML( body ) Parameters Name Type Description body String Required. AML script to send. Return Value An Boolean or a String. Returns false and shows alert message if the server response contains fault code, otherwise returns result body of server response. See Also aras Object Aras Innovator Client Framework

Permissions.RevokeIdentity Method Revokes particular Identity of current user. Syntax Aras.Server.Security.Permissions.RevokeIdentity( identity ) Parameters Name Type Description identity Identity Required. Identity to revoke. Return Value A Boolean. Returns true if specified Identity is successfully revoked, otherwise returns false. See Also Permissions Class Aras.Server.Security Namespace Aras Innovator Server Framework

Permissions.GrantIdentity Method Grants current user particular Identity. Syntax Aras.Server.Security.Permissions.GrantIdentity( identity ) Parameters Name Type Description identity Identity Required. Identity to grant. Return Value A Boolean. Returns true if specified Identity is successfully granted, otherwise returns false. See Also Permissions Class Aras.Server.Security Namespace Aras Innovator Server Framework

Permissions.IdentitiesList Property Gets user's Identity list. Syntax Permissions.IdentitiesList Return Value A String. Identity list of current user, and all Identity ID will be separated with comma. See Also Permissions Class Aras.Server.Security Namespace Aras Innovator Server Framework

Permissions.Current Property Initiates Permissions class by current user permission info. Syntax Aras.Server.Security.Permissions.Current Return Value A Permissions object. See Also Permissions Class Aras.Server.Security Namespace Aras Innovator Server Framework

Permissions.AliasIdentitiesList Property Gets user's Alias. Return Value A String. Alias Identity ID of current user. See Also Permissions Class Aras.Server.Security Namespace Aras Innovator Server Framework

Identity.GetByName Method Initiates Identity class by Identity name. Syntax Aras.Server.Security.Identity.GetByName( name ) Parameters Name Type Description name String Required. Identity name. Return Value An Identity object. See Also Identity Class Aras.Server.Security Namespace Aras Innovator Server Framework

Identity.GetById Method Initiates Identity class by Identity ID. Syntax Aras.Server.Security.Identity.GetById( id ) Parameters Name Type Description id String Required. Identity ID. Return Value An Identity object. See Also Identity Class Aras.Server.Security Namespace Aras Innovator Server Framework

Identity.Id Property Gets Identity's ID. Syntax Identity.Id Return Value A String. See Also Identity Class Aras.Server.Security Namespace Aras Innovator Server Framework

Permissions.UserHasRootOrAdminIdentity Method Checks if current user has Super User Identity or Administrators Identity. Syntax Permissions.UserHasRootOrAdminIdentity() Return Value A Boolean. Returns true if current user has Super User or Administrators Identity, otherwise returns false. See Also Permissions Class Aras.Server.Core Namespace Aras Innovator Server Framework

Permissions.UserHasRootIdentity Method Checks if current user has Super User Identity. Syntax Permissions.UserHasRootIdentity() Return Value A Boolean. Returns true if current user has Super User Identity, otherwise returns false. See Also Permissions Class Aras.Server.Core Namespace Aras Innovator Server Framework

Permissions.UserHasAdminIdentity Method Checks if current user has Administrators Identity. Syntax Permissions.UserHasAdminIdentity() Return Value A Boolean. Returns true if current user has Administrators Identity, otherwise returns false. See Also Permissions Class Aras.Server.Core Namespace Aras Innovator Server Framework

Permissions.IdentityListHasId Method Checks if Identity list contains particular Identity. Syntax (Overloads) Permissions.IdentityListHasId( identityList , id1 ) Permissions.IdentityListHasId( identityList , id1 , id2 ) Parameters Name Type Description identityList String Required. Identity list. id1 String Required. Identity ID. id2 String Required. Another Identity ID. Return Value A Boolean. Returns true if identityList cotains id1 or id2, otherwise returns false. See Also Permissions Class Aras.Server.Core Namespace Aras Innovator Server Framework

aras.isTempEx Method Checks the attribute "isTemp" from Item node. Syntax aras.isTempEx( itemNd ) Parameters Name Type Description itemNd Object Required. Item node. Return Value A Boolean. Returns true if the value of attribute "isTemp" is "1", otherwise returns false. See Also aras Object Aras Innovator Client Framework

aras.isNew Method Checks if the action is "add" from Item node. Syntax aras.isNew( itemNd ) Parameters Name Type Description itemNd Object Required. Item node. Return Value A Boolean. Returns true if the value of attribute "action" is "add", otherwise returns false. See Also aras Object Aras Innovator Client Framework

aras.isLockedByUser Method Checks if Item is locked by current user from Item node. Syntax aras.isLockedByUser( itemNd ) Parameters Name Type Description itemNd Object Required. Item node. Return Value A Boolean. Returns true if the value of attribute "locked_by_id" is current user ID, otherwise returns false. See Also aras Object Aras Innovator Client Framework

aras.isLocked Method Checks if Item is locked from Item node. Syntax aras.isLocked( itemNd ) Parameters Name Type Description itemNd Object Required. Item node. Return Value A Boolean. Returns true if the attribute "locked_by_id" has value, otherwise returns false. See Also aras Object Aras Innovator Client Framework

aras.isDirtyEx Method Checks the attribute "isDirty" from Item node. Syntax aras.isDirtyEx( itemNd ) Parameters Name Type Description itemNd Object Required. Item node. Return Value A Boolean. Returns true if the attribute "isDirty" of Item or its descendant is "1", otherwise returns false. See Also aras Object Aras Innovator Client Framework