PLMProductionSystemAdvFunctionPackage Functions

This section describes the functions of the PLMProductionSystemAdvFunctionPackage.

Note: The "item" objects described in this document were known as "processes" in previous releases. The term "process" is still used in the names of functions, types, methods, attributes, and so on. In this case, "process" now means "item".

This page discusses:

AddCapableResource

Assigns capable resources to a system or operation.

Signature

AddCapableResource(System or Operation Reference : PLMCoreReference, Capable Resource : PLMResource)

Arguments

Name Input / Output Required? Type Comment
System or Operation Reference In PLMCoreReference -
Capable Resource In PLMResource Capable resource reference.

AttachDocumentOnRscDetail

Attaches a document (ISO or DOC) on a resource detail.

Signature

AttachDocumentOnRscDetail(rsc link detail : PLMConnection, document to attach : Feature) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
document to attach In Feature -

ReturnType

Integer

CapableResources

Returns the list of capable resources associated with the system or operation.

Signature

CapableResources(System or Operation Reference : PLMCoreReference) : List

Arguments

Name Input / Output Required? Type Comment
System or Operation Reference In PLMCoreReference -

ReturnType

List

List of resource references.

CreateCapableRscDetail

Creates a capable resource detail and link it to the capable resource link. If the capable resource is a primary capable resource, then the created resource detail becomes also a primary capable resource.

Signature

CreateCapableRscDetail(Capable Rsc Link : PLMConnection, Operation occurrence : ProdSystemOccurrence, Rsc Link detail : PLMConnection) : Integer

Arguments

Name Input/Output Required? Type Comment
Capable Rsc Link In PLMConnection -
Operation occurrence In ProdSystemOccurrence -
Rsc Link detail Out PLMConnection -

ReturnType

Integer

CreateOrModifyTimeConstraint

Defines a time constraint between source and target operation occurrences, defining the constraint delay and type. It is possible to create time constraints between operations that have the same father or a common ancestor.

Signature

CreateOrModifyTimeConstraint(Source System Operation Occurrence : ProdSystemOccurrence, Target System Operation Occurrence : ProdSystemOccurrence, Delay as Real : Real, Constraint Type as Integer (FinishToStart: 1, StartToStart: 2, FinishToFinish: 3) : Integer) : Boolean

Arguments

Name Input / Output Required? Type Comment
Source System Operation Occurrence In ProdSystemOccurrence source operation as ProdSystemOccurrence
Target System Operation Occurrence In ProdSystemOccurrence target operation as ProdSystemOccurrence
Delay as Real In Real delay value as Real
Constraint Type as Integer (FinishToStart: 1, StartToStart: 2, FinishToFinish: 3) In Integer constraint type as Integer

ReturnType

Boolean

Status as Boolean.

Example

let MyPrdSysOcc1(ProdSystemOccurrence)
let MyPrdSysOcc2(ProdSystemOccurrence)
let TimeDelay(Real)
let MyConstraintType(Integer)
MyConstraintType = 2
TimeDelay = 0.5
set MyPrdSysOcc1 = Occ1 //[Occ1 From Argument List, Provided by user selection]
set MyPrdSysOcc2 = Occ2 //[Occ1 From Argument List, Provided by user selection]
CreateOrModifyTimeConstraint(MyPrdSysOcc1,MyPrdSysOcc2,TimeDelay,MyCons)

CreateOrgRscForRscPositioning

Creates an organisation resource and link it to the input process. A process can be linked to one resource at a time. If the link is broken in DB, it is removed and a new one is created.

Signature

CreateOrgRscForRscPositioning(A System Or Operation Reference : PLMCoreReference, A Resource Reference : PLMResource) : Integer

Arguments

Name Input/Output Required? Type Comment
A System Or Operation Reference In PLMCoreReference -
A Resource Reference Out PLMResource -

ReturnType

Integer

CreateScopeAndSetUsagePointTarget

Creates a scope link between a service workplan or service header workplan and a service item occurrence and a return scope connection.

Signature

CreateScopeAndSetUsagePointTarget(Production System Occurrence : ProdSystemOccurrence, MBOM Occurrence : FProcessOccurrence, Service Item Occurrence for usage point target : FProcessOccurrence, Implement Link connection : MfgProductionPlanning) : Boolean

Arguments

Name Input/Output Required? Type Comment
Production System Occurrence In ProdSystemOccurrence -
MBOM Occurrence In FProcessOccurrence -
Service Item Occurrence for usage point target In FProcessOccurrence -
Implement Link connection Out MfgProductionPlanning -

ReturnType

Boolean

Example

Let RootSystemOcc(ProdSystemOccurrence)
Let RootProcessOcc(FProcessOccurrence)
Let ServiceItemOccForUsagePointTarget(FProcessOccurrence)
Let oScopeCnx(MfgProductionPlanning)
Let returncode (Boolean)
set RootSystemOcc = Occ1 //[Occ1 from Argument List, given by user selection]
set RootProcessOcc = Occ2 //[Occ2 from Argument List, given by user selection]
set ServiceItemOccForUsagePointTarget = Occ3 //[Occ3 from Argument List, given by user selection]
if(NULL <> RootSystemOcc and NULL <> RootProcessOcc and  NULL <> ServiceItemOccForUsagePointTarget)
{
 Set returncode = CreateScopeAndSetUsagePointTarget(RootSystemOcc,RootProcessOcc,ServiceItemOccForUsagePointTarget,oScopeCnx)
}"

