Atributos e Funções do Mapa da Interface do Usuário

Observação: use a opção Informações Adicionais da Consulta do Mapa da Interface do Usuário para revisar exemplos HTML fornecidos pelo produto.

Associar XML a HTML

Somente dois atributos são necessários para associar o XML de um Mapa da IU ao HTML dele. Ambos os atributos exigem um documento XML incorporado ao HTML, em que o XML é associado por nós <xml>.

Aviso: é necessário incorporar um par de tags <xml></xml> ao documento HTML para que a associação ocorra.

Vinculando um Campo


Sintaxe	Valores	Descrição
oraField=" "	XPath do elemento Campo	Este atributo é usado para vincular um elemento HTML diretamente a um elemento XML, em que este último é definido dentro do esquema XML do Mapa da IU. O atributo pode ser usado com qualquer elemento HTML de renderização, como <span>, <div> e <input>.

HTML para o elemento input:


<html>
<body>
<table>
   <tr>
      <td>Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
</table>
</body>
<xml>
   <root>
      <address>123 Main St</address>
      <city>Alameda</city>
      <state>CA</state>
      <zip>94770</zip>
   </root>
</xml>
</html>

HTML Renderizado

HTML para os elementos span e div:


<html>
<body>
 
<div oraField="address"></div>
<span oraField="city"></span>
<span>,</span>
<span oraField="state"></span>
<span oraField="zip"></span>
<span oraField="country"></span>
 
</body>
<xml>
   <root>
      <address>123 Main St</address>
      <city>Alameda</city>
      <state>CA</state>
      <zip>94770</zip>
   </root>
</xml>
</html>

HTML renderizado:

Vinculando uma Lista

Este atributo é usado para vincular uma tabela HTML a uma lista XML, em que esta última é definida dentro do esquema XML do Mapa da IU. O objetivo do elemento é disparar a estrutura para replicar o HTML da tabela para cada ocorrência da lista.


Sintaxe	Valores	Descrição
oraList=" "	XPath do elemento da Lista	Este atributo é usado para vincular uma tabela HTML a uma lista XML, em que esta última é definida dentro do esquema XML do Mapa da IU. O objetivo do elemento é disparar a estrutura para replicar o HTML da tabela para cada ocorrência da lista.

Observação: Os atributos oraField incorporados à lista precisam conter navegação XPath relativa à lista. Veja o exemplo a seguir.

<html>
<head><title>Bind xml list element</title></head>
<body>
<table oraList="payment">
   <thead>
      <tr>
         <th><span>Pay Date</span></th>
         <th><span>Amount</span></th>
        </tr>
        <tr/>
    </thead>
    <tr>
      <td>
         <span oraField="date" oraType="date"></span>
      </td>
      <td align="right">
         <span oraField="amount" oraType="money"></span>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
    <payment>
        <date>2008-01-01</date>
        <amount>44.28</amount>
    </payment>
    <payment>
        <date>2008-02-01</date>
        <amount>32.87</amount>
    </payment>
    <payment>
        <date>2008-03-01</date>
        <amount>21.76</amount>
    </payment>
</root>
</xml>
</html>

HTML renderizado:

Gerar Lista Suspensa

Os atributos a seguir são fornecidos para criar um elemento 'select' em HTML, também chamado de lista suspensa, com base em várias origens.


Fonte	Sintaxe	Valores	Exemplos
Consulta	oraSelect="lookup: ;"	Campo de pesquisa	`... <td>House Type:</td> <td> <select oraField="houseType" oraSelect="lookup:HOUSE_TYPE;"> </select> </td>`
Busca Extensível	oraSelect="lookupBO: ;"	Código do objeto de negócios	`... <td>UI Device Display Type:</td> <td> <select oraField="uiDeviceType" oraSelect="lookupBO: F1-DeviceDisplayTypes;"></select> </td>`
Tipo de Característica (predefinido)	oraSelect="charType: ;"	código do Tipo de Característica	`... <td>Usage:</td> <td> <select oraField="statusReasonUsage" oraSelect="charType:F1-SRUSG;"></select> </td> ...`
Tabela de Controle	oraSelect="table: ;" Observação: este atributo funciona somente com tabelas que seguem a estrutura da tabela de controle padrão, em que há uma tabela de idiomas relacionada que inclui a coluna DESCR ou DESCR100 como coluna de descrição da tabela. Vá até a página de manutenção Campo de cada campo para ver quais tabelas contêm os campos. Aviso: a função oraSelect só funciona se menos de 500 valores forem exibidos.	Nome da tabela	`... <td>Currency: </td> <td> <select oraField="currency" oraSelect="table:CI_CURRENCY_CD;"> </select> </td> ...`
Serviço da Página	oraSelect="service: ;"	nome do Serviço da Página	`... <td>Country:</td> <td> <select oraField="country" oraSelect="service:CIPTCNTW;"> </select> </td> ...`
Lista Incorporada	Usado para criar uma lista suspensa de seleção com base em uma lista do XML do mapa. oraSelect="valuePath: ;descPath: "	Após valuePath, indique o XPath do elemento que contém os valores. Após descPath, indique o XPath do elemento que contém as descrições.	<html> <body> <table summary="" border="0" cellpadding="1" cellspacing="1"> <tr> <td>Select: </td> <td><select oraSelect= "valuePath:list/value; descPath:list/desc" oraField="target"></select></td> </tr> </table> </body> <xml> <root> <target>10</target> <list> <value>10</value> <desc>Ten</desc> </list> <list> <value>20</value> <desc>Twenty</desc> </list> <list> <value>40</value> <desc>Forty</desc> </list> </root> </xml> </html>
Script de Serviço	oraSelect="ss: ;"	código do Script de Serviço	Veja a seguir a sintaxe adicional necessária para o uso desta função.
Serviço de Negócios	oraSelect="bs: ;"	código do Serviço de Negócios	Veja a seguir a sintaxe adicional necessária para o uso desta função.

Durante a especificação de um script de serviço ou serviço de negócios, são necessárias informações de mapeamento extras para transmitir os dados de e para o serviço.


Sintaxe	Valores	Descrição
oraSelectIn=" ;"	serviceXPath:element;	Usado para transmitir o valor de outro elemento ao serviço, mapeando para o XPath do serviço.
oraSelectIn=" ;"	serviceXPath:'Literal';	Usado para transmitir uma constante ou literal ao serviço, mapeando para o XPath do serviço.
oraSelectOut="valuePath: ; descPath: "	Veja os exemplos a seguir.	Usado para indicar qual elemento da saída do serviço contém os valores, e qual contém as descrições.

Exemplo com serviço de negócios:

...
<td>External System: </td>
<td>
   <select oraField="externalSystem" 
    oraSelect="bs:F1-RetrieveExternalSystems" 
    oraSelectIn="outboundMsgType:boGroup/parameters/outboundMsgType;" 
    oraSelectOut="valuePath:results/externalSystem; 
    descPath:results/description">
   </select>
</td>
...

Este método para a geração de listas suspensas é muito usado quando há dependência entre elementos, e a lista de valores válidos da lista suspensa do elemento-filho é baseada em outro elemento do mapa (o elemento-pai). Quando o elemento-pai é alterado, pode ser necessário atualizar o elemento-filho. Este comportamento pode ser implementado por meio da função chamada em um evento onChange do mapa. A sintaxe é oraHandleDependentElements('dependent element');. Vários elementos-alvo (dependentes) podem ser nomeados.

O exemplo a seguir está relacionado ao exemplo do serviço de negócios anterior, em que a lista de sistemas externos é específica de um tipo de mensagem de saída, que é transmitido como entrada. O trecho de código a seguir mostra a configuração para o elemento de tipo de mensagem de saída disparar uma atualização da lista suspensa do sistema externo.

...
<div>
   <label oraLabel="boGroup/parameters/outboundMsgType"></label>
      <span>
         <select oraSelect="table:F1_OUTMSG_TYPE"  
          oraField="boGroup/parameters/outboundMsgType"
          onChange="oraHandleDependentElements('boGroup/parameters/externalSystem');">
         </select>
      </span>
</div>
...

Formatar Campos de Entrada e Saída

Os atributos a seguir são projetados para aplicar a formatação do tipo de dados a campos de entrada e saída.

Formatação Automática


Sintaxe
oraSchemaDataTypes="false"

Este atributo é usado para disparar a formatação automática no documento HTML renderizado. A formatação automática ocorre de acordo com os atributos de tipo de dados definidos no esquema do mapa da IU. Para obter detalhes sobre a formatação de um tipo de dados específico, consulte as descrições do atributo oraType a seguir.

Aviso: o atributo oraSchemaDataTypes="true" será injetado automaticamente no HTML do mapa da IU. Se você não deseja aplicar os tipos de dados do esquema ao HTML renderizado, precisará especificar esse atributo no nó body com o valor falso. O atributo <body oraSchemaDataTypes="false"> é necessário para evitar a formatação automática.

Esquema do Mapa da Interface do Usuário:

<schema>
    <schemaDate dataType="date"/> 
    <schemaDateTime dataType="dateTime"/> 
    <schemaFkRef fkRef="F1-MOTBL"/> 
    <schemaLookup dataType="lookup" lookup="ACCESS_MODE"/> 
    <schemaMoney dataType="money"/> 
    <schemaNumber dataType="number"/> 
    <schemaTime dataType="time"/> 
</schema>

Mapa da IU em HTML:


<html>
<body oraSchemaDataTypes="true">
<table border="1" cellpadding="1" cellspacing="1">
   <tr><th>dataType</th><th>input result</th><th> display-only result</th></tr>
   <tr>
      <td>date</td>
      <td><input oraField="schemaDate"/></td>
      <td><span oraField="schemaDate"></span></td>
   </tr>
   <tr>
      <td>dateTime</td>
      <td><input oraField="schemaDateTime"/></td>
      <td><span oraField="schemaDateTime"></span></td>
   </tr>
   <tr>
      <td>fkRef</td>
      <td><input oraField="schemaFkRef"/></td>
      <td><span oraField="schemaFkRef"></span></td>
   </tr>
   <tr>
      <td>lookup</td>
      <td><input oraField="schemaLookup"/></td>
      <td><span oraField="schemaLookup"></span></td>
   </tr>
   <tr>
      <td>money</td>
      <td><input oraField="schemaMoney"/></td>
      <td><span oraField="schemaMoney"></span></td>
   </tr>
   <tr>
      <td>number</td>
      <td><input oraField="schemaNumber"/></td>
      <td><span oraField="schemaNumber"></span></td>
   </tr>
   <tr>
      <td>time</td>
      <td><input oraField="schemaTime"/></td>
      <td><span oraField="schemaTime"></span></td>
   </tr>
</table>
 
</body>
<xml>
<root>
   <schemaDate>2007-11-02</schemaDate>
   <schemaDateTime>2007-11-02-23.45.00</schemaDateTime>
   <schemaFkRef>CI_MD_TBL</schemaFkRef>
   <schemaLookup>A</schemaLookup>
   <schemaMoney>1000000</schemaMoney>
   <schemaNumber>5661976.11548</schemaNumber>
   <schemaTime>23.45.00</schemaTime>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Data e Hora


