Document History

To support the latest version of the SAPPHIRE Enterprise Connector (SEC), added "readfilecontent" and "filecontentpropertyid" input properties to the ProcessFile Action.

SEC

Added a new section for the latest version of the SAPPHIRE Enterprise Connector (SEC). The former version has been deprecated.

Changes Made in Document Revision X081003-5.0

Functionality

Reason

Description

Actions

Added new properties to the CopySDIDetail Action.

Added additional (and more conspicuous) note to the RedoCalculations Action. The note makes a more prominent attempt at stressing the importance of reading conceptual material and examples prior to use.

Added "propsmatch" property to the AddDataSet Action.

Java API

Updated the Javadoc for the Java Public API.

LVX

Prefixed all LVX-specific titles with "LVX" to segregate them from the sapphireadmin Web App (particularly when returned as search results).

OOB Product

C, N,

D, E

Rewrote the OOB Product documentation described below. The new documentation is structured to allow reuse in other documents.

Functionality	Change
Interface	Discarded old information in "Introduction". Rewrote everything (now called "Interface") and updated to current functionality.
Samples	Discarded old information. Rewrote everything and updated to current functionality.
Process	Wrote topics for functionality in the Process tramline.
Tests	Wrote a "Concepts of Data Entry" topic to introduce Test Methods, Tests, Data Entry Structure, Certifications, Data Set Status Transitions, Release, Review, and Approval. Discarded old information. Rewrote everything and updated to current functionality.
Certifications	Discarded old information. Rewrote everything and updated to current functionality.
AQC	Discarded old information. Rewrote everything and updated to current functionality.
ASL and Base Storage	Discarded old information. Rewrote everything to reflect current functionality. Added sections to TISM page to identify each page's functionality for a given ASL operation.
Stability	Rearranged in logical order. Rewrote some sections and updated to current functionality.
CAPA	Discarded old information. Rewrote everything and updated to current functionality.
Reports	Discarded all nonsense and added information concerning Reporting features.
Labels	Added information about Labels.

SDI Approval

Added a section for the SDI Approval mechanism.

Web Services

Added example of Compiling and Running a SAPPHIREWS Client.

Changed location of PropertyList class from sapphire.util package to sapphire.xml package.

Changes Made in Document Revision X080601-5.0

Functionality

Reason

Description

Actions

•	In the AddSDI Action, added the usetemplatedepartment property.
•	Added new CreateSAPMessage and ProcessSAPMessage Actions.

•	In the RedoCalculations Action, changed description from "Repeats all Calculations for an SDI" to "Repeats all Calculations for all Unreleased Data Items associated with an SDI".
•	Changed property descriptions for the ProcessFiles and ProcessFile Actions to reflect latest functionality.

•	In the DeleteSDI Action, added a note to the applylock property specifying limit for the number of SDIs that can be deleted in a single call.
•	In the DeleteDataSet Action, added a note to the applylock property specifying limit for the number of Data Sets that can be deleted in a single call.

Calculations

In the Reference Calculations section of Concepts of Transformations and Calculations, noted that the RedoCalculations Action applies to Unreleased Data Items associated with the SDI.

In Concepts of Transformations and Calculations, added Passing Other Data Types into a Calculation with supporting Examples.

Changed numeric Groovy examples for clarity.

Controlled Reports

In Controlled Reports, changed "Initial Status" field to "Report Confirmed".

CTT

In the CTT ANT Task Reference:

•	In the Overview, added more information and link to an additional CTT Export Example to demonstrate file structure.
•	Modified description of ImportXML task and added example.
•	Added default values to PropertyTree task.

In the CTT ANT Task Reference, added these new items to mimic WPD export options:

•	Added new WebPage task.
•	Added four new attributes to the SDC task.
•	Added four new attributes to the Node task.

Database Connections

In the Database Connections section of Concepts of SAPPHIRE Security, added new strategy for incrementing ConnectionId.

Document Maintenance

Deleted all obsolete product configuration examples.

Java Public API

Corrected a problem with Javadoc generation. Private ancestor classes were not being detected, and several methods (in various classes) were omitted from the Javadoc build. During Javadoc generation, classpaths were specified as a system environment variable. All classpaths are now specified at runtime. Javadoc now shows full tree (Sun classes à private classes à public classes), methods inherited from private classes, and direct known subclasses.

JavaScript

•

Added these new items to the JavaScript Global API:

•

sapphire.cookie class.

•

sapphire.connection methods:

•	releaseLock
•	setCookieRSetList
•	getRSetId

•

sapphire.ajax.util method:

•	createForm

•

sapphire.page method:

•

navigate

•

sapphire.page.list methods:

•	getSelectedKeyId1
•	getSelectedKeyId2
•	getSelectedKeyId3
•	getSelectedKeyId

•

Deprecated releaseLock, setCookieRSetList, getRSetId, and navigateTo in layout.js.

Logging

Added new SAPPHIRE Logging features.

LVX

In the LVX User Maintenance Page, deleted case-sensitivity statement for passwords.

In the SDC Definition Page, removed references to the "Test" button in the Key Generation tab. It is no longer supported.

Naming Restrictions

•	Renamed the topic "Standards and Restrictions" to Naming Restrictions and Syntax Standards.
•	In Naming Restrictions and Syntax Standards, updated SDC/SDI naming restrictions.

Parameter Aliases

•	In the introduction to Concepts of Parameter Lists, resurrected the concept of Parameter Aliases.
•	In the Parameter Maintenance Page, added section on Parameter Aliases.
•	In the sdidetailmaint Element, added "SDIAlias" to DetailType (this is the Parameter Alias detail used by the Parameter Maintenance Page).

Passwords

•	In Password Validation, added information concerning new RSA Password Encryption technique.
•	In Concepts of SAPPHIRE Security, added references to topics concerning User Passwords.

Reagents

In Reagent Example and Reagent Types, added new field (on Reagent Type form) that allows a Specification to be associated with a Quality Sample ("QC Sample Spec"). Also updated screens.

SDC Maintenance

•	In the Key Generation, modified description of Max Length field (now available only if String, Date, or Number columns are part of the segment).
•	In Columns, added ability to increase new column (string) length if database allows.
•	In Exports, added automatic generation of export script for user-created SDCs.

In Linking Procedure, changed the name of "SDC Link" to "Foreign Key".

SDC Rules

In Monitoring section of System Configuration, added Performance Statistics for SDC Rules.

SEC

Added a section concerning the SAPPHIRE Enterprise Connector (SEC).

Stability

In Workorder Mark As Complete functionality, added warning about exception thrown when marking a Workorder as "Complete". This was logged as a document bug.

System Configuration

Updated System Configuration to reflect interface changes.

Translation

In System Configuration, added new "Auto fill temporary translation table" option to Miscellaneous Options.

User Maintenance

In the User Maintenance Page, deleted background information that is no longer relevant.

Versioning

In Concepts of Versioning, resurrected the concept of "Expired" versions.

Web Page Designer

In the Variables section of the Web Page Designer Properties Overview, deleted square brackets around relative date/time examples.

•	In the Web Page Designer Properties Overview, added new features for Categories and Nodes.
•	In the advancedsearch Element, added new "Adhoc Search" option to the "Search Type" property.
•	In the sdclinkmaint Element, added new "Link Definition" property and deprecated "SDC Link Id" property.
•	In the TramlineSitemap Page Type, added new "URL Target" property.
•	In the Generic and GenericPopup Layouts, added new feature to "Application title" property for specifying version number in the title.

In the Column property of the list Element, add a note about behavior with multiple foreign key links between SDCs.

Web Services

N, C

In SAPPHIRE Web Services:

•	Added checkConnection( connectionid ) and getPublicKey().
•	Changed procedure for viewing the WSDL.

History of Changes During SAPPHIRE R4.7 (DM0209)

Top

Changes Made in Document Revision X080124-4.7

Legend

Functionality

Area of SAPPHIRE functionality affected by the change.

Reason

Reason for the change:

C	Changed functionality
N	New functionality
D	Document correction
E	Document enhancement

Functionality

Reason

Description

Ajax Validation

In Server-Side Validation and Error Handling, changed the identifier of the standard Ajax form from "ajaxForm" to "ajaxform".

Configuration Transfer

In Configuration Transfer Tools:

•	Updated Overview.
•	Added Working with Transfer Packages.

Added CTT ANT Task Reference.

Reports

In the Jasper Reports section of "Concepts of Reporting":

•	Updated UI Integration and APIs.
•	Added information concerning iReports Configuration.

Error Logging

Added new information and examples to SAPPHIRE Error Logging.

Changes Made in Document Revision X071220-4.7

Functionality

Reason

Description

Actions

Added these Actions:

•	AddSDIApproval	•	GenerateLabel
•	AddSDIApprovalStep	•	MoveStorageUnit
•	AddSDIDataRelation	•	PerformCDT
•	ApproveSDIStep	•	ProcessFile
•	CancelStudy	•	ReagentEvent
•	CheckDates	•	RecordIncident
•	CheckSpecs	•	RedoCalculations
•	CompleteStudy	•	ResetSDIApproval
•	DeleteIncident	•	ResumeStudy
•	DeleteSDIApproval	•	SetCalcExclude
•	DelSDIDataRelation	•	SetupSampleForWOComp
•	EditSDIApprovalStep	•	StartStudy
•	EditSDIDataRelation	•	SuspendStudy

Added changes to AdjustTrackItemInv Action (made more generic, now handling a single Trackable Item for multiple Containers).

Added the "trackitemid" property to the AddSDIWorkitem Action.

For the AddTrackItem Action:

•	Changed "quantityunits" input property to "quantityunit".
•	Changed "trackitemid" output property to "newkeyid1".

Properties have been added to the ProcessFiles Action for future use.

In the Table of Contents, organized Actions according to class.

Began rewriting information about Creating Java Actions (in process).

Calculations

In Concepts of Transformations and Calculations, added:

•	Improvements to Internal Calculations (those involving a single SDI).
•	Capability to perform Reference Calculations (those involving multiple SDIs).
•	Capability to write expressions using Groovy.

Configuration Transfer

To support configuration transfer, added:

•	Configuration Transfer Tools
•	Compare Configurations Tool

Connections

In Monitoring, added sections for Connection Management and Timeout Handling.

Dashboard

Added Dashboard topic.

Date-Only Columns

In M18N, added section about the timezone-independent Date-Only Columns.

Dual-Key Web Pages

In Web Page Designer Properties Overview, added section about Dual-Key Web Pages.

Environments

Updated information concerning Environments, including new Freeze Thaw Tracking feature.

Expression-Based Properties

In Web Page Designer Properties Overview, added section about Expression-Based Properties.

Graphics

In development documents, changed screen captures to reflect new SAPPHIRE motif.

Java API

Added information to Overview of the sapphire.* packages and updated.

JavaScript API

Added information concerning the new SAPPHIRE JavaScript Global API and its associated features:

•	JavaScript Guide
•	JavaScript Global API
•	JavaScript Utilities

Node Hierarchy

In Web Page Designer Properties Overview, added section about new Node Hierarchy.

Passwords

In the Behaviors section of Password Validation, added requirement to specify only alphanumeric characters for user ids and passwords.

Reports

In Report maintenance, added a section for Controlled Reports.

Also added a link from Concepts of Reporting.

Reagents

Added new Reagent Management Module:

•	Reagent Example		•	Reagent Lots
•	Reagent Types		•	Reagent Lot Status

Also added the Reagent Types tab to the Parameter List Maintenance page.

SDC Maintenance

Added new Web-based SDC Maintenance page (provides LVX SDC Definition page functionality in the browser).

Also modified Concepts of SDCs, SDIs, and Reference Types to point to this new information.

SDC Rules

Added these new methods from BaseSDCRules to SDC Rules:

•	preAddDataSet and postAddDataSet	•	pre EditSDIDataItem and postEditSDIDataItem
•	preEditSDIData and postEditSDIData	•	preReleaseData and postReleaseData
•	preEditSDIDataApproval and postEditSDIDataApproval

Security

Added Concepts of SAPPHIRE Security, which includes:

•	User definitions.
•	Similarities and differences between Role-Level Access and Departmental Security.
•	Principles of Role-Level Access.
•	Principles of Departmental Security.

For the new Departmental Security, added:

•	SDC Operations to SDC Maintenance page.
•	From User List Page, new page for Managing SDC Access.

Specifications

In the Specification Maintenance page, added new features for dealing with unsupported and custom Rule Types.

Also added new CheckSpecs Action for checking SDIs against Specifications that are not associated with the SDIs.

Storage Locations

Updated information concerning Storage Locations.

Trackable Items

Updated information concerning Trackable Items, including new Freeze Thaw Tracking feature.

Versioning

To reflect latest versioning strategy:

•	Modified Concepts of Versioning.
•	Added Versions property collection to the MaintenanceList Page Type.

Web Services

SAPPHIRE Web Services are now public.

History of Changes During SAPPHIRE R4.6 (DM0208)

Top

Changes Made in Document Revision X070802-4.6.1

Functionality	Reason	Description
SDC Rules	N	Added new methods in sapphire.action.BaseSDCRules to SDC Rules.

Changes Made in Document Revision X070713-4.6

Functionality

Reason

Description

Actions

•	Added a list of non-editable columns for SetDataItemDate, SetDataItemNumber, and SetDataItemString.
•	Added GenerateReport Action for use with Jasper and Business Objects Enterprise XIR2 reports.
•	Added applicable report versions to PrintReport and SendBOReport Actions.

Adhoc Queries

Added new features to create AdHocQuery pages: Ad Hoc Query Tools and AdHocQuery Page Type.

Architecture

Created new architecture description.

CAPA

New Module for managing corrective and preventive actions.

Concepts

Added new concept topics for:

•	SDCs, SDIs, RefTypes	•	Actions and Tasks
•	Parameter Lists	•	Workflows
•	Parameter Limits	•	>Workitems
•	Specifications	•	Versions
•	Transforms and Calcs	•	Users, Roles, Privileges, Profiles
•	Queries	•	Reporting

Data Entry

In Expression Editor Dialog, changed round(x, n) and truncate(x, n) to reflect SAPPHIRE maximum numeric value (12 digits) rather than Powerbuilder specification (14 digits).

Data Locking

Modified descriptions to differentiate LVX data locking strategy from data locking used in Web apps.

Documentation

N, E

•	Merged Core, Web/Java, and ELims documents into a single document.
•	Rewrote to segregate LVX-specific functionality.
•	Wrote new conceptual topics.
•	Restructured document to reflect structure of SAPPHIRE R4.6.
•	Generated two document formats: HTML for Web pages, CHM for LVX.

Elements

•

Added new Elements:

•	filerenderer	•	speclimits
•	promptrenderer	•	specrules
•	sdclinkmaint	•	userprofile

•

Added new facility to create tab and field groups in maint, sdclinkmaint, speclimits, and specrules Elements.

•

Updated properties in the maint Element.

•

Updated advancedsearch Element.

Error Logging

Added information about SAPPHIRE Error Logging.

Result Sets

In RSet Options (Queries and Locks configuration), noted Oracle-specific functionality.

History of Changes During SAPPHIRE V3.5 (DM0207)

Top

Changes Made in Document Revision 061122-4.5/3.5

Area of Functionality

Reason for Change

Description of Change

Data Entry

Document Correction

Corrected typographical error in Expression Editor Dialog.

System Actions

Document Enhancement

Added these R4 System Actions:

Elims:

•	AddSDICOC	•	IsAnyDataReleased
•	CheckCOCCustodians	•	RemeasureDataSet
•	CopySDIDataSet	•	RestartWorkflow
•	CopySDIDetail	•	RetestDataSet
•	CopyStorageUnit	•	SyncSDIDataSetStatus
•	GetSDIDataSet	•	SyncStorageAncestor
•	GetWorkitemItem

AQC:

•	ApplyQCMethod	•	QCCalcRPD
•	EvaluateQCBatch	•	QCCalcSpikePRecovery
•	ProcessQCBatch	•	QCRuleEvaluation
•	QCApply	•	QCUpdateLimit
•	QCBulletinOnFailure	•	ReapplyQCPosition
•	QCBulletinOnSuccess	•	RetestQCBatch
•	QCCalcBlankSubtract	•	RunQCValidation
•	QCCalcCtrlDifference	•	UpdateQCBatchStatus
•	QCCalcCtrlPRecovery

Storage:

•	AddTrackItem	•	GetSDITrackItem
•	AdjustTrackItemInv	•	ReserveTrackItem
•	DeleteTrackItem	•	UnReserveTrackItem
•	EditTrackItem

SMS:

•

CreateStorageUnit

•

GetSDIStorageUnit

New Functionality

Added these Core System Actions:

•	AddFolder	•	DeleteFolderItems
•	AddFolderItems	•	RenameFolder
•	DeleteFolder	•	MoveFolder

Changed Functionality

Deprecated the CopyStorageUnit Action.

Users

Name Change

Throughout the document, changed:

•	"Standard Named User" to "Full Named User"
•	"Concurrent Named User" to "Full Concurrent User"

History of Changes During SAPPHIRE V3.4 (DM0206)

Top

Changes Made in Document Revision 060413-3.4

Area of Functionality

Reason for Change

Description of Change

Section

Reporting

Changed Functionality

Eliminated reference to any specific version of Business Objects.

Concepts of SAPPHIRE Reporting

BO6 Report Page

SendBOReport Action (Server-Side)

Changes Made in Document Revision 051215-3.4

