Creating a For-Each Action

1. Add a for-each action to an integration in either of the following ways:

   • On the right side of the canvas, click Actions and drag the For Each action to the appropriate location.
   • Click at the location where you want to add the for-each action, then select For Each.

   The Configure For Each panel opens. This includes a Sources tree of elements.

2. Click Edit under Configure For Each to enter a name and optional description for the for-each action.

3. Expand the Sources tree to select an element.

4. Drag a repeatable element to the Repeating Element field. This is the element over which to loop.

   Note:

   Note the following restrictions:

   • The selected element must be repetitive. You can identify repetitive elements by the three-box icon to the left of the element name.
     
     

   • Any parent of the selected element must not be repetitive.

   • The data type of the selected element must be scalar.

   • Global and nonglobal repeated elements can be selected.

   • If you have a repeating element within another repeating element (that is, a list within a list), you must first create a for-each action and loop over the parent list. This gives you access to the child list during every iteration. You can then create a second for-each action within the scope of the first for-each action and loop over the child list.

   For this example, the element over which to loop is ICSFile.

   For every iteration of the loop, there is a single reference to the repeating element (ICSFile). A current element name file is required for this action to occur.

5. Enter an alias for the current file of the iteration in the Current Element Name field.

   
   

   

   
   

   Note:

   If you drag a for-each action into a schedule integration or the for-each action is not inside a while action, for-each action, scope action, and so on, an additional field called Process items in parallel is visible at the bottom of the dialog.
   

   

   
   

   When selected, iterations of the for-each action are run in parallel. For example, if an integration processes a list of files with a for-each loop created over every file, the processing of the entire file is done in parallel for every file. If a variable is declared outside a for-each loop with Process items in parallel selected and updated within the for-each loop, the last updated value for that variable is available outside of the loop. Also, the degree of parallelism (DOP) is set to 1 to avoid concurrency issues.

6. Click Save.

   The for-each action is displayed in the canvas. A looping arrow indicates that this action performs repetitive looping.

7. Click + inside the for-each action to add additional actions. These actions define what happens during each iteration of the loop. For this example, scope and switch actions are defined within the for-each action.

   
   
   Description of the illustration oic3_for_each2.png
   

Using Global Variables in For-Each Loops

When global variables are used in for-each loops (for example, for logging purposes), they can lead to the following runtime exception when bad or invalid data is associated with the variable:

FORG0001: invalid value for cast/constructor, Cikey=13695578,
FlowId=10025204, Current Activity Key=13695578-BpAss43-BpSeq8.240-4, Current
Activity Label=assignment_ics_api_internal_variable23,

As a recommendation:

• Limit the use of global variables in for-each loops.

• Global variable handling requires database access, which results in an added performance overhead.

• Local variables can be used for logic specific to a local scope.

Tracking the Status of a For-Each Action During Runtime

You can track the status of the for-each action on the Instances page through the tracking diagram and activity stream for an activated integration.

1. In the navigation pane, click Observability, then Instances.

2. Click the business identifier value of the integration to track.

   The integration flow (including any for-each actions) is displayed. Any for-each action failures are identified by red arrows. The activity stream is displayed on the right side.

1. Add a switch action to an integration in either of the following ways:

   • On the right side of the canvas, click Actions and drag the Switch action to the appropriate location.
   • Click at the location where you want to add the switch action, then select Switch.

   Note:

   Nested switches are supported.

   Two branches are automatically created:

   
   

   

   
   

   • Route 1 (first) branch: You must define a routing expression for this branch.

   • Otherwise (second) branch: This branch is taken if the routing expression for the initial branch does not resolve to true.

   Note:

   To add more branches, click Actions in the switch action, then Add.

2. From the Route 1 branch icon, double-click the branch or click Actions , then Edit.

   The Configure Route panel opens. This includes a Sources tree of elements.

   You can now define different data flows for both the defined and otherwise branches in the switch action.

3. Click Edit under Configure Route to enter a name for the Route 1 branch.

4. Define a routing expression. For this example:
   • filetype is dragged to the upper Value field
   • = is selected as the operator
   • 'json' is manually entered in the lower Value field. You can also drag a value from the Sources tree or select a value from the drop-down list.
   
   
   
   
   

   You can add functions to your expression under the Functions tab. XPath version 2.0 functions are supported. Base 64 encode and decode functions that process data confidentially across layers and functions that return boolean results are also supported. Functions that return nonboolean values are not supported.

5. Click Switch to Developer Mode to view the complete path name.

   
   
   

6. Click Add condition to add more conditions or Add group to add group conditions, when needed.
7. Click Save.

   For this example, the following expression is defined:

   
   
   

8. Drag other actions and invokes into the branches of the switch action, when required by your integration. For this example, two switch action branches are defined.

   
   
   

• Creating a Scope Action
• Add Nested Scopes to a Scope Action
• Tracking the Status of a Scope Action During Runtime
• Rename a Scope

Create a Scope Action

1. Add a scope action to an integration in either of the following ways:
   • On the right side of the canvas, click Actions and drag the Scope action to the appropriate location.
   • Click at the location where you want to add the scope action, then select Scope.

2. Click Edit under Edit Scope to enter a name and optional description for the scope action.

3. Drag and design appropriate actions, mappings, and invokes into the scope action.

   
   
   

   The scope includes a default fault handler that is accessible by clicking the scope action and selecting Actions , then Fault Handlers, then Default Handler.

   
   
   

