RangerMSP

https://www.rangermsp.com/wiki/
Admin
RangerMSP is a Professional Services Automation (PSA) software designed for Managed Service...
Tokens:190,860
Snippets:2,962
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Stunnel Service Installation Commands

Source: https://www.rangermsp.com/wiki/KB%3A_Setting_up_Email_Connector_and_Alerts_Server_with_SSL

Commands to install and start the Stunnel Windows service via Command Prompt.

```batch
Stunnel.exe -install
sc start Stunnel
```

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

### Start the new web interface service

Source: https://www.rangermsp.com/wiki/KB%3A_Running_multiple_Services_on_the_same_server

Use the Sc.exe command to start the service with the newly assigned unique name.

```bash
Sc.exe start CRMWebInterface<**NEWNAME**>
```

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

### Install RangerMSP Web Interface Service

Source: https://www.rangermsp.com/wiki/Web_Interface

Execute this command in an Administrator command prompt on the local server to install the service.

```cmd
<Installation_DIR>\RangerMSP\WebInterface\CRMWebInterface.exe -install
```

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

### Basic RangerMSP Connection Pattern

Source: https://www.rangermsp.com/wiki/VB.NET_API

A complete example demonstrating initialization, error handling with Try/Catch, and termination.

```vbnet
Try
    Dim config As New CRM.Config
    config.AppName = "VB.NET Demo"
    config.DllFolder = "C:\RangerMSP\ThirdParty\UserDev"
    config.DbFolder = "C:\RangerMSP\db"

    CRM.Application.Initialize(config)

    'At this point we have successfully initialized the CRM.Application
    'and can start using the other library classes
Catch ex As Exception 
    Console.Out.Write(ex.Message)
Finally
    CRM.Application.Terminate()
End Try
```

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

### Install CRM Server Service Manually

Source: https://www.rangermsp.com/wiki/Install_Server_Service

Execute this command in an elevated command prompt to install the service. Ensure the path is a local server path.

```text
< Installation_DIR>\RangerMSP\Server\CRMServer.exe -install
```

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

### Example configuration with unique service name

Source: https://www.rangermsp.com/wiki/KB%3A_Running_multiple_Services_on_the_same_server

A sample configuration block showing the placement of the UniqueServiceName key alongside other server settings.

```ini
[Pref]
ServerPort=4961
TimeOutAmount=60
ServerIP=127.0.0.1
**UniqueServiceName=CCRMWebInterface**
```

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

### Example Passphrase

Source: https://www.rangermsp.com/wiki/Password_Manager

A sample passphrase demonstrating the recommended mixture of uppercase, lowercase, numbers, spaces, and punctuation.

```text
     	The snow is White. The ocean is Blue. Welcome 2 Baloo.
```

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

### ODBC Database Path Configuration

Source: https://www.rangermsp.com/wiki/API_Developers_Guide

Example format for the database path including the server IP address and port for the Advantage Database Server.

```text
\\192.168.0.1:6262\RangerMSP\Db
```

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

### CmtGetFieldAttributesByRecId Response Examples

Source: https://www.rangermsp.com/wiki/API_Reference_Manual

Examples of successful responses for character and numeric field types.

```xml
<?xml version="1.0" ?>
<?crmxmlgetfieldattributesresponse version = "1.0" ?>
<CRMGetFieldAttributesResponse>
 <Status>SUCCESS</Status>
 <ResultCodes></ResultCodes>
 <ResultMessage></ResultMessage>
 <RecordData>
   <TYPE><![CDATA[CHAR]]></TYPE>
   <SIZE>30</SIZE>
   <LABEL><![CDATA[City]]></LABEL>
   <HINT><![CDATA[City of account's address]]></HINT>
   <NAME><![CDATA[Address: City]]></NAME>
   <DEFAULTVALUE></DEFAULTVALUE>
   <DISPLAYSYMBOL></DISPLAYSYMBOL>
 </RecordData>
</CRMGetFieldAttributesResponse>
```

```xml
<?xml version="1.0"  ?>
<?crmxmlgetfieldattributesresponse version = "1.0" ?>
<CRMGetFieldAttributesResponse>
  <Status>SUCCESS</Status>
  <ResultCodes></ResultCodes>
  <ResultMessage></ResultMessage>
  <RecordData>
    <TYPE><![CDATA[DOUBLE]]></TYPE>
    <SIZE></SIZE>
    <LABEL><![CDATA[Adjust Percent]]></LABEL>
    <HINT><![CDATA[Percent of discount or markup]]></HINT>
    <NAME><![CDATA[Adjust Percent]]></NAME>
    <DEFAULTVALUE><![CDATA[0]]></DEFAULTVALUE>
    <DISPLAYSYMBOL><![CDATA[%]]></DISPLAYSYMBOL>
  </RecordData>
</CRMGetFieldAttributesResponse>
```

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