Sintaxe	Valores Válidos	Descrição
oraType="date"		Esta função é usada para exibir uma data de acordo com o perfil de exibição do usuário. Para os campos de entrada, a definição formata os dados quando o usuário sai do campo com Tab.
oraType="time"		Esta função é usada para exibir uma hora de acordo com o perfil de exibição do usuário. Para os campos de entrada, a definição formata os dados quando o usuário sai do campo com Tab.
oraType="dateTime; time:suppress"		Esta função é usada para exibir uma data/hora de acordo com o perfil de exibição do usuário. Quando esta função é usada para um elemento de entrada, ela é dividida em duas partes, uma para data e outra para hora. É possível usar o valor de atributo 'time:suppress' para suprimir a parte hora do elemento de data hora.
oraType="dateTime; stdTime:true;"		Esta função verdadeira é usada para renderizar um elemento de data/hora que foi armazenado no horário padrão de acordo com a programação de horário de verão do fuso horário "base". O fuso horário-'base' é especificado na tabela Instalação e representa o fuso horário do banco de dados. Para elementos de entrada com essa definição, o pressuposto é que todos os horários informados correspondem à programação de horário de verão do fuso horário-base. Se for informado um horário que não possa ser traduzido para o horário padrão sem ambiguidade, o usuário precisará informar um rótulo de fuso horário para indicar se o horário informado está em horário de verão ou padrão.
oraType="dateTime; stdTimeRef: ;"	Referencie um XPath após os dois pontos.	Esta função é usada para renderizar um elemento de data/hora de acordo com a programação de horário de verão do fuso horário referenciado pelo XPath. Note que o pressuposto é de que a hora processada foi armazenada no horário padrão do fuso referenciado, de modo que apenas a mudança para o horário de verão será executada, não a mudança de fuso horário.
oraType="dateTime; legalTime:true;"		Esta função é usada para renderizar um elemento de data/hora que é armazenado no horário oficial do fuso horário "base". O fuso horário-'base' é especificado na tabela Instalação e representa o fuso horário do banco de dados.
oraType="dateTime; legalTimeRef: ;"	Referencie um XPath após os dois pontos.	Esta função é usada para renderizar um elemento de data/hora de acordo com a programação de horário de verão do fuso horário referenciado pelo XPath. A hora processada é considerada como tendo sido armazenada no horário oficial do fuso referenciado.
oraType="dateTime; … ; displayRef: ;"	Referencie um XPath após os dois pontos.	Esta função é usada para exibir um elemento de data/hora explicitamente definido como armazenado no horário padrão ou oficial (usando stdTime \| stdRef \| legalTime \| legalRef) de seu fuso horário de armazenamento para o fuso horário referenciado no horário oficial antes da exibição e vice-versa, do fuso horário de exibição para o fuso horário de armazenamento ao salvar.


<html>
<body oraSchemaDataTypes="true">
<table border="1" cellpadding="1" cellspacing="1">
   <tr><th>dataType</th><th>input result</th><th> display-only result</th></tr>
   <tr>
      <td>date</td>
      <td><input oraField="schemaDate" oraType="date;"/></td>
      <td><span oraField="schemaDate" oraType="date;"></span></td>
   </tr>
   <tr>
      <td>time</td>
      <td><input oraField="schemaTime" oraType="time;"/></td>
      <td><span oraField="schemaTime" oraType="time;"></span></td>
   </tr>
   <tr>
      <td>dateTime</td>
      <td><input oraField="schemaDateTime" oraType="dateTime;"/></td>
      <td><span oraField="schemaDateTime" oraType="dateTime;"></span></td>
   </tr>
   <tr>
      <td>dateTimeSuppress</td>
      <td><input oraField="schemaDateTimeSup" oraType="dateTime; time:suppress"/></td>
      <td><span oraField="schemaDateTimeSup" oraType="dateTime; time:suppress"></span></td>
   </tr>
   <tr>
     <td>Base Time Zone (Standard)</td>
     <td><input oraField="schemaDateTimeStd" oraType="dateTime; stdTime:true;"/></td>
     <td><span oraField="schemaDateTimeStd" oraType="dateTime; stdTime:true;"></span></td>
   </tr>
   <tr>
     <td>Base Time Zone (Legal)</td>
     <td><input oraField="schemaDateTimeLgl" oraType="dateTime; legalTime:true;"/></td>
     <td><span oraField="schemaDateTimeLgl" oraType="dateTime; legalTime:true;"></span></td>
   </tr>
   <tr>
     <td>Referenced Time Zone (Standard)</td>
     <td><input oraField="schemaDateTimeStdRef" oraType="dateTime; stdTimeRef:timeZone;"/></td>
     <td><span oraField="schemaDateTimeStdRef" oraType="dateTime; stdTimeRef:timeZone;"></span></td>
   </tr>
   <tr>
     <td>Referenced Time Zone (Legal)</td>
     <td><input oraField="schemaDateTimeLglRef" oraType="dateTime; legalTimeRef:timeZone;"/></td>
     <td><span oraField="schemaDateTimeLglRef" oraType="dateTime; legalTimeRef:timeZone;"></span></td>
   </tr>
   <tr>
     <td>Stored in Base Time Zone (Standard) - displayed in another Time Zone</td>
     <td><input oraField="schemaDateTimeStdDisp" oraType="dateTime; stdTime:true; displayRef:timeZoneDisp;"/></td>
     <td><span oraField="schemaDateTimeStdDisp" oraType="dateTime; stdTime:true; displayRef:timeZoneDisp;"></span></td>
   </tr>  
   <tr>
     <td>Stored in Base Time Zone (Legal) - displayed in another Time Zone</td>
     <td><input oraField="schemaDateTimeLglDisp" oraType="dateTime; legalTime:true; displayRef:timeZoneDisp"/></td>
     <td><span oraField="schemaDateTimeLglDisp" oraType="dateTime; legalTime:true; displayRef:timeZoneDisp"></span></td>
   </tr>
   <tr>
     <td>Stored in a Referenced Time Zone (Standard) - displayed in another Time Zone</td>
     <td><input oraField="schemaDateTimeStdRefDisp" oraType="dateTime; stdTimeRef:timeZone; displayRef:timeZoneDisp"/></td>
     <td><span oraField="schemaDateTimeStdRefDisp" oraType="dateTime; stdTimeRef:timeZone; displayRef:timeZoneDisp"></span></td>
   </tr>
   <tr>
     <td>Stored in a Referenced Time Zone (Legal) - displayed in another Time Zone</td>
     <td><input oraField="schemaDateTimeLglRefDisp" oraType="dateTime; legalTimeRef:timeZone; displayRef:timeZoneDisp"/></td>
     <td><span oraField="schemaDateTimeLglRefDisp" oraType="dateTime; legalTimeRef:timeZone; displayRef:timeZoneDisp"></span></td>
   </tr>
  
  </table> 
  
</body>
<xml>
<root>
   <timeZone>US-EASTERN</timeZone>
   <timeZoneDisp>US-CENTRAL</timeZoneDisp>
   <schemaDate>2007-11-02</schemaDate>
   <schemaTime>23.45.00</schemaTime>
   <schemaDateTime>2007-11-02-23.45.00</schemaDateTime>
   <schemaDateTimeSup>2007-11-02-23.45.00</schemaDateTimeSup>
   <schemaDateTimeStd>2007-11-02-23.45.00</schemaDateTimeStd>
   <schemaDateTimeStdRef>2007-11-02-23.45.00</schemaDateTimeStdRef>
   <schemaDateTimeLgl>2007-11-02-23.45.00</schemaDateTimeLgl>
   <schemaDateTimeLglRef>2007-11-02-23.45.00</schemaDateTimeLglRef>
   <schemaDateTimeStdDisp>2007-11-02-23.45.00</schemaDateTimeStdDisp>
   <schemaDateTimeStdRefDisp>2007-11-02-23.45.00</schemaDateTimeStdRefDisp>
   <schemaDateTimeLglDisp>2007-11-02-23.45.00</schemaDateTimeLglDisp>
   <schemaDateTimeLglRefDisp>2007-11-02-23.45.00</schemaDateTimeLglRefDisp>
</root>
</xml>
</html>

HTML renderizado.

Quando um elemento é associado a um fuso horário, o nome do fuso horário correspondente é exibido junto com o valor. Isso é especificamente útil no exemplo referenciado como "Fuso Horário Base (Padrão) - Hora duplicada". A hora 1:28 é ambígua sem um rótulo de fuso horário. Legalmente, 1° de novembro de 2009 1:28h ocorre duas vezes, porque o horário de verão termina às 2:00h. O nome do fuso horário indica se a primeira ou a segunda hora está especificada para o fuso horário.

Formatação de Duração


Sintaxe
oraType="duration"

Esta função é usada para exibir a duração do tempo. Para um elemento de entrada, o valor informado pelo usuário é traduzido de minutos para hora e minutos, conforme apropriado. Por exemplo, um valor informado de '90' é convertido em '00:01:30' quando o usuário usa Tab para sair do campo de entrada.

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Duration: </td>
      <td><span oraField="duration" oraType="duration"></span></td>
   </tr>
   <tr>
      <td>Duration: </td>
      <td><input oraField="duration" oraType="duration"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <duration>90</duration>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Dia em Mês


Sintaxe
oraType="dayInMonth"

Esta função é usada para exibir dia e mês concatenados.

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Day In Month: </td>
      <td><span oraField="dayMonth" oraType="dayInMonth"></span></td>
   </tr>
   <tr>
      <td>Day In Month: </td>
      <td><input oraField="dayMonth" oraType="dayInMonth"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <dayMonth>0228</dayMonth>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Mês em Ano


Sintaxe
oraType="monthInYear"

Esta função é usada para exibir mês e ano concatenados.

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Month In Year: </td>
      <td><span oraField="month" oraType="monthInYear"></span></td>
   </tr>
   <tr>
      <td>Month In Year: </td>
      <td><input oraField="month" oraType="monthInYear"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <month>200811</month>
</root>
</xml>
</html>

HTML renderizado.

Formatação Monetária

Esta função é usada para exibir um número como valor monetário. Consulte a tabela de opções de configuração no que diz respeito à moeda. Para elementos de entrada, um erro é emitido se um valor não numérico é inserido.


Sintaxe	Descrição
oraType="money: "	Especifique diretamente um código de moeda após os dois pontos.
oraType="money;currencyRef: "	Após os dois pontos, referencie um XPath para um elemento que referencie um código de moeda.
oraType="money"	Se nenhuma moeda ou referência de moeda for especificada, a moeda da instalação será usada.

Observação: Para o alinhamento à direita, é necessário especificar um par de referências da folha de estilo, cisEnabled e cisDisabled, no cabeçalho do mapa. A folha de estilo controla a renderização do campo. Se você desejar alterar a renderização, precisará substituir o estilo oraMoney.

<html>
<head>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Amount, currency specified:</td>
      <td><span oraType="money:EUR" oraField="totalAmt"></span></td>
   </tr>
   <tr>
      <td>Amount, default currency:</td>
      <td><span oraType="money" oraField="totalAmt"></span></td>
   </tr>
   <tr>
      <td>Amount, default input:</td>
      <td><input oraType="money" oraField="totalAmt"/></td>
   </tr>
   <tr>
      <td>Amount, currency reference:</td>
      <td><input oraType="money;currencyRef:cur" oraField="totalAmt"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <totalAmt>50500.09</totalAmt>
   <cur>EUR</cur>