4. Click + to define actions on the default fault handler.
5. To return to the scope action, click the fault handler, and select Actions , then Show Scope Block 'scope_name'.
   When you add invokes to a scope, the named faults associated with the invokes are added to the default fault handler in the scope. For example:

   1. Add and configure an invoke connection inside the scope action (for example, a REST Adapter).
   2. Click the scope and select Actions , then Fault Handlers.

      In addition to the Default Handler, an invoke fault handler has been added.

      
      
      

   These are faults that the invoke can handle. The uniqueness of the named faults is defined by the qname of the fault. If there are multiple invokes that define the qname fault, the fault (at runtime) can respond to any invoke. The various invokes cannot be differentiated if their qnames are not unique.

6. Select appropriate named faults.

   You can also define catch all blocks for fault handling through use of the raise error action in the Fault Handler section of the scope action. Catch all blocks are processed if an invoke throws a fault, but there is not a specific catch named for it. See Catch Faults with a Re-throw Fault Action.

7. Collapse the scope action by double-clicking it. You can expand it again by double-clicking it, selecting Actions, then Expand, or clicking >.

Add Nested Scopes to a Scope Action

1. Drag a scope inside an existing scope.

   
   
   

2. Add actions and fault handlers to the nested scope, when necessary.

Track the Status of a Scope Action During Runtime

Rename a Scope

1. Open the integration that includes the scope to rename.
2. Click to collapse the scope action.
3. Click the scope and select Actions , then Edit.
4. Change the name and click Save.

1. Add an assign action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the Assign action to the appropriate location.
   • Click at the location where you want to add the assign action, then select Assign.

   The Configure Assign panel opens.

2. Click Edit under Configure Assign to enter a name and optional description for the assign action.

3. Click the + sign, then select a data type:

   • String: Create a string data type.
   • Fault: Catch and aggregate faults in parallel processing actions in schedule integrations. This operation is only supported in schedule integrations.
4. If you select String:
   1. Enter a string variable name or select an existing variable from the list.

      
      
      

      The Operations field defaults to an equal sign (=) and cannot be changed.

   2. Enter a value between the single quotes.

      
      
      

   3. Add more string variables, when needed.

      
      
      

5. If you select Fault:
   1. Enter a fault variable name or select an existing fault from the list.
   2. Select an operation from the Operation list.
      • Append: Adds a new fault to the end of the fault list.
      • Clear: Removes all entries in the fault list.
   3. If you selected Append, click Edit to select a fault from the mapper in the Value column. This option is not available with the Clear operation.

      
      
      

6. Add more fault variables, as needed.

7. Click Save.

Variable assignments can be of great complexity. You can use assignments in switch actions and maps. For example, the upper branch of a switch action is taken (if $FetchContactAssign = "failed"), which processes a contactCreateProcessing scope. Otherwise, a contactUpdateSkip scope is processed.

You can also configure the primary tracking variable and both custom field tracking variables (update and access values). You can map tracking variables to output variables or create complex expressions for an assign or switch activity.

• All tracking variables are of type string (all that assignments support).

• All three tracking variable entries are present even if you choose not to model them. The name and XPath can be empty for tracking.

• Editing or deleting the tracking variables only updates the name and XPath nodes in that particular tracking variable element.

• The tracking variables have static names. Therefore, it is possible to set a tracking variable somewhere in the flow, but not initialize it with a value and a name in the Tracking dialog.

• The primary tracking variable cannot be assigned any value in between the flow.

• You cannot create a new variable with the same names as any of the statically name tracking variables.

Creating a While Action

1. Add a while action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the While action to the appropriate location.
   • Click at the location where you want to add the while action, then select While.

   The Configure While panel opens. This includes a Sources tree of elements.

2. Click Edit under Configure While to enter a name and optional description for the while action.

3. Manually enter, select from the drop-down list, or drag an element from the Sources tree to the Value field. You can also add functions.

4. Select an operator.
5. Enter a value in the Value field.

   
   
   

6. Click Save.

   For this example, while the counter is less than or equal to 10000, the integration loops over the condition. When the condition is not met, the looping ends.

   
   
   Description of the illustration oic3_while.png
   

7. Drag invoke connections or other actions for configuration to the + sign that is displayed inside the while action. These invoke connections and actions are processed as long as the condition set in the while action is met.

   
   
   

8. If you want to edit the name or expression, double-click the While icon or select Actions , then Edit.

   Note:

   Deleting a while action has no impact on downstream processing of the integration because the while action does not have any output. Any changes in the upstream actions in the integration that impact the while condition result in the display of a warning icon on the while action.

Track the Status of a While Action During Runtime

During runtime, you can track the status of the while action in the Instances page through the tracking diagram and activity stream for an activated integration.

1. In the navigation pane, click Observability, then Instances.

2. Click the business identifier value of the integration to track.

   The integration flow (including any while actions) is displayed. Any while action failures are identified by red.

When the email notification is received during integration runtime, the parameter name is replaced with a dynamic value.

The stitch action supports scalar and complex type variables, arrays, and partial and full message payloads. Complex variables are not limited to message payloads.

The stitch action differs from the mapper and assign action in the following ways:

1. Add a stitch action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag the Data Stitch action to the appropriate location.
   • Click at the location where you want to add the data stitch action, then select Data Stitch.
   The Configure Stitch panel opens.

   
   
   

