microsoft dynamics entrepreneur developer guidelines

Upload: molinaj

Post on 08-Apr-2018

226 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    1/26

    +

    Microsoft Dynamics Entrepreneur

    Solution 2008

    Developer Guidelines

    January 7, 2008

    Dynamics Entrepreneur Solution

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    2/26

    2

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    The information contained in this document represents the current view of Microsoft Corporation on the

    issues discussed as of the date of publication. Because Microsoft must respond to changing market

    conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft

    cannot guarantee the accuracy of any information presented after the date of publication.

    These test guidelines are for informational purposes only. MICROSOFT MAKES NO WARRANTIES,

    EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS DOCUMENT.

    Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights

    under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval

    system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or

    otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

    Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property

    rights covering subject matter in this document. Except as expressly provided in any written license

    agreement from Microsoft, the furnishing of this document does not give you any license to these

    patents, trademarks, copyrights, or other intellectual property.

    Unless otherwise noted, the example companies, organizations, products, domain names, e-mail

    addresses, logos, people, places, and events depicted herein are fictitious, and no association with any real

    company, organization, product, domain name, email address, logo, person, place, or event is intended or

    should be inferred.

    (2007) Microsoft Corporation. All rights reserved.

    Microsoft, Microsoft Dynamics, and Windowsare either registered trademarks or trademarks of MicrosoftCorporation in the United States and/or other countries.

    The names of actual companies and products mentioned herein may be the trademarks of their respective

    owners.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    3/26

    3

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Contents

    Introduction ....................................................................................................................... 5

    About this Document ..................................................................................................................................................................... 5Contents of the Developer Guidelines .................................................................................................................................... 5

    Menu Structure .................................................................................................................. 6Forms ................................................................................................................................... 8

    General Form Characteristics ...................................................................................................................................................... 8List Forms ......................................................................................................................................................................................... 10

    List Form Properties .................................................................................................................................................................10Card Forms ...................................................................................................................................................................................... 11

    Card Form Properties ..............................................................................................................................................................12Common Centers ............................................................................................................. 13

    No Series Center ........................................................................................................................................................................... 13Common Data Center ................................................................................................................................................................. 16Dimension Center ......................................................................................................................................................................... 19Posting Group Center ................................................................................................................................................................. 20

    Reporting .......................................................................................................................... 23Report Center ................................................................................................................................................................................. 23

    End-user layout ..........................................................................................................................................................................23Adding new reports .................................................................................................................................................................23

    Company Set-up .............................................................................................................. 26

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    4/26

    4

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    5/26

    5

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    IntroductionAbout this Document

    The Microsoft Dynamics Entrepreneur Solution Developer Guidelines describes thecharacteristics of the application from a Graphical User Interface (GUI) point of view. Theassumption is made that the reader is familiar with the User Interface Guidelines forMicrosoft Dynamics NAV and thus this document mainly focuses on the differencesbetween the two guidelines.

    The goal of the document is to serve as a reference guide for developers/ISVs that arebuilding functionality for Microsoft Dynamics Entrepreneur to assure that these solutionswill have a consistent look and feel. For Microsoft Dynamics Entrepreneur Solution Add-on Applications, this guide supersedes the corresponding Microsoft Dynamics NAVdocumentation in case of contradicting information.

    Contents of the Developer Guidelines

    This document contains the following sections:

    Menu structure

    Form layouts

    Centralized Maintenance for:

    o Common Data

    o Posting Groups

    o Number Ranges

    o Dimensions

    Report Center

    Company Set-up

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    6/26

    6

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Menu StructureThe menu structure of Microsoft Dynamics Entrepreneur is based on the MicrosoftDynamics NAV navigation pane also found in Microsoft Outlook. To have a more intuitivestructure the following starting points have been chosen:

    Limited number of menus

    One menu for each functional area such as

    o Finance

    o Purchase

    o Sales

    o Inventory

    o Resources

    A separate menu for Reporting

    A separate menu for Administration

    Characteristics of a menu

    o Main entities of the functional area are always directly on top of the menu

    o Menu groups for (preferably in this order)

    Transactions

    Functions

    Documents

    Analysis & Reporting

    History

    And others if applicable

    Choosing an item from a menu which opens a form should always result in opening alist form.

    All common data is maintained from within the Common Data Center. This meansthat common data in the different functional areas does not require a specific menuentry but are grouped in one place.

    The same applies for Reports / Dimensions / Posting Groups

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    7/26

    7

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Figure 1: Microsoft Dynamics Entrepreneur Solution Navigation Pane and menu structure

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    8/26

    8

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    FormsGeneral Form Characteristics

    Background color mandatory controlsControls that access mandatory fields are represented with a yellow background color.This way the user can easily see which fields are required to be filled in.

    Height of Table Controls and List FormsAll table controls and other list forms have a header section height of 880 pixels instead

    of 440. This way the majority of texts in the header columns are visible by default.

    The Show Card arrow buttonAll list forms that have a related card form contain a one-click button in the first column.Clicking this arrow button automatically opens the card form with the data of the selected

    row from the list form.

    The Show Comments pencil buttonAll list forms that have a related comments table contain a one-click button in the lastcolumn. Clicking this pencil button automatically opens the list of comments that areattached to the selected row from the list form. Please note the different pencil icons toindicate whether comments are already available or not.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    9/26

    9

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Lines with dates due shown in redWhen showing lines on which the date is the past the due date, the line is shown in red tonotify the user for a potential issue.

    Information Pane on Card FormsCard forms contain an information frame on the right side that give a one-click access torelated information belonging to the current record on the card.

    Fields and ControlsForms must not show fields and controls that are irrelevant based on the licensedgranules.All controls that refer to unused or unlicensed fields (e.g. Fixed Assets, ServiceManagement) must be removed from the forms and/or menus.

    Minimal no. of menu buttonsThe number of menu buttons that appears on forms has been minimized. In order to haveone-click access to related information the information pane and the relevant tab controlshave been used.

    Advised/required Screen ResolutionThe base application has been designed to run in a 1152 x 864 or higher screenresolution. This is due to the fact that most card forms have been enlarged in order toshow as much information as possible in one single view.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    10/26

    10

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    List Forms

    All list forms have a common layout.

    The following main Form elements can be distinguished:

    Filter AreaContent Area

    Summary Area

    List Form Properties

    Property Overall Form Filter Area Content Area Summary Area

    XPOS n/a 220 220 220

    YPOS n/a 220 2640 8360

    Width 20240 19800 19800 19800

    Height 11000 2200 5500 1650HorGlue n/a Both Both Both

    VertGlue n/a Top Both Bottom

    BorderColor n/a 500

    BorderStyle n/a Raised Sunken Raised

    FontBold n/a Yes n/a Yes

    3

    2

    1

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    11/26

    11

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Card Forms

    Card Forms for main entities within a functional area have a specific layout. An exampleis shown for the customer card:

    The following form elements can be distinguished:

    Overview Header Area

    Detailed Header Area

    Information Area

    Related Data Area

    Summary Area (optional)

    5

    4

    32

    1

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    12/26

    12

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Card Form Properties

    Property Overall

    Form

    Overview

    Header

    Detailed

    Header

    Information

    Area

    Related

    Data

    Summary

    XPOS n/a 220 220 19140 220 220

    YPOS n/a 220 2640 2640 9350 16060

    Width 23540 23100 18700 4180 23100 23100

    Height 18700 2200 6490 6490 6490 1650

    HorGlue n/a Both Both Right Both Both

    VertGlue n/a Top Top Top Both Bottom

    BorderColor n/a 500 n/a n/a n/a n/a

    BorderStyle n/a Raised n/a Raised n/a Raised

    FontBold n/a Yes n/a Yes n/a Yes

    Note:Please note that some form areas are optional (for example, the Resource Card does notcontain a summary area). This may cause some small differences in properties.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    13/26

    13

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Common CentersNo Series Center

    All Number Series are grouped in one central form called No. Series Center.

    In case a localization or ISV-product contains additional No. Series, take the followingsteps:

    1. Add a new tab to the tab control.

    2. Add a SubForm with the following properties:

    Property Value

    Name MySubform

    XPOS 3850

    YPOS 990

    Width 13750

    Height 8250

    HorzGlue Both

    VertGlue Both

    Visible No

    Border No

    SubformID No. Series Center Subform

    For each subarea taken the following steps:

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    14/26

    14

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    3. Add a PictureBox with the following properties:

    Property ValueXPOS 440

    YPOS Consecutive

    Width 440

    Height 550

    Border No

    Focusable No

    Bitmaplist 35,39

    SourceExpr (CurrFunctArea = DATABASE::"MyTable") AND

    (CurrSubArea="Sub Area"::"MySubArea")

    4. Add a CommandButton with the following properties:

    Property Value

    XPOS 880

    YPOS Consecutive

    Width 2750

    Height 550

    FocusOnClick Yes

    HorzAlign Left

    BackTransparent Yes

    Border No

    5. Select the command button and add the following C/AL code to the OnActivatetrigger:

    CurrFunctArea := DATABASE::"MyTable";

    CurrSubArea := "Sub Area"::"MySubArea";

    IF GET(CurrFunctArea, CurrSubArea) THEN;

    CurrForm.MySubform.FORM.SetAreas(CurrFunctArea,

    CurrSubArea);

    CurrForm.MySubform.FORM.SetRecordFilter(TRUE);

    CurrForm.UPDATE(FALSE);

    6. Add the following line of C/AL Code to the function Initialize (located on theTable Object No. Series Center):

    MakeNoSeriesCenterRec(DATABASE::"MyTable", "Sub

    Area"::"MySubArea");

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    15/26

    15

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    7. Add a Textbox control with the following properties:

    Property ValueXPOS 17820

    YPOS 990

    Height 8250

    Width 3520

    HorGlue Right

    VertGlue Both

    Editable No

    Focusable No

    VertAlign Top

    BackTransparent Yes

    Border NoMultiLine Yes

    SourceExpr GetText(Text Type::Description)

    8. Running the form, you can use the No. Series Center->Translate button to adda description for each licensed language.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    16/26

    16

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Common Data Center

    Maintenance of Common Data is done from one form covering all data. The data isgrouped by functional area (each area on a separate tab).

    In case a new subareas need to be added, take the following steps:

    1. Add a new tab to the tab control.

    For each subarea:

    2. Add a PictureBox with the following properties:

    Property Value

    XPOS 440

    YPOS Consecutive

    Width 440

    Height 550

    Border No

    Focusable No

    Bitmaplist 35,39SourceExpr CurrTableID=DATABASE::MyTable

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    17/26

    17

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    3. Add a CommandButton with the following properties:

    Property Value

    XPOS 880

    YPOS Consecutive

    Width 2750

    Height 550

    FocusOnClick Yes

    HorzAlign Left

    BackTransparent Yes

    Border No

    4. Select the command button and add the following C/AL code to the OnActivatetrigger:

    CurrTableID := DATABASE::MyTable;

    IF GET(CurrTableID) THEN;

    ShowSubforms;

    5. Add a SubForm with the following properties:

    Property Value

    Name MyTableSubform

    XPOS 3850

    YPOS 990

    Width 13750

    Height 8250

    HorzGlue Both

    VertGlue Both

    Visible No

    Border No

    SubformID MySubformID

    6. Add the following line of C/AL Code to the function ShowSubforms:

    Currform.MySubform.VISIBLE(CurrTableID=DATABASE::MyTable);

    7. Delete the contents of the table Functional Area Table. (This requirement willbe deleted in a future release and is now still necessary to get the new elements

    added to the form. When opening the form with an empty table an initialization isactivated automatically).

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    18/26

    18

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    8. Add a Textbox control with the following properties:

    Property Value

    XPOS 17820

    YPOS 990

    Height 8250

    Width 3520

    HorGlue Right

    VertGlue Both

    Editable No

    Focusable No

    VertAlign Top

    BackTransparent Yes

    Border No

    MultiLine Yes

    SourceExpr GetText(Text Type::Description)

    9. Running the form, you can use the Common Data->Translate button to add adescription for each licensed language.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    19/26

    19

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Dimension Center

    Microsoft Dynamics Entrepreneur supports Basic Dimensions which can be maintainedby means of the Dimension Center.

    Because the number of Dimensions within Basic Dimensions is limited to two there is nodescription how to add additional dimensions.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    20/26

    20

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    Posting Group Center

    In case a new posting groups need to be added, take the following steps:

    1. Add a new tab to the tab control.

    For each subarea:

    2. Add a PictureBox with the following properties:

    Property Value

    XPOS 440

    YPOS Consecutive

    Width 440

    Height 550

    Border No

    Focusable No

    Bitmaplist 35,39

    SourceExpr CurrTableID=DATABASE::MyTable

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    21/26

    21

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    3. Add a CommandButton with the following properties:

    Property Value

    XPOS 880

    YPOS Consecutive

    Width 2750

    Height 550

    FocusOnClick Yes

    HorzAlign Left

    BackTransparent Yes

    Border No

    4. Select the command button and add the following C/AL code to the OnActivate

    trigger:CurrTableID := DATABASE::MyTable;

    IF GET(CurrTableID) THEN;

    ShowSubforms;

    5. Add a SubForm with the following properties:

    Property Value

    Name MyTableSubform

    XPOS 3850

    YPOS 990

    Width 13750

    Height 8250

    HorzGlue Both

    VertGlue Both

    Visible No

    Border No

    SubformID MySubformID

    6. Add the following line of C/AL Code to the function ShowSubforms:

    Currform.MySubform.VISIBLE(CurrTableID=DATABASE::MyTable);

    7. Delete the contents of the table Functional Area Table. (This requirement willbe deleted in a future release and is now still necessary to get the new elementsadded to the form. When opening the form with an empty table an initialization isactivated automatically).

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    22/26

    22

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    8. Add a Textbox control with the following properties:

    Property Value

    XPOS 17820

    YPOS 990

    Height 8250

    Width 3520

    HorGlue Right

    VertGlue Both

    Editable No

    Focusable No

    VertAlign Top

    BackTransparent Yes

    Border No

    MultiLine Yes

    SourceExpr GetText(Text Type::Description)

    9. Running the form, you can use the Posting Group->Translate button to add adescription for each licensed language.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    23/26

    23

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    ReportingReport Center

    All reports within Microsoft Dynamics Entrepreneur are grouped in the Report Center.Like all other centers functional areas are used to group reports.

    End-user layout

    End User can access all reports from the Report Center form. The right-hand part of theform displays the most essential layout elements of the marked report.

    Adding new reports

    In case new reports need to be added, taken the following steps in the report center:

    1. Open the Report Center with a development license and a number of additionalbuttons will be visible on the form:

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    24/26

    24

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    2. Use the Move Up / Move Down buttons to change the sequence of reportswithin a functional area.

    3. Select ReportNew to add a report to a functional area. A form will come upfrom which you can insert an existing report.

    4. Select ReportCopy in the Report Center form to copy a report from one

    functional area to another functional area.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    25/26

    25

    MICROSOFT DYNAMICS NAV ISV SOLUTION SOFTWARE TEST GUIDELINES

    5. Select ReportDelete in the Report Center window to delete a report from afunctional area (the report itself will not be removed).

    6. Select ReportTranslate in the Report Center window to add an explanationto the report that will be shown on the right hand side of the form.

    Note:Reports can also be run from list- and card forms of the main entities. In that situationonly reports are shown that are directly related to that specific entity. Filter criteria for thisis the table ID of that entity. This ID can be filled in for each separate report within thereport Center as shown below.

  • 8/6/2019 Microsoft Dynamics Entrepreneur Developer Guidelines

    26/26

    26

    Company Set-upSet up of Microsoft Dynamics Entrepreneur is centralized under the Company InformationCard.

    Every module/functional area has a separate tab on which the relevant parameters canbe maintained.

    Notes:

    Only fields related to functionality that is part of Microsoft Dynamics Entrepreneurmust be made available on the respective tabs.

    In case of adding a new functional area that requires set up, a new tab should beadded for this as well.

    Although users can maintain the set up themselves the goal is to have the valuesfilled in automatically during initializing the company (using the ImplementationWizard).