OHS Remedy Coding Standards

OHS Remedy Coding Standards

Contents
Overview 2
Naming Convention of Work Flow Objects 2 Application 2 Form 3 Fields 3 Filters 3 ActiveLinks 4 Menus 4 Guides 4 Escalations 5 Shared Workflow 5
Filter Execution Order Best Practices 5 Guidelines 6
Field ID 7 Advantages 7 Global Fields 7 Attributes of Global Fields 7 Shared Workflow 8 Benefits 8
Error Messages 8

Overview

This document will be used as a reference for best practices surrounding COLT OneOHS Application. It provides guidelines for documenting system changes which will help manage the lifecycle of the customization through deployment.

Naming Convention of Work Flow Objects

The idea behind this is to give one style of naming objects in OHS which should be a very good fit for most situations.

For a big application like OHS, that is getting expanded, it must be decided how to fit the code without introducing a contradicting naming strategy.

Application {OHS} Form {OHS}{Del}{FormName} Fields [Group-prefix-in-form]{Del}{Field-name} Filters {OHS}{Del}{Form-prefix}{Del}{What does it do}[Exec-order] Active Links {OHS}{Del}{Form-prefix}{Del}{What triggers it}[Exec-order] Menus {OHS}{Del}{Form-prefix}{Del}{What does it show} Guides {OHS}{Del}{Form-prefix}{Del}{Guide-name} Escalations {OHS}{Del}{Form-prefix}{Del}{What does it do}

TAG-explanation: Required {} Optional []

Application

It is always advisable to use a name which is simple and easily recognizable. Also one should prefix the application name/ abbreviation followed by a delimiter to the workflow objects which are developed for the application.

For example, the Order Handling System application, use the prefix OHS. The delimiter can be a “ “ or “:” or “-“ or “_”.

Form

Underneath the application, there are the forms.

A naming convention is being