GlobaldataAdminService

The GlobaldataAdminService includes functions to get information about and administer case models.

The table below lists the functions available from the GlobaldataAdminService.

For more information about administering case models, see Case Data Models.

Function Description Returns
getAuditInfo Returns all the CREATE/UPDATE/DROP scripts that have been edited for a case model, including, who performed the operation (for example, the system or the user) and when. It also returns any previously generated scripts. For example, you may have five previous update scripts if you have deployed five different versions of the same case model major version.

Required system action: accessGlobalDataScripts

GetAuditInfoResponseType
getCaseClassInfo

--or--

getCaseClassInfoAlt1

--or--

getCaseClassInfoAlt2

Lists all the case classes and their attributes for a specific case model. This information can then be used when searching for case data.

The request can specify any of the following:

  • the name of the application that generated the case model, as well as the major version number of the application, specified in TIBCO Business Studio at design-time. You can get the application name and major version number by running getCaseModelBasicInfo (see below).

    --or--

  • the case model ID. The case model ID can be obtained using the getCaseModel or getCaseModelBasicInfo function (see below).

    --or--

  • neither the application name nor the case model ID. This results in all case classes on the system being returned.

The response returns all the case classes and attribute information for the specified case model.

Required system action: readGlobalData

GetCaseClassInfoResponseType
getCaseModel Lists the CREATE/UPDATE/DROP database scripts for all deployed case models. Use this to retrieve the database scripts for the case models.

Required system action: accessGlobalDataScripts

GetCaseModelResponseType
getCaseModelBasicInfo Lists basic information about all deployed case models. Use this function to discover all case models.

Required system action: readGlobalData

GetCaseModelBasicInfoResponseType
notifyCleaned Notifies the system when the case model database has been manually cleaned up after auto remove of tables failed.

Required system action: administerGlobalDataScripts

OperationDetailsType
notifyCreated Notifies the system that the CREATE script has been executed on the database and the database schema for the case model has been generated.

Required system action: administerGlobalDataScripts

OperationDetailsType
notifyDropped Notifies the system that the DROP script has been executed on the database and the database schema for the case model has been dropped.

Required system action: administerGlobalDataScripts

OperationDetailsType
notifyFreeze Freezes the case model.

Freezing a case model means that no further updates can be made to any of the database scripts and that no newer minor version of this case model can be deployed to update the frozen model.

Required system action: administerGlobalDataScripts

OperationDetailsType
notifyUnfreeze Unfreezes the case model.

Required system action: administerGlobalDataScripts

OperationDetailsType
notifyUpdated Notifies the system that the UPDATE script has been executed on the database the database schema for the case model has been updated.

Required system action: administerGlobalDataScripts

OperationDetailsType
updateDBScripts Updates the existing CREATE/UPDATE/DROP database scripts with any required changes.

Although editing the scripts is possible, TIBCO does not recommend this unless it is essential. There are only a few changes that you are allowed to make.

The request must specify the case model ID whose database scripts need updating and the new scripts that you want to use. You must include the entire script.

Note:
  • No validation is performed on the scripts when you edit them in Data Admin. This means it is possible to make invalid changes to your scripts.
  • If the CREATE script is changed (for example, index or foreign key names), you must edit the UPDATE/DROP scripts, to reflect the changes.
  • If you have edited an UPDATE script and the business object model is updated, the new UPDATE script that is generated restores the original values and settings. This means you must manually edit the newly generated UPDATE script with your original changes.

Required system action: administerGlobalDataScripts

OperationDetailsType