</root>
</xml>
</html>

HTML renderizado

Formatação de Número

Esta função é usada para exibir um número ou validar um valor de entrada. Para elementos de entrada, um erro é emitido pelo sistema se um valor não numérico é inserido.


Sintaxe
oraType="number"

<html>
<head>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Count:</td>
      <td><span oraType="number" oraField="count"></span></td>
   </tr>
   <tr>
      <td>Count, input:</td>
      <td><input oraType="number" oraField="count"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <count>989</count>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Referência de Chave Externa

Por padrão, quando um elemento com oraType fkRef é exibido, uma string de informações, o menu contexto, a navegação e a pesquisa são ativadas (se a referência da chave externa estiver configurada de acordo). A sintaxe é fornecida para permitir a desativação seletiva de qualquer um desses recursos.

Note que também é possível ativar o hiperlink da chave externa separadamente. Para obter mais informações, consulte Incorporar Navegação da Estrutura. Os vários atributos usados para controlar a funcionalidade de referência da chave externa estão descritos a seguir. Note que, em todos os casos, o valor padrão é verdadeiro. O valor falso deve ser usado para desativar o recurso.


Sintaxe
oraType="fkRef:true\|false; info:true\|false; context:true\|false; navigation:true\|false; search:true\|false"

fkRef. O valor 'verdadeiro' ativa todo o processamento de referência da chave externa descrito a seguir. Use o valor 'falso' para desativar o processamento automático da Referência de Chave Externa.
info. O valor 'verdadeiro' renderiza uma string de informações no mapa da IU, se aplicável.
context. O valor 'verdadeiro' renderiza um menu de contexto a ser exibido antes do elemento de referência da chave externa, se aplicável.
navigation. O valor 'verdadeiro' faz com que a string de informações seja renderizada como hiperlink, se aplicável. Clicar no hiperlink aciona a navegação para a página apropriada.
search. O valor 'verdadeiro' exibe um ícone de pesquisa que inicia a zona de pesquisa, se aplicável.

Observação: As funcionalidades de navegação e menu contexto da chave externa só estão disponíveis para mapas da IU exibidos em uma zona do portal. Os Mapas da IU exibidos durante o processamento de scripts de BPA não têm suporte para as opções de navegação. A funcionalidade de pesquisa só está disponível para elementos HTML de entrada.

Esquema do Mapa da Interface do Usuário:


<schema>
  <bo fkRef="F1-BOMO"/>
</schema>

Mapa da IU em HTML:


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Business Object</td>
      <td><span oraField="bo" oraType="fkRef:true; info:true; context:true; navigation:true;"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <bo>F1-COUNTRY</bo>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Consulta

Esta função é usada para exibir a descrição de um valor de consulta.


Sintaxe	Valores Válidos
oraType="lookup: "	Nome do campo de pesquisa após os dois pontos.


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Status:</td>
      <td><span oraField="status" oraType="lookup:BATCH_JOB_STAT_FLG"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <status>PD</status>
</root>
</xml>
</html>

HTML renderizado.

HTML para o valor de consulta renderizado.

Formatação de Busca Extensível

Esta função é usada para exibir a descrição de um valor de busca extensível.


Sintaxe	Valores Válidos
oraType="lookupBO: "	Nome do código do Objeto de Negócios após os dois pontos.


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Value:</td>
      <td><span oraField="status" oraType="lookupBO:F1-DeviceDisplayTypes"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
    <status>oraTablet</status>
</root>
</xml>
</html>

HTML renderizado.

Formatação de Tipo de Característica

Esta função é usada para exibir a descrição de um valor de característica predefinido.


Sintaxe	Valores Válidos
oraType="charType: "	Código do Tipo de Característica após os dois pontos.


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td>Skill:</td>
        <td><span oraType="charType:CM-SKILL" oraField="skill"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <skill>10</skill>
</root>
</xml>
</html>

HTML renderizado.

Formatação da Tabela de Controle

Esta função é usada para exibir a descrição de uma tabela de controle com uma tabela de idioma associada.


Sintaxe	Valores Válidos
oraType="table: "	Código da tabela após os dois pontos.


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Currency:</td>
      <td><span oraType="table:CI_CURRENCY_CD" oraField="curr"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <curr>USD</curr>
</root>
</xml>
</html>

HTML renderizado.

Adicionar/Remover Formatação da Grade


Sintaxe	Descrição
oraType="addGridRow"	A função addGridRow é usada para gerar a caixa de diálogo "inserir linha" no mapa da IU. Uma imagem para 'adicionar' é exibida. Clicar na imagem insere uma linha na grade. Se a lista estiver vazia, por padrão uma linha de grade vazia será adicionada automaticamente. Isso significa que o usuário sempre verá pelo menos uma linha da grade quando este atributo for usado.
oraType="deleteGridRow"	A função deleteGridRow é usada para gerar a caixa de diálogo "excluir linha" no mapa da IU. Uma imagem para 'excluir' é exibida. Clicar na imagem remove a linha adjacente da grade.

Observação: Como as caixas de diálogo de adição e exclusão só são relevantes dentro de uma tabela, esses atributos precisam ser especificados dentro de um elemento <td>.

Aviso: esses atributos foram projetados para funcionar com a ação do objeto de negócios 'substituir' em vez de 'atualizar'. Portanto, se o mapa contiver uma grade, a ação do objeto de negócios 'substituir' deverá ser usada para atualizar o objeto. Para obter mais informações, consulte Ação Substituir do Objeto de Negócios.

Exemplo:

<html>
<head>
<title>Demonstrate Grid Add and Grid Delete OraTypes</title>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table oraList="listEntry">
   <thead>
      <tr>
         <th/>
         <th/>
         <th><span>Date</span></th>
         <th><span>Amount</span></th>
      </tr>
      <tr/>
   </thead>
   <tr>
      <td oraType="addGridRow"></td>
      <td oraType="deleteGridRow"></td>
      <td>
         <input oraField="date" oraType="date"></input>
      </td>
      <td align="right">
         <input oraField="amount" oraType="money"></input>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <listEntry>
      <date>2008-01-01</date>
      <amount>44.28</amount>
   </listEntry>
   <listEntry>
      <date>2008-02-01</date>
      <amount>32.87</amount>
   </listEntry>
   <listEntry>
      <date>2008-03-01</date>
      <amount>21.76</amount>
   </listEntry>
</root>
</xml>
</html>

HTML renderizado.

Renderização HTML para adicionar e excluir linha

Elementos não Formatados

Esta função é usada para exibir o conteúdo de um elemento que contém dados 'não processados', conforme definido para o elemento do esquema que está sendo renderizado.


Sintaxe
oraType="raw"

Esquema do Mapa da Interface do Usuário:


<schema>
    <rawStuff type="raw"/>
</schema>

Mapa da IU em HTML:


<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Raw Stuff:</td>
      <td><span oraType="raw" oraField="rawStuff"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <rawStuff>
      <ele1>text in element 1</ele1>
      <group1>
         <ele2>text inside element 2, group 1</ele2>
         <ele3>text inside element 3, group 1</ele3>
      </group1>
   </rawStuff>
</root>
</xml>
</html>

HTML renderizado.

Formatação de String

Esta função é usada para exibir o conteúdo de um elemento como XML legível quando o elemento contém XML escapado.


Sintaxe
oraType="xmlString"

Observação: Não é obrigatório, mas a formatação do XML renderizado é aprimorada se você especificar um par de referências da folha de estilo, cisEnabled e cisDisabled, no cabeçalho do mapa.

Exemplo:

<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>XML Stuff:</td>
      <td><span oraType="xmlString" oraField="xmlStuff"></span></td>
      </tr>
</table>
</body>
<xml>
<root>
   <xmlStuff>
      <ele1>text in element 1</ele1>
      <group1>
         <ele2>text inside element 2, group 1</ele2>
         <ele3>text inside element 3, group 1</ele3>
      </group1>
   </xmlStuff>
</root>
</xml>
</html>

HTML renderizado.

HTML renderizado sem oraType="xmlString"

Formatação HTML

Esta função é usada para exibir o conteúdo de um elemento como HTML em vez de texto simples. Um elemento definido como oraType="fkref" é automaticamente renderizado como HTML.


Sintaxe
oraType="html"

Alerta:

Para evitar a execução de HTML malicioso, nem todas as tags HTML são compatíveis. A lista de tags compatíveis está na definição de conteúdo gerenciado "F1-HTMLWhiteList".

Se um código HTML sem suporte for detectado, todo o elemento será escapado e renderizado como texto simples. Portanto, é recomendado escapar adequadamente qualquer string de origem que contribua para o elemento HTML final se não for esperado que ela contenha HTML válido. Assim, somente a string não compatível é escapada, em vez de todo o elemento.

Se o elemento HTML for composto em script, consulte a função 'escape' descrita em Editar Sintaxe dos Dados para obter mais informações. Use a API Java WebStringUtilities.asHTML para escapar o texto composto em Java.


<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
   <td>Info :</td>
   <td><span oraType="html" oraField="info"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <info><b>text in bold</b></info>
</root>
</xml>
</html>

HTML renderizado.

HTML renderizado sem oraType="html"

Exibir Rótulos

Derivar o Rótulo de um Elemento

Este atributo é usado para obter um rótulo idiomático para um elemento HTML <span>, <td> ou <input>.


Sintaxe	Valores Válidos
oraLabel=" "	XPath de um elemento no esquema do mapa da IU. O elemento precisa referenciar os atributos mapField=, mdField= ou label=.

Observação: Também é possível definir um campo diretamente no HTML para a definição do rótulo. Para obter mais informações, consulte Derivando o Rótulo de um Campo.

Observação: Se o esquema contém vários atributos, o atributo oraLabel seleciona o rótulo a ser renderizado de acordo com a seguinte hierarquia: o atributo label substitui o atributo mdField que, por sua vez, substitui o atributo mapField.

Esquema do Mapa da Interface do Usuário:

<schema>
   <user mapField="USER_ID"/> 
   <info type="group" mapXML="CLOB">
      <city label="Metro Area"/> 
      <age mdField="AGE_LBL"/>
   </info> 
</schema>

HTML:

<html>
<head><title oraMdLabel="BUS_LBL"></title></head>
<body>
<table>
   <tr>
      <td oraLabel="user"></td>
      <td><input oraField="user"/></td>
   </tr>
   <tr>
      <td oraLabel="info/city"></td>
      <td><input oraField="info/city"/></td>
   </tr>
   <tr>
      <td oraLabel="info/age"></td>
      <td><input oraField="info/age"/></td>
   </tr>
   <tr>
      <td/>
      <td><input type="button" oraMdLabel="ACCEPT_LBL"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <user>RWINSTON</user>
   <info>
      <city>Alameda</city>
      <age>32</age>
   </info>
</root>
</xml>
</html>

HTML renderizado:

Derivando o Rótulo de um Elemento

Este atributo é usado para obter um rótulo idiomático para um elemento HTML <span>, <td>, <input> ou <title>. O texto do rótulo é derivado do campo referenciado.


