FPA specific Process Definitions

The described process definitions are used implicitly to configure the Redwood Finance Automation system.

FCA_FPA_Configuration

The process is used to configure the application by performing several activities. Usually the configuration is done right after installation. It can be used to reset the system to default values.

The process runs the following processes:

1. Fill application customizing table FCA_ApplicationCustomizing. Existing entries are not overwritten. If you want to reset the system, delete the table or the respective table entries first.
2. Filter handling. Filters are used in the process monitors, dashboards, navigation bars and process lists. The initial settings are configured in this step.
3. Configuration of Auditing rules. Delivered Audit rules are created and activated.

FCA_FPA_DefaultParametersSynchronize

This process is used in FCA_FPA_Tasklist_Initialize to synchronize default parameters from SAP parameter table /JCS/FPA_DEFPARM to Redwood Finance Automation.

The table entries are imported into table FCA_DefaultParameters using the process FCA_DefaultParameters_Synchronize.

Parameters

• SAP_SYSTEMS - Refer to FCA_FPA_TaskDefinition_Event_Template.
• CLIENT - Refer to FCA_FPA_TaskDefinition_Event_Template.
• FORCE - Flag to delete existing content in parameter table before inserting values.
• DELETE_KEYS - List with single parameters to be deleted.
• TASK_TITLE - Refer to FCA_FPA_TaskDefinition_Event_Template.

FCA_FPA_Notification

It provides a generic process that allows for formatted HTML mails and can be used for simple workflows.

For the Workflow it creates an Operator Message. The link to this Operator Message is provided in the mail and the process waits for it to complete. The FCA_FPA Notification also allows to enter a process which is provided as a link in the notification mail.

The email Body and Text can use the replacements of the application. Additionally the message parameters can use replacements as well.

Parameters

• Mx_To - Target email addresses (To:). Duplicates will be removed automatically.
• MX_Cc - Carbon Copy email addresses (Cc:). Duplicates will be removed automatically.
• MX_BCc - List with BCc addresses. Duplicates will be removed automatically.
• MX_ReplyTo - Reply To email addresses. Only the first address will be chosen.
• Mx_Subject - Subject of the email.
• MX_Urgent - Defines urgency of the email.
• Mail_Attachments - List with Attachments. The attachments are to be defined as follows:. <attachment_name>=Step x, job y:<file>, for example: SAP_Log.log=Step 1, job 1:joblog.log <attachment_name>=job <jobid>:<file>, for example: Sap_Log.log=job 12345:joblog.log
• MX_Body - Document containing the Body of the email.
• MX_Text - Document reference containing the Text of the email. This can either contain a reference to a document in FCA (beginning with doc: ) or a text for the note box which will inserted if the content of this parameter does not match doc: in the beginning.
• MergeRecord - A merge record (for example from a RULE_RESULT parameter) inserted in this parameter creates a table with the columns specified in RecordColumnList.

The table generated from this merge record can be inserted into the MX_Text parameter or document using the ${RecordTable} tag.

• RecordColumnList - This parameter needs a comma separated list of column names. The amount of columns needs to match the number of fields per record set of the record specified in MergeRecord.
• Message1 - Variable that can be referenced in email text.
• Message2 - Variable that can be referenced in email text.
• Message3 - Variable that can be referenced in email text.
• Message4 - Variable that can be referenced in email text.
• Message5 - Variable that can be referenced in email text.
• OperatorMessage - Message to be used for the Operator Message.
• OperatorReply - Reply options for Operator Message. Syntax: ^<Option1>|<Option2>(|<option x>)$ Example: ^Confirm|Abort$ The result of the option selected will be stored in the parameter O_OMREPLY. This parameter can control other steps in the process with a precondition. The option Abort will result in the workflow process to fail (status Error). All other options will result in the workflow process to go to Completed.
• MX_MailJob - Mail process to use for sending the email.
• TRAN - This parameter can contain the transaction code of a transaction that is to be executed. Filling this field will automatically generate the execute button at the bottom of the mail.
• TRAN_PARM - This parameter can contain the parameters which should be filled in the transaction. This can be a semi-colon-separated list.

Example: BUKRS=1000,KOKRS=1000

