Create a class-based Script Include

Class-based Script Includes create true object instances with state, unlike function-based ones that are just namespaces. The Class.create() pattern gives you constructor logic, private instance variables, and the ability to maintain state between method calls. The type property isn't decorative — it's required for proper instantiation, especially in scoped applications where the platform needs to resolve the class name correctly.

When to use this pattern

• When you need to maintain configuration or state between method calls on the same instance
• When building utilities that other developers will instantiate with new ClassName() rather than static method calls
• When you need constructor parameters to customize behavior per instance
• When building APIs that other scoped apps will consume — the type property ensures proper cross-scope instantiation

When NOT to use this pattern

• For simple utility functions with no state — use function-based Script Includes instead for better performance
• In client scripts — you need Client callable checked and GlideAjax pattern instead
• When you only need static helper methods — creating instances adds unnecessary overhead
• For one-off logic that won't be reused — put it directly in the Business Rule or calling script

Key behaviors and gotchas

• The type property must exactly match the Script Include name — case sensitive
• Missing initialize function causes silent failures when instantiating with new operator
• Instance variables set in initialize with this.property persist across method calls on the same instance
• Methods defined on prototype are shared across all instances — don't store instance-specific data there
• Private methods prefixed with underscore are convention only — they're still accessible externally
• Cross-scope instantiation requires the Script Include to be in a dependency relationship or global scope