2. Click Edit under Configure Stitch to enter a name and optional description for the stitch action.

3. Click the Variable field and manually enter a variable name, select a variable from the drop-down list, or click Switch to Developer View to open the Sources tree for dragging a variable name.

   
   
   

   Global variables and business identifier tracking variables are displayed for selection. A data element is a subcomponent of a variable. A complex variable conforms to a series of data elements.

4. From the Operation list, select the operation to perform on the variable:
   • Append
   • Assign
   • Remove
5. Click the Value field and specify a value in any of the following ways:

   • Entering manually.
   • Selecting from the list.
   • Clicking Switch to Developer View to open the Sources tree.
   If you selected the Remove operation, the Value field is not displayed.
6. Click + if you want to create additional complex assignment statements.
7. When complete, click Save to save your statements and close the Configure Stitch panel.

   For this example, the following statement was created.

   
   
   

   You can also define the sequence of variables to update. For example, if you want to copy an address, and then override a child element such as street, place these statements in the correct order of processing.

Create a Wait Action

1. Add a wait action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the Wait action to the appropriate location.
   • Click at the location where you want to add the wait action, then select Wait.

   The Configure wait panel opens.

2. Click Edit under Configure wait to enter a name and optional description for the wait action.

   Configure the time to wait before processing the integration in either of two ways:

3. If you want to use literal (hard coded) values:

   1. Enter the number of seconds to wait before processing the integration. Literal values can only be in seconds, with no upper limit. The wait time cannot exceed the total running time of the integration.

      
      
      
      
      
4. If you want to enter an XPath expression:

   This option enables you to update a wait action parameter with an integration property value after the integration is activated. This update does not require a re-activation of the integration.

   1. Drag an element from the Input sources section.

      
      
      

   2. Complete design of your integration and exit the integration canvas.
   3. Activate the integration.
   4. Hover your cursor over the integration, and select Actions , then select Update property values.
   5. Enter a value to use at runtime in the New value field (for this example, 9 is entered). This value overrides the value provided in the Default value field.

      
      
      

   6. Run the integration and view the activity stream.
   7. Click View for the action in front of the wait action (for this example, a logger action) and note that the integration property value is 9 and the wait action was initiated at 02:36:32 and the next action (for this example, a second logger action) was initiated at 02:36:41 (nine seconds later).

      
      
      

Track the Status of a Wait Action During Runtime

During runtime, you can track the status of the wait action on the Tracking page through the tracking diagram and activity stream for an activated integration.

1. In the navigation pane, click Observability, then Instances.

2. Click the business identifier value of the integration to track.

   The integration flow (including any wait actions) is displayed.

Add a Global Fault

1. Design an integration. The integration does not need to be complete. You can add fault handling at any time. However, the integration must include an invoke connection.

2. In the integration canvas, click View Global Fault Handler .

   The Global Fault Handler page is displayed. The initial trigger in your integration is automatically connected to an initial Re-throw Fault action. However, you can add and delete other Re-throw Fault actions. The Re-throw Fault action does not respond back to the trigger. Instead, details collected by the Re-throw Fault action are sent to the error handling framework.

   
   
   

3. Click Actions to add actions to design specific fault handling logic in the integration. For example, you can add Switch, Stop, or additional actions, when needed.

4. To build an expression to capture fault handling information, select the action, then click , then Edit .

   

   Note:

   The Expression Builder includes the following functions under Functions > Integration Cloud for designing fault handling:

   • getFaultAsString (returns the fault as a string value)

   • getFaultAsXML (the fault as an XML element)

   • getFaultName (returns the fault name)

   • getFaultedActionName (returns the fault of the action)

   • getFlowId (returns the flow ID of the integration)

   • lookupValue

   These functions are only available within the Expression Builder in integrations.

5. Build an expression to capture fault handling information. For example:

   $TargetApplicationObject1/nssrcmpr:fault/nssrcmpr:details = "ERROR"

6. Drag a Stop action to the Otherwise branch of the switch action.

   The fault handling logic is now complete. For this example, if an error occurs, error details are captured and sent to the error handling framework (as indicated by the Re-throw Fault action). If no error occurs, the fault handling stops and nothing is sent to the error handling framework (as indicated by the Stop action).

7. Click Save.

8. Click View Main Integration to return to edit mode in the integration canvas.

9. Complete the design of the integration.

10. Activate the integration.

Track the Status of a Global Fault During Runtime

During runtime, you can track the status of global faults on the Instances page through the tracking diagram and activity stream for an activated integration. This is only possible if there is a tracking instance.

1. In the navigation pane, click Observability, then Instances.

2. On the Instances page, click the business identifier value of the integration to track.

   Global fault handling is only invoked if there is a failure in the integration flow. Failures are identified by red.

   If the global fault handler successfully handled the error, the integration is displayed as Succeeded on the Instances page.

1. Create an integration that includes a scope action. See Manage a Group of Actions and Fault Handlers with a Scope Action.

2. Double-click the scope.
3. Select Actions , then Fault Handlers, and then Default Handler.

   The scope action is now in fault design mode.

4. Add a re-throw fault action to an integration in either of the following ways:

   • On the right side of the canvas, click Actions and drag the Re-throw Fault action to the + sign.
   • Click at the location where you want to add the re-throw fault action, then select Re-throw Fault.

     This creates a re-throw fault action in the fault handling section of the scope action.

     
     
     

   Any faults captured by this action are passed to the error hospital for analysis. Because of this fault, the integration flow is terminated.

