16 Information Rights Management Custom WLST Commands

The following sections describe the Oracle Fusion Middleware Information Rights Management custom WLST commands in detail. Topics include:

Overview of WLST IRM Commands
General Server Commands
Migration Commands
Test Content Commands
Languages Support Commands
Oracle IRM Desktop Installers Commands

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.

Overview of WLST IRM Commands

WLST IRM commands are divided into the following categories:

Table 16-1 WLST IRM Command Categories

Command Category	Description
General Server Commands	Make general changes to Oracle IRM Server settings.
Migration Commands	Back up and migrate Oracle IRM Server user data.
Test Content Commands	Set up test content for users of Oracle IRM Desktop.
Languages Support Commands	Set up languages support for users of Oracle IRM Server.
Oracle IRM Desktop Installers Commands	Set up software installation support for Oracle IRM Desktop.

General Server Commands

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...
addIRMRefreshPeriod	Create a new refresh period.	Online
getIRMRefreshPeriod	Display an existing refresh period.	Online
getIRMRefreshPeriods	Display all the refresh periods.	Online
removeIRMRefreshPeriod	Remove an existing refresh period.	Online
updateIRMRefreshPeriod	Update an existing refresh period.	Online
addIRMSyncWindow	Create a new sync window.	Online
getIRMSyncWindow	Display an existing sync window.	Online
getIRMSyncWindows	Display all the sync windows.	Online
removeIRMSyncWindow	Remove an existing sync window.	Online
updateIRMSyncWindow	Update an existing sync window.	Online
getIRMCryptoSchema	Display the cryptography algorithm.	Online
setIRMCryptoSchema	Set the cryptography algorithm.	Online
getIRMDeviceCount	Display the device count.	Online
setIRMDeviceCount	Set the device count.	Online
getIRMJournalCleanUp	Display the current report record clean-up values.	Online
setIRMJournalCleanUp	Set report record clean-up values.	Online
getIRMLicenseStateCleanUp	Display the license state clean-up frequency.	Online
setIRMLicenseStateCleanUp	Set the license state clean-up frequency.	Online
getIRMPrivacyURL	Display the URL of the privacy statement page.	Online
setIRMPrivacyURL	Set the URL of the privacy statement page.	Online
getIRMKeyStore	Display the type and location of the Oracle IRM keystore.	Online
setIRMKeyStore	Set the type and location of the Oracle IRM keystore.	Online

addIRMRefreshPeriod

Online command that creates a new refresh period.

Description

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.

Syntax

addIRMRefreshPeriod(duration,dtype)

Argument	Definition
`duration`	Specifies the value of the refresh period. Integer.
`dtype`	Specifies the unit of the refresh period. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'.

Examples

The following example creates a refresh period of 5 hours:

