AddObjectToProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function adds an object to a project.

1.2Setup Notes and Prerequisites

This function requires a valid project & object handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220O - Add/Remove Object To/From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

szOMWObjectNameOMWOBJIDcharREQINPUT

A 200-character field that serves as an identifier for a OneWorld object. When used in conjunction with an Object Management Workbench 
Object Type (OMWOT),it uniquely identifies any OneWorld object. See the H92/OT UDC for a list of object types that can use this field to 
store their identifiers.

szOMWObjectTypeOMWOTcharREQINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

szReleaseSRCRLScharOPTINPUT

The transfer rule only applies to objects in the project for this release (objects are always tied to a release within a project). The From and 
To Release fields should always be equal.

Related Functions

None

Related Tables

None
AddObjectToProjectNoHandle

AddObjectToProjectNoHandle

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220O - Add/Remove Object To/From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

szOMWObjectNameOMWOBJIDcharREQINPUT

A 200-character field that serves as an identifier for a OneWorld object. When used in conjunction with an Object Management Workbench 
Object Type (OMWOT),it uniquely identifies any OneWorld object. See the H92/OT UDC for a list of object types that can use this field to 
store their identifiers.

szOMWObjectTypeOMWOTcharREQINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

szReleaseSRCRLScharOPTINPUT

The transfer rule only applies to objects in the project for this release (objects are always tied to a release within a project). The From and 
To Release fields should always be equal.

Related Functions

None

Related Tables

None
AddUserToProject

AddUserToProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function adds a user to a project.

1.2Setup Notes and Prerequisites

This function requires a valid project handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220Z - Add/Remove User To/From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWProjectUserOMWUSERcharREQINPUT

A value that indicates the user or group for which the To status is valid.  If the user is not set up for a valid To status, then the user may not 
advance a project to that status.   *PUBLIC is a valid value for this field.

szOMWUserRoleOMWURcharREQINPUT

A definition of the user's function within a project.  Project managers generally assign a user to a project.  When they do so, they indicate 
what role that user will be playing.  Examples of User Roles are:        01  Originator:  Person who originated the project or the need for the project.   
     02  Developer:  Person who modifies project objects.        03  Manager:  Person who manages the project.        04  Quality Assurance:  
Person who checks the project's functionality.        06  Administrator:  Person who configure project status, user roles, objects, etc.

cOMWProjectLeadOMWPLcharREQINPUT

idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
BackupOrRollback

BackupOrRollback

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AV - OMW Backup and Rollback

This will Backup (BackupOrRollback = '0') from the provided Path Code, to the provided Data Source and Directory 
Path (for .h, .c, .obj files). Rollback (BackupOrRollback = '1') will be done from the provided Data Source and Directory 

Path, to the provided Path Code.

Backup and Rollback will be performed for all objects within the passed in Project handle unless information for a 

specific object is provided (object name, type, and release are all required to identify an object), the object must exist in the 

project before calling Backup or Rollback on it.

Parameter NameData ItemData TypeReq/OptI/O/Both
szDataSourceDATScharREQINPUT

OneWorld uses this data source if the primary data source or the data item in the primary data source cannot be located.

szPathCodePATHCDcharREQINPUT

The path code is a pointer to a set of OneWorld objects, and is used to keep track of sets of objects and their locations within OneWorld.

szDirectoryPathDRPTcharREQINPUT

szOMWObjectNameOMWOBJIDcharOPTINPUT

A 200-character field that serves as an identifier for a OneWorld object. When used in conjunction with an Object Management Workbench 
Object Type (OMWOT),it uniquely identifies any OneWorld object. See the H92/OT UDC for a list of object types that can use this field to 
store their identifiers.

szOMWObjectTypeOMWOTcharOPTINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

szOMWObjectReleaseSRCRLScharOPTINPUT

The transfer rule only applies to objects in the project for this release (objects are always tied to a release within a project). The From and 
To Release fields should always be equal.

