REMOVEMODULE Method [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== REMOVEMODULE Method ======


 
==== Description ====
 
Method for removing a module identifiers from a repository entity.
 
==== Syntax ====
 
//retval// = **Repository**('REMOVEMODULE', //entID, module_name//)
 
==== Parameters ====
 
The REMOVEMODULE method has the following parameters.

^Parameter^Description^
|//Message//|'REMOVEMODULE'|
|//entID//|//entID// consists of four elements, which are '*' (asterisk) delimited:\\ \\ * Application name\\ * Type ID\\ * Class ID\\ * Entity name|
|module_name|The name of the module to be removed from the entity's SYSREPOS record.|

 
==== Returns ====
 
Null.
 
==== Remarks ====
 
The module name is field 8 within the SYSREPOS record for the Entity.  The module name allows for the creation of named modules within OpenInsight.  The RDK tool has an option within the Repository View creation to create RDKs based on Modules.  The RDK tool will then build deployments based on the module name.

 

This is available in OpenInsight 9.2 and above.  In 9.2 it is a programmatic function only.  In 9.2.1, the Module Manager was introduced to create and organize Modules.

 

**Note:**  Always call the [[get_status|Get_Status function]] after calling Repository.
 
==== See Also ====
 
[[repository|Repository() function]], [[setmodule|SETMODULE method]], [[addmodule|ADDMODULE method]], [[clearmodule|CLEARMODULE method]], [[getmodule|GETMODULE method]]
 
==== Example ====
 
<code>


* Remove a Module Name from an Entity

 

Declare Function Repository

 

* Create an array of entities to use Module methods against

reposStack  = ""

reposStack := @appid<1> : "*OIWIN**CUSTOMERS" : @fm

reposStack := @appid<1> : "*OIWINEXE**CUSTOMERS" : @fm

reposStack := @appid<1> : "*POPUP**CUSTOMERS"

 

removeThisModuleName = "CUSTOMER_INVOICE"

 

* Remove a Module name to the entities

 

rPos = 0

rFlag = ""

module = ""

 

Loop

   Remove thisEntity From reposStack at rPos setting rFlag

      var = Repository( "REMOVEMODULE", thisEntity, removeThisModuleName )

      If Get_Status(ErrCode) then

         call msg(@window, 'Error Message returned: ' : ErrCode)

      end

   While rFlag

Repeat

 
</code>