OHS Remedy Coding Standards

Only available on StudyMode
  • Topic: Action Request System, AR System Administrator, Field
  • Pages : 10 (1831 words )
  • Download(s) : 63
  • Published : February 4, 2013
Open Document
Text Preview
OHS Remedy Coding Standards

Naming Convention of Work Flow Objects2
Shared Workflow5
Filter Execution Order Best Practices5
Field ID7
Global Fields7
Attributes of Global Fields7
Shared Workflow8
Error Messages8


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}

Required {}
Optional []


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 “_”.


Underneath the application, there are the forms.

A naming convention is being followed which have prefix of the application name/abbreviation followed by the form name. For creating a join form, then name of the form should contain the name/abbreviation of the joining forms (primary form first) and keyword JOIN. If it is a display only or view form, then append dialog or view at the end of the form name.

If new forms are created very often, a template form can also be created and used (save as). For the template form, the basic layout can be set, and permissions for the core field, and by all means add a couple of field such as a char-temp-field that are used mostly in the application.

In order to make OHS Application mid-tier compatible, blank spaces between Form Names should not be used.


|Form Name |Contract |Billing | |Full Name |OHS-Contract |OHS-Billing |


In case of fields, it would be a good practice to take care of the Name as well as the Field ID.

In case of OHS application, the name and size of a field is tried to kept same in all the forms where this field is used. This is strictly followed to avoid data discrepancy as the same data is carried forward to a number of interfaces

| Form Name |Contract |Billing | |Current Revision |Current_Revision |Current_Revision | |Order Status |Order_Status |Order_Status |


There can be many filters associated with a form, which may trigger at the same time. From the naming point of view, it would be better to have the execution order and what the filter does.

It is also recommended to have the related filters in a...
tracking img