ARInside 3.1.

1
Documentation
Updated: 27th August 2014
Status: Published
 ARInside Manual

Table of Contents
Introduction............................................................................................................................................3
Getting Started.......................................................................................................................................3
Requirements.........................................................................................................................................3
Command Line Arguments.....................................................................................................................4
Configuration File...................................................................................................................................5
Server Settings....................................................................................................................................5
Application Settings............................................................................................................................6
Data Retrieval.....................................................................................................................................7
Layout................................................................................................................................................8
Recommended Configuration.............................................................................................................9
Security...................................................................................................................................................9
Known Problems...................................................................................................................................10
Loading of encryption library failed..................................................................................................10
Page not rendered by Internet Explorer...........................................................................................10
Unicode Support...............................................................................................................................10
Communication with older server versions......................................................................................10
Troubleshooting...................................................................................................................................10
Disclaimer.............................................................................................................................................11

Page 2 / 11
 ARInside Manual

Introduction
ARInside is a command-line application that generates linked HTML pages to document ARSystem
workflow. The program can be run in online mode connecting to an ARSystem server or in file mode
using an XML server definition export file. In advance a Packing List with all ARSystem server objects
to exclude from documentation can be specified in the application configuration.
ARInside was initially designed by Stefan Nerlich, who has made the source code public in mid 2009.
From this day on ARInside is maintained by a few developers and released under the “General Public
License Version 2” (GPLv2).
Visit http://arinside.org for more recent information.

Getting Started
We start here with a simple example that documents all workflow of a local installed AR-system
server. The example assumes ARInside is located in C:\arinside. Additionally an administrative
user named “Demo” with password “pass” is required on your server. So first start a new command
shell and go to the installation folder of ARInside. The prompt should look like this:
C:\arinside>
Now enter the following command to start documentation of your server.
C:\arinside> arinside –i settings.ini –l Demo –p pass –s localhost
After that ARInside connects to your server and starts documenting all forms, fields and workflow.
What’s the meaning of those arguments? Ok, here is a short explanation: The “-i” argument specifies
the configuration file. ARInside comes with a default configuration file named “settings.ini” which we
use in this example. The “-l” switch defines the user name and “-p” the password ARInside will use to
connect to the server specified by the “-s” switch.
Depending on the size of your application it can take several hours to finish. Please be patient. If its
finished, you’ll find the generated documentation under C:\arinside\DefaultOutputFolder.
Open the contained index.htm file with a web-browser you like.

Requirements
On the Microsoft Windows™ platform the following software-components must be installed
- Visual C++ 2008 Redistributable Package SP1

Make sure the following points are fulfilled:

- The specified username should have administrator rights. Otherwise the documentation will
be incomplete.
- ARInside supports AR-server version 7.1 and higher. It might also work with older versions.
However testing focuses mainly on the specified versions.

Page 3 / 11
 ARInside Manual

Command Line Arguments

This chapter describes all the available command line options.
Required
-i (string) File Name of the configuration file
Optional Parameters
-s (string) ARSystem server name to connect
-l (string) Login Name used to connect to the ARSystem server
-p (string) Password
-t (integer) The port number that the program will use to communicate with the AR System
server. If you do not specify this parameter or provide 0 for the port number, your
program will use the port number supplied by the portmapper. This parameter is
overridden by the ARTCPPORT environment variable.
-r (integer) The RPC program number of the server. Specify 390600 to use the admin server, a
number from 390621 to 390634 or 390636 to 390669 or 390680-390694 to use a
private server, or 0 (default) to use the fast or list server queue. This parameter is
overridden by the ARRPC environment variable.
-o The output directory of the documentation.
--slow Disables fast object loading.
-v If specified it enables detailed program output.
-h Shows more detailed command line usage information.
Examples
arinside.exe -s servername -l Demo -i settings.ini
arinside.exe -l Demo -s servername -p mypassword -i settings.ini
arinside.exe -p "my&password" -i settings.ini -s servername -l Demo
arinside.exe -s servername -l Demo -i "my settings.ini"
arinside.exe -s servername -l Demo -i "my settings.ini" -t 1044 -r 390621

Comments
- The order of the parameters is irrelevant
- Parameters with special characters (for example empty spaces) can be surrounded by
quotation marks

Page 4 / 11
 ARInside Manual

Configuration File
The ARInside application settings can be configured using a simple text-file. The settings are grouped
into four categories described below.

Server Settings
Starting with ARInside 3.0.1 you could save the connection information within the ini file. The same
settings could be set on the command line. If you do this, the command-line arguments take
precedence over the ini-file settings.

ServerName Description: The server name ARInside should connect to.