5. Double-click the scope action to return to design mode.

   The Re-throw Fault action is hidden.

6. Design your scope action.

7. To return to fault mode, double-click the scope.
8. Select Actions , then Fault Handlers, and then Default Handler.

The stage file action can also read (and remove any trailer) and unzip referenced files in a staged location. The stage file action is similar in functionality to adapters. However, unlike adapters, you do not need to create a connection to use the stage file action. The stage file action has no credential properties and security policies. The stage file action also differs from the File Adapter and FTP Adapter in that it provides the ability to define a file format for read and write operations. For the stage file action to process or act upon files and attachments, they must be available in Oracle Integration. Make the files available in Oracle Integration either using the download operation in the FTP Adapter or consuming the SOAP/REST APIs that return multipart or MTOM attachments. Oracle Integration flows exposed as REST endpoints using the REST Adapter and exposing an interface to accept multipart attachments also automatically stage files in Oracle Integration when the requests are posted to the endpoint.

Process File References

You can specify a file reference to process when you select to read the entire file, read a file in segments, or unzip a file.

Create Local Files

Note the following details about local file behavior:

• Local Oracle Integration folders can only be created using a stage file write operation from within the integration.

• Within the integration scope, the file is available for further processing.

• Using stage file operations such as read, write, and others enables you to read the contents in the scope in which the file is available.

• The file is not visible outside the scope in which it was created.

• You can use stage file write-related variables in mapping operations to point to this virtual file.

• Once the integration moves outside the scope of file visibility, the local file is deleted.

This feature is useful in the following scenarios:

• Supports multiple resource URIs and actions/verbs in a specific integration through the REST Adapter.
• Supports multiple integration patterns (for example, synchronous and asynchronous). The combination of a resource and a verb is called an operation. Each operation can be configured as a synchronous or an asynchronous one-way service. Asynchronous services accept the request and return immediately with an HTTP 202 status.

Create a Logger Action

To create a logger action:

1. Add a logger action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the Log action to the appropriate location.
   • Click at the location where you want to add the log action, then select Log.

   The Configure Logger panel opens.

2. Click Edit under Configure Logger to enter a name and optional description for the log action.

3. Select whether to always log this message or log it only when tracing is set to audit. You can enable tracing when you activate an integration. See Activate an Integration.

4. Specify a static or variable-populated message to be displayed in the activity stream and diagnostic logs. Drag elements from the Sources tree to create a message.

   
   
   

5. When complete, click Save. For this example, a log action is included in the integration.

   
   
   

Track the Status of a Logger Action During Runtime

During runtime, the messages in the loggers are written to the activity stream and diagnostic logs.

1. In the navigation pane, click Observability, then Instances.
2. Click the integration instance.
3. Scroll through the activity stream.

4. Select Download to download the logs.

5. Open the zip file and view the log messages you created.

When all tasks are completed, all branches are automatically synchronized and merged at their termination points in the parallel action and the main path of the integration is resumed. Any variables created inside the parallel branches (for example, invoke responses) are available for use in the main path.

• Use Cases
• Guidelines and Restrictions
• Design Time Behavior
• Runtime Behavior

Want to see a video demo of the parallel action?

Use Cases

Guidelines and Restrictions

• You can create a maximum of five branches to a parallel action. If you attempt to create a sixth branch by selecting Actions , and then Add on the parallel action, the selection is disabled.
• There is no limit to the number of parallel actions you can include in an integration.
• Synchronous and asynchronous integrations are supported.
• You cannot add a parallel action inside another parallel action.
• Parallel actions can be used in application integrations and schedule integrations.
• Only map, scope, switch, logger, JavaScript, B2B, and notification actions and invoke connections are supported in a parallel action branch.
• You can add parallel actions to the branches of a pick action.
• You can add parallel actions inside scope and switch actions.
• Nesting of parallel actions in for-each actions, while actions, or stage file actions with chunking is not supported.
• No independent branch-specific fault handling is supported. You can catch faults at the integration level with a global fault handler.
• Synchronization of global variables is not supported.
• Branch-specific timeouts are not supported.

Design Time Behavior

The following example provides a high-level overview of how to design a specific parallel action. This is just one example of parallel action use.

1. Add a parallel action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag the Parallel action to the appropriate location.
   • Click at the location where you want to add the parallel action, then select Parallel.

   A parallel action with two branches is created.

   
   
   

2. Select Actions to perform the following tasks.
   • Edit: Change the name of the parallel action.
   • Add: Add more branches. You can add a maximum of five branches.
   • Delete: Delete the parallel action.
   • Collapse/Expand: Collapse or expand the parallel action.
   • Cut: Cut the parallel action and paste it elsewhere in the integration. You can also cut and paste existing maps/invokes into the new parallel branches to make them process in parallel. You cannot cut an individual branch of a parallel action and paste it into another parallel action.

     See Cut and Paste Elements in the Integration Canvas.

   For this example, a third branch is added.

   
   
   

   For this example, the three branches are designed to obtain loan offers from three service endpoints and then select the best one.

3. Add and configure three REST Adapter connections to invoke the following service endpoints. At runtime, all three loan service endpoints are invoked in parallel to identify their specific loan offers.
   • American Loan
   • United Loan
   • Star Loan