### Create a new account in C++

Source: https://www.rangermsp.com/wiki/C%2B%2B_API

Demonstrates initializing an account object, setting its properties, and persisting the changes to the database.

```cpp
CRM::Account account;
account.FileAs("ACME Company");
account.Dear("Mr.");
account.Contact("John Doe");
account.Save();
```

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

### CmtGetRecordDataByRecId Ticket Response Example

Source: https://www.rangermsp.com/wiki/API_Reference_Manual

A successful response example for a Ticket record, demonstrating raw data attributes.

```xml
<?xml version="1.0" encoding="ISO-8859-8" ?>
<?crmxmlgetrecorddataresponse version = "1.0" ?>
 <CRMGetRecordDataResponse>
   <Status>SUCCESS</Status>
   <ResultCodes></ResultCodes>
   <ResultMessage></ResultMessage>
   <RecordData>
     <FLDTKTTICKETNO><![CDATA[0500-1009]]></FLDTKTTICKETNO>
     <FLDTKTSTATUS CmtRawData="900">Cancelled</FLDTKTSTATUS>
     <FLDTKTUPDATEDATE>24/01/2011  18:03</FLDTKTUPDATEDATE>
   </RecordData>
 </CRMGetRecordDataResponse>
```

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

### CmtGetRecordDataByRecId Account Response Example

Source: https://www.rangermsp.com/wiki/API_Reference_Manual

A successful response example containing Account data fields wrapped in CDATA tags.

```xml
<?xml version="1.0" ?>
<?crmxmlgetrecorddataresponse version = "1.0" ?> 
 <CRMGetRecordDataResponse>
   <Status>SUCCESS</Status>
   <ResultCodes></ResultCodes>
   <ResultMessage></ResultMessage>
   <RecordData>
     <FLDCRDCOMPANY> <![CDATA[ Business Solutions ltd.]]></FLDCRDCOMPANY>
     <FLDCRDCONTACT> <![CDATA[John Smith]]> </FLDCRDCONTACT>
     <FLDCRDADDRESS1> <![CDATA[107 Severin Street]]> </FLDCRDADDRESS1>
     <FLDCRDCITY> <![CDATA[London]]> </FLDCRDCITY>
   </RecordData>
 </CRMGetRecordDataResponse>
```

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

### Create a New Account in VB.NET

Source: https://www.rangermsp.com/wiki/VB.NET_API

Demonstrates creating a new account entity by instantiating the class, setting properties, and calling the Save method.

```vbnet
Dim account As New CRM.Account
account.FileAs = "ACME Company"
account.Dear = "Mr."
account.Contact = "John Doe"
account.Save()
```

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

### Create a new Account object in C#

Source: https://www.rangermsp.com/wiki/CSharp_API

Demonstrates initializing a new account entity, setting its properties, and persisting the changes to the database.

```csharp
CRM.Account account = new CRM.Account();
account.FileAs = "ACME Company";
account.Dear = "Mr.";
account.Contact = "John Doe";
account.Save();
```

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

### Markdown Header Formatting

Source: https://www.rangermsp.com/wiki/Special%3ASearch/%241

Example of Markdown header syntax.

```markdown
#Header 1
```

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

### XML Token Formatting

Source: https://www.rangermsp.com/wiki/API_Reference_Manual

Example of how to format a database field name as an XML token.

```xml
<FLDSLPQUANTITY>10</FLDSLPQUANTITY>
```

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

### API Constant and XML Declaration

Source: https://www.rangermsp.com/wiki/Special%3ASearch/%241

Example of defining a constant and an XML declaration string in the API.

```vbnet
Private Const C_Ok As Integer = 1 "<?xml version=""1.0"" ?>" & _
```

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

### CmtGetRecordDataByRecId Request

Source: https://www.rangermsp.com/wiki/API_Reference_Manual

Example request structure for retrieving specific fields of an Account record by its ID.

```xml
<?xml version="1.0" ?>
<?crmxmlgetrecorddatarequest version = "1.0" ?>
 <CRMGetRecordDataRequest>
   <ExternalApplicationName>MySoftwareName</ExternalApplicationName>
   <GetRecordByRecId>CRDC1VTHMDF627HJECG7</GetRecordByRecId>
   <SelectFieldsList>
     FLDCRDCOMPANY,
     FLDCRDCONTACT,
     FLDCRDADDRESS1,
     FLDCRDCITY,
   </SelectFieldsList>
 </CRMGetRecordDataRequest>
```
Tokens:
Raw