DeleteAllAttachedDocumentsOnRscDetail

Deletes all documents (ISO or DOC) on a resource detail.

Signature

DeleteAllAttachedDocumentsOnRscDetail(rsc link detail : PLMConnection) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -

ReturnType

Integer

DeleteAttachedDocumentOnRscDetail

Deletes a document (ISO or DOC) on a resource detail.

Signature

DeleteAttachedDocumentOnRscDetail(rsc link detail : PLMConnection, document to remove : Feature) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
document to remove In Feature -

ReturnType

Integer

GetApplicabilityModeOnCapRscOrRscDetail

Gets the applicability mode of the resource link detail or capable resource link.

Signature

GetApplicabilityModeOnCapRscOrRscDetail(rsc link detail or CapRscLink : PLMConnection, string applicability mode : String) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail or CapRscLink In PLMConnection -
string applicability mode Out String -

ReturnType

Integer

GetAssignedOperations

Returns the list of operations assigned to an item occurrence.

Signature

GetAssignedOperations(Manufactured Item Occurrence : FProcessOccurrence) : List

Arguments

Name Input / Output Required? Type Comment
Manufactured Item Occurrence In FProcessOccurrence -

ReturnType

List

GetAttachedDocumentsOnRscDetail

Gets the attached documents (ISO or DOC) on a given resource detail.

Signature

GetAttachedDocumentsOnRscDetail(rsc link detail : PLMConnection, list of documents : List) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
list of documents Out List -

ReturnType

Integer

GetAvailabilityModeOnResourceDetail

Gets the availability mode of the resource link detail.

Signature

GetAvailabilityModeOnResourceDetail(rsc link detail : PLMConnection, string availability mode : String) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
string availability mode Out String -

ReturnType

Integer

GetBuildUpPosition

Gets the build-up position on the input resource link detail and the referential subresource.

Signature

GetBuildUpPosition(capable rsc link or rsc link detail : PLMConnection, list of double : List, resource occ : ResourceOccurrence, boolean for force loading : Boolean, Status : String, zombie alias : String) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rsc link detail In PLMConnection -
list of double Out List -
resource occ Out ResourceOccurrence -
boolean for force loading In Boolean -
Status Out String -
zombie alias Out String -

ReturnType

Integer

GetCapableResourceQuantity

Gets the quantity value associated with the provided capable resource and assigned to this system or operation.

Signature

GetCapableResourceQuantity(SystemOperationReference, CapableResource) : Integer

Arguments

Name Input / Output Required? Type Comment
SystemOperationReference In PLMCoreReference The system or operation on which the capable resource reference is defined.
CapableResource In PLMResource The capable resource reference.

ReturnType

Integer

The quantity value associated with the capable resource for this system or operation.

Example

Let MySysRef(PLMCoreReference)
Let MyResource(PLMResource)
Let I(Integer)
Set MySysRef = Ref//[Ref from Argument List, Provided by User Selection]
Set MyResource = Resource1//[Resource1 from Argument List, Provided by User Selection]
I = GetCapableResourceQuantity(MySysRef,MyResource)

GetCapableRscLinkFromRscDetail

Gets the capable resource link that is pointed with a symbolic link from the current resource link detail.

Signature

GetCapableRscLinkFromRscDetail(rsc link detail : PLMConnection, step operation occ : ProdSystemOccurrence, capable rsc link : List) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
step operation occ In ProdSystemOccurrence -
capable rsc link Out List -

ReturnType

Integer

GetCapableRscLinkFromRscUsage

Gets the capable resource link that points with a symbolic link the input resource usage.

Signature

GetCapableRscLinkFromRscUsage(resource instance : VPMInstance, Capable Rsc Links : List) : Integer

Arguments

Name Input/Output Required? Type Comment
resource instance In VPMInstance -
Capable Rsc Links Out List -

ReturnType

Integer

GetIsReservedOnCapableRsc

Gets whether the capable primary resource is reserved from this step or not.

Signature

GetIsReservedOnCapableRsc(primary capable rsc link : PLMConnection, boolean isReserved : Boolean) : Integer

Arguments

Name Input/Output Required? Type Comment
primary capable rsc link In PLMConnection -
boolean isReserved Out Boolean -

ReturnType

Integer

GetOrgResourceFromProcess

Gets the organizational resource that is linked to the process. If it is not loaded, you can request a forced load.

Signature

GetOrgResourceFromProcess(A System Or Operation Reference : PLMCoreReference, A Resource Reference : PLMResource, Boolean for force load : Boolean, Status : String, Zombie Alias : String) : Integer

Arguments

Name Input/Output Required? Type Comment
A System Or Operation Reference In PLMCoreReference -
A Resource Reference Out PLMResource -
Boolean for force load In Boolean -
Status Out String -
Zombie Alias Out String -

ReturnType

Integer

GetReferentialPositionInfoForRsc

Gets the reference position of this current resource detail or capable resource link.

Signature

GetReferentialPositionInfoForRsc(cap rsl link or rsc link detail : PLMConnection, context prod system occ : ProdSystemOccurrence, String position mode : String, cap rsl link : List, Rsc Sub Occ : ResourceOccurrence, boolean force load : Boolean, Status : String, zombie alias : String) : Integer

Arguments

Name Input/Output Required? Type Comment
cap rsl link or rsc link detail In PLMConnection -
context prod system occ In ProdSystemOccurrence -
String position mode Out String -
cap rsl link Out List -
Rsc Sub Occ Out ResourceOccurrence -
boolean force load In Boolean -
Status Out String -
zombie alias Out String -

