Skip to content
Bizeo Development Kit
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitattributes
.gitignore
README.md

README.md

BizeoDevelopmentKit

Bizeo Development Kit contains everything you need to create a package for Bizeo Drones. You will need to add a reference to BizeoDevelopmentKit.dll and implement the IPackage interface.

public interface IPackage
{
    /// <summary>
    /// Gets all scripts details
    /// </summary>
    IEnumerable<ScriptDescription> GetScriptDetails();

    /// <summary>
    /// Return options for a parameter
    /// </summary>
    /// <remarks>
    /// Some scripts allow user to choose parameters from drop down lists. Those parameters must be in type DropDownList
    /// </remarks>
    /// <param name="dataSource">The data source</param>
    /// <param name="script">The script</param>
    /// <param name="paramName">The name of the parameter</param>
    /// <param name="args">Others arguments</param>
    /// <returns>Sequence of options for the parameter</returns>
    IEnumerable<ParameterOption> GetParameterOptions(DataSource dataSource, ScriptDescription script, string paramName, object[] args);

    /// <summary>
    /// Executes a task
    /// </summary>
    /// <param name="task">The task</param>
    /// <param name="script">The script</param>
    /// <param name="dataSource">The data source</param>
    ExecutionResult Exec(Task task, DataSource dataSource, ScriptDescription script);

    /// <summary>
    /// Gets form to add a data source for the package
    /// </summary>
    DataSourceConfigurationForm AddDataSource();

    /// <summary>
    /// Get form to edit a data source for the package
    /// </summary>
    /// <param name="entity">The data source to be edited</param>
    DataSourceConfigurationForm EditDataSource(DataSource entity);
}

Sample

You can find source code for the sample package at BizeoDevelopmentKit.Sample. The sample package is also available on the Bizeo Store.


How to test your own package

Bizeo allows developers to test their packages before releasing them to the Bizeo store. For testing it is required that you have a Bizeo drone installed along with an active Bizeo account. Steps to test your package:

  • Root folder for Bizeo Drone files is [CommonAppData]\DMS\BizeoMonitor, in Windows 7 & 8 it is C:\ProgramData\DMS\BizeoMonitor.
  • Create directory for the package assemblies in [Root]. The directory location should follow the convention [Root]\packages\[PackageName without spaces]\[version].
  • Append package description and script description in JSON format to [Root]\Packages.txt and [Root]\Scripts.txt.
  • Restart the drone service so that it registers the new package.
  • Configure a data source for the package.
  • At this point, you are able to create tasks for your own package.

How to publish your package to Bizeo Store

Currently, the process is handled manually by Bizeo team. You will need to contact the Bizeo team at integration@bizeo.com.au when your package is complete.

License

© 2014 Bizeo Bizeo is a registered trademark of Direct Marketing Software Pty Ltd. "Business at a glance" is a trademark of Direct Marketing Software Pty Ltd. Patent pending.

You can’t perform that action at this time.