This chapter provides detailed descriptions of custom WLST commands for Oracle Fusion Middleware Information Rights Management, including command syntax, arguments and command examples.
The following sections describe the Oracle Fusion Middleware Information Rights Management custom WLST commands in detail. Topics include:
For additional information about Oracle Information Rights Management, see Oracle IRM Administrator's Guide.
Note:
To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.
WLST IRM commands are divided into the following categories:
Table 16-1 WLST IRM Command Categories
| Command Category | Description |
|---|---|
|
Make general changes to Oracle IRM Server settings. |
|
|
Back up and migrate Oracle IRM Server user data. |
|
|
Set up test content for users of Oracle IRM Desktop. |
|
|
Set up languages support for users of Oracle IRM Server. |
|
|
Set up software installation support for Oracle IRM Desktop. |
Use the WLST commands listed in Table 16-2 to make general changes to Oracle IRM Server settings.
Table 16-2 WLST General Server Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new refresh period. |
Online |
|
|
Display an existing refresh period. |
Online |
|
|
Display all the refresh periods. |
Online |
|
|
Remove an existing refresh period. |
Online |
|
|
Update an existing refresh period. |
Online |
|
|
Create a new sync window. |
Online |
|
|
Display an existing sync window. |
Online |
|
|
Display all the sync windows. |
Online |
|
|
Remove an existing sync window. |
Online |
|
|
Update an existing sync window. |
Online |
|
|
Display the cryptography algorithm. |
Online |
|
|
Set the cryptography algorithm. |
Online |
|
|
Display the device count. |
Online |
|
|
Set the device count. |
Online |
|
|
Display the current report record clean-up values. |
Online |
|
|
Set report record clean-up values. |
Online |
|
|
Display the license state clean-up frequency. |
Online |
|
|
Set the license state clean-up frequency. |
Online |
|
|
Display the URL of the privacy statement page. |
Online |
|
|
Set the URL of the privacy statement page. |
Online |
|
|
Display the type and location of the Oracle IRM keystore. |
Online |
|
|
Set the type and location of the Oracle IRM keystore. |
Online |
Online command that creates a new refresh period.
This command creates a refresh period. A refresh period is the maximum length of time that a user can use rights before the rights are refreshed from the server.
addIRMRefreshPeriod(duration,dtype)
| Argument | Definition |
|---|---|
|
|
Specifies the value of the refresh period. Integer. |
|
|
Specifies the unit of the refresh period. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'. |
Online command that displays an existing refresh period.
This command displays the refresh period that is present at the specified index. A refresh period is the maximum length of time that a user can use rights before the rights are refreshed from the server.
getIRMRefreshPeriod(pindex)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the refresh period. |
Online command that displays all existing refresh periods.
This command displays all existing refresh periods. A refresh period is the maximum length of time that a user can use rights before the rights are refreshed from the server.
Online command that removes an existing refresh period.
This command removes a refresh period that is present at the specified index. A refresh period is the maximum length of time that a user can use rights before the rights are refreshed from the server.
removeIRMRefreshPeriod(pindex)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the refresh period. |
Online command that updates an existing refresh period.
This command updates an existing refresh period. A refresh period is the maximum length of time that a user can use rights before the rights are refreshed from the server.
updateIRMRefreshPeriod(pindex,duration,dtype)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the refresh period. |
|
|
Specifies the value of the refresh period. Integer. |
|
|
Specifies the unit of the refresh period. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS' or 'YEARS'. |
The following example updates the refresh period at index zero to have a duration of 5 hours:
wls:/base_domain/serverConfig> updateIRMRefreshPeriod(0,5,\"HOURS\")
The following example updates the refresh period at index zero to have a duration of 50 minutes:
wls:/base_domain/serverConfig> updateIRMRefreshPeriod(0,50,\"MINUTES\")
Online command that creates a sync window.
This command creates a sync window. A sync window is a period during which Oracle IRM Desktop will attempt to contact the server to synchronize rights.
addIRMSyncWindow(day,stHrs,stMins,endHrs,endMins)
| Argument | Definition |
|---|---|
|
|
Specifies the weekday. 'MONDAY', 'TUESDAY', etc. |
|
|
Specifies the start hours. Integer. |
|
|
Specifies the start minutes. Integer. |
|
|
Specifies the end hours. Integer. |
|
|
Specifies the end minutes. Integer. |
Online command that displays an existing sync window.
This command displays a sync window that is present at the specified index. A sync window is a period during which Oracle IRM Desktop will attempt to contact the server to synchronize rights.
Online command that displays all existing sync windows.
This command displays all existing sync windows. A sync window is a period during which Oracle IRM Desktop will attempt to contact the server to synchronize rights.
Online command that removes an existing sync window.
This command removes a sync window that is present at the specified index. A sync window is a period during which Oracle IRM Desktop will attempt to contact the server to synchronize rights.
removeIRMSyncWindow(sindex)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the sync window. |
Online command that updates an existing sync window.
This command updates an existing sync window. A sync window is a period during which Oracle IRM Desktop will attempt to contact the server to synchronize rights.
updateIRMSyncWindow(indexOfDay,day,stHrs,stMins,endHrs,endMins)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the sync window. Integer. |
|
|
Specifies the weekday. 'MONDAY', 'TUESDAY', etc. |
|
|
Specifies the start hours. Integer. |
|
|
Specifies the start minutes. Integer. |
|
|
Specifies the end hours. Integer. |
|
|
Specifies the end minutes. Integer. |
Online command that displays the cryptography algorithm.
This command displays the cryptography algorithm currently applied to files that are sealed using Oracle IRM.
Online command that sets the cryptography algorithm.
This command sets the cryptography algorithm that will be applied to files that are sealed using Oracle IRM. The default of AES128 is recommended.
setIRMCryptoSchema(cryptID)
| Argument | Definition |
|---|---|
|
|
Specifies the name of the cryptography algorithm. Possible algorithm names are AES128, AES256, AES128-FIPS, AES256-FIPS, DES3-FIPS. |
Online command that displays the device count.
This command displays the maximum number of devices on which a user can open a sealed document at one time. The value applies to all users, and does not differ for individual users.
Online command that sets the device count.
This command sets the maximum number of devices on which a user can open a sealed document at one time. The value applies to all users. The device count is normally kept low (1 or 2) to make it difficult to circumvent document access restrictions by sharing passwords.
setIRMDeviceCount(devCount)
| Argument | Definition |
|---|---|
|
|
Specifies the device count value (the number of devices). Integer. |
Online command that displays the current report record clean-up values.
This command displays the report record clean-up values. The values show how often report record clean-ups are performed, and the maximum age of the report records before they are deleted.
Online command that sets report record clean-up values.
This command sets how often report record clean-ups are performed, and the maximum age of report records before they are deleted.
setIRMJournalCleanUp(clDuration,clUnitType,retDuration,retUnitType)
| Argument | Definition |
|---|---|
|
|
Specifies the value for how often report record clean-ups are performed. Integer. |
|
|
Specifies the unit for how often report record clean-ups are performed. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'. |
|
|
Specifies the value for the maximum age of report records before they are deleted. Integer. |
|
|
Specifies the unit for the maximum age of report records before they are deleted. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'. |
Online command that displays the license state clean-up frequency.
This command displays the license state clean-up frequency (the frequency at which license records will be deleted).
Online command that sets the license state clean-up frequency.
This command sets the license state clean-up frequency (the frequency at which license records will be deleted).
setIRMLicenseStateCleanUp(duration,unitType)
| Argument | Definition |
|---|---|
|
|
Specifies the value of the frequency at which license records will be deleted. Integer. |
|
|
Specifies the unit for the frequency at which license records will be deleted. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'. |
The following example sets the frequency at which license records will be deleted to 10 hours:
wls:/base_domain/serverConfig> setIRMLicenseStateCleanUp(10,\"HOURS\")
The following example sets the frequency at which license records will be deleted to 50 minutes:
wls:/base_domain/serverConfig> setIRMLicenseStateCleanUp(50,\"MINUTES\")
Online command that displays the URL of the privacy statement page.
This command displays the URL of the privacy statement page. The privacy statement page displays a statement that users must accept before viewing sealed content.
Online command that sets the URL of the privacy statement page.
This command sets the URL of a privacy statement that users must accept before viewing sealed content.
setIRMPrivacyURL(privacyURL)
| Argument | Definition |
|---|---|
|
|
Specifies the URL of the privacy statement page. |
Online command that sets the type and location of the Oracle IRM keystore.
This command sets the type and location of the Oracle IRM keystore. You should not normally need to change the keystore type and location from the default (type JKS at location ${domain.home}/config/fmwconfig/irm.jks).
setIRMKeyStore()
You will be prompted to provide the following arguments:
| Argument | Definition |
|---|---|
|
KeyStore Type |
Specifies the type of the keystore. |
|
KeyStore Location |
Specifies the location of the keystore. |
Use the WLST commands listed in Table 16-3 to set up import and export of user data between instances of Oracle IRM Server.
Table 16-3 WLST Commands for Import and Export of Oracle IRM user data
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Set or clear the data export folder location. |
Online |
|
|
Display the value for the data export folder. |
Online |
|
|
Set or clear the data import folder location. |
Online |
|
|
Display the value for the data import folder. |
Online |
Online command that sets or clears the data export folder location.
setIRMExportFolder(folder)
| Argument | Definition |
|---|---|
|
|
Specifies the data export folder value. |
Use the WLST commands listed in Table 16-4 to set up test content for users of Oracle IRM Desktop.
Table 16-4 WLST Commands for Test Content
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new test content instance. |
Online |
|
|
Display details for an existing test content instance. |
Online |
|
|
Display details of all existing test content instances. |
Online |
|
|
Remove an existing test content instance. |
Online |
|
|
Update an existing text content instance. |
Online |
Online command that creates a new test content instance.
This command creates a test content instance. Test content instances identify an item of test content, usually an image file. Test content is shown in a sealed document when Oracle IRM Desktop successfully connects to Oracle IRM Server through the client test facility.
addIRMTestContent(uri,localeKeys,testNames)
| Argument | Definition |
|---|---|
|
|
Specifies the URI of the test content (for example, an image file). |
|
|
Specifies the locale(s) associated with this test content instance. Must be from the list of two-letter language codes given in Table 16-5 (for example, 'fr' for French). If there is more than one supported locale for an instance, the two-letter codes must be listed as comma-separated values. |
|
|
Specifies the name(s) associated with this test content instance. If there is more than one name for a URI, they must be specified as comma-separated values. |
Table 16-5 Language codes (ISO 639-1 "two-letter codes")
| Language/Code | Language/Code | Language/Code |
|---|---|---|
|
Arabic: ar |
Greek: el |
Romanian: ro |
|
Brazilian Portuguese: pt-BR |
Hebrew: iw |
Russian: ru |
|
Czech: cs |
Hungarian: hu |
Simplified Chinese: zh-CN |
|
Danish: da |
Italian: it |
Slovak: sk |
|
Dutch: nl |
Japanese: ja |
Spanish: es |
|
English: en |
Korean: ko |
Swedish: sv |
|
Finnish: fi |
Norwegian: no |
Thai: th |
|
French: fr |
Polish: pl |
Traditional Chinese: zh-TW |
|
German: de |
Portuguese: pt |
Turkish: tr |
The following example creates a test content instance comprising an image named exampleImage.jpg at http://irm.example.com, for use with English installations, and showing the name 'Test Content':
wls:/base_domain/serverConfig> addIRMTestContent(\"http://irm.example.com/exampleImage.jpg\",\"en\",\"Test Content\")
The following example creates a test content instance comprising an image named exampleImage.jpg at http://irm.example.com, for use with English and French installations, and showing the names 'Test Content (en)' and 'Test Content (fr)':
wls:/base_domain/serverConfig> addIRMTestContent(\"http://irm.example.com/exampleImage.jpg\",\"en,fr\",\"Test Content (en),Test Content (fr)\")
Online command that displays the details of an existing test content instance.
This command displays the details of the test content instance that is present at the specified index. Test content instances identify an item of test content, usually an image file. Test content is shown in a sealed document when Oracle IRM Desktop successfully connects to Oracle IRM Server through the client test facility.
getIRMTestContent(tindex)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the test content instance. |
Online command that displays all the test content instances.
This command displays all the test content instances. Test content instances identify an item of test content, usually an image file. Test content is shown in a sealed document when Oracle IRM Desktop successfully connects to Oracle IRM Server through the client test page.
Online command that removes an existing test content instance.
This command removes the test content instance that is present at the specified index. Test content instances identify an item of test content, usually an image file.
Online command that updates an existing test content instance.
This command updates an existing test content instance. Test content instances identify an item of test content, usually an image file. Test content is shown in a sealed document when Oracle IRM Desktop successfully connects to Oracle IRM Server through the client test facility.
updateIRMTestContent(tindex,uri,localeKeys,testNames)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the test content instance. Integer. |
|
|
Specifies the URI of the test content (for example, an image file). |
|
|
Specifies the locale(s) associated with this test content instance. Must be from the list of two-letter language codes given in Table 16-5 (for example, 'fr' for French). If there is more than one supported locale for an instance, the two-letter codes must be listed as comma-separated values. |
|
|
Specifies the name(s) associated with this test content instance. If there is more than one name for a URI, they must be specified as comma-separated values. |
The following example updates a test content instance by changing the image to exampleImage.jpg at http://irm.example.com, for use with English installations, and showing the name 'Test Content':
wls:/base_domain/serverConfig> updateIRMTestContent(0,\"http://irm.example.com/exampleImage.jpg\",\"en\",\"Test Content\")
The following example updates a test content instance by changing the image to exampleImage.jpg at http://irm.example.com, for use with English and French installations, and showing the names 'Test Content (English)' and 'Test Content (French)':
wls:/base_domain/serverConfig> updateIRMTestContent(0, \"http://irm.example.com/exampleImage.jpg\",\"en,fr\",\"Test Content (English),Test Content (French)\")
Use the WLST commands listed in Table 16-6 to set up languages support for users of Oracle IRM Server.
Table 16-6 WLST Commands for Oracle IRM Server languages support
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new language support instance. |
Online |
|
|
Display the default language. |
Online |
|
|
Display all the language support instances. |
Online |
|
|
Remove an existing language support instance. |
Online |
|
|
Set the default language, and set a language support instance for one or more additional languages. |
Online |
Online command that creates a new language support instance.
This command creates a new language support instance. Each language support instance provides the facility in Oracle IRM Server to add names and descriptions in one or more languages (in addition to the default language).
addIRMTranslation(transList)
| Argument | Definition |
|---|---|
|
|
Specifies the supported language(s). Must be from the list of two-letter language codes given in Table 16-5 (for example, 'fr' for French). If there is more than one supported language for an instance, the two-letter codes must be listed as comma-separated values. |
The following example creates a language support instance that will enable users of Oracle IRM Server to add names and descriptions in French (in addition to their default language):
wls:/base_domain/serverConfig> addIRMTranslation(\"fr\")
The following example creates a language support instance that will enable users of Oracle IRM Server to add names and descriptions in French and Arabic (in addition to their default language):
wls:/base_domain/serverConfig> addIRMTranslation(\"fr,ar\")
Online command that displays all the language support instances.
This command displays all the language support instances. Each language support instance provides the facility in Oracle IRM Server to add names and descriptions in one or more languages (in addition to the default language).
Online command that removes an existing language support instance.
This command removes the language support instance that is present at the specified index. Each language support instance provides the facility in Oracle IRM Server to add names and descriptions in one or more languages (in addition to the default language).
removeIRMTranslation(tindex)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the language support instance. |
Online command that sets the default language, and sets a language support instance for one or more languages in addition to the default language.
This command sets the default language, and sets a language support instance for one or more languages in addition to the default language. Each language support instance provides the facility in Oracle IRM Server to add names and descriptions in one or more languages (in addition to the default language).
setIRMTranslations(defaultTrans,transList)
| Argument | Definition |
|---|---|
|
|
Specifies the default language. Language code (for example, 'en' for English). |
|
|
Specifies the supported language(s). Must be from the list of two-letter language codes given in Table 16-5 (for example, 'fr' for French). If there is more than one supported language for an instance, the two-letter codes must be listed as comma-separated values. |
The following example enables users of Oracle IRM Server to enter names and descriptions in English as the default language, and additionally to enter names and descriptions in French:
wls:/base_domain/serverConfig> setIRMTranslations(\"en\",\"fr\")
The following example enables users of Oracle IRM Server to enter names and descriptions in English as the default language, and additionally to enter names and descriptions in French and Arabic:
wls:/base_domain/serverConfig> setIRMTranslations(\"en\",\"fr,ar\")
Use the WLST commands listed in Table 16-7 to set up installation support for Oracle IRM Desktop software.
Table 16-7 WLST Oracle IRM Desktop Installers Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new installer. |
Online |
|
|
Display the details for an existing installer. |
Online |
|
|
Display the details for all installers. |
Online |
|
|
Remove an existing installer. |
Online |
|
|
Update an existing installer. |
Online |
Online command that creates a new installer.
This command creates a new installer. Each installer identifies the locale and URI of software for installing Oracle IRM Desktop, and displays a name and version number that enables users of Oracle IRM Server to select the installer.
addIRMDownload(locale,name,version,uri)
| Argument | Definition |
|---|---|
|
|
Specifies the locale of the installer. Must be from the list of two-letter language codes given in Table 16-5 (for example, 'en' for English). |
|
|
Specifies the name for the installer. |
|
|
Specifies the version of the installer. This is a label for the installer, and is not verified against the associated installation software. |
|
|
Specifies the URI of Oracle IRM Desktop installation software. |
The following example creates an installer for English language installation software at http://irm.example.com/, with the name 'Oracle IRM Desktop' and the version number 11.1.1.1.0.0 visible to users of Oracle IRM Server when they select this installer:
wls:/base_domain/serverConfig> addIRMDownload(\"en\",\"Oracle IRM Desktop\",\"11.1.1.1.0.0\",\"http://irm.example.com/\")
Online command that displays the details for an existing installer.
This command displays the details for an installer that is present at the specified index. Each installer identifies the locale and URI of software for installing Oracle IRM Desktop, and displays a name and version number that enables users of Oracle IRM Server to select the installer.
Online command that displays the details of all installers.
This command displays the details of all installers. Each installer identifies the locale and URI of software for installing Oracle IRM Desktop, and displays a name and version number that enables users of Oracle IRM Server to select the installer.
Online command that removes an existing installer.
Removes the installer that is present at the specified index. Each installer identifies the locale and URI of software for installing Oracle IRM Desktop, and displays a name and version number that enables users of Oracle IRM Server to select the installer.
Online command that updates an existing installer.
This command updates an existing installer. Each installer identifies the locale and URI of software for installing Oracle IRM Desktop, and displays a name and version number that enables users of Oracle IRM Server to select the installer.
updateIRMDownload(dindex,locale,name,version,uri)
| Argument | Definition |
|---|---|
|
|
Specifies the index of the installer. Integer. |
|
|
Specifies the locale of the download. Must be from the list of two-letter language codes given in Table 16-5 (for example, 'en' for English). |
|
|
Specifies the name for the installer. |
|
|
Specifies the version of the installer. This is a label for the installer, and is not verified against the associated installation software. |
|
|
Specifies the URI for the Oracle IRM Desktop installation software. |
The following example updates the installer for index zero. After the update, the installation software is English language and is located at http://irm.example.com/. The name 'Oracle IRM Desktop (English)' and the version number 11.1.1.1.0.0 will be visible to users of Oracle IRM Server when they select this installer.
wls:/base_domain/serverConfig> updateIRMDownload(0,\"en\",\"Oracle IRM Desktop (English)\",\"11.1.1.1.0.0\",\"http://irm.example.com/\")