tcmbuild.kb 的例行程序


TCM_CheckDependencies

文件名

tcmbuild.kb

语法

TCM_CheckDependencies(VAL tablesToBeBuilt: LIST OF INTEGER, REF dependencyErrors: LIST OF STRING) IS

参数

tablesToBeBuilt - 要建立或移植的产品的应用程序标识。

dependencyErrors - 相关性检验的返回状态

返回

副作用

说明

该过程确定是否可以创建或移植此产品的表(其它产品的表要基于此建立或移植为新版本)。如果因为与其它产品的相关性而无法建立该产品的表,则 dependencyError 就会设置为一系列字符串,说明缺少相关性,每个字符串中必须有一个相关性。如果不存在相关性问题,则 dependencyError 就会设置为 $UNKNOWN。

调用的对话框窗体


TCM_GetCurrentTableVersion

文件名

tcmbuild.kb

语法

TCM_GetCurrentTableVersion(VAL applicationID: INTEGER, REF oldVersion: VERSION_REC) IS

参数

applicationID - 此应用程序的整数标识(用来

索引 SAI_APP_PARAMS 表)

oldVersion - 目前已建立的表的版本

将通过调用例行程序,设置成当前存储

在 SAI_APP_PARAMS 表(如果存在)中的

版本号

返回

副作用

说明

该过程确定表是否是在配置的数据库中建立的,并返回表的版本。传入的 oldVersion 将预先设置为 SAI_APP_PARAMS 表(如果存在)的版本号。如果该应用程序总是更新以前发行版中的 SAI_APP_PAPAMS 表,则在此例行程序中不需要做任何操作。

调用的对话框窗体


TCM_GetGrantScripts

文件名

tcmbuild.kb

语法

TCM_GetGrantScripts(REF scriptsToRun: LIST OF STRING)

参数

scriptsToRun - 将要运行的许可脚本

返回

带有将要运行的许可脚本的 scriptsToRun

副作用

说明

根据当前配置的数据库平台,该过程为 TAM 表获取将要运行的许可脚本。

调用的对话框窗体


TCM_GetNextDropScripts

文件名

tcmbuild.kb

语法

TCM_GetNextDropScripts(REF currentScript: INTEGER, REF scriptsToRun: LIST OF STRING) IS

参数

currentScript - 正在执行的当前脚本的索引

scriptsToRun - 要运行的脚本列表

返回

副作用

说明

该过程提供下一步要执行的删除数据库脚本的文件名表。自变量 currentScript 可用来跟踪已运行了什么样的脚本。此例行程序为 currentScript 设置的值在下次调用时可再提供给它。如果 currentScript 的接收值是 $UNKNOWN,则应提供第一个脚本。如果所有的脚本都运行过了,则 currentScript 设置为 $UNKNOWN。相应的脚本列表是根据确定选择和配置什么样的 DBMS 的全局 paramRDBMS 决定的。

调用的对话框窗体


TCM_GetNextScripts

文件名

tcmbuild.kb

语法

TCM_GetNextScripts(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, REF currentScript: INTEGER, REF scriptsToRun: LIST OF STRING) IS

参数

buildAction - 确定是运行移植还是运行新建立

oldVersion - 将要移植过来的旧版本

newVersion - 将要移植过去的新版本

currentScript - 当前正在执行的脚本的索引

scriptsToRun - 将要运行的脚本列表

返回

副作用

说明

该过程提供了一系列下一步要执行的数据库脚本的文件路径和文件名(路径起始于 ESMBuild 目录,其中脚本都位于名称为产品名缩写的一个子目录中,如 ee\scriptname.ext 之后)。自变量 currentScript 可用于跟踪已运行了哪些脚本。此例行程序为 currentScript 设置的值会在下次调用它时再反馈给它。如果 currentScript 的接收值是 $UNKNOWN,则应提供第一个脚本。如果所有的脚本都运行过了,则 currentScript 设置为 $UNKNOWN。相应的脚本列表是根据输入参数确定的,这些参数指定将执行什么样的建立活动、从什么版本移植过来或移植到什么版本(如果执行移植)。全局 paramRDBMS 用来确定选择与配置什么 DBMS。

调用的对话框窗体


TCM_GetRevokeScripts

文件名

tcmbuild.kb

语法

TCM_GetRevokeScripts(REF scriptsToRun: LIST OF STRING)

参数

scriptsToRun - 将要运行的撤回脚本

返回

带有要运行的撤回脚本的 scriptsToRun

副作用

说明

根据当前配置的数据库平台,该过程为 TAM 表获取将要运行的撤回脚本。

调用的对话框窗体


TCM_PostScriptExecution

文件名

tcmbuild.kb

语法

TCM_PostScriptExecution(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, VAL currentScript: INTEGER, VAL scriptStatus: Boolean,VAL wHdl: WINDOW, REF actionStatus: INTEGER) IS

参数

buildAction - 确定是运行了移植还是运行了新建立

oldVersion - 移植过来的旧版本

newVersion - 移植过去的新版本

currentScript - 当前正在执行的脚本的索引

scriptStatus - 以前执行的脚本的成功状态

wHdl - 将消息返回到的窗口句柄

actionStatus -正在执行的操作的返回状态

返回

副作用

说明

该过程是一种调出,它允许产品的特定的代码在执行完一系列数据库脚本之后执行。提供了输入参数,以允许此例行程序知道自已正在建立过程的何处执行。该值指定调用例行程序仅执行什么脚本。输出参数 actionStatus 的用途是允许该例行程序从该产品的建立进程中异常退出。如果 actionStatus 返回值为 1,则此产品的建立将继续进行。如果 actionStatus 返回的值不是 1,则此产品的建立将会异常终止。

调用的对话框窗体


TCM_PreScriptExecution

文件名

tcmbuild.kb

语法

TCM_PreScriptExecution(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, VAL currentScript: INTEGER, VAL wHdl: WINDOW, REF actionStatus: INTEGER) IS

参数

buildAction - 确定是运行移植还是运行新建立

oldVersion - 将要移植过来的旧版本

newVersion - 将要移植过去的新版本

currentScript - 当前正在执行的脚本的索引

wHdl - 将消息返回到的窗口句柄

actionStatus -正在执行的操作的返回状态

返回

副作用

说明

该过程是一种调出,它允许产品的特定的代码在执行完一系列数据库脚本之前执行。提供了输入参数,以允许此例行程序知道自已正在建立过程的何处执行。该值指定调用例行程序将要执行什么样脚本。输出参数 actionStatus 的用途是允许该例行程序从该产品的建立进程中异常退出。如果 actionStatus 返回值为 1,则建立将继续进行。如果 actionStatus 返回的值不是 1,则建立将会异常终止。

调用的对话框窗体


TCM_SupportMigration

文件名

tcmbuild.kb

语法

TCM_SupportMigration(VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, REF supportMigration: BOOLEAN) IS

参数

oldVersion - 要移植过来的旧版本

newVersion - 准备移植过去的新版本

supportMigration - 确定是否支持移植的标志

返回

副作用

说明

该过程确定该产品是否支持把表从指定的旧版本移植到指定的新版本中。如果支持移植,则 supportMigration 就设置为 TRUE。

调用的对话框窗体