4. In the mapper for each invoke action, map your SSN to the loan application for that service endpoint.

   
   
   

   At the bottom, the three branches are synchronized at their termination points and the parallel action rejoins the main branch of the integration. The main integration does not continue until all branches are complete

5. Add a switch action to define the routing rules to check for the best offer returned from the loan service endpoints.

   
   
   

6. Define the message in a log action for each switch branch.

   
   
   

   
   
   

   When complete, the integration looks as follows.

   

   The integration is now ready to be activated and invoked.

Runtime Behavior

1. Invoke an instance of your integration and go to the Instances page.

   During runtime, the activity stream shows both parallel actions and their number of branches. For this example, both parallel actions processed successfully.

   
   
   

2. Expand each branch to view more specific details.

Oracle Cloud Infrastructure functions are part of a fully managed, multi-tenant, highly scalable, on-demand, Functions-as-a-Service platform. Use Oracle Cloud Infrastructure functions to focus on writing code to meet business needs. See Overview of Functions and Functions QuickStart Guides.

• Capabilities
• Prerequisites
• Invoke Oracle Cloud Infrastructure Functions

Want to see a video demo of the OCI Function action?

Capabilities

Oracle Integration supports whatever functions you create using Oracle Cloud Infrastructure functions. Oracle Cloud Infrastructure also provides a catalog of prebuilt functions. See Creating Functions Using Pre-Built Functions.

Prerequisites

An authentication issue was encountered when invoking Function. Please 
check if the prerequisites for calling OCI services have been properly setup for 
this service instance. OCI service integration requires dynamic groups and policies 
granting access to be created in OCI Console. Please consult the documentation for 
more information.

1. Ensure that your cloud tenancy uses identity domains. Invoking Oracle Cloud Infrastructure functions from an integration does not work in cloud tenancies that are not enabled for identity domains. If you are unsure, ask your administrator for details. Your cloud tenancy does not use identity domains if you observe either of the following:
   • In the upper right corner, you select your Profiles icon and don't see an entry for identity domain.

     
     
     

   • From the menu, you select Identity & Security and don't see Domains under the Identity section.

     
     
     

2. Set up your environment to invoke Oracle Cloud Infrastructure functions from an integration. See Functions QuickStart on Cloud Shell. This section describes how to set up the following:
   • Set up your tenancy:
     • Create groups and users (if not already done so).
     • Create a compartment in which to create functions. You specify this compartment when configuring the OCI Function action in the integration canvas.
     • Create a virtual cloud network (VCN) and subnets. For example:

       
       
       

     • Create a policy for groups and services. This policy enables you to create functions. For example:

       
       
       

   • Create an application in which to create the functions to invoke. You specify this application when configuring the OCI Function action in the integration canvas. For example:

     
     
     

   • Set up your Cloud Shell development environment.
   • Create, deploy, and invoke your function. For example:

     Note:

     You must create your own functions in your tenancy. Oracle Cloud Infrastructure doesn't deploy or create any functions for you by default. Oracle Cloud Infrastructure does provide prebuilt functions that you can deploy to your own instance.

     
     
     

3. Create a dynamic group.
   1. Obtain the client ID of the OAuth application for the Oracle Integration instance.
   2. In the upper right corner, select Profile, then click the identity domain.

      
      
      

   3. In the left navigation pane, click Oracle Cloud Services.

      
      
      

      The Oracle Cloud Services page for your domain appears.

   4. In the Name column, click your service instance.
   5. Scroll down to the General Information section and copy the client ID value to use to create your dynamic group.
4. Scroll to the breadcrumbs at the top and click Default domain.

   
   
   

5. In the left navigation pane, click Dynamic groups.
6. Click Create Dynamic Group.
7. Enter the following details:
   1. In the Name and Description fields, enter values. These fields are required.
   2. In the Matching Rules section, enter the required rule. The resource ID you specify must match the client ID of the OAuth application of your Oracle Integration instance. Ensure that you enclose the value in single quotes. For example:

      resource.id = 'client_ID'

      
      
      

8. Assign a policy to the dynamic group to enable you to invoke Oracle Cloud Infrastructure functions from an integration.
9. Scroll to the breadcrumbs at the top and click Identity.

   
   
   

10. In the left navigation pane, click Policies.
11. Click Create Policy.
12. Select the compartment in which to create the policy.
13. Enter the following details:
    1. In the Name and Description fields, enter values. These fields are required.
    2. In the Policy Builder section, build the required policy for the dynamic group. The following example allows the dynamic group to use the entire functions family, but you can set more granular policies, as needed. See Controlling Access to Invoke and Manage Functions and Policy Statements to Give OCI Functions Users Access to Function-Related Resources.

       Allow dynamic-group group_name to use functions-family in compartment compartment_name

       Where:

       • group_name: Is the dynamic group name you created.
       • compartment_name: Is the compartment where the functions to invoke are hosted.

       This enables the Oracle Integration instance associated with the dynamic group to invoke Oracle Cloud Infrastructure functions with the OCI Function action in an integration.

Invoke Oracle Cloud Infrastructure Functions

This section provides an overview of how to configure an OCI Function action in the integration canvas to invoke the Oracle Cloud Infrastructure functions available in your application.

1. Add an OCI Function action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag the OCI Function action to the appropriate location.
   • Click at the location where you want to add the parallel action, then select OCI Function.

   Note:

   If your cloud tenancy is not using identity domains, an error message appears and the page is blank.

   The OCI Functions wizard appears.