• SAP_SYSTEMS - This parameter can be set to override the SAP System that was selected for the process. If it is not set, the SAP System of the process will be selected. The transaction link for the TRAN parameter will be created based on the value of this parameter.
• CLIENT - This parameter can be set to override the SAP Client that was selected for the process. If it is not set, the SAP Client of the process will be selected. The transaction link for the TRAN parameter will be created based on the value of this parameter.

Email Template

Each mail is delivered with 2 mail templates:

FCA_FPA_Mail_Body

FCA_FPA_Mail_Body_Webmail

The standard mail body uses CSS for mail layout and has been optimized for standard mail clients like Outlook.

The webmail body uses inline CSS and is optimized for webmail clients like gmail.

The structure of a FCA_FPA Mail looks like this:

The notification box is defined in the Mail Body parameter and contains generic information like the task number, the SAP system and the failed process.

The document box can contain the content of a document in Redwood Finance Automation or a freely chosen text. It will also include a second box if process document retrieval was selected and a process document name was defined.

The transaction button (Execute xxxx) allows to execute the SAP transaction started.

note

Even though the FCA_FPA Notification can be used for workflow control, the workflow process definitions should be used. By default, the operator message parameters will be not visible to prevent this kind of usage.

FCA_FPA_TaskList_Create

The process is used to initiate the creation of a process list for a financial close. It interprets a close template, triggers the initialization of context parameters and generates configured processes for the financial close.

Parameters

• TEMPLATE - Close template, specified as document reference.
• CHECK - Flag to only check consistency of the close template. No processes are generated.
• WAIT - Flag to indicate, the process list create process waits for the triggered processes.
• HOLD - Flag to put all generated processes on hold immediately. Manual release is necessary.
• TASKLIST_CLOSE_TYPE - Close type, either (M)onth, (Q)uarter or (Y)ear.
• TASKLIST_END_DATE - Close date. If not specified, the value is retrieved from the FiscalPeriod table.
• TASKLIST_PERIOD - Close period. If not specified the current value from FiscalPeriod table is retrieved.
• TASKLIST_YEAR - Close Fiscal Year. If not specified the current value is used from FiscalPeriod table.

FCA_FPA_TaskList_Initialize

The initialization process is trigged in the process list creation process. It takes care of several synchronization processes from SAP to Redwood Finance Automation tables. It runs as first process within a close process.

Parameters

• DL_Parameters - List with default parameters containing distribution lists.
• RetrievalType - Method to retrieve global user IDs. Valid values are:.
  • A=Alias,N=No Global Users,P=Personalisation.
• I_TYPE - Personalization type. Valid values are:.
  • U=Personalisation.
• I_KEY - Personalization Key.
• I_FIELD - Personalization field.
• FP_SYNC_RANGE - Synchronization range (in years) for fiscal periods.
• USERS - Users (Responsible, Processor, Owner) found in Close template.
• CALENDARS - Used factory calendars in close template.
• ROLE - Roles for which process list specific filters are visible in Redwood Finance Automation.
• DASHBOARD - Flag, if dashboards should be activated for the process list.
• NAVBAR - Flag, if navigation bars should be activated for the process list.
• SAP_SYSTEMS - SAP System to retrieve default parameter values from.
• CLIENT - SAP Client.
• TASK_ITEM - Node of process item.
• TASK_SUPERVISOR - Executor of process list.
• TASK_CALENDAR - Factory calendar.
• TASKLIST_ID - Name of process list instance.
• TASKLIST_DESCR - Description of process list.
• TASK_DESCR - Task name.
• FPA$STARTED_ACTION - Notification for task started (not used).
• FPA$RUNLIMIT_ACTION - Notification for task running too long (not used).
• FPA$FINISHED_ACTION - Notification for task completed (not used).
• FPA$ERROR_ACTION - Notification for task in error (not used).
• SID - Refer to FCA_FPA_TaskDefinition_Event_Template.
• SAP_USER_NAME - Refer to FCA_FPA_TaskDefinition_Event_Template.
• LANGUAGE - Refer to FCA_FPA_TaskDefinition_Event_Template.
• SID_CLIENT - Refer to FCA_FPA_TaskDefinition_Event_Template.
• SID_USER - Refer to FCA_FPA_TaskDefinition_Event_Template.
• TASK_NO - Refer to FCA_FPA_TaskDefinition_Event_Template.
• KOKRS - Refer to FCA_FPA_TaskDefinition_Event_Template.
• BUKRS - Refer to FCA_FPA_TaskDefinition_Event_Template.
• TASKLIST_END_DATE - Refer to FCA_FPA_TaskDefinition_Event_Template.
• TASKLIST_YEAR - Refer to FCA_FPA_TaskDefinition_Event_Template.
• TASKLIST_PERIOD - Refer to FCA_FPA_TaskDefinition_Event_Template.
• TASK_TITLE - Refer to FCA_FPA_TaskDefinition_Event_Template.
• RULE - Action rule to apply (as post running action).

