This wiki serves as a quick reference for commonly used Server-Side EKL APIs in Pre-Commit Triggers and UX Openings. It includes syntax, purpose, common usage patterns.
This page is a collection of useful Server-Side EKL APIs, code snippets, and examples that are frequently used in DELMIA and 3DEXPERIENCE development.
Note: This page is intended as a quick reference and is not a training guide or a comprehensive set of best practices. For detailed information about an API—including its complete syntax, supported arguments, limitations, and execution context—please refer to the official 3DEXPERIENCE EKL documentation.
The cheat sheet is intended to evolve as a shared knowledge base. If you have additional useful APIs, code snippets, examples, or improvements, feel free to contribute.
Tested on: R2026 FD03
Table Of Contents
| Sr. No. | Section | APIs Covered |
|---|---|---|
| 1 | Relationship Navigation APIs | GetRelationships(), GetFrom(), GetTo() |
| 2 | Scope/Implement Link APIs | GetProductScopesFromProcess(), GetProcessScopesFromProduct(), GetProcessScopesFromSystem(), GetImplementedFromConnection(), GetImplementingFromConnection() |
| 3 | Composition APIs | IsComposee(), GetComposer(), GetComposees() |
4 | Configuration Context API | GetComposees() |
| 5 | Document APIs | Reference Document , SpecificationDocument Relationship |
| 6 | Interface APIs | AddInterface(), RemoveInterface() |
| 7 | Messaging & Validation APIs | ReportUXMessage(), Validation, Trace(), Notify() |
| 8 | UI Refresh APIs | ReportModifiedObjects() |
| 9 | UX Opening APIs | SetUIAttributeVisible(), SetUIAttributeReadOnly(), SetUIAttributeAuthorizedValue(), SetUIAttributeNotificationMessageAndSeverity(), IsUIAttributeVisible(), IsUIAttributeReadOnly(), GetUIAttributeAuthorizedValue(), GetUIAttributeNotificationSeverity(), GetUIAttributeNotificationMessage() |
| 10 | Classification APIs | getConnectedDefinitionClasses(), getConnectedCategorizationClasses(), getParentLibrary(), getParentClass(), getSubClasses(), getClassificationAttributeValue(), setClassificationAttributeValue() |
| 11 | Change Action APIs | getProposedChanges(), getRealizedChanges(), getChangeRASCI(), getChangeActionDependencies(), getWhere(), getTarget(), getWhat(), getStatus(), getBefore(), getAfter(), getOperations(), getAssignees(), getApprovers(), getFollowers(), getDependencyDownstreamChanges(), getDependencyUpstreamChanges(), getCodependencyChanges() |
1. Relationship Navigation APIs
Purpose: Use these APIs to navigate between related business objects.
Business Object
│
▼
GetRelationships()
│
▼
Relationship
┌────────────┴────────────┐
▼ ▼
GetFrom() GetTo()
Source/ Target/
Parent Child Refernce| API | Description |
|---|---|
GetRelationships() | Returns relationships connected to the current object. |
GetFrom() | Returns the source (parent) object of the relationship. |
GetTo() | Returns the target (child) object of the relationship. |
Use case: Retrieve the childrens under a Manufacturing Root.
Manufacturing Root
│
├── DELFmiFunctionIdentifiedInstance
Assembly 1
│
├── DELFmiFunctionIdentifiedInstance
Assembly 2//ThisObject - DELFmiFunctionReference (Precommit at connect)
Let relList(List)
Let rel(DELFmiFunctionIdentifiedInstance)
Let parent(DELFmiFunctionReference)
Let child(DELFmiFunctionReference)
set relList = ThisObject.GetRelationships("DELFmiFunctionIdentifiedInstance")
Trace(1, "Number of childrens found: ", relList.Size())
If (relList <> NULL)
{
For rel inside relList
{
Set parent = rel.GetFrom()
Set child = rel.GetTo()
Trace(1, "FROM : ", parent.PLM_ExternalID)
Trace(1, "TO : ", child.PLM_ExternalID)
}
}Output
Number of childrens found: 2
FROM : ManufacturingRootID
TO : Assembly1ID
FROM : ManufacturingRootID
TO : Assembly2IDCommon Examples
| Use Case | API |
|---|---|
| Get child Manufacturing Assemblies/Provides | ThisObject.GetRelationships("DELFmiFunctionIdentifiedInstance") |
| Get child header operations under workplan | ThisObject.GetRelationships("DELLmiHeaderOperationInstance") |
| Get Reference Documents | ThisObject.GetRelationships("Reference Document") |
| Get Specification Documents | ThisObject.GetRelationships("SpecificationDocument") |
Retrieve the connected object:
document = relationship.GetTo()<i>Note : To learn how to fetch relationships from MQL, refer to the following </i><a href="https://r1132100503382-eu1-3dswym.3dexperience.3ds.com/community/swym:prd:R1132100503382:community:47?content=swym:prd:R1132100503382:wikitree:hcQgmBiCSOuFc4FteQc7LA" rel="nofollow"><i>documentation</i></a><i>.</i>
2. Scope/Implement Link APIs
Purpose: Use Scope APIs to retrieve the scoped product, item or systems.
| API | Description | Input | Output |
|---|---|---|---|
GetProductScopesFromProcess() | Returns the Engineering Products scoped to a Manufacturing Item. | Manufacturing Item | List of Scoped Engineering Products |
GetProcessScopesFromProduct() | Returns the Manufacturing Items scoped to an Engineering Product. | Engineering Product | List of Scoped Mfg Items |
GetProcessScopesFromSystem() | Returns the Manufacturing Items scoped to a Manufacturing System. | Mfg System | List of Scoped Mfg Items |
GetImplementingFromConnection() | Returns the implementing object (source) of an Implement Link. | MfgProductionPlanning (Implement Link) | List of Implementing Objects (e.g., Header Operation) |
GetImplementedFromConnection() | Returns the implemented object (target) of an Implement Link. | MfgProductionPlanning (Implement Link) | List of Implemented Objects (e.g., Mfg Item) |
Use Case: Retrieve all Engineering Products scoped to a Manufacturing Item.
//ThisObject : DELFmiFunctionReference
Let scopedProducts(List)
Let product(VPMReference)
Let i(Integer)
Set scopedProducts = GetProductScopesFromProcess(ThisObject)
If(scopedProducts.Size() > 0)
{
For product inside scopedProducts
{
Trace(1,"Scoped Product : ",product.PLM_ExternalID)
}
}Use Case: Retrieve all Manufacturing Item scoped to an Engineering Item
//ThisObject : VPMReference
Let scopedProcesses(List)
Let process(DELFmiFunctionReference)
Set scopedProcesses = GetProcessScopesFromProduct(ThisObject)
If(scopedProcesses.Size() > 0)
{
For process inside scopedProcesses
{
Trace(1,"Scoped Process : ",process.PLM_ExternalID)
}
}Use Case: Retrieve all Manufacturing Item scoped to a Manufacturing System.
//ThisObject : DELLmiWorkPlanSystemReference
Let scopedProcesses(List)
Let process(DELFmiFunctionReference)
Set scopedProcesses = GetProcessScopesFromSystem(ThisObject)
If(scopedProcesses.Size() > 0)
{
For process inside scopedProcesses
{
Trace(1,"Scoped Process : ",process.PLM_ExternalID)
}
}Implement Link Sample Scenario
Header Operation
│
│ Implement Link (MfgProductionPlanning)
▼
Provided PartUse Case: Retrieve the implementing Header Operation(s) from an Implement Link
//ThisObject : MfgProductionPlanning
Let llLink(List)
Let lPath(List)
Let operationInst(PLMCoreInstance)
Set llLink = GetImplementingFromConnection(ThisObject)
If (llLink <> NULL)
{
For lPath Inside llLink
{
If (lPath <> NULL)
{
For operationInst Inside lPath
{
If (operationInst <> NULL)
{
Trace(1, "Implementing Header Operation : ", operationInst.PLM_ExternalID)
}
}
}
}
}
Else
{
Trace(1, "No Implementing Objects found.")
}Output
Implementing Header Operation : Header Operation00000001.0Use Case: Retrieve the implemented Manufacturing Item(s) from an Implement Link.
//ThisObject : MfgProductionPlanning
Let llLink(List)
Let lPath(List)
Let mfgItemInst(PLMCoreInstance)
Set llLink = GetImplementedFromConnection(ThisObject)
If (llLink <> NULL)
{
For lPath Inside llLink
{
If (lPath <> NULL)
{
For mfgItemInst Inside lPath
{
If (mfgItemInst <> NULL)
{
Trace(1, "Implemented Manufacturing Item : ", mfgItemInst.PLM_ExternalID)
}
}
}
}
}
Else
{
Trace(1, "No Implemented Objects found.")
}Output
Implemented Manufacturing Item : Provided Part00000175.0
3. Composition APIs
<strong>Note:</strong>
These APIs are supported only in <strong>PreCommit Business Logic</strong>.
They work only for <strong>Composer–Composee</strong> relationships which is defined by the modeler in the data model.Purpose: Use these APIs to navigate Composer–Composee relationships between Business Objects.
A Composee is a Business Object owned by another Business Object called the Composer. This ownership is defined through a compositional relationship in the data model.
API | Description |
|---|---|
IsComposee() | Returns whether the current object is a Composee. |
GetComposer() | Returns the Composer (owner) of the current Composee. |
GetComposees() | Returns all Composees owned by the current Composer. |
GetComposees(relationshipType) | Returns Composees connected through the specified compositional relationship. |
Navigation
GetComposer()
Composer ◄──────────────────── Composee
│
│ GetComposees()
│
▼
Composee 1
Composee 2
Composee 3Use Case: Retrieve the Composer and its Composees
/* ThisObject : DELFmiProcessImplementCnx */
OR
/* ThisObject : MfgProductionPlanning*/
Let composer(BusinessType)
Let listOfComposee(List)
Let composee(Feature)
If (ThisObject.IsComposee())
{
Set composer = ThisObject.GetComposer()
Trace(1, "Composer : ", composer)
Set listOfComposee = composer.GetComposees()
For composee Inside listOfComposee
{
Trace(2, "Composee : ", composee)
}
}Output:
When the business rule executes on Scope Link (DELFmiProcessImplementCnx) created between Product and a Manufacturing Item:
Composer : CreateAssembly
Composees
├── VPMCfgContext
├── DELMfgResponsibilityCnx
└── DELFmiProcessImplementCnx
When the business rule executes on scope Link (MfgProductionPlanning) created between a Workplan and a Manufacturing Item:
Composer: Workplan
Composees
├── VPMCfgContext
├── DELMfgResponsibilityCnx
├── MfgProductionPlanning
├── DELLmiProdSystemIOPort
These examples show that GetComposees() returns all composee objects owned by the Composer, not only objects of the same type as the current object. This behavior depends entirely on the underlying compositional relationships defined in the data model.
Common Use Cases
When Operation → Manufacturing Item Implement Link is created, we can use GetComposer() to retrieve the owning Operation, then use GetRelationships() to navigate the Workplan and retrieve child Operations.
When Engineering Product → Manufacturing Item scope Link is created, we can GetComposer() to retrieve the parent Manufacturing Item, then use GetProductScopesFromProcess() to retrieve the scoped Engineering Product and copy attributes from the EBOM to the corresponding MBOM as shown in below code
// ThisObject : DELFmiProcessImplementCnx
Let miRef(DELFmiFunctionReference)
Let scopedProducts(List)
Let engProduct(VPMReference)
If (ThisObject.IsComposee())
{
Set miRef = ThisObject.GetComposer()
Set scopedProducts = GetProductScopesFromProcess(miRef)
If (scopedProducts.Size() > 0)
{
Set engProduct = scopedProducts.GetItem(1)
miRef.SetAttributeString(
"V_description",
engProduct.GetAttributeString("V_description"))
}
}
Tip: To identify all Business Object types that participate in Composer–Composee relationships, use MQL to list all types and inspect the composed property. Any type with composed = TRUE supports the Composition APIs (IsComposee(), GetComposer(), and GetComposees()) when used in the appropriate PreCommit context.
<i>list type * where 'composed == TRUE'</i>
4. Configuration Context API
Use Case: Check if a Child Manufacturing Reference is a Configured Node (PC Instance)
//ThisObject : DELFmiFunctionReference
Let childRelationships(List)
Let instance(DELFmiFunctionIdentifiedInstance)
Let childReference(DELFmiFunctionReference)
Let configContexts(List)
Let configContext(VPMCfgContext)
Let i, j(Integer)
i = 1
//Get Childrens
Set childRelationships = ThisObject.GetRelationships("DELFmiFunctionIdentifiedInstance")
If (childRelationships <> NULL)
{
For i While i <= childRelationships.Size()
{
Set instance = childRelationships.GetItem(i)
Set childReference = instance.GetTo()
Set configContexts = childReference.GetComposees()
If (configContexts <> NULL)
{
j = 1
For j While j <= configContexts.Size()
{
//Get Config Context
Set configContext = configContexts.GetItem(j)
Trace(1, "Configured Node : ", childReference.V_Name)
Trace(1, "Configuration Context : ", configContext.name)
}
}
}
}Output
Configured Node : Manufacturing Assembly00000396
Configuration Context : 7513BF56FBBD00006A673717000001D6
5. Document APIs
Use relationships API to fetch the documents in ER Generic server openings.
Use Case: Fetch Reference Documents
relationships =ThisObject.GetRelationships("Reference Document")Use Case: Fetch Specification Documents
relationships =ThisObject.GetRelationships("SpecificationDocument")Retrieve document
document = relationship.GetTo()
6. Interface APIs
Purpose: Use these APIs to add or remove Customer Extensions and supported interfaces from Business Objects or Relationships.
Notes:
- Applicable in Init and PreCommit Business Logic depending on the interface type.
- If the interface already exists, AddInterface() or RemoveInterface() does not raise an error.
| API | Description |
|---|---|
ThisObject.AddInterface(interfaceName) | Adds the specified interface to the current Business Object or Relationship. |
ThisObject.RemoveInterface(interfaceName) | Removes the specified interface from the current Business Object or Relationship. |
Use Case: Add a Customer Extension on object creation (Precommit at create)
// ThisObject : Business Object
Validation = TRUE
ThisObject.AddInterface("TST_CustoExtension1")
Trace(1, "Interface added successfully.")Output
Interface added successfully.
Use Case: Remove a Customer Extension on object promotion (Precommit at promote)
// ThisObject : Business Object
Validation = TRUE
ThisObject.RemoveInterface("TST_CustomerExt_1")
Trace(1, "Interface removed successfully.")Output
Interface removed successfully.
7. Messaging APIs
Purpose: Display a validation or information message to the user. It is commonly used with Validation = FALSE to block an operation and display the reason.
| API | Description |
|---|---|
ReportUXMessage(message) | Registers a message to be displayed to the end user. |
Common Usage Pattern
If (<validation fails condition>)
{
Validation = FALSE
ReportUXMessage("Meaningful error message")
}This pattern is the one you'll use most frequently in PreCommit Triggers and ER Generic Server Openings to stop an operation and inform the user why it was rejected.
Use Case: Block promotion if Item is not Classified
//ThisObject :DELFmiFunctionReference
Let classes(List)
Let categorizationClasses(List)
Validation=True
Set classes = ThisObject.getConnectedDefinitionClasses()
Set categorizationClasses = ThisObject.getConnectedCategorizationClasses()
If (classes.Size() <= 0 AND categorizationClasses.Size() <= 0)
{
Validation = FALSE
ReportUXMessage("Item not classified")
}Output
Item not classified
Note: ReportUXMessage() does not display the message by itself. The calling application is responsible for processing and displaying the registered message. No message about the execution status, either success or failure, is displayed if the message stored by the ReportUXMessage is not taken into account by the App where it is called.
8. UI Refresh APIs
Purpose: Refreshes Business Objects or Relationships modified through ER Generic Server Openings in the current Native Apps session.
**Use this API whenever attributes are modified in an ER Generic Server Opening (e.g., PreCommit Trigger). Otherwise, the changes are saved in the database but are not immediately reflected in the Native Apps UI.
Use Case: Update the Description of a Physical Product during a Create Trigger and refresh the object in the current session without reopening the data.
// ThisObject : DELFmiFunctionReference
Let modifiedObjects(List)
Validation = TRUE
ThisObject.SetAttributeString("V_description","Updated through Promote Trigger")
modifiedObjects.Append("B" + ThisObject.GetAttributeString("physicalid"))
ReportModifiedObjects(modifiedObjects)Prefixes
| Prefix | Object Type |
|---|---|
B | Business Object |
R | Relationship |
Common Examples
| Use Case | Example |
|---|---|
| Refresh a Business Object | "B" + ThisObject.GetAttributeString("physicalid") |
| Refresh a Relationship | "R" + relationship.GetAttributeString("physicalid") |
Notes
- Applicable only to ER Generic Server Openings.
- It only refreshes the modified object in the current Native Apps session.
- Without
ReportModifiedObjects(), changes are persisted in the database but may not be visible until the object is reopened or refreshed. - Multiple modified objects can be refreshed by adding their prefixed physical IDs to the list before calling
ReportModifiedObjects()
9. UX Opening APIs
Note: These APIs are supported only in UX Openings and cannot be used in other Server-Side EKL contexts such as PreCommit Triggers
All APIs are tested on New Modify and Properties Modify Trigger Opening Id and ThisObject is DELFmiFunctionReference
Visibility APIs
SetUIAttributeVisible()
IsUIAttributeVisible()Use case: Hide Description Attribute if it is Visible
If (ThisObject.IsUIAttributeVisible("PLMEntity.V_description"))
{
Trace(1, "Description is Visible")
ThisObject.SetUIAttributeVisible("PLMEntity.V_description", FALSE)
}Use case: Show Description Attribute
// Show the Description attribute
ThisObject.SetUIAttributeVisible("PLMEntity.V_description",TRUE)Read Only APIs
SetUIAttributeReadOnly()
IsUIAttributeReadOnly()Use case: Make Title Attribute Read-Only
ThisObject.SetUIAttributeReadOnly("PLMEntity.V_Name",TRUE)Use case: Check if an Attribute is Read-Only and Make it Editable
If (ThisObject.IsUIAttributeReadOnly("PLMEntity.V_Name"))
{
Trace(1, "Attribute is Read Only")
ThisObject.SetUIAttributeReadOnly("PLMEntity.V_Name", FALSE)
}Authorized Values APIs
SetUIAttributeAuthorizedValue()
GetUIAttributeAuthorizedValue()Use case: Set and Retrieve Authorized Values
Let values(List)
Let Authvalues(List)
values.Append("Design")
values.Append("Manufacturing")
values.Append("Released")
ThisObject.SetUIAttributeAuthorizedValue("PLMEntity.V_description", values)
Set Authvalues = ThisObject.GetUIAttributeAuthorizedValue("PLMEntity.V_description")
Trace(1,"Authorised value Size = ",Authvalues.Size())Notification APIs
SetUIAttributeNotificationMessageAndSeverity()
GetUIAttributeNotificationMessage()
GetUIAttributeNotificationSeverityUse case: Display a Error Message and Retrieve Notification message
Let message(String)
let desc(String)
desc=ThisObject.GetAttributeString("PLMEntity.V_description")
if(desc=="" or desc== NULL)
{
ThisObject.SetUIAttributeNotificationMessageAndSeverity("PLMEntity.V_description",1,"Value is recommended.")
message =ThisObject.GetUIAttributeNotificationMessage("PLMEntity.V_description")
Trace(1,"message is ",message)
}Use case: Display Warning Message and Retrieve Severity Message
Let severity(Integer)
let desc(String)
desc=ThisObject.GetAttributeString("PLMEntity.V_description")
if(desc=="%")
{
ThisObject.SetUIAttributeNotificationMessageAndSeverity("PLMEntity.V_description",2,"Invalid value.")
severity = ThisObject.GetUIAttributeNotificationSeverity("MyAttribute")
Trace(1,"severity is ",severity)
}Use case: Display Information Message and Retrieve Severity Message
let desc(String)
desc=ThisObject.GetAttributeString("PLMEntity.V_description")
ThisObject.SetUIAttributeNotificationMessageAndSeverity("PLMEntity.V_description",3,desc+" is set as description")10. Classification APIs
Note: These APIs are supported only in ER Generic Server Openings.
Purpose: Use these APIs to retrieve an object's classification, navigate the classification hierarchy, and access classification attributes.
APIs
| API | Description |
|---|---|
ClassifiedObject.getConnectedDefinitionClasses() | Returns the Definition Classes connected to the object. |
ClassifiedObject.getConnectedCategorizationClasses() | Returns the Categorization Classes connected to the object. |
ClassifiedObject.getClassificationAttributeValue(attributeName, classPhysicalId) | Returns the value of a classification attribute. |
ClassifiedObject.setClassificationAttributeValue(attributeName, value, classPhysicalId) | Sets the value of a classification attribute. |
class.getParentLibrary() | Returns the parent library of a class. |
class.getParentClass() | Returns the parent class of a class. |
class.getSubclasses() | Returns the child classes of a class. |
Use Case: Validate that an item is classified
Let classes(List)
Let class(`General Class`)
Let categorizationClasses(List)
Let categorizationClass(`General Class`)
Validation=True
Set classes = ThisObject.getConnectedDefinitionClasses()
Trace(1, "No. of Definition Classes : ", classes.Size())
For class Inside classes
{
Trace(1, "Definition Class : ", class.name)
}
Set categorizationClasses = ThisObject.getConnectedCategorizationClasses()
Trace(1, "No. of Categorization Classes : ", categorizationClasses.Size())
For categorizationClass Inside categorizationClasses
{
Trace(1, "Categorization Class : ", categorizationClass.name)
}
If (classes.Size() <= 0 AND categorizationClasses.Size() <= 0)
{
Validation = FALSE
ReportUXMessage("Item not classified")
}Output
No. of Definition Classes : 1
Definition Class : Class-8544851-00000012
No. of Categorization Classes : 1
Categorization Class : Class-8544851-00000011
Use case: Retrieve Definition Class Details
Demonstrates:
- Reading connected Definition Classes
- Setting a classification attribute
- Reading a classification attribute
- Retrieving the parent library
- Navigating to the parent class
- Listing sub classes
Let classes, subclasses(List)
Let class, subclass(`General Class`)
Let gl(`General Library`)
Let parentClass(`General Class`)
Let classId(String)
Let language(String)
Set classes = ThisObject.getConnectedDefinitionClasses()
Trace(1, "No. of Definition Classes : ", classes.Size())
For class Inside classes
{
Trace(1, "Definition Class : ", class.Title)
classId = class.GetAttributeString("physicalid")
Set language = ThisObject.getClassificationAttributeValue("LanguageCCMAttr", classId)
Trace(2, "Language : ", language)
Set gl = class.getParentLibrary()
Trace(2, "Library : ", gl.Title)
Set parentClass = class.getParentClass()
If (parentClass <> NULL)
{
Trace(2, "Parent Class : ", parentClass.Title)
}
Else
{
Trace(2, "Class is directly under a Library")
}
Set subclasses = parentClass.getSubclasses()
If (subclasses.Size() == 0)
{
Trace(3, "Leaf Class")
}
Else
{
For subclass Inside subclasses
{
Trace(3, "Subclass of parent : ", subclass.Title)
}
}
}Output
No. of Definition Classes : 1
Definition Class : Class1_1
Attribute value for Language : English
Library : DefinitionLib1
Parent Class : DefClass1
Subclass of parent : Class1_1
Subclass of parent : Class1_2
Use case: Retrieve Categorization Class Details
Demonstrates:
- Reading connected Categorization Classes
- Setting a classification attribute
- Reading a classification attribute
- Retrieving the parent library
- Navigating to the parent class
- Listing sub classes
Let classes, subclasses(List)
Let class, subclass(`General Class`)
Let gl(`General Library`)
Let parentClass(`General Class`)
Let classId(String)
Let NoOfTest(Real)
Set classes = ThisObject.getConnectedCategorizationClasses()
Trace(1, "No. of Categorization Classes : ", classes.Size())
For class Inside classes
{
Trace(1, "Categorization Class : ", class.Title)
classId = class.GetAttributeString("physicalid")
ThisObject.setClassificationAttributeValue("NoOfTestCCMAttr",3.0,classId)
Set NoOfTest = ThisObject.getClassificationAttributeValue("NoOfTestCCMAttr", classId)
Trace(2, "Attribute value for NoOfTest : ", NoOfTest)
Set gl = class.getParentLibrary()
Trace(2, "Library : ", gl.Title)
Set parentClass = class.getParentClass()
If (parentClass <> NULL)
{
Trace(2, "Parent Class : ", parentClass.Title)
}
Else
{
Trace(2, "Class is directly under a Library")
}
//Get parent subclasses
Set subclasses = parentClass.getSubclasses()
If (subclasses.Size() == 0)
{
Trace(3, "Leaf Class")
}
Else
{
For subclass Inside subclasses
{
Trace(3, "Subclass of parent : ", subclass.Title)
}
}
}Output
No. of Categorization Classes : 1
Categorization Class : Subclass3
Attribute value for NoOfTest : RealValue[realAsString=3.0, num=3.0]
Library : CategorizationLib1
Parent Class : Subclass2_2
Subclass of parent : Subclass311. Change Action APIs
Note: These APIs are applicable only on Change Action objects.
Purpose
Use these APIs to navigate the Change Management data model from a Change Action. They can be used to retrieve Proposed Changes, Realized Changes, Change Requests, RASCI information, Dependencies, Approval Cycles, and Context Items.
| API | Description |
|---|---|
ChangeAction.getProposedChanges() | Returns the Proposed Changes associated with the Change Action. |
ChangeAction.getRealizedChanges() | Returns the Realized Changes associated with the Change Action. |
ChangeAction.getChangeRASCI() | Returns the Change RASCI object containing assignees, approvers, and followers. |
ChangeAction.getChangeActionDependencies() | Returns the Change Action dependency object for navigating downstream, upstream, and co-dependent changes. |
Proposed Change APIs
| API | Description |
|---|---|
ProposedChange.getWhere() | Returns the business object associated with the Proposed Change. |
ProposedChange.getTarget() | Returns the target version, such as CurrentVersion, NewVersion, or NewBranch. |
ProposedChange.getWhat() | Returns the proposed operation, such as Modify, ChangeMaturityRelease, ChangeMaturityObsolete, or ChangeMaturityRestore. |
ProposedChange.getStatus() | Returns the status of the Proposed Change. |
Realized Change APIs
| API | Description |
|---|---|
RealizedChange.getWhere() | Returns the realized business object. |
RealizedChange.getBefore() | Returns the object before the operation. |
RealizedChange.getAfter() | Returns the object after the operation. |
RealizedChange.getOperations() | Returns the operations performed on the object, such as Create, Add, Clone, NewVersion, or ChangeStatus. |
Change RASCI APIs
| API | Description |
|---|---|
ChangeRASCI.getAssignees() | Returns the Change Action assignees. |
ChangeRASCI.getApprovers() | Returns the Change Action approvers. |
ChangeRASCI.getFollowers() | Returns the Change Action followers. |
Dependency APIs
| API | Description |
|---|---|
ChangeActionDependencies.getDependencyDownstreamChanges() | Returns downstream dependent Change Actions or Change Orders. |
ChangeActionDependencies.getDependencyUpstreamChanges() | Returns upstream dependent Change Actions or Change Orders. |
ChangeActionDependencies.getCodependencyChanges() | Returns co-dependent Change Actions or Change Orders. |
Use Case: Retrieve Proposed Change Details
- Retrieving Proposed Changes
- Reading the Target Version
- Reading the Operation
- Reading the Status
// ThisObject : Change Action
Let proposedChanges(List)
Let proposedChange(ProposedChange)
Let proposedWhere(BusinessType)
Let proposedTarget(String)
Let proposedWhat(String)
Let proposedStatus(String)
Set proposedChanges = ThisObject.getProposedChanges()
Trace(1, "Number of Proposed Changes : ", proposedChanges.Size())
For proposedChange Inside proposedChanges
{
Set proposedWhere = proposedChange.getWhere()
proposedTarget = proposedChange.getTarget()
proposedWhat = proposedChange.getWhat()
proposedStatus = proposedChange.getStatus()
Trace(1, "Object : ", proposedWhere.name)
Trace(2, "Target : ", proposedTarget)
Trace(2, "Operation : ", proposedWhat)
Trace(2, "Status : ", proposedStatus)
}Output
Number of Proposed Changes : 2
Object : mass-8544851-00000397
Target : CurrentVersion
Operation : ChangeMaturityRelease
Status : Not Started
Object : mass-8544851-00000391
Target : CurrentVersion
Operation : Modify
Status : StartedUse Case: Retrieve Change RASCI Information
Let rasci(ChangeRASCI)
Let changeAssignees,changeFollower,changeApprover(List)
Let assignee,follower,approver(String)
Set rasci = ThisObject.getChangeRASCI()
changeAssignees=rasci.getAssignees()
Trace(1, "Assignees : ", rasci.getAssignees().Size())
for assignee inside changeAssignees
{
Trace(1, "assignee : ", assignee)
}
changeApprover=rasci.getApprovers()
Trace(1, "Approvers : ", rasci.getApprovers().Size())
for approver inside changeApprover
{
Trace(1, "approver : ", approver)
}
changeFollower=rasci.getFollowers()
Trace(1, "Followers : ", rasci.getFollowers().Size())
for follower inside changeFollower
{
Trace(1, "follower : ", follower)
}Output
Assignees : 1
assignee : abe26_abe26
Approvers : 2
approver : abe26_abe26
approver : Test Everything
Followers : 1
follower : DemoLeader
Use Case: Retrieve Change Dependencies
/* Define constants */
let changeDependencies (ChangeActionDependencies)
let downstreamDepChanges (List)
let downstreamDepChangesSize (Integer)
let UpstreamDepChanges (List)
let UpstreamDepChangesSize (Integer)
/* By default it's allowed */
Validation = true
/* Proposed Change logic */
set changeDependencies = ThisObject.getChangeActionDependencies()
set downstreamDepChanges = changeDependencies.getDependencyDownstreamChanges()
set downstreamDepChangesSize = downstreamDepChanges.Size()
Trace(1,"downstreamDepChangesSize " ,downstreamDepChangesSize)
set UpstreamDepChanges = changeDependencies.getDependencyUpstreamChanges()
set UpstreamDepChangesSize = UpstreamDepChanges.Size()
Trace(1,"UpstreamDepChangesSize " ,UpstreamDepChangesSize)Output:
downstreamDepChangesSize 1
UpstreamDepChangesSize 0
Use Case: Retrieve Co-dependent Changes
let changeDependencies (ChangeActionDependencies)
let coDepChanges (List)
let coDepChangesSize (Integer)
Validation = true
/* Proposed Change logic */
set changeDependencies = ThisObject.getChangeActionDependencies()
set coDepChanges = changeDependencies.getCodependencyChanges()
set coDepChangesSize = coDepChanges.Size()
Trace(1,"coDepChangesSize " ,coDepChangesSize)Output:
coDepChangesSize 1
Use Case: Retrieve Realized Changes
Demonstrates:
- Retrieving Realized Changes
- Reading Before and After Objects
- Reading Realized Operations
Let realizedChanges(List)
Let realizedChange(RealizedChange)
Let operations(List)
Let operation(String)
Let realizedWhere(BusinessType)
Let realizedBefore(BusinessType)
Let realizedAfter(BusinessType)
Set realizedChanges = ThisObject.getRealizedChanges()
Trace(1,"realized change size= ",realizedChanges.Size())
For realizedChange Inside realizedChanges
{
set realizedWhere = realizedChange.getWhere()
Trace(1, "Realized Item : ", realizedWhere.name)
set realizedBefore = realizedChange.getBefore()
if(realizedBefore<>NULL)
Trace(2, "Before : ", realizedBefore.name)
set realizedAfter = realizedChange.getAfter()
if(realizedAfter<>NULL)
Trace(2, "After : ", realizedAfter.name)
Set operations = realizedChange.getOperations()
For operation Inside operations
{
Trace(2, "Operation : ", operation)
}
}Output
realized change size= 7
Realized Item : prvd-8544851-00000264
After : prvd-8544851-00000264
Operation : Create
Realized Item : mass-8544851-00000403
Before : mass-8544851-00000402
After : mass-8544851-00000403
Operation : Clone
Operation : ChangeStatus#Frozen
Realized Item : mass-8544851-00000402
Operation : Add
Realized Item : mass-8544851-00000402
After : mass-8544851-00000402
Operation : Create
Realized Item : mass-8544851-00000401
Operation : Add
Realized Item : mass-8544851-00000401
After : mass-8544851-00000401
Operation : Create
Realized Item : prvd-8544851-00000264
Before : prvd-8544851-00000264
After : prvd-8544851-00000264
Operation : NewVersionReference
Capable Resource APIs and Sequencing mode API
