Content

Overview

API Integration

Additional Information

   

 

Overview

Top ../images/arwup.gif (846 bytes)

If an SDC has the "Allow Activate/Deactivate" option set (see Definition Options for SDCs), its SDIs become "Activeable". "Activeable" SDIs can be declared as "Active" (in use) or "Inactive" (no longer in use). When an SDC is "Activeable":

Users with the "View Hidden" Role can:
See "Active" and "Inactive" SDIs.
"Activate" SDIs that are "Inactive".
Users who do not have the "View Hidden" Role can:
See only "Active" SDIs.
"Deactivate" SDIs that are "Active".

Users with "View Hidden" Role can see the "Show Hidden Records" and "View Hidden Records" selections in the upper right of the Layout.

These toggle between showing and hiding Inactive SDIs. When Inactive SDIs are shown, the "Showing All Records" banner is displayed in the page header as shown below.

For Users with the "View Hidden" Role, List pages (MaintenanceList Page Type) and Maintenance pages (MaintenanceList Page Type) for an Activeable SDC contain Menu operations to:

Show Records (lets Users with the "View Hidden" Role see "Active" and "Inactive" SDIs).
Hide Records (hides "Inactive" SDIs).

 

API Integration

Top../images/arwup.gif (846 bytes)

The following API integration is available for Activeable SDCs:

Actions

The SetActiveFlag Action can set the value in the ActiveFlag column of the SDC to Y or N (makes the SDC Activeable or not). 

The AddSDI Action sets the ActiveFlag to "Y" by default on all newly created SDIs unless you specifically pass it in as "N".

Page Types

Setting the MaintenanceList Page Type property "Show Hidden Records" to "Yes" shows both Active and Inactive SDIs in the page regardless of User's Role.

Java Public API

For Activeable SDCs, sapphire.accessor.SDIProcessor returns SDIs with the ActiveFlag set to "Y". To get Inactive SDIs, set "showHiddenRecords" to "true" on sdiRequest, i.e.,

sdiRequest.setShowHiddenRecords( true );

 

Additional Information

Top../images/arwup.gif (846 bytes)

Activating a Versioned SDI activates all of its Versions. Deactivating a Versioned SDI deactivates all of its Versions.