Acciones personalizadas en KCenter

El siguiente ejemplo muestra cómo crear una nueva acción personalizada en el KCenter.

Ejemplo basado en un JSP

Paso 1 - Crear un fichero JSP de ejemplo

Cree el siguiente fichero JSP de ejemplo y cópielo en la carpeta webapps/openkm con el nombre test.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<%@ page isErrorPage="true" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>

<html>
<head>
  <script type="text/javascript" src="<%=request.getContextPath() %>/kcenter/api/common.js"></script>
  <script type="text/javascript" src="<%=request.getContextPath() %>/kcenter/api/modal.js"></script>
</head>
<body>
  <h1>Quick sample about how to create a custom action in the KCenter</h1>

  <p><b>UserId:</b> <%=request.getParameter("userId")%></p>
  <p><b>Uuid:</b> <%=request.getParameter("uuid")%></p>
  <p><b>Encrypted token:</b> <%=request.getParameter("token")%></p>

  <button onclick="_closeCustomFeatureModal()">Close popup</button>
</body>
</html>

Paso 2 - Registrar la acción personalizada

Cree una nueva acción personalizada con estos valores. Más información en Custom actions.

Campo	Valor
Name	test
Label	Label test
Icon	mdi-copy-all
Description
Document	false
Folder	true
Record	false
Mail	false
URL	../test.jsp Otra opción: http://localhost:8080/openkm/test.jsp
Action	popup-wizard
Location	node-toolbar
Width	50%
Height	50%
Show close	true

Paso 3 - Habilitar la acción personalizada en el perfil

Vaya a Administration > Profiles
Edite un perfil y habilite la acción personalizada en la pestaña Misc.

Paso 4 - Comprobar la funcionalidad

Actualice la interfaz de KCenter
Seleccione una carpeta en la vista del navegador.
Aparece una nueva opción de menú llamada “Extra” en el menú contextual o en el menú de la barra de herramientas

Ejemplo completo de JSP

El siguiente ejemplo de JSP permite que cualquiera desbloquee un nodo.

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>

<%@ page import="com.openkm.util.ContextWrapper" %>
<%@ page import="com.openkm.util.StackTraceUtils" %>
<%@ page import="com.openkm.api.OKMDocument" %>
<%@ page import="com.openkm.module.db.DbNodeModule" %>
<%@ page import="com.openkm.bean.Document" %>
<%@ page import="com.openkm.principal.PrincipalUtils" %>
<%@ page import="com.openkm.module.db.stuff.DbSessionManager" %>
<%@ page import="org.apache.commons.lang3.StringUtils" %>

<html>
<head>
  <link rel="stylesheet" type="text/css" href="<%=request.getContextPath() %>/kcenter/css/bootstrap/bootstrap.css" />
  <link rel="stylesheet" type="text/css" href="<%=request.getContextPath() %>/kcenter/css/mdb/mdb.css" />
  <link rel="stylesheet" type="text/css" href="<%=request.getContextPath() %>/kcenter/css/okm.css" />
  <script type="text/javascript" src="<%=request.getContextPath() %>/kcenter/api/common.js"></script>
  <script type="text/javascript" src="<%=request.getContextPath() %>/kcenter/api/modal.js"></script>
  <script type="text/javascript" src="<%=request.getContextPath() %>/kcenter/api/browser.js"></script>
  <script>
    function closeButton() {
      _refreshUI();
      _closeCustomFeatureModal();
    }
  </script>
</head>
<body>

<%
  String error = "";
  boolean isCheckedOut = false;
  boolean isLocked = false;
  try {
    String uuid = request.getParameter("uuid");
    OKMDocument okmDocument = ContextWrapper.getContext().getBean(OKMDocument.class);
    DbNodeModule dbNodeModule = ContextWrapper.getContext().getBean(DbNodeModule.class);
    boolean isDocument = okmDocument.isValid(null, uuid);
    if (isDocument) {
      Document doc = okmDocument.getProperties(null, uuid);
      if (doc.isCheckedOut()) {
        isCheckedOut = true;
      } else if (doc.isLocked()) {
        isLocked = true;
      }
    } else {
      isLocked = dbNodeModule.isLocked(null, uuid);
    }
    if (isLocked) {
      long tenantId = PrincipalUtils.getTenantId();
      String systemToken = DbSessionManager.getInstance().getSystemToken(tenantId);

      dbNodeModule.forceUnlock(systemToken, uuid);
    }
  } catch (Exception e) {
    error = StackTraceUtils.toString(e).replaceAll("\n","<br/>");
    e.printStackTrace();
  }