Area of Functionality	Reason for Change	Description of Change	Section
Calculations	Document Enhancement	Added section to explain how numeric data entry is handled.	Expression Editor Dialog: Calculations: Numeric Data Entry
Display Value	New Functionality	New feature to create a display format that is conditional on user input.	Parameter List Maintenance Page: Display Sub-Tab: Create a Conditional Format
EventNotify	New Functionality	New Profile Property "Always Generate Event Notify" for Oracle users only. This ignores all Event Notify settings in Actions and LVX pages, providing Event Notify is enabled for the SDC. Also added reference to this property in Event GoTo and Event Notify Concepts (see Enabling and Disabling EventNotify).	Explorer Bar, Profile, and Page Properties: Profile Properties
EventNotify	Changed Functionality	The "eventnotify" property has been removed from 15 System Actions.	See System Actions below.
Limit Rules	Document Enhancement	Clarified the conditions under which Limit Rule Actions execute.	Limit Rule Maintenance Page
Password	Changed Functionality	Maximum number of password characters is now 100.	User Maintenance Page
Programmable Business Rules	New Functionality	New Profile Property "Custom Rules Java Package" specifies custom class for Programmable Business Rules (PBR). PBR information is in the document "SAPPHIRE Web Tools and Java API Functional Specification".	Explorer Bar, Profile, and Page Properties: Profile Properties
Reporting	Changed Functionality	SAPPHIRE now supports Business Objects V6.5.1.	Concepts of SAPPHIRE Reporting BO6 Report Page
SOM	Document Correction	Fixed two typographical errors.	User Action Reference for SOM Services
System Actions	Changed Functionality	The "eventnotify" property has been removed from the following Actions: AddChargeListItem (Server-Side) AddPriceListItem (Server-Side) AddWorkgroupItem (Server-Side) ApplyDataItemLimits (Server-Side) ApplyDataSetLimits (Server-Side) Apply SDISpecs (Server-Side) DeleteChargeListItem (Server-Side) DeletePriceListItem (Server-Side) DeleteWorkgroupItem (Server-Side) EditChargeListItem (Server-Side) EditPriceListItem (Server-Side) EditWorkgroupItem (Server-Side) EnterDataItem (Server-Side) EnterDataSet (Server-Side) ReleaseDataItem (Server-Side) This property was removed because the trigger controlling events handled by these Actions cannot be enabled or disabled.	See the links at the left.
	Changed Functionality	Added comments to describe behavior of the EnterDataItem and EnterDataSet Actions when used with Limit Rules (behavior in LVX differs from behavior in Web pages).
	New Functionality	New System Actions: AddSDIAlias (Server-Side) AddSdiversion (Server-Side) AddStudy (Server-Side) DeleteSDIAlias (Server-Side) SetSdiversionStatus (Server-Side)
	Document Enhancement	Added Comment to IE.SetURL Action to note use in a Client-Side Workflow.
	Document Correction	In GetFilename (Client-Side), changed description of fileextension and filetypes properties to match PowerBuilder documentation.

History of Changes During SAPPHIRE DM0205

Top

Changes Made in Document Revision 041203-3.3

Area of Functionality	Topic	Reason for Change	Comments
All	All	Name Change	Changed all instances of "SAPPHIRE Core Application" to "SAPPHIRE V3".
Attachments	SDI Maintenance Pages	Document Correction	Added Attachment information that was accidentally deleted in a previous document build.
Data Entry	Data Entry Page	Document Enhancement	Removed references to maximum numerical input value.
Links	SDC Definition Page	Document Correction Document Enhancement	In the description of the Links Tab: Deleted some unnecessary steps in the procedures for creating links. Moved single-key restriction to a more prominent place in the procedures.
Notices	Notices	None	Added a note concerning screen captures.
Parameters	Parameter Maintenance Page	Document Enhancement	In both the Parameter Maintenance Page and the Standards and Restrictions reference, added a note stating that the logical operators AND and OR can not be used in an attempt to setup a term for use in a calculation expression.
Parameters	Standards and Restrictions	Document Enhancement
Parameter Limits	Concepts of Parameter Limits	Document Correction Document Enhancement	Corrected a typographical error in the diagram for Standard Parameter Limit Checking. Also enhanced all diagrams to make them more readable.
Parameter List Expressions	Parameter List Maintenance Page	Document Correction	Removed all deatils concerning Operator Expressions, Calculation Rules, and Transformation Rules. Some changes made to the Expression Editor since April of 2000 were not reflected in the Parameter List Maintenance Page, which contained duplicate information for convenience. To avoid another occurrence of this error, this topic now points to the Expression Editor, where all changes are centralized.
Profile Properties	Explorer Bar, Profile, and Page Properties	Document Enhancement	In Profile Properties, simplified description of "Auto-Fill Master" property.
		Document Correction	In Profile Properties, changed description of "Password Expiry Warning" property.
		New Functionality	In Profile Properties, added "BO Document Domain" and "BO Exchange Mode" properties.
Queries	Query Maintenance Page	Document Enhancement	In the Example of Cascaded Arguments, deleted references to any specific DBMS.
Reporting	Concepts of SAPPHIRE Reporting	Changed Functionality	Modified to contain only information relevant to currently supported third-party reporting applications.
	Report Page	Changed Functionality
	BO6Report Page	New Functionality	Added BO6Report Page to support Business Objects V6.1a.
	Explorer Bar, Profile, and Page Properties	New Functionality	Added "BO URL" Profile Property to support Business Objects V6.1a. Added BO6Report Page Properties.
	Concepts of Pages	Changed Functionality	Deleted references to all reporting tools.
	System Action Reference	Changed Functionality	Deleted the following Actions until verified: CRReport.GetParam Action (Client-Side) CRReport.Print Action (Client-Side) CRReport.Refresh Action (Client-Side) CRReport.SetParam Action (Client-Side) CRReport.SetReport Action (Client-Side)
		Changed Functionality	LVX.PrintReport (Server-Side) PrintReport (Server-Side) Modified both of these Actions to reflect current Business Objects and Crystal Reports functionality.
		New Functionality	SendBOReport (Server-Side) New Action added to support Business Objects V6.1a.
SDC Columns	Standards and Restrictions	Document Enhancement	Added information regarding MS SQLServer Column Restrictions, originally pulished as a Release Bulletin.
SDC Columns	SDC Definition Page	Document Enhancement	Added link to MS SQLServer Column Restrictions.
SDC Concepts	Concepts of SDCs, SDIs, and Reference Types	Document Enhancement	Simplified the example. The new example now shows a simple many-to-many link between Users and Roles.
SDC Options	SDC Definition Page	New Functionality	Added the "May Be Scheduled" option, which allows SDIs to be used as Sources by Schedule Plan Items.
SOM	Concepts of Actions	Changed Functionality	Changed Language Requirements to restore VBScript functionality.
SOM	User Action Reference for SOM Services	Changed Functionality	Added note (The SOM and SOMWS) stating that Server-Side VBScript Actions will run by installing new .NET component and Web service.
Specifications	Concepts of Specifications	Document Enhancement	Enhanced all diagrams to make them more readable.
System Actions	System Action Reference	Changed Functionality	Deleted explanation of DM0204 method of VBScript Action processing and replaced it with a reference to the new explanation in the V3 Installation and Upgrade Procedures.
		Document Enhancement	AddSDIAttachment (Server-Side) Changed descriptions to make Action less LVX-specific.
		New Functionality	AddSDI (Server-Side), AddSDIWorkitem (Server-Side), ApplySDIWorkitem (Server-Side) Added new "forcenew" property to always create new Data Sets and Workflow Instances. Added properties "templatekeyid1", "templatekeyid2", and "templatekeyid3" for basing new SDIs on an existing SDI Template identified by more than one key. AddSDIWorkitem (Server-Side) now also contains a "propsmatch" property for selective operation of multi-value properties. DeleteDataSet (Server-Side) Added new "forcedelete" property to delete Data Sets containing data. DeleteSDIWorkitem (Server-Side) Added new "cascadedeletes" property to delete Workitem Items from an SDI. Reporting See Reporting for changes made to support reporting applications.
		Changed Functionality	AddSDIWorkflow (Server-Side) and StartWorkflow (Server-Side) Changed the "Workflow Instance" property description. This property has been removed from SAPPHIRE DM0205. For legacy issues with users who have upgraded, the description has been changed to indicate that this property should be left blank (the Actions always create a new instance). Reporting See Reporting for changes made to support reporting applications. Start Workplan (Server-Side) Added a note to indicate that this Action has been removed from Core data and is no longer used. This does not affect upgrading users, as this Action was formerly used only by internal LABVANTAGE development.
Translation	Language Maintenance Page Language Translation Master List Page	New Functionality	Added "Web" to the list of translation text types. This lets you use the new translation features in the SAPPHIRE Java API (<sapphire:translate> tag, property value translation in the Web Page Designer, and methods in the Translation Processor class).
Translation	Language Translation Master List Page	Document Correction	Deleted information concerning partial string search, which was never implemented in this page.
Workgroups	Concepts of Workgroups Workgroup Maintenance Page Workgroup Type Maintenance Page	Document Correction	The description of using SDI Templates was misleading. The description led you to believe that you could use the Workgroup Maintenance Page to insert SDI Templates directly into Workgroups. The descriptions have been changed to indicate that you must use the Workgroup Type Maintenance Page to insert SDI Templates according to the specified insertion rules.

History of Changes During SAPPHIRE DM0204

Top

Changes Made in Document Revision 010414-DM0204

Topic

Reason for Change

Comments

All

Document Enhancement

To identify the SAPPHIRE build supported by this document, the SAPPHIRE Development Milestone has replaced the SAPPHIRE Version number in the Document Revision code.

Concepts of Actions

Changed Functionality

Modified entire topic to reflect new policy regarding User Actions written in VBScript and Powerbuilder, i.e., you can no longer use these languages to write Server-Side Actions.

In Java Action Processing, added a "Workers" section to describe new default setting for APQ workers (now always default to 1 after Jaguar starts), with instructions for changing this value.

Concepts of Users, Roles, and Profiles

Changed Functionality

Modified user descriptions to reflect new licensing strategy (changes to Virtual Named User definition and addition of Virtual Concurrent User).

Concepts of Workflows

Changed Functionality

Removed all references to VBScript.

In Server-Side Workflow Processing, added a "Workers" section to describe new default setting for TDQ and WPQ workers (now always default to 1 after Jaguar starts), with instructions for changing these values.

Data Locking

Changed Functionality

In the section Data Locking in Actions, modified to describe new data locking strategy, i.e., data are unlocked by default, and can be locked on a per-Action basis or en masse in a Server-Side Workflow.

Explorer Bar, Profile, and Page Properties

New Functionality

Added new Profile Property "Disable User on Expiry". This was added to provide functionality required by the new Password Validators. Also changed descriptions of other password-related properties to reflect support for both LVX and Web Applications. See the SAPPHIRE Java API Functional Specification for information concerning the Password Validators.

Added new Profile Property "Lock Workflow Actions". This supports the new data locking strategy (also see Data Locking).

Glossary

Changed Functionality

Modified to reflect new policy regarding User Actions written in VBScript and Powerbuilder, i.e., you can no longer use these languages to write Server-Side Actions.

List Pages

Document Enhancement

Added section (About Deleting SDIs) to explain that, in most cases, deleting an SDI results in simultaneous deletion of all records associated with it.

Parameter List Maintenance Page

Changed Functionality

Removed all references to VBScript.

System Action Reference

New Functionality

AddCategoryItem (Server-Side)
New Action to add SDIs to Categories.

AddListItem (Server-Side)
Added new feature to description of the Index property (if undefined, adds item to end of list).

AddReplicate (Server-Side)
New Action to add Replicates of Parameters already existing in a Data Set.

AddSDIRole (Server-Side)
New Action that adds Roles to SDIs.

DeleteCategoryItem (Server-Side)
New Action to remove SDIs from Categories.

DeleteSDIRole (Server-Side)
New Action that adds Roles to SDIs.

ExtendDataSet (Server-Side)
New Action to add new Parameters to Data Sets.

GetListItem (Server-Side)
Added new feature to description of the Index property (if undefined, returns last item in list).

MaintForm.SelectTab Action (Client-Side)
MaintGrid.SelectTab Action (Client-Side)
Added new value for tab (workitem). Also added values not visible in LVX, and updated the syntax for specifying fk and mtm values.

SendCrystalReport (Server-Side)
New Action. This works only with reports generated using Crystal Enterprise Professional Edition, Version 9. It sends a report to the Crystal Enterprise APS (Automated Process Scheduler) and provides it with instructions for printing, emailing, or storing the report.

Changed Functionality

AddDataItem (Server-Side)
Added a note stating that this Action has been deprecated. It has been replaced by AddReplicate and ExtendDataSet.
Added new "applylock" input property to support data locking on a per-Action basis (also see Data Locking).

AddSDI (Server-Side)
Added new input properties: "adduserroles" and "addtemplateroles".
Removed all references to VBScript.

EditDataSet (Server-Side)
Removed all references to VBScript.

EditSDI (Server-Side)
Removed all references to VBScript.

EditSDIAddress (Server-Side)
Removed all references to VBScript.

Added new "applylock" input property to the following Actions. This supports data locking on a per-Action basis (also see Data Locking).

AddChargeListItem	EditDataItem
AddDataItem	EditDataSet
AddDataSet	EditPriceListItem
AddDetailSDI	EditSDI
AddPriceListItem	EditSDIAddress
AddSDIAddress	EditSDIDetail
AddSDIAttachment	EnterDataItem
AddSDIDetail	EnterDataSet
AddSDISpec	ReleaseDataItem
AddSDIWorkflow	ReleaseDataSet
AddSDIWorkitem	RemoveSDISpec
ApplyDataItemLimits	ResetDataSet
ApplyDataSetLimits	SetDataItemDate
CopyDataSet	SetDataItemNumber
DeleteChargeListItem	SetDataItemString
DeleteDataItem	SetDataSetDate
DeleteDataItemLimit	SetDataSetNumber
DeleteDataSet	SetDataSetString
DeletePriceListItem	SetSDIDate
DeleteSDI	SetSDINumber
DeleteSDIAddress	SetSDIString
DeleteSDIDetail	SetSDIWIIComplete
EditChargeListItem	UnReleaseDataItem
EditDataApproval	UnReleaseDataSet

Document Correction

GetApprovalFlag (Server-Side)
Made the four Data Set input properties mandatory. This description formerly stated that they could be left blank.

User Action Reference for SOM Services

Changed Functionality

Added a requirement to reflect new policy regarding User Actions written in VBScript and Powerbuilder, i.e., you can no longer use these languages to write Server-Side Actions.

User Maintenance Page

New Functionality

Added note to indicate the Password Validator now checks all passwords. Also emphasized case-sensitivity.

History of Changes During SAPPHIRE V3.1.2

Top

Changes Made in Document Revision 030828-3.1.2

Topic	Reason for Change	Comments
Action Maintenance Page	Document Enhancement	Under the Properties tab, listed only the Property Types you can use in SAPPHIRE. Also added a note stating that you should not use any of the other Property Types listed in the Action Maintenance Page.
Concepts of Users, Roles, and Profiles	Document Enhancement	Generated new diagram to more accurately describe the purpose of Role Level Access and SDC Privileges.
Database Definition Toolkit	Changed Functionality	In the section Deleting User SDCs, updated to reflect new name for the file that deletes User SDCs from Oracle databases (changed from SDCKill.sql to KillSDC.sql). Also modified instructions to point to SAPPHIRE Installation and Upgrade Procedures for new instructions to set the location of this file. These new instructions provide a script that creates the destination folder for you.
Database Definition Toolkit	Document Enhancement	In the section Importing and Exporting SDIs, added a note stating that this is not an archiving tool and does not synchronize the database.
Data Entry Page	Changed Functionality	In the section Entering and Releasing Data, added an Auditing section describing how the chosen Audit Option is now exercised when Releasing and Unreleasing Data Items.
Data Locking	Document Enhancement	Modified the definition to more accurately state the purpose of data locking.
Explorer Bar, Profile, and Page Properties	Document Correction	In Profile Properties: Removed "Yes or No" as possible values of Required Custodian Type property (typographical error). Changed "Password Expiry Days" property to specify the number of days prior to expiration of the password.
Expression Editor Dialog	Document Correction	In the section Calculation Rules, rewrote the description of Returning Text from a Calculation. This formerly stated that the variable [this] was permitted in calculation expressions. It is not.
EventNotify and EventGoTo: Concepts and Example	New Functionality	Added the following to the list of Actions having an "eventnotify" input property: AddWorkgroupItem Action (Server-Side) DeleteWorkgroupItem Action (Server-Side) EditWorkgroupItem Action (Server-Side)
List Pages	Changed Functionality	In Working with SDIs in the List, added new information concerning the result of removing the Edit button.
LVX Logon/Connection Dialog	Document Enhancement	Added a note about case-insensitivity of Username and Password.
Query Maintenance Page	Document Enhancement	Added additional information concerning Absreldt and SQL Argument Types. Also recommended against using Argument Types that are not described in this document. Added an example of using the [%currentuser%] variable, and added a link to the Variables section of General Information Concerning System Actions. Changed the description of the "Test" button to indicate that it does not test the Query under actual conditions.
Query Maintenance Page	Changed Functionality	In the Usage section (specifically the SQL Statements description), changed the description of the "From [SDC]" field to indicate that you now must add the comma when specifying column names. SAPPHIRE previously installed the comma for you, but this prevented hints from being added to MS SQLServer select statements when dealing with dirty records (see the SAPPHIRE V3.1.2 Release Bulletin issued 14 March 2003).
Standards and Restrictions	Document Enhancement	Added absolute date and time to Date and Time Syntax section.
System Action Reference	Document Correction	In the description of the eventnotify property for the following Actions, changed the note about enetering Yes/No values in User Actions to specify upper-case "Y" and "N" values. Tests have shown that the value of the "eventnotify" input property for these Actions is case-sensitive. AddSDI (Server-Side) AddChargeListItem (Server-Side) AddPriceListItem (Server-Side) AddWorkgroupItem (Server-Side) ApplyDataItemLimits (Server-Side) ApplyDataSetLimits (Server-Side) Apply SDISpecs (Server-Side) DeleteChargeListItem (Server-Side) DeletePriceListItem (Server-Side) DeleteWorkgroupItem (Server-Side) EditChargeListItem (Server-Side) EditPriceListItem (Server-Side) EditSDI (Server-side) EditWorkgroupItem (Server-Side) EnterDataItem (Server-Side) EnterDataSet (Server-Side) ReleaseDataItem (Server-Side) SetSDIDate (Server-Side) SetSDINumber (Server-Side) SetSDIString (Server-Side) AddDataItem (Server-Side) Changed description of paramlistcheck property and example of how to specify multiple property values. AddSDIAttachment (Server-Side) LVX.AddSDIAttachment (Client-Side) Changed possible values of "type" property from "reference" and "store" to "R" and "S", respectively. AddWorkgroupItem (Server-Side) Changed example of how to specify multiple property values.
	Document Enhancement	AddSDIDetail (Server-Side) Modified the example to include properties required for data entry. The previous example added the Parameter to the Parameter List, but did not allow data entry. The new example lets you see the Action work in a Data Entry Page. AddSDIWorkitem (Server-Side) Added more information to the description of each property. General Information Concerning System Actions Added Case of SDI Keys section to note the case-sensivity of SDI key ids.
	Changed Functionality	AddSDIWorkflow (Server-Side) Changed to reflect enhancement that lets you add Workflows to SDI Templates. AddWorkgroupItem (Server-Side) Changed description of workgroupitemid attribute to reflect changes in functionality discovered in V3.1.2. This property formerly was an integer that specified a place in the Workgroup. It is now the keyid1 of the Workgroup Item. DeleteWorkgroupItem (Server-Side) Changed property identifier of itemkeyid1 to itemkeyid (also changed name from Item Key1 to Item Key Id). There is no indication when this change occurred in the application. IsMatch (Server-Side) IsNull (Server-Side) Input properties for SDI key ids were formerly not case-sensitive. They are now case-sensitive to increase efficiency in large databases and make these Actions consistent with all others. Added a section to the General Information topic for Actions (see General Information Concerning System Actions above) noting the case-sensitivity of all SDI key ids. Also added a note to the "value" property of the IsMatch Action stating that the "value" remains case-insensitive.
	New Functionality	ApplySDIWorkitem (Server-Side) New Action to supply functionality not easily achieved with the AddSDIWorkitem Action. DeleteSDIAttachment (Server-Side) New Action to delete SDI Attachments. EnterDataItem (Server-Side) Added "auditreason" property.
