Jump to: navigation, search

Exporting Rules Packages

You can export an entire rule package containing the rule definitions, business calendars, and references to the templates and versions that the rule package is dependent on, to an .XML file.

It is not necessary to export the rule templates if you are exporting to the same system (for example, backing up or restoring a rule package) or to an equivalent system (for example, a lab versus a production environment). However, if you are moving the rule package to a new system or sending it to Genesys for service, you should export both the rule templates and the rule packages so that, when imported, all referenced templates are available in the target system.

Important
The last-modified-by date and all rule audit history are not part of the rule package (or rule) export.  Package and rule history are not maintained.

Refer to Exporting Rule Templates for details on how to export rule templates.

Exporting rule packages enables you to do the following:

  • Copy an entire rules configuration from a test environment to a production environment.
  • Perform a backup of the entire rules configuration before performing a Genesys Rules System upgrade.
Important
In order to export a rule package, you need to have View Rule and View Business Calendar permissions.

To export a rule package:

  1. Select the Tenant to which the rule package belongs from the drop-down list.
  2. In the Explorer Tree, select the correct node (the level at which the rule package was defined).
  3. Click Export Rule Package. The selected rule package is exported to a single .xml file.
Important
This .xml file contains overall package information (name, type, description, and list of templates and versions), a list of rules (decision tables and linear rules), and a list of business calendars and calendar rules associated with the rule package. This .xml file does not contain the template contents, but does contain a reference to the template names and versions used.

Importing Rules Packages

You can import an entire rule package containing the rule definitions, business calendars and test scenarios for that rule package, from an .XML file.

If it is necessary to import the rule templates, you should import them prior to importing the rule packages, since the rule packages make references to the templates that they use.

It is not necessary to import the rule templates if you are importing or exporting from the same system (for example, backing up or restoring a rule package) or from an equivalent system (for example, a lab versus a production environment). However, if you are importing the rule package to a new system or sending it to Genesys for service, you should export both the rule templates and the rule packages so that, when imported, all referenced templates are available in the target system.

Important
The last-modified-by date and all rule audit history are not part of the rule package (or rule) export. So, when re-importing an exported rule package, the user doing the importing becomes the new owner of each rule created. Package and rule history are not maintained. The imported rules is considered a new rule package with new history starting from the point of import.

Refer to Importing Rule Templates for details on how to import rule templates.

Importing rule packages enables you to do the following:

  • Copy an entire rules configuration from a test environment to a production environment.
  • Perform a backup of the entire rules configuration before performing a Genesys Rules System upgrade
Important
To import a rule package, you must have Create Package and Create Business Calendar permissions.

