Installation guide

Zetadocs for NAV Installation Guide
This edition 5
th
December 2012 © Copyright Equisys plc 2012 All trademarks acknowledged All rights
reserved
Page 57
10. SDK Primer
The Zetadocs for NAV SDK is made up of two parts, Zetadocs Capture Plus and Zetadocs Delivery Plus. It
was created to allow NAV developers to further customize the Zetadocs for NAV features to meet bespoke
requirements. With the SDK it is easy to leverage the core features of Zetadocs for NAV, Delivery and
Capture, to provide complex, high value business processes that are fully integrated into NAV.
NOTE: To get the most from the Zetadocs for NAV SDK it is recommended that you take a moment to
understand the goals of the SDK and the logic behind the framework. This section aims to give a short
overview of the SDK framework which will then simplify your understanding of the Capture and Delivery
Plus examples in the subsequent chapters and help you in designing good solutions with Zetadocs.
10.1 Goals of the SDK
It is common in the NAV community that customizations are implemented as and where the developer sees
fit. Most NAV objects are open to developers to modify. The positive aspect of this is the speed of
implementation. However there is a negative aspect and that is the cost of maintenance and upgrade.
Equisys identified the challenge this presents for developers and has designed this SDK with this in mind.
Our goal is to make upgrades and patches of the Zetadocs for NAV product much simpler and faster by
removing the need to merge customizations into updated object versions. Our SDK goals are:
1. Structured - Provide designated entry points for NAV developer code
2. Flexible - Integrate Zetadocs for NAV features with any records of NAV*
3. Intuitive Use a framework to provide a consistent style of customization implementation
*This refers to the use of the typeless RecordID and RecordRef types over the strongly typed Record type. There is no guaranteed of
the suitability of any NAV record for use with Zetadocs.
10.2 Understanding the Framework
There are three elements to the Zetadocs for NAV SDK. They are:
1. Interfaces
This is the name given to existing NAV forms, pages, codeunits or reports that are
modified to call the Zetadocs for NAV Core codeunits to provide Zetadocs for NAV
functionality. Our aim is to make these modifications as minimal as possible.
2. Zetadocs Core Codeunits
These are our codeunits which developers do not have modify permissions for. They
perform the bulk of Zetadocs for NAV processing and call the Integration and
Customization codeunits to run developer code.
3. Integration and Customization Codeunits
These are our codeunits which developers with the Zetadocs SDK granule do have modify
permissions for. They provide simple call out functions which the developer implements
his custom code in.
Developers should look to understand the integration and customization entry points before designing their
solution.
10.3 Process Flow
The processing flow follows the same pattern in both Plus feature areas.
1. The interfaces calls the Zetadocs Core codeunits which use the Zetadocs for NAV settings to
perform the action.
2. If there is no suitable configuration available for the records being processed then the Zetadocs
Code calls out to the Integration and Customization codeunits to get the information. It is here that
the developer can implement bespoke settings and integrate with custom records.
3. Once all processing has been completed, the Zetadocs Core calls out to the Customization
codeunits with modifiable data sets to instruct the core codeunits on how to complete the action
processing. It is here that the developer can implement custom business logic, enhanced Zetadocs
feature functionality and integration with other subsystems.