wls:/base_domain/serverConfig> addIRMRefreshPeriod(5,\"HOURS\")

The following example creates a refresh period of 50 minutes:

wls:/base_domain/serverConfig> addIRMRefreshPeriod(50,\"MINUTES\")

getIRMRefreshPeriod

Online command that displays an existing refresh period.

Description

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.

Syntax

getIRMRefreshPeriod(pindex)

Argument	Definition
`pindex`	Specifies the index of the refresh period.

Examples

The following example displays the refresh period that is present at index zero:

wls:/base_domain/serverConfig> getIRMRefreshPeriod(0)

The following example displays the refresh period that is present at index one:

wls:/base_domain/serverConfig> getIRMRefreshPeriod(1)

getIRMRefreshPeriods

Online command that displays all existing refresh periods.

Description

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.

Syntax

getIRMRefreshPeriods()

Example

wls:/base_domain/serverConfig> getIRMRefreshPeriods()

removeIRMRefreshPeriod

Online command that removes an existing refresh period.

Description

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.

Syntax

removeIRMRefreshPeriod(pindex)

Argument	Definition
`pindex`	Specifies the index of the refresh period.

Examples

The following example removes the refresh period that is present at index zero:

wls:/base_domain/serverConfig> removeIRMRefreshPeriod(0)

The following example removes the refresh period that is present at index one:

wls:/base_domain/serverConfig> removeIRMRefreshPeriod(1)

updateIRMRefreshPeriod

Online command that updates an existing refresh period.

Description

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.

Syntax

updateIRMRefreshPeriod(pindex,duration,dtype)

Argument	Definition
`pindex`	Specifies the index of the refresh period.
`duration`	Specifies the value of the refresh period. Integer.
`dtype`	Specifies the unit of the refresh period. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS' or 'YEARS'.

Examples

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\")

addIRMSyncWindow

Online command that creates a sync window.

Description

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.

Syntax

addIRMSyncWindow(day,stHrs,stMins,endHrs,endMins)

Argument	Definition
`day`	Specifies the weekday. 'MONDAY', 'TUESDAY', etc.
`stHrs`	Specifies the start hours. Integer.
`stMins`	Specifies the start minutes. Integer.
`endHrs`	Specifies the end hours. Integer.
`endMins`	Specifies the end minutes. Integer.

Example

The following example creates a sync window that will result in Oracle IRM Desktop attempting to contact the server between 9.30am and 6.30pm on Mondays:

wls:/base_domain/serverConfig> addIRMSyncWindow(\"MONDAY\",9,30,6,30)

getIRMSyncWindow

Online command that displays an existing sync window.

Description

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.

Syntax

getIRMSyncWindow(sindex)

Argument	Definition
`sindex`	Specifies the index of the sync window.

Examples

The following example displays the sync window at index zero:

wls:/base_domain/serverConfig> getIRMSyncWindow(0)

The following example displays the sync window at index one:

wls:/base_domain/serverConfig> getIRMSyncWindow(1)

getIRMSyncWindows

Online command that displays all existing sync windows.

Description

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.

Syntax

getIRMSyncWindows()

Example

wls:/base_domain/serverConfig> getIRMSyncWindows()

removeIRMSyncWindow

Online command that removes an existing sync window.

Description

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.

Syntax

removeIRMSyncWindow(sindex)

Argument	Definition
`sindex`	Specifies the index of the sync window.

Examples

The following example removes the sync window at index zero:

wls:/base_domain/serverConfig> removeIRMSyncWindow(0)

The following example removes the sync window at index one:

wls:/base_domain/serverConfig> removeIRMSyncWindow(1)

updateIRMSyncWindow

Online command that updates an existing sync window.

Description

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.

Syntax

updateIRMSyncWindow(indexOfDay,day,stHrs,stMins,endHrs,endMins)

Argument	Definition
`indexOfDay`	Specifies the index of the sync window. Integer.
`day`	Specifies the weekday. 'MONDAY', 'TUESDAY', etc.
`stHrs`	Specifies the start hours. Integer.
`stMins`	Specifies the start minutes. Integer.
`endHrs`	Specifies the end hours. Integer.
`endMins`	Specifies the end minutes. Integer.

Example

The following example updates the sync window at index zero so that Oracle IRM Desktop will attempt to contact the server between 9.30am and 5.30pm on Mondays:

wls:/base_domain/serverConfig> updateIRMSyncWindow(0,\"MONDAY\",9,30,5,30)

getIRMCryptoSchema

Online command that displays the cryptography algorithm.

Description

This command displays the cryptography algorithm currently applied to files that are sealed using Oracle IRM.

Syntax

getIRMCryptoSchema()

Example

wls:/base_domain/serverConfig> getIRMCryptoSchema()

setIRMCryptoSchema

Online command that sets the cryptography algorithm.

Description

This command sets the cryptography algorithm that will be applied to files that are sealed using Oracle IRM. The default of AES128 is recommended.

Syntax

setIRMCryptoSchema(cryptID)

Argument	Definition
`cryptID`	Specifies the name of the cryptography algorithm. Possible algorithm names are AES128, AES256, AES128-FIPS, AES256-FIPS, DES3-FIPS.

Example

The following example sets the cryptography algorithm used for Oracle IRM communications to AES128:

wls:/base_domain/serverConfig> setIRMCryptoSchema(\"AES128\")

getIRMDeviceCount

Online command that displays the device count.

Description

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.

Syntax

getIRMDeviceCount()

Example

wls:/base_domain/serverConfig> getIRMDeviceCount()

setIRMDeviceCount

Online command that sets the device count.

Description

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.

Syntax

setIRMDeviceCount(devCount)

Argument	Definition
`devCount`	Specifies the device count value (the number of devices). Integer.

Example

The following example sets the device count to 2:

wls:/base_domain/serverConfig> setIRMDeviceCount(2)

getIRMJournalCleanUp

Online command that displays the current report record clean-up values.

Description

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.

Syntax

getIRMJournalCleanUp()

Example

wls:/base_domain/serverConfig> getIRMJournalCleanUp()

setIRMJournalCleanUp

Online command that sets report record clean-up values.

Description

This command sets how often report record clean-ups are performed, and the maximum age of report records before they are deleted.

Syntax

setIRMJournalCleanUp(clDuration,clUnitType,retDuration,retUnitType)

Argument	Definition
`clDuration`	Specifies the value for how often report record clean-ups are performed. Integer.
`clUnitType`	Specifies the unit for how often report record clean-ups are performed. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'.
`retDuration`	Specifies the value for the maximum age of report records before they are deleted. Integer.
`retUnitType`	Specifies the unit for the maximum age of report records before they are deleted. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'.

Example

The following example runs report record clean-ups every 5 days, and deletes report records that are 6 months old:

wls:/base_domain/serverConfig> setIRMJournalCleanUp(5,\"DAYS\",6,\"MONTHS\")

getIRMLicenseStateCleanUp

Online command that displays the license state clean-up frequency.

Description

This command displays the license state clean-up frequency (the frequency at which license records will be deleted).

Syntax

getIRMLicenseStateCleanUp()

Example

wls:/base_domain/serverConfig> getIRMLicenseStateCleanUp()

setIRMLicenseStateCleanUp

Online command that sets the license state clean-up frequency.

Description

This command sets the license state clean-up frequency (the frequency at which license records will be deleted).

Syntax

setIRMLicenseStateCleanUp(duration,unitType)

Argument	Definition
`duration`	Specifies the value of the frequency at which license records will be deleted. Integer.
`unitType`	Specifies the unit for the frequency at which license records will be deleted. 'MINUTES', 'HOURS', 'DAYS', 'MONTHS', 'YEARS'.

Examples

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\")

getIRMPrivacyURL

Online command that displays the URL of the privacy statement page.

Description

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.

Syntax

getIRMPrivacyURL()

Examples

wls:/base_domain/serverConfig> getIRMPrivacyURL()

setIRMPrivacyURL

Online command that sets the URL of the privacy statement page.

Description

This command sets the URL of a privacy statement that users must accept before viewing sealed content.

Syntax

setIRMPrivacyURL(privacyURL)

Argument	Definition
`privacyURL`	Specifies the URL of the privacy statement page.

Example

The following example sets the URL of the privacy policy page to "http://irm.example.com/":

wls:/base_domain/serverConfig> setIRMPrivacyURL(\"http://irm.example.com/\")

getIRMKeyStore

Online command that displays the type and location of the Oracle IRM keystore.

Description

This command displays the type and location of the Oracle IRM keystore.

Syntax

getIRMKeyStore()

Examples

wls:/base_domain/serverConfig> getIRMKeyStore()

setIRMKeyStore

Online command that sets the type and location of the Oracle IRM keystore.

Description

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).

Syntax

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.

Example

The following example sets the keystore type to JCEKS and the keystore location to D:/exampledir/:

wls:/base_domain/serverConfig> setIRMKeyStore()
Enter KeyStore Type: JCEKS
Enter KeyStore Location: D:/exampledir/

Migration Commands

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...
setIRMExportFolder	Set or clear the data export folder location.	Online
getIRMExportFolder	Display the value for the data export folder.	Online
setIRMImportFolder	Set or clear the data import folder location.	Online
getIRMImportFolder	Display the value for the data import folder.	Online

setIRMExportFolder

Online command that sets or clears the data export folder location.

Description

This command sets or clears the location of the folder used for data export.

Syntax

setIRMExportFolder(folder)

Argument	Definition
`folder`	Specifies the data export folder value.

Example

wls:/base_domain/serverConfig> setIRMExportFolder("export")

getIRMExportFolder

Online command that displays the value of the data export folder.

Description

This command displays the location of the folder used for data export.

Syntax

getIRMExportFolder()

Example

wls:/base_domain/serverConfig> getIRMExportFolder()

setIRMImportFolder

Online command that sets or clears the data import folder location.

Description

This command sets or clears the location of the folder used for data import.

Syntax

setIRMImportFolder(folder)

Argument	Definition
`folder`	Specifies the import folder value.

Example

wls:/base_domain/serverConfig> setIRMImportFolder("import")

getIRMImportFolder

Online command that displays the value of the data import folder.

Description

This command displays the location of the folder used for data import.

Syntax

getIRMImportFolder()

Example

wls:/base_domain/serverConfig> getIRMImportFolder()

Test Content Commands

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...
addIRMTestContent	Create a new test content instance.	Online
getIRMTestContent	Display details for an existing test content instance.	Online
getIRMTestContents	Display details of all existing test content instances.	Online
removeIRMTestContent	Remove an existing test content instance.	Online
updateIRMTestContent	Update an existing text content instance.	Online

addIRMTestContent

Online command that creates a new test content instance.

Description

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.

Syntax

addIRMTestContent(uri,localeKeys,testNames)

Argument	Definition
`uri`	Specifies the URI of the test content (for example, an image file).
`localeKeys`	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.
`testNames`	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

Examples

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)\")

getIRMTestContent

Online command that displays the details of an existing test content instance.

Description

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.

Syntax

getIRMTestContent(tindex)

Argument	Definition
`tindex`	Specifies the index of the test content instance.

Examples

The following example displays the details of the test content instance at index zero:

wls:/base_domain/serverConfig> getIRMTestContent(0)

The following example displays the details of the test content instance at index one:

wls:/base_domain/serverConfig> getIRMTestContent(1)

getIRMTestContents

Online command that displays all the test content instances.

Description

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.

Syntax

getIRMTestContents()

Example

wls:/base_domain/serverConfig> getIRMTestContents()

removeIRMTestContent

Online command that removes an existing test content instance.

Description

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.

Syntax

removeIRMTestContent(tindex)

Argument	Definition
`tindex`	Specifies the index of test content.

Examples

The following example removes the test content instance at index zero:

wls:/base_domain/serverConfig> removeIRMTestContent(0)

The following example removes the test content instance at index one:

wls:/base_domain/serverConfig> removeIRMTestContent(1)

updateIRMTestContent

Online command that updates an existing test content instance.

Description

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.

Syntax

updateIRMTestContent(tindex,uri,localeKeys,testNames)

Argument	Definition
`tindex`	Specifies the index of the test content instance. Integer.
`uri`	Specifies the URI of the test content (for example, an image file).
`localeKeys`	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.
`testNames`	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.

Examples

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)\")

Languages Support Commands

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...
addIRMTranslation	Create a new language support instance.	Online
getIRMDefaultTranslation	Display the default language.	Online
getIRMTranslations	Display all the language support instances.	Online
removeIRMTranslation	Remove an existing language support instance.	Online
setIRMTranslations	Set the default language, and set a language support instance for one or more additional languages.	Online

addIRMTranslation

Online command that creates a new language support instance.

Description

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).

Syntax

addIRMTranslation(transList)

Argument	Definition
`transList`	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.

Examples

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\")

getIRMDefaultTranslation

Online command that displays the default language.

Description

This command displays the default language.

Syntax

getIRMDefaultTranslation()

Example

wls:/base_domain/serverConfig> getIRMDefaultTranslation()

getIRMTranslations

Online command that displays all the language support instances.

Description

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).

Syntax

getIRMTranslations()

Example

wls:/base_domain/serverConfig> getIRMTranslations()

removeIRMTranslation

Online command that removes an existing language support instance.

Description

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).

Syntax

removeIRMTranslation(tindex)

Argument	Definition
`tindex`	Specifies the index of the language support instance.

Examples

The following example removes the language support instance at index zero:

wls:/base_domain/serverConfig> removeIRMTranslation(0)

The following example removes the language support instance at index one:

wls:/base_domain/serverConfig> removeIRMTranslation(1)

setIRMTranslations

Online command that sets the default language, and sets a language support instance for one or more languages in addition to the default language.

Description

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).

