Deltek Maconomy SaaS SDLC

Transcription

1 Deltek Maconomy SaaS SDLC March 16, 2018

2 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. 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 March 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. Maconomy SaaS SDLC ii

3 Contents Overview... 1 Document Control... 1 Additional Documentation for SaaS Developers... 2 Maconomy SaaS Solutions... 3 Environments and Databases... 4 Deltek Maconomy Enterprise and Flex Environments... 4 Available Development Tools... 5 Gaining Access elopment Environments... 7 Access Environments... 7 Install Citrix Plug-in... 7 Maconomy SaaS SDLC... 8 Overview... 8 Customization Capabilities... 8 Integrations... 9 SDLC Artifacts SDLC for Enterprise and Flex Development Projects SDLC Security Assessment Service Requests Overview Appendix SDLC for Essentials Development Projects Maconomy SaaS SDLC

4 Overview The Software Development Life Cycle is a Deltek process for deployment of Customer-specific Features in the Cloud infrastructure. This process covers the development of extensions, custom reports, custom universes, and integrations. The customer-specific features developed within the SDLC process are the customer s responsibility. Custom code must be written in a secure manner, in order to not introduce a security vulnerability into the Cloud environment. Deltek has the right to mitigate this risk by providing periodic code scanning of custom extensions after they are deployed. If vulnerabilities are identified by Deltek, they will be reported back to the customer who is responsible for making the appropriate code corrections. The Maconomy SaaS SDLC is intended to provide developers with an understanding of the Maconomy SaaS Software Development Life Cycle (SDLC). Understanding the SDLC will enable developers to successfully create and modify customizations to Maconomy that can be deployed to Maconomy SaaS customers. Developers should read this guide before they begin a development project. All changes to Maconomy SaaS should follow the process outlined in this document. The following information is included: SDLC process description Information on required artifacts Information on environments Information on development tools List of allowed customizations Security Review information You should ensure that you have the latest version of the document when you start a new development effort. You can find the latest version on the Customer Care Connect Portal. Document Control This document is regularly maintained and updates can be expected as the Deltek Maconomy SaaS offering evolves. Minor and major Maconomy releases also prompt updates to this document. Feedback and input from clients is welcome and should be communicated through to the Deltek project manager or account manager for consideration. Version History Version Status Date Change 1.0 Draft May 17, 2017 First draft of the document 1.1 Published Aug. 4, 2017 First published version of the Maconomy Cloud SDLC 1.2 Editing Sept. 6, 2017 Security review information and process updated 1.3 Editing Mar. 16, 2018 Minor edits

5 Additional Documentation for SaaS Developers Document Enterprise Cloud 2.x SaaS Administrator Guide Deltek First Maconomy Essentials 2.x SaaS Administrator Guide

6 Maconomy SaaS Solutions The Deltek Maconomy SaaS offering includes three solutions. Below you can find information on these solutions, what customizations capabilities are offered in each solution, and what environments are available. Solution Customization capabilities Environments* Deltek Maconomy Enterprise Deltek Maconomy Flex Deltek Maconomy Essentials Custom Reports Custom Universes Custom ETL (Populate data warehouse) Customer Specific Integrations Basic Layout Changes Advanced Extensions Analyzer Special Customer Specific Language Custom Database Extensions Customer Specific Translation Files Custom Reports Custom Universes Customer Specific Integrations Basic Layout Changes Customer Specific Translation Files Custom Reports Customer Specific Integrations Customer Specific Translation Files Production Environment Test Environment Always On Development Environment Upgrade Preview Environment Production Environment Test Environment Always On Development Environment Upgrade Preview Environment Production Environment Test Environment Customization capabilities not listed here are not supported in the Deltek Maconomy SaaS offering. This document focuses on the Deltek Maconomy Enterprise solution as that is where most customizations are allowed. The information provided in this document is also applicable for Deltek Maconomy Flex and Essentials for the customizations that are allowed in those solutions. More details on the different environments are found in next section. Please refer to the Enterprise Cloud 2.x SaaS Administrator Guide or Deltek First Maconomy Essentials 2.x SaaS Administrator Guide and your contract for additional details.

