Skip to content

Commit 5111827

Browse files
jwindmullerjwindmuller
committed
Adding documentation
1 parent b72de55 commit 5111827

2 files changed

Lines changed: 147 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
1-
Web2Rpm
1+
# Web contact form to RPM via API
2+
3+
Code example for a website that lets visitor fill and send a simple contact form to a process in RPM.
4+
5+
## Setting up this example
6+
7+
1. Create the target process by importing `Contact.xml` into RPM
8+
2. Open `Web2Rpm.sln` in Visual Studio
9+
2. Configure the [API key](https://api.rpmsoftware.com/getting-started/#keys), ProcessID and (optional) the [API URL](https://api.rpmsoftware.com/getting-started/#url) in [HomeController.cs](https://github.com/rpmsoftware/Web2Rpm/blob/master/Web2Rpm/Controllers/HomeController.cs#L14)
10+
11+
## API documentation
12+
13+
For more in depth information about RPM's API, visit our documentation at [api.rpmsoftware.com](https://api.rpmsoftware.com/)

‎Web2Rpm/Contact.xml‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<?xml version="1.0"?>
2+
<rpm:Process xmlns:rpm="urn:rpmsoftware.com:Process">
3+
<name>Contact</name>
4+
<date>Mar 1,2018</date>
5+
<titleNumber>true</titleNumber>
6+
<number>
7+
<minumum>4</minumum>
8+
<formNumberReadOnly>True</formNumberReadOnly>
9+
</number>
10+
<repeating>
11+
<enabled>false</enabled>
12+
<addlink>Add repeating fields</addlink>
13+
</repeating>
14+
<agentautoaddagentparticipants>false</agentautoaddagentparticipants>
15+
<isSimple>false</isSimple>
16+
<ShowStartLink>true</ShowStartLink>
17+
<ShowStartLinkOnForm>true</ShowStartLinkOnForm>
18+
<OnStartShowAllFields>true</OnStartShowAllFields>
19+
<permissions>
20+
<addParticipantChangeOwner>Edit</addParticipantChangeOwner>
21+
<editTrashNotes>Edit</editTrashNotes>
22+
<addDeleteRepeatingFields>Start</addDeleteRepeatingFields>
23+
<permissionsForSubUsers>{"AgentUserEmailAccess":false,"CustomerUserEmailAccess":false,"AgentUserPermission":1,"AgentUserChangeStatus":false,"AgentUserAddAction":false,"CustomerUserPermission":1,"CustomerUserChangeStatus":false,"CustomerUserAddAction":false}</permissionsForSubUsers>
24+
</permissions>
25+
<NotificationFormInfo>[]</NotificationFormInfo>
26+
<Signature>{"IsEnabled":false,"Name":"Signatures","IsHandDrawn":false,"ShowCompany":false,"Instruction":""}</Signature>
27+
<fields>
28+
<field name="Contact Name (First &amp; Last)">
29+
<type>Text</type>
30+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
31+
<order>1</order>
32+
<LayoutFormat>{"Width":"2","Order":1}</LayoutFormat>
33+
<repeating>false</repeating>
34+
<ID>40639</ID>
35+
</field>
36+
<field name="Primary Contact Number">
37+
<type>Text</type>
38+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
39+
<order>3</order>
40+
<LayoutFormat>{"Width":"1","Order":-1}</LayoutFormat>
41+
<repeating>false</repeating>
42+
<ID>40640</ID>
43+
</field>
44+
<field name="Email">
45+
<type>Text</type>
46+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
47+
<order>4</order>
48+
<LayoutFormat>{"Width":"1","Order":-1}</LayoutFormat>
49+
<repeating>false</repeating>
50+
<ID>40641</ID>
51+
</field>
52+
<field name="Company">
53+
<type>Text</type>
54+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
55+
<order>5</order>
56+
<LayoutFormat>{"Width":"1","Order":-1}</LayoutFormat>
57+
<repeating>false</repeating>
58+
<ID>40642</ID>
59+
</field>
60+
<field name="Website">
61+
<type>Text</type>
62+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
63+
<order>6</order>
64+
<LayoutFormat>{"Width":"1","Order":-1}</LayoutFormat>
65+
<repeating>false</repeating>
66+
<ID>40643</ID>
67+
</field>
68+
<field name="Web Lead Comment">
69+
<type>Text</type>
70+
<InternalFormat>{"PatternEnabled":false,"Pattern":"","Instruction":""}</InternalFormat>
71+
<order>7</order>
72+
<LayoutFormat>{"Width":"2","Order":-1}</LayoutFormat>
73+
<repeating>false</repeating>
74+
<ID>40644</ID>
75+
</field>
76+
</fields>
77+
<statusLevels>
78+
<statusLevel>
79+
<name>New</name>
80+
<autoarchive>false</autoarchive>
81+
<userselectable>true</userselectable>
82+
<includeInSum>true</includeInSum>
83+
<allowAttachmentAddEdit>true</allowAttachmentAddEdit>
84+
<allowEditForm>true</allowEditForm>
85+
<signature>{"ShowLink":false}</signature>
86+
</statusLevel>
87+
</statusLevels>
88+
<statusTriggers />
89+
<defaultColumns>
90+
<staff>
91+
<column>Number</column>
92+
<column>Owner</column>
93+
<column>Action due for me</column>
94+
<column>Started</column>
95+
<column>Started by</column>
96+
<column>Modified</column>
97+
<column>Modified by</column>
98+
<column>Files</column>
99+
</staff>
100+
<agent>
101+
<column>Number</column>
102+
<column>Owner</column>
103+
<column>Action due for me</column>
104+
<column>Started</column>
105+
<column>Started by</column>
106+
<column>Modified</column>
107+
<column>Modified by</column>
108+
</agent>
109+
<customer>
110+
<column>Number</column>
111+
<column>Owner</column>
112+
<column>Action due for me</column>
113+
<column>Started</column>
114+
<column>Started by</column>
115+
<column>Modified</column>
116+
<column>Modified by</column>
117+
</customer>
118+
<action>
119+
<column>Form title</column>
120+
<column>Done</column>
121+
<column>Due</column>
122+
<column>Assignee</column>
123+
<column>Description</column>
124+
<column>Result</column>
125+
</action>
126+
</defaultColumns>
127+
<customWebBoxes />
128+
<holders />
129+
<nofitificationSettings>
130+
<setting isOn="true" userType="AgentRep" watching="all" suppressOnCopy="false" suppressOnFlow="false" />
131+
<setting isOn="true" userType="Staff" watching="all" suppressOnCopy="false" suppressOnFlow="false" />
132+
<setting isOn="true" userType="CustomerContact" watching="all" suppressOnCopy="false" suppressOnFlow="false" />
133+
</nofitificationSettings>
134+
</rpm:Process>

0 commit comments

Comments
 (0)