Challenge Overview
Introduction
Welcome to the Actian DataConnect MCF SDK Getting Started Guide Documentation Challenge.
Actian is the hybrid data management, integration, and analytics Company that enables Enterprises to seamlessly manage and connect operational and analytic data for superior performance, insights, and business outcomes. Activate Your DataTM - Learn more about Actian’s products here and follow us on Twitter.
Overview
We need help from the TopCoder Community to build a new Getting Started Guide for Actian DataConnect MCF SDK.
The existing MCF documentation is available here - http://docs.actian.com/dataconnect/11.2/index.html#page/User%2FUsing_Message_Component_Framework.htm%23
The Message Component Framework (MCF) allows development of components to process message objects with binary or string content. It provides a uniform run-time environment for message handling, as well as services needed during data integration execution. It also manages the component life cycle and component actions.
Developers use the MCF SDK and its Java API to build components of various types:
• Aggregator - Builds a complex message object from a collection of simpler message objects.
• Invoker - Provides an adapter for external application interfaces.
• Iterator - Iterates over a logical collection of messages.
• Queue - Provides connectivity to a message channel.
• Transformer - Transforms a message object.
• Validator - Validates a message object.
The finished components are installed as DataConnect plug-ins and used in Process Designer.
Conceptually, Message Component Framework consists of five parts:
• Component services
• Component (plug-in)
• Component manager
• Component model
• Component instance
Component services are provided for use by component writers. The Manager, Model, and Instance components are internally implemented. The physical implementation of actual components uses some utility classes. It also involves subclassing the component model to support various component types and programming languages.
Currently, support is provided for writing components in Java.
Each Java class supported by the Message Component Framework is described in a Javadoc viewable with a browser that will be made available for download in the forums when you complete registration for the challenge.
The DataConnect Studio IDE and a temporary use license for the software in which you can deploy the completed example will also be made available in the forums upon registration.
The Java application programming interface (API) document is an HTML file that can be viewed with a browser.
Requirements
- Create an easy to read, task-oriented, getting started guide for the Actian DataConnect MCF SDK. This guide should make it easier for developers to learn how to easily create new adapters for external application interfaces etc. The target audience for this guide are Developers, Data Integration Specialists, Business Systems Analysts, and Data Scientists.
- Provide for at least one example of the core functionality, and at a minimum document the steps a developer would follow in order to create an invoker for oAuth2.
Deliverables
- Getting Started Guide for MCF SDK as per the requirements detailed above.
- The guide should be written in HTML format with links to various section and subsections similar to existing Actian DataConnect documentation so that it can be published on Actian website.
Submission/ Review
-
Submit your zipped Getting Started Guide
-
The submissions will be scored by Actian team in its sole discretion, there will be no appeals or appeals responses
Scorecard
All submissions will be scored on a scale of 1-10 based on
- Coverage of MCF SDK functionality
- Completeness of steps for creating the oAuth2 invoker
- ���Ability to provide instruction and describe concepts in an easy to understand manner
Additional terms and conditions for all participants
By participating in this Competition, You acknowledge and agree that
-
You must comply with all applicable laws in submitting a Competition Submission, and you represent that you are authorized to submit the Competition Submission.
-
Actian Corporation (“Actian”) is free to use, disclose, distribute or otherwise exploit Residual Knowledge. Residual Knowledge means information that is retained in the unaided memories of Actian’s employees and contractors who have had access to any Competition Submissions submitted by You. An employee’s or contractor’s memory will be considered unaided if the employee or contractor has not intentionally memorized the information for the purpose of retaining and subsequently using or disclosing it; and
-
If You provide comments, criticism, suggested improvements, test results, answers to questions, and other feedback regarding the function, features, and other characteristics of the Actian products in written or oral form (“Feedback”), You agrees that all Feedback is the property of Actian and may be used, reproduced, adapted, modified, distributed, and otherwise exploited by Actian in any manner and for any purpose.
-
You are not entitled to any compensation from Actian or any of the benefits which Actian may make available to its employees, and You are not authorized to make any representation, contract or commitment on behalf of Actian.
-
Employees and direct and indirect subcontractors of Actian Corporation and its subsidiaries and other affiliates, and employees and direct and indirect subcontractors of Actian’s partners (including TopCoder and its affiliates) are not eligible to participate in the challenge.
-
You may only use data that is open and that can be shared with anyone in the world and which is freely available and to which you have rights to use the data in submitting such data.