Title 1 - EC SOLUTIONS

Title 1 Title 2

450.681.0123 450.681.6055 3200 Autoroute 440 Ouest, Laval, Québec, H7T 2H6

Contents

Introduction .................................................................................................................................................. 3

Lexique .......................................................................................................................................................... 3

Projet ......................................................................................................................................................... 3

Solution ..................................................................................................................................................... 3

DEV Tracker ............................................................................................................................................... 3

UD Field Tracker ........................................................................................................................................ 3

Promote Tracker ....................................................................................................................................... 3

Gestion des versions et des commentaires .................................................................................................. 4

Customisation ........................................................................................................................................... 4

BPM/DataDirective ................................................................................................................................... 6

BAQ ........................................................................................................................................................... 8

DashBoard ................................................................................................................................................. 9

Rapport ................................................................................................................................................... 10

Crystal ................................................................................................................................................. 10

SSRS : ................................................................................................................................................... 10

Dev & UD Field Tracker ............................................................................................................................... 12

UD Fields. ................................................................................................................................................ 12

Dev Tracker. ............................................................................................................................................ 13

Tests ........................................................................................................................................................ 14

Promote .................................................................................................................................................. 15

Préparation de l’installation ....................................................................................................................... 16

Étapes de développement .......................................................................................................................... 18

0. Requis .................................................................................................................................................. 18

1. Démarrage ........................................................................................................................................... 18

2. Préparation.......................................................................................................................................... 18

3. Développement ................................................................................................................................... 19

4. Documentation ................................................................................................................................... 19


5. Test interne ......................................................................................................................................... 19

6. Préparation.......................................................................................................................................... 19

6. Installation en Test/Training ............................................................................................................... 19

7. Installation en Production ................................................................................................................... 20

8. Clôture du projet. ................................................................................................................................ 20

Clients en cours d’Implantation .................................................................................................................. 21

Clients ‘LIVE’ sur le logiciel. ........................................................................................................................ 22


Introduction This guide documents the best practices pertaining to customization development in Epicor. Those practices are used by ECS development team, and it is recommended that they are also to be applied by the customer’s internal development resources for customizations in Epicor.

Procedures included in this guide were defined in order to standardize and facilitate the customization development process.

Lexicon Project Functional and technical documentation written to understand the requirements and perform the customization development as requested by the customer. The project work breakdown is structured to define each deliverable included in the solution to be deployed on the customer server & Epicor environment.

Solution Bundles the deliverables, including customizations, BPMs, BAQs and Dashboards as well as the corresponding customization. (BPM/Customisation/BAQ/Dashboard…) ainsi que la documentation (Test scenarios/User Guides /Technical doc).

DEV Tracker Development tracker. Includes a complete list of customizations, their location in various environments. Each customer has his own customization dev tracker list managed in SmartSheet.

UD Field Tracker UD Fields tracker is a complete list of every UD fields added and used under Epicor E10 & E9.05 versions. As with the Dev tracker list, the UD Fields tracker list is also maintained in SmartSheet.

Promote Tracker Tracking list of test scenarios, installation and documentation for each customer. Most customers the tracking list is maintained in SmartSheet.


Version and management and corresponding comments. EVERY object developed must have a version associated to it as well as a description of who, when and what has changed or been added.

The object’s version numbering must be in the following format « 0.0.0 » and must be maintained as follows: 1. X.0.0 : Version Number, major change, New project adding new functionality or feature. 2. 0.X.0 : Version Number, changes to existing custom functionalities already existing in the customization. 3. 0.0.X : Revision, Fixing of an existing bug in the current customization. In order to preserve the change history of the code, an existing version which has been deployed in the Epicor menu, should never be deleted or modified. Instead, a Copy/Save As should be performed, prior to working on the customization.

Depending on the type of the object, the version number should be applied accordingly.

Customization Version