2. On the Basic Info page, enter the following information to identify the function to invoke, then click >. When you enter details in a field, the page refreshes to show more fields.

   Element	Description
   Region	Select the region where the functions are deployed.
   Compartment	Select the compartment where the functions to invoke are hosted.
   Application	Select the application. Oracle Cloud Infrastructure functions are organized in sets called applications. An application can contain multiple functions.
   Function	Select the Oracle Cloud Infrastructure function to invoke. The functions you are entitled to invoke by your application are displayed for selection.

   
   
   

3. On the Request page, select the payload type and specify the content, then click >.
   • JSON Sample: Drag and drop or select a file, or manually enter the payload.
   • XML Schema: Drag and drop or select a file.
   • XML Sample (Single or No NameSpace): Drag and drop or select a file.
   • Binary:
     • For files, simply select Binary and map the content.
     • For plain/text request/response payloads, select Binary and perform the following encoding:
       • To provide text as input, you must first encode the text as Base64, then decode that Base64 to a stream reference.

         decodeBase64ToReference(encodeBase64(Name))

       • To receive the text output, you need to encode the output stream reference to Base64, then decode that Base64 to text.

         decodeBase64(encodeReferenceToBase64(Stream Reference))

4. On the Response page, select the response payload type and specify the content, then click >. The available response payload types are the same as the request payload types.
5. Review your selections on the Summary page. For this example, the hello-python-json function is invoked. The request and response media is in JSON format.

   
   
   

6. Click Done.

1. Add a Publish Event action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag the Publish Event action to the appropriate location.
   • Click at the location where you want to add the publish event action, then select Publish Event.

   The Choose event panel opens.

2. Specify an event in either of two ways:
   1. Select the event, then click Choose. If you are unsure of the event contents, click View details .
   2. Click Define new event to create a new event. See Create Events to Publish and Subscribe to in Integrations.
3. Review your selections, then click Finish.

See Publish Events in an Integration.

Create a JavaScript Action

1. Add a Javascript action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the Javascript action to the appropriate location.
   • Click at the location where you want to add the Javascript action, then select Javascript.

2. Click Edit under Configure Javascript to enter a name and optional description for the JavaScript action.

3. Click the Function button.

   The Functions List appears.

4. Select a function.

   The function and Sources tree are displayed. Function details are shown, including the input and output parameters.

   
   
   

5. Click the first input parameter to open a Value field.

   
   
   

6. Drag a value from the Sources tree.

   
   
   

7. Perform the same steps to add a value for the second input parameter.

8. Click Save.

Track the Status of a Javascript Action During Runtime

During runtime, you can track the status of the JavaScript action on the Instances page through the tracking diagram and activity stream for an activated integration. This is only possible if there is a tracking instance.

• Oracle Cloud Infrastructure Object Storage Concepts
• Prerequisites
• Invoke Oracle Cloud Infrastructure Object Storage from an Integration

Oracle Cloud Infrastructure Object Storage Concepts

Oracle Cloud Infrastructure Object Storage is an internet-scale, high-performance storage platform that offers reliable and cost-efficient data durability. Oracle Cloud Infrastructure Object Storage enables you to securely store any type of data in its native format. An unlimited amount of unstructured data of any content type is supported, including analytic data and rich content such as images and videos. See Object Storage and Overview of Object Storage.

Prerequisites

• Create a dynamic group
• Create a policy to grant access to Oracle Cloud Infrastructure Object Storage.
• Ensure that your cloud tenancy uses identity domains. Your cloud tenancy does not use identity domains if you observe either of the following:
  • In the upper right corner, you select your Profiles icon and don't see an entry for identity domain.

    
    
    

  • From the menu, you select Identity & Security and don't see Domains under the Identity section.

    
    
    

• Create the required dynamic group and assign a policy to that group to allow your Oracle Integration instance to access Oracle Cloud Infrastructure Object Storage. The policy defines the permissions for the dynamic group and determines which operations the dynamic group can perform on Oracle Cloud Infrastructure Object Storage and other services such as Oracle Cloud Infrastructure Functions, Oracle Cloud Infrastructure Vision, and more
  1. Log in to the Oracle Cloud Infrastructure Console.
  2. Obtain the client ID of the OAuth application for the Oracle Integration instance.
     1. In the upper right corner, select Profile, then click the identity domain.

        
        
        

     2. In the left navigation pane, click Oracle Cloud Services.

        
        
        

        The Oracle Cloud Services page for your domain appears.

     3. In the Name column, click your service instance.
     4. Scroll down to the General Information section and copy the client ID value to use to create your dynamic group.
  3. Scroll to the breadcrumbs at the top and click Default domain.

     
     
     

  4. In the left navigation pane, click Dynamic groups.
  5. Click Create Dynamic Group.
  6. Enter the following details:
     1. In the Name and Description fields, enter values. These fields are required.
     2. In the Matching Rules section, enter the required rule. The resource ID you specify must match the client ID of the OAuth application of your Oracle Integration instance. Ensure that you enclose the value in single quotes. For example:

        resource.id = 'client_ID'

        
        
        

  7. Scroll to the breadcrumbs at the top and click Identity.

     
     
     

  8. In the left navigation pane, click Policies.
  9. Click Create Policy.
  10. Select the compartment in which to create the policy.
  11. Enter the following details:
      1. In the Name and Description fields, enter values. These fields are required.
      2. In the Policy Builder section, build the required policy for the dynamic group. Examples of the minimum policy required are as follows:

         allow dynamic-group dynamic_group to manage object-family in compartment compartment_name 
         

         allow dynamic-group dynamic_group to inspect compartments in compartment compartment_name
         

         Where:

         • dynamic_group: Is the dynamic group name you specified in Step 5.
         • compartment_name: Is the compartment in which your Oracle Integration instance is located.

         This enables the Oracle Integration instance associated with the dynamic group to call Oracle Cloud Infrastructure Object Storage in this particular compartment. The RPST token is only valid for resources to which the dynamic group has been granted access using this policy.

         Details about more granular permissions for object storage are provided. See Securing Object Storage.