Syntax

setIRMTranslations(defaultTrans,transList)

Argument	Definition
`defaultTrans`	Specifies the default language. Language code (for example, 'en' for English).
`transList`	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.

Examples

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\")

Oracle IRM Desktop Installers Commands

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...
addIRMDownload	Create a new installer.	Online
getIRMDownload	Display the details for an existing installer.	Online
getIRMDownloads	Display the details for all installers.	Online
removeIRMDownload	Remove an existing installer.	Online
updateIRMDownload	Update an existing installer.	Online

addIRMDownload

Online command that creates a new installer.

Description

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.

Syntax

addIRMDownload(locale,name,version,uri)

Argument	Definition
`locale`	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).
`name`	Specifies the name for the installer.
`version`	Specifies the version of the installer. This is a label for the installer, and is not verified against the associated installation software.
`uri`	Specifies the URI of Oracle IRM Desktop installation software.

Example

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/\")

getIRMDownload

Online command that displays the details for an existing installer.

Description

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.

Syntax

getIRMDownload(dindex)

Argument	Definition
`dindex`	Specifies the index of the download.

Examples

The following example displays the details for the installer at index zero:

wls:/base_domain/serverConfig> getIRMDownload(0)

The following example displays the details for the installer at index one:

wls:/base_domain/serverConfig> getIRMDownload(1)

getIRMDownloads

Online command that displays the details of all installers.

Description

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.

Syntax

getIRMDownloads()

Example

wls:/base_domain/serverConfig> getIRMDownloads()

removeIRMDownload

Online command that removes an existing installer.

Description

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.

Syntax

removeIRMDownload(dindex)

Argument	Definition
`dindex`	Specifies the index of the download.

Examples

The following example removes the installer at index zero:

wls:/base_domain/serverConfig> removeIRMDownload(0)

The following example removes the installer at index one:

wls:/base_domain/serverConfig> removeIRMDownload(1)

updateIRMDownload

Online command that updates an existing installer.

Description

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.

Syntax

updateIRMDownload(dindex,locale,name,version,uri)

Argument	Definition
`dindex`	Specifies the index of the installer. Integer.
`locale`	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).
`name`	Specifies the name for the installer.
`version`	Specifies the version of the installer. This is a label for the installer, and is not verified against the associated installation software.
`uri`	Specifies the URI for the Oracle IRM Desktop installation software.

Example

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/\")