NGOChangeCabinetProperty

This call is used to modify the Properties of the Cabinet. User should send only those Tags for which, the Cabinet Properties have to be modified.  The remaining values are retained.

 

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.

NGOChange

CabinetProperty

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

Cabinet

Root

A list of Cabinet information, starting from the root, is given between <Cabinet> and </Cabinet> tag.

 

 

Security Level

Cabinet

It indicates the level of Security in the Cabinet.

0 - No Security

1 - Cabinet Level Security

2 - Object Level Security

    2

Image Volume Index

Cabinet

It indicates the VolumeId of the entire Cabinet. Whenever a new folder is added to the Cabinet and the User does not specify Volume Id, it inherits this value from Cabinet.

 

 

Version Flag

Cabinet

Specifies whether Auto versioning is allowed or not

 

Y – Versioning is allowed

N – Versioning is not allowed

 

CabinetLockFlag

Cabinet

It indicates a flag whether the Cabinet should be locked or not.

Y-Yes

N-No

 

EnableFTSFlag

Cabinet

This flag indicates whether FTS should be Enabled for this Cabinet or not

Y – Yes

N - No

 

FTSDatabasePath

Cabinet

Reserved for internal use.

 

 

Priveleges

Cabinet

Reserved for internal use

 

NULL

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

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

CabinetName

Root

It indicates the name of the Cabinet.

CabinetType

Root

It indicates the type of the Cabinet (Image, Document or Both Cabinet).

VersionFlag

Root

Specifies whether Auto Versioning is supported or not.

ImageVolumeIndex

Root

It indicates the VolumeId of the entire Cabinet.  Whenever a new folder is added to the Cabinet and the User does not specify the Volume Id, it inherits this value from the Cabinet.

CreationDateTime

Root

It indicates the Date and Time when the Cabinet was created.

LoginUserRights

Root

It indicates the Rights of the User logged on to the Cabinet.

FTSDatabasePath

Root

Reserved for internal use.

SecurityLevel

Root

It indicates the level of Security on the Cabinet.

CabinetLockFlag

Root

Flag that specifies whether the Cabinet is locked or not.

LockByUser

Root

It indicates the User Index of the User who has locked the Cabinet.

LoginUserIndex

Root

User Index of the currently logged in User.

 

Errors returned from call

Code

Message

Comments

-50078

User is not Administrator.

The Administrator can only perform this operation.