Imports the application resources from the artifacts repository and deploys the application to one or more selected cloud instances. Performs environment-specific property replacement for one or more service endpoint configuration plans ( if exists ) before deployment.

It is required to have exported the application resources using exportApplication operation prior to running the import. This operation uses the application artifact zip file (ApplicationId-ApplicationVersion.zip) from the artifacts repository and derives the ApplicationVersion to be used for the application imported to the target cloud instances. It will result in failure when there is no exported application artifact in the repo,

Configuration plans can be used for this operation, see below for more details. It also performs application 'Stage' or 'Publish' based on the operation type plugin input after successfully importing all the resources.

Either FDOVB_CLOUD_ACCOUNT_CODE environment instance property value or FDOVB_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exists, plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for OVB.

Environment/Instance Properties

Property Name	Property Code	Required	Description
Oracle Visual Builder Account	FDOVB_CLOUD_ACCOUNT_CODE	No	The OVB account with all the required properties like Base URI, Username and Password for running OVB Instance.

Project Properties

Property Name	Property Code	Required	Description
Oracle Visual Builder Application Id	FDOVB_APPLICATION_ID	Yes	This ID defines the context path (browser's URI) used for the application.
Oracle Visual Builder Application Description	FDOVB_APPLICATION_DESCRIPTION	No	Oracle Visual Builder Application Description.

Cloud Account Properties

Property Name	Property Code	Required	Description
OVB User	`FDOVBACCT_USERNAME`	Yes	User name for the registered OVB account
OVB Password	`FDOVBACCT_PASSWORD`	Yes	Password for the registered OVB account
OVB Base URI	`FDOVBACCT_BASE_URI`	Yes	The REST Base URI of a running OVB Instance
OVB Identity Base URI	`FDOVBACCT_IDENTITY_BASE_URI`	No	The Oracle Identity Cloud Service URL (IDCS). E.G. https://idcs-1a2bc3de.identity.oraclecloud.com. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Client Id	`FDOVBACCT_CLIENT_ID`	No	The Oracle Identity Client Id. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Client Secret	`FDOVBACCT_CLIENT_SECRET`	No	The Oracle Identity Client Secret. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Client Scope	`FDOVBACCT_CLIENT_SCOPE`	No	The Oracle Identity Client Scope. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Keystore Path	`FDOVBACCT_KEYSTORE_PATH`	No	Java keystore path containing the private key to use for JWT User Assertion. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Keystore Passphrase	`FDOVBACCT_KEYSTORE_PASS`	No	Java keystore passphrase for the OVB Keystore Path property. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Certificate Alias	`FDOVBACCT_CERT_ALIAS`	No	Private certificate alias. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Certificate Passphrase	`FDOVBACCT_CERT_PASS`	No	Passphrase for the OVB Certificate Alias property. Leave blank if no passphrase was used. Only required when using OAuth. For more information on configuring OAuth see here.
OVB Certificate Algorithm	`FDOVBACCT_CERT_ALGORITHM`	No	Algorithm used for the certificate. Defaults to RS256 Only required when using OAuth. For more information on configuring OAuth see here.
OVB Component Exchange URL	`FDOVBACCT_COMPONENT_EXCHANGE_URL`	No	URL for a visual builder component exchange. More info on this https://docs.oracle.com/en/cloud/paas/app-builder-cloud/abcag/manage-your-component-exchange.html#GUID-2B02DA1E-82EA-4FD1-88EC-F1C113A8969E. Default is the US Oracle hosted exchange. Only neccessary if using buildApplication operation and you are using component exchange.
OVB Component Exchange Username	`FDOVBACCT_COMPONENT_EXCHANGE_USERNAME`	No	Username for a visual builder component exchange. Defaults to US oracle hosted exchange. Only neccessary if using buildApplication operation and you are using component exchange.
OVB Component Exchange Password	`FDOVBACCT_COMPONENT_EXCHANGE_PASSWORD`	No	Password for a visual builder component exchange. Default for US oracle hosted exchange is: bXwphh6RMFjn#g Only neccessary if using buildApplication operation and you are using component exchange.

Inputs

Input Name	Input Code	Required	Description
Oracle Visual Builder Account	FDOVB_INP_CLOUD_ACCOUNT_CODE	No	The OVB account with all the required properties like Base URI, Username and Password for running OVB Instance.
Oracle Visual Builder Application Import Operation	FDOVB_INP_OPERATION_TYPE	No	Visual builder operation (Blank, Stage or Publish) to be performed after successful import. Defaults to Publish

Outputs

Output Name	Description

Artifacts

This operation consumes the artifacts stored in the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the environment/instance.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Configuration Plans

Configuration plans are used to dynamically update the environment specific information for service endpoints used across the applications. VBCS application stores the server endpoint configuration for all the service connections in the json format under '/services/' directory. This operation utilizes one or more config plans ( explained below ) to update the appropriate server definition prior importing the resources to the target cloud instance.

Configuration plans are expected to be available in the artifacts repository. You may choose to keep all the configuration plans in shared network location. However, design your workflow step to copy the required configuration plans from your shared location to the artifacts repository location ( FD_ARTIFACTS_DIR/configplans/ ) prior running the importApplication operation step.

Configuration plan file name format should be one of the following

(serviceName)-ovbconfigplan.json (global)
(serviceName)-ovbconfigplan-environmentCode.json (environment specific)

Environment specific configuration plan always takes precedence over the global plan.

Service Connection or Backend Connection specific ( global )

Lets say you have a 'getAPI' service connection in your application. Create a configuration plan with the getAPI-ovbconfigplan.json file name. The contents of the file is copied from the original service definition in the application resources and then overridden based on what you need it to be for this import operation.

Only the "servers" contents from the configuration plan file is used to override the service definition

Steps to copy from the application service connection definition file

Download the application artifact zip file created using exportApplication operation
Unzip the application artifact zip file
Go to 'services' directory
Go to appropriate service name directory. In this case, it is 'getAPI'
Look for a *.json file have all the service definitions. It is expected to have only one *.json file in this directory
Copy all the contents from /services/getAPI/someName.json to your configuration plan file
Repeat the above steps for all the service definitions you want to override.

FD_ARTIFACTS_DIR/configplans/getAPI-ovbconfigplan.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "Get API Details",
        "version": "1.0.0"
    },
    "servers": [
        {
            "url": "https://instancename.servicename.ocp.oraclecloud.com:443/ic/builder",
            "description": "Ic",
            "x-vb": {
                "authentication": {
                    "authenticated": {
                        "type": "basic",
                        "credentials": "vb_018f0546-3ec5-4de3-8a20-2989bab79b31"
                    }
                }
            }
        }
    ],
    "paths": {
        "/api/": {
            "get": {
                "operationId": "getApi",
                "responses": {},
                "x-vb": {
                    "actionHint": "getMany"
                }
            }
        }
    }
}

