Question

Difference between some Pega Mashup attributes

What is the difference between

data-pega-parameters

data-pega-action-param-parameters

data-pega-action-param-query

data-pega-query

Can you highlight some use-cases to better understand the difference between them?

***Moderator Edit: Vidyaranjan | Updated Platform Capability***

Correct Answer
July 16, 2018 - 2:31pm

Hi,

First, I am looking at the source code in PegaCompositeGadgetMgr.js to avoid any confusion.

You listed 2 parameters that simply don't exists:

data-pega-parameters

data-pega-query

These are incorrectly mentioned in some of the articles on the support community.

https://community.pega.com/knowledgebase/articles/previous-and-current-pega-web-mashup-attributes

These two are actually the following:

data-pega-parameters  should be mentioned as data-pega-action-param-parameters

data-pega-query should be mentioned as data-pega-action-param-query

(I will get this fixed)

Now, to answer your question the differences between the following parameters:

data-pega-action-param-query

This is a required parameter of "query" when using the data-pega-action of OpenWorkByURL.

A perfect example is when you want to display a full end user portal in a mashup you have to use this:

data-pega-action ='OpenWorkByURL'
data-pega-action-param-query ='pyActivity=Data-Portal.ShowDesktop'

Every action type may have one or more required parameters and they all use the "data-pega-action-param-[Param_Name]' naming convention.

 

data-pega-action-param-parameters

These are parameters added to the initial mashup processing and are not specific to the action type being used. Think of these parameters as being specific to client needs to send extra data to PRPC.  This follows a very specific syntax:

data-pega-action-param-parameters="{param1_name:'param1_value',param2_name:'param2_value'}"

 

 

Comments

Keep up to date on this post and subscribe to comments

Pega
July 16, 2018 - 2:31pm

Hi,

First, I am looking at the source code in PegaCompositeGadgetMgr.js to avoid any confusion.

You listed 2 parameters that simply don't exists:

data-pega-parameters

data-pega-query

These are incorrectly mentioned in some of the articles on the support community.

https://community.pega.com/knowledgebase/articles/previous-and-current-pega-web-mashup-attributes

These two are actually the following:

data-pega-parameters  should be mentioned as data-pega-action-param-parameters

data-pega-query should be mentioned as data-pega-action-param-query

(I will get this fixed)

Now, to answer your question the differences between the following parameters:

data-pega-action-param-query

This is a required parameter of "query" when using the data-pega-action of OpenWorkByURL.

A perfect example is when you want to display a full end user portal in a mashup you have to use this:

data-pega-action ='OpenWorkByURL'
data-pega-action-param-query ='pyActivity=Data-Portal.ShowDesktop'

Every action type may have one or more required parameters and they all use the "data-pega-action-param-[Param_Name]' naming convention.

 

data-pega-action-param-parameters

These are parameters added to the initial mashup processing and are not specific to the action type being used. Think of these parameters as being specific to client needs to send extra data to PRPC.  This follows a very specific syntax:

data-pega-action-param-parameters="{param1_name:'param1_value',param2_name:'param2_value'}"

 

 

Pega
July 17, 2018 - 11:12pm
Response to ChrisKoyl

Many thanks for clarifying, Chris.

We somehow should get these articles updated. It caused a lot of confusion :(

 

April 4, 2019 - 5:11am

Hello All,

 Still we are in lot of confusion as per this post we tried in below way

 

<!-- ********************** Begin Pega content ********************** -->
<script src ='http://localhost:8080/prweb/PRServlet?pyActivity=pzIncludeMashupScripts'></script>

<div 

data-pega-gadgetname ='PegaGadget' 
data-pega-action ='createNewWork' 
data-pega-action-param-classname ='Mayan-LangTrans-Work-Simple' 
data-pega-action-param-flowname ='pyStartCase' 
data-pega-action-param-parameters='{Customer:'Cust1',Level:'Level'}'

data-pega-isdeferloaded ='false' 
data-pega-applicationname ='LangTrans' 
data-pega-threadname ='STANDARD' 
data-pega-resizetype ='stretch' 
data-pega-url ='http://localhost:8080/prweb/PRServlet' >

</div>

<!-- ********************** End Pega content ********************** -->

 

But I never get these parameters. I tried to read it from pyDefault DT of case type class.

 

 

April 4, 2019 - 9:59am
Response to MayanAlagar

Hello!

 

Thank you for posting your query on PSC. This looks like an inactive post and hence, we suggest you create a new post for your query. Click on the Write a Post button that’s at the top of this screen and also on our Pega Support Community homepage.  Once created, please reply back here with the URL of the new post.

 

We have also sent you a private message opening up a communication channel in case you have any further questions.

 

Thanks,

Marissa | Community Moderator | Pegasystems Inc.