Show TOC

Background documentationMashup API Locate this document in the navigation structure

 

The client-side Mashup API facilitates the use of the Enterprise Portal Client Framework (EPCF) eventing mechanism for the implementation of connections between content items in a page.

For more information, see Client-Side Eventing.

getEventData()

Retrieves a JavaScript object through which a source iView can pass parameters to target iViews.

Parameters

None

Return Value

JavaScript object

Example Example

  1. var eventData = EPCM.getSAPTop().MashupAPI.getEventData();
End of the code.
EventData.setID(ID)

Stores an iView ID in the EventData object

Parameters

ID – iView ID

Return Value

None

Example Example

  1. var eventData = EPCM.getSAPTop().MashupAPI.getEventData();
    eventData.setID("material321");
    
End of the code.
EventData.setPortID(portID)

Stores a port ID in the EventData object

Parameters

portID – port ID as defined in ports.xml

Return Value

None

Example Example

  1. var eventData = EPCM.getSAPTop().MashupAPI.getEventData();
    eventData.setPortID("inPort1");
    
End of the code.
EventData.addData(key,value)

Stores a parameter name and value in the EventData object

Parameters

key – parameter's name as defined in ports.xml; value - parameter's value

Return Value

None

Example Example

  1. var eventData = EPCM.getSAPTop().MashupAPI.getEventData();
    eventData.addData("param1","P-100");
    
End of the code.
EventData.toString()

Retrieves a string representation of the EventData object

Parameters

None

Return Value

String value of the EventData object in JSON format

Example Example

  1. var eventData = EPCM.getSAPTop().MashupAPI.getEventData();
    eventData.setID("material321");
    eventData.setPortID("inPort1");
    eventData.addData("param1","P-100");
    String myEvent = eventData.toString();
    
End of the code.