Invoke Oracle Cloud Infrastructure Object Storage from an Integration

1. Add an OCI Object storage action to an integration in either of the following ways:
   • On the side of the canvas, click Actions and drag the OCI Object storage action to the appropriate location.
   • Click at the location where you want to add the action, then select OCI Object storage.

   The Configure object storage panel opens.

2. Enter a name.
3. Select the resource to manage.
   • Manage buckets: Buckets are logical containers for storing objects. Buckets are region- and compartment-specific. You can define policies at a bucket level to control access.
   • Manage objects: Objects are stored within buckets. Objects can be any data type and consist of the object itself and any metadata.
4. If you select Manage buckets:
   1. From the Operations list, select the operation to perform.
      • Create bucket: Create a bucket in Oracle Cloud Infrastructure Object Storage. In the mapper, you map the bucket name to create.
        1. Select the compartment in which to create the bucket. This selection during design-time is overridden if you map anything to the compartment Id field in the request mapper for this action.
      • List buckets: Retrieve a list of objects in a bucket in Oracle Cloud Infrastructure Object Storage. In the mapper, you map the bucket name to retrieve the objects list.
        1. Select the compartment in which to list the buckets. This selection during design-time is override if you map anything to the compartment Id field in the request mapper for this action.
      • Delete bucket: Delete a bucket in Oracle Cloud Infrastructure Object Storage. In the mapper, you map the bucket name to delete.
   2. Click Continue.
5. If you select Manage objects:
   1. From the Operations list, select the operation to perform:
      • Upload object: Upload an object into Oracle Cloud Infrastructure Object Storage. In the mapper, you map the object name to upload. This is how you update an object (it overrides an existing object with the same name). The file size limit is 1 GB. However, the API can handle objects up to 50 GB in size. See PutObject.
      • Download object: Retrieve an object from Oracle Cloud Infrastructure Object Storage. In the mapper, you map the object name to retrieve. The size limit is 1 GB. Otherwise, the download fails.
      • Delete object: Delete an object in Oracle Cloud Infrastructure Object Storage. In the mapper, you map the object name to delete.
      • List objects: List all objects in Oracle Cloud Infrastructure Object Storage. In the mapper, you map the bucket name to retrieve the objects list.
   2. Select the compartment in which to perform the operation.
   3. Select the bucket in which to perform the operation. This selection during design-time is overridden if you map anything to the Bucket Name field in the request mapper for this action.
   4. Click Continue.
6. Review your selections on the Summary page, then click Finish.

   This creates a map action in front of the OCI Object storage action.

Several use cases that natively invoke Oracle Cloud Infrastructure Object Storage are provided. See Manage Oracle Cloud Infrastructure Buckets and Objects from an Integration.

The B2B action translates an incoming EDI document into an Oracle Integration XML message and an outgoing Oracle Integration XML message into an EDI X12 document.

On This Page

• What You Can Do with the File Server Action
• When Not to Use the File Server Action
• Start Here: Add the File Server Action to an Integration
• Option 1. Obtain a List of Files in File Server
• Option 2. Write a File to File Server
• Option 3. Move a File to File Server
• Option 4. Stage a File and Work with It, or Write a File to Another Location in File Server
• Option 5. Delete a File in File Server
• Next Steps

What You Can Do with the File Server Action

The File server action lets you interact with files in the following ways.

For all of the options, you can hard code values, but most of the time, you'll pass dynamic values into the File server action using the Map action. Complete that task after you finish defining the File server action. See Next Steps.

When Not to Use the File Server Action

If you need to complete the following tasks, use a connection that is based on the FTP Adapter, or use the stage file action:

• Write a file to a temporary storage location and then perform work on the file, such as by updating the file.

• Sign or verify a file.

Start Here: Add the File Server Action to an Integration

No matter what you need to use the File server action to do, start here by adding the action to your integration.

1. Add a File server action to an integration in either of the following ways:

   • On the side of the canvas, click Actions and drag the File server action to the appropriate location.
   • Click at the location where you want to add the assign action, then select File server.

   Note:

   If you don't see the File server action or can't add it to an integration, then an administrator needs to enable File Server for your Oracle Integration instance. See Enable File Server in Using File Server in Oracle Integration 3.

2. Fill in the following fields.

   Field	Description
   What do you want to call your endpoint?	Name of the endpoint, such as write_file_to_File_Server.
   Select resource	Select one of the following options: File: Interact with a file, such as by writing, moving, downloading, reading, or deleting it. Directory: Obtain a list of files in a specific directory in File Server.

   Additional fields, which are related to the operation that you selected, appear.

3. Continue following the steps in the appropriate section:

   • Option 1. Obtain a List of Files in File Server
   • Option 2. Write a File to File Server
   • Option 3. Move a File to File Server
   • Option 4. Stage a File and Work with It, or Write a File to Another Location in File Server
   • Option 5. Delete a File in File Server