7 Environments and Databases Deltek Maconomy Enterprise and Flex Environments All Deltek Maconomy Enterprise and Deltek Maconomy Flex customers are provided with the following environments. Deltek Maconomy Essentials customers have Test and Production Environments. Customer Development Customer Test Customer Production Development Environment is available for you to develop and test extensions, integrate to web services and perform other technical testing activities. Extensions are deployed from Development to Test; for End User verification Scheduled deployment to Production Environment of web services and extensibility packages by Cloud Ops upon request. Application database integration is available on a case by case basis but not guaranteed. Development changes are promoted to Test by Deltek for End User testing During Implementation used for: UAT Training Testing Setup Activating new features, extensions /integrations Post Implementation used for: End User training Activating new features Replicating prodcution errors Can be refreshed with Production data upon request Basic, intermediate and advanced extensions from Test are promoted to Production for Go Live by Deltek This is the environment where your live database resides. All updates of Maconomy are available to preview upon scheduled service request prior to upgrade on Prod. Deltek reserves the right to require you to upgrade to the latest maintenance release. Deltek supports the latest 2 minor versions of Maconomy (e.g 2.2 & 2.3), but reserves the right to force an upgrade at any point. Environment upgraded inline with Preview Env. Preview Customer Specific Pre-Prod Environment used to preview new versions and maintenance releases Preview environment only provided for releases with significant enhancements, this is decided by Deltek. New version features and functionality will not be enabled by default. All production applications are replicated and upgraded to latest released versions (BPM, Touch, etc.) All standard application integrations included. Extensions will not be supported until Customers work with Services in order to migrate them

8 More information on environments can be found in the Enterprise Cloud 2.x SaaS Administrator Guide or Deltek First Maconomy Essentials 2.x SaaS Administrator Guide. Available Development Tools The table below lists the development tools available in the Deltek Maconomy Enterprise Development. These development tools are not available in the Production, Test, or Preview Environments. Development Tool Target audience Purpose Access Comments Maconomy Extender** Extension/ Business Consultant Used for Workspace Client (WSC), iaccess, and Touch layout modifications. BPM reports linking from within WSC and iaccess customization. All Java Extensions. Maconomy Extender installed locally and connects through SSL. This can also be the client Super User or client developer educated as an Extension developer. SAP BO Information Design Tool* BPM consultants Use for customizing existing universes or creating new. Located on a development server accessible through Citrix. Clients can have their own SAP Business Objects (BO) developers. SAP BO Web Intelligence BPM consultants Use for creating and modifying Web Intelligence documents (Reports). These can be shared in the BO server and viewed from the BO Launch Pad. Access through Web Intelligence web interface. Clients can have their own BO developers or elect for having Super Users do development in WebI. SAP BO Lumira* BPM consultants Tool for creating Lumira storyboards. These can be shared in the BO server and viewed from the BO Launch Pad. Located on a development server accessible through Citrix. Clients can have their own BO developers. Pentaho Data Integration* Sys. Admin/Impl ementer Use for editing the ETL process that controls load of data to the customers data warehouse. Located on a development server accessible through Citrix.

9 Development Tool Target audience Purpose Access Comments MS SQL Management Studio Extension/ Technical consultant To view database schema and content. To execute scripts for modifying the database schema Located on a development server accessible through Citrix. All schema changes have to be done with scripts so that these can be executed also in Test and Production. PP Admin Tool* Business/ Technical consultant Used to install PP and modify PP settings. Located on a development server accessible through Citrix. * Development tool available via Citrix. ** Only the Sys Admin and Implementer are able to access the Development server and restart the coupling service.

10 Gaining Access elopment Environments The SaaS Customer Administrator can request access to the Development Environment. A description of the steps necessary for this are found in the Enterprise Cloud 2.x SaaS Administrator Guide or the Deltek First Maconomy Essentials 2.x SaaS Administrator Guide. Developers only receive access to the Customer s Development environment. Cloud Ops promotes changes to test and production. Developers are not granted access to those environments. Access is granted to those development tools that the SaaS Administrator has requested. As Citrix is needed for some of the development tools, information on how to install a Citrix Plugin is described below. Access Environments The information needed to access the Development Environments can be requested from the SaaS Customer Administrator. Each developer receives their initial password for login to the requested Development tools. The initial password must be changed upon first login. Developer passwords are maintained through the Citrix login screen. Citrix passwords expire every 90 days. The process for granting development access is documented in the Enterprise Cloud 2.x SaaS Administrator Guide and the Deltek First Maconomy Essentials 2.x SaaS Administrator Guide. Install Citrix Plug-in Citrix is required to access a number of development tools in the development environment. To install the Citrix Receiver plug-in, complete the following steps: 1. Go to 2. Enter your DCOFLEXPLUS user account (just the username) and password (provided by Deltek in two separate s). 3. If prompted, click Detect Receiver. If the receiver isn't detected, review the license agreement. If you agree, mark the checkbox to accept the license agreement and click Download. te: 'CitrixReceiverWeb.exe' should be downloaded to your PC. Run it once downloaded. If you agree, accept the license agreement and install. 4. Once installed, click on the Continue on the original web page and Launch Application if prompted. The Citrix StoreFront should be presented. 5. Click APPS at the top of the page. The applications available to you should be shown. Click on an application to launch it.