Type: String
Default value: <EMPTY>
Username Description: Login name used to connect to the ARSystem server.
Type: String
Default value: <EMPTY>
Password Description: Password used to connect to the ARSystem server.
Type: String
Default value: <EMPTY>
TCPPort Description: The port number that the program will use to communicate
with the AR System server. If you do not specify this setting or
provide 0 for the port number, your program will use the port
number supplied by the portmapper. This setting is overridden
by the ARTCPPORT environment variable.
Type: Integer
Default value: 0
RPCPort Description: The RPC program number of the server. Specify 390600 to use
the admin server, a number from 390621 to 390634 or 390636
to 390669 or 390680-390694 to use a private server, or 0
(default) to use the fast or list server queue. This setting is
overridden by the ARRPC environment variable.
Type: Integer
Default value: 0
APITimeout Description: If you have a big amount of workflow on your server, it’s
possible that ARInside fails to load objects like e.g. Active Links.
In that case you should increase the api-timeout.
Type: Integer (in seconds)
Default value: 0

Page 5 / 11
 ARInside Manual

Application Settings
TargetFolder Description: Relative or absolute path to the output directory where the
documentation is saved. This setting could be overridden by
the -o command line argument.
Type: String
Default value: <EMPTY>
FileMode Description: Specify if the application will connect to an ARSystem server
(FileMode=FALSE) or load information from a file specified in
parameter ObjListXML (FileMode=TRUE).
Type: Boolean (Values: TRUE / FALSE)
Default value: FALSE
ObjListXML Description: An ARSystem Administrator server definition file in XML
format. The parameter specifies the filename and is only used
when FileMode is set to TRUE. Refer to the ARSystem
Administrator Guide how to export server definitions in XML
format.
Type: String
Default value: <EMPTY>
UTF-8 Description: Refer to your ARSystem Database configuration if UTF-8
encoding is required.
Type: Boolean (Values: TRUE / FALSE)
Default value: FALSE
BlackList Description: Name of an ARSystem PackingList with a list of ARSystem
objects NOT to include in the documentation. Server objects
type of Application or Packinglist will be considered as
container without the including objects. Refer to the ARSystem
Administrator Guide how to create a PackingList and
add/remove objects to the list.
Type: String
Default value: <EMPTY>
LoadServerInfoList Description: Load extended server informations.
Type: Boolean (Values: TRUE / FALSE)
Default value: TRUE
CompactFolder Description: Use NTFS file system compression to save some disk space. The
application uses the Windows NT(tm) compact command.
Type: Boolean (Values: TRUE / FALSE)
Default value: FALSE
DeleteExistingFiles Description: Delete all existing files in target folder.
Type: Boolean (Values: TRUE / FALSE)
Default value: FALSE

Page 6 / 11
 ARInside Manual

OldNaming Description: Since ARInside 3.0.1 the file- and folder-names in the output
directory are generated using the object name, e.g. the schema
name. On previous versions a consecutive number was used. If
you set this parameter to TRUE, the old file naming convention
will be used. This option exists for backward compatibility.
Type: Boolean (Values: TRUE / FALSE)
Default: FALSE
GZCompression Description: With version 3.0.2 ARInside supports gzip-compressed html
files. In combination with an apache server you can access the
compressed documentation. ARInside generates the needed
.htaccess file as well.
Type: Boolean (Values: TRUE / FALSE)
Default: FALSE
OverlayMode Description: If this option is set to TRUE and the servers version is 7.6.04
and higher, ARInside will document additional details of the
overlay-feature.
Type: Boolean (Values: TRUE / FALSE)
Default: TRUE

Data Retrieval
LoadUserList Description: Load User data from ARSystem form „User“. Requires the
following fields in the form:
RequestId (1), LoginName (101), Email (103), GroupList (104),
FullName (8), DefNotify (108), LicType (109), FtLicType (110),
CreatedBy (2), Created (3), ModifiedBy (5), Modified (6)
If this parameter is set to „FALSE“ no user data will be loaded.
Type: Boolean (Values: TRUE / FALSE)
Default value: TRUE
UserForm Description: Name of the ARSystem user form.
Type: String
Default value: User
UserQuery Description: Query to restrict the number of users returned from the server
Type: String
Default value: '1'!=$NULL$
LoadGroupList Description: Load Group data from ARSystem form „Group“. Requires the
following fields in the form:
RequestId (1), GroupName (105), GroupId (106), GroupType
(107), LongGroupName (8), CreatedBy (2), Created (3),
ModifiedBy (5), Modified (6), Category (120), Computed Group
Definition (121)
If this parameter is set to “FALSE” no group data will be loaded.
Type: Boolean (Values: TRUE / FALSE)
Default value: TRUE

Page 7 / 11
 ARInside Manual

GroupForm Description: Name of the ARSystem group form.