Sintaxe	Valores Válidos
oraMdLabel=" "	Código do Campo MD.

Observação: Também é possível definir rótulos derivados da definição do esquema do mapa. Para obter mais informações, consulte Derivar Rótulo de um Elemento.

HTML:

<html>
<head><title oraMdLabel="F1_DETAILS_LBL"></title></head>
<body>
<table>
   <tr>
      <td oraLabel="user"></td>
      <td><input oraField="user"/></td>
   </tr>
   <tr>
      <td oraLabel="info/city"></td>
      <td><input oraField="info/city"/></td>
   </tr>
   <tr>
      <td oraLabel="info/age"></td>
      <td><input oraField="info/age"/></td>
   </tr>
   <tr>
      <td/>
      <td><input type="button" oraMdLabel="ACCEPT_LBL"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <user>RWINSTON</user>
   <info>
      <city>Alameda</city>
      <age>32</age>
   </info>
</root>
</xml>
</html>

HTML renderizado:

Ativar Ajuda do Mapa da IU

A seção Exibir Rótulos descreve maneiras de derivar o rótulo de um elemento por meio de um Campo de Metadados subjacente. Além disso, se o mesmo campo de metadados contiver texto de ajuda, o sistema gerará automaticamente uma dica de ferramenta adjacente ao rótulo do elemento. Clicar na dica de ferramenta permitirá ao usuário visualizar o texto de ajuda.

É possível alterar a renderização da dica de ferramenta. Para obter mais informações, consulte Opções de Aparência Personalizada.

Pesquisar Usando uma Zona do Explorador em Janela Pop-Up

Opção de Pesquisa

Este atributo é usado para ativar a funcionalidade de zona de pesquisa para elementos HTML de entrada.


Sintaxe	Valores Válidos
oraSearch=" "	código da Zona.

Observação: O atributo oraSearch é semelhante ao oraType, pois será incluído 'automaticamente' no HTML por meio do atributo oraSchemaDataTypes. Isso significa que só é necessário codificar o atributo oraSearch no HTML do Mapa da IU se não houver zona de pesquisa especificada no esquema ou na referência de chave externa do elemento do esquema.

Exemplo de definição da pesquisa no HTML. Esquema do Mapa da IU:

<schema>
   <uiMap/> 
</schema>

HTML do Mapa da IU:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap" oraSearch="F1-UISRCH"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

Exemplo de definição da pesquisa no esquema. Esquema do Mapa da IU:

<schema> 
   <uiMap search="F1-UISRCH"/>
</schema>

HTML do Mapa da IU:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

Exemplo em que a referência da chave externa define a zona de pesquisa. Esquema do Mapa da IU:


<schema>
   <uiMap fkRef="F1-UISRC"/> 
</schema>

HTML do Mapa da IU:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

Em todos os casos, o HTML renderizado é o mesmo.

Inicializando Campos de Pesquisa

Este atributo opcional é usado para inicializar os filtros da zona de pesquisa. Vários filtros podem ser inicializados. O atributo só pode ser usado em conjunto com o atributo oraSearch.


Sintaxe	Valores Válidos	Opções do Valor do Campo	Comentários
oraSearchField=" "	Um ou mais pares de nome e valor do campo, separados por dois pontos. Cada par é separado por um ponto e vírgula. oraSearchField="fieldName:fieldValue: ..." O nome do campo é usado para identificar o filtro da zona a ser inicializado quando a pesquisa é iniciada. O nome do campo deve corresponder ao valor do mnemônico searchField especificado em um parâmetro de zona de pesquisa de filtro do usuário ou filtro oculto.	Nenhum valor	Se você não especificar um valor do campo, o valor do elemento de entrada que contém o atributo oraSearchField será usado.
		XPath	Indique o XPath para o elemento do esquema que contém o valor a ser usado.
		'literal'	Indica o fornecimento de um valor literal.

Observação: Se você não especificar um atributo oraSearchField, e o elemento do esquema tiver um fkRef ativado para pesquisa especificado, a estrutura vai gerar automaticamente um oraSearchField com nome do campo igual aos campos de metadados da chave da referência da chave externa.

Aviso: a zona do explorador em janela pop-up pode ser chamada de duas maneiras: com um clique no botão de pesquisa ou pressionando o Enter no campo à esquerda do botão. Se você clicar no botão, nenhuma informação de campo de pesquisa será transmitida para a zona. As informações do campo de pesquisa são usadas somente para inicializar valores do filtro da zona quando o Enter é pressionado.

Dois valores de filtro são inicializados, conforme mostrado no exemplo a seguir:

<schema>
   <bo/> 
   <uiMap/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap" oraSearch="F1-UISRCH" oraSearchField="MAP_CD; BUS_OBJ_CD:bo;"></td>
    </tr>
</table>
</body>
<xml>
<root>
   <bo/>
   <uiMap/>
</root>
</xml>
</html>

Mapeando Campos de Pesquisa Retornados

Este atributo opcional é usado para direcionar valores retornados pela zona de pesquisa. Vários campos podem ser especificados. O atributo só pode ser usado em conjunto com o atributo oraSearch.


Sintaxe	Valores Válidos	Opções do Valor do Campo	Comentários
oraSearchOut=" "	Um ou mais pares de nome e valor do campo, separados por dois pontos. Cada par é separado por um ponto e vírgula. oraSearchOut="field name:xpath target; ..." O nome do campo é usado para identificar o resultado da pesquisa retornado pela zona de consulta. O nome do campo precisa corresponder ao mnemônico ELEMENT_NAME definido dentro do parâmetro dos resultados de pesquisa da zona do explorador.	Nenhum valor	Se você não especificar um valor do campo, o elemento de entrada que contém o atributo oraSearchField receberá o valor retornado.
oraSearchOut=" "		XPath	Indique o XPath para o elemento do esquema que deve receber o valor retornado.

Observação: Se você não especificar um atributo oraSearchOut, a estrutura gerará um padrão em que o nome do campo será definido igual ao nome do campo oraSearchField.

Dois valores são retornados no exemplo a seguir:

<schema>
   <bo/>
   <mo/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>BO Search </td>
      <td><input oraField="bo" oraSearch="Z1-BOSRCH" oraSearchOut="BUS_OBJ_CD; MO_CD:mo;"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <bo/>
   <mo/>
</root>
</xml>
</html>

Exibir Erros

Exibir Variáveis do Erro

Uma das variáveis de erro a seguir pode ser exibida.


Sintaxe
oraErrorVar="ERRMSG-TEXT"
oraErrorVar="ERRMSG-LONG"
oraErrorVar="ERRMSG-CATEGORY"
oraErrorVar="ERRMSG-NUMBER"

...
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
...

HTML renderizado

Destacar um Campo com Erro

Observação: Para mais informações sobre a geração de erros, consulte Encerrar Instrução em Editar Sintaxe dos Dados.


Sintaxe	Comentários
oraError="automate:true\|false; prefix: "	A especificação de automate:true ativa automaticamente o destaque do elemento com erro quando o erro é emitido. Observe que verdadeiro é o padrão e não precisa ser especificado. Especifique automate:false para desativar o destaque do campo.
	O sistema usa uma correspondência no nome do elemento referenciado no erro aos nomes dos elementos no mapa da IU. Se os elementos do esquema estiverem em um XPath que pode não corresponder ao que é referenciado pelo erro, use prefix:XPath para especificar isso.

Observação: É necessário especificar um par de referências da folha de estilo, cisEnabled e cisDisabled, para referência do estilo oraError. A folha de estilo controla a renderização do campo com erro. Se você desejar alterar a renderização, precisará substituir o estilo oraError.

O exemplo em HTML a seguir mostra que os elementos do mapa estão definidos em um grupo chamado boGroup. O nome do elemento retornado pelo erro não incluirá esse grupo. Portanto, para que o destaque do campo funcione adequadamente, o atributo prefix: precisará indicar o nome do grupo.

<html>
<head>
   <title>User Zone Input</title>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body oraError="automate:true; prefix:boGroup">
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table width="100%" border="0" cellpadding="4">
   <tr style="padding-top:30px;">
      <td align="right" class="label">User Id</td>
      <td>
         <span oraField="boGroup/userId" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">First Name</td>
      <td>
         <input oraField="boGroup/firstName" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">Last Name</td>
      <td>
         <input oraField="boGroup/lastName" class="normal"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <boGroup>
      <userId>BOND007</userId>
      <firstName>James</firstName>
      <lastName></lastName>
   </boGroup>
</root>
</xml>
</html>

HTML renderizado, em que o elemento do erro gerado é igual a 'lastName':

oraErrorElement renderizado automaticamente com oraError na tag body

Substituindo o Nome do Elemento do Erro

Na rara ocasião em que o nome do elemento retornado pelo erro não corresponder ao nome do elemento no mapa, é possível adicionar um atributo explícito para indicar o nome do elemento do erro.


Sintaxe	Valores Válidos	Comentários
oraErrorElement=	"element name"	O nome do elemento referenciado aqui precisa corresponder exatamente ao nome do elemento de erro atribuído quando o erro foi gerado. É possível referenciar mais de um campo HTML com o mesmo nome do elemento do erro.

Isto ilustra um cenário em que o nome do elemento associado ao erro é diferente do nome do elemento no mapa.

<html>
<head>
   <title>User Zone Input</title>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table width="100%" border="0" cellpadding="4">
   <tr style="padding-top:30px;">
      <td align="right" class="label">User Id</td>
      <td>
         <span oraField="userId" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">First Name</td>
      <td>
         <input oraField="firstName" class="normal" oraErrorElement="firstName"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">Last Name</td>
      <td>
         <input oraField="familyName" class="normal"  oraErrorElement="lastName"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <userId>BOND007</userId>
   <firstName>James</firstName>
   <familyName></familyName>
</root>
</xml>
</html>

HTML renderizado.

Exibir Janela Pop-Up do Erro

Quando o texto do erro é exibido, esta função pode ser usada para criar uma janela pop-up com a caixa de diálogo padrão do erro, que exibe mais informações, quando o usuário clicar na mensagem de erro.


Sintaxe
oraShowErrorAlert(); return false;

<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table>
   <tr>
      <td >Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
   <tr>
      <td/>
      <td style="padding-top=15px;">
         <oraInclude map="F1-SaveCancelButtons"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

HTML renderizado.

Caixa de diálogo de erro padrão em janela pop-up iniciada por meio do clique na mensagem de erro:

Janela detalhada iniciada por meio da função oraShowAlert

Disparar JavaScript para Eventos do Navegador

Trabalhando com a Estrutura JavaScript

Há vários eventos JavaScript que podem ser usados dentro do ambiente HTML/JavaScript. Estes incluem eventos como onLoad, onBlur, onChange, etc. A Estrutura do Mapa da IU também utiliza alguns desses eventos. É importante que qualquer Mapa da IU desenvolvido funcione com a estrutura para que os resultados obtidos sejam consistentes, pois os eventos podem não ser sempre executados na mesma ordem.

Alerta:

Veja a seguir a abordagem recomendada para o tratamento seguro do carregamento e processamento das atualizações de campo dos Mapas da IU.

