Exibir código-fonte para Embargo na interface JSPUI

== Introdução ==

No formulário, o embargo pode ser configurado de duas formas: 

* '''data limite''', ou
* '''quantidade de dias'''

Estes dois modos serão abordados a seguir.

=== Data limite ===

Primeiramente é necessário criar um campo no esquema de metadados, o qual será utilizado para armazenar a data limite para o embargo do documento, por exemplo: '''dc.description.embargo'''. Acesse (logado como administrador) ''Administrador -> registro de metadados -> registro de metadados'' (normalmente http://dublincore.org/documents/dcmi-terms/)'' -> Registro de campo de metadado''. Ao final da página ''Adicionar campo de metadado'':

[[Arquivo:Ad_metadado.png|center|700px]]

Preencha os campos ''Elemento'' e ''Qualificador'', e clique em ''Adicionar novo''. O preenchimento do campo ''Nota de escopo'' é opcional.

Edite o arquivo '''[dspace-base]/config/input-forms.xml'''. 

{{Nota|O novo metadado deve ser inserido/atualizado em todos os formulários onde se utiliza mecanismo de embargo.}}

Exemplo de descrição para o campo:

<pre><field>
	<dc-schema>dc</dc-schema>
        <dc-element>description</dc-element>
        <dc-qualifier>embargo</dc-qualifier>
        <repeatable>false</repeatable>
        <label>Data de liberação para acesso</label>
        <input-type>date</input-type>
        <hint>Entre com a data de liberação para acesso dos usuários ao texto completo</hint>
        <required></required>
</field></pre>


{{Nota|Se deseja que o campo embargo seja de preenchimento obrigatório, preencha o elemento '''<required>'''.}}
Exemplo:
<pre><required>o preenchimento deste campo é obrigatório</required></pre>

[[Arquivo:Restrito.png|center|700px]]


Ainda é necessário realizar do campo associação '''dc.description.embargo''' com a data limite de embargo do documento. Isso pode ser feito mediante mudança de alguns parâmetros no arquivo '''[dspace-base]/config/dspace.cfg''', a saber:

<pre># DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.description.embargo

# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.description.embargo</pre>


É necessário reiniciar o servidor Apache-Tomcat para que as alterações de embargo entrem em vigor.


{{Nota|Entre as datas (quando aplicável) nas submissões dos itens que serão embargados. Você pode utilizar pelo ano ('2020'), mês e ano 
('2020-12'), ou pela data completa ('2020-12-15').}}


{{Nota|Quando o embargo é '''permanente''', no caso onde o acesso ao documento é '''restrito''', pode se utilizar uma data terminada em um valor de ano bastante alto, por exemplo '''9999'''.}}


{{Nota|Periodicamente rode o programa para liberação do item quando esgotar o embargo. O comando [dspace-base]/bin/dspace embargo-lifter (o mais recomendado é adicionar a regra no crontab).}}



=== Quantidade de dias ===

Verifique se os campos '''dc.embargo.terms''' e '''dc.embargo.lift''' estão cadastrado como metadados.  Se não estiver, acesse (logado como administrador) ''Administrador -> registro de metadados -> registro de metadados'' (normalmente http://dublincore.org/documents/dcmi-terms/) ''-> Registro de campo de metadado'' (e adicione estes campos, como no caso de embargo por data limite).

Edite o arquivo '''[dspace-base]/config/input-forms.xml'''. Exemplo:

<pre><field>
       <dc-schema>dc</dc-schema>
       <dc-element>embargo</dc-element>
       <dc-qualifier>terms</dc-qualifier>
       <repeatable>false</repeatable>
       <label>Acesso</label>
       <input-type value-pairs-name="common_embargo">dropdown</input-type>
       <hint>Entre com o tipo de acesso</hint>
       <required>Esse é um campo obrigatório</required>
</field></pre>


<pre><value-pairs value-pairs-name="common_embargo" dc-term="embargo">
       <pair>
         <displayed-value>Aberto</displayed-value>
         <stored-value>aberto</stored-value>
       </pair>
       <pair>
         <displayed-value>Restrito</displayed-value>
         <stored-value>restrito</stored-value>
       </pair>
       <pair>
         <displayed-value>Embargado: 15 dias</displayed-value>
         <stored-value>15 dias</stored-value>
       </pair>
       <pair>
         <displayed-value>Embargado: 30 dias</displayed-value>
         <stored-value>30 dias</stored-value>
       </pair>
</value-pairs></pre>



Edite o arquivo '''[dspace-base]/config/dspace.cfg''':

<pre># DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.embargo.terms

# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.embargo.lift

# string in terms field to indicate indefinite embargo
embargo.terms.open = restrito</pre>

Adicione o texto abaixo: 

<pre># implementation of embargo setter plugin - replace with local implementation ifapplicable
plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DayTableEmbargoSetter

# DC metadata field to hold computed "lift date" of embargo
embargo.terms.days = aberto:1, 15 dias:15, 30 dias:30</pre>

Insira um '''#''' na frente da linha:

<pre>plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DefaultEmbargoSetter</pre>

[[Arquivo:Acesso.png|center|500px]]

É necessário reiniciar o servidor Apache-Tomcat para que as alterações entrem em vigor.


{{Nota|Como o sistema não aceita um tempo de embargo inferior a 1 dia, no caso do acesso aberto o documento estará com acesso bloqueado durante esse período.}}


{{Nota|Periodicamente rode o programa para liberação do item quando esgotar o embargo. O comando [dspace-base]/bin/dspace embargo-lifter (o mais recomendado é adicionar a regra no crontab).}}