ReturnType

Integer

GetResourcePosition

Gets the position on the current object (capable resource or resource detail).

Signature

GetResourcePosition(capable rsc link or rscl link detail : PLMConnection, list of double : List) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rscl link detail In PLMConnection -
list of double Out List -

ReturnType

Integer

GetRscLinkDetailsFromCapableRsc

Gets the resource link detail that points with a symbolic link the input capable resource link.

Signature

GetRscLinkDetailsFromCapableRsc(capable rsc link : PLMConnection, Step Operation Occ : ProdSystemOccurrence, rsc link detail : List) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link In PLMConnection -
Step Operation Occ In ProdSystemOccurrence -
rsc link detail Out List -

ReturnType

Integer

GetSystemOfEachScope

Returns the manufacturing systems having a scope link with an item reference.

Signature

GetSystemOfEachScope(Manufactured Item Reference : DELFmiFunctionReference) : List

Arguments

Name Input / Output Required? Type Comment
Manufactured Item Reference In DELFmiFunctionReference -

ReturnType

List

Manufacturing systems as list of PLMSystem.

GetTimeConstraintInfo

Returns the time constraint information between the source operation and the target operation.

Signature

GetTimeConstraintInfo(The source System Operation Occurrence : ProdSystemOccurrence, The target System Operation Occurrence : ProdSystemOccurrence, Constaint Type as Integer (FinishToStart: 1, StartToStart: 2, FinishToFinish: 3) : Integer, Delay as Real : Real) : Boolean

Arguments

Name Input / Output Required? Type Comment
The source System Operation Occurrence In ProdSystemOccurrence source operation as ProdSystemOccurrence
The target System Operation Occurrence In ProdSystemOccurrence target operation as ProdSystemOccurrence
Constaint Type as Integer (FinishToStart: 1, StartToStart: 2, FinishToFinish: 3) Out Integer constraint type as Integer
Delay as Real Out Real delay value as Real

ReturnType

Boolean

Example

let MyPrdSysOcc1(ProdSystemOccurrence)
let MyPrdSysOcc2(ProdSystemOccurrence)
let TimeDelay(Real)
let Bool(Boolean)
let MyConstraintType(Integer)
MyConstraintType = 2
TimeDelay = 0.5
set MyPrdSysOcc1 = Occ1 //[Occ1 From Argument List, Provided by user selection]
set MyPrdSysOcc2 = Occ2 //[Occ1 From Argument List, Provided by user selection]
set Bool = GetTimeConstraintInfo(MyPrdSysOcc1,MyPrdSysOcc2,MyConstraintType,TimeDelay) 
Message("Status",Bool)

GetUsagePointSourceFromTarget

Gets the service workplan process occurrence and scope implementation connection from the input usage point target SBOM occurrence.

Signature

GetUsagePointSourceFromTarget(Service Item Occurrence for usage point target : FProcessOccurrence, Context where the output occurrences of Service Work Plan are computed : PLMCoreReference, The List Of Scope Cnxs : List, The List Of Service Work plan Occurrences. : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
Service Item Occurrence for usage point target In FProcessOccurrence -
Context where the output occurrences of Service Work Plan are computed In PLMCoreReference -
The List Of Scope Cnxs Out List -
The List Of Service Work plan Occurrences Out List -

ReturnType

Boolean

Example

Let serviceItemOcc(FProcessOccurrence)
Let ContextForOutputServiceWorkplanProc(DELFmiFunctionReference)
Let ListOfServiceWorkPlanProcOcc(List)
Let ListOfScopeCnxs(List)
Let returncode (Boolean)
set serviceItemOcc = occ1 //[occ1 from Argument List, given by user selection]
set ContextForOutputServiceWorkplanProc = context2 //[context2 from Argument List, given by user selection]
if(NULL <> serviceItemOcc and NULL <> ContextForOutputServiceWorkplanProc )
{
Set returncode = GetUsagePointSourceFromTarget(serviceItemOcc, ContextForOutputServiceWorkplanProc, ListOfScopeCnxs, ListOfServiceWorkPlanProcOcc)
}";

GetUsagePointTarget

Gets the list of usage point target occurrences, PLM IDs, statuses, and aliases in context from input implement link connection.

Signature

GetUsagePointTarget(Implement Link connection : MfgProductionPlanning, Context where the output occurrences of Service Items are computed : DELFmiFunctionReference, The List Of Item Occurrences : List, The List Of Statuses : List, List of Alias : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
Implement Link connection In MfgProductionPlanning -
Context where the output occurrences of Service Items are computed In DELFmiFunctionReference -
The List Of Item Occurrences Out List -
The List Of Statuses Out List -
List of Alias Out List -

ReturnType

Boolean

Example

Let ScopeCnx(MfgProductionPlanning)
Let ContextForOutputMBOM(DELFmiFunctionReference)
Let ListOfServiceItemOccurrence(List)
Let ListOfStatus(List)
Let ListOfAlias(List)
set ScopeCnx = ScopeCnx1 //[ScopeCnx1 from Argument List, given by user selection]
set ContextForOutputMBOM = context2 //[context2 from Argument List, given by user selection]
if(NULL <> ScopeCnx and NULL <> ContextForOutputMBOM )
{
GetUsagePointTarget(ScopeCnx, ContextForOutputMBOM, ListOfServiceItemOccurrence, ListOfStatus, ListOfAlias)
}";

GetUsagePointTargetFromSource

Gets the usage point target (SBOM) occurrence, scope implementation connection, PLM IDs, statuses, and aliases from input service workplan process occurrence or service header workplan process occurrence.

Signature

GetUsagePointTargetFromSource(Production System Occurrence : ProdSystemOccurrence, Context where the output occurrences of Service Items are computed : DELFmiFunctionReference, Implement Link connection : MfgProductionPlanning, The List Of Service Item Occurrences : List, The List Of Statuses : List, List of Alias : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
Production System Occurrence In ProdSystemOccurrence -
Context where the output occurrences of Service Items are computed In DELFmiFunctionReference -
Implement Link connection Out MfgProductionPlanning -
The List Of Service Item Occurrences Out List -
The List Of Statuses Out List -
List of Alias Out List -

ReturnType

Boolean

Example

Let RootSystemOcc(ProdSystemOccurrence)
Let ContextForOutputMBOM(DELFmiFunctionReference)
Let ScopeCnx(MfgProductionPlanning)
Let ListOfServiceItemOccurrence(List)
Let ListOfStatus(List)
Let ListOfAlias(List)
set RootSystemOcc = occ1 //[occ1 from Argument List, given by user selection]
set ContextForOutputMBOM = context2 //[context2 from Argument List, given by user selection]
if(NULL <> RootSystemOcc and NULL <> ContextForOutputMBOM )
{
GetUsagePointTargetFromSource(RootSystemOcc, ContextForOutputMBOM, ScopeCnx, ListOfServiceItemOccurrence, ListOfStatus, ListOfAlias)
}";

IsARscUsage

Verifies if the resource usage has already the extension for the symbolic ID.

Signature

IsARscUsage(resource instance : VPMInstance, Boolean is resource usage : Boolean) : Integer

Arguments

Name Input/Output Required? Type Comment
resource instance In VPMInstance -
Boolean is resource usage Out Boolean -

ReturnType

Integer

RemoveBuildUpPosition

Removes the build up position and the referential sub-resource on the input resource link detail.

Signature

RemoveBuildUpPosition(capable rsc link or rsc link detail : PLMConnection) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rsc link detail In PLMConnection -

ReturnType

Integer

RemoveCapableResources

Removes the capable resources assigned to a system or operation.

Signature

RemoveCapableResources(System or Operation Reference : PLMCoreReference, Capable Resource : PLMResource)

Arguments

Name Input / Output Required? Type Comment
System or Operation Reference In PLMCoreReference -
Capable Resource In PLMResource Capable resource reference.

RemoveCapableRscDetail

Removes a resource link detail.

Signature

RemoveCapableRscDetail(rsc link detail : PLMConnection, Aggregation Reference : PLMCoreReference) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
Aggregation Reference In PLMCoreReference -

ReturnType

Integer

RemoveTimeConstraint

Removes a time constraint between two operation occurrences.

Signature

RemoveTimeConstraint(Source System Operation Occurrence : ProdSystemOccurrence, Target System Operation Occurrence : ProdSystemOccurrence)

Arguments

Name Input / Output Required? Type Comment
Source System Operation Occurrence In ProdSystemOccurrence source operation as ProdSystemOccurrence
Target System Operation Occurrence In ProdSystemOccurrence target operation as ProdSystemOccurrence

Example

Let MyProdSysOcc1(ProdSystemOccurrence)
Let MyProdSysOcc2(ProdSystemOccurrence)
let Bool(Boolean)
set MyProdSysOcc1 = Occ1//[Occ1 From Argument List, Provided by user selection]
set MyProdSysOcc2 = Occ2//[Occ2 From Argument List, Provided by user selection]
set Bool = RemoveTimeConstraint(MyProdSysOcc1,MyProdSysOcc2)

SetApplicabilityModeOnCapRscOrRscDetail

Specifies the applicability mode of the resource link detail or capable resource link.

Signature

SetApplicabilityModeOnCapRscOrRscDetail(rsc link detail or CapRscLink : PLMConnection, string applicability mode : String) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail or CapRscLink In PLMConnection -
string applicability mode In String -

ReturnType

Integer

SetAvailabilityModeOnResourceDetail

Specifies the availability mode of the resource link detail.

Signature

SetAvailabilityModeOnResourceDetail(rsc link detail : PLMConnection, string availability mode : String) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc link detail In PLMConnection -
string availability mode In String -

ReturnType

Integer

SetBuildUpPosition

Specifies the build up position on the input primary resource link detail or primary capable resource link.

Signature

SetBuildUpPosition(capable rsc link or rsc link detail : PLMConnection, operation occ : ProdSystemOccurrence, list of double : List, rsc occ : ResourceOccurrence) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rsc link detail In PLMConnection -
operation occ In ProdSystemOccurrence -
list of double In List -
rsc occ In ResourceOccurrence -

ReturnType

Integer

SetCapableResourceQuantity

Defines a quantity to the provided capable resource that is assigned to the input system or operation.

Signature

SetCapableResourceQuantity(System or Operation Reference : PLMCoreReference, Capable Resource : PLMResource, Quantity : Integer)

Arguments

Name Input / Output Required? Type Comment
System or Operation Reference In PLMCoreReference -
Capable Resource In PLMResource Capable resource reference.
Quantity In Integer The quantity value to be defined on the capable resource.

SetIsReservedOnCapableRsc

Specifies if the capable resource is reserved from this step onward.

Signature

SetIsReservedOnCapableRsc(primary capable rsc link : PLMConnection, boolean isReserved : Boolean) : Integer

Arguments

Name Input/Output Required? Type Comment
primary capable rsc link In PLMConnection -
boolean isReserved In Boolean -

ReturnType

Integer

SetReferentialPositionInfoForRsc

Specifies the referential position of the input resource detail or capable resource link. The referential position cannot be a resource detail. This API specifies also the position mode (is it positioned according to the build up, sub-resource, etc).

Signature

SetReferentialPositionInfoForRsc(capable rsc link or rsc detail : PLMConnection, capable rsc link : PLMConnection, context operation occ : ProdSystemOccurrence, string position mode : String, sub rsc occurrence  : ResourceOccurrence) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rsc detail In PLMConnection -
capable rsc link In PLMConnection -
context operation occ In ProdSystemOccurrence -
string position mode In String -
sub rsc occurrence In ResourceOccurrence -

ReturnType

Integer

SetResourcePosition

Specifies the position on the input object that can be a capable resource or a resource detail.

Signature

SetResourcePosition(capable rsc link or rsc link detail : PLMConnection, list of double : List) : Integer

Arguments

Name Input/Output Required? Type Comment
capable rsc link or rsc link detail In PLMConnection -
list of double In List -

ReturnType

Integer

SetUsagePointTarget

Defines the usage point on the scope link between a service workplan (or service header workplan) and a service item occurrence.

Signature

SetUsagePointTarget(Implement Link connection : MfgProductionPlanning, Service Item Occurrence for usage point target : FProcessOccurrence) : Boolean

Arguments

Name Input/Output Required? Type Comment
Implement Link connection In MfgProductionPlanning -
Service Item Occurrence for usage point target In FProcessOccurrence -

ReturnType

Boolean

Example

Let RootSystemOcc(ProdSystemOccurrence)
Let RootProcessOcc(FProcessOccurrence )
Let ServiceItemOccForUsagePointTarget(FProcessOccurrence )
Let oScopeCnx(MfgProductionPlanning)
Let returncode (Boolean)
set RootSystemOcc = Occ1 //[Occ1 from Argument List, given by user selection]
set RootProcessOcc = Occ2 //[Occ2 from Argument List, given by user selection]
set ServiceItemOccForUsagePointTarget = Occ3 //[Occ3 from Argument Lis, given by user selection]
if(NULL <> RootSystemOcc and NULL <> RootProcessOcc and  NULL <> ServiceItemOccForUsagePointTarget)
{
 Set returncode = CreateScopeAndSetUsagePointTarget(RootSystemOcc,RootProcessOcc,ServiceItemOccForUsagePointTarget,oScopeCnx)
}";

UnsetUsagePointTarget

Removes the SBOM occurrence usage point target from the input implement link connection.

Signature

UnsetUsagePointTarget(Implement Link connection : MfgProductionPlanning) : Boolean

Arguments

Name Input/Output Required? Type Comment
Implement Link connection In MfgProductionPlanning -

ReturnType

Boolean

Example

Let ScopeCnx(MfgProductionPlanning)
Let returncode (Boolean)
set ScopeCnx = ScopeCnx1 //[ScopeCnx1 from Argument List, given by user selection]
if(NULL <> ScopeCnx and NULL <> ServiceItemOccForUsagePointTarget)
{
Set returncode = UnsetUsagePointTarget(ScopeCnx)
}";

UpdateSymbolicIDOfObject

Updates the symbolic ID of a resource usage, capable resource link, or resource detail.

Signature

UpdateSymbolicIDOfObject(rsc instance : VPMInstance) : Integer

Arguments

Name Input/Output Required? Type Comment
rsc instance In VPMInstance -

ReturnType

Integer

DELAsmProcessCanUseCnx.GetSecondaryFromPrimary()

Gets secondary link associated to the provided ProcessCanUseCnx element.

Signature

DELAsmProcessCanUseCnx.GetSecondaryFromPrimary() : List

ReturnType

List

Example

Let ProcessCanUseCnx(DELAsmProcessCanUseCnx)
Let oListOfSecCapRscLinks(List)
Set ProcessCanUseCnx = iProcessCanUseCnx //[iProcessCanUseCnx From Argument List, Provided by user selection]
ProcessCanUseCnx->GetSecondaryFromPrimary(oListOfSecCapRscLinks)
";

DELAsmProcessCanUseCnx.SetCapableRscGroupIndex()

Moves resource pointed by this PCU connection in target group by changing the V_CapableRscGroupIndex attribute value.

Signature

DELAsmProcessCanUseCnx.SetCapableRscGroupIndex(Group index : Integer, Set Group Index Error status. : SetCapableRscGroupIndexStatus) : Integer

Arguments

Name Input/Output Required? Type Comment
Group index In Integer -
Set Group Index Error status. Out SetCapableRscGroupIndexStatus -

ReturnType

Integer

Example

Let oReturnInt(Integer)
Let SetGrpIndexStatusEnum(SetCapableRscGroupIndexStatus)
Let PCUCnx(DELAsmProcessCanUseCnx)
Let GroupIndexVal(Integer)
set PCUCnx = iPCUcnx //[iPCUcnx from Argument List, given by user selection]
set GroupIndexVal = iGroupIndexVal //[iPCUcnx from Argument List, given by user selection]
set ContextForOutputServiceWorkplanProc = context2 //[context2 from Argument List, given by user selection]
set oReturnInt=PCUCnx.SetCapableRscGroupIndex(GroupIndexVal, SetGrpIndexStatusEnum)
";

DELLmiCandidateResourcesCnx.LoadCandidateRscScopeOrSecondary()

Loads the target of capable resource scope or secondary link.

Signature

DELLmiCandidateResourcesCnx.LoadCandidateRscScopeOrSecondary(Load Mode: 1(Load Target Only) or 2(load Target With Children) : Integer, Status : Integer, Alias : String) : PLMResource

Arguments

Name Input/Output Required? Type Comment
Load Mode: 1(Load Target Only) or 2(load Target With Children) In Integer -
Status Out Integer -
Alias Out String -

ReturnType

PLMResource

Example

let CandidateResourcesCnx(DELLmiCandidateResourcesCnx)
let LoadMode(Integer)
let Status(Integer)
let Alias(String)
set CandidateResourcesCnx = iCandidateResourcesCnx //[iCandidateResourcesCnx from Argument List, Provided by User Selection]
set LoadMode = 1
CandidateResourcesCnx->LoadCandidateRscScopeOrSecondary(LoadMode,Status,Alias)
";

PLMConnection.AddEstimatedTimeExtension()

Adds DELLmiEstimatedTimeExtension to the capable resource link or ProcessCanUseCnx.

Signature

PLMConnection.AddEstimatedTimeExtension() : Integer

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->AddEstimatedTimeExtension()
";

PLMConnection.AddLogisticExtension()

Adds DELLmiLogisticExt to the candidate resource link or ProcessCanUseCnx.

Signature

PLMConnection.AddLogisticExtension() : Integer

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->AddLogisticExtension()
";

PLMConnection.AddQtyToBeProducedPerTime()

Adds DELLmiQtyToBeProducedPerTime extension to the capable resource link or the ProcessCanUseCnx.

Signature

PLMConnection.AddQtyToBeProducedPerTime(QtyToBeProducedPerTime Magnitude as Integer (Each: 0, Area: 1, Length: 2, Weight: 3, Volume: 4) : Integer) : Integer

Arguments

Name Input/Output Required? Type Comment
QtyToBeProducedPerTime Magnitude as Integer (Each: 0, Area: 1, Length: 2, Weight: 3, Volume: 4) In Integer -

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->AddQtyToBeProducedPerTime(1)
";

PLMConnection.AddRelativePositionExtension()

Adds DELLmi_relativePositionExtension to the capable resource link or the ProcessCanUseCnx.

Signature

PLMConnection.AddRelativePositionExtension() : Integer

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->AddRelativePositionExtension()
";

PLMConnection.DeleteAllAttachedDocument()

Detaches all the document from the capable resource link or ProcessCanUseCnx.

Signature

PLMConnection.DeleteAllAttachedDocument()

Example

let CandRscOrProcessCanUseCnx(PLMConnection)
set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx from Argument List, Provided by User Selection]
CandRscOrProcessCanUseCnx->DeleteAllAttachedDocument()
";

PLMConnection.DeleteAttachedDocument()

Detaches the document from the capable resource link or ProcessCanUseCnx.

Signature

PLMConnection.DeleteAttachedDocument(A Document To DeAttach : Feature)

Arguments

Name Input/Output Required? Type Comment
A Document To DeAttach In Feature -

Example

let CandRscOrProcessCanUseCnx(PLMConnection)
let document(Feature)
set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx from Argument List, Provided by User Selection]
set document = iDoc //[iDoc from Argument List, Provided by User]
CandRscOrProcessCanUseCnx->DeleteAttachedDocument(Document)
";

PLMConnection.GetAttachedDocuments()

Gets all documents associated to the provided capable resource link.

Signature

PLMConnection.GetAttachedDocuments() : List

ReturnType

List

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Let oListOfDocuments(List)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->GetAttachedDocuments(oListOfDocuments)
";

PLMConnection.GetRelativePosition()

Gets the attribute V_CandidateResourceRelativePosition on provided capables or candidates a resource link.

Signature

PLMConnection.GetRelativePosition() : List

ReturnType

List

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Let oListOfDouble(List)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
CandRscOrProcessCanUseCnx->GetRelativePosition(oListOfDouble)
";

PLMConnection.SetRelativePosition()

Sets the attribute V_CandidateResourceRelativePosition to CandidateResourceLink or ProcessCanUseCnx.

Signature

PLMConnection.SetRelativePosition(position As ListofDoubleValue : List) : Integer

Arguments

Name Input/Output Required? Type Comment
position As ListofDoubleValue In List -

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Let ListofDouble(List)
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List,Provided by user selection]
CandRscOrProcessCanUseCnx->SetRelativePosition(ListofDouble)
";

PLMConnection.SetResourcesQuantity()

Sets the V_ResourcesQuantity attribute to the capable resource link or ProcessCanUseCnx.

Signature

PLMConnection.SetResourcesQuantity(Quantity As DoubleValue : Real) : Integer

Arguments

Name Input/Output Required? Type Comment
Quantity As DoubleValue Out Real -

ReturnType

Integer

Example

Let CandRscOrProcessCanUseCnx(PLMConnection)
Let iResourceQuantity(Real)
Set iResourceQuantity = 2.0
Set CandRscOrProcessCanUseCnx = iCandRscOrProcessCanUseCnx //[iCandRscOrProcessCanUseCnx From Argument List, Provided by user selection]
SecondaryCandidateRscLink->SetResourcesQuantity(iResourceQuantity)
";

PLMCoreReference.GetAllOutputCnxToProcesses()

Retrieves the list of output connections that are connected to the system or operation.

Signature

PLMCoreReference.GetAllOutputCnxToProcesses(System IO Port : DELLmiProdSystemIOPort, Load Mode: 1(No load),2(Load Target Only) or 3(load Target With Children) : Integer, List Of Output Processes : List, List of Process Status : List, List of Process Alias : List) : List

Arguments

Name Input/Output Required? Type Comment
System IO Port In DELLmiProdSystemIOPort -
Load Mode: 1(No load),2(Load Target Only) or 3(load Target With Children) In Integer -
List Of Output Processes Out List -
List of Process Status Out List -
List of Process Alias Out List -

ReturnType

List

Example

let MyPrdSysOperRef(PLMCoreReference)
let ListOfOutputCnx(List)
let ListOfOutputProcess(List)
let ListOfObjectsStatus(List)
let ListOfObjectsAlias(List)
let LoadMode(Integer)
let spPort(DELLmiProdSystemIOPort)
set MyPrdSysOperRef = Ref //[Ref from Argument List, Provided by User Selection]
set spPort = port //[from Argument List, Provided by User]
set LoadMode = 2
ListOfOutputCnx =MyPrdSysOperRef->GetAllOutputCnxToProcesses(spPort,LoadMode,ListOfOutputProcess,ListOfObjectsStatus,ListOfObjectsAlias)
";

PLMCoreReference.GetAllOutputCnxToProducts()

Retrieves the list of output connections that are connected to the system or operation.

Signature

PLMCoreReference.GetAllOutputCnxToProducts(System IO Port : DELLmiProdSystemIOPort, Load Mode: 1(No load),2(Load Target Only) or 3(load Target With Children) : Integer, List Of Output Products : List, List of Product Status : List, List of Product Alias : List) : List

Arguments

Name Input/Output Required? Type Comment
System IO Port In DELLmiProdSystemIOPort -
Load Mode: 1(No load),2(Load Target Only) or 3(load Target With Children) In Integer -
List Of Output Products Out List -
List of Product Status Out List -
List of Product Alias Out List -