The customization name must include 3 fundamental sections separated by « _ ». An optional section casn also be used to identify a specific functionality related to this customization. The abbreviated ID of the customer, which is the short name used for the customer. For

example « ECS » for E C Solutions. This will facilitate the identifying the customer and related projects under a same test environment.

Form Name: is the name of the form which has been modified. For example; « POEntry » for the PO entry form for « UD100 » for the UD100 Data entry form.

Optional - Name of Project/Function. In the case of UD forms, it can be i useful to add a description indicating the objectives of the form, for example; ECS_UD100_INFORMATIONXYZ_0.0.0

Version - The version number using format « 0.0.0 ». (Read following section.) The version number must be displayed in the form’s header caption section. In order to

achieve this, the version number must be displayed using code included in the « FormLoad ». This is included in the customization development Template.


Comments A Comment explaining the development must be added in the customization script header

section. The comment must include the developer name/initials, date, project Id or support case # as well as a description of the change being applied.


BPM/DataDirective

The comments must be included in the item « Execute custom code » as follows :

This item not being connected to the Flow.

The item’s title must correspond to the version associated to the code modification.


Optionally, It is possible to make a copy of the original item and add the version number in order to preserve a logical sequence.

In the precedent item, there is version 1.0.0 with a condition and item code which have been previously created. Then in version 1.1.0, new version of code has been added.


BAQ The BAQ version number must be added at the beginning of the BAQ description. Specifically for BAQs, the sections must be separated by « » (space) instead «. » in order to avoid created problems with dashboard using a BAQ.

The BAQ description must be used to comment change. The project # for which the BAQ has been designed must also be included in the description.


DashBoard As with a BAQ, the version number must be appended to the caption description. This will facilitate the identification of a custom dashboard version #.

The BAQ description must contain the comment.

Note: « Clear Client Cache » must be performed by the user logged to Epicor in order for the changes applied to dashboards to take effect.


Reports Crystal :

For Crystal report Template, an « invisible » note will be added with a formula « VersionComment ».

The formula will return the version number. Then comments will be added after.

SSRS : For SSRS reports Template, creat a global variable in the report :

Right click in the screen behind the report and select « Report Properties »

1. Creat a variable as follows: 1. Sélect « Variable » 2. Click « Add » 3. The variable name must be « Version »


4. Return the string value « X.X.X » (version number) and enter comments including the assigned version number.

2.


Dev & UD Field Tracker In order to ensure an effective tracking of customizations, the location of their development and installation as well as the most recent Or the W.I.P version, the information will be maintained in SmartSheet. This tool will allow sharing the information amongst EC Solutions resources and the customer own rerources.

For each customer, a folder will be created in SmartSheet.

Deux chiffriers distincts seront créés UD Fields et Dev Tracker.

UD Fields. The goal of the documentation is to track UD Fields that are created in various Epicor environments including the customer own servers and those of EC Solutions.

UD Fields must be created in SmartSheet prior to creating them in an Epicor environment, in order to minimize chances of having duplicate UD field names. .

The list of the environment at the end of the list must be updated during the installation of the solutions or when replacing an environment by another.


Dev Tracker.

This document allows tracking of different type of developments.

