This project has moved. For the latest updates, please go here.

The following values are valid for the action in an AML Item tag.

Action Description
ActivateActivity  

add

AddItem

Add the Item as an instance of an ItemType.
AddHistory ExampleAdd History Item
ApplyUpdate  
BuildProcessReport Builds an HTML-formatted report for a workflow process

CancelWorkflow

 

checkImportedItemType

 
closeWorkflow  
copy  

copyAsIs

copyAsNew

 
create This will act as a "get" if the Item exists, otherwise acts as an "add".
delete Delete all versions of the Item. The purge and delete are the same for non-versionable Items.
edit This will lock, update, and unlock the Item.
EmailItem  
EvaluateActivity ExampleUpdate an Activity
exportItemType  
get Gets the Item(s) and its configuration based on the AML Item configuration used to query the database.
getAffectedItems

Returns a flat list of all items that reference a particular item.  Similar to the getItemWhereUsed; however, this method will return the relationship item associated with an item while the where used action does not

Example (Input):

<Item type="Part" id="A680C64BF11A45449665B9FE30664894" action="getAffectedItems" />

 

getItemAllVersions Get all versions (i.e. generations) of an item.  It requires an id attribute and does not respect the select attribute.  Another way to do this is to search for generations > 0.
getItemConfig This will return the Item configuration as described by the standard AML query. The AML in and out are no different than the standard action="get". The GetItemConfig is optimized by limiting the logic done between the SQL call and the AML result. The performance improvement is gained by limiting the features typically available in Innovator GetItem (no server events or access checking on the sub level Items).
getHistoryItems Obsolete
getItemLastVersion  
getItemNextStates Returns a list of Life Cycle Transition items representing the transitions that the authenticated user has permissions to perform.
ExampleGet Valid Promotion States
getItemRelationships  
GetItemRepeatConfig This will allow deep recursive queries and is useful in multi-Part BOM's with repeating relationships.
ExampleGet Recursive Tree (e.g. BOM)
getItemWhereUsed ExampleGet Where Used Data
GetMappedPath Returns the base directory on the server combined with the path specified in the path attribute

Example (Input):

<Item action="GetMappedPath" path="Solutions/PLM/images/Icons/16x16/16x16_Part.gif" />
getPermissions ExampleGet Whether the Current User has Certain Permissions
getRelatedItem  
GetUpdateInfo  
instantiateWorkflow  
lock This will lock the Item and is the same as the Item.lockItem() method.
merge This will act as an "edit" if the Item exists, otherwise acts as an "add".
New Workflow Map  
promoteItem Promotes the item to the new state specified by the state property.  
ExamplePromote an Item
purge Delete the version of the Item.
recache  
replicate  
resetAllItemsAccess  
resetItemAccess  
resetLifecycle  
setDefaultLifecycle  
skip  
startWorkflow  
unlock This will lock the Item and is the same as the Item.unlockItem() method.
update

Updates the Item.

  • The Item must be locked.
  • If the Item is versionable and is being updated the first time since being locked the update versions the Item applying the update to the new version, unless the version="0" attribute is specified, which disables the versioning.
ValidateWorkflowMap  
version Creates a new version of an item. The new item remains locked.

Last edited Jun 5, 2012 at 2:46 PM by erdomke, version 17

Comments

No comments yet.