User Action Reference for SOM Services	Document Correction	Added the "databaseid" argument to the example syntax provided for the ConnectToServer function (it is stated as a mandatory argument in the "Arguments" section).

Changes Made in Document Revision 030408-3.1.2

Topic	Comments
All	Changed the name of this document and modified all references to it. Changed all references to the "SAPPHIRE Java Developer's Guide", which has been renamed to "SAPPHIRE Core Application Java API Functional Specification". It will be published with the next SAPPHIRE release.
Address Maintenance Page	Changed AddressSDI identifier from "Address" to "Contact". In Required Reading section, added link to SDI Maintenance Pages.
Chain of Custody	Rmoved note describing an SDI Maintenance Grid Page Property that seems to have been removed at some time between V3.0 and V3.1.
Column Painter for SDI List Pages	Added new feature to change SDI sort order.
Concepts of SDCs, SDIs, and Reference Types	Updated definitions and regenerated illustrations (they were illegible when printed).
Concepts of Specifications	Changed math expression fonts (some embedded fonts were incorrectly interpreted by Windows 2000 and XP).
Concepts of Workflows	Rewrote definition and regenerated illustrations (they were illegible when printed).
Database Definition Toolkit (DDT)	Removed the note stating that the Import/Export Utility is not a released feature. It was formally released in build DM0203.011.09 of V3.1.1 (13 November 2002). Also in the Import/Export Utility, added new handling of contentions, and new "Replace" option.
Data Entry Page	In the Entering and Releasing Data section, added new maximum numerical input value of one trillion.
Explorer Bar, Profile, and Page Properties	In Profile Properties, changed the maximum allowable value of the Max Trigger Count property to 100. In SDI Maintenance Page Properties, removed the "Show FK Tabs" property. In SDI List Page Properties, added link to Column Painter.
Expression Editor Dialog	Added new astmround( x, n ) aggregate function.
Form Painter Page	Updated toolbar illustration.
Glossary	Modified definition of Address to avoid confusion between Address SDIs and Contacts.
Parameter List Maintenance Page	Changed math expression fonts (some embedded fonts were incorrectly interpreted by Windows 2000 and XP). Referenced new ASTMRound Display Format to the Expression Editor Functions, which include an example.
Report Page	Added note stating that you must register a B.O. report prior to viewing it in a JSP.
SAPPHIRE System Configuration	For Connection Cache settings under the Application Server tab, added the newly-discovered "Edit" function, and added more information to the cursory descriptions of property values.
SDC Definition Page	Added a note to the Columns Tab section stating that, when adding an SDC column, you cannot specify a LOB-type column even though LVX offers the choice.
SDI Maintenance Pages	Updated description of Reverse Foreign Key functionality and added new "Remove" button functionality. Fixed a broken link in the "Addresses" section. Modified description of Addresses to avoid confusion between Address SDIs and Contacts.
SDI Maintenance Grid Pages	Added new feature that lets you display Reverse Foreign Key links in a column and insert the linked SDC tab in the lower pane of the Page.
Specification Maintenance Page	Changed math expression fonts (some embedded fonts were incorrectly interpreted by Windows 2000 and XP). Added new Rpt and Display Format facilities for displaying Specification Limits on Reports.
Standards and Restrictions	Updated Special Characters section.
System Action Reference	Modified the following Actions: AddSDIAddress (Server-Side) Modified description to avoid confusion between Address SDIs and Contacts. DeleteDataSet (Server-Side) Added note indicating that this Action deletes all Data Sets associated with the SDI(s) if you do not specify any Data Set property values. DeleteSDIAddress (Server-Side) Modified description to avoid confusion between Address SDIs and Contacts. EditDataItem (Server-Side) Added newly-discovered properties. EditSDIAddress (Server-Side) Modified description to avoid confusion between Address SDIs and Contacts. SendMail (Server-Side) Changed name of "filename" property. Added the following new Actions: AddCOCEntry (Server-Side) Starts a Chain of Custody or adds to an existing one. CheckCustodian (Server-Side) Determines if a Custodian exists and verifies the Custodian's password. MaintForm.SetAttrib (Client-Side) Lets you set the attributes of objects in an SDI Maintenance Form. Corrected a typographical error in the Variables section of the topic General Information Concerning System Actions. In the example of using a variable to define a portion of a value, [sdi]Description was erroneously specified as [sdc]Description.

SAPPHIRE V3.1.2 Release Notes

Top

The following changes were made in SAPPHIRE V3.1.2.

Functionality	Description
Actions	The following new Actions have been added: AddCOCEntry (Server-Side) Starts a Chain of Custody or adds to an existing one. CheckCustodian (Server-Side) Determines if a Custodian exists and verifies the Custodian's password. MaintForm.SetAttrib (Client-Side) Lets you set the attributes of objects in an SDI Maintenance Form.
Data Entry	When entering a numerical value in the Data Entry Page, SAPPHIRE now accepts a maximum value of one trillion (see Data Entry Page above).
Import/Export Utility	When importing, the Import/Export Utility in the DDT Page now handles contentions differently, and now includes a Replace option, which overwrites existing items in your database. This means you no longer need to delete them before importing their replacements.
Installation and Upgrade	The form synchronization process has been removed from the standard upgrade scripts and placed in a separate XML job file. After you have successfully complete an installation or upgrade, you must run this file to synchronize your SDI Maintenance Forms. See the SAPPHIRE Installation and Upgrade Procedures.
Parameter Lists	There is a new Display Format (ASTMRound in Parameter List Maintenance Page) and aggregate function (astmround(x,n) in the Expression Editor) to support ASTM rounding rules. The Expression Editor Functions contain an example.
SDI List Pages	The Column Painter now lets you change the default order in which SDIs are listed.
SDI Maintenance Page	When an SDI Maintenance Form opens, focus is now set to the lowest tab number you have defined in the Form Painter. New "Remove" button functionality.
SDI Maintenance Grid Page	The Description column now validates to ensure that the 80-character length is not exceeded. You can now choose to display Reverse Foreign Key links in a column. This also puts the linked SDC tab in the lower pane of the SDI Maintenance Grid. For example, if there is an SDC Link from the Project column of the Sample SDC to the Project SDC, and you choose the Reverse FK column selection, a Project Id tab is inserted in the lower pane of the SDI Maintenance Grid Page.
Specifications	New "Rpt" and "Display Format" facilities are available in the Specification Maintenance Page for displaying Specification Limits on Reports.

History of Changes During SAPPHIRE V3.1.1

Top

Changes Made in Document Revision 020912-3.1.1

