Deltek Maconomy Extender Handbook for Using the Maconomy Extender IDE July 31, 2014 While Deltek has attempted to verify that the information in this document is accurate and complete, some typographical or technical errors may exist. The recipient of this document is solely responsible for all decisions relating to or use of the information provided herein. The information contained in this publication is effective as of the publication date below and is subject to change without notice. This publication contains proprietary information that is protected by copyright. All rights are reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, or translated into another language, without the prior written consent of Deltek, Inc. This edition published July 2014. © 2014 Deltek, Inc. Deltek’s software is also protected by copyright law and constitutes valuable confidential and proprietary information of Deltek, Inc. and its licensors. The Deltek software, and all related documentation, is provided for use only in accordance with the terms of the license agreement. Unauthorized reproduction or distribution of the program or any portion thereof could result in severe civil or criminal penalties. All trademarks are the property of their respective owners. Handbook for Using the Maconomy Extender IDE ii Contents Terminology and Concepts .............................................................................................................. 1 Installation ........................................................................................................................................ 2 Installing in Eclipse ...................................................................................................................... 2 Updating Maconomy Extender .................................................................................................... 3 Alternative Update Method .......................................................................................................... 5 Starting Maconomy Extender .......................................................................................................... 6 Setting Up a Server Repository ....................................................................................................... 7 Extending a Maconomy Installation ............................................................................................... 10 Creating a MaconomyExtender Project .................................................................................... 10 Automatic Check of the Maconomy Version ............................................................................. 13 Find, Open, and Copy Standard and Solution files ................................................................... 14 Inspecting Container Definitions ............................................................................................... 16 Server-Specific Files ................................................................................................................. 17 Validating Changes ................................................................................................................... 17 Impact Analysis ......................................................................................................................... 18 Testing Changes on a Local Maconomy Installation ................................................................ 18 Comparing Files on the Sandbox Server with Files in the Active Project ................................. 19 Comparing Files from the Standard Layers with Files in the Active Project ............................. 20 Inspecting Installed Files on a Server ....................................................................................... 20 Pushing Changes to the Server Repository .............................................................................. 20 Deploying Changes ................................................................................................................... 22 Development Workflow and Git ..................................................................................................... 24 Introduction to Git ...................................................................................................................... 24 Work Process and Server Setup ............................................................................................... 25 Server Setup and Relation to Branches .................................................................................... 27 Deployment Diagram................................................................................................................. 27 Rules Imposed by Maconomy Extender ................................................................................... 28 Workflow Examples ................................................................................................................... 29 Maconomy Classic Support ........................................................................................................... 32 Creating Maconomy Classic Folders ........................................................................................ 32 Specifying Customer Numbers and Building and Stamping Options ........................................ 32 Need a Special License File? .................................................................................................... 34 Deploying Reports ..................................................................................................................... 34 Working with Servers ..................................................................................................................... 35 Deploying to a Server ................................................................................................................ 36 Handbook for Using the Maconomy Extender IDE iii Promoting to a Server ............................................................................................................... 36 Forced Deploy (Deploy to Server) ............................................................................................. 37 Viewing Installation History ....................................................................................................... 37 Changing the Server Configuration ........................................................................................... 37 Using the Editors ........................................................................................................................... 40 Working with the Source ........................................................................................................... 40 Working with the MMSL Preview .............................................................................................. 42 Working with the MWSL Preview .............................................................................................. 42 Working with the MDML Preview .............................................................................................. 46 Authentication and Authorization Support ..................................................................................... 49 Access Roles ............................................................................................................................. 49 Login Dialog .............................................................................................................................. 50 Extension Framework Development.............................................................................................. 51 Prerequisite ............................................................................................................................... 51 Creating a Bundle ...................................................................................................................... 51 Extending a Container ............................................................................................................... 52 Creating a Root Container ........................................................................................................ 52 Setting the Target Platform ....................................................................................................... 54 Whitelist ..................................................................................................................................... 55 Download a Coupling Service ................................................................................................... 55 Starting the Coupling Service for Testing.................................................................................. 55 Deploying Changes ................................................................................................................... 55 Uninstalling Extensions ............................................................................................................. 56 Custom Dictionaries ...................................................................................................................... 57 Add and Modify Dictionary Files ................................................................................................ 57 Deploying Dictionaries............................................................................................................... 57 Working with the Git Version Control System ..............................................................................