CyL's nOtE

aras.uiGetFilteredListEx Method Gets filtered List Filter Values. Syntax aras.uiGetFilteredListEx( fValueNds , filter ) Parameters Name Type Description fValueNds Object Required. Array of Filter Value Item nodes. filter String Required. Regular expression. Return Value An Array Object of filtered Filter Value Item nodes. See Also aras Object Aras Innovator Client Framework

aras.getListValues Method Gets List Values by List ID. Syntax aras.getListValues( listID , is_bgrequest ) Parameters Name Type Description listID String Required. List ID. is_bgrequest Boolean Optional. Not necessary to pass this parameter due to unknown purpose, maybe reserve for the future. Default is false. Return Value An Array Object of Filter Value Item nodes. See Also aras Object Aras Innovator Client Framework

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

aras.getListFilterValues Method Gets List Filter Values by List ID. Syntax aras.getListFilterValues( listID , is_bgrequest ) Parameters Name Type Description listID String Required. List ID. is_bgrequest Boolean Optional. Not necessary to pass this parameter due to unknown purpose, maybe reserve for the future. Default is false. Return Value An Array Object of Value Item nodes. See Also aras Object Aras Innovator Client Framework

aras.getMostTopWindowWithAras Method Gets the most top window object. Syntax aras.getMostTopWindowWithAras( windowObj ) Parameters Name Type Description windowObj Object Optional. The window object. Default is current window. Return Value An Object. Input Paramter Return Main Window Object Main Window Object Work Window Object Tree Window Object Item Window Object Item Window Object Instance Window Object Relationship Window Object See Also aras Object Aras Innovator Client Framework

aras.getItemWhereUsed Method Finds Item where used. Syntax aras.getItemWhereUsed( typeName , id ) Parameters Name Type Description typeName String Required. Item type. id String Required. Item ID. Return Value An Object. Returns Item node contains "relatedItems" tag if the Item is used in somewhere. See Also aras Object Aras Innovator Client Framework

aras.getItemByName Method 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. Syntax aras.getItemByName( typeName , name , levels , configPath , select ) Parameters Name Type Description typeName String Required. Item type. name String Required. Item name. levels String Optional. Expanding depth for Relationships. Default is 0. configPath String Optional. RelationshipType name which should be loaded together. Default is empty. When specifying this parameter, "levels" must be greater than zero. If there are various values, use "|" to separate. select String Optional. The Property to return. Separating by comma. Default is empty (select all Properties). Return Value An Object or Null. Returns Item node if the data is loaded successfully, otherwise returns Nul

aras.getItemById Method 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. Syntax aras.getItemById( typeName , id , levels , configPath , select ) Parameters Name Type Description typeName String Required. Item type. id String Required. Item ID. levels String Optional. Expanding depth for Relationships. Default is 0. configPath String Optional. RelationshipType name which should be loaded together. Default is empty.  When specifying this parameter, "levels" must be greater than zero. If there are various values, use "|" to separate. select String Optional. The Property to return. Separating by comma. Default is empty (select all Properties). Return Value An Object or Null. Returns Item node if the data is loaded successfully, otherwise returns Null. See Al

When initiating a Workflow Map, a new Workflow Process and Workflow will be created. Workflow is a Relationship for recording the dependency of Workflow Process. That means Workflow Process cannot be deleted once source Item exits due to Relationship constraint. As for subflow, it is a kind of Workflow Process. But in the background, system will record which Activity starts the subflow. With above conditions, error message like Figure 1 and Figure 2 will show when trying to delete a Workflow Process. Figure 1. Error message of while deleting Workflow Process but source Item exists. Figure 2. Error message of while deleting Workflow Process but it has subflow. Therefore, deletion needs the following steps: Delete source Item. Delete subflow (if has). Delete Workflow Process.

aras.downloadFile Method Downloads a file from vault server. Syntax aras.downloadFile( fileNd , preferredName ) Parameters Name Type Description fileNd Object Required. File Item node. preferredName String Optional. The file name. Default uses original file name. Return Value A Boolean. Returns true if the file is downloaded successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework

ItemType must be created with some Properties in order to perform system functions correctly. They are System Property, including: classification keyed_name id created_by_id created_on modified_by_id modified_on current_state state locked_by_id is_current major_rev minor_rev is_released not_lockable css source_id related_id behavior sort_order config_id new_version generation permission_id managed_by_id owned_by_id itemtype release_date effective_date superseded_date team_id If trying to modify System Property, the warning message as below figure will show up. System will throw error when Property is a System Property and the new name is not identical to original name. But there is another logic if Property name does not be changed. The modification of Required, Length, Precision, Scale, and Default Value will affect column definition of database table. When column definition of database table changed, there are 3 rules to prevent illegal modif

OnChangeCell Event Fires when cell value changes. Arguments Name Type Description relationshipID String Relationship ID. relatedID String Related Item ID. Default is undefined if Relationship is Null Relationship propertyName String Property name. colNumber String Column number in current grid with zero-based numbering. gridApplet Object Grid control object. Details can refer to Aras Innovator official online API guide . See Also Aras Innovator Client Framework

OnEditFinish Event Fires after user finishes editing a cell. Arguments Name Type Description relationshipID String Relationship ID. relatedID String Related Item ID. Default is undefined if Relationship is Null Relationship propertyName String Property name. colNumber String Column number in current grid with zero-based numbering. gridApplet Object Grid control object. Details can refer to Aras Innovator official online API guide . See Also Aras Innovator Client Framework

OnEditStart Event Fires before user starts editing a cell. If return false, the action will abort. Arguments Name Type Description relationshipID String Relationship ID. relatedID String Related Item ID. Default is undefined if Relationship is Null Relationship propertyName String Property name. colNumber String Column number in current grid with zero-based numbering. gridApplet Object Grid control object. Details can refer to Aras Innovator official online API guide . See Also Aras Innovator Client Framework

Versionable ItemType has Life Cycle to control its states and permission. Although search result will only show the latest version, older versions still can be discovered with AML query. Find All Versions ID will not be Null in any situation due to it is the primary key. Therefore, all versions can be found with this principle. Below is the syntax: <AML> <Item type=" Item Type " action="get"> <id condition="is not null" /> </Item> </AML> Find All Released Revisions There is a Property named "is_released" in versionable ItemType to identify if the Item is released. Below syntax will find all released revisions: <AML> <Item type=" Item Type " action="get"> <id condition="is not null" /> <is_released>1</is_released> </Item> </AML> Find All Old Versions There is another Property named "is_current" in version

According to this article , Relationship tabs are indexed with RelationshipType ID. That means RelationshipType ID is Relationship tab ID. And also, Relatioship tabs are a part of Item window. Therefore, the first step is to get Item window reference. it could easily get with below code: var thisWnd = aras.getMostTopWindowWithAras(window); Enable/Disable Use below code can enable/disable a tab. The parameter "Enabled" is a Boolean, the tab will be disabled if passing false. thisWnd.relationships.relTabbar.SetTabEnabled( RelationshipType ID , Enabled ) Visibility Use below code can control the visibilty of a tab. The parameter "Visible" is a Boolean, the tab will hide if passing false. thisWnd.relationships.relTabbar.SetTabVisible( RelationshipType ID , Visible ) Remove Use below code can remove a tab, but this action is irreversible. thisWnd.relationships.relTabbar.RemoveTab( RelationshipType ID , Item Type )