Steps to copy from the application service backend definition file-

Download the application artifact zip file created using exportApplication operation
Unzip the application artifact zip file
Go to 'services' directory
Open the /services/catalog.json file which stores all the backend service definitions
Look for the backend name that you are looking for and copy the contents to your configuration plan file
Repeat the above steps for all the service backend definitions you want to override.

Sample /services/catalog.json File

{
	"backends": {
		"backendService1": {
			"serviceType": "adf-describe",
			"servers": [
				{
					"x-vb": {
						"authentication": {
							"authenticated": {
								"type": "cloud"
							}
						}
					},
					"description": "Default Server",
					"url": "https://devserver.com"
				}
			],
			"transforms": {
				"path": "vb/BusinessObjectsTransforms"
			},
			"description": "Backend sample service 1"
		},
		"backendService2": {
			"serviceType": "ics",
			"servers": [
				{
					"x-vb": {
						"authentication": {
							"authenticated": {
								"type": "cloud"
							}
						}
					},
					"description": "Default Server",
					"url": "https://dev.integrations.com"
				}
			],
			"description": "Backend sample service 2"
		}
	}
}

FD_ARTIFACTS_DIR/configplans/backendService1-ovbconfigplan.json

{
	"backendService1": {
		"serviceType": "adf-describe",
		"servers": [
			{
				"x-vb": {
					"authentication": {
						"authenticated": {
							"type": "cloud"
						}
					}
				},
				"description": "Default Server",
				"url": "https://devserver.com"
			}
		],
		"transforms": {
			"path": "vb/BusinessObjectsTransforms"
		},
		"description": "Backend sample service 1"
	}
}

Service Connection or Backend Connection specific ( environment specific )

All the steps to create the configuration plan file will be the same as explained in (global) section above. The only difference will be the configuration file name which should be environment specific.

For the examples shown above, the (development) environment specific configuration plan file names will be

FD_ARTIFACTS_DIR/configplans/getAPI-ovbconfigplan-development.json
FD_ARTIFACTS_DIR/configplans/backendService1-ovbconfigplan-development.json

No Configuration plans

You may choose not to utilize the dynamic reusable configuration plans. You will just not copy any configuration plan files in the artifacts repository and the operation will just do the import without any modifications. In this case, you will need to setup multiple deployment profiles in your application which will be duplicated across multiple instances.

Browser not supported