ServiceBuilder Quick Reference
Build and deploy OpenForum services, JavaScript libraries, Extensions, Plugins, and Progressive Web Apps
Key Features
- Service Builder - Create OpenForum services with API endpoints
- Javascript Builder - Build and minify JavaScript libraries
- Extension Builder - Create OpenForum markup extensions
- Plugin Builder - Build server-side plugins
- Progressive Web App Builder - Generate PWA manifests and service workers
- Code generation and scaffolding
- Automated build processes
Server-Side Usage:
<![CDATA[
// Get the ServiceBuilder API
var ServiceBuilder = js.getObject("/OpenForum/AddOn/ServiceBuilder","ServiceBuilder.sjs");
// Build a service
ServiceBuilder.buildService("/MyPage", {
serviceName: "MyService",
endpoints: ["getData", "postData"]
});
// Build JavaScript library
ServiceBuilder.buildJavascript("/MyPage", {
sourceFiles: ["file1.js", "file2.js"],
outputFile: "library.min.js",
minify: true
});
// Generate Extension
ServiceBuilder.buildExtension("/MyPage", {
extensionName: "MyExtension",
parameters: ["param1", "param2"]
});
// Build Progressive Web App
ServiceBuilder.buildPWA("/MyPage", {
appName: "My App",
description: "App description",
icons: ["icon-192.png", "icon-512.png"]
});
]]>
Client-Side Usage:
<![CDATA[
// Build service via API
JSON.post('/OpenForum/AddOn/ServiceBuilder/Build', null,
'pageName=/MyPage&type=service&config=' JSON.stringify(config))
.onSuccess(function(result) {
console.log('Service built:', result);
}).go();
// Generate PWA manifest
JSON.post('/OpenForum/AddOn/ServiceBuilder/PWA', null,
'pageName=/MyPage&appName=MyApp')
.onSuccess(function(result) {
console.log('PWA created:', result);
}).go();
]]>
Builder Types
- Service Builder - API endpoints and server-side services
- Javascript Builder - Bundled and minified JavaScript
- Extension Builder - OpenForum markup extensions
- Plugin Builder - Server-side Java plugins
- PWA Builder - Progressive Web App configuration
Configuration
- Build output locations
- Minification settings
- Dependency management
- Service definitions