Difference between revisions of "Freeside:1.7:Documentation:Developer"

From Freeside
Jump to: navigation, search
Line 1: Line 1:
=== Price plans ===
+
= Introduction =
 +
 
 +
= Signup and self-service =
 +
 
 +
You can of course customize the signup and self-service templates as well as plug into the self-service API from Perl, PHP or any other language via XML-RPC.  See [[Freeside:1.7:Documentation:Developer/FS/SelfService|FS::SelfService API]].
 +
 
 +
= Backend plugins =
 +
 
 +
The backend code is structured to make it easy to add "plugins" of various types.  1.7 allows you to easily add new price plans and exports.  1.9 extends this and additionally allows event plugins (conditions and actions) and new kinds of service tables.
 +
 
 +
== Price plans ==
  
 
[[Freeside:1.7:Documentation:Developer:Price Plans|Price plans]]
 
[[Freeside:1.7:Documentation:Developer:Price Plans|Price plans]]
  
=== Exports ===
+
== Exports ==
  
 
[[Freeside:1.7:Documentation:Developer:Exports|Exports]]
 
[[Freeside:1.7:Documentation:Developer:Exports|Exports]]
  
=== (Invoice) Events ===
+
== (Invoice) Events ==
 +
 
 +
Invoice events have been refactored in 1.9.x and are now just events.  The new events have "Condition" and "Action" plugins.
 +
 
 +
== Services ==
 +
 
 +
Service tables are fully "plug-in" able - just create the table (see "Schema changes" below) and define the %info hash.
  
have been refactored in 1.9.x
+
= Additional developer information =
  
=== Schema changes ===
+
== Schema changes ==
  
 
[[Freeside:1.7:Documentation:Developer:Schema changes|Schema changes]] - Quick documentation on how to make schema changes
 
[[Freeside:1.7:Documentation:Developer:Schema changes|Schema changes]] - Quick documentation on how to make schema changes
  
=== Agent virtualization ===
+
== Agent virtualization ==
  
 
[[Freeside:1.7:Documentation:Developer:Agent-virtualized Config|Agent-virtualized config]] - Quick notes on how to agent-virtualize new parts of the configuration tables
 
[[Freeside:1.7:Documentation:Developer:Agent-virtualized Config|Agent-virtualized config]] - Quick notes on how to agent-virtualize new parts of the configuration tables
  
=== API documentation ===
+
= API documentation =
  
 
[[Freeside:1.7:Documentation:Developer/FS|1.7 API documentation]]
 
[[Freeside:1.7:Documentation:Developer/FS|1.7 API documentation]]

Revision as of 17:57, 2 January 2008

Introduction

Signup and self-service

You can of course customize the signup and self-service templates as well as plug into the self-service API from Perl, PHP or any other language via XML-RPC. See FS::SelfService API.

Backend plugins

The backend code is structured to make it easy to add "plugins" of various types. 1.7 allows you to easily add new price plans and exports. 1.9 extends this and additionally allows event plugins (conditions and actions) and new kinds of service tables.

Price plans

Price plans

Exports

Exports

(Invoice) Events

Invoice events have been refactored in 1.9.x and are now just events. The new events have "Condition" and "Action" plugins.

Services

Service tables are fully "plug-in" able - just create the table (see "Schema changes" below) and define the %info hash.

Additional developer information

Schema changes

Schema changes - Quick documentation on how to make schema changes

Agent virtualization

Agent-virtualized config - Quick notes on how to agent-virtualize new parts of the configuration tables

API documentation

1.7 API documentation