Overriding Event Parameters

You can override event parameters, and this can be done by changing value of certain properties in Adeptia Suite. However, you can not override "HTTP" and "Complex" events.

Login to Adeptia Suite.
Go to Administer > Setup > Update System Properties > Services and click Event.
Set value of abpm.event.parametersOverriding.enable to true.
After setting this value go to Administer > Setup > Update System Properties > Shared Path.
In the abpm.event.parameters.fileLocation, the default location of the file (eventParameters.json) is set to etc. If you want to change the file location, provide the folder path of the file in this property. Ensure that the file with name eventParameters.json is present in the folder location you have given.

In case of clustered deployment, user should place eventParameters.json file in defined shared location of the cluster in order to share the file to all the nodes of cluster.
If parameters are found in this file, system will override these parameters while the events are activated.

A user can also provided the parameter value from the System Properties. For example, if the user has defined a parameter value as SystemProperty.ftpPort in the System Properties, then during the activation of events, system fetches the value from System Properties.

List of Parameter Events

Following is the category-wise list of the event parameters that can be overridden. Click on the events to know the related details.

Application Event Parameters

Display Name	Variable Name	Data Type	Possible Values	Comments (Use of Parameters)
Trigger Type	triggerType	String	newfileindirectory	Criteria on which event should be triggered.
Application Account	accountId	String	EX: OAuthAccount:192168001180152818939423800001	Application Accounts typed Id.
Folder	fileBaseLocation	String		Folder path.
Search Crietria	filterIn	String	*.txt	Define file search criteria
Run Initial Load	runInitialLoad	Boolean	True or False	Enable if you want to process all the existing records or files on first activation of this event.
Polling Frequency	pollingFrequency	String	Ex : 10$y means 10 years 10$M means 10 months 10$w means 10 weeks 10$d means 10 days 10$H means 10 hour 10$m means 10 minute 10$s means 10 second	Time delay that should exist between successive polls

Calendar Event Parameters

Parameter	Datatype	Possible Values
businessInterval	String
calendarType	String	"AllDays", "BusinessDays", "WeekDays"

Database Event Parameters

Display Name

Variable Name

Data Type

Possible Values

Comments (Use of parameters)

Database Info

dbConnectionInfoId

String

Ex:
DatabaseConnectionInfo:192168001180152808731075200006

Provide database info typed Id.

SQL Query

sqlQuery

String

Select count(*) from tableName;

Enter SQL query to check if the required data is available in the table
For Ex: If the event is to be triggered when the total number of records in table are greater than 10, then query will be, 'Select count(*) from tablename'.

Trigger For All Records

triggerForAllRecords

Boolean

True or False

Override if you want to trigger process flow for all records present in result set of SQL query.

Check Condition

checkCondition

Boolean

True or False

Override if the result of the select query is to be compared with the conditional value.

Operator

operators

String

EX:
EqualTo,
NotEqualTo,
GreaterThan,
LessThan,
LessThanEqualTo,
GreaterThanEqualTo

The relational operator which relates the result of the select query with the conditional value.

Value

conditionValue

String

Provided value is compared with the result of the SQL query for triggering of the event.

Execute Update Query

executeUpdateQuery

Boolean

True or False

Use if you want to execute an update query.

Update Query

updateColumnName

String

Provide and update query.

Where Clause

updateWhereCondition

String

Provide the where clause.

SQL Trigger

dbtrigger

String

Provide the Database Trigger code.

SQL Trigger Name

triggerName

String

Provide SQL Trigger name.

Event Start Date

eventStartDateTime

String

06/27/2018 19:20

Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.

Event Expiry Date

eventExpiryDateTime

String

06/30/2018 00:00

Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.

Trigger

creationMode

String

Simple,
Cron

Override the trigger type.

Firing Days

calendarType

String

AllDays,
BusinessDays,
WeekDays

In case Trigger is Cron, override calendar days, event should fire.

Firing Schedule

businessInterval

String

Sec	Mins	Hrs	DOM	Mon	DOW	Year
*	0/5	*	*	*	?	*

In case Trigger is Cron then provide the cron expression.

Polling Frequency

pollingFrequency

String

Ex :
10$y means 10 years
10$M means 10 months
10$w means 10 weeks
10$d means 10 days
10$H means 10 hour
10$m means 10 minute
10$s means 10 second

Time delay that should exist between successive polls

File Event Parameters

Trigger Type

triggerType

String

"FileCreated", "FileExists", "FileModified"

Criteria on which event should be triggered

Check for File Modification

checkModified

Boolean

true or false

Override if you want event to check for File Modification in addition to File Creation

Run Initial Load

runInitialLoad

Boolean

