EMSE tool and repositories

For the EMSE Tool to push the scripts from the Civic Platform into the repository (see Pushing Scripts into a Repository below) , the repository must be empty. If you do not use the EMSE Tool to push the Civic Platform scripts into the repository, create the following folder structure in the repository.

• INCLUDES_CUSTOM - This folder contains the individual JavaScript files with the custom functions for the agency. Each file should only have one function in the file.

• Scripts - This folder uses other folders to organize the scripts for implementation. All scripts under the Scripts folder will be available to pull into the Civic Platform; the folder structure isn't preserved in the Civic Platform.

  • Events

  • Batch

  • Interface

  • Expressions

  • Config

  • Pageflow

  • Sets

  • Misc

• Reports - Use this folder for all the reports created or used in implementation. Create other folders (such as Libraries, Includes, et cetera) as needed for organization.

• Conversion - Use this folder for all the data conversion materials created or used in implementation. Create other folders as needed for organization.

  • SourcePrepScripts

  • Files

  • ConversionScripts

• Documentation - Use this folder for all the documentation created for implementation such as use cases, test cases, et cetera. If documentation materials are stored in other locations such as SharePoint the final version of the documents should be added to this folder, so all the implementation materials are available in one location.

• Requirements - Use this folder for all the requirement documentation created for implementation. If appropriate, this folder can be merged into the Documentation folder. If materials are stored in other locations such as SharePoint the final version of those documents should be added to this folder, so all the implementation materials are available in one location.

• Adapters - If an adapter or adapters are used in implementation, store the code for each adapter in its own folder under this folder. If the adapter is a standard adapter, store the code for the adapter here or, if only the configuration is unique, store the configuration. This folder is optional if no adapters are needed for implementation.

• SQL - Any SQL queries not part of a report or data conversion should be stored here. This folder is option if no queries are needed for implementation.

• Interfaces - If an interface or interfaces are used in implementation, store the code for each interface in its own folder under this folder. If the interface is a standard interface, store the code for the interface here or, if only the configuration is unique, store the configuration. This folder is optional if no interfaces are needed for implementation.

• ACA - Files for ACA should be stored in this folder. CSS files for ACA Admin and other related files but not Pageflow scripts as those are stored in the Scripts folder. If a custom ACA wrapper is used, store all of the wrapper files in an AgencyWrapper folder.

  • AgencyWrapper

Using an individual’s credentials to configure the EMSE Tool can be a security risk. Instead, you should create a user and an access token to limit access to just the repository if possible. If it isn’t possible to create a new user, create a personal access token for an individual’s account and use the token instead of the individual user’s password.