Se o JavaScript for necessário dentro de um Mapa ou fragmento de Mapa da Interface do Usuário em XHTML, será preciso colocá-lo dentro de uma tag ![CDATA[ ]]para garantir um documento XML válido. Note que as tags em si podem precisar de comentários para promover a compatibilidade com navegadores mais antigos. Por exemplo:


<script type="text/javascript">
/* <![CDATA[ */

//
// javascript
//

/* ]]> */

</script>

Evento de Alteração do Elemento


Sintaxe	Valores Válidos
oraChange=" "	Uma função JavaScript.

No momento em que o Mapa da IU é carregado, se há um gerenciador de eventos já anexado a um elemento HTML, a estrutura o remove e anexa um gerenciador de evento combinado. O gerenciador combinado chama quaisquer gerenciadores da estrutura primeiro e depois chama os outros gerenciadores (personalizados).

Aviso: note que a função não deve ser usada para executar uma lógica que modifique o valor dos dados do campo associado novamente. Se isso acontecer, um loop infinito ocorrerá.

No exemplo a seguir, a função oraInvokeBS é executada quando o botão é clicado.

<html>
  <head>
    <title>oraInvokeBS test</title>
  </head>
  <body>
    <table>
      <tr>
        <td>User Id:</td>
        <td>
          <input oraField= "xmlGroup/userId"/>
          <input type="button" value="Search" oraChange="oraInvokeBS('UserSearch','xmlGroup');"/>
        </td>
      </tr>
      <tr>
        <td/>
        <td>Search Results</td>
      </tr>
      <tr>
        <td/>
        <td>
          <table oraList="xmlGroup/searchList">
            <tr>
              <td><span oraField="userId"></span>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
  <xml>
    <root>
      <xmlGroup>
        <userId/>
        <searchList>
            <userId></userId>
        </searchList>
      </xmlGroup>
    </root>
  </xml>
</html>

Evento de Carregamento da Página


Sintaxe	Valores Válidos
oraLoad=" "	Uma função JavaScript.

Aviso: ao executar oraLoad em um fragmento de mapa da IU, se você precisar executar uma função JavaScript durante o carregamento da página que chame um objeto de negócios, um serviço de negócios ou um script de serviço, é possível usar a sintaxe especial "oraLoad[$SEQUENCEID]". Para outras sintaxes especiais usadas em fragmentos de mapa, consulte a seçãoCriar um Cabeçalho da Zona do Portal.

No exemplo a seguir, a função oraDisplayNone é executada durante o carregamento da página:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td oraLoad="oraDisplayNone(item,'userId','')">User Id: </td>
        <td><span oraField="userId"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId>SPLAXT</userId>
</root>
</xml>
</html>

HTML renderizado

Evento Pós-Carregamento da Página


Sintaxe	Valores Válidos
oraAfterLoad=""	Uma função JavaScript.

No exemplo a seguir, a função oraGetValueFromScript é executada após o carregamento da página.

<div>
  <label for="boGroup_parameters_externalSystem" oraLabel="boGroup/parameters/externalSystem">
  </label>
    <span>
      <select oraSelect="bs:F1-RetrieveExternalSystems" class="oraInput" 
        id="boGroup_parameters_externalSystem" oraField="boGroup/parameters/externalSystem" 
        oraSelectOut="valuePath:results/externalSystem; descPath:results/description" 
        oraSelectIn="outboundMsgType:boGroup/parameters/outboundMsgType" 
        oraAfterLoad
        ="oraGetValueFromScript(document.getElementById('boGroup_parameters_externalSystem');">
      </select>
    </span>

</div>

Ocultar Elementos

Ocultar Usando uma Função

O sistema fornece várias técnicas para ocultar um elemento HTML.


Sintaxe	Valores Válidos	Comentários
oraDisplayNone(item );	(item, 'XPath', 'valor', 'operador')	Usado para ocultar um elemento com base no valor de outro elemento, referenciado pelo XPath. Informe um valor de ' ' para interrogar um valor em branco. Por padrão, o operador é '='. Pode também ser definida para outro operador como '!=', '>' ou '<'.
oraDisplayNone(item );	(item, nome da função, true \| false)	Usado para indicar uma função JavaScript, que deve retornar um Booliano.
oraIsSuppress="true"		Use esta opção para campos que precisam ser ocultados sempre e não dependem de outra coisa. Defina este atributo no elemento HTML (elemento div).

Exemplo em que o rótulo ID do Usuário é ocultado quando não há valor de ID do Usuário.

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td oraLoad="oraDisplayNone(item,'userId','')">User Id: </td>
        <td><span oraField="userId"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId></userId>
</root>
</xml>
</html>

Exemplo em que o botão Salvar é ocultado quando o usuário não tem segurança de acesso à ação alterar ('C') do serviço de aplicativo 'F1-DFLTS'.

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
   <td oraLoad="oraDisplayNone(item, oraHasSecurity('F1-DFLTS', 'C'), false );">
      <input name="Save" type="button" onclick="oraInvokeBO('CM-IndividualTaxpayer', null, 'replace')"/>
   </td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId></userId>
</root>
</xml>
</html>

Verificar Segurança de Acesso do Usuário

O sistema contém duas funções para verificar a segurança de acesso de um usuário a determinado serviço do aplicativo e modo de acesso. Estas geralmente são usadas para ocultar elementos.


Sintaxe	Parâmetros
oraHasSecurity( )	'código do Serviço do Aplicativo'
oraHasSecurity( )	'Modo de Acesso'
oraHasSecurityPath('x','y')	'XPath do Serviço do Aplicativo'
oraHasSecurityPath('x','y')	'XPath do Modo de Acesso'

Para ver um exemplo da função oraHasSecurity, consulte a seção anterior. A seguir, há um exemplo em que o botão do status é ocultado quando o usuário não tem segurança de acesso ao modo de acesso 'ACT' do serviço do aplicativo 'FORMTST'.

<html>
<body>
<table>
    <tr>
   <td oraLoad="oraDisplayNone(item, oraHasSecurityPath('appService', 'accessMode'), false );">
      <input oraField="statusLabel" type="button" onclick="oraRunScript('UpdateState','status');"/>
   </td>
    </tr>
</table>
</body>
<xml>
<root>
    <status>ACTIVATE</status>
<statusLabel>Activate</statusLabel>
<appService>FORMTST</appService>
    <accessMode>ACT</accessMode>
</root>
</xml>
</html>

Chamar Serviços com Base no Esquema

O sistema contém funções para chamar um objeto de negócios, serviço de negócios ou script de serviço.

Função Chamar Objeto de Negócios

Esta função é usada para realizar a interação com um objeto de negócios diretamente do HTML do mapa da IU. Ela retorna um valor 'verdadeiro' ou 'falso' caso a chamada encontre um erro.


Sintaxe	Parâmetros	Comentários
oraInvokeBO( )	'Nome do Objeto de Negócios'
	'XPath' ou null	Identifica um elemento do grupo por XPath. Se você especificar a palavra null, todo o objeto XML incorporado será transmitido.
	'ação'	Indica a ação a ser usada. Os valores válidos são add (adicionar), delete (excluir), read (ler), update (atualizar), replace (substituir), fastAdd (adição rápida) e fastUpdate (atualização rápida). Acesso rápido: consulte Ações do Objeto de Negócios para obter mais informações sobre as várias ações do objeto de negócios.

Exemplo com a instrução chamada em uma função JavaScript.

function invokeBO {
     if (!oraInvokeBO('F1-User','xmlGroup','read')) {
          oraShowErrorAlert();
          return;
}
}

Exemplo com a instrução chamada em onClick.

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeBO('F1-User');"/>

Função Chamar Serviço de Negócios

Esta função é usada para realizar a interação com um serviço de negócios diretamente do HTML do mapa da IU. Ela retorna um valor 'verdadeiro' ou 'falso' caso a chamada encontre um erro.


Sintaxe	Parâmetros	Comentários
oraInvokeBS( )	'Nome do Serviço de Negócios'
oraInvokeBS( )	'XPath' ou null	Identifica um elemento do grupo por XPath. Se você especificar a palavra null, todo o objeto XML incorporado será transmitido.

Exemplo com a instrução codificada em uma função JavaScript.

function invokeBS {
     if (!oraInvokeBS('F1-UserSearch','xmlGroup')) {
          oraShowErrorAlert();
          return;
  }
}

Exemplo com a instrução chamada em onClick.

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeBS('F1-RetrieveInfo');"/>

Função Chamar Script de Serviço

Esta função é usada para realizar a interação com um script de serviço diretamente do HTML do mapa da IU. Ela retorna um valor 'verdadeiro' ou 'falso' caso a chamada encontre um erro.


Sintaxe	Parâmetros	Comentários
oraInvokeSS( )	'Nome do Script de Serviço'
oraInvokeSS( )	'XPath' ou null	Identifica um elemento do grupo por XPath. Se você especificar a palavra null, o documento pertencente ao nó-pai será transmitido. Se o nó-pai não for suficiente, sempre é possível transmitir todo o documento por meio da seguinte sintaxe: `oraInvokeSS('service script', null, null, [$SEQUENCEID])`

Exemplo com a instrução chamada em uma função JavaScript:


function invokeSS {
     if (!oraInvokeSS('F1-GetUsers','xmlGroup')) {
          oraShowErrorAlert();
          return;
}
}

Exemplo com a instrução chamada em onClick.

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeSS('F1-GetUserInfo');"/>

Atualizar Mapa Renderizado ou Página do Portal

Atualizar Mapa

Esta função é usada para 'Atualizar' somente a zona do mapa que emite o comando.


Sintaxe
oraRefreshMap;

...
    <tr>
        <td/>
        <td><input type="button" onclick="oraRefreshMap();" value="Refresh"/></td>
    </tr>
...

Atualizar Página

Esta função é usada para atualizar todas as zonas do portal.


Sintaxe
oraRefreshPage;

...
    <tr>
        <td/>
        <td><input type="button" onclick="oraRefreshPage();" value="Refresh"/></td>
    </tr>
...

Incorporar Navegação da Estrutura

Navegar usando a Opção de Navegação

Esta função é usada para acessar outra página por meio das informações definidas em uma opção de navegação.


Sintaxe	Parâmetros
oraNavigate( );	'código da Opção de Navegação'
oraNavigate( );	'XPath da Chave'

Aviso: a função só deve ser usada em mapas da IU definidos dentro de uma zona do portal. Ela não deve ser usada dentro de um mapa da IU inicializado por um script de BPA.

O exemplo a seguir exibe dois usos possíveis para essa função: como URL e como botão. Note que o esquema do Mapa da IU precisa conter um atributo fkRef. Para obter mais informações, consulte Formatação da Referência de Chave Externa.

<schema>
    <userId fkRef="CI_USER"/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
       <td>User Link: </td>
       <td><a href="" onclick="oraNavigate('userMaint','userId'); return false;">
         <span oraField="userId" oraType="fkRef:CI_USER"></span></a>
       </td>
    </tr>
    <tr>
        <td>User Button: </td>
        <td><input type="submit" onclick="oraNavigate('userMaint','userId')" 
          value="Go to User"/></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId>SPLAXT</userId>
</root>
</xml>
</html>

HTML renderizado.

Iniciar Script de BPA