true or false

Enable it if you want to process all the existing files at the time of activation.

Don't Process Duplicate Files

processDuplicateFile

Boolean

true or false

This will not process any file that has already been processed during last 30 (default) days. To know how to change the default value click here

File Include Criteria

filterIn

String

*.txt, *.json etc

Include files participating in event. Separate multiple files by comma. Wild characters are allowed, e.g. *.*, *, ?, [a-c]*.txt

File Exclude Criteria

filterOut

String

*.xml etc

Exclude files not participating in event. Separate multiple files by comma. Wild characters are allowed, e.g. *.*, *, ?, [a-c]*.txt

File Base Location

fileBaseLocation

String

/Adeptia/order

File Base Location

Use VFS

useWindowsService

Boolean

true or false

Override if want to use VFS service to connect to remote machine

Secure

secure

Boolean

true or false

Override if source is password protected

User Id

userId

String

Override user Id (In case secure is selected)

Password

password

String

Override password (In case secure is selected)

Event Start Date

eventStartDateTime

String

06/27/2018 19:20

Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.

Event Expiry Date

eventExpiryDateTime

String

06/30/2018 00:00

Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.

Trigger

creationMode

String

Simple,
Cron

Override the trigger type.

Firing Days

calendarType

String

AllDays,
BusinessDays,
WeekDays

In case Trigger is Cron, override calendar days, event should fire.

Firing Schedule

businessInterval

String

Sec	Mins	Hrs	DOM	Mon	DOW	Year
*	0/5	*	*	*	?	*

In case Trigger is Cron then provide the cron expression.

Polling Frequency

pollingFrequency

String

Ex :
10$y means 10 years
10$M means 10 months
10$w means 10 weeks
10$d means 10 days
10$H means 10 hour
10$m means 10 minute
10$s means 10 second

Time delay that should exist between successive polls

File Stable Time

stableTime

String

2$m means 2 minute
20$s means 20 second

Provide time period in which file must remain unmodified before a file trigger should fire

Display Name

Variable Name

Data Type

Possible Values

Comment (Use of parameter)

FTP Event Parameters

Trigger Type

triggerType

String

"FileCreated", "FileExists", "FileModified"

Criteria on which event should be triggered

Run Initial Load

runInitialLoad

Boolean

True or False

Enable it if you want to process all the existing files at the time of activation.

Don't Process Duplicate Files

processDuplicateFile

Boolean

True or False

This will not process any file that has already been processed during last 30 (default) days. To know how to change the default value click here

SFTP

secured

Boolean

True or False

Enable for transferring file using SSH.

Key Manager

keyManager

String

EX:
KeyManager:192168001180152757526927600010

Provide keyManager Typed Id when SFTP is enabled.

FTPS

ftpOverSSL

Boolean

True or False

Enable if FTPS server supports TLS and SSL protocols.

FTPS Mode

ftpsMode

String

Explicit,
Implicit

In case FTPS is enabled, provide the security mode that will be used to connect to the FTP server, default port for explicit mode is 21 and for implicit is 990.

Protection Level

ftpProtectionLevel

String

None,
Clear,
Private

In case FTPS is enabled, provide the data Channel Protection Level for FTPS.

Validate Server

ftpValidateServer

Boolean

True or False

validate server certificate.

Keystore Name

keyStoreNameForFTP

String

EX:
KeyStore:192168001073149086937652500003

Provide keystore typed Id.

File Include Criteria

filterIn

String

*.txt, *.json etc

Include files participating in event. Separate multiple files by comma. Wild characters are allowed, e.g. *.*, *, ?, [a-c]*.txt

File Exclude Criteria

filterOut

String

*.xml etc

Exclude files not participating in event. Separate multiple files by comma. Wild characters are allowed, e.g. *.*, *, ?, [a-c]*.txt

File Base Location

fileBaseLocation

String

/Adeptia/order

File Base Location

Event Start Date

eventStartDateTime

String

06/27/2018 19:20

Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.

Event Expiry Date

eventExpiryDateTime

String

06/30/2018 00:00

Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.

Trigger

creationMode

String

Simple,
Cron

Override the trigger type.

Firing Days

calendarType

String

AllDays,
BusinessDays,
WeekDays

In case Trigger is Cron, override calendar days, event should fire.

Firing Schedule

businessInterval

String

Sec	Mins	Hrs	DOM	Mon	DOW	Year
*	0/5	*	*	*	?	*

In case Trigger is Cron then provide the cron expression.

Polling Frequency

pollingFrequency

String

Ex :
10$y means 10 years
10$M means 10 months
10$w means 10 weeks
10$d means 10 days
10$H means 10 hour
10$m means 10 minute
10$s means 10 second