cBackupOrRollbackEV01charREQINPUT

An option that specifies the type of processing for an event.

idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
ChangeProjectStatus

ChangeProjectStatus

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AW - Change Project Status

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWFromProjectStatusOMWFPScharREQINPUT

This can be one of the project status codes, which      are:    01  Complete    11  Pending Review    17  Plan or Research    18  Design    19  
Design Review    21  Programming    22  Programmer Test    23  Manager Review    24  Transfer to Production    25  Rework    26  QA Test    28  QA Test 
Complete 

szOMWToProjectStatusOMWTPScharREQINPUT

Indicates an allowed next status for a project that is currently at the From status to be advanced to.

cOMWProofOrFinalModeOMWPOFcharREQINPUT

idOMWProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

cBlockProgressDialogPopupEV01charOPTINPUT

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None
CheckInObject

CheckInObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function checks in an Object Librarian Object using the Object Management Workbench.  It will fail if it is not checked-out or it does not have the 
token.  If it is a project object, the check-in method will be called on all the objects within a project.


This only works for Object Librarian Object Types (APPL, BSFN, BSVW, DSTR, GT, TBLE, UBE, and UBEVER) and project objects (PRJ).


1.2Setup Notes and Prerequisites

This function requires a valid project handle and object handle and the object must be part of the project.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AG - Check In Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idObjectHandleAPPLIDIDREQINPUT

This is a handle to the object (or Project) to be checked  in.ab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the check-in function.   ab 

Related Functions

None

Related Tables

None
CheckOutObject

CheckOutObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function checks out an Object Librarian Object using the Object Management Workbench.  The function will always request the token if the object 
does not already have it.  If the object does not have the token and the request for the token fails (i.e. someone else has the token), the calling function can 

set it so this function will prompt the user with a GUI to allow the user to select one of the following options:


1.Queue up for the token
2.Inherit the token

3.Do not do anything and exit


This only works for Object Librarian Object Types (APPL, BSFN, BSVW, DSTR, GT, TBLE, UBE, and UBEVER).


This also works for project (PRJ).  To do this, call this function where idObjectHandle equals zero.  In this case, the cPromptUser and 

cRequestTokenFailOption flags are ignored.  Checkout is applied to the entire project and the return value is returned in idReturn.


Data Structure

D98220AE - Check Out Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHandleAPPLIDIDREQINPUT

This is a handle to the project that contains the object that needs to be checked  out.ab 

idObjectHandleAPPLIDIDREQINPUT

This is a handle to the object to be checked  out.ab 

cPromptUserEV01charREQINPUT

0  Do not prompt user if request token fails. 
1  Prompt user if request token  fails.ab 


cRequestTokenFailOptionEV01charOPTINPUT

If PromptUser = 0, the following will be used to handle the situation of failing to get the token: 
0  Do nothing and return. 

1  Queue for the token 

2  Inherit the  Tokenab 


idReturnAPPLIDIDOPTOUTPUT

Return Value from the checkout function.   ab 

idReqTknRetAPPLIDIDOPTOUTPUT

Return Value from the request token function.   
0  Project has token for object (it could have inherited it) 

1  Project does not have the token but it is queued up for it. 

2  Project does not have the token. 

3  Request Token returned with another error.  Check idRetSecLvl for this error  code.ab 


idRetSecLvlAPPLIDIDOPTOUTPUT

Return value from the request token function if the return value could not be handled (i.e. database error.)  If zero, no  error.ab 

Related Functions

None

Related Tables

None
CopyNonOLObject

CopyNonOLObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AK - Copy OMW Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHanldeAPPLIDIDREQINPUT

This is a handle to the project that the copy will be added  to.ab 

szOMWObjectNameOMWOBJIDcharREQINPUT

Object Name to be  copiedab 

szOMWObjectTypeOMWOTcharREQINPUT

Object Type to be copied These are the only supported types: 
APPL 