Type: String
Default value: Group
GroupQuery Description: Query to restrict the number of groups returned from the
server
Type: String
Default value: '1'!=$NULL$
LoadRoleList Description: Load Roles data from ARSystem form „Role“. Requires the
following fields in the form:
RequestId (1), ApplicationName (1700), RoleName (1701),
RoleID (1702), GroupName Test (2001), GroupName
Production (2002), CreatedBy (2), Created (3), ModifiedBy (5),
Modified (6)
If this parameter is set to “FALSE” no role data will be loaded.
Type: Boolean (Values: TRUE / FALSE)
Default value: TRUE
RoleForm Description: Name of the ARSystem role form.
Type: String
Default value: Roles
RoleQuery Description: Query to restrict the number of roles returned from the server
Type: String
Default value: '1'!=$NULL$
MaxRetrieve Description: The maximum number of entries to retrieve. Use this
parameter to limit the amount of data returned if the
qualification does not sufficiently narrow the list. Specify 0 to
assign no maximum.
Type: Integer
Default value: 0

Layout
CompanyName Description: Your company name displayed in the documentation.
Type: String
Default value: yourcompanyname

CompanyUrl Description: Html link to the specified company (CompanyName)

Type: String
Default value: http://companyurl.com

RunNotes Description: Additional notes that will display on the main page
Type: String
Default value: <EMPTY>

Page 8 / 11
 ARInside Manual

Recommended Configuration
The ARInside package comes with a sample configuration file named “settings.ini”. While this
configuration is enough to start with, it’s always a good idea to customize it to personal needs.
1) Target Folder
The output folder should be changed to a more appropriate name and location. For example:
TargetFolder = D:\arinside_doc\<servername>
2) User List
If you have a lot of users it could increase the duration of a run significantly. At the same
time you don’t get much functionality, just some details like license type and such, and a
direct link between an AR-system object and the user. For most customers this isn’t
important at all. In this case it’s recommended to disable loading of users.
# Data Retrieval
LoadUserList = FALSE

Security
ARInside uses the following ARSystem API calls to load objects from server / file.
Online Mode
ARInitialzation
ARTermination
ARGetList(...)
ARGet(...)
FreeAR
File Mode
ARInitialzation
ARGet(...)FromXML
FreeAR
Security Comments:
ARInside doesn’t use any of the ARSet(…) or ARExecuteProcess API calls.

Page 9 / 11
 ARInside Manual

Known Problems
Here are some known problems and possible workarounds listed.

Loading of encryption library failed

In some cases the program prints out the following text right after the start:
Connecting to server sample.server.name...
Initilization of ARAPI returned: 2 (Error)
[ARERR 9011] Loading of encryption library failed
After the error message, the program crashes. From what is known this is an issue of ARAPI 7.5, if it
finds another api file within the path. The workaround is to clear the PATH variable before you run
ARInside.
C:\> set PATH=
Reference: http://arinside.org/ticket/81

Page not rendered by Internet Explorer

It looks like “Internet Explorer” has some trouble rendering bigger html files. A user has had some
trouble with a 60 MB html file. In such a case we can only recommend using another browser. Firefox
and Chrome will work very well in such a case.

Unicode Support
While there is an option named “UTF-8” within the settings.ini file, the functionality isn’t finished yet.
Currently, the setting doesn’t have any impact. Unicode support will be added in the future.

Communication with older server versions

The current release of ARInside uses a rather new version of ARAPI. If you connect to a server which
has an older version, usually the API handles the backward compatibility. But we have observed
some cases where the newer api-version couldn't handle the data transfer correctly. That’s mostly
because ARInside uses some of the newer ARGetMultiple(...) api-calls which aren’t supported
on AR Servers below version 6.3. Starting with ARInside 3.1.1 the slower object loading is
automatically activated if you connect to a server below version 6.3. If ARInside causes crashes on
newer server versions (6.3 and above) and prints some ARERR90 and ARERR91 during loading of
objects like activelinks, filters, escalations, menus and so on, just use the "--slow" command line
option. If this setting is specified, ARInside will load objects via calls like ARGetActiveLink (instead
of ARGetMultipleActiveLinks) which provides a better backwards compatibility but is much
slower.
Reference: http://arinside.org/ticket/118 (#118)
http://arinside.org/ticket/133 (#133)

Troubleshooting
In case you observe some error during execution of ARInside (e.g. a crash) you should activate the
detailed logging and redirect the output to a log file like this:
arinside.exe [...] –v >arinside.log 2>&1
The [...] is just a placeholder for other options (like –i) you want to specify on the command line.
In this example the output is redirected to the file arinside.log.

Page 10 / 11
 ARInside Manual

Disclaimer
ARInside is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation, version 2 of the License.
ARInside is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
ALL TRADEMARKS AND REGISTERED TRADEMARKS ARE THE PROPERTY OF
THEIR RESPECTIVE OWNERS.
For detailed license information visit:
http://www.gnu.org/licenses/gpl-2.0.html

Page 11 / 11