Time delay that should exist between successive polls

File Stable Time

stableTime

String

2$m means 2 minute
20$s means 20 second

Provide time period in which file must remain unmodified before a file trigger should fire

Display Name

Variable Name

Data Type

Possible Values

Comment (Use of parameter)

Host name

hostName

String

EX: FTP.server.com or 215.123.23.45

FTP server host name.

Port

port

Integer

EX: 21

FTP server port number.

User Id

ftpUserId

String

FTP server connection userId.

Password

ftpPassword

String

password in plain text format

FTP server connection password.

Transfer Type

transferType

String

ACTIVE,
PASSIVE

Provide transfer type to be used.

JMS Event Parameter

Display Name	Variable Name	Data Type	Possible Values	Comments (Use of Parameters)
jmsProvider	jmsProvider	String	EX: JmsProvider:192168001180152808772278900014	Provide JMS provider typed Id.
Connection Type	queueOrTopic	String	QUEUE, TOPIC	provide the JMS connection type.
Durable Subscriber	durableSubscriber	Boolean	True or False	Provide if subscriber is durable.
SubscriberID	subscriberID	String		Provide subscriber Id.
Queue Or Topic Name	queueOrtopicName	String		Provide Queue or Topic name
Message Type	messageType	String	BOTH, BYTE, TEXT	Provide message type.
MessageSelector	messageSelector	String		Select messages based on some search criteria.
UserName	userName	String		JMS provider user id.
Password	jmsPassword	String		JMS Provider password.
Session	sessionType	String	Non-Transactional, Transactional	Provide session is Non-Transactional or Transactional.
Event Start Date	eventStartDateTime	String	06/27/2018 19:20	Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.
Event Expiry Date	eventExpiryDateTime	String	06/30/2018 00:00	Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.
Polling Frequency	pollingFrequency	String	Ex : 10$y means 10 years 10$M means 10 months 10$w means 10 weeks 10$d means 10 days 10$H means 10 hour 10$m means 10 minute 10$s means 10 second	Time delay that should exist between successive polls

Mail Event Parameters

Display Name	Variable Name	Data Type	Possible Values	Comments (Use of parameters)
Protocol	protocol	String	pop3, imap	Incoming mail server protocol.
Incoming Mail Server	hostName	String	pop.gmail.com	Incoming server host name.
Domain	domain	String		Provide the domain where the CDO host machine belongs
CDO host machine	cdoMachine	String
Security Type	securityType	String	SSL, TLS	Provide the security type that will use during connection to mail server.
Port	port	String		Incoming mail server port number.
User Id	mailUserId	String		Provide the mail login user id.
Password	mailPassword	String		Provide the mail login password.
Sender E-mail	senderEmail	String		Sender E-mail Id.Wild characters are allowed, e.g. , ?, [a-z],[A-Z]b,[0-9].
Mail Subject	mailSubject	String		E-mail subject.Wild characters are allowed, e.g. , ?, [a-z],[A-Z]b,[0-9]
Mail Content	mailContent	String		E-mail Content.Wild characters are allowed, e.g. , ?, [a-z],[A-Z]b,[0-9]
File Attachment	filterCriteria	String		The name of attached file in the mail. For Microsoft Outlook Express, if file specified does not have extension then give '.dat' for extension.Wild characters are allowed, e.g. , ?, [a-z],[A-Z]b,[0-9].
Event Start Date	eventStartDateTime	String	06/27/2018 19:20	Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.
Event Expiry Date	eventExpiryDateTime	String	06/30/2018 00:00	Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.
Polling Frequency	pollingFrequency	String	Ex : 10$y means 10 years 10$M means 10 months 10$w means 10 weeks 10$d means 10 days 10$H means 10 hour 10$m means 10 minute 10$s means 10 second	Time delay that should exist between successive polls

Timer Event Parameters

Display Name	Variable Name	Data Type	Possible Values	Comment (Use of Paremters)
Event Start Date	eventStartDateTime	String	06/27/2018 19:20	Enter the date time in mm/dd/yyyy hh:mm format when event should start firing. If you want to start the event immediately after activating, then don't override this parameter.
Expiry Criteria	expiryCriteria	String	06/30/2018 00:00	Enter the date time in mm/dd/yyyy hh:mm format when event should stop firing. If you want that the event should never expire, then don't override this parameter.
Frequency	frequency	String	Ex : 10$y means 10 years 10$M means 10 months 10$w means 10 weeks 10$d means 10 days 10$H means 10 hour 10$m means 10 minute 10$s means 10 second	Provide how frequently event should fire(Required for expiry criteria:Repeat Count and Expiry By Date/Time).