ORCID Manual Entry — OJS plugin

⬇️ Install package: OJS 3.5 — or browse all Releases.

A generic plugin for Open Journal Systems (OJS) that restores a typeable (manual) ORCID field — the behaviour from older OJS versions — for journals where ORCID authentication (OAuth) is not configured. It covers the three places where the core hides the field: the author/contributor form, the public user registration page and the user profile.

⚠️ Manual entry is NOT the recommended way to collect ORCID iDs. The recommended approach remains authenticated ORCID (OAuth), where the author signs in at ORCID and the iD is verified at the source. A manually typed iD is unverified — it can be mistyped or belong to someone else. Use this plugin only as a fallback while your journal cannot enable ORCID OAuth; once you configure OAuth, the plugin goes inert and OJS takes over. See Why authenticated ORCID is recommended.

Developed and maintained by OJSBR. See the Credits & authorship section below.

Compatibility & branches

OJS version	Branch	Plugin release
OJS 3.5.x	stable-3_5_0 (default)	1.1.0.1

Also applies to OJS 3.4.x, where the same core restriction was introduced.

Why authenticated ORCID is recommended

Since OJS 3.4/3.5 the old ORCID plugin was merged into the core and the author ORCID field became read-only: it can only be filled by OAuth authentication (the author signs in at ORCID and authorises the journal). This is deliberate — an authenticated iD is verified at the source, so you know it really belongs to that person. A manually typed iD is not verified: it may be mistyped, invented, or belong to someone else, and it will not carry ORCID's "verified" status.

So the recommendation is: enable ORCID OAuth. See PKP's ORCID in OJS/OMP/OPS guide. Use this plugin only while you genuinely cannot enable OAuth (e.g. no ORCID member/public API credentials yet) and still need to record iDs. It is a pragmatic fallback, not a replacement for authentication.

What it does

• Acts only when ORCID OAuth is not enabled for the context. If you configure OAuth later, the plugin becomes inert and the core takes over the verified flow.
• Adds a plain ORCID text field to the contributor form (submission wizard and Edit contributor), to the public registration page and to Profile → Identity.
• An iD recorded on the user account is copied by the core into the author metadata of the user's next submission (Repo::author()->newAuthorFromUser()), so authors no longer have to type it again at submission time.
• Accepts the bare iD (0000-0002-1825-0097) or the URL, and normalizes it to the canonical https://orcid.org/0000-0002-1825-0097 the core expects.
• Keeps the core's format + checksum validation: an invalid iD is rejected.
• Shows the stored iD again when Edit contributor is reopened, so re-saving a contributor never wipes it.

Installation

1. Install via Settings → Website → Plugins → Upload A New Plugin, or extract the folder into plugins/generic/ so you get plugins/generic/orcidManualEntry/.
2. Enable ORCID manual (digitável) under the Generic plugins list.

Configuration

There is nothing to configure — enabling the plugin is the whole setup. What matters is the guard: the plugin only acts while ORCID OAuth is off for the context.

OrcidManager::isEnabled() reads orcidEnabled from the journal (or the site), and it does not check whether the credentials are usable. A journal left with ORCID enabled and placeholder client id/secret ends up in limbo: a field nobody can fill and a plugin that stays silent. If the ORCID field does not show up, check Settings → Distribution → ORCID first, before suspecting a plugin conflict.

Site-wide registration (the site index, with no journal selected) is out of scope: the core disables ORCID there, and a context-enabled plugin is not loaded on that page.

How it works (technical)

The core blocks manual ORCID in four places; the plugin neutralizes each only when OAuth is off:

1. Form::config::before → adds a typeable orcid field to the ContributorForm.
2. TemplateManager::display → publishes js/orcidManualEntry.js, which registers the field-orcid-manual Vue component. This one is not obvious: ContributorsListPanel .openEditModal() fills every field with field.value = contributor[name], except a field named orcid, which instead receives field.orcid, because the core assumes the FieldOrcid (OAuth) component there. A plain FieldText reads value, so the stored iD never reached the input: the form always reopened blank, and the next Save wrote that blank over the stored iD. The component extends FieldText and seeds value from the orcid prop on mounted().
3. Author::validate → removes the cannotUpdateAuthorOrcid block while keeping the core's format/checksum validation.
4. Author::add::before / Author::edit → normalizes and (re)injects the iD before it is written, since the edit endpoint strips orcid from the parameters by default. Clearing an existing iD is logged to the PHP error log, so that a future regression of the Vue component is traceable instead of silent.

For the registration page and the user profile, the core already ships a text field and already reads the orcid request variable — it just hides the field and drops the value when OAuth is off. Four more hooks close that gap:

5. registrationform::display / identityform::display → turn on the templates' own $orcidEnabled switch, which is what gates the ORCID markup in userRegister.tpl and identityForm.tpl.
6. TemplateResource::getFilename → replaces templates/form/orcidProfile.tpl (the OAuth widget) with the plugin's manual version. That single small template is the only ORCID markup on the registration page, and on the profile it is what turns the text input into a hidden field by JavaScript — swapping it fixes both screens without overriding any large core template.
7. registrationform::Constructor / identityform::Constructor → add an optional FormValidatorCustom on orcid, so a typed iD must pass format + checksum.
8. registrationform::execute / identityform::execute → write the normalized iD to the user (RegistrationForm::execute() only applies it when OAuth is on, and IdentityForm::execute() never applies it at all).

Site-wide registration (no journal context) is out of scope: ORCID is disabled there by the core, and a context-enabled plugin is not loaded on that page.

Tests

Verified on OJS 3.5.0-3 (2026-08-29), with ORCID OAuth off:

