|
Object: sapphire.connection |
Description
Manages the connection.
File
WEB-CORE\scripts\sapphirecore.js
Properties
| Property | Type | Description |
| databaseId | String | Database in use by the client. |
| sysUserId | String | Current user of the client. |
| sysUserDesc | String | Description of the client's current user. |
| sysUserRoleList | String | Roles of the current user. |
| sysUserModuleList | String | Modules assigned to the current user. |
| rsetid | String | Current RSetId (blank if not used). |
| pingRsetFrqcy | Integer | Timeout until an RSet ping (in seconds). |
| pingConnectionFrqcy | Integer | Timeout until a connection ping (in seconds). |
| timeToTimeout | Integer | Time remaining until the connection is lost (in seconds). |
| connectionDate | String | Date the connection was created. |
| decimalSeparator | String | Number decimal separator generated from the FormatUtil. |
| groupingSeparator | String | Number grouping separator generated from the FormatUtil. |
| groupingInterval | Number | Number grouping interval generated from the FormatUtil. |
| isDevMode | Boolean | Determines if the application is in Development Mode. |
| isLoggingOff | Boolean | True if a log off is initiated. |
pingRset |
Functionality
Pings the RSet and keeps it alive.
Parameters
| Parameter | Type | Description |
| rsetid | String | RSetId. |
Returns
None.
pingRsetError |
Functionality
Error handler for Ajax error callback when rset is pinged.
Parameters
| Parameter | Type | Description |
| rsetid | String | RSetId. |
Returns
None.
getConnectionId |
Functionality
Gets the current ConnectionId.
Parameters
None.
Returns
String.
checkConnection |
Functionality
Checks the connection to determine the time remaining until timeout, then takes the following action:
| Time Remaining (seconds) | Functionality |
| Less than 120 | Shows a dialog. |
| Zero | Directs the current page back to the login page. |
Parameters
None.
Returns
None.
pingConnection |
Functionality
Pings the connection to keep it alive.
Parameters
None.
Returns
None.
dsCall |
Functionality
Calls any JavaScript function with the arguments provided using the Departmental Security model to check Access Type.
Parameters
| Parameter | Type | Description |
| sSDCId | String | Identifier of the SDC on which the operation is performed. |
| sKeyId1 | String | List of SDIs on which the operation is performed. |
| sOperation | String | Identifier of the Operation that is performed. |
| sAccessType | String | Access Type of the operation (if known... otherwise, pass an empty string). If the Access Type is "World", the Departmental Security check is bypassed. |
| sFailureScript | String | JavaScript to execute if authorization has failed (any failed SDIs). From the failure script, you have access to this.failedsdis and this.passedsdis. |
| oFunction | Function | Function pointer to a JavaScript function that will be executed if the security check passes. |
| oaArguments | Object Array | Arguments to pass to the function specified by the oFunction parameter (above). |
Returns
None.
releaseLock |
Functionality
Sets the cookie string to release the current lock.
Replaces the releaseLock method in layout.js.
Parameters
| Parameter | Type | Description |
| sReleaseLockFlag | String | Setting this to Y releases the lock. |
Returns
None.
setCookieRSetList |
Functionality
Sets the cookie that holds the reset details.
Replaces the setCookieRSetList method in layout.js.
Parameters
| Parameter | Type | Description |
| sRsetlist | String | RSet Id list. |
Returns
None.
getRSetId |
Functionality
Gets the current RSetId from the Maintenance or Data Entry page, and sets the connection.rsetid property.
Replaces the getRSetId method in layout.js.
Parameters
None.
Returns
String.
logOff |
Functionality
Forces Log Off.
Parameters
| Parameter | Type | Description |
| IForce | Boolean | True to force a log off, false or not provided to check for connection and initiate timeout. |
Returns
None.