RPM Software Support Solutions

https://support.rpmsoftware.com/support/solutions/
Admin
This repository contains documentation for RPM Software Support Solutions, a service provided by...
Tokens:399,654
Snippets:570
Trust Score:6.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### RPM API Example Response

Source: https://support.rpmsoftware.com/support/solutions/articles/12000099856-getting-started-with-api

An example of a successful response from the 'Info' endpoint, containing subscriber and user details.

```JSON
{
  "InfoResult": {
    "Subscriber": "Test Inc.",
    "RPM": "AGENT",
    "Role": "Executive",
    "User": "johnsmith"
  }
}
```

--------------------------------

### RPM API Example Request

Source: https://support.rpmsoftware.com/support/solutions/articles/12000099856-getting-started-with-api

A basic example of a POST request to the 'Info' endpoint with a valid API key and an empty JSON payload.

```HTTP
POST https://secure.rpmtelco.com/rpm/api2.svc/Info
RpmApiKey: 12345678-1234-1234-1234-123abc
{
}
```

--------------------------------

### Map Order Statuses to Start Order Modifications

Source: https://support.rpmsoftware.com/support/solutions/articles/12000059889-dynamic-orders-setup-guide

This section describes mapping all status levels on an Order to enable starting an Order Modification. It advises mapping all statuses regardless of whether they match a provided screenshot, assuming changes can be made at any stage of an Order's lifecycle.

```text
Map every status level on the Order to be able to start an Order Modification.
Map all of them even if they don't match the screenshot below.
```

--------------------------------

### Import Training Record Process in RPM Software

Source: https://support.rpmsoftware.com/support/solutions/articles/12000042307-setup-process-import

This snippet details the steps for importing the 'Training Record' process. Users must navigate to Setup, select 'Import a process', specify 'Training Record' as the process, and upload the 'Training Record.xml' file.

```XML
<process>Training Record</process>
<group>Training Tracking</group>
<file>Training Record.xml</file>
```

--------------------------------

### Import Training Topic Process in RPM Software

Source: https://support.rpmsoftware.com/support/solutions/articles/12000042307-setup-process-import

This snippet outlines the procedure for importing the 'Training Topic' process. Users need to navigate to Setup, select 'Import a process', specify 'Training Topic' as the process, and upload the corresponding 'Training Topic.xml' file.

```XML
<process>Training Topic</process>
<group>Training Tracking</group>
<file>Training Topic.xml</file>
```

--------------------------------

### Map Recommended Fields for Order Modifications

Source: https://support.rpmsoftware.com/support/solutions/articles/12000059889-dynamic-orders-setup-guide

Lists recommended fields to map from the Source Field to Target Fields for a smoother Order Modification process. Examples include 'Account Number', 'Customer Name', and 'Rep Name'.

```text
Recommended Fields to Map:
Source Field -> Target Fields
Account Number -> Account Number
Customer Name -> Customer Name
Carrier -> Carrier
Agency Name -> Agency Name
Rep Name -> Rep Name
```

--------------------------------

### Import Employee Training Profile Process in RPM Software

Source: https://support.rpmsoftware.com/support/solutions/articles/12000042307-setup-process-import

This snippet explains the process of importing the 'Employee Training Profile'. It requires navigating to Setup, selecting 'Import a process', choosing 'Employee Training Profile' as the process, and uploading the 'Employee Training Profile.xml' file.

```XML
<process>Employee Training Profile</process>
<group>Training Tracking</group>
<file>Employee Training Profile.xml</file>
```

--------------------------------

### Setup Table Fill for Order Modifications

Source: https://support.rpmsoftware.com/support/solutions/articles/12000059889-dynamic-orders-setup-guide

Guides on setting up a Table Fill where the Source is 'Order Modifications' and the Target is 'Orders'. It explains how to edit the Map to automatically fill relationships and source options, and how to map additional fields added to the table.

```text
Add a Table Fill where the Source is Order Modifications and the Target is Orders.
Hit "edit" on the Map and it will fill in all the relationship and source options for you.
Map any fields you have added to the table earlier. Select the corresponding field that represents the data, e.g., "Sign Date," from the "from source form."
```

--------------------------------

### RPM API Error Response - Missing Key

Source: https://support.rpmsoftware.com/support/solutions/articles/12000099856-getting-started-with-api

An example of an error response when a valid API key is not provided in the request header.

```JSON
{
  "Result": {
    "Error": "Valid key required"
  }
}
```

--------------------------------

### Import Training Type Process in RPM Software

Source: https://support.rpmsoftware.com/support/solutions/articles/12000042307-setup-process-import

This snippet details the steps to import the 'Training Type' process into RPM Software. It involves navigating through the setup menu, selecting the import option, choosing the 'Training Type.xml' file, and completing the import.

```XML
<process>Training Type</process>
<group>Training Tracking</group>
<file>Training Type.xml</file>
```

--------------------------------

### RPM API Error Response - Invalid Key

Source: https://support.rpmsoftware.com/support/solutions/articles/12000099856-getting-started-with-api

An example of an error response when an invalid or unrecognized API key is used.

```JSON
{
  "Result": {
    "Error": "Key not found.  A valid \"Key\" must appear as the first input data item."
  }
}
```

--------------------------------

### Import Training Role Process in RPM Software