To import a rule package:

  1. Select the Tenant to which the rule package belongs from the drop-down list.
  2. In the Explorer Tree, select New Rules Package under the appropriate Solution.
  3. Click Import Rule Package. A dialog box opens in which you to enter the Package Name and the Business Name, and select the .xml file to be imported.
  4. Check  Auto-save each rule to auto-save each rule on import. This option should only be used if the rule package is known to be valid on the target system, such as when copying between two identical systems (a lab versus a production environment). Auto-save commits each rule in the package without validating that it matches the underlying templates.  If you do not use this option, each rule is imported in the draft state and must be saved manually. This method shows any validation errors and gives the rule author the opportunity to fix them before deployment.
  5. Check Auto-create business hierarchy during import to tell GRAT to automatically create any missing nodes in your business hierarchy for rules that are contained within the .xml file.  For example, if this option is selected, during the import if there is a rule that is associated with the “Widget Sales” department, but no such department is defined in the business hierarchy, GRAT will attempt to create it during the import operation. The GRAT user who is performing the rule package import must have permission to create this folder.  If the box is not checked and there are rules associated with missing nodes, the import will fail.
  6. Click Import.

    Exporting Rules Templates

    You can export rule templates to an .XML file. Rule templates are stored in the repository as separate assets so they can be used by multiple rule packages. The rule templates are not part of the rule package themselves; the rule package refers to the rule templates that it needs.

    It is not necessary to import or export the rule templates if you are importing or exporting to the same system (for example, backing up or restoring a rule package) or to an equivalent system (for example, a lab versus a production environment). However, if you are moving the rule package to a new system or sending it to Genesys for service, you should export both the rule templates and the rule packages so that, when imported, all referenced templates are available in the target system.

    Refer to Exporting Rule Packages for details on how to export rule packages.

    Important
    To export a rule template, you must have View Template permission and Read access for the Script objects that represent the templates being exported.

    To export a rule template:

    1. In the Explorer Tree, select the Tenant tab.
    2. Click Export Rule Templates. A dialog box opens in which you select the .xml file to import.
        Important
        You must export all versions of the templates so that on the target system, the repository can be reconstructed with the same version numbering as on the source system.
        Warning
        Be careful when changing templates or template versions, as it could affect existing rules. For example, an existing rule might use a condition that does not exist in a different version of the template. Consult with the rule template developer to ensure that you are choosing the correct templates and versions for your application.

    Importing Rules Templates

    Important
    A template exported with a pre-8.1.2 version of GRAT cannot be imported with release 8.5.x.

    You can import rule templates from an .XML file. Rule templates are stored in the repository as separate assets, so they can be used by multiple rule packages. The rule templates are not part of the rule package themselves; the rule package refers to the rule templates that it needs.

    If it is necessary to import the rule templates, you should import them prior to importing the rule packages, since the rule packages make references to the templates that they use.

    It is not necessary to import the rule templates if you are importing from the same system (for example, backing up or restoring a rule package) or from an equivalent system (for example, a lab versus a production environment). However, if you are moving a rule package to a new system or sending it to Genesys for service, you should import both the rule templates and the rule packages so that, when imported, all referenced templates are available in the target system.

    Refer to Importing Rules Packages for details on how to import rule packages.

    Important
    To import a rule package template, you must have Create Template permission.

    To import a rule package template:

    1. In the Explorer Tree, select the Tenant tab.
    2. Click Import Rule Templates. A dialog box opens in which you select the .xml file to import.
    Important
    Clicking Replace existing templates in repository clears the repository of any previous versions of each template before the new ones are imported into the target system. If this option is not enabled and an existing template with the same name is found in the repository, an error message appears and the import is terminated.
    Warning
    Be careful when changing templates or template versions as it could affect existing rules. For example, an existing rule might use a condition that does not exist in a different version of the template. Consult with the rule template developer to ensure that you are choosing the correct templates and versions for your application.

    Migration

    Migration to 8.5.001 from 8.5.0

    1. Undeploy the 8.5.0 .war file from your application server.
    2. Important
      Do not just copy the 8.5.0001 .war file over the 8.5.0 .war file in your application server directory. Genesys recommends undeploying the previous file first and letting the application server clean up its files, then deploying the new .war file.
    3. Deploy the 8.5.0001 .war file to your application server.
    4. Set the values of any of the new configuration options—see GRAT Configuration Options.
    5. Log into 8.5.0001 Genesys Rules Authoring Server.

    Migration to 8.5.0/8.5.001

    From 8.1.4

    1. Undeploy the 8.1.4 .war file from your application server.
    2. Important
      Do not just copy the 8.5.0 .war file over the 8.1.4 .war file in your application server directory. Genesys recommends undeploying the previous file first and letting the application server clean up its files, then deploying the new .war file.
    3. Deploy the 8.5.0 .war file to your application server.
    4. Important
      If you have a very large repository database, it may take several minutes the first time you deploy the 8.5.0 .war file, as GRAT must rebuild the index cache. Once this process is complete, the user will be able to log in to the system.
    5. Log into 8.5.0 Genesys Rules Authoring Server.


    From 8.1.3

    1. In 8.1.4, the repository database configuration was moved to a Database Access Point (DAP). Create and configure a DAP and add it as a connection to the GRAT application object. You will no longer be prompted for database configuration information during the installation process.
    2. See the following procedures for details of how to create a DAP:

  7. Undeploy the 8.1.3 .war file from your application server.
  8. Important
    Do not just copy the 8.5.0 .war file over the 8.1.3 .war file in your application server directory. Genesys recommends undeploying the previous file first and letting the application server clean up its files, then deploying the new .war file.
  9. Deploy the 8.5.0 .war file to your application server.
  10. Important
    If you have a very large repository database, it may take several minutes the first time you deploy the 8.5.0 .war file, as GRAT must rebuild the index cache. Once this process is complete, the user will be able to log in to the system.
  11. Log into 8.5.0 Genesys Rules Authoring Server.
  12. From 8.1.2 and 8.1.1

    1. From the 8.1.1 or 8.1.2 Genesys Rules Authoring Server:
      1. Click on each tenant and export the templates associated with that tenant as an XML file.
      2. Click on each rule package that you wish to migrate and export as an XML file.
    2. Create a new database for GRAT 8.5.0 (leaving the old one in place).
    3. Install 8.5.0 Genesys Rules System.
    4. Start 8.5.0 Genesys Rules Authoring Server. This creates the tables inside the new database.
    5. Log into 8.5.0 Genesys Rules Authoring Server.
    6. For each tenant, import the template XML file (from step 1a).
    7. For each tenant, and under each solution, click on New Rule Package and import the corresponding rule package XML file (click the Auto-save option).
    8. Redeploy each rule package to the corresponding 8.5.0 Genesys Rules Engine(s).
    9. Optionally, from the Genesys Rules Deployment Tool, you may import the templates from the 8.5.0 Genesys Rules Authoring Server.


    See the GRAT online Help for explicit steps for importing and exporting templates, and importing and exporting rules packages.

    Important
    Running an 8.5.0 Rules Authoring Server against an 8.1.2 repository will result in a corrupted repository that will no longer be useable by any version of the Rules Authoring Server.

    Repository Performance Enhancement for Oracle 11 users

    For Oracle users, a performance enhancement is available that is enabled only when you create a new database repository when either initially installing, or migrating to, 8.5.x. For a new installation with a new Oracle database repository, no additional steps are required. If you are migrating to GRS release 8.5.x from an earlier release, to take advantage of the enhancement, do the following:

    1. Click on each tenant and export the templates associated with that tenant as an XML file.
    2. Click on each rule package that you wish to migrate and export as an XML file.
    3. Create a new database for GRAT 8.5.x.
    4. Start 8.5.x Genesys Rules Authoring Server.
    5. With the enhancement, when GRAT initializes, it creates new database tables based on a new optimized schema, and database performance is improved.
      Important
      If you re-use your existing 8.1.3/8.1.4 repositories, GRAT does not re-create the tables with the new schema. In this scenario, there is no performance enhancement.
    This page was last modified on September 4, 2014, at 11:19.

    Feedback

    Comment on this article:

    blog comments powered by Disqus