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