11 High Level Process Maconomy SaaS SDLC Overview This SDLC describes the process for development, test, and deployment for all types of customizations that are possible in Deltek Maconomy Enterprise. The overall process is illustrated in the process diagram below. The detailed SDLC process is found in the SDLC for Enterprise and Flex Development Projects section. Maconomy Customer Development Release Process Development Environment Test Environment Production Environment Start (Customer Requests Change) Analysis and Design of Feature/ Extension Development of Feature/Extension and Feature Testing Deployment of Feature/Extension to Test UAT Testing Deployment of Feature/Extension to Production Customization Capabilities The following can be customized in Deltek Maconomy Enterprise. Items not covered here are not available for customization. Java Extensions via Maconomy Extender Screen Layouts WSC, iaccess and Touch via Maconomy Extender tifications via Maconomy Extender Integrations via Maconomy Extender, see details in next section MPL/Print layouts via Maconomy Extender

12 Universes Reports via SAP BO Web Intelligence and SAP BO Web Intelligence Rich Client Cascading Style Sheet for Reports via SAP BO Web Intelligence and SAP BO Web Intelligence Rich Client Branding for Reports via SAP BO Web Intelligence and SAP BO Web Intelligence Rich Client Translation for Report and Universes via SAP BO Translation Management Tool Dashboards via SAP BO Design Studio and Web Intelligence Storyboards via SAP BO Lumira Scheduling of BPM content via SAP BO Enterprise Integration to SAP BO - via SAP BO Query As a Web Service Designer ETL via Pentaho Data Integration Data Warehouse database objects via SQL Management Studio Configuration Parameters, Popups, Core setup via the Maconomy Workspace Client Bank Formats via Maconomy Workspace Client Schedule Tasks via Maconomy Workspace Client Translation Files via Maconomy server as dictionary files are place on the server Audit Logs via the Maconomy server and two configuration files are utilized to setup audit logs Integrations The Enterprise Cloud 2.x SaaS Administrator Guide contains information on what Integrations are supported as part of the Deltek Maconomy Enterprise offering. The preferred integration method for all Deltek Cloud Solutions is through the application API. In cases where the API cannot handle the volume or scenario, each solution has standard filebased integrations or the capability for customers or Deltek Global Consulting to build a file-based integration. In those scenarios, the following protocols are supported for transport of files to a place that the application can operate: Primary Method: The customer provides Deltek with access to an Amazon Web Services S3 location where the customer places files for Deltek to pull into the Deltek AWS infrastructure. Secondary Method: The customer provides Deltek with access to a customer maintained secure FTP (S-FTP) site where Deltek pulls files from the customer into the Deltek AWS infrastructure. In order to maintain the highest level of security, Deltek does not support customers pushing files into the Deltek AWS infrastructure. In order to ensure customers are protected, data is pulled into a secured location where it can be scanned and assessed from a security perspective before importing into the customer s environments. Deltek currently does not support a direct connection for pulling or pushing files to a 3 rd party vendor that Deltek does not have a direct contract with. The supported method in this scenario is to have the customer interface with third parties and then provide a secure location, as mentioned above. The following integration capabilities are available with the Enterprise Cloud standard offering: RESTful API *recommended approach

13 SOAP Standard Maconomy Import Programs Other integration capabilities may be available, based on Deltek review and approval of detailed technical requirements. Examples include: File-based integrations Secure FTP, Deltek push/pull; direct from the customer S3 Bucket (customer-owned); Deltek push/pull Examples of integration types NOT supported: ODBC read, write or update Direct SQL bulk data loads Secure FTP from 3 rd party; Deltek push/pull SDLC Artifacts The following information and documents are mandatory for the Maconomy SaaS SDLC process. As customizations available for Deltek Maconomy Essentials are limited, not all artifacts are relevant for that solution. These are marked with * in the list below. Artifact Responsible Comments Project Eval. Doc. Project Manager Document attached to Service Request. Design Doc. Development/Unit test evidence Change ID Evidence (Into Dev. branch)* Deployment guide doc. System test evidence* Business Consultant/ Developer Developer Development Coordinator Business Consultant/ Developer Business Consultant Contains description of the requested functionality, detailed design, prerequisites, and test plan. Document attached to Service Request. Describes the Development and/or Unit testing that was conducted and confirms that these were successful. Can be included in Design document or in a separate document. Document attached to Service Request. For development done in GitHub this is the commit ID. For other files this is the file name. Should be noted directly in Service Request. Contains detailed deployment instructions, rollback instructions and confirmation that both these have been tested. Document attached to Service Request. Documentation of what test cases have been executed and the results of these tests. For any failed test cases information should be provided on what failed. ted directly in Service Request. Reference a document attached to Service Request if needed.

