How do I import configuration elements from version control using Element Manager APIs?
Environment: Oracle B2C Service Browser User Interface (BUI), Element Manager
Resolution:
Element Manager APIs now allows direct import of configuration elements and that can be used to import configurations from version control. This capability allows the customers to automate the process of deploying configuration elements to a test site. Thus reduces the development cycle time by eliminating the need to manually deploy configuration elements to a test site. The supported element types for import from version control are
- Browser Extensions
- Desktop Add-Ins
- Custom Process Models
- Custom Scripts
- Reports (only from a package)
Some highlights of the feature are:
- Signing of the certificate for the element is by-passed when the element is imported from version control or already created package via the import API.
- The import of elements from version control or already created package is singleton only.
- The dependencies of the custom code elements, if any has to be imported separately via Browser UI or via APIs.
The mandatory parameters to be passed in the body of the API call.
- Common mandatory parameters for all element types.
- Name: Name of the Import
- Package Content: Element files encoded in Base-64 format. For Browser Extension it should be base64 encoded zip file, for Add-Ins it should be base64 encoded dll or zip file, and for CPMs it should be base64 encoded php file.
- Import Type: “CustomImport”
- Mandatory custom import attributes for Browser Extension.
- Item name: Name of the browser extension
- Item type: “BrowserExtension”
- Extension Type: Type of the browser extension. One of “Analytics”, “Workspace”, “Report”, or “Console.
- Extension Init File: Initialization file for the browser extension
Click the 
next to the appropriate heading below to expand that section for viewing.
Request Headers:
{
"USERSESSION”: “{{USERSESSION-Token}}”,
"API_VERSION”: “1",
"Content-Type”: “application/json"
}
Request Body:
{
"name": "ExtensionCustomImport",
"packageContent": "{{base-64 content}}",
"importType": "CustomImport",
"attributes": {
"customImportAttributes":{
"itemName": "SampleExtensionName",
"itemType": "BrowserExtension",
"extensionAttributes":{
"extensionType": "Analytics",
"extensionInitFile": "index.html",
"extensionConfigFile":"s2_analytics.json",
"extensionSchemaFiles": ["s2_analytics.json"],
"notes": "This is a test comment"
}
}
}
}
Response Body:
{
"description": "Prepare package for import",
"id": 100015,
"href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100015"
}
- Mandatory custom import attributes for Desktop Add-Ins.
- Item name: Name of the Desktop Add-In with extension type. Extension Types: .dll or .zip.
- Item type: “DesktopAddIn”
Request Headers:
{
"USERSESSION”: “{{USERSESSION-Token}}”,
"API_VERSION”: “1",
"Content-Type”: “application/json"
}
Request Body:
{
"name": "AddInCustomImport",
"packageContent": "{{base-64 content}}",
"importType": "CustomImport",
"attributes": {
"customImportAttributes":{
"itemName": "SampleAddInName.dll",
"itemType": "DesktopAddIn",
"addInAttributes": {
"notes":"Test notes"
}
}
}
}
Response Body:
{
"description": "Prepare package for import",
"id": 100016,
"href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100016"
}
- Mandatory custom import attributes for CPMs.
- Item name: Name of the CPM Object Event Handler
- Item type: “ObjectEventHandler”
Request Headers:
{
"USERSESSION”: “{{USERSESSION-Token}}”,
"API_VERSION”: “1",
"Content-Type”: “application/json"
}
Request Body:
{
"name": "CPMCustomImport",
"packageContent": "{{base-64 content}}",
"importType": "CustomImport",
"attributes": {
"customImportAttributes":{
"itemName": "SampleObjectEventHandlerHeaderName",
"itemType": "ObjectEventHandler"
}
}
}
Response Body:
{
"description": "Prepare package for import",
"id": 100017,
"href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100017"
}
- Mandatory custom import attributes for Custom Scripts.
- Item name: Name of the custom script with extension. Extension types: .php or .phph
- Item type: “Custom Script”
Request Headers:
{
"USERSESSION”: “{{USERSESSION-Token}}”,
"API_VERSION”: “1",
"Content-Type”: “application/json"
}
Request Body:
{
"name": "CustomScriptCustomImport",
"packageContent": "{{base-64 content}}",
"importType": "CustomImport",
"attributes": {
"customImportAttributes":{
"itemName": "SampleCustomScript.php",
"itemType": "Custom Script"
"customScriptAttributes": {
"subFolderPath": "subfolder1/subfolder2"
}
}
}
}
Response Body:
{
"description": "Prepare package for import",
"id": 100018,
"href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100018"
}
- Mandatory custom import attributes for Reports.
- Item type: “Report”
Request Headers:
{
"USERSESSION”: “{{USERSESSION-Token}}”,
"API_VERSION”: “1",
"Content-Type”: “application/json"
}
Request Body:
{
"name": "ReportCustomImport",
"packageContent": "{{base-64 content}}",
"importType": "CustomImport",
"attributes": {
"customImportAttributes":{
"itemType": "Report"
}
}
}
Additional Information:
