Bookshelf Home | Contents | Index | Search | PDF

Product Administration Guide > Technical Reference > eConfigurator API >

APIs to Interact with Conflicts and Messages

---

NOTE:  The APIs in this section apply only to customizable products with constraint rules.

GetDetailedReqExpl

This method retrieves conflict messages.

Input Arguments:

ObjId—the unique identifier of the complex object root (for example, Quote ID).
RootId—the unique identifier of the complex object root (for example, Quote Line Item row Id).
IntObjName—the name of the integration object.

Output Arguments:

Expl#—the explanations for the conflicts. Substitute a number for #, such as Expl0, Expl1, and so on.

GetExplanations

This method retrieves configuration explanations for an item.

Input Arguments:

ObjId—the unique identifier of the complex object root (for example, Quote ID).
RootId—the unique identifier of the complex object root (for example, Quote Line Item row Id).
(Optional) Version—Version arguments are used only when testing a customizable product version that is different from the currently released version.
Path—the path of the item.

Output Arguments:

The property set returned will have child property sets, each with the property Value as the explanation, as follows:

<Output>

<Expl Value="Explanation"/>

<Expl Value="Explanation"/>

...

<Expl Value="Explanation"/>

</Output>

GetSignals

This method retrieves configuration engine signals.

Input Arguments:

ObjId—the unique identifier of the complex object root (for example, Quote ID).
RootId—the unique identifier of the complex object root (for example, Quote Line Item row Id).
(Optional) Path—the integration ID where the item gets signals.
(Optional) Version—Version arguments are used only when testing a customizable product version that is different from the currently released version.

Output Arguments:

The property set returned will have child property sets, as follows:

< >

<Signal Expl="signal"/>

<Signal Expl="signal"/>

...

<Signal Expl="signal"/>

</ >

RemoveFailedRequests

This method removes all failed requests sent to the configuration engine.

Input Arguments:

ObjId—the unique identifier of the complex object root (for example, Quote ID).
RootId—the unique identifier of the complex object root (for example, Quote Line Item row Id).
(Optional) Version—Version arguments are used only when testing a customizable product version that is different from the currently released version.

Output Arguments:

None.

UndoLastRequest

This method removes the last request sent to the configuration engine.

Input Arguments:

ObjId—the unique identifier of the complex object root (for example, Quote ID).
RootId—the unique identifier of the complex object root (for example, Quote Line Item row Id).
(Optional) Version—Version arguments are used only when testing a customizable product version that is different from the currently released version.

Output Arguments:

None.

Bookshelf Home | Contents | Index | Search | PDF