Sintaxe	Parâmetros	Comentários
oraRunScript( );	'código do script de BPA'
oraRunScript( );	'Elemento XPath'	Um ou mais valores de elemento podem ser transmitidos para o BPA, onde podem ser referenciados como variáveis temporárias.

Aviso: esta função só se aplica a mapas da IU exibidos nas zonas do portal. Os mapas da IU iniciados em um script de BPA em execução não podem iniciar diretamente outro script de BPA a partir do HTML do mapa da IU. Em vez disso, retorne um valor do mapa da IU e execute um tipo de etapa Executar Script ou Controle de Transferência.

Observação: É responsabilidade do autor do script retirar informações do armazenamento temporário nas etapas iniciais do script.

No exemplo a seguir, uma variável temporária chamada 'personId' é criada com o valor '1234567890', e o script de BPA chamado 'Editar Endereço' é iniciado.

<html>
<body>
<table>
   <tr>
      <td>
         <div oraField="address"></div>
         <span oraField="city"></span>
         <span>,</span>
         <span oraField="state"></span>
         <span oraField="zip"></span>
         <span oraField="country"></span>
         <a href="" onClick="oraRunScript('Edit Address','personId');">edit</a>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <personId>1234567890</personId>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

HTML renderizado.

Iniciar Script de BPA com Valores

Esta função é usada para iniciar um BPA, informando pares nome/valor a serem colocados em armazenamento temporário. Vários valores podem ser transmitidos. O script de BPA poderá então referenciar os valores temporários por nome.


Sintaxe	Parâmetros	Comentários
oraRunScriptWithValues( );	'código do script de BPA'
oraRunScriptWithValues( );	'Nome do Elemento XPath':value	Um ou mais pares de nomes de elementos e valores.

Observação: Use esta função JavaScript em vez de oraRunScript se precisar inserir valores no script de BPA que não estão localizados na estrutura XML do Mapa da IU.

No exemplo a seguir, uma função JavaScript chamada 'editUser()' é responsável por iniciar o script de BPA chamado 'UserEdit'. A variável temporária chamada 'userId' será criada com o valor 'CMURRAY'.

<html>
<head>
<script type="text/javascript">
 
function editUser() {
    var values = {'userId': 'CMURRAY'};
    oraRunScriptWithValues('UserEdit', values);
    return;
}
 
</script>
</head>
<body>
...
</body>
</html>

Sair de Mapa da IU com Valores Associados

Esta função é usada para sair de um Mapa da IU. Ao sair do mapa, é possível especificar um valor para retornar ao script e se o XML atualizado deve ser retornado.


Sintaxe	Parâmetros	Comentários
oraSubmitMap( );	'Valor de Retorno'
oraSubmitMap( );	Valor booliano	Indica se o XML atualizado deve ser retornado. O padrão é true.

No exemplo a seguir, o botão Salvar retornará as informações atualizadas. O botão Cancelar, não.

<html>
<body>
<table>
   <tr>
      <td/>
      <td style="padding-bottom:15px;">
         <a href="" onclick="oraShowErrorAlert(); return false;">
         <span oraErrorVar="ERRMSG-TEXT"></span></a>
      </td>
   </tr>
   <tr>
      <td >Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
   <tr>
      <td/>
      <td style="padding-top=15px;">
         <input type="button" value="Save" onClick="oraSubmitMap('SAVE');"/>
         <input type="button" value="Cancel" onClick="oraSubmitMap('CANCEL',false);"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

Botões Salvar e Cancelar renderizados:

Incluir um Fragmento de Mapa

Esta função é usada para incorporar um fragmento de mapa em outro mapa da IU. Note que é possível usar o nó include em um mapa ou fragmento de mapa.


Sintaxe	Parâmetros	Comentários
<oraInclude map=' ' prefixPath=' '/>	map='Código do Mapa da IU'
<oraInclude map=' ' prefixPath=' '/>	prefixPath='Xpath'	Opcionalmente, especifique um prefixo de XPath a ser anexado a cada valor de atributo oraField, oraLabel, oraList, oraSelect, valuePath e descPath, oraDownloadData e oraUploadData definido no HTML do fragmento de mapa incluído. Observação: Esta funcionalidade só se aplica aos valores de atributo XPath quando esses valores não são exibidos abaixo de um atributo oraList. Qualquer valor de XPath dentro de uma tabela que contenha um atributo oraList não será afetado por prefixPath.

Um exemplo de fragmento de mapa com dois botões chamado 'F1-SaveCancelButtons'.

<input onClick ="oraSubmitMap('SAVE');" oraMdLabel="SAVE_BTN_LBL" class="oraButton" 
type="button"/>
<input onClick ="oraSubmitMap('CANCEL',false);" oraMdLabel="CANCEL_LBL" class="oraButton" 
type="button"/>

Um exemplo de mapa que inclui o fragmento de mapa chamado 'F1-SaveCancelButtons'.

...
<tr>
   <td colspan="2" align="center">
<oraInclude map="F1-SaveCancelButtons"/>
   </td>
</tr>
...

Incluir um componente da Web

Um componente Web é um elemento HTML personalizado que produz um recurso de interface do usuário específico. Cada componente da Web suportado geralmente tem um ou mais atributos HTML definidos que afetam como o componente da Web funciona e como ele aparece. Os componentes Web mais complexos podem ter um objeto de configuração do sistema correspondente que define o comportamento e as informações exibidas pelo elemento da interface do usuário resultante. Por exemplo, o componente Web que produz uma "árvore" de informações tem uma tabela de configuração Árvore, que define os detalhes sobre como recuperar informações para a árvore e como exibir cada nó.

Atributos Comuns

Alguns atributos comuns que podem ser usados para cada componente Web são:

Uma referência à instância específica do objeto de configuração que controla os detalhes a serem produzidos.
A capacidade de transmitir dados de contexto como pares de nome e valor.
Um 'modo' que suporta a exibição de uma visualização do recurso

Alguns atributos suportam um valor único que é referenciado. Para esses tipos de atributos, o valor pode ser fornecido usando uma das seguintes referências:

Valor literal. O valor pode ser referenciado diretamente. Exemplo:
```
treename="F1-Tree"
```
Referência XPath. As referências XPath devem usar a sintaxe explícita x[value]. Exemplo:
```
treename="x[migrationTree]"
```
Referência de contexto global ou do Portal. Essas referências devem usar a sintaxe explícita c[value].
```
treename="c[TREE_NAME]"
```
Referência do rótulo do campo. Essas referências devem usar a sintaxe explícita md[value] .
```
text=md[F1_ADD_LBL]"
```
Referência do texto de ajuda do campo. Essas referências devem usar a sintaxe explícita mdh[value] .
```
text=mdh[F1_OPERATIONS_LBL]"
```

Para atributos complexos que suportam um ou mais pares de nome/valor, a sintaxe para definir os nomes e valores segue as mesmas regras acima para valores literais, referências XPath e contexto. Os dois-pontos (":") devem ser usados para separar o nome do valor e os pontos-e-vírgulas (";") para separar cada par.

context="FIELD_NAME1:x[value1];FIELD_NAME2:F1AB;x[fieldName3]:c[FIELD_NAME3];"

Um determinado componente da Web pode ter atributos HTML adicionais específicos de sua funcionalidade.

Observação: Qualquer mapa da interface do usuário que define um componente Web deve incluir o fragmento de mapa F1-OJETLIBSR na tag "body".

<body>
<oraInclude map="F1-OJETLIBSR"/>
..
</body>

Observação: Os atributos HTML padrão também podem ser fornecidos (por exemplo, ID=".." e style=".."). Eles são definidos como normais. Deve-se notar que os próprios componentes da Web podem controlar alguns aspectos de estilo diretamente e, portanto, substituir quaisquer configurações de estilo fornecidas no componente da Web HTML. Por exemplo, a configuração de Insights Contextuais fornece definições para a cor do texto que substituiria qualquer cor definida no HTML.

As seções a seguir descrevem cada componente da Web suportado.

Estruturas

Consulte Estruturas para obter mais informações sobre a configuração de estruturas.


Sintaxe	Parâmetros	Comentários
<ou-tree...></ou-tree>	treename="singleValue"	Você deve fornecer uma referência ao nome do objeto da estrutura que define a configuração da estrutura a ser exibida. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima.
<ou-tree...></ou-tree>	context="..."	Opcionalmente, informe um ou mais pares de nome/valor. A sintaxe segue o exemplo mostrado nas informações de atributos complexos acima.

O exemplo a seguir usa uma referência explícita a uma estrutura e não passa em nenhum contexto. A estrutura específica depende do contexto global ao qual o algoritmo do nó de estrutura tem acesso.

<ou-tree treename="C1-PremiseTree"></ou-tree>

Insight Contextual

Consulte Insights Contextuais para obter informações sobre a configuração relacionada à definição de insights contextuais.


Sintaxe	Parâmetros	Comentários
<ou-insights ...></ou-insights>	insightType="singleValue"	Use este atributo para especificar um tipo de insight a ser exibido. Este atributo ou o atributo de classe de insight deve ser fornecido. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima.
	insightClass="singleValue"	Use uma classe de informações para exibir todos os tipos de informações do grupo de informações relacionado a essa classe. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima.
	context="..."	Opcionalmente, informe um ou mais pares de nome/valor. A sintaxe segue o exemplo mostrado nas informações de atributos complexos acima.
	mode="preview"	Opcionalmente, passe em um modo de preview para indicar ao algoritmo de insight subjacente que prepara os dados que o insight está sendo chamado no modo de visualização, sem contexto disponível. Idealmente, o algoritmo retorna informações de amostra.
	class=" "	Opcionalmente, forneça uma classe auxiliar CSS para controlar aspectos do insight renderizado. Valores suportados: class="card-full-width" - Aplicável a insights de cartão. Use esta classe de opção para garantir que a largura de um insight de cartão se ajuste à largura da zona que o contém. Os insights de cartão que não definem esse parâmetro usam uma largura fixa.

O exemplo a seguir é do mapa de visualização de informações em que o tipo de insight é aquele no contexto. Nenhum dado de contexto é necessário e o modo é "visualizar".

<ou-insights insightType="x[insightType]" mode="preview"></ou-insights>

O exemplo a seguir usa uma classe de insight e passa valores de contexto de elementos XPath com nomes de contexto definidos explicitamente.

<ou-insights insightClass="C1CI" context="PER_ID:x[personId];ACCT_ID:x[accountId];PREM_ID:x[premiseId];"></ou-insights>

Botão

O componente Web do botão fornece suporte para o conjunto padrão de formatos de botão usados no sistema.