Source: https://support.rpmsoftware.com/support/solutions/articles/12000042307-setup-process-import

This section describes how to import the 'Training Role' process. The steps include navigating to Setup, choosing to import a process, selecting 'Training Role' as the process name, and uploading the 'Training Role.xml' file.

```XML
<process>Training Role</process>
<group>Training Tracking</group>
<file>Training Role.xml</file>
```

--------------------------------

### Map References for Order Modifications

Source: https://support.rpmsoftware.com/support/solutions/articles/12000059889-dynamic-orders-setup-guide

This explains how to map references from the flow, specifically from the source form to the Order reference field created in the Order Modifications process. It notes that if no options appear, the Process Reference Field might have been missed during setup.

```text
Map the References from flow, only the source form to the Order reference field you made in the Order Modifications process.
If you don't have any options here it means you missed adding the Process Reference Field to the Order Modifications process.
```

--------------------------------

### RPM API Request Structure

Source: https://support.rpmsoftware.com/support/solutions/articles/12000099856-getting-started-with-api

Demonstrates the structure of an API request, including the HTTP POST method, endpoint, API key header, and JSON payload.

```HTTP
POST https://secure.rpmtelco.com/rpm/api2.svc/<api-endpoint>
RpmApiKey: ffffffff-ffff-ffff-ffff-ffffffffffff
{
    ... other data
}
```

--------------------------------

### Map Mandatory Fields for Order Modifications

Source: https://support.rpmsoftware.com/support/solutions/articles/12000059889-dynamic-orders-setup-guide

Details the mandatory fields that need to be mapped from the Source Field to Target Fields to facilitate starting an Order Modification. The example provided is mapping 'Total Order MRC' to 'Previous MRC'.

```text
Mandatory Fields to Map:
Source Field -> Target Fields
Total Order MRC -> Previous MRC
```

--------------------------------

### Configure Start Date Field

Source: https://support.rpmsoftware.com/support/solutions/articles/12000043475-setup-vehicles-cont-d

This outlines the configuration for the 'Start Date' field, which is a Date field used to record when an inspection becomes relevant. The format is set to 'Date'.

```RPM Software Configuration
Field: Start Date
Type: Date field
Format: Date
```

--------------------------------

### Supplier Setup Recommendation

Source: https://support.rpmsoftware.com/support/solutions/articles/5000544010-step-by-step-guide-to-setting-up-rpm-telco

Guidance on configuring suppliers in RPM Telco, recommending consolidation of commissions under a single supplier entity for cleaner data and comprehensive reporting, while acknowledging alternative configurations.

```text
While RPM does not recommend setting up your suppliers to represent TSDs or TSD suppliers(e.g, TSname or TSD_AT&T) you may do so if you prefer RPM to summarize the totals quickly by those categories. Keep in mind your agents will be able to see the supplier names you choose.
```

--------------------------------

### RPM Webhook Setup Guide

Source: https://support.rpmsoftware.com/support/solutions/articles/12000100149-rpm-webhooks

Provides guidance on configuring a new webhook in RPM. This includes specifying a name, associated process (if applicable), the target URL for notifications, the specific event to track, and a secret key for request verification.

```English
1. **Name** – identify the webhook
2. **Process** – identify the associated process (only for process related webhooks)
3. **Url** – the url to request when the event happens
4. **Event** – the event to track. See the list of valid event names section
5. **Secret** – secret key used to generate a checksum to allow the receiving system to confirm the request is indeed from RPM (do not publish anywhere, should only be known by RPM and the receiving system)
```

--------------------------------

### Configure Vehicle Inspection Field

Source: https://support.rpmsoftware.com/support/solutions/articles/12000043475-setup-vehicles-cont-d

This describes the setup for the 'Vehicle Inspection' field within the 'Inspection History' table. It is configured as a Reference field linked to the 'Vehicle Inspection' process.

```RPM Software Configuration
Field: Vehicle Inspection
Type: Reference field
Process: Vehicle Inspection
```

--------------------------------

### Configure End Date Field

Source: https://support.rpmsoftware.com/support/solutions/articles/12000043475-setup-vehicles-cont-d

This describes the setup for the 'End Date' field, a Date field used to mark the expiration of an inspection's validity. The format is set to 'Date'.

```RPM Software Configuration
Field: End Date
Type: Date field
Format: Date
```

--------------------------------

### Configure Inspection Type Field in History

Source: https://support.rpmsoftware.com/support/solutions/articles/12000043475-setup-vehicles-cont-d

This details the setup for the 'Inspection Type' field within the 'Inspection History' table. It is configured as a Reference field linked to the 'Inspection Type' process.

```RPM Software Configuration
Field: Inspection Type
Type: Reference field
Process: Inspection Type
```

--------------------------------

### PHP API POST Requests

Source: https://support.rpmsoftware.com/support/solutions/articles/12000100031-api-usage-examples

Example PHP script demonstrating simple POST requests to the RPM API using stream_context_create. This script shows how to establish a connection and send data.

```PHP
<?php

// Example PHP script for RPM API POST requests

$url = 'YOUR_API_ENDPOINT';
$data = array(
    'key1' => 'value1',
    'key2' => 'value2'
);

$options = array(
    'http' => array(
        'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data)
    )
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);

if ($result === FALSE) { die('Error'); } 

var_dump($result);

?>

```
Tokens:
Raw