forked from stmansour/rentroll
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrentroll.1
126 lines (117 loc) · 4.83 KB
/
rentroll.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
.TH rentroll 1 "January 15, 2016" "Version 0.1" "USER COMMANDS"
.SH NAME
rentroll \- Accord Office RentRoll Service
.SH SYNOPSIS
.B rentroll
[\fB\-A\fR]
[\fB\-B\fR \fIdatabase_username\fR]
[\fB\-C\fR \fIcert_filename\fR]
[\fB\-help\fR]
[\fB\-j\fR \fIperiodStartDate\fR]
[\fB\-K\fR \fIprivatekey_filename\fR]
[\fB\-k\fR \fIperiodStopDate\fR]
[\fB\-M\fR \fIrentroll_database_name\fR]
[\fB\-N\fR \fIdirectory_database_name\fR]
[\fB\-p\fR \fIport\fR]
[\fB\-r\fR \fIreportspec\fR]
[\fB\-v\fR]
.SH DESCRIPTION
.B Rentroll
is the rentroll service in Accord Office. It can run as a server providing a multi-user web interface.
It can also run in a command line mode suitable for scripting particular tasks or automated testing.
By default Rentroll listens on port 8270. This value can be changed with the -p option. It also supports
HTTPS connections. For HTTPS, the cert and key files must be provided (see -C and -K). Currently, the
HTTPS port is set to the HTTP port number + 1, so by default HTTPS is handled on port 8271.
.SH OPTIONS
.IP "-A"
Run rentroll in batch mode, do not start the HTTP service. Be sure to set the date range using -j and -k,
and set the report using -R.
.IP "-B database_username"
Username for logging into the database server. Default name is "ec2-user"
.IP "-C cert_filename"
Filename for the certificate for the key-pair, the public part of the pair. The default
filename is localhost.crt
.IP "-j periodStartDate"
For use with batch mode operation. Set the period to
.I periodStartDate
which is in the format yyyy-mm-dd. Example: 2016-05-01
.IP "-K key_filename"
Filename for the private key for the key-pair, the private part of the pair. The default
filename is localhost.key
.IP "-k periodStopDate"
For use with batch mode operation. Set the period to
.I periodStopDate
which is in the format yyyy-mm-dd. Example: 2016-06-01.
.B Note:
The stop date means "up-to-but-not-including". Thus the range
.I -i 2016-05-01 -j 2016-06-01
would include May 1, 2016 through May 31, 2016.
.IP "-M rentroll_database_name"
Set the name of the rentroll database to
.I rentroll_database_name.
The default name is "rentroll".
.IP "-N directory_database_name"
Set the name of the directory database to
.I directory_database_name.
The default name is "accord".
.IP "-p port"
Specify the TCP port number on which rentroll listens when running its HTTP service.
By default, the port is 8270.
.IP "-r reportspec"
Rentroll will generate the following text reports based on a report specification. The date
range for all reports is from
.I periodStartDate
to
.I periodEndDate
unless otherwise noted.
.nf
reportSpec Description
------------------- -----------------------------------------------------
-r 1 Journal report
-r 2 Ledger report
-r 4 Rentroll report
-r 7 Rentable count by RentableType
-r 8 Statement
-r 9,InvoiceNo Example -r 9,IN00001 or -r 9,1
Both examples report Invoice 1.
-r 10 Ledger activity
-r 11 Rentable Gross Scheduled Rent
-r 12,LID,RAID,date Ledger balance on date. LID=LedgerID,
RAID = Rental Agreement ID
date = desired date for balance, yyyy-mm-dd
-r 13,LID,RAID Rental Agreement Details over date range.
Example: -r 13,L00004,RA00003
-r 13,4,3
Both examples show all the ledger details
for ledger 4 involving Rental Agreement 3.
-r 14,date Delinquency Report for the supplied date.
Example: -r 14,2016-05-25
-r 15 Process vacancy and generate vacancy journal entries.
-r 16 Generate Ledger Markers for the current Stop date.
-r 17 Ledger Balance Report - shows the value of all
ledgers on the current Stop date.
-r 18 Generate Journal records for the current period
-r 19 Generate Ledger records for the current period. Note
that the Journal records must be generated first as
the Ledger records are based on Journal entries.
-r 20,RID List the MarketRates for rentables over the supplied
rentable over the current period.
Example: -r 20,R000027
-r 20,27
Both examples list the Market Rates for the rentable
with RID = 27.
-r 24 Assessments report
-r 25,TLID print task list TLID
.fi
.IP "-v"
Prints the version number, build machine, and build time of rentroll. No other command line options will
be executed when this option is specified.
.P
.SH EXAMPLES
.P
.SH BUGS
Please report bugs to [email protected]
.SH AUTHOR
Steve Mansour ([email protected])
.SH "SEE ALSO"
.BR phonebook(1), rrloadcsv(1), rrbkup(1), rrrestore(1)