- Customizations - BPM or Data Directive - BAQ - DashBoard - External Program (Progress, C# or other) - Report & RDD.

Similar to the UD fields, the environments are listed in order to ensure effective customizations tracking.

This information must be created or maintained as soon as a new version of a development is created or installed in an environment.

When overwriting an environment by another, the columns referring to the environment must be overwritten as well.


Installation Preparation The following steps are mandatory prior to installing of any customization/development on the customer environment. .

In case where changes have been done on a customer environment, those steps are also mandatory in order to recuperate the developments to EC Solutions servers/environments.

The following steps are required, in order to effectively control the development and installation cycles at customer sites.

Testing Testing scenarios must be performed following a standardized control list.

The template located in the folder « Y:\_Demandes ECS\Liste Contrôle Custo.docx»

This will list the standard testing list, it will also include 2 lists that may need to be personalized for the current project.

1. The solutions embeds the customer’s request requirements.

It’s about functional testing of the development. Those have been elaborated by the customer and/or the consultant working with that customer, in order to ensure the requirements are met.

2. Internal testing of deliverables.

The technical test scenarios have been defined in order to validate certain aspect of the development, which may cause some issues or challenges. It is therefore important to include and document test scenarios covering those occurrences.

The test scenarios executed, must be supported by documentation proving the adequacy of the customization behavior to meet the requirements, screen shits can be annexed to the document..


Promote The installation on a customer environment must be effectively documented in order to allow replicating of the installation by relying on the documentation. In order to achieve this, the standard « Promote » document will include each step required in order to perform and complete the installation of the solution. The promote may include validation steps in order to ensure that all deliverables ahave been installed.

At installation time.

1. Must ensure that UD field Tracker and Dev Tracker and the Promote Tracker are all up to date.

2. Validate developments using the testing « CheckList » used for the development during the testing phase.


Preparation of the installation Documentation of installation or migration of a solution from an Epicor environment to another.

The installation process on a customer environment must be well documented, allowing to be able to reproduce the same installation without missing any content or steps. To achieve this, a standard « Promote » document must be previously completed, and it must contain every step executed during the install process. It must also include validation points to ensure that all deliverable included in the solution have been properly installed.

Le document vide se situe sous « Y:\_Demandes ECS\Promote.docx », celui-ci devrait être complété comme suit :

1. Create a folder under the project’s own folder.

2. Copy the promote document to the folder and complete the document by including the installation details related to the solution.

The document must be broken down based on installation steps.

3. The files required during the installation process must be copied to the « Promote » folder of the project, with the document.

4. In case that changes should be made to the project another « Promote » folder must then be created and must include the up to date version of each development.

5. prior to beginning the installation.


a. Ensure that the UD field Tracker & the Dev Tracker are up to date

b. Validate the development using the test « CheckList » including the test scenarios used during the development phase.


Development steps 0. Requirements When a project is assigned to a development resource, the following information must be provided.

1. Project # de Projet and name.

The project folder must be previously created and will contain the documentation regarding functional and technical analysis and scope.

\\ecs-filesrv.ecsdomain.com\projet client\[Nom du client]\[# de projet]\

To facilitate references amongst users, the access is « mapped » on drive « Y : ». (\\ecs-filesrv.ecsdomain.com\projet client\)

2. Time sheet entry : The project must be previosuly created in the BigTime Time sheet system and hours must be logged under this project. In certain cases a global project for minor customization may be used. Delivery/Due date A delivery/due date will be determined and communicated to the customer.

1. Launch When development is ready to begin, the functional and technical analysis and scope

documentiona must be previously read and understood. In case of doubt or lack of clarification on certain item, the project should not be started by making assumptions. The developer should then request to meet with the developer director or the consultant who wrote the functional requirements.

A « kickoff » meeting must always take place prior to beginning the project. This meeting will allow the developer to ask question and better understand the project scope, and in some cases ask for assistance when required.

2. Preparation In order to ensure an effective project tracking and follow up :

1. Where will the development be performed : The customer development environment on EC Solutions servers – is it accessible, up to date and functioning?

2. Existing Development. Verify the information contained in the Dev Tracker list in SmartSheet.

Which versions are on the customer’s live environment? Are there any object being developed or pending installation?


Are the latest versions installed in the development environment?

3. Reserving objects

New version of developed objects will be added to the Dev Tracker list and the UD Fields tracker (see SmartSheet tracking details above).

3. Development During development, should there be a need for a new version to be created or an ad hoc object to be added, then those must be added to the SmartSheet list immediately.

4. Documentation Documentation must be prepared and must include a user guide documentation to the customer, including the test scenario for the customer to execute on their own test environment. All documentation must be saved under the project’s folder.

5. Internal Testing The test scenarios must validate that the customization included in the solutions are functioning and meet the objectives of the project as requested by the customer.

Inform the resource responsible of the functional testing, when the solution is fully installed and ready to be tested. Documentation must also be provided.

The testing scenarios must be performed as per what has been previously documented in the technical analysis documentation.

Prepare a test report including the test results.

6. Preparation 1. Prepare the « Promote » document explaining the installation details of the solution on the customer’s environment.

2. During the meeting with the customer resource, present the test scenariods as well as the promote document of what is to be installed on their Test environment.

6. Installation in Test/Training Installation of the development on the environment to be used for testing on the customer server.

1. Install the solution on the customer environment.

2. Contact the Customer.


Inform the customer that the installation has been completed on their server/ Test environement. The customer must also be informed of which environment, company and under which menu items are affected by the installation. Price screens of Menus and forms are recommended in order to visualize what has been installed.

Offer to the customer a presentation to review the development and the related functionalities.

7. Installation in Production/Live When the customer approves the development which has been previously installed in the Test environment, the installation must be performed in the Live environment, using the same promote document to execute the installation.

8. Project closure.


Customer in implementation.

For customer in implementation process, the installation of customization can carry additional challenges.

Reasons :

1. Master files and transactional testing are constantly evolving. 2. New data can be imported. 3. The Pilot & Live environment may not be ready and may be missing pertinent data to

perform adequate testing.

Installing and managing customization will therefore be different.

Following completion of the customization on EC Solutions internal development environment, as well as having completed the testing scenarios, the following steps must be performed:

In order to validate the installation and ensure conformity with the customer’s data, the following steps must be performed:

1. A copy of the Pilot or Live customer environment must be installed on EC Solutions development server. This will allow, when required, to test by creating system transactions and validate that customizations are working well during or following those transactions.

a. The testing must be collected and deemed as completed in the checklist report, as used during the internal testing phase of the development on ECS development servers.

b. In case of anomalies, correction or fixes will be applied on the ‘development’ environment on EC Solutions servers.

2. Customization will then be installed on the customer’s Pilot environment followed by a validation of the installation.

a. The customer must then execute the test scenarios as documented in the test report checklist, and when conclusive, approve the customization & installation. The installation will then be planned and installed on the customer live environment.

b. In case of anomalies, correction or fixes will be applied on the ‘Development’ environment at EC Solutions, then the installation steps will be performed again on the customer’s environment.

3. Following customer approval, customization will then be installed on the Live environment, followed by a final validation of the installation.

4. For every installation of a promote, an entry must be logged in SmarSheet, and the documentation relate dot the installation as well as Test scenarios checklists, must be attached to this entry.


Clients ‘LIVE’ on Epicor.

As indicated in the analysis documentation, when required, a copy of the customer Live environment must be installed on the EC Solutions development servers/environment.

Following completion of the customization on EC Solutions internal development environment, as well as having completed the testing scenarios, the following steps must be performed:

In order to validate the installation and ensure conformity with the customer’s data, the following steps must be performed:

1. Customization will then be installed on the customer’s Pilot environment followed by a validation of the installation.

a. The customer must then execute the test scenarios as documented in the test report checklist, and when conclusive, approve the customization & installation. The installation will then be planned and installed on the customer live environment.

b. In case of anomalies, correction or fixes will be applied on the ‘Development’ environment at EC Solutions, then the installation steps will be performed again on the customer’s environment.

2. Following customer approval, customization will then be installed on the Live environment, followed by a final validation of the installation.

3. For every installation of a promote, an entry must be logged in SmarSheet, and the documentation relate dot the installation as well as Test scenarios checklists, must be attached to this entry.

Title 1 - EC SOLUTIONS

Documents

Transcript of Title 1 - EC SOLUTIONS