Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Configure script access to encrypted data

Execute a script to run the cryptographic module policy for a cryptographic purpose. Specific read (decrypt/unwrap) or write (encrypt, wrap) access can be defined based on the module access policy operation granularity.

Before you begin

Role required: sn_kmf.cryptographic_manager

About this task

Examples of uses are for Business Rules and Script Includes. This procedure uses a script for Business Rules.

Procedure

  1. Create a cryptographic module with the symmetric data encryption/decryption algorithm.

    Refer to Create a cryptographic module for details. Specific access to the data or attachment is controlled with a module access policy with the following characteristics:

    • Symmetric encryption: The script is able to encrypt data but unable to decrypt the data.
    • Symmetric decryption: The script is able to decrypt uploaded encrypted data or attachment but unable to encrypt data or attachments.
    • Symmetric encryption and decryption: The script is able to both encrypt and decrypt data or attachments.
    • Navigate to System Definition > Business Rules.
  2. Click New.

Image omitted: business-rule-script.png
New Business Rule record.
  1. Complete the form on the When to run tab and enter the script on the Advanced tab:
FieldDescription
NameEnter a name for the business rule.
TableSelect Incident [incident]from the drop-down list.
ApplicationGlobal is selected by default.
ActiveMark the rule as Active.
AdvancedSelect the check box to display advanced options.
When to run tabOn the When to run tab, enable Insert and Update fields.
Advanced tab

On the Advanced tab, paste the following script text at line 3: ```

var gc = global.GlideCryptoModule.getModule('global.acme_mod'); var value = 'test'; var encrypted = gc.encryptData(value); gs.info('value: ' + value); gs.info('Encrypted: ' + encrypted); var decrypted = gc.decryptData(encrypted); gs.info('Decrypted: ' + decrypted); gs.info(decrypted == value);

```

Note: Refer to the "Business Rules Advanced Tab" image for details.

Image omitted: business-rules-advanced.png
Business Rule Advanced tab.
  1. Select Submit.

  2. Navigate to All > System Security > Field Encryption > Field Encryption Experience > Configurations > Access Policies > * *All.

    Note: For additional information, refer to Create a module access policy.

  3. Select Create new.

  4. Select an existing Field Encryption module to associate the Module Access Policy (MAP) with.

  5. Select Create.

  6. Complete the form.

Image omitted: fe-create-map.png
Target script selection.
Module Access Policies fields

|Field|Description|
|-----|-----------|
|Policy name|Enter a name for the policy.|
|Type|Select **Script** to control access by script.|
|Script Table|Select a value from the script table drop-down list. For this example, select **Business Rule \[sys\_script\]**.|
|Result|To give the script access to the module, select **Track** in the **Result** field.|
|Crypto module|Displays the module with the symmetric data encryption/decryption algorithm that you selected.|
|Active|Select to activate the policy.|
|Target Script|Select the script document for the policy. Select the **Table name** and then the related document for the policy. For this example, select the Business Rule that you created in previous steps.|
|Check script version|Select this option to direct the system to perform a version comparison anytime the script is run. If the script has been changed, the user is notified.|
|Specify purpose|Optional. Enable  to  display  the  Crypto  Spec field  on  the  form.  Enable this option to configure granular operations, such as some users being able to encrypt, but not decrypt.|
|Application|The  Application scope  is  auto-populated  by  your  current scope. |
  1. Select Save.

    The Module Access Policy for the script is now available in the system.

  2. View declined cryptographic module usage requests
    View cryptographic modules that rejected encryption requests made by scripts because of unsupported encryption mechanisms.

Parent Topic:Script access for cryptographic modules