{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Custom Code files for EngageIP can be stored in the EngageIP source code repository system regardless of whether they were written by LogiSense or other developers. The following sections describe the naming conventions for folders, files and build artifacts when the custom code file for a customer is included in the EngageIP source code repository system.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Folder Structure Naming Convention","type":"text"}]},{"type":"paragraph","content":[{"text":"The folder structure on the file system must reflect the namespaces and folder structure in the C# solution. Files are placed in the Customer folder in the C# solution as outlined below.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"99fd401f-9666-4b61-860a-803112a53bc7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Folder","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Content Guidelines","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Config","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"These are classes that are used for configuration. For example, FileMoverSettings","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Database","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All SQL files must be placed here. This includes any views, tokens, and other objects. Typically these are SQL files. Any .txt files that are actually SQL files should have their extension changed to .sql and placed here","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"EventHandlers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All UUIH classes and classes inheriting from IAction must be placed here","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Feeds","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All CDR/UDR Feeds must be placed here. All Feed Processors should also be placed here","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Hooks","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All Hooks must be placed here. These types are defined in Logic.Hooks.cs. Examples are IInvoiceClosingHooks, IInvoiceReopenedHook, ITicketStatusChangeHook, etc.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Installers","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Used for any ICustomCodeInstaller stand alone classes.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Jobs","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All Jobs that inherit from IJob must be placed here","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"PageExtensions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All javascript, css, and classes that extend the UI must be placed here. This is typically seen with classes inheriting from IDynamicAction, ICustomPermissions and using Castle.Monorail","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Reports","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All Custom Report classes","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"ShellScripts","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Any Shell/PowerShell scripts must be placed here. For example, Batch files (*.bat)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Templates","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"This is where any xslt template files must be placed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"WebServices","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"All asmx, wsdl and related files must be placed here. Typically these are WebService.cs, WebService.asmx, WebService.wsdl","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"A concrete example for customer names of Acme, QuickSwitchNetworks, and RedBanana would look like the following:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":239,"id":"d7f0e174-df0f-483f-a7a8-4212a86c0c17","collection":"contentId-1985839591","type":"file","height":437}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Complex Files","type":"text"}]},{"type":"paragraph","content":[{"text":"Some of the test files contain an IAction, IJob, etc in one to encapsulate one feature and overcome the limitation of not being able to share code between custom code files. ","type":"text"},{"text":"The location would be picked currently for where it makes most sense based on what the file is doing.","type":"text","marks":[{"type":"strong"}]},{"text":" For example, a Job may also have an installer in the file, it would go under the Jobs folder.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"File Naming Conventions","type":"text"}]},{"type":"paragraph","content":[{"text":"Files must be named so that it is clear who it is for, what is is doing, and what type it is. The format is as follows:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Format","type":"text"}]},{"type":"paragraph","content":[{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The 'Type' is a general description on what the file does. Generally this can determined by what folder the file was placed in. When the files are deployed the folder structure is lost. This naming format gives anyone the ability to understand what the file is about by glancing and the name.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"24e27b59-089b-40f2-ae7f-357de5c37964"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Feed","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Data Feed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Processor","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Processors (pre/post)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Workflow","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"a workflow (single and/or multistep)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Job","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Scheduled Job","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Hook","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"WebHook","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Action","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Action/Dynamic Action","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Report","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Custom Report","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Examples","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AcmeBroadWorksFeed.cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AcmeNetworkRatingProcessors.cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AcmeUUIHWorkflow.cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RedBananaUserAttributePaymentDeclineDeletionJob.cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"QuickSwitchNetworksRegulatoryRecoveryFreeHook.cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"QuickSwitchNetworksDataExportAction.cs","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Build Artifact Naming Convention","type":"text"}]},{"type":"paragraph","content":[{"text":"EngageIP Custom Code build artifacts have the file name format of -- .zip.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, Acme Corp. from an 8.0.0 build with a release candidate build #14 would look like this:","type":"text"}]},{"type":"paragraph","content":[{"text":"Acme-8.0.0- RC14.zip","type":"text"}]},{"type":"paragraph","content":[{"text":"Inside the zip file will be the versioned custom code files. Each file has the format - .","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AcmeBroadWorksFeed-4 .cs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AcmeNetworkRatingProcessors-1 .cs","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"On each file the version will increase if the file changes relative to the last build of the file. These versioned artifacts are should be what's uploaded to confluence.","type":"text"}]}],"version":1}