Sintaxe	Parâmetros	Comentários
<ou-button...></ou-button>	type=”singleValue”	Você deve definir o tipo de botão a ser exibido. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima. Os valores válidos são: image - image only text - somente texto imageText - imagem seguida pelo texto menu - texto mais um cursor drop-down para abrir o menu imageMenu - imagem mais um cursor drop-down para abrir o menu Se nenhum atributo de tipo for fornecido, uma imagem de 'botão interrompido' será exibida.
	img=”singleValue”	Defina o caminho da imagem a ser exibida. Este atributo ou o atributo de referência de imagem deve ser fornecido para um tipo de botão que inclua uma imagem. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima. Observe que, para imagens SVG, se a referência incluir apenas o nome do arquivo SVG sem caminho, o caminho será considerado o repositório SVG de Estrutura.
	imgRef=”singleValue”	Defina a referência do ícone de exibição da imagem a ser usada. Este atributo ou o atributo de imagem deve ser fornecido para um tipo de botão que inclua uma imagem. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima.
	text="..."	Defina os vários elementos de texto necessários ao botão. A sintaxe segue o exemplo mostrado nas informações de atributos complexos acima. Os valores válidos de nome do elemento de texto são: label - o texto do label a ser usado para o botão tooltip - o texto suspenso a ser usado para o botão aria-label - o rótulo ARIA do botão
	menu=”singleValue”	Defina o menu a ser usado com o botão. Este atributo deve ser fornecido para um tipo de botão que inclua um controle de menu. Esse atributo espera um único valor que siga a sintaxe descrita na seção de valor único acima.
	disabled=”singleValue”	Este é um atributo HTML padrão. Um valor "verdadeiro" ou apenas a presença do texto "desativado" resultará em um botão desativado inicialmente.
	segurança="..."	Opcionalmente, defina as configurações de segurança para o botão. O botão ficará oculto se o usuário não tiver o acesso de segurança apropriado. A sintaxe segue o exemplo mostrado nas informações de atributos complexos acima. Os valores válidos de nome do elemento de segurança são: service - o serviço de aplicativo cujo acesso de segurança controla o acesso ao botão accessMode - o modo de acesso específico do serviço que determina um nível de acesso mais granular ao botão
	clickAction="..."	Opcionalmente, defina a ação a ser tomada quando o botão for "clicado". A sintaxe segue o exemplo mostrado nas informações de atributos complexos acima. Existem valores 'name' específicos para o atributo da seguinte forma: action - a ação a ser tomada. Os valores válidos são 'BPA' e 'NAVIGATE' script - o script a ser executado quando a ação for 'BPA' navopt – opção de navegação a ser usada quando a ação for ‘NAVIGATE’ O atributo também pode incluir outros pares de nome/valor que definem informações a serem passadas para o script ou usadas como campos de contexto de navegação. Além das configurações do atributo de segurança, o sistema verificará se o usuário tem acesso ao script ou ao caminho de navegação antes de executar a ação. O atributo HTML padrão 'onClick' ainda pode ser usado. Se o HTML incluir um atributo 'onClick' e o atributo 'clickAction', o atributo 'onClick' terá precedência.

Veja a seguir um exemplo de botão simples com texto.

<ou-button type="text" text="label:md[F1_BOOKMARK_LBL];"></ou-button>

Veja a seguir um exemplo de botão de ícone usando uma referência de ícone de exibição.

<ou-button type="image" imgRef="F1CMNT"></ou-button>

Veja a seguir um exemplo de botão de menu de imagem.

<ou-button type="imageMenu" imgRef="F1STTGS" menu="CI_CONTEXTSCRIPT" text="tooltip:md[F1INSTY_VIS_LBL];></ou-button>

Veja a seguir um exemplo de botão de texto que navega para outra página.

<ou-button type="text" text="label:md[ALG_CD];tooltip:md[GOTO_ALG]" clickAction="action:NAVIGATE; navopt:f1algqTabMenu; ALG_CD:x[algorithm];></ou-button>

Mostrar Padrão do Esquema ao Adicionar

Os valores padrão do esquema do mapa da IU serão exibidos nos campos de entrada de um mapa da IU se um nó <action> incorporado tiver um valor 'ADD' ou em branco.


Sintaxe
<action>ADD</action>

<action> </action>

O padrão do esquema para o elemento <description> será exibido:

<schema>
    <action/>
    <boGroup type="group">
        <key/>
        <description default="enter description here"/>
    </boGroup>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td>Description   </td>
        <td><input oraField="boGroup/description"></td>
    </tr>
</table>
</body>
<xml>
<root>
    <action>ADD</action>
    <boGroup>
        <key/>
        <description/>
    </boGroup>
</root>
</xml>
</html>

HTML renderizado.

Configurar um Gráfico

Além de integrar gráficos a zonas, o sistema suporta o uso dos mesmos atributos no HTML do Mapa da Interface do Usuário para configurar uma representação gráfica de uma lista XML. O designer pode controlar o tipo, o tamanho, a posição e o conteúdo do gráfico por meio desses atributos. Para obter detalhes dos atributos e da sintaxe, consulte Configuração do Gráfico do Explorador de Dados.

Exemplos de Gráficos

Exemplo de uma configuração de gráfico de pizza:

<html>
<head>
<title>Pie Chart</title>
</head>
<body>
 
<div style="width:100%; height:290px;"
    oraChart="type:pie;"
    oraChartSeries1="list:set; labelPath:date; amount:amount; "
    oraChartBroadcast="BILL_ID:billId;">
</div>
 
</body>
 
<xml>
<root>
  <set>
<date>05-02-2003</date>
<amount>163.24</amount>
<billId>592211649441</billId>
  </set>
  <set>
<date>06-02-2003</date>
<amount>97.29</amount>
<billId>592211649442</billId>
  </set>
  <set>
<date>07-02-2003</date>
<amount>54.38</amount>
<billId>592211649443</billId>
  </set>
</root>
</xml>
</html>

Um gráfico de pizza renderizado para uma série:

Exemplo de uma configuração de gráfico de linha, cluster ou empilhado, cada um com duas séries:

<html>
<head>
<title>Stacked Chart</title>
</head>
<body>
 
<div style="width:100%; height=300px;"
    oraChart="type:line;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
    oraChartBroadcast="BILL_ID:billId;">
</div>
 
<div style="width:100%; height=300px;"
oraChart="type:cluster;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
oraChartBroadcast="BILL_ID:billId;">
</div>
 
<div style="width:100%; height=300px;"
oraChart="type:stacked;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
oraChartBroadcast="BILL_ID:billId;">
</div>
 
</body>
 
<xml>
<root>
  <set>
<date>05-02-2003</date>
<amount>163.24</amount>
<balance>163.24</balance>
<billId>592211649441</billId>
  </set>
  <set>
<date>06-02-2003</date>
<amount>97.29</amount>
<balance>260.53</balance>
<billId>592211649442</billId>
  </set>
  <set>
<date>07-02-2003</date>
<amount>54.38</amount>
<balance>314.91</balance>
<billId>592211649443</billId>
  </set>
</root>
</xml>
</html>

Três tipos de gráfico renderizados para duas séries cada: linha, cluster e empilhado.

Upload e Download de um Arquivo CSV

Os atributos HTML a seguir podem ser usados para gerenciar um upload e um download entre uma lista definida dentro do esquema do mapa e um arquivo CSV (valores separados por vírgulas). Note que essa técnica é recomendada apenas para volumes de dados pequenos a médios; por exemplo, para menos de algumas centenas de linhas. Para volumes maiores, recomenda-se usar a funcionalidade de upload/download em batch.

A sintaxe é oraUploadData="type:embed;path:list xpath;useLabels:true;showCount:true"

A configuração do upload exige que você nomeie um arquivo CSV a ser carregado e uma lista XML como destino. Por convenção, cada linha do CSV criará uma instância separada da lista. Cada campo separado por vírgula do arquivo será carregado como um elemento separado da lista. Para incorporar uma caixa de diálogo de upload ao mapa, o atributo oraUploadData deve ser associado ao um elemento de contêiner, como div, td ou span.

O valor opcional useLabels:true indica que, durante a análise do arquivo CSV carregado, o esperado é que os cabeçalhos sejam rótulos.

Observação: Se você não especificar o valor useLabels:true, e o nome do elemento de destino do XML for "camelCase", o cabeçalho de planilha correspondente precisará ter a primeira letra de cada palavra em maiúscula, com um espaço entre as palavras. Exemplo: "Camel Case". As letras e caracteres especiais não são considerados palavras diferentes. Por exemplo, Address1 deve ser carregado no elemento XML de destino address1.

A especificação do valor opcional showCount:true exibirá o número de registros carregados.

CUIDADO: se você usar uma grade em conjunto com a função oraUploadData, será necessário atualizar a lista da grade com uma ação do objeto de negócios "replace". Para obter mais informações, consulte Ação Substituir do Objeto de Negócios.

Exemplo de oraUploadData="embed" dentro de um elemento div.

<html>
<head>
    <title>File Upload</title>
</head>
<body>
   
    <div oraUploadData="type:embed;path:myList"> </div>
 
</body>
 
<xml>
<root>
    <myList>
<id>838383930</id>
        <name>Janice Smith</name>
    </myList>
    <myList>
<id>737773730</id>
        <name>Bill McCollum</name>
    </myList>
</root>
</xml>
</html>

Esta caixa de diálogo de upload estará incorporada ao corpo da página, onde oraUploadData está definido.

Caixa de Diálogo de Upload de Arquivo Incorporado

oraUploadData="type:popup;path:list xpath;useLabels:true;showOk:true;showCount:true"

A configuração do upload exige que você nomeie um arquivo CSV a ser carregado e uma lista XML como destino. Por convenção, cada linha do CSV criará uma instância separada da lista. Cada campo separado por vírgula do arquivo será carregado como um elemento separado da lista. Para o upload de um arquivo CSV por meio de uma caixa de diálogo em janela pop-up, o atributo oraUploadData precisa ser associado a um elemento de entrada, como um botão, link de texto ou imagem.

O valor opcional useLabels:true indica que, durante a análise do arquivo CSV carregado, o esperado é que os cabeçalhos sejam rótulos.

A especificação do valor opcional showOk:true exibirá um botão "Ok" quando o upload for concluído. A janela pop-up permanecerá aberta até que o botão seja pressionado. Além disso, a especificação do valor opcional showCount:true exibirá o número de registros carregados.

Exemplo de oraUploadData="popup" associado a um botão:

<html>
<head>
    <title>File Upload</title>
</head>
<body>
   <input type="button" name="submitButton" oraUploadData="type:popup;path:myList;" value='Get Data'>
   <table oraList="myList">
      <tr/>
      <tr>
         <td><span oraField="id"/></td>
         <td><span oraField="name"/></td>
      </tr>
   </table>
</body>
<xml>
<root>
   <myList>
      <id>838383930</id>
      <name>Janice Smith</name>
   </myList>
   <myList>
      <id>737773730</id>
      <name>Bill McCollum</name>
   </myList>
</root>
</xml>
</html>

HTML Renderizado:

Atributo oraUploadData anexado ao botão Obter Dados

Pressionar o botão "Obter Dados" inicia uma caixa de diálogo padrão de upload de arquivo fornecida pela Estrutura, conforme mostrado a seguir.

oraDownloadData="list xpath"

A configuração do download exige a nomeação de uma lista XML. Por convenção, cada instância da lista representará uma linha separada no arquivo criado. Por padrão, todos os elementos da lista estarão separados por vírgulas no arquivo.

Observação: A formatação dos números se baseia na definição do perfil do usuário. Para locais onde o símbolo de decimal é uma vírgula, a implementação pode configurar uma definição de propriedade (spl.csv.delimiter.useFromDisplayProfile=true) para fazer com que o sistema use ponto e vírgula como delimitador para separar os elementos, em vez de vírgula.

Exemplo de oraDownloadData.

