On-ramping Forms
A NAS Enterprise Messaging System (NEMS) On-ramping form (ORF) can be viewed and created only by an authorized user. To create on-ramping forms for a given service, an authorized user must be a member of the SWIM Governance team who has been assigned as a SWIM subject matter expert (SME) for that service. To view on-ramping forms, an authorized user must have NSRR Service Publisher or On-ramping Specialist (ORS) access privileges for that service.
To view or create on-ramping forms for a service, the authorized user clicks the On-ramping Information link on the bottom of the service navigation menu located at the left side of the Service Description screen.
When an on-ramping form is first created, the NEMS on-ramping environment is selected from the Environment pull-down list on the NEMS Environment tab of the form. Each on-ramping form corresponds to a particular NEMS on-ramping environment and all of them have the same data fields. Independent of the on-ramping environment, each on-ramping form also contains information specific to its Service Interface Type as defined on the Service Profile page. The NSRR automatically selects which on-ramping form information needs to be created based on the interface type, message-oriented (JMS) or method-oriented (WS). Bear in mind that the on-ramping form created for a message-oriented (JMS) service will provide details for each on-ramped message in a separate CSV-formatted file. The file, a link to which will be shown on the form, can be downloaded and used with spreadsheet software such as Microsoft Excel.
The on-ramping form is created when the authorized user clicks on the "Add On-ramping form" link. The user will need to populate several of the form's data fields, while other data fields will be automatically populated by the NSRR from the existing registry metadata. If the metadata needed for the on-ramping form is missing, the on-ramping form will show blank entries. The user must then go back to the corresponding NSRR metadata section and populate missing data fields in order for them to appear on the on-ramping form.
The on-ramping data entry form presents the data in several sections which the user can navigate to from the menu on the left side of the data entry form:
. Service Identification
. On-ramping Contacts
. Enhanced Capabilities
. NEMS Environment
. Security
. Service Levels
. On-ramping Note
. Messages to On-ramp (see NOTE below)
. Related Documents
In order to use the form in the ordering process for the service on-ramping, all data fields need to be populated.
The table below provides a mapping of on-ramping data fields to the NSRR metadata section elements that will automatically populate these fields, or indicates that the user must manually enter the data in the on-ramping data entry screen.
NOTE: Messages are no longer printed on the form. Instead, message descriptions are rendered as a .csv file on NSRR, and a link to the file is displayed on the form. The Messages to On-ramp section of the data entry form allows the user to select the messages for on-ramping and requires the user to provide a title for the .csv file. The .csv file is generated automatically and stored at a location on NSRR.
| ORF data field element | Applicable to (JMS ORF/WS ORF) | NSRR metadata element source of ORF data field |
|---|---|---|
| Service Name | JMS ORF and WS ORF | This field is automatically populated from the Service Profile section using data in the Service Name field |
| Service Provider | JMS ORF and WS ORF | This field is automatically populated from the Service Profile section using data in the Service Provider Name field |
| On-ramping Environment | JMS ORF and WS ORF | This field is populated based on the selection of Environment in the NEMS Environment section of the form. |
| Form Version | JMS ORF and WS ORF | This field has to be populated manually on the ORF edit screen |
| Submission Date | JMS ORF and WS ORF | This field has to be populated manually on the ORF edit screen |
| Last Updated Date | JMS ORF and WS ORF | This field is automatically populated with the system date on which the form was last updated |
| GRID | JMS ORF and WS ORF | This field is automatically populated from the Service Profile section using data in the Global Registry ID (GRID) field |
| Operational Domain | JMS ORF and WS ORF | This field is automatically populated from the Service Profile section using data in the Environmental Constraints data field. This value represents the location of the NEMS node where the service will be on-ramped in context of the NAS boundary. |
| LID and FAC | JMS ORF and WS ORF | This field has to be populated manually on the ORF data entry screen. The values are expected to be filled out when the Provider is located in the NAS designated facility. LID is NAS code for location ID, FAC is NAS facility type. More than one value can be entered in these fields |
| Location | JMS ORF and WS ORF | This field has to be populated manually on the ORF data entry screen. The value for this field is expected to describe location(s) of non-NAS Provider |
| Service On-ramping Contacts | JMS ORF and WS ORF | The contacts are selected from the Service Provider Points of Contacts section in the NSRR. To create a proper contact list on the ORF, the user needs to make sure that contacts with the following titles are entered in the Service Provider Points of Contacts section:
- NEMS Vendor Contact
|
| Enhanced Capabilities | JMS ORF and WS ORF | None, one or more values has to be selected from the following options:
- E1 Mediation (Mediation file is required for applicable messages)
Note: selection is not required and none may be selected if service doesn't require enhanced capabilities |
| Security Zone | JMS ORF and WS ORF | One or more values has to be selected from the following options:
- SG Trusted
The Security zone describes which NEMS node(s) will be used by the service in relation to the security gateway for corresponding on-ramping environment (NESG in Ops) |
| Live/Recorded Content | JMS ORF | One value has to be selected from the following options:
- Live
Live content shall be selected in operational environment, while Recorded (or simulated) is typical for R&D and sometimes available in various test environments |
| Security | JMS ORF and WS ORF | The security mechanisms are selected from the Security section in the NSRR. The security mechanisms can be customized or selected from a predefined list in that section that includes:
- Basic Authentication (userid/password)
|
| QoS | JMS ORF and WS ORF | The QoS Parameter Names are selected from the Qualities of Service section in the NSRR. The QoS Parameter Names can be customized or selected from a predefined list in that section that includes:
- Minimum Availability
Each QoS Parameter is displayed along with its value. |
| RMA (Reliability, Maintenance, Availability) | JMS ORF and WS ORF | One value has to be selected from the following options:
- RMA3
In order to select the appropriate RMA level, the user must refer to applicable QoS parameters in the NSRR Qualities of Services section of the service. More RMA level guidance is provided at the end of this table. |
| On-ramping Note | JMS ORF and WS ORF | An optional field for entering special instructions or other information |
| Message Reliability | JMS ORF | One value has to be selected from the following options:
- Best Effort
|
| JMS Provider | JMS ORF | One value has to be selected from the following options:
- WebLogic
|
| Related Documents | JMS ORF and WS ORF | Related documents to be included in the ORF selected from the list of all available documents in the Service Documents section of the NSRR for that Service. |
| Messages to On-ramp | JMS ORF | Messages to be included in the ORF selected from the list of all messages in the Service Interface section of the NSRR for that Service. |
| Following data fields are applicable for each on-ramped message for JMS ORF | ||
| Message Name | JMS ORF | Message screen - Message Name |
| Message Description | JMS ORF | Message screen - Message Description |
| Message Header Routing Attributes | JMS ORF | Property Names from the Application Specific Properties subsection of the Message Header |
| Filter Criteria | JMS ORF | Filter Criteria from the Application Specific Properties subsection of the Message Header |
| Time to Live | JMS ORF | Time to Live from the Message Header screen |
| Message Type | JMS ORF | Message Body Type from the Message screen |
| Topic/Queue | JMS ORF | Message Destination from the Message Header screen |
| Delivery Mode | JMS ORF | Delivery Mode from the Message Header screen |
| Frequency Low | JMS ORF | Frequency Low from the Message Configuration screen |
| Frequency Median | JMS ORF | Frequency Median from the Message Configuration screen |
| Frequency Peak | JMS ORF | Frequency Peak from the Message Configuration screen |
| Message Size Minimum | JMS ORF | Message Size Minimum from the Message Configuration screen |
| Message Size Median | JMS ORF | Message Size Median from the Message Configuration screen |
| Message Size Maximum | JMS ORF | Message Size Maximum from the Message Configuration screen |
| Latency | JMS ORF | Latency from the Message Configuration screen |
| Compression | JMS ORF | Compression from the Message Configuration screen |
| Compression Ratio | JMS ORF | Compression Ratio from the Message Configuration screen |
| Mediation | JMS ORF | Mediation from the Message Configuration screen |
| Note | JMS ORF | Note from the Message Configuration screen |
Service Levels - RMA Categories
RMA refers to Reliability, Maintenance and Availability. NEMS currently provides RMA3, RMA4 and RMA6 category services. RMA category service is measured in the areas listed as in the table below.
| RMA Category | Minimum Availability (latest 12-month period) | Maintenance Service Period (Days x Hours) | Cold Start Time (minutes after application power) | Service Restoration Max Time (minutes) | Mean Time between outages (minutes) |
|---|---|---|---|---|---|
| RMA3 | 0.9998478 | 7x24 | 5 | 8 | 584 |
| RMA4 | 0.9979452 | 7x24 | 5 | 180 | 583 |
| RMA6 | 0.9904215 | 5x12 | NA | Next Business Day (NBD) | 522 |
When user elects to Print the on-ramping form, the system will insert a standard cover page and will produce a PDF file which can be saved at a selected location or printed.
When user elects to Upload the on-ramping form, the system will upload the On-ramping Form to the Service Documents section of the Service Description.