ReturnType

List

Example

let MyPrdSysOperRef(PLMCoreReference)
let ListOfOutputCnx(List)
let ListOfOutputProducts(List)
let ListOfObjectsStatus(List)
let ListOfObjectsAlias(List)
let LoadMode(Integer)
let spPort(DELLmiProdSystemIOPort)
set MyPrdSysOperRef = Ref //[Ref from Argument List, Provided by User Selection]
set spPort = port //[from Argument List, Provided by User]
set LoadMode = 2
ListOfOutputCnx =MyPrdSysOperRef->GetAllOutputCnxToProducts(spPort,LoadMode,ListOfOutputProducts,ListOfObjectsStatus,ListOfObjectsAlias)
";

PLMCoreReference.GetCapablePrimaryResources()

Retrieves the target resource list and the ProcessCanUseCnx list.

Signature

PLMCoreReference.GetCapablePrimaryResources(List of Resource reference : List, List of ProcessCanUseCnx : List)

Arguments

Name Input/Output Required? Type Comment
List of Resource reference Out List -
List of ProcessCanUseCnx Out List -

Example

let SystemOrOpnRef(PLMCoreReference)
let ListResourceReference (List)
let ListProcessCanUseCnx(List)
set SystemOrOpnRef = Ref //[Ref from Argument List, Provided by User Selection]
SystemOrOpnRef->GetCapablePrimaryResources(ListResourceReference,ListProcessCanUseCnx)
";

PLMCoreReference.GetListOfGlobalLinkedRequirements()

Gets or loads the requirement specifications linked with global specification links.

Signature

PLMCoreReference.GetListOfGlobalLinkedRequirements(List of Requirements : List, List of specification links : List, Force Load mode : Boolean)

Arguments

Name Input/Output Required? Type Comment
List of Requirements Out List -
List of specification links Out List -
Force Load mode In Boolean -

Example

let SystemOrOpnRef(PLMCoreReference)
let ForceLoadmode(Boolean)
let Listofspecificationlinks(List)
let ListofRequirements(List)
set SystemOrOpnRef = Ref //[Ref from Argument List, Provided by User Selection]
SystemOrOpnRef->GetListOfGlobalLinkedRequirements(ListofRequirements,Listofspecificationlinks,ForceLoadmode)
";

PLMCoreReference.GetListOfLinkedRequirements()

Gets or loads the linked requirements.

Signature

PLMCoreReference.GetListOfLinkedRequirements(List of Requirements : List, List of HowToUsage attributes : List, List of specification links : List, List of specification links : Boolean)

Arguments

Name Input/Output Required? Type Comment
List of Requirements Out List -
List of HowToUsage attributes Out List -
List of specification links Out List -
List of specification links In Boolean -

Example

let SystemOrOpnRef(PLMCoreReference)
let ForceLoadmode(Boolean)
let ListofHowToUsageAttributes(List)
let Listofspecificationlinks(List)
let ListofRequirements(List)
set SystemOrOpnRef = Ref //[Ref from Argument List,Provided by User Selection]
SystemOrOpnRef->GetListOfLinkedRequirements(ListofRequirements,ListofHowToUsageAttributes,Listofspecificationlinks,ForceLoadmode)
";

PLMCoreReference.GlobalLinkToRequirement()

