History: Data Channels
Preview of version: 9
Prerequisite: Profile Developer Documentation
Data channels are named piped allowing to run profiles from user space. They can be used to:
A channel is composed of:
Channels are configured through the profile Administration Interface using a textbox. The format of the textbox is comma delimited, one channel per line.
The above sample creates two channels. One that will receive commit messages from subversion and save them using the profile located in the local wiki page called SvnCommit. The channel can only be used by administrators for test purposes and users in Subversion (which likely contains a single system user with credentials stored in the SVN plugin). The second one creates a base workspace and is accessible by normal users. A custom form will be required to use it.
Channels can use remote profiles as well. However, unless the remote tiki installation is in a controlled environment, like an intranet configuration repository, remote channels are not recommended.
Data channel profiles use the User Input syntax to transmit information from the request to the profile.
Once configured, data channels can be called through 'tiki-channel.php'. The request uses a simple HTTP request to perform the desired task. The file can execute multiple channels simultaneously and will verify that the user can execute them all before executing any of them. Basic authentication will be used for anonymous users if any of the channels require groups other than Anonymous to handle machine requests.
Root keys on GET or POST request:
Data channels are named piped allowing to run profiles from user space. They can be used to:
- Allow external applications to feed data into tiki
- Create custom forms to execute complex actions
A channel is composed of:
- A unique name composed of alphanumeric characters and underscores
- A profile domain, usually tiki://local to use local pages as profiles
- A profile name
- A list of groups allowed to execute the channel
Channels are configured through the profile Administration Interface using a textbox. The format of the textbox is comma delimited, one channel per line.
Sample configuration
svn_commit, tiki://local, SvnCommit, Subversion, Admins create_workspace, tiki://local, WorkspaceConfiguration, ProjectLeads, Admins
The above sample creates two channels. One that will receive commit messages from subversion and save them using the profile located in the local wiki page called SvnCommit. The channel can only be used by administrators for test purposes and users in Subversion (which likely contains a single system user with credentials stored in the SVN plugin). The second one creates a base workspace and is accessible by normal users. A custom form will be required to use it.
Channels can use remote profiles as well. However, unless the remote tiki installation is in a controlled environment, like an intranet configuration repository, remote channels are not recommended.
Data channel profiles use the User Input syntax to transmit information from the request to the profile.
Calling Data Channels
Once configured, data channels can be called through 'tiki-channel.php'. The request uses a simple HTTP request to perform the desired task. The file can execute multiple channels simultaneously and will verify that the user can execute them all before executing any of them. Basic authentication will be used for anonymous users if any of the channels require groups other than Anonymous to handle machine requests.
Root keys on GET or POST request:
- return_uri: Optional URI to return to when processed for end users
- channels: Mandatory array containing the channels to process. Each element of the array contains:
- channel_name: Mandatory name of the channel to process
- Arbitrary keys: Will be sent to the installer as user input
Sample POST request
channels[0][channel_name]=svn_commit&channels[0][version]=16345&channels[0][message]=Sample+Message&channels[1][channel_name]=svn_file_modification&channels[1][version]=16345&channels[1][file]=test.php&channels[2][channel_name]=svn_file_modification&channels[2][version]=16345&channels[1][file]=test2.php&return_uri=/success.php
Related
http://blog.lphuberdeau.com/wordpress/2009/01/25/adding-collaboration-and-durability-to-code-reviews/Examples of uses
These are just examples for now. Just Vaporware :-)- A site owner would like that all users that register can create their own image galleries, one public and one private.
- A company would like to deploy a Time_Sheet for each employee.
- Employees can only see their own time sheet.
- Supervisors can see all the Time sheets of employees in their group.
History
Current Profiles
Latest Changes
- test_new_personal_blog_and_profile_vlog_include
- test_new_personal_blog_and_profile
- Profile_Test_all_Modules_Test_all_Modules_page
- test_profile_change
- Bug_Tracker_16
- Bug_Tracker_16
- Profile_Tracker_as_Calendar_page_09
- Tracker_as_Calendar_09
- TikiKart_Product_Include
- Shopping_Cart
- Scheduler_Presets_20
- test_new_personal_blog_and_profile_post3_include
- test_new_personal_blog_and_profile_post2_include
- test_new_personal_blog_and_profile_post1_include
- test_new_personal_blog_and_profile_about_include
- test_new_personal_blog_and_profile_social_include
- R_demo
- Voting_System
- Test_all_tracker_field_types_profile
- Tracker_as_Calendar_10