DSTR 

UBE 

UBEVER 

APPLVER 

GT 

TBLE 

BSVWab 


szSourceReleaseSRCRLScharREQINPUT

Release of the object to be  copied.ab 

cPromptUserEV01charREQINPUT

1  Prompt User with copy prompt 
0  Do not prompt with copy prompt and assume the passed in parm object has the necessary  values.ab 


idObjectAPPLIDIDOPTOUTPUT

Handle to new  copyab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the copy function.   ab 

idParmAPPLIDIDOPTINPUT

Parm object that will be used to pass data to the copy function.  If not parm object is specified, one will be created and populated as needed.  This field is 
required if the prompt user flag is  zero.ab 


Related Functions

None

Related Tables

None
CopyOMWObject

CopyOMWObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function calls the copy method on the passed in object reference.  If the prompt flag is set, the OMW will automatically bring up the appropriate 
copy form for the selected object.


1.2Setup Notes and Prerequisites

This function requires a valid project handle.

Currently, this API can only be used for the following objects:


APPL

DSTR

UBE

UBEVER

APPLVER

GT

TBLE

BSVW


All other types are either not supported (only BSFN copy is not supported) or they must be copied directly from the OMW GUI.


1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AK - Copy OMW Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHanldeAPPLIDIDREQINPUT

This is a handle to the project that the copy will be added  to.ab 

szOMWObjectNameOMWOBJIDcharREQINPUT

Object Name to be  copiedab 

szOMWObjectTypeOMWOTcharREQINPUT

Object Type to be copied These are the only supported types: 
APPL 

DSTR 

UBE 

UBEVER 

APPLVER 

GT 

TBLE 

BSVWab 


szSourceReleaseSRCRLScharREQINPUT

Release of the object to be  copied.ab 

cPromptUserEV01charREQINPUT

1  Prompt User with copy prompt 
0  Do not prompt with copy prompt and assume the passed in parm object has the necessary  values.ab 


idObjectAPPLIDIDOPTOUTPUT

Handle to new  copyab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the copy function.   ab 

idParmAPPLIDIDOPTINPUT

Parm object that will be used to pass data to the copy function.  If not parm object is specified, one will be created and populated as needed.  This field is 
required if the prompt user flag is  zero.ab 


Related Functions

None

Related Tables

None
CreateObjectPrompt

CreateObjectPrompt

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function creates a brand new object and adds it to a project (if the new object is not a project).  This function will always prompt the user with the 
appropriate dialog to add the indicated object.


1.2Setup Notes and Prerequisites

This function requires a valid project handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AH - Create OneWorld Object with Prompt

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectAPPLIDIDREQBOTH

This is a handle to the project that the new object will be added to.  If you are adding a project, this must be an empty handle variable to receive the new 
project  handle.ab 


szOMWObjectTypeOMWOTcharREQINPUT

Object Type to be  addedab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the check-in function.   ab 

idParmAPPLIDIDOPTINPUT

Parm object that will be used to pass data to the add function.  If not parm object is specified, one will be created and populated as  needed.ab 

Related Functions

None

Related Tables

None
CreateProject

CreateProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AU - Create Project and Handle

A Project will be created if one does not exist in the Project table and return a handle to the Project.
Pass in all attributes if this is a new Project, you can have the GUI called to allow the user to enter the attributes or pass 

them into the NER. (Call GUI flag, 1 = yes, 0 = no)

If this is an existing Project, only the Project Name is needed. 

ESUPackageName is used for the ESU process, if you are not using this function for ESU, leave this field blank.

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWProjectNameOMWPRJIDcharREQINPUT

An identifier for a OneWorld project. A OneWorld project is composed of a group of OneWorld objects that have been modified or created 
by a developer to complete a task. All work with objects within OneWorld must occur within the context of a project.

szOMWProjectTypeOMWTYPcharOPTINPUT

szOMWProjectSeverityOMWSVcharOPTINPUT

