NGORegisterForm

This transaction can be used to register a Formform (which is basically a visual representation of a Ddata dDefinition) for a datadefinitionDataDefinition.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGORegister

Form

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

DuplicateName

Root

This Flag specifies whether the duplicate name is to be generated for the form or not.

‘Y’ –Yes

‘N’ – No

 

NameLength

Root

Maximum length of the name of the Form.

 

 

Form

Root

It contains the complete information about a formForm using various tags.

 

N/A

FormName

Form

Name of the form whichForm that is to be registered for the datadefinitionDataDefinition.

 

N/A

FormType

Form

Not Used

 

 

CreationDate

Time

Form

Date and Time of registration of the formForm for the datadefinitionDataDefinition.

 

Current Date Time

DataDefIndex

Form

Index of the datadefinitionDataDefinition for which the formForm is to be registered.

 

N/A

Comment

Form

Comments that are to be added with the formForm.

 

 

FormBuffer

Form

Binary data that represents the formForm.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If Status is 0, then the call is successful.

Form

Root

It contains the complete information about a formForm using various tags.

FormIndex

Form

Index of the formForm registered for the datadefinitionDataDefinition.

FormName

Form

Name of the formForm registered for the datadefinitionDataDefinition.

FormType

Form

Not Used.

Owner

Form

Not Used.

CreationDateTime

Form

Date and Time of registration of the formForm for the datadefinitionDataDefinition.

RevisedDateTime

Form

Date and Time when the formForm was last revised.

AccessedDateTime

Form

Date and Time when the formForm was last accessed.

DataDefIndex

Form

Index of the datadefinitionDataDefinition for which the formForm is registered.

DataDefName

Form

Name of the datadefinitionDataDefinition for which the formForm is registered.

Comment

Form

Comments added with the formForm.

Locked

Form

Specifies whether the form is locked or not.

LockedBy

Form

Index of the User by whom the Form is locked.

LockMessage

Form

Message to be displayed when the Form is locked.

LockByUser

Form

Username of the User by whom the Form is locked.

 

Errors returned from call

Code

Message

Comments

-50028

Data Class not found.

The Data Class, with which the given formForm was to be registered, does not exist.

-50032

Insufficient rights for the current operation.

The logged in User does not have Rread rRights on the datadefinitionDataDefinition with which the formForm is to be registered.

-50131

Form name already exist.

This exception comes occurs when the User tries to add a formForm with a name that such that some other form with the same name already exists.