FCA_FPA_Workflows

For processing workflows in tasks, the following definitions are available:

• FCA_FPA_Workflow_Confirm.
• FCA_FPA_Workflow_AcceptReject.
• FCA_FPA_Workflow_RestartContinueAbort.

The definitions are based on a Redwood UserMessage and will create a business user message for workflow processing. They require the process System_UserMessage_Notification in the Redwood Finance Automation partition. This process will send an enriched HTML mail to the selected recipients.

The email Body and Text can use the replacements of the solution. Additionally the message parameters can use replacements as well.

Parameters

Tab	Name	Description	Documentation	Default Expression	Values
Mail	MX_To	List with TO: Userids or email addresses
Mail	MX_Cc	List with CC: userid's or email addresses
Mail	MX_BCc	List with BCC: userid's or email addresses
Mail	MX_ReplyTo	Reply-To: userid or email address
Mail	OVERRIDE_MX_TO_MAIL_ADRESSES	Override To email adresses	Override To email adresses to supress sending mail to Users that are assigned to the Usermessage
Mail	MX_Subject	Mail Subject		==Action Required==
Mail	MX_Urgent`	Raise/Lower importance of mail			,high,low
Mail	Mail_Attachments	Mail Attachments
Mail	IN_NOTE_TARGET	Note target		W	B=Both,T=Task,W=Workflow,N=Notes forbidden
Mail	IN_UPLOAD_TARGET	Attachments target		T	B=Both,T=Task,W=Workflow,N=Upload forbidden
Mail	IN_UPLOAD_NAME	Name for uploaded files	If this parameter is set, files uploaded by the user in the inbox will be fixed to the following pattern: Upload_<Process Object Name>_<IN_UPLOAD_NAME><incrementing number starting with 1)>.<extension of the originally uploaded file>		.
Mail	MX_Body	Mail Body reference (Document ID)		${A:FPA_Mail_Body}
Mail	MX_Text	Mail Text (Document ID or plain text)		${A:FPA_Mail_Workflow}
Mail	IN_TEXT_HEADER	Text Header	Displays the set text in a bar above the mail text. Leave empty to hide the bar.	NOTE
Mail	INLINE_TABLE	Inline table for mail	If this parameter is not empty, placing the tag ${INLINE_TABLE} anywhere in the mail body / text will result in an inline table representing the provided RTX table.
Mail	MergeRecord	Result list for table display	Converts a result list into a table display. The table can be used in the mail text using a text replacement with the content RecordTable.
Mail	RecordColumnList	List with columns for result list table	Comma separated list. The amount of columns must match the number of the result list elements.
Mail	USER_MESSAGE_BUTTON_CAPTION	User message button caption	Used to as caption in for the user message button within the mail body, does not appear in the inbox view of the user message	Process Requested Action
Mail	Message1	1st Message
Mail	Message2	2nd Message
Mail	Message3	3rd Message
Mail	Message4	4th Message
Mail	Message5	5th Message
Mail	UserMessage_History	Workflow history
Workflow	UserMessage_SelectedAction	null
Workflow	UserMessage_InitialAssignee	Initial Assignee
Workflow	UserMessage_Participants	Participant Users	A comma separated list of the users allowed to reply to the user message.
Workflow	UserMessage_Comment	null
Workflow	UserMessage_Roles	Participant Roles	A comma separated list of the roles allowed to reply to the user message.
Workflow	MX_DelegateTo	Delegate To	A type of user the user message can be delegated to.		P=Participant users U=Delegating user
Workflow	UserMessage_Attach	Attach notification?	Attach the notification Task to this user message?	Y	Y,N
Workflow	UserMessage_FileList	User message file list
Workflow	UserMessage_ActionResponder	Responder of the user message action
Workflow	OUT_UPLOADED_FILE	Uploaded files
Workflow	UserMessage_NotifyMethod	Notify Method			None IndividualEmails</br />OneEmail
Infrastructure	NotificationJob	Notification definition to be started	The value of this parameter is expected to be in business key format ( like JobDefinition:PartitionName.My_System_UserMessage_Notification )
Infrastructure	_SYSTEMID	System ID of FCA		<current_system_id>
User message options	IN_UM_TEXT	User message short text		Please [Accept] to continue or [Reject] to abort the process
Target	TRAN	SAP Transaction
Target	TRAN_PARM	SAP Transaction Parameters	Separated by semicolon
Target	SAP_SYSTEMS	SAP System
Target	CLIENT	SAP Client
Runtime	rMail_Subject	Mail Subject
Runtime	rMail_Cc	Mail CC addresses
Runtime	rMail_BCc	Mail BCc addresses
Runtime	rMail_ReplyTo	Reply To address
Runtime	rMail_HTML	HTML result mail
Mail reactor	ReactMail	Set to X when react e-mail should be generated			X
Mail reactor	MailConnector	MailConnector for react mail generation
Mail reactor	Reply_Subject	Subject in reply mail-to links

• Mx_To - Comma separated list of participants. Only users that have either previously logged in or been imported can be participants (recipients) for a user message workflow, all other e-Mail addresses will be removed from the participant list. If no participant is left, a notification will be sent to the Redwood automation platform support team defined in the application customizing parameter Base_Mail_Support. The e-Mail address stored in the redwood platform user will be used by System_UserMessage_Notification as To address. Also, only the users defined as To participants will be able to respond to the workflow.
• MX_Cc - Carbon Copy email addresses (cc:). Duplicates will be removed automatically.
• MX_BCc - List with blind carbon copy addresses (bcc). Duplicates will be removed automatically.
• MX_ReplyTo - Reply To email addresses. Only the first address will be used.
• OVERRIDE_MX_TO_MAIL_ADRESSES - Suppresses sending emails to the assignee of the user message.
• Mx_Subject - Subject of the email.
• MX_Urgent - Defines urgency of the email.
• Mail_Attachments - List with Attachments. The attachments are to be defined as follows:.
  • <attachment_name>=Step x, job y:<file>, for example: SAP_Log.log=Step 1, job 1:joblog.log.
  • <attachment_name>=job <jobid>:<file>, for example: Sap_Log.log=job 12345:joblog.log.
• MX_Body - Document containing the Body of the email, defaults to ${A:FPA_Mail_Body}.
• MX_Text - Document reference containing the Text of the email. This can either contain a reference to a document in FCA (beginning with doc: ) or a text for the note box which will inserted if the content of this parameter does not match doc: in the beginning, defaults to ${A:FPA_Mail_Workflow}.
• MergeRecord - A merge record (for example from a RULE_RESULT parameter) inserted in this parameter creates a table with the columns specified in RecordColumnList. The table generated from this merge record can be inserted into the MX_Text parameter or document using the ${RecordTable} tag.
• RecordColumnList - This parameter needs a comma separated list of column names. The amount of columns needs to match the number of fields per record set of the record specified in MergeRecord.
• Message1 - Variable that can be referenced in email text.
• Message2 - Variable that can be referenced in email text.
• Message3 - Variable that can be referenced in email text.
• Message4 - Variable that can be referenced in email text.
• Message5 - Variable that can be referenced in email text.
• IN_UM_TEXT - Specify the text for the user message.
• OperatorMessage - Message to be used for the Operator Message.
• OperatorReply - Reply options for Operator Message (Example: ^Confirm|Abort$).
  • The syntax is: ^<Option1>|<Option2>...|<Optionx>$.
  • The result of the option selected will be stored in the parameter O_OMREPLY. This parameter can control other steps in the process with a precondition. The option Abort will result in the workflow task to fail (status error). All other options will result in the workflow task to go to Completed.
• TRAN - This parameter can contain the transaction code of a transaction that is to be executed. Filling this field will automatically generate the execute button at the bottom of the mail.
• TRAN_PARM - This parameter can contain the parameters which should be filled in the transaction. This can be a semi-colon-separated list.
  Example: BUKRS=1000;KOKRS=1000.
• SAP_SYSTEMS - This parameter can be set to override the SAP System that was selected for the process. If it is not set, the SAP System of the process will be selected. The transaction link for the TRAN parameter will be created based on the value of this parameter.
• CLIENT - This parameter can be set to override the SAP Client that was selected for the process. If it is not set, the SAP Client of the process will be selected. The transaction link for the TRAN parameter will be created based on the value of this parameter.

Mail Template

Each mail is delivered with 2 mail templates:

• FCA_FPA_Mail_Body
• FCA_FPA_Mail_Body_Webmail

The standard mail body uses CSS for mail layout and has been optimized for standard mail clients like Outlook.

The webmail body uses inline CSS and is optimized for webmail clients like gmail.

The structure of an FCA_FPA Mail is as follows:

The notification box is defined in the Mail Body parameter and contains generic information like the task number, the SAP system and the failed task. For Redwood Finance Automation , it also includes the org structure and process list information in the left section, overall settings in the right section.

The document box can contain the content of a document in Redwood Finance Automation or a freely chosen text. It will also include a second box if task document retrieval was selected and a task document name was defined.

The transaction button (Execute xxxx) allows to execute the SAP transaction started.

Mail Text parameters

In the mail bodies internal parameters can be used within the mail text. They work in the context of the given task and provide possibilities to use them without using replacements.

The following key words are supported:

Key word	Meaning	Example
${Executor}	Executor user in Redwood Finance Automation Task	FCc: Task Processor (FCC_TSK_PROC)
${FYearPeriod}	Fiscal Period
${Job_Description}	Description of the task
${Job_Elaps}	Elapsed time of the task
${Job_StartTime}	Start time of process	28.10.2015 14:54:09
${Message1}	Message variable 1
${Message2}	Message variable 2
${Message3}	Message variable 3
${Message4}	Message variable 4
${Org_Title}	Organisational context	CA=1000 / CC=0005
${Period_FromTo}	Fiscal period context	01.10.2015 => 31.10.2015
${RAP_SYSID}	System ID	RedwoodPlatform:sysid.fca.internal:10180
${RecordTable}	Contents of merge record in table format	Table display of a list of records
${Responsible}	Responsible user in FPA Task	Hugo Wolf (WOLFHUGO)
${rMail_Subject}	Mail subject
${SapUser}	Executing SAP user	Hugo Wolf (WOLFHUGO)
${Owner}	Owner user in Redwood Finance Automation Task	Hugo Wolf (WOLFHUGO)
${SapFpaSystem}	SAP target system	FCA.SID_FCA
${SapFpaClient}	SAP target client	110
${Title_Color}	Color of title in mail text	color:#FFFFFF
${toMailName}	To Mail recipient	Hugo Wolf (WOLFHUGO)

Workflow control

Based on the workflow process, additional parameters are available and a different workflow handling can be done. For proper workflow behavior, the step including the workflow process must only contain the workflow process. Adding additional processes to the same step will cause the workflow being handled incorrectly.

FCA_FPA_Workflow_Confirm

This workflow will create a usermessage allowing a confirm only. The default status handler for the step including this workflow will be standard for completed and error.

FCA_FPA_Workflow_AcceptReject

This workflow will create a usermessage with the response options Accept and Reject. The workflow process will fail on Reject and will complete on Accept.

The status handlers for the step including this workflow can be adjusted to reflect the desired behavior of the task.

FCA_FPA_Workflow_RestartContinueAbort

This workflow will create a usermessage with the response options Restart, Continue and Abort.

The responses Restart and Continue will cause the workflow process to complete, the response Abort will cause the workflow process to finish with error.

The status handler for the step containing this workflow should be Goto <Step> (preferably the step containing the workflow) for Completed and Raise Error for Error.

In addition, this workflow offers three additional parameters:

• IN_RESTART_STEP - Step name of the step that should be processed if the Restart option is selected. The status handler for Completed must contain a goto option in order for this to work.
• IN_CONTINUE_STEP - Step name of the step that should be processed if the Continue option is selected. The status handler for Completed must contain a goto option in order for this to work.
• IN_ABORT_STEP - Step name of the step that should be processed if the Restart option is selected. The status handler for Error must contain a goto option in order for this to work.

SAP Credentials

SAP credentials are specified in CREDENTIAL_USER parameters by specifying the SAP user name; the credential must exist and have the following properties:

Field	Description	Value
Credential Protocol	The credential protocol for SAP connections	GLOBAL.SAP_RFC
Endpoint	The target SAP system	<partition>.<name>
Real User	The SAP user name	jdoe

financeTopic