szProjectProductSystemCodeSYRcharOPTINPUT

A user defined code (98/SY) that specifies the system number for reporting and jargon purposes.

szOMWProjectDescriptionOMWDESCcharOPTINPUT

cCallGUIFlagEV01charOPTINPUT

An option that specifies the type of processing for an event.

szESUPackageNameOMWPJS1charOPTINPUT

idProjectHandleAPPLIDIDREQOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idParamObjectHandleAPPLIDIDOPTINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
CreateProjectHandle

CreateProjectHandle

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220K - Create Project Handle

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWProjectNameOMWPRJIDcharREQINPUT

An identifier for a OneWorld project. A OneWorld project is composed of a group of OneWorld objects that have been modified or created 
by a developer to complete a task. All work with objects within OneWorld must occur within the context of a project.

idPrjHandleAPPLIDIDREQOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
DeleteHandle

DeleteHandle

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function deletes the passed in OMW handle.  This handle can be an object handle, a project handle, a log interface handle, or a parameter object 
handle.


1.2Setup Notes and Prerequisites

This function requires a handle created by another OMW function.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220S - Delete OMW Object Hanlde

Parameter NameData ItemData TypeReq/OptI/O/Both
idHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
DeleteOMWObject

DeleteOMWObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function calls the delete method on the passed in object reference.  

1.2Setup Notes and Prerequisites

This function requires a valid object interface handle.  A project is an object interface as well.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AL - Delete OMW Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idObjectAPPLIDIDREQINPUT

This is a handle to the project or object to be  deleted.ab 

cDeleteLocalEV01charREQINPUT

0  No, do not delete locally 
1  Yes, delete locally.   


If this is an OL object, this will delete the object from local specs.  If this is a non-OL object, this will delete the object from the table the local environment 

points to.  This does not apply to  projects.ab 


cDeleteServerEV01charREQINPUT

0  No, do not delete from the check-in location. 
1  Yes, delete from the check-in location.  


This applies only to OL  Objects.ab 


idReturnAPPLIDIDOPTOUTPUT

Return Value from the delete function.   ab 

szOMWObjectTypeOMWOTcharOPTINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

idProjectAPPLIDIDOPTINPUT

The Application ID uniquely identifies the OneWorld Application.

cReqTokenPromptUserEV01charOPTINPUT

An option that specifies the type of processing for an event.

cRequestTokenFailOptionEV01charOPTINPUT

An option that specifies the type of processing for an event.

idReqTknRetAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idReqTknSecLvlAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

cDeleteSaveEV01charREQNONE

An option that specifies the type of processing for an event.

cDeleteOnPrjXferEV01charREQNONE

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None
DesignObject

DesignObject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.1Purpose
This function bring up the appropriate design form for the passed in object handle.

1.2Setup Notes and Prerequisites

This function requires a valid object handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AI - Design OMW Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idReturnAPPLIDIDOPTOUTPUT

Return Value from the check-in function.   ab 

idObjectAPPLIDIDREQINPUT

This is the handle to the object you want to design.  You can get this object handle from calling  'GetObjectFromProject()'.ab 

idDesignModeAPPLIDIDOPTINPUT

Allows caller to specify what design mode to bring the object up in.  If left blank, it will be bring up the default  mode.ab 

Related Functions

None

Related Tables

None
EraseOMWCheckout

EraseOMWCheckout

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function erases the checkout for an Object Librarian Object.

1.2Setup Notes and Prerequisites

This function requires a valid project handle.

This function only applies to the following object types:

APPL

BSFN

BSVW

DSTR

GT

TBLE

UBE

UBEVER


1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220AM - Erase Object Librarian Checkout

Parameter NameData ItemData TypeReq/OptI/O/Both
idObjectAPPLIDIDREQINPUT

Handle to the Object Librarian Object to have its checkout  erased.ab 

idReturnAPPLIDIDOPTOUTPUT

