Modules

The database comprises a number of different modules that correspond to different business areas. For example, there are modules for Problem Management, Change Management, Request Management, and so on. Each of these modules contains a number of business objects that you use to capture information and a top-level object that you can create processes for.

You can also add new modules to your database to support additional business needs in your organisation, and transfer them to a different database. For example, you could add a new Facilities Management module to handle your organisation's facility management processes.

Creating a module

When you create a new module, you specify a top-level object for it that you can create processes for, and the software automatically creates the objects and behaviours required to provide the basic features for a process module.

In addition to the top-level object, creating a new module creates the following objects:

  • Assignment
  • Category
  • Escalation Point
  • Note
  • Reminder
  • Reminder Recipient
  • Task
  • Task Assignment
  • Task Category
  • Task Escalation Point
  • Task Note
  • Task Reminder
  • Task Reminder Recipient
To create a new module:
  1. In Object Designer, select the Modules node at the top of the Business Objects tree.
  2. In the Actions list, click New Module.
    The New Module dialog appears.
  3. In the Module Title box, type the name for the module you want to create. For example, Facilities Management.
  4. In the Top-level Object Title box, type the name that you want to use for the top-level process object. For example, Facilities Request.
  5. Click OK.
    The New Module dialog closes and the new module and its default objects are created.
  6. Click Save icon.
    The new module and its default objects are saved.

You can now add new objects and attributes to the new module as required, and design windows, processes, queries, and so on as for any other module.

For information about how to create a Reinitialise action in a new module, see Reinitialise: switching between processes within a module.

Using processes from a new module with Service Catalogue

If you want to use a process from your new module with Service Catalogue, you need to add the ConfigurationItemType Relationship behaviour to the top-level object.

To configure a new module to work with Service Catalogue:
  1. In Object Designer, open the top-level object that you want to use with Service Catalogue.
  2. Click the object name at the top of the Attributes tree, then in the Properties grid, click Ellipsis icon alongside Behaviours.
    The Behaviour Selection dialog appears.
  3. In the Available Items list, select ConfigurationItemType Relationship, then click Right arrow.
    ConfigurationItemType Relationship moves to the Selected Items list.
  4. Click OK, then click Save icon.
    The attributes Configuration Item, Configuration Item Type, and Configuration Item Type Reference are added to the object.

Locking and transferring modules

If you are logged in to Console as a user who has their culture set to the default language, you can export locked modules using Design Transfer so that they can be imported into another database.

When you have locked a module, you can use Design Transfer to export only the entire module. You cannot export individual windows, processes, and so on from a locked module unless you unlock it. The branches that correspond to locked modules under the Service Desk folder in the Export tree in Design Transfer are removed.

When you lock a module, you supply two passwords: a publisher password and a subscriber password. The publisher password locks the module for editing and makes it available for exporting. The subscriber password enables someone who has imported a module into a different database to unlock it and make changes to it. If a subscriber DOES NOT unlock their imported module, then they can accept future versions of the module supplied by the publisher as updates to the module. If a subscriber DOES unlock their imported module, they can no longer import updates to it.

Never provide the publisher password when you provide an exported module. This password is only for the publisher to unlock the module so that it can be modified to generate a new version to give to subscribers.

To lock and export a module:
  1. On the Business Objects tree in Object Designer, select the module that you want to export.
  2. On the Actions list, click Lock.

    The Lock The Module dialog appears.
  3. Enter and confirm a Publisher Password and a Subscriber password, then click OK.

    The module is locked. You can no longer edit the module.
  4. Start Design Transfer.
    If you are logged in to Console as a user who has their culture set to the default language, the Export tree includes a new folder called Modules.
  5. In the Export tree, expand the Modules folder.

    The modules that are locked appear.
  6. Select the module that you want to export, then click Export Module.

    The Publisher Password Validation dialog appears.
  7. Enter the publisher password for the selected module, then click OK.

    The Save As dialog appears.
  8. Select a folder and filename for the XML file, then click Save.

    The entire module is exported to the specified XML file. This may take several minutes.
  9. Pass the XML file and the Subscriber password to the subscriber.

DO NOT provide the Publisher Password.

When a subscriber has the XML file, they can import the module into their own database.

To import a module:
  1. Start Design Transfer, and display the Import tree ().
  2. On the Actions list, click Open Import File.

    The Open dialog appears.
  3. Select the XML file you have been provided with.

    The file is validated.
  4. On the Actions list, click Import.

    The module is imported. This may take several minutes.

When you have imported the new module, you can use all of its features as provided.

Limitations of locked modules

If you have a locked module, you can still add Web Access queries, and create, update or delete instances of service levels, ordered lists, reference lists, and categories for the module.

If you want to modify the module using Object Designer, Window Manager, Process Designer, Query and Report Designer, or Template Designer, you first need to unlock it using Object Designer.

To unlock a module for editing:
  1. Select the module in the Business Objects tree in Object Designer, then on the Actions list, click Unlock.

    The Unlock Module dialog appears.
  2. Select the Subscriber option button, then enter the subscriber password for the module and click OK.

    The module is unlocked and can be edited.

If you unlock a module you cannot accept future updates from the publisher of the module.

Importing an update to a module

If you have never unlocked a module, you can import updates to it that are provided by the publisher. Changes made to an updated module are merged into the original module. If categories, ordered lists, reference lists, or response levels are different, then you are asked which ones you want to keep.

When you import an updated module, you are told about any objects or attributes that have been removed from the module so that you can fix any Web Access queries, Crystal Reports, and so on that you have created that may have relied on those objects and attributes.

Deleting modules

You can delete certain unlocked modules from your database using the Delete Module action in Object Designer. Modules that you cannot delete are:

  • System
  • Metadata
  • Lifecycle
  • User Interface
  • User Management
  • Any data connection
  • Any external module
  • Email
  • Management Information
  • Management Suite

You cannot delete modules that are referenced from other modules until you have removed those references.