Asistencia al usuario para autores de contenido

Plug-in URL de representación

Utilice el plug-in de representación de RenderURL para crear URL que establezcan o eliminen los parámetros de representación.

La sintaxis para este plug-in es la siguiente:

[Plugin:RenderURL copyCurrentParams="" escape="" uri="" uriMode="" 
prefijo.key="" prefijo.value="" prefijo.mode="" prefijo.type=""]

Este plug-in utiliza los atributos siguientes:

copyCurrentParams: Utilice este atributo para determinar si desea que el estado y los parámetros del portal actual codificados en el estado se copien en el nuevo URL. Los valores válidos son true y false. El valor predeterminado es false.
escape: Utilice este atributo para definir el escape que se utiliza para grabar el URL. Especifique uno de los valores siguientes: xml, json, javascript o none. El valor predeterminado es xml.

Para establecer, añadir o eliminar los parámetros de representación públicos o privados, utilice los siguientes atributos. Utilice el prefix antes de los atributos para correlacionar los atributos clave, valor, tipo y modalidad que hacen referencia al mismo parámetro de representación. El prefijo no debe contener un carácter de punto ( . ).

prefijo.key

Utilice este atributo para establecer el nombre del parámetro. Para el valor, especifique el identificador simple de un parámetro privado o público.

Soporte limitado para parámetros de representación pública no declarada: IBM® Digital Data Connector (DDC) for WebSphere Portal también proporciona soporte limitado para parámetros públicos que no se declaran en el descriptor de despliegue del Visor de contenido web. Puede identificar tales parámetros mediante el nombre completo en el formato {ns}localname. Los parámetros de representación públicos no declarados no funcionan al utilizarlos con WSRP. No se incluyen de forma predeterminada en la clave de memoria caché de fragmentos de portlet si está habilitado el almacenamiento en caché de fragmentos de portlet.

prefijo.value

Utilice este atributo para establecer, añadir o eliminar valores para un parámetro. El prefix debe coincidir con el establecido para la key listada anteriormente. Para establecer parámetros con varios valores, añada varios atributos prefix.value a la etiqueta de plug-in de representación.

prefijo.type

Utilice este atributo para determinar el tipo de parámetro que desea que se establezca. Los valores válidos son private y public.

prefijo.mode

Utilice este atributo para determinar lo que desee hacer con los valores de parámetro. Los valores válidos para este parámetro son los siguientes:

set

Esta modalidad es la predeterminada. Utilice esta modalidad para establecer el valor para el parámetro. Al utilizar esta modalidad, el valor del parámetro que establezca sustituye un valor existente.

add

Utilice esta modalidad para añadir un valor para el parámetro. Al utilizar esta modalidad, el valor del parámetro que establezca se añade a los valores existentes. Si utiliza esta modalidad, pero no existen aún valores de parámetro, se establecerá un nuevo parámetro.

remove

Utilice esta modalidad para suprimir el parámetro o sus valores. Utilice esta modalidad sólo para los parámetros de representación privada con copyCurrentParams="true" o para los parámetros de representación pública. Puede utilizar esta modalidad de cualquiera de estas dos formas:

Para eliminar completamente el parámetro, no pase ningún valor.
Para eliminar sólo valores específicos de un parámetro de representación, pase únicamente los valores que desee eliminar.

Para centrarse en un plug-in del resolvedor del portal, utilice los siguientes atributos. Si especifica también los parámetros de representación públicos, estos parámetros se aplican una vez finalizada la resolución.

uri: Utilice este atributo para especificar un URI válido que identifique el recurso que desee que se resuelva.
uriMode: Utilice este atributo para especificar la modalidad de resolución. Los valores válidos son view y download. El plug-in evalúa el atributo uriMode únicamente si no se establecen parámetros de representación públicos en la misma etiqueta de plug-in de representación.

Para incluir también parámetros sólo para el resolvedor, utilice uno de los siguientes atributos:

prefijo.type="uri": Especifique el tipo de parámetro a identificar como un parámetro resolvedor.
prefijo.key: Establezca el nombre del parámetro para el resolvedor. El prefijo puede ser cualquier serie
prefijo.value: Establezca el valor del parámetro para el resolvedor. Para establecer parámetros con varios valores, añada los atributos de varios valores a la etiqueta de plug-in de representación

Ejemplos

Todos estos atributos se pueden combinar juntos. Ejemplos:

La etiqueta de plug-in siguiente creará un URL que lleva a cabo las dos acciones siguientes:
- Establece un parámetro de representación privado private1.
- Agrega varios valores [pv1, pv2] para el parámetro de representación público public1.
```
[Plugin:RenderURL copyCurrentParams="true" 
    pr1.key="private1" pr1.value="v1"                  
    pr1.type="private" pr1.mode="set"
    pr2.key="public1"  pr2.value="pv1" pr2.value="pv2" 
    pr2.type="public"  pr2.mode="add"] 
```
La etiqueta de plug-in siguiente creará un URL que lleva a cabo las dos acciones siguientes:
- Establece un parámetro de representación pública con varios valores utilizando el nombre calificado (QName) {http://ibm.com}prp1 del parámetro.
- Elimina el parámetro de representación privada con el nombre private1.
```
[Plugin1:RenderURL copyCurrentParams="true" 
    pr1.key="private1" pr1.type="private" pr1.mode="remove"
    pr2.key="{http://ibm.com}prp1" pr2.value="pv1" pr2.value="pv2" 
    pr2.type="public"  pr2.mode="set"]
```
La etiqueta de plug-in siguiente creará un URL que lleva a cabo las dos acciones siguientes:
- Resuelve el URI en una página identificada por el parámetro de la URI.
- Agrega el valor para el parámetro de representación pública utilizando el nombre calificado (QName) {http://ibm.com}prp1 del parámetro en la página que se ha resuelto en el paso anterior. Establece el valor en pv1.
```
[Plugin:RenderURL copyCurrentParams="true" uri="nm:oid:pageid" 
    pr2.key="{http://ibm.com}prp1" pr2.value="pv1" 
    pr2.type="public" pr2.mode="add"] 
```

Los ejemplos siguientes muestran cómo se pueden establecer los parámetros de representación al enviar el formulario, de modo que estos parámetros se puedan leer mediante los portlets que se muestran en la página de resultados del formulario.

En el ejemplo siguiente se establece un parámetro de representación privado, que es un parámetro que sólo se puede ver mediante la misma instancia del portlet en la página que establece el parámetro. Para establecer el valor del parámetro, especifique como se indica a continuación:
```
<form method="get" action="[Plugin:RenderURL copyCurrentParams="true"]">
    
    <input type="text" name="param1">
    <input type="submit" value="Submit">
</form>
```
Para leer el valor del parámetro, utilice el siguiente código en la página a la que se envía el formulario: [Plugin:RenderParam key="param1"]
En el ejemplo siguiente se establece exactamente un parámetro de representación público, que es un parámetro que todas las instancias del portlet pueden ver. El ejemplo utiliza el parámetro CUSTOM_CONTEXT reservado y declarado en el archivo portlet.xml con el portlet de representación. Para establecer el valor del parámetro, especifique como se indica a continuación:
```
<form method="get" action="[Plugin:RenderURL copyCurrentParams="true"]">
    
    <input type="text" name="CUSTOM_CONTEXT">
    <input type="submit" value="Submit">
</form>
```
Para leer el valor del parámetro, utilice el código siguiente en la página a la que se envía el formulario: [Plugin:RenderParam key="CUSTOM_CONTEXT"]