Return value based off the OMW_RETURN  enum.ab 

cReleaseTokenEV01charREQINPUT

1  Release Token
0  Do not Release  Tokenab 


Related Functions

None

Related Tables

None
GetObjectFromProject

GetObjectFromProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function gets an object from a project.  Depending on a flag, this function will add the object to the project if the object is not found in the project.

1.2Setup Notes and Prerequisites

This function requires a valid project handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220L - Get Object Interface From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWObjectNameOMWOBJIDcharREQINPUT

A 200-character field that serves as an identifier for a OneWorld object. When used in conjunction with an Object Management Workbench 
Object Type (OMWOT),it uniquely identifies any OneWorld object. See the H92/OT UDC for a list of object types that can use this field to 
store their identifiers.

szOMWObjectTypeOMWOTcharREQINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

cAddIfNotFoundEV01charREQINPUT

1 - Add Object to project if not found in project
2 - Do not add object to project if not found in project

idObjectHandleAPPLIDIDREQOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idProjectAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

szReleaseSRCRLScharOPTINPUT

The transfer rule only applies to objects in the project for this release (objects are always tied to a release within a project). The From and 
To Release fields should always be equal.

Related Functions

None

Related Tables

None
ReleaseToken

ReleaseToken

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AG - Check In Object

Parameter NameData ItemData TypeReq/OptI/O/Both
idObjectHandleAPPLIDIDREQINPUT

This is a handle to the object (or Project) to be checked  in.ab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the check-in function.   ab 

Related Functions

None

Related Tables

None
RemoveObjectFromProject

RemoveObjectFromProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function removes an object from a project.

1.2Setup Notes and Prerequisites

This function requires a valid project handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220O - Add/Remove Object To/From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

szOMWObjectNameOMWOBJIDcharREQINPUT

A 200-character field that serves as an identifier for a OneWorld object. When used in conjunction with an Object Management Workbench 
Object Type (OMWOT),it uniquely identifies any OneWorld object. See the H92/OT UDC for a list of object types that can use this field to 
store their identifiers.

szOMWObjectTypeOMWOTcharREQINPUT

In OneWorld, an object has traditionally been a reusable entity based on software specification created by the OneWorld Tools.  These 
objects included Object Librarian Objects, such as interactive applications (APPL), as well as batch applications (UBE), and data structure 
(DSTR) objects. In OMW, we have expanded this definition to include other Non Object Librarian type objects or data source based rather than 
path code based objects.  These include User Defined Controls (UDC), Workflow, ActivEra, Menus, and Data Items. OL Objects:     o Batch 
Applications     o Business functions     o Business views     o Data structures     o Event rules     o Interactive applications     o Media Objects     o 
Tables Non-OL Objects     o Data dictionary items     o UDC items     o Workflow items     o Menus 

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

szReleaseSRCRLScharOPTINPUT

The transfer rule only applies to objects in the project for this release (objects are always tied to a release within a project). The From and 
To Release fields should always be equal.

Related Functions

None

Related Tables

None
RemoveUserFromProject

RemoveUserFromProject

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function removes a user from a project.

1.2Setup Notes and Prerequisites

This function requires a valid project handle.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.


Data Structure

D98220Z - Add/Remove User To/From Project

Parameter NameData ItemData TypeReq/OptI/O/Both
szOMWProjectUserOMWUSERcharREQINPUT

A value that indicates the user or group for which the To status is valid.  If the user is not set up for a valid To status, then the user may not 
advance a project to that status.   *PUBLIC is a valid value for this field.

szOMWUserRoleOMWURcharREQINPUT

A definition of the user's function within a project.  Project managers generally assign a user to a project.  When they do so, they indicate 
what role that user will be playing.  Examples of User Roles are:        01  Originator:  Person who originated the project or the need for the project.   
     02  Developer:  Person who modifies project objects.        03  Manager:  Person who manages the project.        04  Quality Assurance:  