14 Artifact Responsible Comments Deployment Check evidence Change ID evidence (From Dev. to Test) Smoke test Doc. Test env. smoke test evidence Customer sign-off on UAT Production env. smoke test evidence Customer sign-off on production env. change Cloud Ops. Cloud Ops. Cloud Ops. Cloud Ops. Business Consultant Cloud Ops. Business Consultant Documentation of that all deployment checks have been conducted. ted directly in Service Request. For development done in GitHub this is the commit ID. For other files this is the file name. Should be confirmed that this is same as provided for deployment elopment environment. ted directly in Service Request. Document that describes what Smoke tests are conducted for this deployment. Document attached to Service Request. Documentation of what test cases have been executed and the results of these tests. For any failed test cases information should be proved on what failed. ted directly in Service Request. Reference a document attached to Service Request if needed. Documentation of customer acceptance of the customization. If this fails then information should be provided on why. Mail from customer attached to Service Request or information noted directly on Service Request with name of the approver. Documentation of what test cases have been executed and the results of these tests. For any failed test cases information should be proved on what failed. ted directly in Service Request. Reference a document attached to Service Request if needed. Documentation of customer acceptance of the change being applied in production. If this fails then information should be provided on why. Mail from customer attached to Service Request or information noted directly on Service Request with name of the approver. * t relevant for Deltek Maconomy Essentials. SDLC for Enterprise and Flex Development Projects The following flowchart outlines the development process for custom development projects for Maconomy SaaS. A scaled-down version of this process for Deltek Maconomy Essentials can be found in the appendix.

15 Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Start (Customer Requests Change) Change Request Approved Change Approved Project Eval Doc Raise Service Request for Developer Access to Dev Environment Service Request Grant Implementer Administrator Permissions Opened Functional Design Provision Accounts and Provide Dev Environment info Cust Dev Env Access; Github Access; Version, Pathc level, Solution Language, etc. Analysis & Design Functional Design Sign-off Configure Workstations for Development Service Request Closed Workstation setup for development incl. data Technical Design Technical Design Sign-off Design Doc Create Feature Branch(es) Feature branche created Cont. to Develop & Unit test

16 Development and dev. test Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. From Create Feature Branch(es) Code ready for End to End test Develop & Unit Test Development/Unit Test evidence Merge Feature branch(es) in branch Change ID (GitHub commit ID) evidence Deploy to Customer Dev Environment from Dev Branch Deployment guide doc System Test System Test Success Code ready for depoyment to Test env. System test evidence Cont. to Migrate from Dev. To Test

17 Test and Deployment Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. from System Test Success Service Request Opened Raise Service Request to Move from Dev to Test Ticket includes: Project Eval. Doc., Design Doc., Unit test evidence, code review evidence, Change ID, Implementation guide doc., End to End test evidence, System test evidence Release plan Test Agree with the customer release manager on a release plan for test environment Code ready for deployment to Test env. Assist with questions or concerns arising from check Deployment Check Verify Change ID, verify all evidence, review implementation gudie doc. Deployment Check evidence All Checks Passed? DCO CR Process DCO CR, Customer communication, DCO Approval Assist with any merge issues Merge Dev branch into Test branch Change ID (GitHub commit ID) evidence up Customer s Test Enviroment DB backup, File System up Deploy from Test Branch to Customer s Test Environment following Implementation Guide Store all deployed files that are not part of Github May need to assist troubleshooting if Smoke Test doesn t immediately succeed or to determine if a roll back is necessary Smoke Test Customer s Test Environment Smoke Test doc. Smoke Test Passed? Test env. Smoke Test evidence Cont. To Verify Deployment is working as expected

18 Test and Deployment Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. From Smoke Test Passed? Verify Deployment is working as expected Implementation Successful? Optional - Rollback Imlementation Customer Test Env. restored to preimplementation state dependent on customers wish Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed Dev works with Customer to perform UAT UAT Passed? Customer signoff on UAT Raise Service Request to Move from Dev to Test Service Request Opened Ticket includes all artifacts such as Design Doc., Change ID from test, Implementation guide doc., System test evidence, customer signoff on UAT Release plan production Agree with the customer release manager on a release plan for production environment Deployment Check Verify Change ID, verify all evidence, All Checks Passed? Cont. To DCO CR Process

