Initialize a Generic Visualization Business Area Instance

Use this API to initialize a business area instance with a given currency and blinding access type to determine which data is displayed. The visualization tool must run this API each time:

• A user logs in.
• The user changes the currency or blinding setting.
• A user selects a business area to view. Users can view multiple business areas in a single session as long as the user selects compatible blinding settings for all business areas.

  If the user selects a blinding access type for a business area that is incompatible with the blinding access types selected for other business areas in the same session, the API errors out with the message, "There is a change in reading dummy data to blinded data or vice-versa. Please reset access to all business areas using resetBAAccess api and try again." See Reset a Generic Visualization Business Area Instance.

If the currency and the blinding access values are not set by the user, the API uses the default values, which are to show current and nonblinded data.

Tip:

There are two versions of API CDR_PUB_API_GVA.setInitializeBa with the same name. One allows entering a timestamp for the currency, while the other one accepts either the value CURRENT or a snapshot label.

Signature for Version 1

PROCEDURE SETINITIALIZEBA(
PI_COMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE,
PI_OBJID     IN CDR_NAMINGS.OBJ_ID%TYPE,
PI_OBJVER    IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
PI_VCURRENCY IN VARCHAR2,
PI_VBLINDINGACCESSTYPE IN VARCHAR2,
X_RETURN_STATUS     OUT NOCOPY  VARCHAR2,
X_MSG_COUNT         OUT NOCOPY  NUMBER,
X_MSG_DATA          OUT NOCOPY  VARCHAR2)

Signature for Version 2

PROCEDURE SETINITIALIZEBA(
PI_COMPANYID IN CDR_NAMINGS.COMPANY_ID%TYPE,
PI_OBJID     IN CDR_NAMINGS.OBJ_ID%TYPE,
PI_OBJVER    IN CDR_NAMING_VERSIONS.OBJ_VER%TYPE,
PI__REFRESHTS IN DATE,
PI_VBLINDINGACCESSTYPE IN VARCHAR2,
X_RETURN_STATUS     OUT NOCOPY  VARCHAR2,
X_MSG_COUNT         OUT NOCOPY  NUMBER,
X_MSG_DATA          OUT NOCOPY  VARCHAR2)

Parameters

PI_COMPANYID. Enter the business area instance's company ID.

PI_OBJID. Enter the business area instance's object ID.

PI_OBJVER. Enter the business area instance's object version.

PI_VCURRENCY. Enter Current or a snapshot label common to all Table instances. See Get Snapshot Labels Common to all Tables in a BA Instance for a Given Blinding AccessType.

OR

PI_DREFRESHTS Timestamp of the data currency required. Use any valid Oracle date or datetime format. The system displays data that was current at the date and time specified. For example, if data was loaded for the first time at 1:00 pm and then again at 2:00 pm:

• If the user specifies a timestamp of 1:30 pm, the visualization displays data loaded at 12:00.

• If the user specifies a timestamp of 12:00 pm, the visualization displays no data.

• If the user specifies a timestamp of 4:00 pm, the visualization displays data loaded at 2:00 pm.

PI_VBLINDINGACCESSTYPE. Enter the blinding access type. The allowed values are: NA/Dummy, Masked Data, Real(Unblinded), and Real(BlindBreak). Note that there is no space between Real and the parentheses/brackets.

• NA/Dummy: The user sees dummy data for data blinded at the table level.

• Masked Data: The user sees masking values for data blinded at the column, row, or cell level.

• Real (Unblinded): The user sees real data in unblinded table instances. This option is available only if all the business area's table instances whose Blinding flag is set to Yes have a Blinding Status of Unblinded.

• Real (Blind Break): The user sees currently blinded data in blinded table instances.

• Real (Unblinded) and Real (Blind Break) can be specified together: The user sees unblinded data in business area instances where this option is available (all table instances that have their Blinding Flag set to Yes must have a Blinding Status of Unblinded) and currently blinded data in other business area instances in the same session.

  Tip:

  There is no space between Real and the parentheses/brackets.