Person who checks the project's functionality.        06  Administrator:  Person who configure project status, user roles, objects, etc.

cOMWProjectLeadOMWPLcharREQINPUT

idProjectHandleAPPLIDIDREQINPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

The Application ID uniquely identifies the OneWorld Application.

Related Functions

None

Related Tables

None
RequestToken

RequestToken

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description

1.1Purpose
This function requests the token for the passed in object handle.   If the object does not have the token and the request for the token fails (i.e. someone 
else has the token), the calling function can set it so this function will prompt the user with a GUI to allow the user to select one of the following options:


1.Queue up for the token
2.Inherit the token

3.Do not do anything and exit


This only works for Object Librarian Object Types (APPL, BSFN, BSVW, DSTR, GT, TBLE, UBE, and UBEVER).


1.2Setup Notes and Prerequisites

This function requires a valid project handle and object handle and the object must be part of the project.

1.3Special Logic

Like everything else in N98220B, this function is client-only because it relies on the B98220A business function.  B98220A relies on jdeomw.dll which is a 
client-only system library.



Data Structure

D98220AF - Request Token

Parameter NameData ItemData TypeReq/OptI/O/Both
idProjectHandleAPPLIDIDREQINPUT

This is a handle to the project that contains the object that needs to be checked  out.ab 

idObjectHandleAPPLIDIDREQINPUT

This is a handle to the object to be checked  out.ab 

cPromptUserEV01charREQINPUT

0  Do not prompt user if request token fails. 
1  Prompt user if request token  fails.ab 


cRequestTokenFailOptionEV01charOPTINPUT

If PromptUser = 0, the following will be used to handle the situation of failing to get the token: 
0  Do nothing and return. 

1  Queue for the token 

2  Inherit the  Tokenab 


idReturnAPPLIDIDOPTOUTPUT

Return Value from the request token function.   
0  Project has token for object (it could have inherited it) 

1  Project does not have the token but it is queued up for it. 

2  Project does not have the token. 

3  Request Token returned with another error.  Check idRetSecLvl for this error  code.ab 


idRetSecLvlAPPLIDIDOPTOUTPUT

Return value from the request token function if the return value could not be handled (i.e. database  error.)ab 

Related Functions

None

Related Tables

None
SetupF4801Handle

SetupF4801Handle

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

Data Structure

D98220AS - Setup F4801 Handle

Parameter NameData ItemData TypeReq/OptI/O/Both
idF4801RecordSetAPPLIDIDREQOUTPUT

The Application ID uniquely identifies the OneWorld Application.

idReturnAPPLIDIDOPTOUTPUT

0 - Success
1 - Error

Related Functions

None

Related Tables

None
;font-size:10pt">

szOMWObjectNameOMWOBJIDcharREQINPUT

Object Name to be  copiedab 

szOMWObjectTypeOMWOTcharREQINPUT

Object Type to be copied These are the only supported types: 
APPL 

DSTR 

UBE 

UBEVER 

APPLVER 

GT 

TBLE 

BSVWab 


szSourceReleaseSRCRLScharREQINPUT

Release of the object to be  copied.ab 

cPromptUserEV01charREQINPUT

1  Prompt User with copy prompt 
0  Do not prompt with copy prompt and assume the passed in parm object has the necessary  values.ab 


idObjectAPPLIDIDOPTOUTPUT

Handle to new  copyab 

idReturnAPPLIDIDOPTOUTPUT

Return Value from the copy function.   ab 

idParmAPPLIDIDOPTINPUT

Parm object that will be used to pass data to the copy function.  If not parm object is specified, one will be created and populated as needed.  This field is 
required if the prompt user flag is  zero.ab 


Related Functions

None

Related Tables

None
CreateObjectPrompt

CreateObjectPrompt

OMW NER API

Minor Business Rule

Object Name: N98220B

Parent DLL: COBLIB

Location: Client

Language: NER

1.Functional Description