<html>
<head>
<title>File Download</title></head>
<body>
<input type="button" name="downloadButton" oraDownloadData="myList" value="Download"/>
</body>
<xml>
<root>
   <myList>
      <id>881-990987</id>
      <name>John Mayweather</name>
   </myList>
   <myList>
      <id>229-765467</id>
      <name>Anna Mayweather</name>
   </myList>
   <myList>
      <id>943-890432</id>
      <name>Andrew Brewster</name>
   </myList>
</root>
</xml>
</html>

HTML Renderizado:

oraDownloadData anexado ao botão Download

Pressionar o botão "Download" inicia uma caixa de diálogo padrão de download de arquivo fornecida pela Estrutura, conforme mostrado a seguir.

Caixa de diálogo em janela pop-up Download de Arquivo

Um download bem-sucedido resultará em um arquivo CSV:

Para realizar o download dos dados de uma sublista, use o atributo oraDownloadDataInList em vez de oraDownloadData. O atributo oraDownloadDataInList terá o nome da sublista. O XPath da sublista é usado para selecionar dados da linha específica da lista-pai. Assim, só o download da sublista específica é realizado.

oraDownloadDataUseLabels="true"

O atributo oraDownloadDataUseLabels pode ser usado em conjunto com o atributo oraDownloadData descrito anteriormente. Especifique oraDownloadDataUseLabels se você quiser que o arquivo CSV gerado use os rótulos dos elementos como cabeçalhos de coluna, em vez dos nomes dos elementos.

Criar Fragmentos de Mapa da Zona do Portal

As zonas do portal podem referenciar um mapa da interface do usuário para o cabeçalho da zona e para a área de filtro. Esse mapa da interface do usuário não é um documento HTML completo, mas está configurado como um fragmento do Mapa da IU. Ao criar um fragmento de mapa da zona, é possível referenciar as variáveis de substituição a seguir. Note que essas variáveis serão preenchidas dinamicamente no momento da execução com informações particulares à zona do mapa dentro do portal:


Variável	Lógica de Substituição
[$ZONEDESCRIPTION]	Texto de descrição da zona.
[$SEQUENCEID]	ID de sequência da zona.
[$ZONENAME]	Nome da zona.
[$HELPTEXT]	Texto de ajuda da zona.
[$ZONEPARAMNAME]	Valor do parâmetro da zona (ou em branco, se não for especificado).

Alerta:

Consulte um dos seguintes mapas como exemplos: F1-UIMapHeader e F1-ExplorerHeader.
Esses mapas usam a tag oraInclude para incorporar fragmentos de HTML ao menu do cabeçalho e às ações da estrutura. Consulte os parâmetros do tipo de zona para obter os fragmentos do Mapa da IU que você deve incluir no HTML.
Se desejar que o ícone do "texto de ajuda" seja exibido ao lado da descrição da zona, você precisará ter id="title_[$SEQUENCEID]" no <td> que contém a descrição desejada.
Se for necessário encapsular o JavaScript em um fragmento de Mapa da Interface do Usuário, será preciso vincular o JavaScript a uma tag ![CDATA[ ]] para garantir um documento XML válido. Note que as tags em si podem precisar de comentários para promover a compatibilidade com navegadores mais antigos. Por exemplo:
```
<script type="text/javascript">

/*<![CDATA[ */

//
//javascript
//
/*]]> */
</script>
```

Observação: Se você desejar preservar os valores de um campo de entrada de filtro dentro de um fragmento de mapa para a funcionalidade 'Voltar' e 'Avançar' da estrutura, será necessário associar o campo de entrada (caixa de texto, seleção etc.) a um ID HTML exclusivo. Os valores de campo de entrada associados a um ID exclusivo serão capturados no 'memento' da estrutura. O 'memento' é usado para reconstruir o mapa de entrada quando a zona do portal é acessada por meio da funcionalidade 'Voltar' ou 'Avançar'.

Observação: Existem muitas funções especializadas para manipular o comportamento da zona, por exemplo:

oraGetZoneSequence(zoneName). Usa o código da zona para recuperar o número de sequência dela.
oraIsZoneCollapsed(sequenceId). Usa a sequência da zona para determinar se ela é minimizada.
oraHandleCollapse(seq). Minimiza a zona.
oraHandleExpand(seq,refresh). Expande e/ou atualiza uma zona.

Todas essas e muitas outras funções estão localizadas na biblioteca JavaScript userMapSupport.js descrita a seguir.

Observação: Ao executar oraLoad em um fragmento de mapa da IU, se você precisar executar uma função JavaScript durante o carregamento da página que chame um objeto de negócios, um serviço de negócios ou um script de serviço, é possível usar a sintaxe especial "oraLoad[$SEQUENCEID]". Para obter mais informações, consulte a seção Evento ao Carregar Página.

Exemplo de oraLoad[$SEQUENCEID] usado em uma função:

<script type="text/javascript">
function oraLoad[$SEQUENCEID]() {
checkRebateClaimStatus();
}
 
function checkRebateClaimStatus() {
    var work = id(''analyticsFilterText[$SEQUENCEID]'',
document).cells[0].innerText.split('' '');
    var rebateClaimId = work[work.length - 3];
    id(''rebateClaimId'', document).value = rebateClaimId;
oraInvokeSS(''C1-CheckRCSt'',''checkRebateClaimStatus'', false);
    var statusIndicator = id(''statusInd'', document).value;
    if (statusIndicator == ''C1PE'' || statusIndicator == ''C1ID'') {
       id(''addRebateClaimLine'', document).style.display = '''';
    } else {
id(''addRebateClaimLine'', document).style.display = ''none'';
    }
}
</script>

F1-ExplorerHeader renderizado:

Chamando um Objeto de Negócios

A função oraInvokeBO pode ser usada no cabeçalho de uma zona do portal ou no mapa de um filtro da zona. Ela é semelhante ao comando descrito em Função Chamar Objeto de Negócios, que permite a chamada para um objeto de negócios de dentro do HTML do mapa da IU. Para obter uma descrição dos primeiros três parâmetros, consulte a seção citada.


Sintaxe	Parâmetros	Comentários
oraInvokeBO( )	'Nome do Objeto de Negócios'
	'XPath' ou null
	'ação'
	null	Isto precisa ser especificado como o quarto argumento.
	[$SEQUENCEID]	Isto precisa ser especificado como o quinto argumento.
	true \| false	Especifique true se o fragmento for usado em um cabeçalho de zona do portal. Especifique false se o fragmento for usado com um mapa de filtro da zona.

Exemplo em um cabeçalho de zona do portal:

oraInvokeBO('CM-User','xmlGroup','read', null, [$SEQUENCEID], true)

Chamando um Serviço de Negócios

A função oraInvokeBS pode ser usada no cabeçalho de uma zona do portal ou no mapa de um filtro da zona. Ela é semelhante ao comando descrito em Função Chamar Serviço de Negócios, que permite a chamada para um serviço de negócios de dentro do HTML do mapa da IU. Para obter uma descrição dos primeiros dois parâmetros, consulte a seção citada.


Sintaxe	Parâmetros	Comentários
oraInvokeBS( )	'Nome do Objeto de Negócios'
	'XPath' ou null
	null	Isto precisa ser especificado como o quarto argumento.
	[$SEQUENCEID]	Isto precisa ser especificado como o quinto argumento.
	true \| false	Especifique true se o fragmento for usado em um cabeçalho de zona do portal. Especifique false se o fragmento for usado com um mapa de filtro da zona.

Exemplo em um cabeçalho de zona do portal:

oraInvokeBS('CM-UserSearch','xmlGroup', null, [$SEQUENCEID], true)

Chamando um Script de Serviço

A função oraInvokeSS pode ser usada no cabeçalho de uma zona do portal ou no mapa de um filtro da zona. Ela é semelhante ao comando descrito em Função Chamar Script de Serviço, que permite a chamada para um script de serviço de dentro do HTML do mapa da IU. Para obter uma descrição dos primeiros dois parâmetros, consulte a seção citada.


Sintaxe	Parâmetros	Comentários
oraInvokeSS( )	'Nome do Script de Serviço'
	'XPath' ou null
	null	Isto precisa ser especificado como o quarto argumento.
	[$SEQUENCEID]	Isto precisa ser especificado como o quinto argumento.
	true \| false	Especifique true se o fragmento for usado em um cabeçalho de zona do portal. Especifique false se o fragmento for usado com um mapa de filtro da zona.

Exemplo em um cabeçalho de zona do portal:

oraInvokeSS('UserSearch','xmlGroup', null, [$SEQUENCEID], true)

Detectando Alterações Não Salvas

Utilize essa função para retornar um conjunto Booliano para true caso haja alterações não salvas. O sistema interrogará a função quando o usuário tentar navegar, emitindo um aviso apropriado. Essa função é necessária apenas se um mapa de IU estiver utilizando um JavaScript personalizado para gerenciar elementos de forma que o sistema não possa detectar se alterações foram feitas ou não. Além disso, é responsabilidade do JavaScript do mapa da IU gerenciar os valores no Booliano utilizado nessa função.

function hasUnsavedChanges(){
       return isDirtyFlag;
   }

Ocultando Guias do Portal

O produto possibilita o uso de JavaScript para ocultar uma guia do portal atual com base em alguma condição por meio da API JavaScript oraAuthorizeTab. Essa API aceita uma função como parâmetro e desativa o índice da guia indicada.

Por exemplo, o Mapa da IU pode ter uma função para desativar um ou mais índices de guia:

function overrideTabIndex(index){
    if (index == 2) return false;
    if (index == 3) return false;
  }

O JavaScript é referenciado “on load”:

<body class="oraZoneMap"
onLoad="oraAuthorizeTab(overrideTabIndex);">

Bibliotecas JavaScript Obrigatórias

Toda a funcionalidade descrita neste documento depende de duas bibliotecas JavaScript. Se você gravar e executar os mapas totalmente dentro da estrutura de renderização do mapa da IU, não será necessário inserir manualmente as bibliotecas a seguir. A estrutura vai inseri-las na renderização do Mapa da IU.

Aviso: ao executar HTML fora da estrutura, será necessário incluir as referências a seguir explicitamente no código HTML. Além disso, a ferramenta usada para renderizar o HTML precisará ter acesso a uma cópia física de privateUserMapSupport.js para suporte à associação.

src="privateUserMapSupport.js"

O documento HTML precisa referenciar esta biblioteca para executar a associação em um ambiente independente.

Aviso: o referenciamento de funções dentro desta biblioteca JavaScript é perigoso, pois essas funções são de propriedade da estrutura e podem ser alteradas durante a atualização de versão ou por meio do processo de patch normal.

<script type="text/javascript" src="privateUserMapSupport.js"></script>

src="userMapSupport.js"

Para aproveitar os recursos opcionais do conjunto de ferramentas, é preciso referenciar esta biblioteca.

Observação: É possível referenciar as funções desta biblioteca JavaScript para gravar funções personalizadas no mapa da IU.

<script type="text/javascript" src="userMapSupport.js"></script>

onload="oraInitializeUserMap();"

Para executar a associação em um ambiente independente, será necessário incorporar a função onload a seguir ao nó <body>.

<body onload="oraInitializeUserMap();">