Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 2.03 KB

example-app.md

File metadata and controls

34 lines (20 loc) · 2.03 KB
Raw

Example App

Table of contents

Introduction

The example app can be used to understand the DocmosisCloud module. It may assist you with ideas of how to implement the module in your own app.

Where to find the Example App

Download the latest version as zip file or use git to clone it from the GitHub repository.

To run the app, open it in Mendix Studio Pro and in the profile update the two DocmosisCloud module constants with your Docmosis Cloud access key and endpoint. Or start the app and enter the access key on the home page in the appropriate field.

ATTENTION: This example app exposes the API access key visually. So when you want to hide it then remove the field(s) from the app's home page.

What is in the Example App

These modules are in the app:

  • DocmosisCloud: That is the module where this is all about.
  • DocmosisSamples: The business entities to manage customers, products and invoices and trigger the creation of PDFs.
  • DocmosisCloudImplementation: This module implements the module in this specific app with its specific needs. Here decision are made how to create PDFs, how to handle errors, etc. This is specific to the app, operational needs, etc.
  • DocmosisCloudUnitTesting: Implementation of unit tests for the DocmosisCloud module, directly related to development of it.

In case of errors or other unforeseen events the module does not log errors or show messages to the user. It is up to your app to decide what to do. Hint: Use module DocmosisCloudImplementation to get inspiration how you could implement this in your app so it matches your operational need.

This is what the app looks like in terms of layers. Module DocmosisCloudUnitTesting is not in scope.

Module