Com omplir la plantilla de sol·licitud
Navegació
| ⬅️ Com utilitzar EventHub | ➡️ Que-canvia-projectes-existents |
|---|
Com omplir la plantilla de sol·licitud
Canigó – Guia pas a pas
Aquesta pàgina explica com omplir correctament la plantilla Excel de sol·licitud de recursos EventHub (V1.0).
📥 Descarregar la plantilla de sol·licitud
Model de fitxa: una fitxa per iniciativa
A diferència de versions anteriors, la plantilla V1.0 segueix el model una fitxa = una iniciativa completa.
Això vol dir que una sola fitxa pot contenir N aplicacions amb codis d’aplicació diferents, totes relacionades amb el mateix projecte o iniciativa. No cal enviar una fitxa per aplicació.
Quan usar una sola fitxa:
- Projectes simples: 1 aplicació, 1 JIRA.
- Iniciatives complexes: 7 aplicacions interrelacionades, totes sense resources previs, amb un JIRA paraigua comú.
Visió general de la plantilla
La plantilla és un únic fitxer Excel per iniciativa. Conté 7 pestanyes de treball organitzades en l’ordre recomanat d’ompliment:
| # | Pestanya | Qui omple | Què conté |
|---|---|---|---|
| 1 | Dades_Iniciativa | Aplicació | JIRA paraigua + taula de totes les aplicacions involucrades |
| 2 | Sol·licitud_ClientKafka | Aplicació | Un client Kafka per fila (editable per aplicació) |
| 3 | Sol·licitud_Topic | Aplicació | Un topic per fila i entorn |
| 4 | Sol·licitud_Schema | Aplicació | Un schema per fila associat a un topic |
| 5 | Sol·licitud_Connector | Aplicació | Un connector per fila |
| 6 | Sol·licitud_StreamProcessing | Aplicació | Un pipeline per fila (ksqlDB o Flink) |
| 7 | Sol·licitud_Permisos | Aplicació | Permisos creuats entre aplicacions |
| — | README | Referència | Llegenda de colors i punts clau |
Només omples les pestanyes que necessites. Si no tens connectors, no cal tocar Sol·licitud_Connector.
Llegenda de columnes
Totes les pestanyes de recursos utilitzen un sistema de prefixos de text per identificar qui ha d’omplir cada columna, independent del color:
| Prefix | Color de fons | Qui actua | Descripció |
|---|---|---|---|
[APP] |
Blau clar | Aplicació | Codi/Nom de l’aplicació — editar per fila |
[SOL] |
Blanc | Aplicació | Camp obligatori — sense ell la sol·licitud queda incompleta |
[OPC] |
Gris molt clar | Aplicació | Camp opcional — dona context, no és bloquejant |
[AUT] |
Blau molt clar | — | Automàtic — es calcula sol, no editar |
[OFI] |
Gris clar | Oficina | Només Oficina EventHub — no tocar |
[CTR] |
Groc clar | — | Control automàtic — fórmula, no editar |
La fila 2 de cada pestanya repeteix sempre aquesta llegenda per tenir-la a la vista.
Llegenda de files (Tipus_Operacio)
El color de fila indica el tipus d’operació sol·licitada:
| Valor | Color | Descripció |
|---|---|---|
ALTA |
Verd molt clar | Recurs nou — mai no ha existit |
MODIFICACIO |
Groc molt clar | Canvi sobre un recurs ja existent |
BAIXA |
Blau molt clar | Sol·licitud d’eliminació |
Pas 1: Dades_Iniciativa (obligatori, sempre primer)
Aquesta pestanya s’omple una sola vegada per iniciativa. Conté dues parts:
Part A — Dades generals
| Camp | Què posar | Exemple |
|---|---|---|
| JIRA_Iniciativa | Tiquet JIRA paraigua o èpica | ACOEVENT-980 |
| Nom_Iniciativa | Nom del projecte global | Ecosistema Pagaments |
| Owner_Iniciativa | Responsable que entrega la fitxa | Ana Ruiz |
| Email_Contacte | Email del responsable | pagaments@empresa.cat |
| Data_Sol·licitud | Data d’entrega | 23/04/2026 |
| Entorns_Sol·licitats | Entorns globals | PRE, PRO |
| Descripcio_Breu | Cas d’ús en una frase | Plataforma de pagaments online |
| Versio_Formulari | Versió (incrementar si reenvies) | 1.0 |
Part B — Taula d’aplicacions
Una fila per cada aplicació involucrada a la iniciativa. El Codi_Aplicacio d’aquesta taula és el valor de referència: ha de coincidir exactament amb el que s’usin a totes les pestanyes de recursos.
| Camp | Exemple |
|---|---|
| Codi_Aplicacio | b3101 |
| Nom_Aplicacio | Passarel·la de Pagaments |
| Owner_Tecnic | Ana Ruiz |
| Owner_Funcional | Carlos Mendoza |
| Equip_Suport | Suport Pagaments |
| Domini_Funcional | PAGAMENTS |
| Rol_a_Iniciativa | Productor / Consumidor / Ambdós |
⚠️ Si Dades_Iniciativa està buit, les altres pestanyes no tindran context. Sempre primer.
Pas 2: Sol·licitud_ClientKafka
Una fila per cada client Kafka sol·licitat. A diferència de versions anteriors, el [APP] Codi_Aplicacio s’edita per fila: una iniciativa amb 7 aplicacions tindrà 7 files, cadascuna amb el seu codi d’aplicació.
| Camp | Què posar | Exemple |
|---|---|---|
[APP] Codi_Aplicacio |
Codi de l’app propietària d’aquest client | b3101 |
[APP] Nom_Aplicacio |
Nom de l’app | Passarel·la de Pagaments |
[SOL] Tipus_Operacio |
ALTA / MODIFICACIO / BAIXA | ALTA |
[SOL] Identificador_Curt |
Nom curt sense espais ni accents | pagaments-prod |
[AUT] Nom_Client_Generat |
Es genera sol: {codi}-{identificador} |
b3101-pagaments-prod |
[SOL] Entorns |
INT / PRE+PRO / INT+PRE+PRO | PRE+PRO |
[SOL] CPD_Cloud |
Onpremise / Azure / AWS / Hybrid | Onpremise |
[SOL] Criticitat |
Alta / Mitjana / Baixa | Alta |
[SOL] Topics_Propis |
Topics dels quals és propietari | b3101-pagaments-prod-transaccio-iniciada |
El nom del client és el mateix en INT, PRE i PRO (sense sufix d’entorn).
Pas 3: Sol·licitud_Topic
Una fila per topic i entorn. El camp [APP] Codi_Aplicacio s’edita per fila igual que a la pestanya anterior.
| Camp | Què posar | Exemple |
|---|---|---|
[SOL] Tipus_Operacio |
ALTA / MODIFICACIO / BAIXA | ALTA |
[SOL] Entorn |
INT / PRE / PRO | PRO |
[SOL] Client_Kafka_Propietari |
Client propietari (prefixe del topic) | b3101-pagaments-prod |
[SOL] Descripcio_Topic |
Slug en minúscules amb guions | transaccio-iniciada |
[AUT] Nom_Topic_Generat |
Es genera sol | b3101-pagaments-prod-transaccio-iniciada |
[SOL] Es_DLQ |
SI si aquest topic ÉS una cua d’errors | NO |
[OPC] Topic_Principal_DLQ |
Només si Es_DLQ = SI | b3101-pagaments-prod-transaccio-iniciada |
[SOL] Criticitat |
Alta / Mitjana / Baixa | Alta |
[SOL] Volum_MBs |
MB/s mitjà | 3.0 |
[SOL] Pic_MBs |
MB/s pic | 12 |
[SOL] Requereix_Schema |
SI / NO | SI |
[OPC] Retencio_Dies |
Dies de retenció (def=7) | 7 |
[OPC] Consumidors_Coneguts |
Informatiu — els permisos van a la pestanya Permisos | b3103-frau-svc |
Generació del nom del topic:
| Entorn | Resultat |
|---|---|
| INT | b3101-pagaments-prod-transaccio-iniciada-int |
| PRE | b3101-pagaments-prod-transaccio-iniciada-pre |
| PRO | b3101-pagaments-prod-transaccio-iniciada (sense sufix) |
Valors per defecte (no modificar si no cal):
Retencio=7 dies, Cleanup=delete, Compression=producer, Max_Msg=1MB, Schema_Validation=No.
Si necessites un valor diferent → omplir [OPC] Justificacio_Excepcio.
Pas 4: Sol·licitud_Schema (si aplica)
Només si algun topic requereix schema. Una fila per schema.
| Camp | Què posar | Exemple |
|---|---|---|
[SOL] Tipus_Operacio |
ALTA / MODIFICACIO / BAIXA | ALTA |
[SOL] Entorn |
INT / PRE / PRO | PRO |
[SOL] Nom_Schema_Base |
Nom base sense sufix | b3101-pagaments-prod-transaccio-iniciada |
[AUT] Nom_Schema_Generat |
Es genera sol: {topic}-value |
b3101-pagaments-prod-transaccio-iniciada-value |
[SOL] Tipus_Schema |
AVRO / JSON / PROTOBUF | AVRO |
[SOL] Topic_Associat |
Nom complet del topic | b3101-pagaments-prod-transaccio-iniciada |
[SOL] Compatibilitat |
BACKWARD (defecte) | BACKWARD |
[SOL] Esquema_Proposat |
Definició JSON/Avro | {"type":"record",...} |
[AUT] Impacte_Consumidors |
Es calcula sol segons compatibilitat | Sense impacte (BACKWARD) |
[AUT] Requereix_Coordinacio |
Es calcula sol si hi ha impacte | NO |
Si és un schema de key, el nom generat acaba en -key. Editar Nom_Schema_Base per reflectir-ho.
Pas 5: Sol·licitud_Connector (si aplica)
Una fila per connector. La biblioteca determina el tipus (CDC Source, Sink, etc.) — no existeix un camp “Tipus” separat.
⚠️ Si el connector és OracleCDCSource: abans d’omplir aquesta pestanya cal que l’equip de BBDD hagi realitzat una anàlisi de performance de la base de dades Oracle origen. Sense aquest pas previ, la sol·licitud serà retornada.
| Camp | Què posar | Exemple |
|---|---|---|
[SOL] Tipus_Operacio |
ALTA / MODIFICACIO / BAIXA | ALTA |
[SOL] Entorn |
INT / PRE / PRO | PRO |
[SOL] Client_Kafka_Propietari |
Client propietari (prefixe del connector) | b3101-pagaments-prod |
[SOL] Nom_Connector |
{client}-{biblioteca}-{sistema} |
b3101-pagaments-prod-s3sink-txarxiu |
[SOL] Biblioteca_Connector |
Desplegable (OracleCDCSource, S3Sink…) | S3Sink |
[SOL] Versio_Biblioteca |
Versió exacta | 10.1.1 |
[SOL] Criticitat |
Alta / Mitjana / Baixa | Alta |
[SOL] Snapshot_Proposat |
SI / NO | NO |
[SOL] Config_Connector |
Paràmetres key=value, un per línia | s3.bucket.name=pagaments-psd2 |
[OPC] DLQ_Proposada |
Topic DLQ associat si aplica | b3101-pagaments-prod-txarxiu-dlq |
Tots els connectors són continus — no existeix el concepte de freqüència o lot.
Pas 6: Sol·licitud_StreamProcessing (si aplica)
Una fila per pipeline. Només disponible en PRE i PRO — no INT.
| Camp | Què posar | Exemple |
|---|---|---|
[SOL] Tipus_Operacio |
ALTA / MODIFICACIO / BAIXA | ALTA |
[SOL] Entorn |
PRE o PRO (mai INT) | PRO |
[SOL] Tipus |
ksqlDB / Flink | ksqlDB |
[SOL] Nom_Pipeline |
Slug descriptiu | deteccio_frau_10min |
[SOL] Topics_Entrada |
Topics d’entrada separats per coma | b3101-pagaments-prod-transaccio-iniciada |
[SOL] Topics_Sortida |
Topics de sortida | b3103-frau-svc-alerta-frau |
[SOL] Justificacio |
Per qué aquesta tecnologia | Detecció en finestra temporal de 10 min |
[SOL] Query_KSQL_Flink |
SQL complet o codi del job Flink | CREATE TABLE alertes AS ... |
[OPC] Paral·lelisme |
Només si Tipus=Flink | 4 |
[OPC] Mem_TaskMgr_GB |
Memòria per task manager. Flink. | 8 |
Pas 7: Sol·licitud_Permisos (si aplica)
Només si un client Kafka necessita accedir a un topic que no és propi — ja sigui d’una altra aplicació de la mateixa iniciativa o d’un altre projecte.
Una fila = un client Kafka sobre un topic. Cada entorn necessita la seva pròpia fila.
| Camp | Què posar | Exemple |
|---|---|---|
[APP] Codi_App |
Codi de l’app que té el client Kafka | b3101 |
[APP] Nom_App |
Nom de l’app | Passarel·la de Pagaments |
[PER] Client_Kafka |
Nom exacte del client que necessita el permís | b3103-frau-svc |
[SOL] JIRA_ID |
Tiquet de la sol·licitud | ACOEVENT-981 |
[SOL] Owner_Tecnic_Topic |
Responsable tècnic del topic | Ana Ruiz |
[SOL] Nom_Topic |
Topic sobre el qual es demana el permís | b3101-pagaments-prod-transaccio-iniciada |
[SOL] Entorn |
INT / PRE / PRO | PRO |
[SOL] Tipus_Permis |
CONSUME (lectura) / PRODUCE (escriptura) | CONSUME |
[SOL] Justificacio |
Per qué es necessita aquest accés | L'antifrau calcula el score de cada transacció |
[OFI] Confirmacio_Owner |
L’Oficina coordina amb el propietari | Confirmat |
L’Oficina EventHub coordinarà la confirmació amb el propietari del topic i aprovarà o denegarà el permís.
Què NO has de tocar
- Columnes
[AUT]: es calculen soles (Nom_Topic_Generat, Nom_Client_Generat, Nom_Schema_Generat, Impacte_Consumidors, Requereix_Coordinacio). - Columnes
[OFI]: les omple l’Oficina EventHub. - Columnes
[CTR]: fórmules de control automàtic. - Valors per defecte (Retencio, Cleanup, Compression, etc.): només modificar si tens una excepció justificada a
[OPC] Justificacio_Excepcio.
Ordre recomanat d’ompliment
Dades_Iniciativa (1 vegada per iniciativa)
│
▼
ClientKafka ──▶ Topic ──▶ Schema ──▶ Connector ──▶ StreamProcessing
│
▼
Sol·licitud_Permisos
(si aplica)
│
▼
Adjuntar a JIRA ACOEVENT ──▶ Validació Oficina ──▶ Creació recursos
Enviament progressiu (recomanat per iniciatives grans)
En iniciatives amb molts recursos o moltes aplicacions, no cal enviar INT, PRE i PRO al mateix Excel des del principi:
- Envia primer els recursos per a INT i obre un tiquet JIRA ACOEVENT.
- Quan els recursos d’INT estiguin validats i funcionant, incrementa
Versio_Formulari(ex: 1.0 → 2.0) i obre un nou tiquet per a PRE. - Quan PRE estigui validat, repeteix el procés per a PRO.
Això facilita la validació per part de l’Oficina EventHub i redueix errors en entorns productius.
Si reenvies el formulari amb canvis, has de:
- Incrementar
Versio_Formularia Dades_Iniciativa. - Reenviar l’Excel complet.
L’Oficina sempre treballa sobre la versió més recent.
Errors habituals
| Error | Conseqüència | Solució |
|---|---|---|
| No omplir Dades_Iniciativa primer | El context de la iniciativa queda buit | Sempre primer |
| Escriure el nom del topic a mà | Pot no seguir el naming estàndard | Només omplir Descripcio_Topic; el nom es genera sol |
| Posar punts o espais al nom | Nom invàlid | Només guions i minúscules |
| Modificar valors per defecte sense justificar | La sol·licitud serà retornada | Omplir Justificacio_Excepcio |
| Oblidar l’entorn | Fila incompleta | Cada entorn (INT/PRE/PRO) necessita la seva fila a Topics i Schemas |
Omplir columnes [OFI] o [CTR] |
Conflicte amb la validació de l’Oficina | Deixar-les en blanc |
| Indicar CDC com a tipus de connector | No existeix aquest valor | Usar OracleCDCSource al camp Biblioteca_Connector |
| Demanar StreamProcessing en INT | No disponible | Entorn mínim: PRE |
| No omplir la Justificacio del permís | La sol·licitud pot ser retornada per falta de context | Explicar clarament per qué el client necessita accés al topic |
Següent pas
Un cop omplerta la plantilla:
- Obre un tiquet JIRA ACOEVENT.
- Adjunta l’Excel.
- L’Oficina EventHub revisarà i validarà.