RCMapFields Class Properties
In this section, the RCMapFields class properties are presented in alphabetical order.
Description
Use the FieldMenuOpt property to set or return a Y/N string value indicating whether the menu is associated with a page field.
Set this property to Y for related content with a mapping type of page field when you want to display the related content in the page field menu. Also set this property to Y when mapping related actions to a page field menu. When this parameter is set to Y, you must set the MapFieldType to PF. In addition, you must also set the ParameterName property to PTCS_MENUFIELD, a required value.
Note: The PnlFieldName property is also required, and is set by the invocation of the AppendMapField method.
Note: The default value is N.
This property is read-write.
Example
&rcMapFields = &rcServConfig.AppendMapField("0.QE_BOOK.QE_BOOK_NAME.2");
/* Required value for the ParameterName property */
&rcMapFields.ParameterName = "PTCS_MENUFIELD";
&rcMapFields.PnlName = "QE_BOOK";
&rcMapFields.MapFieldType = "PF";
&rcMapFields.FieldMenuOpt = "Y";Description
Use the MapFieldType property to set or return a string value representing the mapping type:
|
Value |
Description |
|---|---|
|
KF |
Key field. |
|
FV |
Fixed value. |
|
SV |
System variable. |
|
PF |
Page field (valid only for a page-level configuration—that is, when the IsCompService property of the parent RCServiceConfig object is set to P). |
|
DC |
Data column (valid only for a pivot grid configuration). |
|
ML |
Menu location (valid only for chart field in a pivot grid configuration). |
This property is read-write.
Example
&rcMapFlds.MapFieldType = "PF";Description
Use the MapNullValue property to set or return a Y/N string value indicating whether a parameter value is required.
Note: The default value is N.
This property is read-write.
Example
&rcMapFlds.MapNullValue = "Y";Description
Use the ParameterName property to return a string value representing the name of the service parameter from the related content service definition.
Important! Only when the FieldMenuOpt
property is set to Y, set the ParameterName property to PTCS_MENUFIELD, a required value.
This property is typically read-only.
Description
Use the PnlFieldName property to set or return the mapped data value as a string value. The value specified—for example, the mapped page field name, key field name, fixed value, system variable, and so on—depends on the value of the MapFieldType property.
This property is read-write.
Example 1
Local PTCS_SRVCONFIG:RCMapFields &rcMapFlds = &rcServConfig.AppendMapField("0.OPRID_VW2.OPRID.2");
&rcMapFields.MapFieldType = "PF";
Local string &sPnlFieldName = &rcMapFlds.PnlFieldName;
Example 2
Local PTCS_SRVCONFIG:RCMapFields &rcMapFlds = &rcServConfig.AppendMapField("0.OPRID_VW2.OPRID.2");
&rcMapFields.MapFieldType = "SV";
&rcMapFlds.PnlFieldName = "%UserId";Description
Use the PnlName property to set or return the page name as a string value. This property is required only when the value of the MapFieldType property is set to PF (page field); otherwise, it is an empty string.
This property is read-write.
Example
Local PTCS_SRVCONFIG:RCMapFields &rcMapFlds = &rcServConfig.AppendMapField("0.OPRID_VW2.OPRID.2");
&rcMapFlds.PnlName = "QE_RI_GROUPLET";
&rcMapFlds.MapFieldType = "PF";
Local boolean &bRet = &rcMapFlds.Save();
Description
Use the RefreshService property to set or return a Y/N string value that indicates whether to have the service data refreshed automatically when the key values on the transaction page changes.
Note: The default value is N.
This property is read-write.
Example
&rcMapFlds.RefreshService = "Y";