-
Notifications
You must be signed in to change notification settings - Fork 16
AML Actions
Eric Domke edited this page May 6, 2019
·
31 revisions
Action | Description |
---|---|
ActivateActivity |
|
add , AddItem ➡️ |
Add the Item as an instance of an ItemType. |
AddHistory |
|
ApplyUpdate |
|
BuildProcessReport |
Builds an HTML-formatted report for a workflow process |
CancelWorkflow |
|
⛔ checkImportedItemType
|
Removed in v11 |
closeWorkflow |
|
copy ➡️ |
Used when copying relationships in the relationships grid |
copyAsIs , copyAsNew ➡️ |
Used with the Save As... menu item |
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-versioned items. |
edit ➡️ |
This will lock , update , and unlock the Item. |
EmailItem |
|
EvaluateActivity ➡️ |
|
⛔ exportItemType
|
Removed in Aras v11 |
get , GetItemConfig , recache ➡️ |
Gets the Item(s) and its configuration based on the AML Item configuration used to query the database. Originally, getItemConfig was optimized by limiting the logic done between the SQL call and the AML result. This is no longer true |
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 <Item type="Part" id="..." action="getAffectedItems" />
|
GetInheritedServerEvents |
(:heavy_plus_sign: Added in Aras v11) |
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. |
⛔ getHistoryItems
|
Obsolete in 9.3 |
getItemLastVersion ➡️ |
|
getItemNextStates ➡️ |
Returns a list of Life Cycle Transition items representing the transitions that the authenticated user has permissions to perform. |
getItemRelationships |
<Item type="Part" relName="Part BOM" id="xxx"> -> <Item type="Part BOM" action="get"><source_id>xxx</source_id></Item>
|
GetItemRepeatConfig ➡️ |
This will allow deep recursive queries and is useful in multi-Part BOM's with repeating relationships. |
getItemWhereUsed ➡️ |
|
⛔ GetMappedPath ➡️
|
Removed in Aras v11sp12 |
getPermissions ➡️ |
|
getRelatedItem |
Given AML of the form <Item><related_id type="relType">xxx</related_id></Item> , performs a get of <Item type="relType" id="xxx" />
|
GetUpdateInfo ➡️ |
|
instantiateWorkflow ➡️ |
|
lock |
This will lock the Item and is the same as the Item.lockItem() IOM 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. |
purge |
Delete the version of the Item. |
replicate |
|
resetAllItemsAccess , resetItemAccess
|
Resets the permission_id of the item to the default for the item type. |
resetLifecycle |
Resets the life cycle to the initial state. Only can be called by root or administrator |
setDefaultLifecycle |
Resets the life cycle to the initial state of the default life cycle map defined in the item type configuration. |
skip |
|
startWorkflow ➡️ |
|
unlock |
This will lock the Item and is the same as the Item.unlockItem() method. |
update ➡️ |
Updates the Item. It is important to note, that the Item must be locked. Also, if the Item is versionable and is being updated for the first time since being locked, the update versions the Item and applies the update to the new version, unless the version="0" attribute is specified, which disables the versioning. |
ValidateWorkflowMap |
|
VaultServerEvent |
(:heavy_plus_sign: Added in Aras v11) |
version ➡️ |
Creates a new version of an item. The new item remains locked. |
Action | Description |
---|---|
ES_Search ➡️ |
Performs a search using enterprise search |
GetCommandBarItems ➡️ |
Returns the controls present in a command bar. |
GetCurrentUserIdentities ➡️ |
|
GetItemsForStructureBrowser ➡️ |
Gets the structure browser data |
GetPermissionsClause ➡️ |
(:heavy_plus_sign: Added in Aras v11sp12) |
mp_RegenerateSecuredFunctions |
|
ODataRequestConvert ➡️ |
|
qry_ExecuteQueryDefinition ➡️ |
(:heavy_plus_sign: Added in Aras v11sp12) Execute a query-builder query |
Run Report ➡️ |
Run a report |