The Rights Viewer dialog enables you to view the following access rights, which are grouped according to function:
The internal value for access rights is used by the REST API.
Global Access Rights
Login
| Display Name | Required for... |
Internal Value |
| Log in to Rhapsody IDE | View access to Rhapsody IDE. | ide view |
| Log in to Management Console | View access to the Management Console. | monitoring view |
| Call the Web Services API | Calling operations in the Rhapsody Web Services API. | web services api call |
Preferences
| Display Name | Required for... |
Internal Value |
| Change password | Changing one's own password in Rhapsody IDE and the Management Console. | user change password |
Rhapsody IDE
| Display Name | Required for... |
Internal Value |
| Make changes with IDE | Editing the configuration of Rhapsody components in Rhapsody IDE. | ide edit |
| Create locker | Creating new locker objects. |
create locker |
| Edit user accounts | Creating, editing and deleting user accounts as well as reset user passwords. | users edit |
| Clear definition checkouts | Clearing another user's check-out of a message definition in the File Manager. | definitions clear checkout |
| Save configurations | Saving configurations using Rhapsody IDE. | save rlc |
| Load configurations | Loading saved configurations using Rhapsody IDE. | load rlc |
| Clear configurations | Clearing configurations when loading RLCs from Rhapsody IDE. | overwrite configuration |
| View configuration history | Viewing history of all configuration changes in Rhapsody IDE. | view commit history |
| Configure check-in comment rules | Configuring check-in comment rules in Rhapsody IDE. | configure commit comment rules |
| Rollback the configuration | Rollbacking the configuration to a previous version from Rhapsody IDE. | rollback to previous commit |
| Edit configuration version tags | Adding, editing or removing tags associated with a configuration version in Rhapsody IDE. | edit commit tags |
| Manage licenses | Loading custom modules and third-party libraries. | manage licenses |
| Stop engine | Stopping the engine through the Rhapsody>Server Action>Stop Rhapsody Engine... menu item in Rhapsody IDE. | stop engine |
| Load custom modules and third-party libraries | Loading custom modules and third-party libraries. | load custom modules and third party libraries |
| Edit templates | Adding, editing or deleting templates in Rhapsody IDE. | edit templates |
Management
| Display Name | Required for... |
Internal Value |
| Organize backups | Accessing and editing the settings on the Backup and Restore page in the Management Console. | backups manage |
| Organize archive cleanup | Accessing and editing the archive cleanup settings on the Archive Cleanup page in the Management Console. | archive-cleanup manage |
| Organize message defragmentation | Accessing and editing the message defragmentation settings on the Archive Cleanup page in the Management Console. | defrag manage |
| Edit monitoring settings | Accessing and editing the Default Settings and General Settings pages in the Management Console. | web-settings manage |
| Configure message banners | Configuring the appropriate Message Banner for every page in the Management Console. | message-banners configure |
| Configure introduction page | Configuring the Management Console's introduction and login settings on the Login Settings page. | introduction-page configure2 |
| View user sessions | Viewing the User Sessions page to identify those users who are currently logged on to the Management Console. | user sessions view |
| Disconnect user sessions | Disconnecting users from the Management Console through the User Sessions page. | user sessions disconnect |
| Stacktrace threads | Taking stack traces of threads. | threads manage2 |
| Generate system information | Generating system state information and stack traces of threads from the Management Console. | threads stacktrace2 |
| Perform internal diagnostics | Performing internal diagnostics. | engine debugging |
| Manage product usage | Managing the product usage configuration. | manage product usage |
Certificates and Keys
| Display Name | Required for... |
Internal Value |
| Edit certificates and keys | Importing, deleting and generating certificates and keys from the Certificate and Key Manager. | keys edit |
| Generate signed private keys | Generating issuer-signed certificate and private key pairs from the Certificate and Key Manager | keys generate private signed |
| Export SSL private keys | Exporting SSL private keys from the Certificate and Key Manager. |
keys export private |
| Export SSH private keys | Exporting SSH private keys from the Certificate and Key Manager. | keys export private ssh |
| Export symmetric keys | Exporting symmetric keys from the Certificate and Key Manager. | keys export symmetric |
| Export RPG private keys | Exporting RPG private keyrings from the Certificate and Key Manager. | keys export private rpg |
Rhapsody Variables
| Display Name | Required for... |
Internal Value |
| Edit Rhapsody variables | Editing Rhapsody variables. | edit rhapsody variables |
Shared JavaScript Libraries
| Display Name | Required for... | Internal Value |
| Edit shared JavaScript libraries | Editing shared JavaScript libraries. | edit shared JavaScript libraries |
Web Services
| Display Name | Required for... |
Internal Value |
| Edit web services | Editing web services from Rhapsody IDE. | web services edit |
| Restart web services | Restarting web services. | web services restart |
| Change web service log level | Changing the log level for web services on the Web Service Details page in the Management Console | web-services change log-level |
| Edit web services user store | Editing the web services user store from Rhapsody IDE. | web services user store edit |
| Export web services user store | Exporting the web services user store so it can be imported into another engine. | web services user store export |
Notifications
| Display Name | Required for... |
Internal Value |
| View default notification settings | Viewing the Default Settings page for notifications. | default notifications settings view |
| Suspend/resume component and issue notifications | Suspending or resuming the notifications of components and issues from the Suspend / Resume All notifications page. | component notification suspend-resume |
| Change system notifications | Changing system notifications. | change system notifications |
| Notification stream comment | Making comments in the notification stream. | notification stream comment |
| Notification issue resolve | Resolving notification issues. | notification issue resolve |
| Notification issue assign | Assigning notification issues. | notification issue assign |
| Notification flag comment | Flagging comments in the notification stream as important. | notification issue flag |
| Edit current user's notification preferences | Accessing and editing the My Notifications section for the current user. | my notifications edit |
| Send test notifications | Sending test notification messages. | notification send test |
| Edit watchlists | Editing watchlists. | watch list edit |
| Edit component notifications | Changing notification recipient and escalation resend periods for components from the Resend and Escalation Periods section in the Management Console. | component notifications edit |
| Edit unmonitored component notifications | Editing component notification thresholds from Notifications for Unmonitored Components section. | unmonitored component notifications edit |
| Edit component notification thresholds | Customizing notifications thresholds for components from the component details page in the Management Console. | component notification edit |
| Edit default notification thresholds | Editing default notifications thresholds from the Default Threshold Settings section. | default notifications thresholds edit |
| Redirect user notifications | Redirecting user notification while they are on holiday. | user notifications redirect |
| Edit notification delivery methods | Enabling, disable and configuring the Delivery Methods available for delivering notifications. | notification-delivery-methods edit |
| Suspend/resume global notifications | Suspending or resuming all component and issues notifications across the engine. | global notification suspend-resume |
| Edit other user's notification preferences | Accessing and editing the My Notifications Section page for other users. | other notifications preferences edit |
| Edit public holidays | Adding, removing, importing and exporting public holidays from the Public Holidays page. |
public holidays edit |
Searches
| Display Name | Required for... |
Internal Value |
| Perform full text searches | Performing full text search for messages from all search pages in the Management Console. | search full text |
| Save searches | Saving search results on all search pages (or deleting searches on the Recent Results page) in the Management Console. | searches save2 |
| Send searches | Sending search results from the Saved Searches page in the Management Console. | searches publish2 |
| Manage orphaned messages | Viewing and managing deleted messages on the Error Queue or Hold Queue. | manage orphaned messages |
Logs
| Display Name | Required for... |
Internal Value |
| View audit logs | Viewing and search the Audit Log files. | audit-log view |
| View engine logs | Viewing the System Log files. | engine-logs view |
| Export engine logs | Exporting the Rhapsody System Log files | engine-logs export |
Statistics
| Display Name | Required for... |
Internal Value |
| View system statistics | Viewing the system statistics. | statistics view system-performance |
| Export system statistics | Exporting statistics on the Engine Monitor, Communication Point Details, Route Details, Web Service Details and System Monitor pages. | statistics export system-performance2 |
| View performance statistics | Viewing performance statistics on the Performance Statistics. | statistics view performance-statistics2 |
| Collect performance statistics | Examining collected statistics on the Performance Statistics page. | statistics collect performance-statistics2 |
| Generate message breakdown report | Generating a message breakdown report on the Message Breakdown page. | statistics generate message-breakdown-report2 |
| Export message breakdown statistics | Exporting a message breakdown report on the Message Breakdown page. | statistics export message-breakdown-data2 |
| Generate message latency reports | Generating message latency reports on the Message Latency page. | statistics generate message-latency-report2 |
| Export message latency statistics | Exporting message latency statistics on the Message Latency page. | statistics export message-latency-data2 |
| Generate response latency reports | Generating response latency reports on the Response Latency page. | statistics generate response-latency-report2 |
| Export response latency statistics | Exporting response latency statistics on the Response Latency page. | statistics export response-latency-data2 |
| View engine uptime statistics | Viewing engine uptime statistics. | statistics view uptime |
| Generate engine uptime reports | Generating engine uptime reports. | statistics generate engine-uptime-report |
| Collect engine uptime statistics | Collect engine uptime statistics. | statistics collect engine-uptime-statistics |
JavaScript Counters
| Display Name | Required for... |
Internal Value |
| Edit JavaScript counters | Editing JavaScript Counters in the Management Console. | global-counters edit2 |
Lookup Tables
| Display Name | Required for... |
Internal Value |
| View lookup table values | Viewing lookup table values in the Management Console. | lookup tables values view |
| Edit lookup table values | Editing lookup table values in the Management Console. | lookup tables values edit |
| Manage lookup tables | Creating, editing and deleting lookup tables in Rhapsody IDE. | lookup tables manage |
REST API
| Display Name | Required for... |
Internal Value |
| Call REST API | Calling the REST API. | rest api call |
| View notifications REST API | Calling the REST API to view notification alerts. | rest api notifications view |
| Change notifications REST API | Calling the REST API to change notification alerts. | rest api notifications change |
| Change system notifications REST API | Calling the REST API to change system notification alerts. |
|
| View notification settings REST API | Calling the REST API to view the system notifications settings. | rest api view notification settings |
| Edit unmonitored component notifications REST API | Calling the REST API to edit notifications for unmonitored components. | rest api unmonitored component notifications edit |
| Suspend/resume component and issue notifications REST API | Calling the REST API to suspend or resume the notifications of components and issues. | rest api component notification suspend-resume |
| Suspend/resume global notifications REST API | Calling the REST API to suspend or resume all component and issue notifications across the engine. | rest api global notification suspend-resume |
| View message statistics REST API | Calling the REST API to read the number of received, processed, sent and failed messages on the engine. | rest api message statistics view |
View engine statistics REST API |
Calling the REST API to read the in-use memory, memory used by the JVM, and total allocated memory in the engine. | rest api engine statistics view |
| View Error Queue count REST API | Calling the REST API to get the number of messages on the Error Queue. | rest api error queue count view |
| View Hold Queue count REST API | Calling the REST API to get the number of messages on the Hold Queue. | rest api hold queue count view |
| View components REST API | Calling the REST API to view component information. | rest api view components |
| View communication points REST API | Calling the REST API to view communication point information. | rest api view comm points |
| Start/stop communication points REST API | Calling the REST API to start/stop communication points. | rest api comm points start stop |
| View routes REST API | Calling the REST API to view route information. | rest api view routes |
| Start/stop routes REST API | Calling the REST API to start/stop routes. | rest api routes start stop |
| View web services REST API | Calling the REST API to view web services. | rest api view webservices |
| Restart web services REST API | Calling the REST API to restart web services. | rest api webservices restart |
| View message metadata REST API | Calling the REST API to view message metadata. | rest api view message meta data |
| View message bodies REST API | Calling the REST API to view message bodies. | rest api view message body |
| Search Error Queue REST API | Calling the REST API to search the Error Queue. | rest api error queue search |
| Delete message REST API | Calling the REST API to delete a message on the Error or Hold Queue. | rest api delete message |
| Release message REST API | Calling the REST API to release a message on the Error or Hold Queue. | rest api release message |
| Perform lookup REST API | Calling the REST API to perform a lookup on a lookup table. | rest api perform lookup |
| Search Hold Queue REST API | Calling the REST API to search the Hold Queue. | rest api hold queue search |
| List all searches for all users REST API | Calling the REST API to list (but not view) all searches by all users. | rest api searches list all |
| Discard all searches for all users REST API | Calling the REST API to cancel and discard all searches by all users. | rest api searches discard all |
| Export logs REST API | Calling the REST API to export logs. | rest api log export |
| Organize archive cleanup REST API | Calling the REST API to manage archive cleanup. | rest api archive cleanup manage |
| Organize message defragmentation REST API | Calling the REST API to manage message defragmentation. | rest api defragmentation manage |
| Get backup information REST API | Calling the REST API to fetch information about engine backups. | rest api backups read |
| Manage backups REST API | Calling the REST API to manage engine backups. | rest api backups manage |
| View support notes REST API | Calling the REST API to view support notes of communication points, routes, and filters. | rest api support-notes view |
| Manage general settings REST API | Calling the REST API to change the Management Console's general settings. | rest api general settings manage |
| Test filter and conditional connector REST API | Calling the REST API to manage filter and conditional connector tests. | rest api filter and connector test |
Administration REST API
| Display Name | Required for... |
Internal Value |
| Read licenses REST API | Calling the REST API to read licenses. | rest api licenses read |
| Write licenses REST API | Calling the REST API to write licenses. | rest api licenses write |
| Read variables REST API | Calling the REST API to read variable. | rest api variables read |
| Write variables REST API | Calling the REST API to write variables. | rest api variables write |
| View certificates and keys REST API | Calling the REST API to view certificates and keys. | rest api security objects view |
| Write certificates and keys REST API | Calling the REST API to write certificates and keys. | rest api security objects write |
| Save web services users REST API | Calling the REST API to save web services users. | rest api web services users save |
| Load web services users REST API | Calling the REST API to load web services users. | rest api web services users load |
| Save/view lookup tables REST API | Calling the REST API to save or view lookup tables. | rest api lookup tables save |
| Load/edit lookup tables REST API | Calling the REST API to load or edit lookup tables. | rest api lookup tables load |
| Save custom modules and third-party libraries REST API | Calling the REST API to save custom modules and third-party libraries. | rest api custom modules save |
| Load custom modules and third-party libraries REST API | Calling the REST API to load custom modules and third-party libraries. | rest api custom modules load |
| Save configuration REST API | Calling the REST API to save a configuration. | rest api configuration save |
| Load configuration REST API | Calling the REST API to load a configuration. | rest api configuration load |
| Save access groups REST API | Calling the REST API to save access groups. | rest api access groups save |
| Load access groups REST API | Calling the REST API to load access groups. | rest api access groups load |
| Save users REST API | Calling the REST API to save users. | rest api users save |
| Load users REST API | Calling the REST API to load users. | rest api users load |
| Save templates REST API | Calling the REST API to save templates. | rest api templates save |
| Load templates REST API | Calling the REST API to load templates. | rest api templates load |
| Stop engine REST API | Calling the REST API to stop the engine. | rest api stop engine |
Locker Access Rights
Rhapsody IDE
| Display Name | Required for... |
Internal Value |
| View locker | Viewing lockers. | locker view |
| Edit locker | Editing lockers. | locker edit |
| Test filter configurations | Testing filters. | filter configuration test |
| Test conditional connectors | Testing conditional and JavaScript connectors. | conditional connector test |
Management
| Display Name | Required for... |
Internal Value |
| View support notes | Viewing support notes for components in Rhapsody IDE and the Management Console. | support-notes view |
Communication Points and Routes
| Display Name | Required for... |
Internal Value |
| Start/stop communication points | Starting and stopping individual communication points on the Communication Point Types page in the Management Console. | communication-points start-stop |
| Start/stop communication points with scheduling enabled | Starting and stopping individual communication points with scheduling enabled on the Communication Point Types page in the Management Console. | scheduled-communication-points start-stop |
| Change communication point log level | Changing the log level for communication points on the Communication Point Details page in the Management Console. | communication-points change log-level |
| Start/stop routes | Starting and stopping individual routes on the Monitoring Routes page in the Management Console. | routes start-stop |
| Change route log level | Changing log level for routes on the Route Details page in the Management Console. | route change log-level |
REST Clients
| Display Name | Required for... |
Internal Value |
| Change REST client log level | Changing the log level for REST clients. | rest clients change log-level |
Intelligent Mapper
| Display Name | Required for... |
Internal Value |
| Run Intelligent Mapper analysis | Analyzing messages in the Intelligent Mapper. | run intelligent mapper analysis |
| Run Intelligent Mapper tests | Running tests on a mapping project in the Intelligent Mapper. | run intelligent mapper tests |
Searches
| Display Name | Required for... |
Internal Value |
| Search message queues | Performing searches on message queues. | searches perform locker messages |
| Search Error and Hold Queues | Performing searches on the Error Queue and Hold Queue. |
searches perform locker error hold queues |
Messages
| Display Name | Required for... |
Internal Value |
| View message bodies | Viewing the contents of messages on the Message View page in the Management Console. | messages view bodies |
| View message properties | Viewing the properties of messages on the Message View page in the Management Console. | messages view properties |
| View message in an emergency | Viewing the contents and properties of a message in an emergency situation on the Message View page in the Management Console. | emergency messages view |
| Edit messages | Editing messages on the Hold Queue and Error Queue. | messages edit |
| Cancel tracking on messages | Canceling message tracking on the Message View page in the Management Console. | messages cancel tracking |
| Redirect messages | Redirecting messages to a selected filter or communication point. | messages redirect |
| Reinject messages | Reinjecting messages into the Rhapsody engine at its original point of entry. | messages reinject |
| Resend messages | Resending messages. | messages resend |
| Release/reprocess messages | Releasing messages on the Hold Queue, and reprocessing messages on the Error Queue. | messages release from table |
| Delete waiting messages | Deleting waiting messages, specifically:
|
messages delete waiting |
| Delete held/errored messages | Deleting messages from the Hold Queue or Error Queue. | messages delete from table |
| Download messages | Downloading messages. | messages download |
| Export messages | Exporting the metadata of message on the Hold Queue or Error Queue. | messages error export |
| Perform bulk operations | Performing bulk download and deleting operations from the search results. | messages bulk operations on table |
Database Input-Key Values
| Display Name | Required for... |
Internal Value |
| Edit input database key values | Editing Database Key Values in the Management Console. | database-key-values edit2 |
REST API
| Display Name | Required for... |
Internal Value |
| Read transient state REST API | Calling the REST API to read the transient state. |
|
| Modify transient state REST API | Calling the REST API to modify the transient state. | rest api modify transient state |
| Manage product usage REST API | Calling the REST API to manage product usage settings. | rest api manage product usage |