Links the system, operation, or MBOM to the requirement with a global specification link.

Signature

PLMCoreReference.GlobalLinkToRequirement( A Requirement : Feature)

Arguments

Name Input/Output Required? Type Comment
A Requirement In Feature -

Example

let SystemOrOpnRef(PLMCoreReference)
let MyRequirement(Feature)
set SystemOrOpnRef = Ref //[Ref from Argument List, Providede by User Selection]
set MyRequirement = MyReq //[from Argument List, Provided by User]
SystemOrOpnRef->GlobalLinkToRequirement(MyRequirement)
";

PLMCoreReference.LoadCapablePrimaryResources()

Loads the list of assigned resources.

Signature

PLMCoreReference.LoadCapablePrimaryResources(Load Mode: 1(Load Target Only) or 2(load Target With Children) : Integer, List of Resource reference : List, List of ProcessCanUseCnx : List)

Arguments

Name Input/Output Required? Type Comment
Load Mode: 1(Load Target Only) or 2(load Target With Children) In Integer -
List of Resource reference Out List -
List of ProcessCanUseCnx Out List -

Example

let SystemOrOpnRef(PLMCoreReference)
let LoadMode(Integer)
let ListResourceReference (List)
let ListProcessCanUseCnx(List)
set SystemOrOpnRef = Ref //[Ref from Argument List, Provided by User Selection]
set LoadMode = 1
SystemOrOpnRef->LoadCapablePrimaryResources(LoadMode,ListResourceReference,ListProcessCanUseCnx)
";

PLMCoreReference.RemoveGlobalLinkToRequirement()

Deletes the global specification link between the system, operation, or MBOM and the requirement specification.

Signature

PLMCoreReference.RemoveGlobalLinkToRequirement( A Requirement : Feature)

Arguments

Name Input/Output Required? Type Comment
A Requirement In Feature -

Example

let SystemOrOpnRef(PLMCoreReference)
let MyRequirement(Feature)
set SystemOrOpnRef = Ref //[Ref from Argument List,Providede by User Selection]
set MyRequirement = MyReq //[from Argument List, Provided by User]
SystemOrOpnRef->RemoveGlobalLinkToRequirement(MyRequirement)
";

PLMCoreReference.RemoveLinkToRequirement()

Deletes the link between the system, operation, or MBOM and the requirement.

Signature

PLMCoreReference.RemoveLinkToRequirement( A Requirement : Feature, HowToUsage attribute : String, IsIgnoreUsage attribute : Boolean)

Arguments

Name Input/Output Required? Type Comment
A Requirement In Feature -
HowToUsage attribute In String -
IsIgnoreUsage attribute In Boolean -

Example

let SystemOrOpnRef(PLMCoreReference)
let MyRequirement(Feature)
let HowToUsageAttributeName(String)
let IsIgnoreUsageAttribute(Boolean)
set SystemOrOpnRef = Ref //[Ref from Argument List,Provided by User Selection]
set MyRequirement = MyReq //[from Argument List, Provided by User]
SystemOrOpnRef->RemoveLinkToRequirement(MyRequirement,HowToUsageAttributeName,IsIgnoreUsageAttribute)
";

PLMCoreReference.SetSequencingMode()

Sets the V_SequencingMode attribute to the aggregating system or operation reference. This method does not support Proxy, so it will not work in the PLMIdentificationInitialization business logic, for example.

Signature

PLMCoreReference.SetSequencingMode(Sequence Mode : Advanced and Linear : String) : Integer

Arguments

Name Input/Output Required? Type Comment
Sequence Mode : Advanced and Linear In String -

ReturnType

Integer

Example

Let AggregatingReference(PLMCoreReference )
Let iSequencingMode(String )
Set AggregatingReference = iAggregatingReference //[iAggregatingReference From Argument List, Provided by user selection]
AggregatingReference->SetSequencingMode(iSequencingMode)
";

PLMResource.GetPreAssignedRscLinksFromResource()

Gets the list of pre-assigned resource links that are pointed to Workcenter resource reference.

Signature

PLMResource.GetPreAssignedRscLinksFromResource(The list of pre-assigned resource links : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
The list of pre-assigned resource links Out List -

ReturnType

Boolean

Example

Let ListofPreAssignedRscLinks(List)
Let returncode(boolean)
Let spResource(PLMResource)
Set spResource = iResource //[iResource From Argument List, Provided by user selection]
returncode = spResource->GetPreAssignedRscLinksFromResource(ListofPreAssignedRscLinks)
";

PLMSystem.GetPreAssignedContextResource()

Gets the target resource reference of pre-assigned context resource link.

Signature

PLMSystem.GetPreAssignedContextResource(The target Resource reference of Pre-Assigned Context link : PLMResource, The Pre-AssignedStatus : Integer, The Alias : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
The target Resource reference of Pre-Assigned Context link Out PLMResource -
The Pre-AssignedStatus Out Integer -
The Alias Out String -

ReturnType

Boolean

Example

Let spAllocatedResourceLink(AllocatedResourceLink)
Let ListOfStatuses(List)
Let ListOfAlias(List)
Let returncode(boolean)
Let spContextReference(PLMSystem)
Set spContextReference = iContextReference // [iContextReference From Argument List, Provided by user selection]
returncode = spContextReference->GetPreAssignedRscLinkOperation(spAllocatedResourceLink,ListPreAssignedOperationOccurrence,ListOfStatuses,ListOfAlias,false)
";