Added some templates for the properties files with detailed comments. #14

Author: JoelProminic

README.md

@@ -30,9 +30,9 @@ You can also find an example script library, `DemoScriptLibrary`
 
 ### Agent Configuration
 
-Configure agents in `agentProperties/agentbuild`.
+Configure agents in `agentProperties/agentbuild`.   See the commented template here: `agentProperties/templates/agent.properties`
 
-Configure script libraries in `agentProperties/scriptbuild`
+Configure script libraries in `agentProperties/scriptbuild`.  See the commented template here: `agentProperties/templates/scriptlibrary.properties`
 
 The name of the file (excluding the `.properties extension`) should match the name of the agent.  This name will be used in [Running Tasks](#running-tasks).
 

agentProperties/TestWeb.properties …Properties/agentbuild/TestWeb.propertiesagentProperties/TestWeb.properties renamed to agentProperties/agentbuild/TestWeb.properties agentProperties/TestWeb.properties renamed to agentProperties/agentbuild/TestWeb.properties

@@ -0,0 +1,41 @@
+# target location overwritten by properties in build.gradle
+$$nsfServer=
+$$nsfFile=
+
+## Primary Configuration
+# The name of the agent.  An alias can be specifed with:  FullName|alias
+agent_name=MyAgent
+# The main class that should be run for this agent.  This must include the package.  The maximum length is 65 characters - additional characters will be cut off.
+javaproject_class=path/to/MyAgent.class
+# The JAR to use for this agent.  All agents will use the combined JAR
+$$jarSourceFile=./build/libs/MyProject.jar
+# Comma-separated list of Script Libraries required for this agent
+$$scriptLibrary=
+
+## Additional options
+# Whether the agent should run as the web users with permissions.  true or false
+agent_runaswebuser=false
+# If true, enables you to access the agent without having to wait for it to complete. If you set this attribute to true and the agent references any front-end classes, a run-time error is generated
+agent_clientbackgroundthread=false
+# If true, permits remote debugging of the LotusScript in an agent script and permits you to monitor the execution of agents written in Java
+agent_allowremotedebugging=false
+# If true, highlights the text in the retrieved documents that matches the search query. Default is false.
+agent_storehighlights=false
+# The access level the agent needs:  (restricted | unrestricted | fulladminunrestricted)
+agent_restrictions=restricted
+# Space separated list of hide restrictions.  Allowed Values:  (web | notes | v3)
+agent_hide=v3 notes
+# Do not change
+agent_publicaccess=false
+# The method to use for triggering the agent.  Options: (actionsmenu | agentlist | beforenewmail | afternewmail | docupdate | docpaste | scheduled | serverstart )
+trigger_type=actionsmenu
+# The runtime behavior of the agent:  (modified | unreadinview | allinview | selected | runonce | all)
+documentset_type=runonce
+# Name of a built-in event or a user-defined LotusScript function.
+code_event=action
+# Do not change
+javaproject_codepath=.
+# true or false. Determines whether this agent is compiled with debugging information.  True is recommended to see line numbers in stack traces
+javaproject_compiledebug=true
+# Do not change this
+javaproject_imported=true

agentProperties/templates/agent.properties

@@ -0,0 +1,15 @@
+# target location overwritten by properties in build.gradle
+$$nsfServer=
+$$nsfFile=
+
+# The name of the script library
+scriptlibrary_name=REPLACEME
+# Comma-separated list of script libraries required by this script library
+$$scriptLibrary=
+# The JAR with the main source code for this script library
+$$scriptlibrary_objectjarFile=./lib/REPLACEME.jar
+# Additional jars to include in the agent. Comma separated
+$$jarSourceFile=
+javaproject_codepath=.
+# Do not change
+$$scriptlibrary_sourcejarFile=./ScriptLibraryImportTemplate/%%source%%.jar