Topic	Comments
Concepts of Workflows	In Server-Side Workflow Execution, added information currently available concerning Action Block error retry, Workflow error notification, the Workplan Startup Service, and links to topics that describe the new Workflow Action auditing features.
Data Entry Page	Added link to new topic Data Locking.
Data Entry Grid Configuration	Added new Parameter List Options to restrict display (and thereby locking) of Parameter Lists.
Data Locking	This is a new topic that has been added to introduce the new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs.
EventNotify and EventGoTo: Concepts and Example	Added ReleaseDataItem (Server-Side) to list of Actions having an "eventnotify" Input Property.
Expression Editor Dialog	Fixed a broken hyperlink.
SAPPHIRE Error and Status Messages	Added SPM error 103 and SSC errors 702, 704.
System Action Reference	Modified the following Actions: AddPriceListItem (Server-Side) Modified to reflect new properties. AddSDI (Server-Side) Modified to reflect new functionality (now adds User Roles from an SDI Template when Role Level Access is enabled). DeletePriceListItem (Server-Side) Modified to reflect new properties. EditChargeListItem (Server-Side) Modified to reflect new properties. EditPriceListItem (Server-Side) Modified to reflect new properties. MaintGrid.AddDS (Client-Side) Modified to add new functionality (rownumber property can now take an (All) value). MaintGrid.AddSpec (Client-Side) Modified to add new functionality (rownumber property can now take an (All) value). MaintGrid.AddWF (Client-Side) Modified to add new functionality (rownumber property can now take an (All) value). ReleaseDataItem (Server-Side) Added "eventnotify" Input Property. SendMail (Server-Side) Modified to add new functionality (can now send multiple attachments). SetSDIDate (Server-Side), SetSDINumber (Server-Side), and SetSDIString (Server-Side) Modified to add new functionality (can now set value in multiple columns). Set SDIWIIComplete Added newly-discovered functionality. Added the following new Actions: AddWorkgroupItem (Server-Side) DeleteWorkgroupItem (Server-Side) EditWorkgroupItem (Server-Side) MaintForm.AddRole (Client-Side) MaintForm.DeleteRole (Client-Side) MaintGrid.AddRole (Client-Side) MaintGrid.DeleteRole (Client-Side) Deleted the following Actions: DataEntry.StartAgent (Client-Side) DataEntry.StopAgent (Client-Side)
SAPPHIRE System Configuration	In the Application Server Tab: Updated the Application Server Properties to describe only admindb, smtphost, and trace (taskpoll, tdlpoll, and timeoutpoll have been removed). Added description of "trace" Application Server Property. Removed "Disable Trace" option. Updated "Set Password" description. Added procedure for importing a WAR file over an existing one of the same name. Added descriptions of Web Application properties, including a reference to the SAPPHIRE Java Developer's Guide. In the Databases Tab: Added new "Retry lock error" settings to Database Properties dialog (accessed from the Properties button). These let you set the number of times SAPPHIRE will retry a Workflow if an Action Block fails due to a data locking contention, as well as the time between retry attempts.
SDI Maintenance Pages	Added link to the Data Locking topic, which describes the new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs. Added new "View Error" feature in Workflow tab to view Server-Side Workflow errors.
SDI Maintenance Grid Pages	Added link to the Data Locking topic, which describes the new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs.
User Action Reference for SOM Services	Added a Potential Problems section, which identifies conditions that cause problems with VBScript Actions, and provides guidelines for avoiding trouble.
Workflow Painter Page	Added new feature to enable/disable Action auditing (see Auditing Actions). Guidelines for viewing audit results are in the Workplan Viewer Page (also see Workplan Viewer Page below).
Workplan Status Page	Added new "Retry State" feature. In the event of Server-Side Workflow failure, this lets you restart it at the failed State (see Workflows (Server-Side) in the SAPPHIRE V3.1.1 Release Notes below. Removed "Next State" feature (it has been replaced by "Retry State"). Added new "View Error" feature that lets you view Server-Side Workflow errors.
Workplan Viewer Page	Add new feature to view results of Action auditing (see Action History).

SAPPHIRE V3.1.1 Release Notes

Top

The following changes have been made in SAPPHIRE V3.1.1.

Functionality

Description

Actions

Modified Actions

The following Actions have been modified:

AddPriceListItem (Server-Side)
All Properties have been modified to resemble the AddChargeListItem Action.

AddSDI (Server-Side)
Now adds User Roles from an SDI Template when Role Level Access is enabled.

DeletePriceListItem (Server-Side)
All Properties have been modified to resemble the DeleteChargeListItem Action.

EditChargeListItem (Server-Side)
All Properties have been modified to resemble the EditPriceListItem Action.

EditPriceListItem (Server-Side)
All Properties have been modified to resemble the EditChargeListItem Action.

MaintGrid.AddDS (Client-Side)
The rownumber property can now take an (All) value.

MaintGrid.AddSpec (Client-Side)
The rownumber property can now take an (All) value.

MaintGrid.AddWF (Client-Side)
The rownumber property can now take an (All) value.

ReleaseDataItem (Server-Side)
A new "eventnotify" Input Property has been added.

SendMail (Server-Side)
You can now send multiple attachments.

SetSDIDate (Server-Side), SetSDINumber (Server-Side), and SetSDIString (Server-Side)
You can now set a value in multiple columns.

New Actions

The following new Actions have been added:

AddWorkgroupItem (Server-Side)

DeleteWorkgroupItem (Server-Side)

EditWorkgroupItem (Server-Side)

MaintForm.AddRole (Client-Side)

MaintForm.DeleteRole (Client-Side)

MaintGrid.AddRole (Client-Side)

MaintGrid.DeleteRole (Client-Side)

Deleted Actions

The following Actions have been deleted:

DataEntry.StartAgent (Client-Side)

DataEntry.StopAgent (Client-Side)

Deprecated Actions

The following Actions have been deprecated:

Agent.Speak (Client-Side)

Agent.Start (Client-Side)

Agent.Stop (Client-Side)

Data Locking in Actions

MAY AFFECT BACKWARD COMPATIBILITY

Server-Side Actions that currently modify SDIs and/or Data Sets now lock the SDI or Data Set while the Action is processing. Depending upon how you have been using these Actions, this may affect compatibility with Actions you have written using previous versions of SAPPHIRE.

For a list of affected Actions, see the topic Data Locking (specifically the section Data Locking in Actions).

Data Entry

SAPPHIRE employs a new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs.

New Grid Configuration options let you restrict display and locking of Parameter Lists available for data entry.

Data Locking

SAPPHIRE employs a new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs.

JSPs
(SAPPHIRE Custom Tags)

The following changes are described in the SAPPHIRE Java Developer's Guide:

sdi Tag

This tag now supports the new data locking strategy with the following new attributes:

primarylock (locks only the "primary" result set)
datalock (locks only the "dataset" result set)
paramlistid, paramlistversionid, variantid, dataset (lets you retrieve a result set containing a specific Data Set)

This tag still supports the lockoption attribute, which will lock both the "primary" and "dataset" result sets.

You can request any of the following data to be returned as a "dataset" Result Set Type:

sdidata
sdidataitem
sdidataitemlimits
sdidataapproval
sdidataitemspec

sdiif Tag

This tag has two new values for the condition attribute:

locksuccess (perform an operation if data have been successfully locked)
lockfailure (perform an operation if data have not been successfully locked)

These values are equivalent in principle to the previous (but still supported) lockedrow and unlockedrow values.

SDI Maintenance

SAPPHIRE employs a new data locking strategy for Data Entry, SDI Maintenance, Actions, and JSPs.

SAPPHIRE System Configuration (SSC)

The SAPPHIRE upgrade utility now removes the taskpoll, tdlpoll, timeoutpoll (sapphire.server) properties from the Application Server tab. It now has only three properties: admindb, smtphost, and trace.

Workflows
(Server-Side)

Action Block Error Retry

In a Server-Side Workflow, if an Action Block fails to execute due to a data locking contention, the Workflow engine restarts the Action Block and repetitively tries to execute it. The SSC lets you set values for the two properties that control the retry:

"Retry lock errors" (default = 12) is the number of times the Workflow engine attempts to execute the Action Block.

"With delay of" (in seconds, default = 300) is the time period between attempts.

The SysConfig database table holds these values in the columns MaxTriggerRetry and TriggerDelay.

The RetryCount column has been added to the SDIWorkflow table. This column logs the number of times the Workflow engine has attempted to execute the Action Block.

Workflow Error Notification

A View Error button has been added to the Workplan Status Page and the Workflow tab of SDI Maintenance/Maintenance Grid Pages. This lets you view errors that have occured during Workflow execution. The Errortext column in the SDIWorkflow table logs the error text, and is populated automatically when the first error is generated by the Workflow engine.

The "Next State" button in the Workplan Status Page has been renamed to "Retry State". If a Workflow fails, you do not have to restart the Workflow from the beginning... just do this:

a.	Fix the problem.
b.	Open the Workplan Status page.
c.	Select the State in which the Workflow stopped.
d.	Click Retry State. Workflow execution should resume.

Workflow Action Auditing

Actions running in the Workflow are now audited. You enable/disable auditing in the Workflow Painter Page. You can view audit results in the Workplan Viewer Page.

Workplan Startup Service

The Workplan Startup Service now attempts to restart only Workflows with a status of "Active". It ignores all other Workflows, such as those in a Wait State.

Workgroups and Workgroup Types

The SDCId column in the Workgroup and WorkgroupType SDCs has been renamed to ItemSDCId. For example, if the Workgroup contains Samples, the Sample is now in the ItemSDCId column. The Workgroup and Workgroup Type Maintenance Pages do not reflect this change, i.e., the SDC drop-list is still labeled "SDC".

This was done to let you create Workgroups and Workgroup Types using the AddSDI Action. Prior to this change, if you ran Samples through a Server-Side Workflow, and you used the AddSDI Action to create a Workgroup while in the Workflow, the Workflow used its implicit SDCId property (the value of which would be Sample) to overwrite the SDCId property that identified the Workgroup.

MAY AFFECT BACKWARD COMPATIBILITY

If you have previously made any custom Workgroup Forms (using the Form Painter Page), you must perform the following steps in order to see values in the new column (ItemSDC) on your forms:

a.	Open the SDC List Page.
b.	Right-click the Workgroup SDC.
c.	Click Synchronize Default Form. This synchronizes the database columns with the forms.

If this does not work, you may have to revert to the default form. However, if you do this, be advised that you will lose all of your custom forms. If you still choose to revert to the default form, click Reset Default Form, then click Synchronize Default Form.

History of Changes During SAPPHIRE V3.1

Top

Changes Made in Document Revision 020712-3.1

Topic	Comments
System Action Reference	Modified the following Actions: AddChargeListItem (Server-Side) Added Input Properties not available when V3.1 was released. AddDataItem (Server-Side) Added "paramlistcheck" Input Property. Changed description to reflect new functionality. AddSDIWorkitem (Server-Side) Added "applyworkitem" Input Property.
User Action Reference for SOM Services	Modified VBScript examples to utilize new syntax for calling functions on SOM components (see SOM Memory Leak in the V3.0 Release Notes). Added note about the deprecation of dot notation between a SOM component and its function (also related to the SOM Memory Leak). Added notes about the deprecation of EnableServicePool and DisableServicePool functions. Added the new ConnectToServer and DisconnectFromServer functions, which you should use in place of EnableServicePool and DisableServicePool for all future VBScripts. Modified the EnableServicePool function as follows: Removed all arguments previously used to enable remote services. Removed "local" argument. Changed "userid" and "pwd" argument descriptions to specify that the user must be an LVX Named User. Removed the CheckUser function.
User Action Examples (APS)	Modified VBScript examples to utilize new syntax for calling functions on SOM components (see SOM Memory Leak in the V3.0 Release Notes).
User Action Examples (FPS)	Modified VBScript examples to utilize new syntax for calling functions on SOM components (see SOM Memory Leak in the V3.0 Release Notes). Included CStr() function to force string data type for variable inputs to PB8 objects.

Changes Made in Document Revision 020625-3.1

Topic	Comments
Concepts of Actions	Updated to include new Java Action processing mechanism. Modified VBScript processing to reflect new architecture. Updated "Nested Actions" section to include User Actions written in Java. Added note discouraging the future use of VBScript and Powerbuilder.
Concepts of Parameters and Parameter Lists	Added note about the deprecation of Parameter Aliases.
Concepts of SDCs, SDIs, and Reference Types	Updated SDC summary and description of Reference Types. Deleted Parameter Alias Type from list.
Concepts of Users, Roles, and Profiles	Added "Concurrent Users".
Concepts of Workflows	Modified Workflow Action Processing to reflect enhancements made to Server-Side Workflow Execution.
Database Definition Toolkit (DDT) Page	Updated to reflect newly-discovered functionality.
Document Contents and Index files	Modified to support topic reorganization, and reparied 19 broken links.
Explorer Bar, Profile, and Page Properties	In Profile Properties: Added "Workitem Pricelists", "BO Domain", "Log Set Users", "Log Set Users Failure", and "Log Action Processes". Also updated "Auto-Fill Master" Property. Deleted "Mail Password", "Mail User Id", "File Location at Remote Site", and "Help File Directory". In SDI Maintenance Page Properties and SDI Maintenance Grid Properties: Changed "Disable Event Notify" property to "Event Notify". The EventNotify feature has changed significantly. Read the topic EventNotify and EventGoTo: Concepts and Example prior to using these properties.
Expression Editor Dialog	Generated new index with more links. Added two examples to rules for "Returning Text from a Calculation".
EventNotify and EventGoTo: Concepts and Example	Expanded and revised to describe the new options available for generating events.
>General Information Concerning System Actions	Added new variable [%currentconnection%] (see Variables).
Glossary	Added Workitems. Added note about the deprecation of Parameter Aliases. In definition of Version, updated versioned SDIs. Deleted "License Key" and "Client Connection Manager". In general, modified some definitions to reflect changes in V3.1.
Java Actions	As of 10 May 2002, information that was in this topic has been moved to a single document titled the "SAPPHIRE Java Developer's Guide".
Java API for SAPPHIRE	As of 10 May 2002, all information concerning Java development has been moved to the SAPPHIRE Java Developer's Guide.
JSPs and Custom Tags	As of 10 May 2002, the SAPPHIRE Java Developer's Guide contains all information currently available regarding Web Page development.
Query Maintenance Page	Add note stating that Generic Queries can not modify Filter Bars in SDI List Pages.
Parameter List Maintenance Page	Generated new index with more links. Added note about the deprecation of Parameter Aliases.
Parameter Maintenance Page	Added note about the deprecation of Parameter Aliases.
Reference	Added note about naming columns for the benefit of those who are thoroughly unfamiliar with relational databases.
SAPPHIRE Architecture	Deleted references to Role Level Access of registered WebPage SDIs. Changed the trade name of the Application Server to to "Sybase EAServer". Deleted information concerning CCM connection to verify License Key information. Replaced with information currently available concerning licensing specified by property file. Removed definitions of SAPPHIRE Users.
SAPPHIRE System Configuration	Updated to reflect the latest round of Application Server configuration features.
SDC Definition Page	Added new Alias feature to functionality summary and updated screen capture. Incorporated information from the now-deleted topic SDC Functionality and Options. Changed description of "Allow Contacts" (an "Addresses" tab is now inserted rather than a "Contacts" tab). Added "EventNotify Options". Added link to SDI Column Naming Restrictions.
SDC Functionality and Options	Deleted topic to facilitate more efficient access to information. Redistributed all information to SDC Definition Page and SDI Maintenance Pages. Deleted 41 links to this page in 34 files, and 23 references in the Contents and Index files.
SDI Maintenance Pages	Added new Alias feature. Incorporated information from the now-deleted topic SDC Functionality and Options. Changed description of Contacts and Addresses (an "Addresses" tab is now inserted rather than a "Contacts" tab). Added the Address Function Reference Type, which is referred to as "Contact Function" elsewhere in SAPPHIRE. Also added explanation of how "Allow Contacts" means you can add "Addresses" that later become "Contacts" again.
System Action Reference	Added the following new Actions: AddPriceListItem (Server-Side) AddSDIAddress (Server-Side) BOReport.GetParam (Client-Side) BOReport.SetParam (Client-Side) BOReport.SetReport (Client-Side) DeleteChargeListItem (Server-Side) DeletePriceListItem (Server-Side) DeleteSDIAddress (Server-Side) EditChargeListItem (Server-Side) EditDataApproval (Server-Side) EditPriceListItem (Server-Side) EditSDIAddress (Server-Side) LookupSQLRow (Client-Side) Modified the following existing Actions: AddSDI (Server-Side) Added newly-discovered functionality. Modified examples. Added EventNotify property. ApplyDataItemLimits (Server-Side) Added EventNotify property. ApplyDataSetLimits (Server-Side) Added EventNotify property. ApplySDISpecs (Server-Side) Added EventNotify property. EditSDI (Server-Side) Added newly-discovered functionality. Modified examples. Added EventNotify property. EnterDataItem (Server-Side) Added EventNotify peoperty. EnterDataSet (Server-Side) Added EventNotify property. EventGoTo (Server-Side) Added specevent and specitemevent Input Properties. Changed description to more accurately reflect functionality. EventGoToExplicit (Server-Side) Added specevent and specitemevent Input Properties. Changed description to more accurately reflect functionality. EventNotify (Server-Side) Changed description to more accurately reflect functionality. GetListItemCount (Server-Side) Added new Output Property "listitemsize". GetWorkflowProperty (Server-Side) Added a comment about using this Action in a Client-Side Workflow. PrintReport (Server-Side) Added new Input Property "emailfrom", changed "Mandatory" status of "destination" to "No", and removed "Crystal Reports Only" caveats from destination definitions. SendMail (Server-Side) Added "filename" Input Property. SetSDIDate (Server-Side) Added EventNotify property. SetSDINumber (Server-Side) Added EventNotify property. SetSDIString (Server-Side) Added EventNotify property. SetWorkflowProperty (Server-Side) Added a comment about using this Action in a Client-Side Workflow. TriggerWorkflow (Server-Side) Added newly-discovered Input Properties. The following changes could not be documented at this time: AddChargeListItem (Server-Side) This is a new Action in V3.1.
User Action Reference for SOM Services	Renamed topic and added note to emphsize that these functions are for use only with SOM services. Added EnableTracing, DisableTracing, and LogTrace functions.
Workflow Construction	Added note about the deprecation of Parameter Aliases.
Workgroup Type Maintenance Page	Changed examples to reflect new functionality.
Workitems	New topic that explains the new Workitem Group feature and how it relates to Standard Workitems. Also added links to this topic in SDI Maintenance Pages.

SAPPHIRE V3.1 Release Notes

Top

The following information describes changes made to SAPPHIRE V3.1.

Functionality

Description

Actions

Recommendation

Beginning with SAPPHIRE V3.1, we strongly discourage using Microsoft VBScript to code your own custom User Actions. We strongly recommend that you code all future Actions in Java.

New Actions

AddPriceListItem (Server-Side)

AddSDIAddress (Server-Side)

BOReport.GetParam (Client-Side)

BOReport.SetParam (Client-Side)

BOReport.SetReport (Client-Side)

DeleteChargeListItem (Server-Side)

DeletePriceListItem (Server-Side)

DeleteSDIAddress (Server-Side)

EditChargeListItem (Server-Side)

EditDataApproval (Server-Side)

EditPriceListItem (Server-Side)

EditSDIAddress (Server-Side)

LookupSQLRow (Client-Side)

NOTE:

The new Action AddChargeListItem (Server-Side) could not be documented at this time.

Modified Actions

GetListItemCount (Server-Side)
This Action now has an output property (List Item Size) that returns a value describing the number of items in the list.

PrintReport (Server-Side)
New Input Property "emailfrom".

SendMail (Server-Side)
New Input Property "filename". The "filetype" Input Property now lets you specify PDF files for Business Objects Reports.

SetWorkflowProperty (Server-Side) and GetWorkflowProperty (Server-Side)
You can now use these Actions to set/get a Client-Side Workflow Property.

Each of the following Actions now has an "eventnotify" Input Property:

AddSDI (Server-Side)

ApplyDataItemLimits (Server-Side)

ApplyDataSetLimits (Server-Side)

ApplySDISpecs (Server-Side)

EditSDI (Server-Side)

EnterDataItem (Server-Side)

EnterDataSet (Server-Side)

SetSDIDate (Server-Side)

SetSDINumber (Server-Side)

SetSDIString (Server-Side)

Each of the following Actions now has two new Input Properties: "specevent" and "specitemevent":

EventGoTo (Server-Side)

EventGoToExplicit (Server-Side)

VBScript Actions in Action Blocks

SAPPHIRE V3.x processes Action Blocks in Server-Side Workflows as a single transaction. If a single Action within the Action Block fails, changes made to the database by the previous Action are rolled back. SAPPHIRE then attempts to re-process the Action Block up to 5 more times.

SAPPHIRE now also processes each individual VBScript User Action (meaning one you have written in VBScript) as a single transaction. This means that if you execute an Action Block consisting of System Actions and VBScript User Actions that modify the database, you must be aware of the following issue concerning Workflow Actions that change data or cause other Actions to change data.

Action Block in V1.x

Action Type	Action Successful?	Data Committed?
System	Yes	Yes
VBScript	Yes	Yes
System	No	No

Action Block in DM0202

Action Type	Action Successful?	Data Committed?
System	Yes	No
VBScript	Yes	Yes
System	No	No

The example above shows Action Blocks in SAPPHIRE V1.x and DM0202. In V1.x, each Action was a single transaction. If the last Action failed (as shown at the left), both the first and second Actions commit the data to the database. In DM0202, since both the Action Block and the VBScript Action are individual transactions, an Action failure may provide unexpected results. As shown in the example at the right, if the last Action fails, only the VBScript Action commits data. The two System Actions roll back for another attempt.

If you must continue to write future User Actions in VBScript, we recommend you split your System and VBScript User Actions to isolate each VBScript User Action in its own Workflow State. SAPPHIRE will then process it as a single transaction. For example:

Portion of Example Workflow Stage

State	Action Block
1	System Action A System Action B System Action C
2	VBScript Action
3	System Action D System Action E

Variables

A new special variable [%currentconnection%] is now available for use (see Variables in the topic General Information Concerning System Actions).

Application Server

SAPPHIRE can operate with the Jaguar CTS provided in Sybase^® EAServer V4.1.

You can now define your own Jaguar password.

When you start the Application Server, the Application Server and database version are logged in the Jaguar.log file.

Database

MS SQLServer

SAPPHIRE V3.1 can operate with Microsoft^® SQLServer 2000.

NOTE
SAPPHIRE V3.1 does not support any other version of Microsoft SQLServer.

Oracle and MS SQLServer

The following table has been added:

rsetitemsds

The following columns have been added:

todolist.propertyclob
workplan.nextstateid
workplan.fromworkplanid
workplan.auditflag
workplanhistory.nextstateid
connection.usertypeflag

The following table has been dropped:

todolistproperty

The following columns have been dropped:

rsetitems.locktypeflag1
rsetitems.locktypeflag2
rsetitems.locktypeflag3
rsetitems.locktypeflag4

Installation and Upgrade

The installation and upgrade procedures have been rewritten.

You can upgrade to the current version of SAPPHIRE only from SAPPHIRE V1.3 or higher.

The installation utility no longer installs third party OCXs.

LVX determines if OCXs are installed before trying to launch them.

A new product file (sapphireproduct.props) replaces the former product.props file.

Installation of a localhost listener is now part of the initial server configuration using the SSC.

Java API

AFFECTS BACKWARD COMPATIBILITY

Since V3.0, many changes have been made to the Java API for SAPPHIRE. Most recently:

Constructors in the sapphire.accessor package have changed

Class sapphire.accessor.ConnectionProcessor has changed

SAPPHIRE Custom Tags (JSP)
In addition to changes, we have fixed a bug associated with the sdiif tag. Data Entry JSPs supplied with V3.1 contain modifications that take advantage of this fix. Data Entry JSPs supplied with the Demo prior to SAPPHIRE V3.1 will not compile with V3.1. Replace your old Data Entry JSPs with the new ones shipped with this version of SAPPHIRE.

These changes have been incorporated into the SAPPHIRE Java Developer's Guide.

JSPs

The BOAPI calls have been removed from sapphirehead.jsp. This means you can now load non-BO JSPs into the Web Application framework without running Business Objects.

The SDI tag now has an "eventnotify" attribute (true or false) to enable/disable the EventNotify mechanism.

EventNotify Mechanism

MAY AFFECT BACKWARD COMPATIBILITY

We have made significant changes to the EventNotify mechanism, which posts an EventNotify Action onto the ToDo List in response to an event.

You can now enable and disable the EventNotify mechanism. This has necessitated adding an "eventnotify" Input Property to 10 System Actions, and the addition of two new events (see "Actions" above).

Regarding installation and upgrade:

Installation on a New Database

If you have installed SAPPHIRE for the first time and have a clean, newly populated database, EventNotify is disabled for all EventTypes at the SDC, Page, and Action levels. To generate an EventNotify in this case, you must enable it as described in the topic EventNotify and EventGoTo: Concepts and Example.

Upgrading a Database

If you have upgraded your database to this release of SAPPHIRE, EventNotify is disabled unless you have previously used it in conjunction with the EventGoTo Action. In this case, the value of the EventNotifyableFlag (sic) column in the SDC table is set to E or D prior to the upgrade, so EventNotify will continue to function where you used it.

In cases where you have not previously used EventNotify, it will be disabled after the upgrade. If you want to use it, you must enable it as described in the topic EventNotify and EventGoTo: Concepts and Example.

For details concerning the new EventNotify mechanism and EventNotify Options, read the following topic, then follow the "Related Topics" links from there:

EventNotify and EventGoTo: Concepts and Example

Licensing

A new, encrypted, customer-specific license file (sapphire.lic) replaces the former license.props and sapphire.props files. This new license file can now define "Concurrent Users" and an Expiry Date. A "Concurrent User" is a new type of SAPPHIRE User (see Concepts of Users, Roles, and Profiles for details).

Powerbuilder API

You can define a disable bind option for LVX connections.

Profile Properties

A new Profile Property (Workitem Pricelists) lets you prevent Price Lists from containing anything except Workitem SDIs (see Profile Properties).

SDC Options

A new SDC Option (Allow Aliases) lets you specify alternate names for SDI identifiers (see SDC Definition Page and SDI Maintenance Pages).

SOM

Three new functions (EnableTracing, DisableTracing, and LogTrace) let you trace SOM activity (see User Action Reference for SOM Services).

SSC

MAY AFFECT BACKWARD COMPATIBILITY

The SSC now has a "Disable Trace" option that lets you disable tracing in the Jaguar.log file. Tracing is disabled by default following SAPPHIRE installation.

SSC Server Properties are now disabled by default. This means the property values are not written into the srv.log file.

Server Properties "taskpoll", "tdlpoll", "timeoutpoll", and "connectiontimeout" have been moved to the "Database Properties" dialog (accessible from the Properties button under the Databases tab).

Workflows

The performance and reliability of Server-Side Workflow processing has been improved (see Concepts of Workflows).

SAPPHIRE V3.1 does not yet audit Actions in Workflows.

Workgroups

You can now add multiple SDI Templates at a position in the Workgroup. For details, see Workgroup Type Maintenance Page.

Workitems

You can now build a Workitem Group that contains multiple Workitems (see Workitems).

History of Changes During SAPPHIRE V3.0

Top

Help Build 30.020107

Topic	Comments
Concepts of Users, Roles, and Profiles	Modified description of Virtual Named Users.
SAPPHIRE Architecture	Modified description of Virtual Named Users.
SAPPHIRE System Configuration (SSC)	Updated to include Build 015 functionality.
SDC Definition Page	Updated Audit Options. Updated Data Type choices.
SDC Functionality and Options	Updated Audit Options.
SDI Maintenance Pages	Updated Audit Options.
User Action Reference	Added a "Required Reading" section. In the description of EnableServicePool, referenced the feature in the Action Maintenance Page that automatically creates a connection between the SOM instance and the database.
Version Control Maintenance Page	Removed User (meaning user-created) SDCs from the list of versionable SDCs. Versioning was never implemented for User SDCs.

Help Build 30.011204

Topic	Comments
Address Maintenance Page	New topic, added specifically to supplement PrintReport Actions. Added notes concerning how to specify printer in Win2000 and Win98. Also specified which fields in the "Other Information" section are inactive.
BO Report Page	New topic added to support Business Objects report viewer.
Concepts of SAPPHIRE Reporting	New topic.
Document Contents and Index files	Rebuilt the Table of Contents and Index to this document. Formerly, clicking any Contents or Index entry jumped to the top of the relevant page. Now, clicking any entry sends you directly to the relevant section of that page.
Explorer Bar, Profile, and Page Properties	Added warning concerning the necessity of pressing "Enter" after inputting text values for properties. BO Report Page Properties New topic added to support BO Report Pages. Crystal Report Page Properties and Infomaker Report Page Properties Updated description of "Report" property. Added more information concerning "Parameter" properties. Added "Initial Zoom" and "Toolbars" properties.
List Pages	Updated warnings concerning deletion of SDCs.
Property Configuration Page	Added warning concerning the necessity of pressing "Enter" after inputting text values for properties.
Report Page	Moved all information concerning report generation and printing to the topic Concepts of SAPPHIRE Reporting.
SDC Definition Page	Updated screen capture.
SDC Functionality and Options	Corrected typo in explanation of Workitems "Force New" option. The second Data Set added Sample_001 was identifed as Metals(1;1;1), and has been changed to Metals(1;1;2) to denote the second instance of the Metals Parameter List. Attempted to clarify the example of using "Force New".
SDI Maintenance Pages	Added a link from the "Contacts" section to the new topic Address Maintenance Page.
System Action Reference	AddSDI Action (Server-Side) Added newly-discovered functionality. Modified examples. EditSDI Action (Server-Side) Updated functionality. EnterDataItem (Server-Side) and EnterDataSet (Server-Side) In the "Affected Tables" section, removed "Condition" from the list of columns that can be altered using these Actions. PrintReport Action (Server-Side) and LVX.PrintReport Action (Client-Side) Changed "Purpose" section to provide more details. Added more information about the AddressId property, and added a link to the new topic Address Maintenance Page. Changed description of "Destination" property. Previous description could be incorrectly interpreted. Removed "Exchange" from the list of possible Destinations for Crystal Reports. Added more information concerning "Parameter" properties. Deleted printing instructions in "Comments" section. SetSDIString Action (Server-Side) Updated functionality.
Task Maintenance Page	Updated to reflect terminology changes.

Help Build 011009.04

Topic	Comments
Action Maintenance Page	Updated to include Java as a valid scripting language for User Actions. Modified option information to reflect V3.x architecture.
All Topics	Deleted and rebuilt 33 fragmented placeholder files. This results in enhanced search capability, since it no longer searches for files that do not really exist. Deleted the following obsolete topics and removed all links to them: SAPPHIRE Automation Manager (SAM) Page SAM Configuration Page Sam Logon/Connection Dialog SAM Initialization Configuration File Page System Configuration Dialog ToDo List Manager (TDLM) Concepts TDLM Configuration Page
Concepts of Actions	Modified to reflect V3.x architecture: Changed descriptions of Server- and Client-Side Actions. Added Java as a valid scripting language for User Actions. Changed Server-Side Action execution diagram and methodology. Removed option information (now only in Action Maintenance Page).
Concepts of Users, Roles, and Profiles	Added definitions of Standard Named, Virtual Named, and Unnamed Users.
Concepts of Workflows	Modified to reflect V3.x architecture: Changed descriptions of Server- and Client-Side Workflows, and Client- and Server-Side Actions. Changed Server-Side Workflow execution diagram and methodology.
Glossary	Modified to reflect V3.x architecture: Added Admin Database, Application Server, Request Controller, SAPPHIRE Database, SAPPHIRE System Configuration, SAPPHIRE Web Application, SuperUser. Modified Client-Side Action, Client-Side Workflow, Connection, LABVANTAGE Explorer, License Key, SAPPHIRE Object Manager, Server-Side Action, Server-Side Workflow, Service Pool Manager, ToDo List Manager. Deleted all references to V1.x architecture.
Explorer Bar, Profile, and Page Properties	Updated Profile Properties.
LVX Initialization File Configuration Dialog	Updated to reflect V3.x architecture.
LVX Logon/Connection Dialog	Updated to reflect V3.x architecture.
Parameter Maintenance Page	Added + to list of restricted characters when naming Parameters.
Reference	Changed wording concerning use of restricted characters. Updated lists of restricted characters.
Report Page	Added cursory details about registering and viewing Business Objects reports.
SAPPHIRE Architecture	New topic added to describe the present state of V3.x architecture.
SAPPHIRE System Configuration (SSC)	New topic added for V3.x architecture.
SDC Definition Page	Changed wording concerning use of restricted characters.
SDC Functionality and Options	Added information currently available concerning Workitems.
System Action Reference	Added the following new Actions: AddBucketSDI (Server-Side) AddDataItem (Server-Side) AddSDIDetail (Server-Side) AddSDIWorkitem (Server-Side) AddSDIWorkflow (Server-Side) ClearBucket (Server-Side) ClearRecentItems (Server-Side) CompareNumbers (Server-Side) DeleteDataItem (Server-Side) DeleteSDIDetail (Server-Side) EditDataItem (Server-Side) EditDataSet (Server-Side) EditSDIDetail (Server-Side) GetDataItemDate (Server-Side) GetDataItemNumber (Server-Side) GetDataSetDate (Server-Side) GetDataSetNumber (Server-Side) GetSDIDate (Server-Side) GetSDINumber (Server-Side) LVX.AddSDIAttachment (Client-Side) LVX.GetSDIAttachment (Client-Side) LVX.PrintReport (Client-Side) LVX.ProcessFiles (Client-Side) RemoveBucketSDI (Server-Side) SendBulletin (Server-Side) SetBulletinStatus (Server-Side) SetSDIWorkitemItemComplete (Server-Side) Modified the following Actions: AddDataSet (Server-Side) Added "AddNewOnly" Input Property. Specified Properties that can have multiple values, and added example of multiple Input Property usage. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. AddSDI (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. AddSDIAttachment (Server-Side) Added note to use this only in Server-Side Workflows, with alternative Action to use in Client-Side Workflows. AddSDISpec (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. AddToDoListEntry (Server-Side) Changed misleading description of "delete" property. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. AddWorkgroupItem (Server-Side) Corrected Action type (last document build identified it as Client-Side). BannerSetText (Client-Side) Added information that was not available in last document build. ConfirmUser (Client-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. DeleteDataSet (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. DeleteSDI (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. DeleteToDoListEntry (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. EditSDI (Server-Side) Specified Properties that can have multiple values. EnterDataItem (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. EnterDataSet (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. GetSDIAttachment (Server-Side) Added note to use this only in Server-Side Workflows, with alternative Action to use in Client-Side Workflows. GetSDIString (Server-Side) Corrected typo (changed "column" PropertyId to "columnid". Specified Properties that can have multiple values, and added example of multiple Input Property usage. GetTextFileData (Client-Side) Action is now Client-Side. ImportXML (Client-Side) Action is now Client-Side. IMReport.SaveAs (Client-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsApprovalDone (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsConditionMet (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsControlDateMet (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsDataReleased (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsDueDateMet (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsListItem (Client-Side) Added information that was not available in last document build. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsMatch (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsNull (Server-Sdie) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. IsStringEqual (Server-Side) Added information that was not available in last document build. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. MaintForm.Open (Client-Side) Added information that was not available in last document build. MaintFormOK (Client-Side) Added information that was not available in last document build. MaintGridOK (Client-Side) Added information that was not available in last document build. MsgBox (Client-Side) Added information that was not available in last document build. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. Page.GetProperty (Client-Side) Added information that was not available in last document build. Page.SetButtonState (Client-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. PrintReport (Server-Side) Added note to use this only in Server-Side Workflows, with alternative Action to use in Client-Side Workflows. ProcessFiles (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions. Added note to use this only in Server-Side Workflows, with alternative Action to use in Client-Side Workflows. ReleaseDataItem (Server-Side) Smoked "AllowMandatoryNulls" Input Property. Specified Properties that can have multiple values, and added example of multiple Input Property usage. Differentiated "yes/no" values in LVX from "y/n" values in User Actions. ReleaseDataSet (Server-Side) Differentiated "yes/no" values in LVX from "y/n" values in User Actions, and added example of multiple Input Property usage. SendMail (Server-Side) Changed Action Properties and example to reflect V3.0 functionality (now uses SMTP server). StartWorkplan (Server-Side) Added information that was not available in last document build. Deleted the following Actions: FileTransfer (Server-Side) Modified the following topics: General Information Concerning System Actions Modified description of Server-Side and Client-Side Actions to reflect V3.x architecture. Modified description of Multiple Property Values to reflect inconsistencies among Actions that accept/return multiple Property values.
User Maintenance Page	Added new facilities for specifying User types and Profile Properties.

SAPPHIRE V3.0 Feature List

Top

Functionality	Description
Actions	27 new System Actions have been added (see System Action Reference above). 11 old System Actions now accept/return multiple Property values (see System Action Reference above). Java has been added as an authoring language for User Actions.
Architecture	A new system architecture uses Sybase Jaguar CTS as a Web/Application Server. This lets you run SAPPHIRE as both a Client-Server and Web application. A SAPPHIRE Web Application, modeling a generic laboratory, is shipped and can be installed with the product. See SAPPHIRE Architecture, SAPPHIRE System Configuration (SSC), Concepts of Actions, and Concepts of Workflows above.
Users	SAPPHIRE now defines three kinds of Users: Standard Named, Virtual Named, and Unnamed. This discrimination defines access privileges and affects the product license (see Concepts of Users, Roles, and Profiles above).
Reports	You can now view Business Objects Reports from within LVX and the SAPPHIRE Web Application. For details currently available, see Concepts of SAPPHIRE Reporting, Report Page, and BO Report Page.
Workitems	Workitems are a new SDC option (see SDC Functionality and Options above).

V3.0 Upgrade Compatibility Issues

Top

The following issues affect users upgrading from a V1.x version of SAPPHIRE.

Functionality	Issue
Actions (System)	Many new System Actions now accept/return multiple Property values, including 11 old System Actions (see System Action Reference for Help Build 011009.04). You can use this new feature to optimize Workflows and User Actions. Calling an Action that has multiple values for each Property is much faster than repetitively calling the Action each time a new value is required. The Application Server now processes all Server-Side Actions that run in Client-Side Workflows. This may affect Client-Side Workflows with Actions that process files or queues on the client machine (hosting LVX). To circumvent this, we have added Client-Side counterparts to four affected Server-Side Actions. If you have any of the following Actions in Client-Side Workflows, replace them as specified: AddSDIAttachment (Server-Side) Replace with LVX.AddSDIAttachment (Client-Side). GetSDIAttachment (Server-Side) Replace with LVX.GetSDIAttachment (Client-Side). PrintReport (Server-Side) Replace with LVX.PrintReport (Client-Side). ProcessFiles (Server-Side) Replace with LVX.ProcessFiles (Client-Side). Additionally, the ImportXML, GetTextFileData, and AddWorkgroupItem Actions are now Client-Side Actions. Do not use them in Server-Side Workflows. SAPPHIRE no longer supports the FileTransfer Action. We have substantially changed the functionality of the SendMail Action. It no longer recognizes Contact Names used by Microsoft Outlook or Exchange. It now sends an email by dispatching the mail request to an SMTP server. To use this Action, you must be able to connect to an SMTP server (server that uses Simple Mail Transfer Protocol to send mail between servers). SAPPHIRE sends the request to send mail after the Application Server processes the Action. For details, see SendMail Action (Server-Side). In the SDIAddress table, ContactFunction is now a primary key. This means that the ContactFunction column can never have a null value. If you have been using an Action that populates this table, you must add the ContactFunction column to this Action and specify a value for it.
Actions (System and User)	V3.0 processes Action Blocks in Server-Side Workflows as a single transaction. This means that if a single Action within the Action Block fails, changes made to the database by the previous Action are rolled back. SAPPHIRE then attempts to re-process the Action Block up to 5 more times.
Actions (User) written in VBScript	The first argument of each function listed below takes an integer that has been returned from an earlier function call: fps.read fps.write fps.close dbs.getrows dbs.getvalue dbs.close When calling these functions, the first argument needs to be explicitly cast to an integer using the cint method. For example: V1.4 Code: mydataset = dbs.opendataset( "select sampleid from sample" ) dbs.getrows( mydataset, "sampleid" ) V3.0 Code: mydataset = dbs.opendataset( "select sampleid from sample" ) dbs.getrows( cint(mydataset), "sampleid" )
Data Locking	When a user accesses data, SAPPHIRE uses a new strategy to lock the open record. V1.4 used database locking. V3.0 locks open records using a new component called the Database Access Manager (DAM). This ensures locking compatibility among the three database connections possible in V3.0 (LVX, SOM, and the V3.0 Web Application).
Import/Export	When importing XML files, SAPPHIRE now creates a log file that records what has been imported. SAPPHIRE creates the file in the Windows temp folder and appends 'log' to the filename extension. For example, it you import the file samples.xml, SAPPHIRE generates a log file called samples.xmllog.
Insallation and Upgrade	An Applications Server has replaced the SAM. This means significant and ongoing changes in the procedures for installing and upgrading SAPPHIRE. Most notably, users upgrading to V3.0 must create new connections (entries in the lvx.ini file) to point to the Application Server (rather than the SAM). For an overview of the new architecture and how it has changed Action and Workflow processing, see SAPPHIRE Architecture, SAPPHIRE System Configuration (SSC), Concepts of Actions, and Concepts of Workflows above.
License Key	The License Key no longer counts the number of concurrent connections to the database. It now counts the number of Standard Named and Virtual Named Users (see Concepts of Users, Roles, and Profiles above).
Naming Restrictions	The plus character (+) is now a restricted character. This means that you can not use it to create new keys. Existing keys containing a plus (+) character will continue to work in V3.0 LVX, but may not work in the V3.0 Web Application.
Profile Properties	We have removed the following Profile Properties: RemoteFileLocation SAM Configuration Mail Userid Mail Password
Users	You must now define existing and new SAPPHIRE Users as Standard Named, Virtual Named, or Unnamed. For details, see Concepts of Users, Roles, and Profiles above.

V3.0 Release Notes

Top

SOM Memory Leak

This note was prepared for V3.0 before V1.5 was released.

Prior to SAPPHIRE V1.4(Build017), the SAPPHIRE Object Manager (SOM) failed to release 1.2Mb of system memory each time it shut down. This can result in a significant memory leak if your application repeatedly cycles the SOM on and off. The memory leak was a result of the way SAPPHIRE components processed User Actions which, in turn, is related to the notation used to write User Action statements.

In statements using APS, FPS, and DBS functions, SAPPHIRE V1.4 used dot notation to indicate that the function was called on the component. For example, the statement

SAPPHIRE.APS.SetProperty "SdcId", "Sample"

uses dot notation to indicate that setproperty is called on the APS component. This caused the memory leak.

SAPPHIRE V3.0 and higher allows you to write your VBScript Actions in a manner that avoids locking memory when the SOM cycles off and on. To apply the fix, use an underscore rather than a dot between the component and the function. For example, the following excerpt shows the notation that caused the problem:

SAPPHIRE.APS.SetProperty "SdcId", "Sample"
SAPPHIRE.APS.SetProperty "KeyId1", "Sample001"
SAPPHIRE.APS.ProcessAction "AddSDI"

You should now write these statements as follows:

SAPPHIRE.APS_SetProperty "SdcId", "Sample"
SAPPHIRE.APS_SetProperty "KeyId1", "Sample001"
SAPPHIRE.APS_ProcessAction "AddSDI"

Remember that you should use the underscore only between the SAPPHIRE component (APS, FPS, and DBS) and the User Action Function for that component (as described in the Online Help). For example:

SAPPHIRE.APS_SetProperty "SdcId", "Sample"
SAPPHIRE.FPS_OpenWrite( "c:\myfile.txt" )
SAPPHIRE.DBS_OpenDataSet ( "desc * from sample" )

History of Changes during SAPPHIRE V1.5

Top

Help Build 020502-1.5

Topic	Comments
Data Entry Page	Added new Data Locking Strategy.
Data Entry Grid Configuration	Added ParamList Options.
Workgroup Maintenance Page	Added note concerning data locking (see Parameter List Tab).

Help Build 15.011120

Topic	Comments
Address Maintenance Page	New topic, added specifically to supplement PrintReport Actions. Added notes concerning how to specify printer in Win2000 and Win98. Also specified which fields in the "Other Information" section are inactive.
BO Report Page	New topic added to support Business Objects report viewer.
Concepts of SAPPHIRE Reporting	New topic.
Explorer Bar, Profile, and Page Properties	Added warning concerning the necessity of pressing "Enter" after inputting text values for properties. BO Report Page Properties New topic added to support BO Report Pages. Crystal Report Page Properties and Infomaker Report Page Properties Updated description of "Report" property. Added more information concerning "Parameter" properties. Added "Initial Zoom" and "Toolbars" properties.
List Pages	Updated warnings concerning deletion of SDCs.
Property Configuration Page	Added warning concerning the necessity of pressing "Enter" after inputting text values for properties.
Report Page	Moved all information concerning report generation and printing to the topic Concepts of SAPPHIRE Reporting.
SDI Maintenance Pages	Added a link from the "Contacts" section to the new topic Address Maintenance Page.
System Action Reference	EditSDI Action (Server-Side) Updated functionality. At some undetermined time, this Action stopped allowing you to edit the same column in multiple SDIs. Added a link to the SetSDIString Action (Server-Side) for those who need to edit multiple SDIs. EnterDataItem (Server-Side) In the "Affected Tables" section, removed "Condition" from the list of columns that can be altered using these Actions. Specified Properties that can have multiple values, and added example of multiple Input Property usage. EnterDataSet (Server-Side) In the "Affected Tables" section, removed "Condition" from the list of columns that can be altered using these Actions. PrintReport Action (Server-Side) Changed "Purpose" section to provide more details. Added more information about the AddressId property, and added a link to the new topic Address Maintenance Page. Changed description of "Destination" property. Previous description could be incorrectly interpreted. Removed "Exchange" from the list of possible Destinations for Crystal Reports. Added more information concerning "Parameter" properties. Deleted printing instructions in "Comments" section. ReleaseDataItem (Server-Side) Specified Properties that can have multiple values, and added example of multiple Input Property usage. SetSDIString Action (Server-Side) Added example using multiple SDIs.
Task Maintenance Page	Updated to reflect terminology changes.

SAPPHIRE V1.5 Feature List

Top

Affected Functionality	Description
Actions	The following Actions now accept multiple Input Property values: EnterDataItem (Server-Side) ReleaseDataItem (Server-Side)
Data Entry	New Data Locking Strategy.
Queries	Default Values now work in Query Arguments. For example usage, see the topic Query Maintenance Page (see "Defining the Arguments" under "Example of Cascaded Arguments").
Reports	You can now view Business Objects Reports from within LVX. For details currently available, see Concepts of SAPPHIRE Reporting, Report Page, and BO Report Page. Viewing Business Objects reports from within LVX requires the Adobe® Acrobat Reader, which must be on the same machine as LVX.
SOM	There are procedures for repairing the SOM memory leak, as well as three new User Action functions for SOM Maintenance. For details, see the Release Notes.

V1.5 Release Notes

Top

Repair of SOM Memory Leak

This note was prepared for V1.5 after V3.0 was released.

In statements using APS, FPS, and DBS functions, SAPPHIRE V1.4 used dot notation to indicate that the function was called on the component. For example, the statement

SAPPHIRE.APS.SetProperty "SdcId", "Sample"

uses dot notation to indicate that setproperty is called on the APS component. This caused the memory leak.

SAPPHIRE V1.5 and higher allows you to write your VBScript Actions in a manner that avoids locking memory when the SOM cycles off and on. To apply the fix, use an underscore rather than a dot between the component and the function. For example, the following excerpt shows the notation that caused the problem:

SAPPHIRE.APS.SetProperty "SdcId", "Sample"
SAPPHIRE.APS.SetProperty "KeyId1", "Sample001"
SAPPHIRE.APS.ProcessAction "AddSDI"

You should now write these statements as follows:

SAPPHIRE.APS_SetProperty "SdcId", "Sample"
SAPPHIRE.APS_SetProperty "KeyId1", "Sample001"
SAPPHIRE.APS_ProcessAction "AddSDI"

Remember that you should use the underscore only between the SAPPHIRE component (APS, FPS, and DBS) and the User Action Function for that component (as described in the Online Help). For example:

SAPPHIRE.APS_SetProperty "SdcId", "Sample"
SAPPHIRE.FPS_OpenWrite( "c:\myfile.txt" )
SAPPHIRE.DBS_OpenDataSet ( "desc * from sample" )

New Functions for SOM Maintenance

The following new User Action functions are available for SOM maintenance. These work only with functions that utilize the new underscore notation between component and function (see the previous topic "Repair of SOM Memory Leak").

SAPPHIRE.Logtrace( "message" )

This writes the specified message to the SOM log file C:\<WINDIR>\som.log, where <WINDIR> is the Windows system folder.

EnableTracing( "name" )

This begins automatically recording events in the SOM log file som.log. If you specify a name, this Action enters the name against the message inserted by SAPPHIRE.Logtrace ( "message" ).

DisableTracing( )

This stops recording events in the SOM log file by disabling the EnableTracing() function.

ToDo List Maintenance

Prior to V1.5, if a SAMLET crashed it would leave Event Triggers (which execute an Action or Action Block) in the ToDo list. It should delete the Event Trigger and the entire related record in the ToDo List. Some background is helpful in order to understand the fix.

When an Event Trigger awaits execution on the ToDo List, the status of the Event Trigger is "W" (meaning "waiting"), and the SAM assigns the Event Trigger to "ALL" (meaning it is not yet assigned to a SAMLET and any SAMLET can execute it). When a SAMLET picks up the Action or Action Block, the status of the Event Trigger changes to "P" (meaning "processed"), and the SAM assigns the Event Trigger to a specific SAMLET. The problem occurred because the status of the Event Trigger remained "P", indicating to the SAM that the Trigger was still being processed even though the SAMLET crashed.

SAPPHIRE V1.5 fixes this problem by, when starting the SAM, checking for any Event Triggers with a status of "P". If there are any (meaning inactive Triggers are taking up space on the ToDo List), the SAM displays a "Hung Actions" dialog stating:

"There are currently n action(s) in the todolist that have previously failed. This may be because the assigned SAMLET no long exists or because there is another SAM currently processing the same todolist. Would you like SAM to attempt to reset the action(s) to be processed again?"

You should answer "Yes" if you know there should not be anything waiting to be processed in the ToDo List. If SAPPHIRE can not clear the record(s), a dialog will tell you:

"Unable to delete the actions. This may be because one or more of the todolist entries is locked. See your system administrator for more help."

Be aware that if you start a second SAM instance, it will detect active Event Triggers being processed by the first SAM instance. If you tell the second SAM instance to clear the ToDo List records, it will clear those being processed by the first SAM instance.

History of Changes During SAPPHIRE V1.4

Top

Help Build 000410

Topic	Comments
Concepts of SDCs, SDIs, and Reference Types	Updated to include new feature that lets users generate a delete script that deletes User SDCs.
Data Entry Grid Configuration	Added Tab Options.
DDT Page	Added instructions for deleting User SDCs.
Explorer Bar, Profile, and Page Properties	Updated to reflect Properties for V1.4: SDI Maintenance Page Properties Modified "Define Tabs" Property to accommodate Reverse SDC Links.
Expression Editor	Added reference to PowerBuilder Help for details concerning functions. Corrected Examples of Parameter List and Parameter Definition.
Form Painter Page	Added new feature that lets you trigger Client-Side Workflows by clicking a button or in response to a field event (changing the contents of a field).
Parameter List Maintenance Page	Added new feature that lets you create an expression to conditionally evaluate the Display Format.
SDC Definition Page	You can now remove SDC columns you have added. For details, see SDC Definition Page.
SDI Maintenance Pages and SDI Maintenance Page Properties	New tab for Reverse SDC Links.
Specification Maintenance Page	Corrected three typographical errors concerning Specification Rule syntax used in examples.
System Action Reference	Added the following new Actions: MaintGrid.RowCount (Client-Side) MaintGrid.SelectTab (Client-Side) Modified the following Actions: AddSDI (Server-Side) Added note concerning Auto Key generation. Changed phrasing of Properties requiring Yes/No values to compensate for inconsistency between VBScript and LVX required input. The modification made to General Information Concerning System Actions (below) suggests a workaround to avoid this problem. Added note describing how you can specify SDC column values while you are adding an SDI. AddToDoListEntry (Server-Side) Added note about adding Properties to the Action. DataEntry.GetItem (Client-Side) Corrected Property types (formerly specified all Properties as Input Properties). Edit SDI (Server-Side) Added note describing how to add columns and values using both VBScript and the SAPPHIRE Input Properties dialog. LookupSDI (Client-Side) and LookupSDIs (Client-Side) Added "Extended Where" and "Lookup SDI" Properties. MaintForm.SetItem (Client-Side), MaintGrid.SetItem (Client-Side), and General Information Concerning System Actions Added information concerning the variable [%currentuser%]. PrintReport (Server-Side) Attempted to clarify (as much as possible) the operation of this Action as of 010228. ReleaseDataItem (Server-Side) and ReleaseDataSet (Server-Side) Added "Allow Mandatory Nulls" Property. Changed phrasing of Properties requiring Yes/No values to compensate for inconsistency between VBScript and LVX required input. The modification made to General Information Concerning System Actions (below) suggests a workaround to avoid this problem. Run (Client-Side) Action was incorrectly specified as a Server-Side Action. References in Contents and Index are also corrected. Modified the following references: >General Information Concerning System Actions Added a section (titled System Action Property Values in User Actions) to inform users that some VBScripted System Actions accept y or n values rather than Yes or No.
User Action Examples: FPS	Corrected typo (removed parentheses from SetProperty).
User Action Reference	Removed Output Property from DisableServicePool.

SAPPHIRE V1.4 Feature List

Top

Affected Functionality	Description of Feature and Link to Documentation
Actions	New Actions: MaintGrid.RowCount (Client-Side) Outputs the total number of rows in the current SDI Maintenance Grid Page. MaintGrid.SelectTab (Client-Side) Selects a tab on the current SDI Maintenance Grid Page. Properties: All Action Properties can now be 4000 characters in length (see Properties below).
API	Extended to allow custom Client-Side Actions, custom Data Entry tabs, selection of multiple items in SDI Lookup List Pages, and dialog box positioning. Function of_isoktoclose now available for use in API pages. Function of_copy enhanced. For details, see the SAPPHIRE API Reference (printed document).
Form Painter Page	You can now trigger Client-Side Workflows by clicking a button or in response to a field event (changing the contents of a field). For details, see Form Painter Page.
Parameter List Maintenance Page	You can now create an expression to conditionally evaluate the Display Format. For details, see Parameter List Maintenance Page.
Properties	All Properties for Actions, Pages, and Workflows have been extended from 256 to 4000 (four thousand) characters. You can verify this by looking at the Data Dictionary from the DDT Page.
SDCs and SDIs	You can now delete User SDCs. For a procedure, see DDT Page. For configuration instructions during SAPPHIRE installation or upgrade, see the SAPPHIRE Installation and Upgrade Procedures, and the Database and Client Configuration Guidelines for Oracle Databases. You can now remove SDC columns you have added. For details, see SDC Definition Page.
SDI Maintenance Pages	New tab for Reverse SDC Links. For details, see SDI Maintenance Pages.

History of changes during SAPPHIRE V1.3

Top

Help Build 000920

Topic	Comments
Concepts of Parameters and Parameter Lists	Revised explanation of Replicates. Modified terminology to distinguish between Parameter Limits and Specification Limits.
Concepts of Parameter Limits	Re-wrote sections to be consistent with Specification elements. Generated new illustrations to show Parameter Limit Checking processes. Changed name of topic and all relevant links. Modified terminology to distinguish between Parameter Limits and Specification Limits.
Concepts of SDCs, SDIs, and Reference Types	Added SpecSDC (Specification SDC) and Spec Condition RefType. Modified Limit Type definition to include both Parameter Limits and Specification Limits.
Concepts of Specifications	New topic.
Concepts of Workflows	Modified introductory description of Client-Side Workflows to emphasize the fact that they can perform many of the same functions as Server-Side Workflows. Changed some terminology in explanation of Server-Side Workflow Execution to more accurately describe the process (changed "Workplan" to "Workplan table", changed "Trigger" to "Event Trigger"). Added a caveat to using Triggers for branching within a Workflow (creates an SDI instance for each branch).
Data Entry Page	Added changes required to support Specifications and distinguish between Parameter Limits and Specification Limits.
Data Entry Grid Configuration	Updated SDC Columns options and added Specification Options.
Explorer Bar Configuration for Button Bars	Added new features (ability to execute Workflows and change button order).
Explorer Bar, Profile, and Page Properties	Updated to reflect Properties for V1.3: Profile Properties Added Error File Location and Max Logon Attempts. SDI Collection Page and SDI List Page Made Properties identical. SDI List Page Added Filter Bar Settings Property.
Expression Editor Dialog	Added new Replicate calculation methods. Add new maxsigfigdp rounding rule.
Form Painter Page	Removed all information concerning the Edit Mask feature, which has been removed from the application.
Glossary	Updated.
Help system Contents and Index	Corrected a few wayward links.
LABVANTAGE Explorer Concepts	Added link from Go menu to Application Menus Dialog.
Limit Rule Maintenance Page	Modified to follow new dialog format.
Limit Type Maintenance Page	Added new functionality used with Specifications.
List Pages	Changed "Index Bar" to "Filter Bar" (update of naming convention).
LVX Initialization File Configuration Dialog	Added instructions for specifying LVX connections on your Windows desktop.
Parameter Maintenance Page	Added the ampersand to the list of disallowed characters for ParamListId.
Parameter List Maintenance Page	Added information concerning Replicates and link to Expression Editor Dialog (which contains new Replicate calculation method). Added Operators to specify textual Parameter Limits. Modified terminology to distinguish between Parameter Limits and Specification Limits.
Profile Configuration Page	Corrected destination of link to Property descriptions.
Query Maintenance Page	Added information concerning Generic Queries, with information relevant to Specification Rules. Changed description of Distinct option.
References	Added the ampersand to the list of disallowed characters for ParamListId.
Reference Type Maintenance Page	Removed all information concerning the Display Value feature, which has been removed from the application.
SAPPHIRE Error and Status Messages	Added 12 new error messages (9 LIS, 1 SPM, and 3 Delete).
SDI Maintenance Pages	Added information and links concerning Specifications tab.
SDI Maintenance Grid Page	Added information concerning adding Core columns. Added description of Shortcut Menu that provides Note/Category/Workflow assignment to multiple SDIs.
SDC Definition Page	Expanded explanation of Default Lookup List (Page) to emphasize that a Lookup List is actually just a modal SDI List Page.
SDC Functionality and Options	Added information and links concerning Specifications.
Specification Maintenance Page	New topic.
Specification Status Page	New topic.
System Action Reference	Added the following new Actions (see What's New in SAPPHIRE V1.3 for descriptions): AddSDISpec (Server-Side) ApplySDISpecs (Server-Side) DataEntry.ApplyRules (Client-Side) DataEntry.GetItem (Client-Side) DataEntry.Open (Client-Side) GetSDIAttachment (Server-Side) GetSDISpecCondition (Server-Side) GetSDISpecRuleValue (Server-Side) ImportXML (Server-Side) MaintForm.AddSpec Client-Side) MaintGrid.AddSpec (Client-Side) MsgBoxOK (Client-Side) ProcessFiles (Server-Side) RemoveSDISpec (Server-Side) SDIList.SetSelected (Client-Side) SpecStatus.AddSpec (Client-Side) SpecStatus.AllSDIs (Client-Side) SpecStatus.AllSpecs (Client-Side) SpecStatus.Evaluate (Client-Side) SpecStatus.Open (Client-Side) SpecStatus.Save (Client-Side) SpecStatus.SelSDIs (Client-Side) SpecStatus.SelSpecs (Client-Side) Modified the following Actions: AddSDI (added new Input Property auditreason) DeleteSDI (added new Input Property auditreason) EditSDI (added new Input Property auditreason) InputBox (added new Output Property inputbox) InputListBox (added new Output Property inputlistbox) MaintGrid.Open (added new Output Property maintgridopen) MsgBox (added description to distinguish from new MsgBoxOK Action) Page.SetButtonState (changed Yes and No values of Input Properties to Y and N, respectively) PrintReport (updated to add new method of specifying location of printer) SetSDIDate (added new Input Property auditreason) SetSDINumber (added new Input Property auditreason) SetSDIString (added new Input Property auditreason) ApplyDataItemLimits (modified terminology to distinguish between Parameter Limits and Specification Limits) ApplyDataSetLimits (modified terminology to distinguish between Parameter Limits and Specification Limits) Deleted the following Actions: CRReport.Print CRReport.Refresh GetSDIDate GetSDINumber IMReport.Print IMReport.Refresh MaintForm.EventWait
User Action Examples: FPS	Corrected syntax in example.
User Maintenance Page	Added instructions to set Password and Expiry Date.
Version Control Maintenance Page	Add SpecSDC (Specification SDC) to the list of versioned SDCs.
Workflow Painter Page	Added information concerning new buttons ("I" and "O") to identify and edit Action Input and Output Properties.

SAPPHIRE V1.3 Feature List

Top

Affected Functionality	Description of Feature and Link to Documentation
Actions	New Actions: AddSDISpec (Server-Side) Assigns a Specification to an SDI. ApplySDISpecs (Server-Side) Compares Data Values entered for an SDI to a Specification. DataEntry.ApplyRules (Client-Side) Applies Specification Rules to the SDI in the active Data Entry Page. DataEntry.GetItem (Client-Side) Retrieves the Data Value in the current cell in the current Data Entry Page. DataEntry.Open (Client-Side) Opens the specified Data Entry Page. GetSDIAttachment (Server-Side) Retrieves a file that is linked to the Attachments tab on an SDI Maintenance or Maintenance Grid Page. GetSDISpecCondition (Server-Side) Retrieves the Spec SDI Condition for an SDI. GetSDISpecRuleValue (Server-Side) Retrieves the Rule Output of a Specification Rule. ImportXML (Server-Side) Imports an XML file that was exported from the database. MaintForm.AddSpec Client-Side) Assigns a Specification to the current SDI. MaintGrid.AddSpec (Client-Side) Assigns a Specification to one or more SDIs supported by the current SDI Maintenance Grid Page MsgBoxOK (Client-Side) Opens a dialog box that contains a message and an OK button. ProcessFiles (Server-Side) Searches for files. When found, inserts the files as values of another Action's File Name Input Property, then executes the Action. RemoveSDISpec (Server-Side) Removes a Specification that is assigned to an SDI. SDIList.SetSelected (Client-Side) Selects one or more SDIs into the active SDI List Page. SpecStatus.AddSpec (Client-Side) Adds a Specification to SDIs in the currently open Specification Status Page. SpecStatus.AllSDIs (Client-Side) Outputs a list of all SDIs in the currently open Specification Status Page. SpecStatus.AllSpecs (Client-Side) Outputs a list of all SDIs and their assigned Specifications in the currently open Specification Status Page. SpecStatus.Evaluate (Client-Side) Conducts Spec Limit Checking and/or Spec SDI Checking on Specifications in the currently open Specification Status Page. SpecStatus.Open (Client-Side) Opens a Specification Status Page and returns a value indicating that the Page has opened. SpecStatus.Save (Client-Side) Assigns Specifications to SDIs (with enabled Save options) in the currently open Specification Status Page. SpecStatus.SelSDIs (Client-Side) Outputs a list of all SDIs that are selected in the currently open Specification Status Page. SpecStatus.SelSpecs (Client-Side) Outputs a list of all SDIs, with their assigned Specifications, that are selected in the currently open Specification Status Page. Modified Actions: AddSDI, DeleteSDI, EditSDI, SetSDIDate, SetSDINumber, SetSDIString New Input Property (auditreason) lets you enter a reason for executing the Action. AddSDI, EditSDI Actions now check and verify the columnid prior to entering a value into the column. InputBox New Output Property (inputbox) indicates how the user exited the dialog. InputListBox New Output Property (inputlistbox) indicates how the user exited the dialog. MaintGrid.Open New Output Property (maintgridopen) indicates that the Page has opened. Action Maintenance Page: Resized Action Maintenance Page to enlarge the script.
Auditing	As in V1.2, you should continue to be able to enter an Audit Reason as either a standard reason or free text. However, if you choose one of the Prompt Options for Auditing, SAPPHIRE will now always require input (the Audit Reason cannot be null). For details concerning Audit Prompt Options, see SDC Functionality and Options and SDC Definition Page.
Auto Key Generation	You can now create an Automatic Key Generation sequence that is based on more than one column of data. Using the terminology of Auto Key Generation, you can base a segment of type String, Number, or Date Column on another segment of type String, Number, or Date Column. The key will contain the contents of each column specified in each segment. For details, see the Note under Automatic Key Generation in the topic SDC Functionality and Options.
Charge Lists	Any SDI (relevant to Core, System, or User SDCs) can now be used as a Chargeable SDI. In the Charge List Maintenance Page, dragging an SDI from the Price List to the Charge List populates any relevant links. You can now assign an SDI from the Price List to an SDI in the Charge List (drag the SDI from the Price List and drop it onto an SDI in the Charge List), populating all links. For example, you can drop a Sample SDI onto a Workflow, and the Sample's Data Sets will be assigned to the Workflow. For details concerning Charge Lists, see Concepts of Pricing and Charge List Maintenance Page.
Data Entry	You can view the results of checking data against Specification Limits. For details, see Data Entry Page and Data Entry Grid Configuration. For information concerning Specifications, begin with Concepts of Specifications.
Explorer Bars	You can now execute Workflows from a Button Bar Explorer Bar Type. You can now change the order of buttons in a Button Bar Explorer Bar Type. For details, see Explorer Bar Configuration for Button Bars.
Error File	Error File Location Profile Property now lets you specify the path to the SAPPHIRE error log file sapphire.err. For details, see Profile Properties.
Import/Export	You can now import an SDI Template. Import/Export is not a released feature. We therefore do not yet support it.
License Key	License Keys now include information concerning expiration date, demo version, client-specific options, and modules. This did not require a change to the documentation. For information concerning License Keys, see System Configuration Dialog.
LVX	The Toolbar now contains a Home button that lets you return to the Startup Page. You should now be able to page Back and Forward through LVX Pages. You can now specify LVX connections on your Windows desktop. For details, see LVX Initialization File Configuration Dialog.
Parameter Lists	Lookup Lists that let you choose Parameter Lists now let you choose only Active Versions (rather than both Active and Provisional). In addition to specifying Parameter Limits as numerical values, Reference Values (defined in Reference Types), and SDC Links, you can now also specify textual values. For details, see Parameter List Maintenance Page. You can now create a Calculation Rule expression that uses all Replicates of multiple Parameters. For details, see Expression Editor. There is a new rounding rule (maxsigfigdp) for use in Transform Rules. For details, see Expression Editor.
Reports	You can now specify a default Zoom as a Page Property for Reports.
SDI Collection Page	Page Properties are now identical to SDI List Page. For details, see SDI Collection Page Properties and SDI List Page (below).
SDI List Page	Page Properties are now identical to SDI Collection Page. New Page Property (Version Status) lets you view only SDIs having specific Version Statuses in SDI List Pages and Lookup Lists made from SDI List Pages. If you enter No for the Single Click Selection Page Property, items are no longer highlighted for selection during a mouse-over. You now have to click an item to select it. New Page Property to configure Filter Bar (Filter Bar Settings Property). For details, see List Page Properties.
SDI Maintenance Pages	If you have selected an Audit Option, deleting an SDI now marks the Trace Log activity column with "Delete". This is a database feature and is not visible when using the LVX interface.
SDI Maintenance Grid Page	You can now edit multiple SDI Templates. You can now display Core (protected) columns as read-only. For multiple SDIs, you can now (in a single operation) add Notes, assign Server-Side Workflows, or classify the SDIs into Categories. For details, see SDI Maintenance Grid Page.
Specifications	You can now check Data Items and SDIs to a set of Specification Limits. For details, begin with the topic Concepts of Specifications.
Web IE Page	Some changes (Browse button and so on).
Workflow Painter Page	Graphics now tell you if an Action has Input and/or Output Properties. Clicking on the graphic lets you specify the Properties. For details, see Workflow Painter Page.

History of changes during SAPPHIRE V1.2

Top

Help Build 000608

Topic	Comments
Glossary	Updated.
Help system Contents and Index	Changed compression method for faster performance.

Help Build 000606

Topic	Comments
Help system Contents and Index	Restructured Index and rebuilt it as a Site Map Index, which allows the Help engine to run in a web browser.
Reference Type Maintenance Page	Clarified the purpose of Static List and Display Value options.
SDC Functionality and Options	Updated Apply SDC Privileges functionality.

Help Build 000526

Topic	Comments
Concepts of SDCs, SDIs, and Reference Types	Added a diagram and example to explain SDC and SDI data model.
Help system Contents and Index	Restructured the Table of Contents to show all subtopics in each help topic. In this help build, double-clicking a Contents entry brings you to the topic containing the relevant information. Individual links from Contents entries to each subtopic will not yet be pursued due to inability to maintain such a structure during product development. However, in a future help build, the Contents section at the beginning of each topic will mirror the Table of Contents. A future help build will also contain a restructured Index.
SAM Initialization Configuration Dialog	Added instructions to specify connections from the Windows desktop and batch files.

Help Build 000420

Topic	Comments
AddSDI Action (Server-Side)	Changed the name of the Property that determines the name of the SDI created in a VBScript. It was keyid, but has been changed to newkeyid.
Help system Contents and Index	Eliminated references to deleting and copying SDCs.
List Pages	Updated menu functionality and included the warning (concerning data alteration) that appears in the SAPPHIRE Installation and Upgrade Procedures.
References	Deleted extraneous text at end of file.

Help Build 000412

Topic	Comments
Action Maintenance Page	Updated to reflect V1.2 functionality.
Application Menus Dialog	Modified to include Client-Side Workflows.
Concepts of Actions	Modified to include Client-Side and Server-Side Action information. Updated to reflect latest SAM architecture.
Concepts of Users, Roles, and Profiles	Re-defined the SuperUser.
Concepts of Workflows	Modified to include Client-Side and Server-Side Workflow information. Updated to reflect latest SAM architecture. Added note explaining V1.2 security for Server- and Client-Side Workflows.
Database Definiton Toolkit (DDT) Page	Updated information concerning the DDT Page and the Table Maintenance Page.
Data Entry Page	Updated to V1.2 functionality for Release/UnRelease, Approval/Disapproval, and Page configuration options.
Data Entry Page Configuration	Updated to reflect V1.2 changes.
Error and Status Messages	Updated. Added descriptions where available.
Explorer Bar Configuration for ButtonBars Explorer Bar Configuration for CET	Modified to include Client-Side Workflow assignment and direct assignment of Page Links to bar (CET only).
Explorer Bar, Profile, and Page Properties	Updated to reflect new and changed Properties for V1.2.
Expression Editor Dialog	Added rounding rules for inorganic and organic analysis.
Form Painter Page	Added Edit Mask options and new drop-list option.
Glossary	Updated.
LABVANTAGE Explorer Concepts	Updated menu functions.
Limit Rule Maintenance Page	Added info and examples concerning use of variables when defining Transforms, Display, and Qualifier during Extended Limit Checking. Added Color feature for Limits that have been met.
Parameter List Maintenance Page	Added links to Expression Editor for sigfig rounding rules.
Query Maintenance Page	Updated to include Distinct option.
Reference	New topic to contain frequently-asked syntax and convention information.
SAM Configuration Dialog	New topic to support V1.2 functionality.
SAPPHIRE Automation Manager	Updated to reflect V1.2 SAM interface (new SAM architecture described in ToDo List Manager).
SDC Functionality and Options	Modified to specify operations relevant to only Server-Side Workflows. Updated Auditing to delete statement that you cannot change Auditing options, and to include data Approval in the examples of Audited events.
SDI Maintenance Pages	Modified to specify operations relevant to only Server-Side Workflows. Updated Page Properties (now consistent with SDI Maintenance Grid Pages).
SDI Maintenance Grid Page	Added Edit Mask options.
SDI Maintenance Grid Configuration	Added Edit Mask options.
System Action Examples	Re-sized illustrations in EventNotify example to fit on a printed page. Simplified the GetWorkflowProperty, SetWorkflowProperty example. Added two Client-Side Action examples (more to follow).
System Action Reference	Added links from relevant Actions to new examples. Reformatted Index page to handle the new volume of Actions. Added identifiers to Action descriptions to differentiate Server-Side from Client-Side. Modified General Information to include Client-Side and Variable information. Added new Properties to AddSDI to reflect V1.2 functionality. "DataSetNumer" Property Type has changed from "number" to "string" in the following Actions: AddDataSet, ApplyDataItemLimits, ApplyDataSetLimits, CopyDataSet, DeleteDataSet, EnterDataItem, EnterDataSet, GetApprovalFlag, GetApprovalStepFlag, IsApprovalDone, IsDataReleased, ReleaseDataItem, ReleaseDataSet, SetDataItemDate, SetDataItemNumber, SetDataItemString, SetDataSetDate, SetDataSetNumber, SetDataSetString. NOTE Workflow Instance and Replicate continue to be of Type "number" in Build 061. This may change to "string" at some undisclosed time. Added ability to set null value to SetSDIDate. Updated the following Actions to specify that you can now set values in multiple columns across multiple SDIs: SetSDIDate, SetSDINumber, SetSDIString. Also clarified description of this feature in EditSDI Action. Updated the following Actions to specify that you can now set values in user-added columns (also corrected several typos): SetDataSetDate, SetDataSetNumber, SetDataSetString, SetDataItemDate, SetDataItemNumber, SetDataItemString. Changed key names in EventGoToExplicit to reflect V1.2 functionality. Added ability to assign Workflow to SDI when using the StartWorkflow Action. Added the following Actions: AddListItem (Server-Side) Agent.Speak (Client-Side) Agent.Start (Client-Side) Agent.Stop (Client-Side) Banner.Close (Client-Side) Banner.SetText (Client-Side) ConfirmUser (Client-Side) CopyDataSet (Server-Side) CRReport.GetParam (Client-Side) CRReport.SetParam (Client-Side) CRReport.SetReport (Client-Side) CRReport.Refresh (Client-Side) CRReport.Print (Client-Side) DataEntry.SelectDI (Client-Side) DataEntry.SelectTab (Client-Side) DataEntry.SetItem (Client-Side) DataEntry.StartAgent (Client-Side) DataEntry.StopAgent (Client-Side) DecrementCounter (Server-Side) Excel.Activate (Client-Side) Excel.SetFile (Client-Side) GetDataItemString (Server-Side) GetDataSetString (Server-Side) GetFilename (Client-Side) GetListItem (Server-Side) GetListItemCount (Server-Side) GetSaveAsFilename (Client-Side) IE.DocumentWrite (Client-Side) IE.SetURL (Client-Side) IMReport.GetParam (Client-Side) IMReport.SaveAs (Client-Side) IMReport.SetParam (Client-Side) IMReport.SetReport (Client-Side) IMReport.Refresh (Client-Side) IMReport.Print (Client-Side) IncrementCounter (Server-Side) InputBox (Client-Side) InputListBox (Client-Side) IsConditionMet (Server-Side) IsListItem (Server-Side) IsStringEqual (Server-Side) LookupList (Client-Side) LookupRefType (Client-Side) LookupSDI (Client-Side) LookupSDIs (Client-Side) LVX.ExplorerBarLeft (Client-Side) LVX.ExplorerBarRight (Client-Side) LVX.OpenExplorerBar (Client-Side) LVX.OpenPage (Client-Side) LVX.OpenPopupPage (Client-Side) LVX.SetMicroHelp (Client-Side) MaintForm.AddDS (Client-Side) MaintForm.AddWF (Client-Side) MaintForm.EventWait (Client-Side) MaintForm.GetItem (Client-Side) MaintForm.OK (Client-Side) MaintForm.Open (Client-Side) MaintForm.SelectTab (Client-Side) MaintForm.SetItem (Client-Side) MaintForm.SetNotes (Client-Side) MaintGrid.AddDS (Client-Side) MaintGrid.AddRow (Client-Side) MaintGrid.AddWF (Client-Side) MaintGrid.GetItem (Client-Side) MaintGrid.GetSelRow (Client-Side) MaintGrid.GetSelSDI (Client-Side) MaintGrid.OK (Client-Side) MaintGrid.Open (Client-Side) MaintGrid.RemoveRow (Client-Side) MaintGrid.SetItem (Client-Side) MsgBox (Client-Side) Page.Cancel (Client-Side) Page.Close (Client-Side) Page.EventWait (Client-Side) Page.OK (Client-Side) Page.GetProperty (Client-Side) Page.Print (Client-Side) Page.Refresh (Client-Side) Page.SetButtonState (Client-Side) PlaySound (Client-Side) PowerPoint.Activate (Client-Side) PowerPoint.SetFile (Client-Side) ReleaseDataItem (Server-Side) ReleaseDataSet (Server-Side) ResetDataSet (Server-Side) Run (Server-Side) SDIList.AddMultiple (Client-Side) SDIList.AddSingle (Client-Side) SDIList.DataEntry (Client-Side) SDIList.Delete (Client-Side) SDIList.EditMultiple (Client-Side) SDIList.EditSingle (Client-Side) SDIList.GetSelected (Client-Side) SDIList.SelectAll (Client-Side) StartWorkplan (Server-Side) UnreleaseDataItem (Server-Side) UnReleaseDataSet (Server-Side) Word.Activate (Client-Side) Word.SetFile (Client-Side)
Table Maintenance Page	Updated.
ToDo List Manager	Updated to reflect V1.2 SAM architecture.
Unit Maintenance Page	Included procedure to define conversion factors between Units.
User Action Reference	Added DisableServicePool function (accidentally deleted from last build). Corrected several typos.
Workflow Construction	Added preliminary Client-Side Workflow guidelines. More to follow in updates.
Workflow Painter Page	Changed to reflect V1.2 functionality and incorporate Client-Side Workflows.
Workgroup Type Maintenance Page	Updated to include Distribution function.
Workplan Manager Page	Modified to specify that Page applies to only Server-Side Workflows.
Workplan Status Page	Modified to specify that Page applies to only Server-Side Workflows.
Workplan Viewer Page	Modified to specify that Page applies to only Server-Side Workflows.

SAPPHIRE V1.2 Feature List

Top

The following is a feature list for SAPPHIRE V1.2. For a detailed summary of all changes in SAPPHIRE V1.2, with links to relevant areas of the documentation, see What's New in this Help Build (above).

Affected Functionality	Description of Feature and Link to Documentation
Actions	Client-Side Actions and new Server-Side Actions. Improved performance of EventNotify Action. SetSDIDate now allows NULL setting for Value. SetDataSetDate/Number/String and SetDataItemDate/Number/String can now update user-defined fields. ResetDataSet Action nulls Data Entry values. SetSDIDate/Number/String now accept list of SDI keys, columns, and values. Drop-list displays Action Properties where relevant.
Approval	Audit prompting (per SDC Definition Page Audit options) during data Approval. New options (in Data Entry Page) to reverse Approval.
Data Entry	Configurable Page toolbar. Improved performance (Page open, Release, Approval). Release/UnRelease and Approve/Disapprove schemes added. New option to hide tabs on Page and configure colors.
Explorer Bars	CET Type now can display a single level. You can use this to launch Client-Side Workflows from the Explorer Bar.
Expression Editor	Expression syntax now allows use of versions and variants in calculations.
General	E-signature compliance underway (list of features currently in compliance is pending). VSFlexGrid 7.0 update (draws grids on Data Entry and Maintenance Grid Page Types).
Installation and Upgrade	New database population and upgrade scripts.
Language Maintenance Page	Reworked to achieve design functionality.
Limit Rules	Option on Limit Rule Page to set color when Extended Limit condition is met. Variables can be used for Transform Rules, Display Value, and Qualifier.
LVX	New Profile property lets you confirm exit from LVX.
Reports	Crystal Reports 8.0 upgrade.
SAM	Multiple-SAM capability for enhanced performance.
SDI Collection Page	Page now inserts items in the order that you add them.
SDI List Pages	Configurable Page toolbar. Improved display time performance.
SDI Maintenance and Maintenance Grid Pages	Standardized Page Properties. Configurable Page toolbar on SDI Maintenance Grid Page Type. Improved display, paste, and save performance.
Queries	Option lets you specify Queries using the DISTINCT clause.
Users	Users can now change passwords from the new LVX menu function (Tools: Change Password. Set User and Clear User now logs times and devices in the User SDC (sysuser table).
Workflows	Client-Side Workflows. Action processing is now auditable (when on Server-Side Workflows only). Drag-and-drop Actions in Workflow Painter Page.
Workgroups and Workgroup Types	Lookup List (fired by "Manage List" button) is now configurable. Workgroup Type rules can now be sequenced. Lookup List for Workgroup Type SDI Templates.

History of changes during SAPPHIRE V1.1

Top

Help Build 000203

Topic	Comments
Concepts of SDCs, SDIs, and Reference Types	Updated list of SDCs.
Data Entry Page	Added information concerning Measure button.
Expression Editor Dialog	Changed Parameter List and Parameter definitions for calculation rules.
Help system Contents and Index	Added missing Actions.
Parameter List Maintenance Page	Added Measurement Action feature and relevant links.
Version Maintenance Page	Added Actions and Limit Rules to list of Versioned SDCs.
System Action Reference	Updated and added info to Apply Data Item Limits, Get Workflow Property, Set SDI Date, Set SDI Number, Set Data Item Date, Set Data Item Number, Set Data Item String, Set Data Set Date, Set Data Set Number, Set Data Set String, Set Workflow Property, and Print Report.
Workgroup Maintenance Page	Added example to Parameter List feature (for restricting Data Entry).
Workgroup Type Maintenance Page	Updated Rules to reflect most recent changes.

Help Build 000105

Topic	Comments
Concepts of Actions	Added rules regarding nested Actions.
Concepts of SDCs, SDIs, and Reference Types	Changed User SDC description to specify that you can not delete User SDCs.
Data Set Maintenance Dialog	Added constraints that apply to deleting Data Sets.
Parameter List Maintenance Page	Added information concerning Default Value (if you specify a Default Value, you can not delete any Data Set made from that Parameter List.
System Action Reference	Updated AddDataSet, AddDetailSDI, AddSDI, AddSDIAttachment, AddToWorkplan, and EditSDI. Added more details to >General Information topic.
User Action Examples: APS	Began second installment of User Action examples.
User Action Reference	Linked example sections to the User Action Example files. Changed some descriptions to clarify purpose of Action.
Using Help	Added note concerning Microsoft HTMLHelp Compiler bug, which imposes a limit on the number of subtopics you can print (Help Compiler V1.2 4.73.8220.0). This currently prevents you from printing all HTML files with a single click.

Help Build 991228

Topic	Comments
Action Maintenance Page	Updated and added more information concerning options.
Concepts of Actions	Updated.
Concepts of SDCs, SDIs, and Reference Types	Changed definitions and updated.
Concepts of Workflows	Updated terminology.
Contents (Help system Table of Contents)	Reorganized the order in which the Table of Contents presents topics.
Data Entry Grid Configuration	Added "Use Pages to Lookup SDCs" option.
Data Entry Page	Updated to reflect changes made to Limit presentation. Updated Data Set definition.
Glossary	Updated.
LVX Logon/Connection Dialog	Added technique of forcing dialog to open even if the "Prompt for Connection..." option is disabled.
Query Maintenance Page	Added example of querying by date and time.
SAM Initialization File Configuration Dialog	Added more information and recommendations concering multiple connections.
SDC Definition Page	Changed (to 13 characters) the maximum number of characters allowed in SDC names.
User Action Reference	Changed Outputs of SAPPHIRE.DBS.Close (does not output a value).
Version Maintenance Page	Deleted Actions and Specifications from the list of SDCs that can be versioned. Actions can not yet be versioned, and the Specification SDC no longer exists.

Help Build 991203

Topic	Comments
Chain of Custody	New topic.
Concepts of Actions	Updated description of TDLM Action processing.
Concepts of Workflows	Updated details concerning Workflow execution.
Explorer Bar, Profile, and Page Properties	Updated Profile Properties and included links to topics concerning Action processing.
Parameter List Maintenance Page	Corrected description of Data Type functionality when you choose SDC or Reference Type. The description previously stated that the SDC used for the Data Type had to be linked to another SDC.
SDC Definition Page	Updated Many-to-Many Link constraints to indicate that linked SDCs can be either System or User, and must be single-key. Also noted that Link Text names the tab inserted into SDI Maintenance Pages.
SDC Functionality and Options	Updated Many-to-Many Link constraints to indicate that linked SDCs can be either System or User, and must be single-key. Also described tab inserted into SDI Maintenance Pages.
SDI Maintenance Pages	Added the Many-to-Many Link tab.
System Action Reference	Clarified descriptions and added detail to PrintReport Action. Added Override Key Generation (Input Property) to EditSDI Action. Re-formatted all Actions to print properly.
User Action Examples: FPS	This is the first installment of a guide to writing User Actions.
User Action Reference	Significant update.
Workflow Construction	Updated.

Help Build 991104

Topic	Comments
AddSDIAttachment Action	Changed Action name, and updated all relevant links from other files.
Data Entry Page	Changed Page Property names and all affected links.
Data Entry Grid Configuration	Changed Page Property names and all affected links.
Form Painter Page	Changed Overview to reflect latest terminology.
List Pages	Changed information concerning Form Painter, and modified all terminolgy to reflect latest changes.
Page Links Configuration	Changed Page Property names and all affected links.
Page Properties	Changed Page Properties to reflect latest terminology, additions, and deletions.
Query Maintenance Page	Changed Page Property names and all affected links.
SDC Definition Page	Changed Page Property names and all affected links.
SDI Collection Page	Changed Page Property names and all affected links.
SDI Maintenance Grid Page	Changed Page Property names and all affected links.
Workgroup Maintenance Page	Updated to include Parameter List filter for Data Entry.
Workplan Status Page	Updated operation of Cancel Workflow feature.

Help Build 991102

Topic	Comments
Approval Type Maintenance Page	Changed description of Approvals and Approval Steps. Added procedural overview of the Approval process.
Basics of Working with SDCs and SDIs	Rearranged topic and revised Overview to emphasize that this is an introductory topic that points to more detailed information in other topics.
Charge List Maintenance Page	New topic.
Concepts of Parameters and Parameter Lists	Added more information concerning "data" (Data Values, Data Items, and Data Sets). Revised to include references to Pages in which you perform operations on Parameter Lists. Added introduction and pointers relevant to Approval and Limits.
Concepts of Limits	New topic.
Concepts of Pages	Updated.
Concepts of Pricing	New topic.
Concepts of SDCs, SDIs, and Reference Types	Updated to reflect V1.0 functionality, including Definition SDCs, and new Reference Types.
Concepts of Workflows	Updated to reflect current Action functionality,
Concepts of Workgroups	Discarded and rewrote to reflect V1.0 functionality.
Data Entry Grid Configuration	Updated to reflect V1.1 functionality.
Data Entry Page	Reorganized and updated to reflect V1.0 functionality. Added information concerning Release and Approval.
Data Set Maintenance Dialog	Added conditions that must be met to allow Data Set modification.
Error and Status Messages	New topic... also opens if you press F1 while viewing an error message.
Expression Editor Dialog	Updated Calculation Rule definitions and revised examples.
Glossary	Updated.
InfoMaker Report Page	New topic.
Limit Rule Maintenance Page	New topic.
List Pages	Changed "Template" to "SDI Template" to distinguish from "Workflow Template". Removed "Editing Linked SDCs" section of "SDI List Pages", and linked to "Page Links Configuration" topic.
LVX Initialization Configuration Dialog	Updated.
Page Links Configuration	Updated.
Page Properties	Updated.
Parameter List Maintenance Page	Changed Limit-specific terminology to be consistent with Limit Rules. Changed description of "Modifiable" checkbox. Added Defer Transforms feature. Changed pointers to the Expression Editor.
Parameter Maintenance Page	Specified characters that can not be used in the Parameter Id.
Price List Maintenance Page	New topic.
Query Maintenance Page	Updated to reflect V1.1 functionality, including revised explanations and Cascaded Query example.
Report Page	New topic.
SAM Initialization Configuration Dialog	Updated to add MS SQLServer connection choices.
SAM Page	Updated to reflect V1.0 functionality.
SDC Definition Page	Updated to reflect V1.1 functionality, including new options and Many-to-Many Links.
SDC Functionality and Options	Updated to reflect V1.1 functionality, including new options and Many-to-Many Links. Revised description of features that assign (or make available) a Workflow's Parameter Lists to an SDI.
SDI Collection Page	Updated.
SDI Maintenance Grid Page	Updated to add "Show Primary Form" option in grid configuration.
SDI Maintenance Pages	Added conditions that must be met to allow Data Set modification. Updated to reflect V1.1 functionality. Revised description of features that assign (or make available) a Workflow's Parameter Lists to an SDI.
System Action Examples	New topic.
System Action Reference	Updated to add new Actions, corrected where necessary, and re-formatted to present new information. Changed all Action names to reflect recent changes. Revised to include PropertyId, whether or not Property is mandatory, Outputs, and SAPPHIRE tables affected by the Action. Re-formatted to make each Action a separate topic. This also lets you print all Actions (with page breaks) by printing the Action Index topic and specifying "Print all linked documents". Corrected mapping... pressing F1 while in any Action Propery dialog will display the System Action Index.
System Configuration Dialog	New topic.
User Action Command Reference	Fixed links and updated. Added caveat to "Read" FPS command.
Workflow Construction	Added description of features that assign (or make available) a Workflow's Parameter Lists to an SDI. Revised Data Entry description to reference options avilable in the Workflow Painter Page.
Workflow Painter Page	Added "Sequence" and "% Complete" options for Stages, and "Required" option in Parameter List tab for automatic Data Set assignment. Revised description of Parameter List tab, which lets you assign (or make available) a Workflow's Parameter Lists to an SDI.
Workgroup Maintenance Page	Discarded and rewrote to reflect V1.0 functionality.
Workgroup Type Maintenance Page	Discarded and rewrote to reflect V1.0 functionality.
Workplan Status Page	Updated.

Web Tools and Java API prior to R4.6

Top

Changes Made in Document Revision 061121-4.5/3.5 (DM0207 Release)

Area of Functionality

Reason for Change

Description of Change

Link to Section

Database

Document Enhancement

Added "Database Settings" to centralize database-specific settings that do not fit anywhere else in the document.

Database Settings

New Functionality

New features added to:

•	Log RSet activity
•	Allow or prevent using single quotes as part of data

•	Logging RSet Activity
•	Single versus Double Quotes in Queries

Java Public API

New Functionality

Updated Javadoc for the Java Public API.

Javadoc Public API

JavaScript Public
API for R4

Document Enhancement

Added R4 JavaScript Public API functions.

R4 JavaScript Public API

LDAP Authentication

New Functionality

New features added to:

•	Synchronize a user's attributes defined on the LDAP Server with those defined in SAPPHIRE
•	Search for a user in multiple LDAP tree nodes

External Authetication properties:

•	The RDN for the User Search
•	Default User To Create

M18N

Document Enhancement

Centralized and added information to SAPPHIRE M18N Support. New information includes sections about database time, absoulte versus relative dates, upgrade considerations, and coding considerations.

SAPPHIRE M18N Support

New Functionality

The userdate function now supports MS SQL Server.

Database: Absolute versus Relative Dates

Modules

New Functionality

New controls for granting access to Modules:

•	Unlimited and site-wide Modules
•	Page-level Module restriction
•	hasModule() method in sapphire.util.ConnectionInfo (determines if a User has access to a Module)

Granting Users Access to Roles

Request Parameters

Document Enhancement

Added a note to specify that Request Parameters can not contain illegal JavaScript characters.

Request Parameters: About JavaScript Characters

Web Page Designer
Layouts

Document Enhancement

Added these Layouts and updated them to R4.5:

•	Generic		•	GenericPopup
•	GenericBlank		•	NoLayout

Layouts

Web Page Designer
Page Types

Document Enhancement

Added these Page Types and updated them to R4.5:

•	AttachmentForm	•	MaintenanceForm	•	wzChooseLinkedSDCs
•	AuditReason	•	MaintenanceList	•	wzChooseSDCTemplate
•	AuditView	•	MaintenanceTree	•	wzChooseTemplates
•	BulletinList	•	Message	•	wzCommonSDIMaint
•	BulletinSend	•	ProtocolMaintForm	•	wzCreateSDI
•	BulletinView	•	QCBatchMaintForm	•	wzCreateStorageUnit
•	COCPage	•	QCBatchRuleForm	•	wzInvokeWizard
•	CreateOption	•	QCTrendChart	•	wzLinkedSDCMaint
•	CreatePooledSample	•	ScheduleGridView	•	wzLinkedSDCOptions
•	CreateSampleChild	•	SMSDataEntry	•	wzMultiTemplateMaint
•	CustomPageWrapper	•	SMSSampleMaintForm	•	wzQCBatchCreateEnd
•	DataDetailView	•	StorageCondMaint	•	wzQCBatchCreateGUI
•	DataEntry	•	StorageEnvMaint	•	wzBatchCreateMaint
•	DataEntryByQuery	•	StorageUnitMaintForm	•	wzSDCTemplateMaint
•	DataEntryGridMode	•	StudyMaintForm	•	wzSearchTemplates
•	DataEntryListMode	•	TrackItemManagement	•	wzSingleLinkdSDIDtls
•	DataEntryTabHolder	•	TramlineSitemap	•	wzSUHierarchy
•	ESigForm	•	TrendChart	•	wzSUTHierarchy

Page Types

New Functionality

New R4 Page Types:

•	TrackItemManagement
•	wzCreateStorageUnit

•	TrackItemManagement Page Type
•	wzCreateStorageUnit Page Type

New Functionality

The advancedtoolbar Element now supports Ajax server-side validation class.

Server-Side Validation: Support for advancedtoolbar Element

Changed Functionality

When copying Storage Units in a List page, the copy does not retain the linked SDC (linksdc) and SDI (linkkeyid1).

StorageUnitMaint Page Type

Web Page Designer
Elements

Document Enhancement

Added these Elements and updated them to R4.5:

•	advancedtoolbar	•	schedulegrid
•	auditdetails	•	sdidetailmaint
•	chainofcustody	•	sdidetailview
•	chart	•	storageunitrenderer
•	detailmaint	•	studyplanconditions
•	linkedsdimaint	•	templateselector
•	protocolproductplan	•	trackitemlist
•	qcbatchitemmaint	•	treelist

Elements

New Functionality

New R4 Elements:

•	storageunitrenderer
•	treelist

•	storageunitrenderer Element
•	treelist Element

New Functionality

New sdidetailmaint Element features:

•	Restrictive Where property.
•	Additional Detail Type: SDIAddress.

sdidetailmaint Element

New Functionality

Client-side validation rules have been added to these Elements:

•	detailmaint
•	linkedsdimaint
•	sdidetailmaint

•	detailmaint Element: Validation property
•	linkedsdimaint Element Validation property
•	sdidetailmaint Element: Validation property

Document Enhancement

Added a note to the dataentrylist Element CSS Class property for Data Items: If using WEB-OPAL/stylesheets/opal.css, set the class to dataentry_list_field_input. This sets proper borders for data fields.

dataentrylist Element

SAPPHIREAdmin
System Tools

New Functionality

New Storage Unit Types define attributes of a Storage Unit.

Storage Unit Types

Web Page Designer
Property Definition Editor

New Functionality

New Add Button Method option in the Property Definition Editor provides an easy way to customize buttons.

•	Property Definition Editor: Display Options
•	Property Definition Editor: Display Options: Customizing Buttons

Document Enhancement

Updated screen captures for the Property Definition Editor.

Property Definition Editor

SDC Rules

Feature Name Changed

Changed the name of "Programmable Business Rules" to "SDC Rules".

SDC Rules

Users

Name Change

Throughout the document, changed:

•	"Standard Named User" to "Full Named User".
•	"Concurrent Named User" to "Full Concurrent User".

Various

Validations and Error Handling

New Functionality

New techniques for conducting server-side validation and handling errors using SDC Rules, Actions, and Ajax.

Server-Side Validation and Error Handling

Changes Made in Document Revision 060413-3.4

Area of Functionality	Reason for Change	Description of Change	Section
Date Format	Document Enhancement	Added note to Date Format property to indicate that choosing a format specifying only date defaults to midnight in the user's time zone.	WPD Section 5 Elements: List Element: Properties WPD Section 5 Elements: Maint Element: Properties
Configuration Options	Document Correction	In Powerbuilder API Options, deleted references to the SAPPHIRE Powerbuilder API.	SAPPHIREAdmin Diagnostic and Configuration Tools: Configuration Options: Powerbuilder API Options
Pseudocolumns	Document Correction	Changed description of all pseudocolumn properties to state that pseudocolumns accept only HTML and variables as input.	WPD Section 5 Elements: List Element: Properties WPD Section 5 Elements: Maint Element: Properties WPD Section 5 Elements: Maint Page Detail Elements: Properties WPD Section 5 Elements: Dataentrylist: Properties n 5 Elements: Dataentrygrid: Properties

Changes Made in Document Revision 051215-3.4 (V3.4 DM0206 Release)

Area of Functionality

Reason for Change

Description of Change

Section

Actions

New Functionality

Request Controller:
Calling the Request Controller:
Syntax

Advanced Properties

New Functionality

New feature for selectively showing/hiding properties in children of the Root node.

Adding Custom Properties:
Property Definition Editor:
Declaring Advanced Properties

Attachments

New Functionality

New UploadAttachment Element.

WPD Section 5 Elements:
UploadAttachment Element

Copying Pages

New Functionality

New 2-click tool for copying pages made in the Web Page Designer.

WPD Section 1 Basic Principles:
Menus:
Pages Menu:
Copying Pages

Data Entry
Item Selection

New Functionality

New Show Checkbox property (shows/hides selection checkboxes).

WPD Section 5 Elements:
Dataentrylist:
Properties

Data Locking

New Functionality

New data locking strategy for pages built using Web Page Designer.

WPD Section 2
Properties Overview:
Data Locking Strategy

Added reference to new data locking strategy in Dataentrylist Element.

WPD Section 5 Elements:
Dataentrylist Element:
Other Data Entry Features

Added reference to new data locking strategy in Maint Element.

WPD Section 5 Elements:
Maint Element:
Data Locking

New Read Only property (displays the value as read-only, can be used to flag locking by page).

WPD Section 5 Elements:
Dataentrylist Element:
Properties

Deprecating Pages

New Functionality

New feature to deprecate pages.

WPD Section 6
Advanced Operations:
Adding Custom Properties:
Property Definition Editor:
Deprecating Pages

Deprecating Properties

New Functionality

New feature to deprecate properties.

WPD Section 2 Properties Overview:
Depricated Properties

WPD Section 6
Advanced Operations:
Adding Custom Properties:
Property Definition Editor:
Deprecating Properties

Deprecated Tags

Document Enhancement

Removed the section describing deprecated tags. They were causing some degree of confusion.

Deleted Section.

Document Structure

New Functionality

Split Web Page Designer documentation into seven sections in order to better organize the increased volume of information in this release.

WPD Sections 1 through 7

Error Logging (Jaguar)

Changed Functionality

Using settings from a SAPPHIRE props file, Jaguar now handles all server error logging.

SAPPHIREAdmin Diagnostic and Configuration Tools:
Jaguar Error Logging and Scanning

Exporting and Importing Items

New Functionality

New feature to export and import Pages, Page Types, Elements, and Layouts.

WPD Section 7:
Exporting and Importing

Internationalization and Localization

New Functionality

New Locale and Time Zone strategy.

Internationalization
and Localization:
Locale and Time Zone

New Functionality

Full support of Unicode character sets.

Internationalization
and Localization:
Unicode Character Support

New Functionality

New interface settings allow each user to specify Locale and Time Zone.

SAPPHIREAdmin:
Security:
Users and Roles

New Functionality

New Date Format property (specifies date/time display format according to the user's Locale).

WPD Section 5 Elements:
List Element:
Properties

WPD Section 5 Elements:
Maint Element:
Properties

New Functionality

New Translate Value property (translates all values in the column).

WPD Section 5 Elements:
List Element:
Properties

WPD Section 5 Elements:
Maint Element:
Properties

WPD Section 5 Elements:
Dataentrylist:
Properties

WPS Section 5 Elements:
Dataentrygrid:
Properties

New Functionality

New features for translating property values.

WPD Section 2
Properties Overview:
Translating Property Values

Changed Functionality

Interface to define translatable properties has been modified.

WPD Section 6
Advanced Operations:
Adding Custom Properties:
Property Definition Editor:
Translatable Properties

Document Enhacement

Added link to information describing translation of property values (actual information is in WPD Section 2 Properties Overview: Translating Property Values.

Internationalization
and Localization:
Translation

New Functionality

In RSet-based SQL queries, two new variables available (adjust sysdate for user's session and pass connectionid to the RSet routine), plus new function to adjust date column value based on connectionid.

WPD Section 2 Properties Overview:
Variables:
Specialized Variables

Java Packages, Classes, and Methods

New Functionality

•	New method added to httpUtil to get the request parameter into a hashmap (useful when calling actions).
•	Cache added to getprofile method.
•	New interface executeUpdate added to DBAccess.
•	DatabaseUtil converted to DBUtil.
•	DataSetUtil changed to drive from a DBAccess interface.

Javadoc for the sapphire.* Packages

Large Result
Set Retrieval

New Functionality

New Max Rows/Retrieve property (limits the number of records retrieved).

WPD Section 5 Elements:
List Element:
Properties

New attributes for <sapphire:sdi> tag:

•

mergequerywhere merges values of queryid and querywhere attributes into a single query.

NOTE:

The SDI KeyId, SQL query, and SAPPHIRE Query data retrieval options were always mutually exclusive in SAPPHIRE V3.3. If you use the mergrequerywhere attribute, you can now use the SAPPHIRE Query (queryid attribute ) and SQL Query (querywhere attribute) together.

•

retrievelimit restricts the maximum number of rows (records) to retrieve.

•

versionstatus specifies the value of the "versionstatus" column by which you want to filter the retrieved data (for use with Versioned SDIs).

SDI Tags:
Required Tags:
Descriptions:
sdi

New global setting to specify the maximum number of rows (records) that can be retrieved for a single query.

SAPPHIREAdmin Diagnostic and Configuration Tools:
System Tools:
Queries and Locks

List Element Refresh
(in conjunction with AdvancedSearch)

New Functionality

New "Last Search" option added to the "Default Select" property (causes the AdvancedSearch Element to remember the last executed search upon return to the List Page).

WPD Section 5 Elements:
AdvancedSearch:
Properties

LDAP User
Authentication

New Functionality

New feature provides an interface for user verification utilizing LDAP protocol.

SAPPHIREAdmin:
Security:
External Authentication

Maint Element Defaults

New Functionality

New Default Value property (uses this value when creating new SDIs - overrides Template values).

WPD Section 5 Elements:
Maint Element:
Properties

Maint Element
Display

New Functionality

•	New Fixed Column property makes left-most columns stationary and generates a horizontally-scrolling Maintenance Grid.
•	New dropdowncombo Column Mode is a combination of "input" and "dropdownlist" display modes.
•	New default Column Mode for use when no mode is selected.
•	New retrievedata Column Mode retrieves the value in the column but does not render it on the page.
•	New DropdownSQL property used to retrieve data in dropdownlist mode.

WPD Section 5 Elements:
Maint Element:
Properties

Maint Element Validation

New Functionality

New built-in Maint Element client-side validation rejects selected varchar fields.

WPD Section 5 Elements:
Elements:
Maint Element:
Properties