19 Test and Deployment Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. From All Checks Passed? DCO CR Process DCO CR, Customer communication, DCO Approval Assist with any merge issues Merge Test branch into Prod branch up Customer s Prod Environment DB backup, File System up Deploy from Prod Branch to Customer s Prod Environment following Implementation Guide May need to assist troubleshooting if Smoke Test doesn t immediately succeed or to determine if a roll back is necessary Smoke Test Customer s Test Environment Smoke Test Passed? Production env. Smoke Test evidence Verify Deployment is working as expected Implementation Successful? Rollback Imlementation Customer Production Env. restored to pre-implementation state Cont. To Post Production Validation Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed

20 Production Release Maconomy Customer Development Release Process Customer Developers Development Coordinator Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. From Implementation Successful? Dev works with Customer to perform Post Production Validation (is it working like the customer expects?) Customer signoff on production change Post Production Signoff? Rollback Imlementation Customer Production Env. restored to pre-implementation state Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed SDLC Security Assessment Overview Custom code must be written in a secure manner, in order to not introduce a security vulnerability into the Cloud environment. Ensuring that customer-specific content is developed in a secure manner is the Customer s responsibility. Deltek has the right to mitigate this risk at Deltek s discretion, by providing periodic code scanning of custom extensions after they have been deployed. If vulnerabilities are identified by Deltek, they will be reported back to the Customer who is responsible for making the appropriate code corrections. Extensions should be written as Java Extensions. Although extensions written in MScript are allowed in the Enterprise Cloud, any MScript extensions will not be subjected to Security scanning and are therefore allowed at the Customer s own risk. The responsibility of ensuring that MScript does not introduce any security vulnerabilities sits with the Customer and is not the responsibility of Deltek.

21 Service Requests Overview Service Requests allow the SaaS Customer Administrator to direct Deltek Cloud Operations to perform various types of processes or actions to their company s cloud environment. Service Requests are required to perform many of the steps in the Maconomy SaaS SDLC. Deltek suggests that the SaaS Customer Administrator and stakeholders in the development and implementation project discuss and agree on who is responsible for creating service requests for the development process. This ensures that service requests are submitted in a timely manner to support development project timelines. The SaaS Customer Administrator should make themselves familiar with the available service requests, the specific instructions for submitting a service request, and the Service Level Objective (SLO) assigned to each service request. This information is available in the Enterprise Cloud 2.x SaaS Administrator Guide.

22 Deployment Implementation Appendix SDLC for Essentials Development Projects Maconomy Customer Development Release Process - Essentials Customer Developers Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Start (Customer Requests Change) Change Request Approved Change Approved Create local development environment Workstation setup for development Change description Change description Change implementation Test of change passed Development/Unit test evidence Create file to be deployed (BIAR, Translation) Deployment Guide Raise Service Request to Copy to Test Service Request Opened Ticket includes: Change description, test evidence, implementation guide, Deployment Check Verify evidence and review implementation gudie doc. Deployment Check evidence All Checks Passed? If needed: DCO CR Process DCO CR, Customer communication, DCO Approval Cont. Deployment

23 Deployment to Sandbox Maconomy Customer Development Release Process - Essentials Customer Developers Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. To Verify Deployment is working as expected up Customer s Sandbox Enviroment DB backup, File System up Deploy to Customer s Sandbox Environment Store all deployed files that are not part of Github Standby for supporting deployment Smoke Test Customer s Sandbox Environment Smoke Test doc. Smoke Test Passed? Test env. Smoke Test evidence Verify Deployment is working as expected Optional - Rollback Imlementation Customer Sandbox Env. restored to pre-implementation state dependent on customers wish Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed UAT Passed? Customer signoff on UAT Cont. To Deployment to Production

24 Deployment to Production Maconomy Customer Development Release Process - Essentials Customer Developers Development QE/ QA team/bc CloudOps Support Deliverables & Artifacts Cont. to Deployment to Production Service Request Opened Raise Service Request to Copy to Production up Customer s Production Enviroment Ticket includes: Change description, test evidence, implementation guide DB backup, File System up Deploy to Customer s Production Environment Standby for supporting deployment Smoke Test Customer s Production Environment Smoke Test Passed? Test env. Smoke Test evidence Verify Deployment is working as expected Optional - Rollback Imlementation Customer Production Env. restored to pre-implementation state dependent on customers wish Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed Post Production Signoff? Customer signoff on production change Rollback Imlementation Customer Production Env. restored to pre-implementation state Close CR & RNT Ticket Service Request Closed DCO CR Ticket Closed