%>

  <div class="d-flex justify-content-center w-100 my-2">
    <% if (StringUtils.isEmpty(error)) { %>
      <% if (isCheckedOut) { %>
        <p class="text-danger">Can not unlock a document in edition.</p>
      <% } else if (!isLocked) { %>
        <p class="text-danger">The node is not locked.</p>
      <% } else { %>
        <p class="text-success">The node has been unlocked</p>
      <% } %>
    <% } %>
  </div>

  <div class=" d-flex justify-content-center w-100 my-2">
    <button type="button" class="btn btn-success btn-sm my-0 m-0" onclick="closeButton()">
      Tancar
    </button>
  </div>

  <% if (StringUtils.isNotEmpty(error)) { %>
    <div class="d-flex justify-content-center w-100 my-2">
      <p class="text-danger">Error found:</p>
      <%= error %>
    </div>
  <% } %>

</body>
</html>

<% if (StringUtils.isNotEmpty(error)) { %>

Error found:

<%= error %>

<% } %>">

Ejemplo basado en JavaScript

Paso 1 - Registrar la acción personalizada

Cree una nueva acción personalizada con estos valores. Más información en Custom actions.

Campo	Valor
Name	test
Label	Label test
Icon	mdi-assistant-direction
Description
Document	true
Folder	false
Record	false
Mail	false
URL
Action	run-script
Location	node-toolbar
Width	50%
Height	50%
Show close	true
Script	const kcenterApp = window.kcenterApp; // kcenter app const uuid = ‘1aff985f-9243-4c1a-8d43-482026f3fa93’; // uuid to jump kcenterApp.$store.dispatch(‘browser/refreshByUuid’, uuid, { root: true }); // internal function to jump Ejemplo de acceso a servicios web: kcenterApp.$ws.node.getNodeByUuid(‘095cdb6e-c28e-410c-a6e3-19e23bd4b3ef’).then(response => { console.log(‘here1’); console.log(response); console.log(‘here2’); });

Paso 2 - Habilitar la acción personalizada en el perfil

Vaya a Administration > Profiles
Edite un perfil y habilite la acción personalizada en la pestaña Misc.

Paso 3 - Comprobar la funcionalidad

Actualice la interfaz de KCenter
Seleccione un documento en la vista del navegador.
En el menú de la barra de herramientas aparecerá un nuevo icono de menú.

Ejemplo con validación

Paso 1 - Registrar la acción personalizada

Cree una nueva acción personalizada con estos valores. Más información en Custom actions.

Campo	Valor
Name	test
Label	Label test
Icon	mdi-assistant-direction
Description
Document	true
Folder	false
Record	false
Mail	false
URL
Action	run-script
Location	node-toolbar
Width	50%
Height	50%
Show close	true
Script	console.log(‘The document has the group okg:consulting’);
Validation script	Disponible desde la versión 8.1.15. La sentencia return debe ser un valor booleano o una promise, como en el ejemplo siguiente. async function main() { console.log(‘execute main’); const kcenterApp = window.kcenterApp; const currentNode = kcenterApp.$store.getters[‘browser/currentNode’]; const isValid = await hasGroup(currentNode.uuid); console.log(’isValid: ’ + isValid); return isValid; // Return is valid } async function hasGroup(uuid) { const response = await kcenterApp.$ws.propertyGroup.getGroups(uuid); console.log(response); // Groups of the node const found = response.some(group => group.name === ‘okg:consulting’); return found; } // Return the promise ( will be executed in the UI ) or a boolean value return main();

Paso 2 - Habilitar la acción personalizada en el perfil

Vaya a Administration > Profiles
Edite un perfil y habilite la acción personalizada en la pestaña Misc.

Paso 3 - Comprobar la funcionalidad

Actualice la interfaz de KCenter
Seleccione un documento en la vista del navegador.
En el menú de la barra de herramientas aparecerá un nuevo icono de menú.
La opción de menú está habilitada cuando el documento tiene asignado el metadato okg:consulting.