Option 1. Obtain a List of Files in File Server

1. Complete the steps in Start Here: Add the File Server Action to an Integration.

2. From the Select operation drop-down list, select List directory.

3. Fill in the following fields.

   Field	Description	Can override later in the mapper?
   Input Directory	Name of the directory that contains the files that you need to list. Oracle recommends using an absolute directory. For example, /HOME/USERS/.	Yes
   File name pattern	Pattern of the files that you want to list, such as *.csv for only CSV files. Or, enter * to list files of all types.	Yes
   Max Files	Maximum number of files to return, up to 1000. Note: The File server action returns the files according to the last modified time. If you selected 10 as the maximum number of files and the last modified time of the eleventh file is the same as the tenth file, then the action also returns the eleventh file and any other files with the same last modified time. For example, consider a directory with 15 files, and the Max Files setting is 10. If the tenth, eleventh, twelfth, and thirteenth files have the same time stamp, then the File server action returns thirteen files.	No
   Minimum Age (seconds)	Minimum age in seconds of the files to return. For example, if a file was last modified at 02:28:45 AM, and the minimum age is 80 seconds, the file isn't returned at 02:29:00 AM and 02:30:00 AM. The file is returned only after 02:30:05.	No
   List File Recursively	Whether to list files within directories recursively beneath the input directory.	No

4. Select Continue.

5. Review the summary of the action, and select Finish.

The File server action appears on the canvas with a Map action before it.

Option 2. Write a File to File Server

1. Complete the steps in Start Here: Add the File Server Action to an Integration.

2. From the Select operation drop-down list, select Write File.

3. Fill in the following fields.

   Field	Description	Can override later in the mapper?
   Specify an Output Directory	Name of the directory to write the files to. Oracle recommends using an absolute directory. For example, /HOME/USERS/.	Yes
   File Name	Name of the file to create.	Yes

4. Select Continue.

5. Review the summary of the action, and select Finish.

The File server action appears on the canvas with a Map action before it.

Option 3. Move a File to File Server

1. Complete the steps in Start Here: Add the File Server Action to an Integration.

2. From the Select operation drop-down list, select Move File.

3. Fill in the following fields.

   Field	Description	Can override later in the mapper?
   Directory path	Name of the directory that contains the file to be moved. Oracle recommends using an absolute directory. For example, /HOME/USERS/.	Yes
   File name	Name of the file to be moved. The file can be of any size. If the file is missing, an error occurs when the integration attempts to locate it.	Yes
   Target directory path	Name of the directory to move the file to. Oracle recommends using an absolute directory. For example, /HOME/USERS/. If the directory doesn't exist, File Server creates it.	Yes
   Target file name	Name of the file in the target directory.	Yes
   Overwrite File	When selected, the target file is overwritten if it already exists. If you deselect this option and the file already exists in the target directory, an error occurs when File Server attempts to move the file to the directory.	No

4. Select Continue.

5. Review the summary of the action, and select Finish.

The File server action appears on the canvas with a Map action before it.

Option 4. Stage a File and Work with It, or Write a File to Another Location in File Server

This operation gets a reference to a file in File Server. If anyone moves or deletes the file while the integration is running, an error occurs, indicating that the file doesn't exist.

1. Complete the steps in Start Here: Add the File Server Action to an Integration.

2. From the Select operation drop-down list, select Get File Reference.

3. Fill in the following fields.

   Field	Description	Can override later in the mapper?
   Input Directory	Name of the directory that contains the files that you need to download. Oracle recommends using an absolute directory. For example, /HOME/USERS/.	Yes
   File Name	Name of the file in the input directory.	Yes

4. Select Continue.

5. Review the summary of the action, and select Finish.

The File server action appears on the canvas with a Map action before it.

Option 5. Delete a File in File Server

1. Complete the steps in Start Here: Add the File Server Action to an Integration.

2. From the Select operation drop-down list, select Delete File.

3. Fill in the following fields:

   Field	Description	Can override later in the mapper?
   Directory path	Name of the directory to delete. Oracle recommends using an absolute directory. For example, /HOME/USERS/.	Yes
   File name	Name of the file to delete.	Yes

4. Select Continue.

5. Review the summary of the action, and select Finish.

The File server action appears on the canvas with a Map action before it.

Next Steps

• Pass dynamic values into the File server action using the Map action, which appears before the File server action on the canvas. See About Mapping Data Between Applications in Using the Oracle Mapper with Oracle Integration 3.

• If you need to encrypt a file and then write it to File Server, perform the following steps:

  1. After the File server action, add a stage file action to encrypt the file.

     See Process Files in Schedule Integrations with a Stage File Action.

  2. After the stage file action, add another File server action using the Write File operation. This action uploads the file to File Server by passing the encrypted file reference.

     See Option 2. Write a File to File Server.

  Alternatively, use the FTP Adapter to encrypt the file and write it to File Server. See Create a Connection and Add the FTP Adapter Connection to an Integration in Using the FTP Adapter with Oracle Integration 3.

• If you need to decrypt a file that is in File Server, use the stage file action or the FTP Adapter. See the following links:

  • Process Files in Schedule Integrations with a Stage File Action

  • Create a Connection and Add the FTP Adapter Connection to an Integration in Using the FTP Adapter with Oracle Integration 3