Wiki source code of xwiki-development-integrations
Version 1.5 by Alex Cotiugă on 2026/05/12 12:54
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.2 | 1 | {{velocity}} |
| 2 | #set ($discard = $xwiki.ssx.use('PublicWebSite.WebHome')) | ||
| 3 | {{html clean="false"}} | ||
| 4 | |||
| 5 | ## PAGE HEADER | ||
| 6 | <section class="hero hero-centered service-hero" aria-labelledby="hero-title"> | ||
| 7 | <div class="container hero-inner"> | ||
| 8 | <div class="hero-kicker"> | ||
| 9 | <i class="fa fa-cogs" aria-hidden="true"></i> | ||
| 10 | XWiki development and integrations | ||
| 11 | </div> | ||
| 12 | |||
| 13 | <h1 id="hero-title">Custom XWiki applications, workflows and integrations</h1> | ||
| 14 | |||
| 15 | <p class="lead"> | ||
| 16 | Extend XWiki beyond documentation with custom applications, structured data, workflows, dashboards, | ||
| 17 | automation and integrations adapted to your organization. | ||
| 18 | </p> | ||
| 19 | |||
| 20 | <p class="hero-support"> | ||
| 21 | We help organizations turn XWiki into a practical business platform for knowledge management, | ||
| 22 | procedures, approvals, internal tools, reporting and connected processes. | ||
| 23 | </p> | ||
| 24 | |||
| 25 | <div class="hero-actions"> | ||
| 26 | <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Discuss a project</a> | ||
| 27 | <a class="btn btn-secondary" href="#development-process">See the development approach</a> | ||
| 28 | </div> | ||
| 29 | </div> | ||
| 30 | </section> | ||
| 31 | |||
| 32 | ## WHY CUSTOM DEVELOPMENT | ||
| 33 | <section aria-labelledby="why-development-title"> | ||
| 34 | <div class="container"> | ||
| 35 | <h2 id="why-development-title">When XWiki needs to fit your business</h2> | ||
| 36 | |||
| 37 | <p class="section-intro"> | ||
| 38 | XWiki is flexible enough to become much more than a documentation system. With the right structure, | ||
| 39 | custom applications and integrations, it can support internal processes that would otherwise be handled | ||
| 40 | through spreadsheets, scattered documents, manual approvals or disconnected tools. | ||
| 41 | </p> | ||
| 42 | |||
| 43 | <div class="pathways"> | ||
| 44 | <article class="pathway-card"> | ||
| 45 | <div class="pathway-icon"> | ||
| 46 | <i class="fa fa-database" aria-hidden="true"></i> | ||
| 47 | </div> | ||
| 48 | <h3>Structure your information</h3> | ||
| 49 | <p> | ||
| 50 | Use XWiki classes, forms, templates and metadata to organize business information in a maintainable way. | ||
| 51 | </p> | ||
| 52 | <ul> | ||
| 53 | <li>Custom data models</li> | ||
| 54 | <li>Structured forms and templates</li> | ||
| 55 | <li>Metadata-driven pages and views</li> | ||
| 56 | </ul> | ||
| 57 | </article> | ||
| 58 | |||
| 59 | <article class="pathway-card"> | ||
| 60 | <div class="pathway-icon"> | ||
| 61 | <i class="fa fa-random" aria-hidden="true"></i> | ||
| 62 | </div> | ||
| 63 | <h3>Automate workflows</h3> | ||
| 64 | <p> | ||
| 65 | Support approvals, reviews, notifications, status changes and controlled document lifecycles directly in XWiki. | ||
| 66 | </p> | ||
| 67 | <ul> | ||
| 68 | <li>Review and approval workflows</li> | ||
| 69 | <li>Role-based actions and permissions</li> | ||
| 70 | <li>Notifications and task queues</li> | ||
| 71 | </ul> | ||
| 72 | </article> | ||
| 73 | |||
| 74 | <article class="pathway-card"> | ||
| 75 | <div class="pathway-icon"> | ||
| 76 | <i class="fa fa-plug" aria-hidden="true"></i> | ||
| 77 | </div> | ||
| 78 | <h3>Connect external systems</h3> | ||
| 79 | <p> | ||
| |
1.5 | 80 | Integrate XWiki with authentication systems, APIs, AI tools, internal services and external platforms. |
| |
1.2 | 81 | </p> |
| 82 | <ul> | ||
| 83 | <li>REST API integrations</li> | ||
| 84 | <li>SSO, LDAP and identity systems</li> | ||
| |
1.5 | 85 | <li>AI-assisted search and knowledge access</li> |
| |
1.2 | 86 | </ul> |
| 87 | </article> | ||
| 88 | </div> | ||
| 89 | </div> | ||
| 90 | </section> | ||
| 91 | |||
| 92 | ## COMMON DEVELOPMENT NEEDS | ||
| 93 | <section class="services" aria-labelledby="development-needs-title"> | ||
| 94 | <div class="container"> | ||
| 95 | <h2 id="development-needs-title">Common development needs</h2> | ||
| 96 | |||
| 97 | <p class="section-intro"> | ||
| 98 | Custom XWiki development can range from small improvements to full business applications built on top of | ||
| 99 | the platform. The focus is to keep the implementation useful, maintainable and aligned with XWiki conventions. | ||
| 100 | </p> | ||
| 101 | |||
| 102 | <div class="services-grid"> | ||
| 103 | <article class="service"> | ||
| 104 | <div class="service-icon" aria-hidden="true"> | ||
| 105 | <i class="fa fa-window-restore"></i> | ||
| 106 | </div> | ||
| 107 | <div class="service-body"> | ||
| 108 | <h4>Custom XWiki applications</h4> | ||
| 109 | <p> | ||
| 110 | Business-specific applications using XWiki classes, sheets, templates, UI extensions, scripts and components. | ||
| 111 | </p> | ||
| 112 | </div> | ||
| 113 | </article> | ||
| 114 | |||
| 115 | <article class="service"> | ||
| 116 | <div class="service-icon" aria-hidden="true"> | ||
| 117 | <i class="fa fa-check-square-o"></i> | ||
| 118 | </div> | ||
| 119 | <div class="service-body"> | ||
| 120 | <h4>Workflows and approvals</h4> | ||
| 121 | <p> | ||
| 122 | Review, approval, publishing, document control and status-based processes adapted to your internal rules. | ||
| 123 | </p> | ||
| 124 | </div> | ||
| 125 | </article> | ||
| 126 | |||
| 127 | <article class="service"> | ||
| 128 | <div class="service-icon" aria-hidden="true"> | ||
| 129 | <i class="fa fa-table"></i> | ||
| 130 | </div> | ||
| 131 | <div class="service-body"> | ||
| 132 | <h4>Dashboards and structured views</h4> | ||
| 133 | <p> | ||
| 134 | LiveData views, filters, reports, queues and dashboards that make structured XWiki information easier to use. | ||
| 135 | </p> | ||
| 136 | </div> | ||
| 137 | </article> | ||
| 138 | |||
| 139 | <article class="service"> | ||
| 140 | <div class="service-icon" aria-hidden="true"> | ||
| 141 | <i class="fa fa-file-pdf-o"></i> | ||
| 142 | </div> | ||
| 143 | <div class="service-body"> | ||
| 144 | <h4>PDF export and document outputs</h4> | ||
| 145 | <p> | ||
| 146 | Custom export templates, generated documents, controlled output formats and PDF-related workflow features. | ||
| 147 | </p> | ||
| 148 | </div> | ||
| 149 | </article> | ||
| 150 | |||
| 151 | <article class="service"> | ||
| 152 | <div class="service-icon" aria-hidden="true"> | ||
| 153 | <i class="fa fa-plug"></i> | ||
| 154 | </div> | ||
| 155 | <div class="service-body"> | ||
| 156 | <h4>External integrations</h4> | ||
| 157 | <p> | ||
| 158 | Integration with REST APIs, authentication systems, internal services, automation tools or third-party platforms. | ||
| 159 | </p> | ||
| 160 | </div> | ||
| 161 | </article> | ||
| 162 | |||
| 163 | <article class="service"> | ||
| 164 | <div class="service-icon" aria-hidden="true"> | ||
| 165 | <i class="fa fa-code"></i> | ||
| 166 | </div> | ||
| 167 | <div class="service-body"> | ||
| 168 | <h4>Macros, components and extensions</h4> | ||
| 169 | <p> | ||
| 170 | Custom macros, Java components, Velocity scripts, UI extensions and packaged XWiki extensions. | ||
| 171 | </p> | ||
| 172 | </div> | ||
| 173 | </article> | ||
| 174 | </div> | ||
| 175 | </div> | ||
| 176 | </section> | ||
| 177 | |||
| 178 | ## DEVELOPMENT APPROACH | ||
| 179 | <section id="development-process" class="split-section" aria-labelledby="process-title"> | ||
| 180 | <div class="container"> | ||
| 181 | <div class="split-grid"> | ||
| 182 | <div class="split-copy"> | ||
| 183 | <h2 id="process-title">A practical development approach</h2> | ||
| 184 | |||
| 185 | <p> | ||
| 186 | XWiki development works best when the solution fits the platform instead of fighting it. The goal is | ||
| 187 | to build features that are useful for business users while remaining understandable, maintainable and | ||
| 188 | compatible with future upgrades. | ||
| 189 | </p> | ||
| 190 | |||
| 191 | <p> | ||
| 192 | Development can start with a small improvement, a prototype or a full application. The important part is | ||
| 193 | to clarify the business process, model the information correctly and choose the right technical level: | ||
| 194 | configuration, scripting, extension development or external integration. | ||
| 195 | </p> | ||
| 196 | </div> | ||
| 197 | |||
| 198 | <ol class="process-list"> | ||
| 199 | <li> | ||
| 200 | <strong>Understand the business process</strong> | ||
| 201 | Clarify users, roles, data, statuses, permissions, outputs, notifications and expected decisions. | ||
| 202 | </li> | ||
| 203 | <li> | ||
| 204 | <strong>Design the XWiki model</strong> | ||
| 205 | Define the right structure using pages, spaces, XClasses, templates, sheets, rights and views. | ||
| 206 | </li> | ||
| 207 | <li> | ||
| 208 | <strong>Choose the implementation level</strong> | ||
| 209 | Decide whether the feature should be built with configuration, scripting, Java components or a packaged extension. | ||
| 210 | </li> | ||
| 211 | <li> | ||
| 212 | <strong>Build and validate iteratively</strong> | ||
| 213 | Implement the feature in manageable steps and validate it with real usage scenarios. | ||
| 214 | </li> | ||
| 215 | <li> | ||
| 216 | <strong>Document and prepare for maintenance</strong> | ||
| 217 | Leave clear notes about configuration, custom code, assumptions and future improvement areas. | ||
| 218 | </li> | ||
| 219 | </ol> | ||
| 220 | </div> | ||
| 221 | </div> | ||
| 222 | </section> | ||
| 223 | |||
| 224 | ## EXAMPLE SOLUTIONS | ||
| 225 | <section aria-labelledby="examples-title"> | ||
| 226 | <div class="container"> | ||
| 227 | <h2 id="examples-title">Example solutions</h2> | ||
| 228 | |||
| 229 | <p class="section-intro"> | ||
| 230 | The same XWiki foundation can support different internal tools, depending on how your organization manages | ||
| 231 | knowledge, documents, processes and collaboration. | ||
| 232 | </p> | ||
| 233 | |||
| 234 | <div class="widgets"> | ||
| 235 | <article class="widget"> | ||
| 236 | <div class="icon" aria-hidden="true"> | ||
| 237 | <i class="fa fa-file-text-o"></i> | ||
| 238 | <h4>SOP and document control</h4> | ||
| 239 | </div> | ||
| 240 | <p> | ||
| 241 | Controlled documents with review, approval, publishing, revision tracking, PDF export and lifecycle management. | ||
| 242 | </p> | ||
| 243 | </article> | ||
| 244 | |||
| 245 | <article class="widget"> | ||
| 246 | <div class="icon" aria-hidden="true"> | ||
| 247 | <i class="fa fa-tasks"></i> | ||
| 248 | <h4>Internal workflow applications</h4> | ||
| 249 | </div> | ||
| 250 | <p> | ||
| 251 | Lightweight business applications for requests, approvals, registers, task queues and process tracking. | ||
| 252 | </p> | ||
| 253 | </article> | ||
| 254 | |||
| 255 | <article class="widget"> | ||
| 256 | <div class="icon" aria-hidden="true"> | ||
| 257 | <i class="fa fa-sitemap"></i> | ||
| 258 | <h4>Knowledge structures</h4> | ||
| 259 | </div> | ||
| 260 | <p> | ||
| 261 | Templates, metadata, taxonomies, related articles and navigation structures for large knowledge bases. | ||
| 262 | </p> | ||
| 263 | </article> | ||
| 264 | |||
| 265 | <article class="widget"> | ||
| 266 | <div class="icon" aria-hidden="true"> | ||
| 267 | <i class="fa fa-exchange"></i> | ||
| 268 | <h4>Connected platforms</h4> | ||
| 269 | </div> | ||
| 270 | <p> | ||
| 271 | Integrations with authentication, APIs, external tools, notification systems and operational processes. | ||
| 272 | </p> | ||
| 273 | </article> | ||
| 274 | </div> | ||
| 275 | </div> | ||
| 276 | </section> | ||
| 277 | |||
| 278 | ## RELATED SERVICES | ||
| 279 | <section class="resource-strip" aria-labelledby="related-title"> | ||
| 280 | <div class="container"> | ||
| 281 | <h2 id="related-title">Related XWiki services</h2> | ||
| 282 | |||
| 283 | <p class="section-intro"> | ||
| 284 | Development work often connects with support, upgrades, authentication and long-term maintainability. | ||
| 285 | </p> | ||
| 286 | |||
| 287 | <div class="resource-grid"> | ||
| 288 | <article class="resource-card"> | ||
| 289 | <h4>XWiki Support & Maintenance</h4> | ||
| 290 | <p> | ||
| 291 | Ongoing technical care for production environments, including troubleshooting, maintenance planning and recovery support. | ||
| 292 | </p> | ||
| 293 | <a href="$xwiki.getURL('services.xwiki-maintenance-support')">View support services</a> | ||
| 294 | </article> | ||
| 295 | |||
| 296 | <article class="resource-card"> | ||
| 297 | <h4>XWiki Upgrade Services</h4> | ||
| 298 | <p> | ||
| 299 | Safe LTS upgrades with staging validation, compatibility checks, rollback planning and post-upgrade verification. | ||
| 300 | </p> | ||
| 301 | <a href="$xwiki.getURL('services.xwiki-upgrades')">View upgrade services</a> | ||
| 302 | </article> | ||
| 303 | </div> | ||
| 304 | </div> | ||
| 305 | </section> | ||
| 306 | |||
| 307 | ## CTA | ||
| 308 | <section class="cta-section" aria-labelledby="cta-title"> | ||
| 309 | <div class="container"> | ||
| 310 | <div class="cta-panel"> | ||
| 311 | <h2 id="cta-title">Need to build something in XWiki?</h2> | ||
| 312 | |||
| 313 | <p> | ||
| 314 | Send a short description of the process, workflow, integration or application you want to create. | ||
| 315 | A few details about users, data and expected outcomes are enough to start the conversation. | ||
| 316 | </p> | ||
| 317 | |||
| 318 | <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Discuss a project</a> | ||
| 319 | </div> | ||
| 320 | </div> | ||
| 321 | </section> | ||
| 322 | |||
| 323 | {{/html}} | ||
| 324 | {{/velocity}} |