8 implementation notes

BEXIS Tech Talk Series

#8: Implementation Notes

Javad ChamanaraJanuary 2017

Jena, Germany

2BEXIS Tech Talk #8: Implementation Notes

Reminder

• Tech Talk 5: BExIS Extensibility


Modules

• What is a module?A module is a set of related user facing

functions, operating from inside the BExIS shell


Module Development Consideration

• ASP.NET MVC 5• Plug-ability– Independent development, testing, publishing– Online deployment

• Shell Integration – Menu integration– State Management


Module Anatomy

• UI project:– Entry points– Controllers, Models, Views– Manifest file• Menus, dependencies, identification

• Services• Data Access


Module Anatomy

• Bootstrapping – Install– Uninstall

• State Management– Start– Shutdown– Activate– InActivate


Module Development Recipe

• 1: Defines the required names– <moduleID>: usually a three letter abbreviation of your

module name– <Affiliation>: the institute that owns the module– <projectName>: <Affiliation>.Modules.<moduleID>– <projectCode>: <projectName>.UI


Create the UI project

• From scratch:– Read the “Module Development Recipes” doc

• From a template– Follow up


Create a Module from a Template

• Copy “Module.Template” folder to the Areas folder– The template is in the “Repo/Code/Templates”

folder– Replace the name with actual <moduleID>– Remove the tailing “Template” token



• Inside the folder, rename:– *.csproj to <projectCode>.csproj– *.csproj.user to <projectCode>.csproj.user



• In the VS Solution explorer, at solution’s root• Create the “Modules” folder in does not exists• Create a <moduleID> folder under the “Modules” folder.



• Add Existing Project• <projectCode> from the Areas/<moduleId>• To solution/Modules/<moduleID> • Via “Add Existing Project”.



• From inside VS, rename the followings:– ModuleIDModule.cs to <moduleID>Module.cs– ModuleID.Manifest.xml to

<moduleID>.Manifest.xml



• Edit the <moduleID>Module.cs – Update the namespace to <projectCode>– Update the class name to <moduleID>Module– Pass <moduleID> to the base constructor



• Edit /Views/web.config–Edit <add namespace="Template.UI" /> to <add

namespace="<projectCode>" />



• Edit the module manifest• Change the moduleId from “Template” to <moduleID>• Update other attributes and elements



• Develop designated features– Controllers/ Actions– Views



• Shell publishing does not include the module



• Publish the module


The Manifest File


The Manifest File: Dependencies

• Must be installed and active• Required version is checked against available

one


The Manifest File: Exports

• Publicly accessible module features• Plugged into the menu structure• Document order is preserved– Also catalog order


The Manifest File: Exports

• Id: export port id for path/hierarchy building• Title: as menu label• Description: as tooltip• Controller: the controller name• Action: the action name• Argument: If the action has a parameter• Extends: The injection point in the menu

structure


Module Publishing

• Shell is already published• Areas folder does not include the module• Publish the module into a folder• Create a zip bundle


Module Registration

• Method 1:– Update Modules.Catalog.xml– Create the <moduleID>folder under Shell/Areas– Unzip the module zip file into the folder

• Method 2:– Use the SAM’s registration feature


Module Management


Documents

• Module Development Recipes• Naming Conventions• DLM API docs

28BEXIS Tech Talk #7: Configuration and Change Management

Outlook

What‘s next in the talk series?

Nothing

2929

Thanks!Questions?

Contact:[email protected]://bexis2.uni-jena.de

Acknowledgment

BEXIS Tech Talk #8: Implementation Notes

Software

8 implementation notes