Check	Result
Public registration page shows a typeable ORCID field	✅
Registration stores the iD, normalized to the canonical URL	✅ 0000-0002-1825-0097 → https://orcid.org/0000-0002-1825-0097
Profile → Identity shows the stored iD and saves a new one	✅
Invalid iD (bad checksum)	✅ rejected, stored value untouched
New submission inherits the account's iD in the author metadata	✅
Contributor edit modal reopens with the stored iD	✅
ORCID OAuth enabled ⇒ plugin inert	✅ the core's "Connect ORCID" button comes back and the manual field disappears

Credits & authorship

• Developed and maintained by OJSBR — original plugin.
• Distributed under the GNU GPL v3, the same license as OJS.

Contributing

Issues and pull requests are welcome.

License

Distributed under the GNU GPL v3. See LICENSE and docs/COPYING.

---

🇧🇷 Português

Plugin genérico para o Open Journal Systems (OJS) que restaura um campo ORCID digitável (manual) — como nas versões anteriores do OJS — para revistas em que a autenticação ORCID (OAuth) não está configurada. Cobre os três lugares em que o núcleo esconde o campo: o formulário de autor/contribuidor, a tela pública de cadastro de usuário e o perfil do usuário.

⚠️ O preenchimento manual NÃO é a forma recomendada de coletar iDs ORCID. A recomendação continua sendo o ORCID autenticado (OAuth), em que o autor faz login no ORCID e o iD é verificado na fonte. Um iD digitado manualmente não é verificado — pode ser digitado errado ou pertencer a outra pessoa. Use este plugin apenas como alternativa temporária enquanto a revista não puder habilitar o ORCID OAuth; assim que o OAuth for configurado, o plugin fica inerte e o OJS assume o controle.

Desenvolvido e mantido pela OJSBR.

Compatibilidade e branches

Versão do OJS	Branch	Release do plugin
OJS 3.5.x	stable-3_5_0 (padrão)	1.1.0.1

Vale também para o OJS 3.4.x, onde a mesma restrição do núcleo foi introduzida.

Por que o ORCID autenticado é o recomendado

Desde o OJS 3.4/3.5 o antigo plugin ORCID foi incorporado ao núcleo e o campo ORCID do autor passou a ser somente-leitura: só pode ser preenchido via autenticação OAuth (o autor faz login no ORCID e autoriza a revista). Isso é proposital — um iD autenticado é verificado na origem, então você sabe que ele realmente pertence àquela pessoa. Um iD digitado manualmente não é verificado: pode conter erro de digitação, ser inventado ou ser de outra pessoa, e não recebe o status de "verificado" do ORCID.

Portanto, a recomendação é: habilitar o ORCID OAuth (veja o guia de ORCID da PKP). Use este plugin apenas enquanto realmente não for possível habilitar o OAuth e ainda assim for preciso registrar iDs. É uma alternativa pragmática, não um substituto da autenticação.

O que faz

• Age somente quando o ORCID OAuth não está habilitado no contexto; se você configurar o OAuth depois, o plugin fica inerte.
• Adiciona um campo de texto ORCID ao formulário de contribuidor (assistente de submissão e Editar contribuidor), à tela pública de cadastro e ao Perfil → Identificação.
• O iD gravado na conta do usuário é copiado pelo próprio núcleo para os metadados de autoria da submissão seguinte (Repo::author()->newAuthorFromUser()), ou seja, o autor não precisa digitá-lo de novo na hora de submeter.
• Aceita o iD nu (0000-0002-1825-0097) ou a URL e normaliza para https://orcid.org/0000-0002-1825-0097.
• Mantém a validação de formato e dígito verificador do núcleo: iD inválido é rejeitado.
• Reexibe o iD gravado ao reabrir Editar contribuidor, de modo que salvar o contribuidor de novo nunca apaga o ORCID.

Instalação

Instale em Configurações → Website → Plugins → Enviar um novo plugin, ou extraia a pasta em plugins/generic/ (ficando plugins/generic/orcidManualEntry/). Depois ative o ORCID manual (digitável) na lista de plugins Genéricos.

Configuração

Não há o que configurar — ativar o plugin é a configuração inteira. O que importa é a guarda: o plugin só age enquanto o ORCID OAuth estiver desligado no contexto.

O OrcidManager::isEnabled() lê o orcidEnabled da revista (ou do site) e não verifica se as credenciais prestam. Uma revista com o ORCID ligado e client id/secret de teste fica no limbo: campo que ninguém consegue preencher e plugin calado. Se o campo ORCID não aparecer, confira Configurações → Distribuição → ORCID antes de suspeitar de conflito entre plugins.

O cadastro em nível de site (o índice do portal, sem revista selecionada) está fora do escopo: o núcleo desliga o ORCID ali, e um plugin habilitado por contexto não é carregado nessa página.

Testes

Verificado no OJS 3.5.0-3 (29/08/2026), com o ORCID OAuth desligado:

Verificação	Resultado
Tela pública de cadastro exibe o campo ORCID digitável	✅
O cadastro grava o iD, normalizado para a URL canônica	✅ 0000-0002-1825-0097 → https://orcid.org/0000-0002-1825-0097
Perfil → Identificação exibe o iD gravado e salva um novo	✅
iD inválido (dígito verificador errado)	✅ recusado, valor gravado intacto
Submissão nova herda o iD da conta nos metadados de autoria	✅
Modal de editar contribuidor reabre com o iD gravado	✅
ORCID OAuth ligado ⇒ plugin inerte	✅ volta o botão "Conectar ORCID" do núcleo e o campo manual some

Créditos e autoria

• Desenvolvido e mantido pela OJSBR — plugin autoral.
• Distribuído sob a GNU GPL v3, a mesma licença do OJS.

Licença

Distribuído sob a GNU GPL v3. Veja LICENSE e docs/COPYING.