\n\n\n\n\n
\n\nGetting Started\nA Quick Start for Bardioc Developers\nGetting Started
\n
Most people who find their way to this Developer Portal are interested in finding out how to develop components for Bardioc, particularly data connectors, action handlers, and frontend applications. If this is you, and you are new to Bardioc, we suggest to start in the Getting Started section.\nIf you want to read more about the technical concepts and best practices, you may want to proceed to the Documentation section.
\n\n\n\n\n\n
\n\nGetting Started\nA Quick Start for Bardioc Developers\nGetting Started
\n
\n\n\n\n\n
\n\nTutorials\nLearning Bardioc Step by Step\nTutorials
\n
\n\n\n\n\n
\n\nOverview\nA Short Introduction to Bardioc\nOverview
\n
\n\n\n\n\n
\n\nDocumentation\nConcepts, Best Practices, and Examples\nDocumentation
\n
\n\n\n\n\n
\n\nAPI\nA reference of the Bardioc API\nAPI
\n
The API specifications moved to HIRO API Reference.
\n![\"getting](\"/7.0/images/getting-started-connector.svg\")
You are new to Bardioc and are eager to get started. We have assembled some tutorials that guide you through the first steps with Bardioc, to facilitate the initial learning. After working though these tutorials, you will be able to connect with the Bardioc API…
\n\n\n\n\n\n
\n\nIdentity and Access Management\nUser accounts and permissions in Bardioc\nIdentity and Access Management in Bardioc 6
\n
\n\n\n\n\n
\n\nAutomation Task Lifecycle\nThe states and lifecycle of Automation Tasks\nAutomation Task Lifecycle
\n
\n\n\n\n\n
\n\nBardioc API Overview\nGeneral advice for working with the Bardioc API\nAPI Overview
\n
\n\n\n\n\n
\n\nBardioc Auth API\nHow to authenticate before using the Bardioc API\nAuthentication
\n
\n\n\n\n\n
\n\nBardioc Action API\nAction API in Bardioc 7 - Architecture and Definitions\nAction API in Bardioc 7
\n
\n\n\n\n\n
\n\nBardioc Websocket API\nWebsocket connections for receiving event streams\nBardioc Websocket API
\n
\n\n\n\n\n
\n\nBardioc API List modifiers\nThe list API allows one to maintain multiple values for one property\nBardioc API List modifiers
\n
\n\n\n\n\n
\n\nRefresh Access Tokens\nRefresh Access Tokens\nRefresh Access Tokens
\n
\n\n\n\n\n
\n\nGremlin Graph Queries\nGraph traversal queries using Gremlin\nGremlin Graph Queries
\n
\n\n\n\n\n
\n\nAudit API\nAPI to query audit and security logs\nAPI changelog
\n
\n\n\n\n\n
\n\nAPI Changelog\nChanges in Bardioc APIs\nAPI changelog
\n
\n\n\n\n\n
\n\nDomainObjectApi\nDomainObjectApi Overview\nDomainObjectApi Overview
\n
\n\n\n\n\n
\n\nIntroduction\nIntroduction to Connectors and Action Handlers
\n
\n\n\n\n\n
\n\nStandard Action Handler\nSetup the standard Docker image for Bardioc™ Action Handlers\nStandard Action Handler Installation Guide (Docker Image)
\n
\n\n\n\n\n
\n\nServiceNow™\nServiceNow Connector
\n
\n\n\n\n\n
\n\nSAP™ Action Handler\nSAP™ Action Handler Installation Guide (Docker Image)
\n
\n\n\n\n\n
\n\nEmail Action Handler\nEmail Action Handler
\n
\n\n\n\n\n
\n\nWinRM Action Handler\nWinRM/Powershell Action Handler
\n
\n\n\n\n\n
\n\nApproval Action Handler\nApproval Action Handler
\n
\n\n\n\n\n
\n\nCSV Connector\nDocumentation on how to use the csv connector\nCSV Connector
\n
\n\n\n\n\n
\n\nCSV Action Handler\nDocumentation on how to use the csv connector\nCSV Action Handler
\n
\n\n\n\n\n
\n\nDomainObjectApi\nDomainObjectApi Overview\nDomainObjectApi Overview
\n
\n\n\n\n\n
\n\nList of Action Capabilities\nA list of the available capabilities for action handlers\nCapabilities List
\n
\n\n\n\n\n
\n\nMigration from Bardioc 6 to Bardioc 7\nAPI updates from Bardioc 6 to Bardioc 7\nMigration from Bardioc 6 to Bardioc 7
\n
\n\n\n\n\n
\n\nTicket Classifier\nHow to make use of Bardioc’s capability to classify tickets from a ticket description\nTicket Classifier
\n
\n\n\n\n\n
\n\nLocal Reverse Proxy for Bardioc Desktop App Developers\nLocal Reverse Proxy for Bardioc Desktop App Developers\nLocal Reverse Proxy for Bardioc Desktop App Developers
\n
\n\n\n\n\n
\n\nMonitoring the Bardioc Platform\nMonitoring the Bardioc Platform\nLocal Reverse Proxy for Bardioc Desktop App Developers
\n
![\"getting](\"/7.0/images/getting-started-frontend.svg\")
You are new to Bardioc and are eager to get started. We have assembled some tutorials that guide you through the first steps with Bardioc, to fasilitate the initial learning. After working though these tutorials, you will be able to connect with the Bardioc API…
\nConnector / Action Handler Developer
\n![\"getting](\"/7.0/images/getting-started-integrator.svg\")
You are new to Bardioc and are eager to get started. We have assembled some tutorials that guide you through the first steps with Bardioc, to fasilitate the initial learning. After working though these tutorials, you will be able to connect with the Bardioc API…
\nYou are new to Bardioc and are eager to get started. Click here to work through our Tutorials to learn using the Bardioc API step by step.
\nAlternatively, we have assembled three reading lists for you to provide orientation. These links will guide you through the first steps with Bardioc, to facilitate the initial learning.
\nPlease choose what you want to achieve:
\n\nYou want to integrate Bardioc with an application or data source, for which no off-the-shelf connector exists yet. Here is what you should read first:
If you don’t know what the Bardioc product can do for you, get a first impression in the Overview: Intelligent Automation with Bardioc™
\nLearn how to access the Bardioc API and authenticate with your account credentials in First Steps with Bardioc
\nLearn how to read and write graph data throught the API in Basic Graph Operations
\nDevelop a first simple connector - Example: Google Calendar synchronization to Bardioc
\nRead how to Create automation tasks through the API
\n\nIf you want to develop a new frontend application, the Bardioc Desktop framework is a good starting point, enabling you to build native Bardioc apps.
You will soon find more information here. In the meantime, please contact us directly to get support with your frontend app.
\n\nWhether you develop a new connector or use an existing one: there are a few things that you might want to know about architecture, connectivity and enterprise compliance.
You will soon find more information here. In the meantime, please contact us directly to get support for your integration project.
\nBardioc™ is an automation tool based on a proprietary combination of artificial intelligence technologies, created by Almato AG. It can be used to automate both IT and business processes, enabling companies to utilise time and resources effectively.
\nBardioc™ is always working in the background, whether that be carrying out tasks, or learning new ones. This can be seen in the two modes Bardioc™ works in:
\nBardioc™ solves tasks automatically by applying pre-existing knowledge.
\nBardioc™ gets taught new knowledge to automate new tasks in an agile manner.
\n![\"1.](\"/7.0/images/overview/1._The_Big_Picture-575fb.png\")
\nPrimarily, Bardioc™ needs to understand the environment that it will automate in, including which tasks can occur there. These can both be extended as the scope grows, but to start off one should select an end to end process to automate, and define which tasks can occur there and their triggers.
\nTriggers will be defined for each problem type, and an Automation Task will be created in Bardioc™ every time a trigger is detected. In the Automatic Execution Mode, Bardioc™ tries to solve each task by applying existing knowledge that it will have been taught previously.
\nIf the knowledge present is not sufficient for a specific task, Bardioc™ will request to be taught new knowledge in the Agile Automation Mode, so that it can solve the task automatically the next time a similar trigger occurs.
\nAutomating with Bardioc™ entails indirectly collaborating with various team members that will each use Bardioc™ differently. For this purpose, Almato has created some User Roles to better separate responsibilities, processes for hand-over, and allow for the user interface and training content to be better catered to each role.
\nSolution Design is carried out by a Business Analyst who is familiar with the business process, and understands how Bardioc™ works. They design how all components will work together and what is to be developed.
\nA Bardioc™ Developer is responsible for creating and configuring the Action Handlers and Connectors planned in the Solution Design phase. They are familiar with the source and target systems, and the available Bardioc™ APIs.
\nExperts who will teach Bardioc how to automate processes they are knowledgeable on through a chat conversation where they answer some questions regarding said processes and tasks within them.
\nThis role will be given to users who understand how Bardioc works, and can edit Bardioc’s automatically generated code to ensure it has translated content from an SME’s chat conversation correctly into KIs.
\nOnce a business process has been selected for automation, a Business Analyst will design the automated solution for the tasks within that business process and how they will be transferred into Bardioc. They will also define which external systems need to be connected to Bardioc™ and what content is needed from each.
\nThese designs will be communicated to a Developer who will create the necessary Connectors and Action Handlers which will import data into Bardioc™ for automation, and define how Bardioc™ interacts with external systems.
\n![\"1.](\"/7.0/images/overview/1._The_Big_Picture-cc237.png\")
\nOnce the integration phase is complete, the Connectors will pick up any triggers that were defined to start an automation task, and push this information into Bardioc™. Bardioc™ then tries to solve said task with existing knowledge. If there is no knowledge applicable to the task at hand, the Connector should pick up on this, and inform the relevant Subject Matter Expert, who will complete the task manually.
\nAfter manual resolution, this knowledge needs to be taught to Bardioc™ for next time the same issue occurs. In this case, the automation task that was not able to be solved by Bardioc™ appears in the user interface listed in the Automation Task Queue app. This is where the SME would need to locate it and start teaching the Bardioc Chatbot when they’re redirected to the Knowledge Acquisition Tool.
\nThrough the chat conversation, Bardioc™ understands the steps and translates it into code that is used for automation. These steps are called Knowledge Items and for the process to be complete, an AI Expert would need to peer review Bardioc™'s translation, and edit where needed, before deploying all the new knowledge so that Bardioc™ can solve the problem itself next time it occurs.
\nYou updated to
\ncommon base url (https://core.test.engine.datagroup.de) for all customers and instances
\neach bardioc instance has its own scope which manages access-permissions
the ogit/_owner attribute no longer needs to be set when writing to provide visibility and access
The structure of the path for calling the interfaces has changed:
\n/api/$VERSION/graph/ (previous)
\n/api/graph/$VERSION/ (now)
\nfor all available APIs, please visit https://core.test.engine.datagroup.de/help/
The special treatment for ogit/Person (email address has also been used as the vertex id) has been removed.
To make your exiting project work with bardioc7 you need to:
\nGraph-Api: https://core.test.engine.datagroup.de/api/graph/7
\nchange your code to refer to your scope instead of an owner:
\ne.g. when creating a new vertex set the attribue ogit/_scope
\nogit/_owner → ogit/_scope
\nFor details please read/follow the tutorial First Steps with Bardioc
When Bardioc™ receives a task to automate, it will try to complete the task with its existing knowledge base.\nIn this tutorial, we will learn how to submit automation tasks to Bardioc™ and what happens in Bardioc™ after the\ntasks has been submitted. If you are not familiar yet with how Bardioc™ works,\nwe recommend reading the Bardioc™ System Overview first.
\nAPI access to a Bardioc™ instance
\nAuthenticated Bardioc™ session with valid access token
\nDefined functions to create and read vertices via API (see Basic Data Operations)
\nLoaded calendar data into the graph with a connector (see Writing a first connector: Google Calendar synchronization to Bardioc)
\nPlease follow the steps described in the tutorial First Steps with Bardioc to\nauthenticate before proceeding to use Bardioc’s Graph API.
\nSend a new automation task to Bardioc
\nObserve how Bardioc™ processes automation tasks without Todo Variable
\nAdd a Todo Variable to our automation task
\nUnderstand what happens if automation tasks cannot be resolved
\nTeach knowledge to Bardioc™ to process our task
\nRe-submit our automation issue and check if it gets resolved
\nBardioc™ works in a task-centric mode. An Automation Task (a.k.a automation issue) is the central data object that triggers\nthe automated execution of knowledge to perform this task. We will learn how we can create new automation tasks via the\nBardioc API. The diagram below shows the issue lifecycle; issues typically move from NEW via PROCESSING to RESOLVED.
In a situation when Bardioc™ receives an automation task that is new and the knowledge base does not contain sufficient knowledge\nin order to complete it, the automation task will be set to STOPPED state and presented to a Subject Matter Expert (SME) to\nteach Bardioc™ the steps to solve the Issue. With the help of an AI Expert (AIE), this Teaching Session is translated\ninto executable knowledge, which is called Knowledge Items. Bardioc™ will then use this new knowledge the next time the same\ntask is submitted.
In this tutorial, we will first push an automation task to Bardioc™, which Bardioc™ cannot complete with the existing knowledge base.\nAfter adding a simple Knowledge Item to the knowledge base, we will then see that the automation task lifecycle is completed\nand automation tasks finally get resolved. For the sake of brevity of this tutorial, we will only enter a Knowledge Item that\nwill directly resolve the automation task. You will find more realistic teaching session examples in the Bardioc™ User Guides.
\n![\"Task](\"/7.0/images/tutorials/issue_state_diagram.png\")
\nWe want to create automation tasks frequently. Therefore, we define a convenience function to create automation tasks in\nBardioc. Since an automation task is a vertex, this function will call the create_vertex() function, which we have already\npreviously defined in another tutorial (as mentioned in the prerequisites). Then we will create an Automation Task by\ncalling this function.
An Automation Task corresponds to the entity type ogit/Automation/AutomationIssue. We define now the function create_task(),\nwhich creates a vertex representing the Automation Task in Bardioc:
![\"Gettingstarted\"](\"/7.0/images/Gettingstarted.svg\")
![\"Tutorials\"](\"/7.0/images/Tutorials.svg\")
![\"Overview\"](\"/7.0/images/Overview.svg\")
![\"Docu\"](\"/7.0/images/Docu.svg\")
![\"API\"](\"/7.0/images/API.svg\")
def create_task (issueType, subject, originNode, attributes={}):\n\n vertex_data = {'ogit/Automation/issueType': issueType,\n 'ogit/subject':subject,\n 'ogit/Automation/originNode': originNode,\n 'ogit/status': 'NEW'\n }\n vertex_data.update(attributes)\n task_id = create_vertex(bardioc_session, 'ogit/Automation/AutomationIssue', vertex_data)\n return task_idThe code above creates an automation task vertex (entity type ogit/Automation/AutomationIssue) in the Bardioc™ Graph with the provided attributes:
issueType \t: Type of task to be submitted, written to ogit/Automation/issueType attribute
subject \t: Task subject, which will be shown in user interfaces, written to ogit/subject attribute
originNode \t: vertex ID of the entity the task is initially associated with, written to ogit/Automation/originNode attribute
attributes\t: further attributes, i.e. Todo Variables and Information Variables.
The following attributes are mandatory attributes for automation tasks and need to be always provided upon creation: ogit/Automation/issueType, ogit/subject, ogit/Automation/originNode.
Attributes of an automation task are also called Variables when you work with them in Knowledge Items. Information Variables provide additional information to Bardioc™ about the specific task to perform. If your automation task would be purchasing office material, then the products to buy and the quantities might be relevant parameters that could be provided as information variables. Todo Variables represent sub-tasks or objectives that need to be satisfied. You need to specify at least one Todo Variable upon issue creation.\nNote: You may add arbitrary attributes to an automation task – either any already defined attributes from the OGIT schema, or free attributes with a trailing “/”. Be aware that such free attributes need to be registered as Variables in Bardioc™ to be referenced in Knowledge Items. This is done in the Knowledge Acquisition Tool.
Next, we will proceed to create our first Automation Task. As an example, we will create a task for rescheduling meetings in our calendar.\nIn this example, Bardioc™ will attempt to reschedule a meeting when it finds that the meeting date is conflicting with a vacation period.\nAs a design decision, we set ogit/Automation/originNode to the ID of the calendar vertex in the graph, so that the ogit/Schedule/Calendar represents the context in which the rescheduling of meetings should be processed. We find out this vertex id by a query for the external google calendar id (xid query).\nWe proceed to create the task with the following function call, by passing the parameters needed (issueType, subject, and originNode):
google_calendar_id = '7hfea2godbmajrspfp30l23q1o@group.calendar.google.com' #replace with the id of your calendar!\ncalendar_node = read_vertex_by_xid ('CAL-' + google_calendar_id)['ogit/_id']\ntask_id = create_task('RescheduleMeeting', 'Reschedule Meeting to After Vacation', calendar_node, {})After the automation task with the above parameters is created, Bardioc™ will immediately update the task status to RESOLVED, due to the fact that no Todo Variable has been provided in the parameters. For any Automation Task that is submitted without a Todo Variable, Bardioc™ will automatically consider it RESOLVED, without any actual processing being done. We can read the Automation Task from the Graph and see that the status is RESOLVED.
task_status = read_vertex(task_id)['ogit/status']\nprint ('Task status: ' + task_status)The result is:
\nTask status: RESOLVEDWhen an automation task is submitted (task state: NEW), it must be submitted with at least one Todo Variable for Bardioc™ to work on. The task will then be processed by Bardioc™ (task state: PROCESSING).Provided that Bardioc™ has enough Knowledge to act on it, the objective of each Todo Variable will be achieved, and the Todo Variable will be removed. When all the Todo Variables are removed, the state of the task will be set to RESOLVED.
In order to have the automation task being processed by Bardioc™, we add the generic Todo Variable ProcessIssue:
task_id = create_task('RescheduleMeetings', 'Reschedule meetings during my absence', calendar_node, {'/ProcessIssue':''})Now we get a different result:
\ntask_status = bardioc.read_vertex(task_id)['ogit/status']\nprint ('Task status: ' + task_status)Task status: PROCESSINGAfter a few minutes, Bardioc™ will stop working on this issue, because there is no suitable Knowledge in the Knowledge Base:
\ntask_status = bardioc.read_vertex(task_id)['ogit/status']\nprint ('Task status: ' + task_status)Task status: STOPPEDIf there is not sufficient Knowledge in the Knowledge Base to automatically solve all objectives of the submitted Automation Task, Bardioc™will change the status of the automation task to STOPPED, which means that the task needs to be completed externally by a Subject Matter Expert (SME). By default, the transition to STOPPED state is performed after 15 minutes of idle time have elapsed.
You can view the details of the task, the execution history and the associated node context in the Task Viewer tool(IV icon in Bardioc Frontend). This is a helpful developer tool for troubleshooting if you encounter problems.
\n![\"Stopped](\"/7.0/images/tutorials/iv_stopped_task.png\")
\nNow that our task has been submitted to Bardioc™ with a Todo Variable, it ends up in STOPPED state, because there is no available knowledge to apply by the Bardioc™ Engine. The automation task shows up in the Automation Teaching Queue (ATQ) in the Bardioc™ user interface.\nWe login to Bardioc™ as SME user and start a Teaching Session. Afterwards we translate the Teaching Session into a Knowledge Item. For the sake of brevity of this tutorial, we will only write a simple Knowledge Item that removes the ProcessIssue Todo variable, so that automation tasks will be resolved.
![\"Stopped](\"/7.0/images/tutorials/teaching_session_automation_issue_1.png\")
\n![\"Teaching](\"/7.0/images/tutorials/teaching_session_automation_issue_2.png\")
\nThe contents of our sample Knowledge Item looks like this:
\nki\n name: \"I decide that nothing should be done.\"\n description: \"I decide that nothing should be done, and finish the task.\"\non\n ogit/_type == \"ogit/Schedule/Calendar\"\nwhen\n ogit/Automation/issueType == \"RescheduleMeetings\"\n ProcessIssue\ndo\n NumberOfMeetingsRescheduled = 0\n delete(ProcessIssue)The next time the same task is sent to Bardioc™, it will be handled by Bardioc™ with the new Knowledge Item. To demonstrate this, we create another automation task with the same content as before. Then we check the task status in the Task Viewer (IV) in the Bardioc™ user interface. The new task should be listed as RESOLVED.\nFinally, we use the API to check the task status and retrieve the number of rescheduled meetings (which is 0) from the Information Variable NumberOfMeetingsRescheduled:
task_id = create_task('RescheduleMeetings', 'Reschedule meetings during my absence', calendar_node, {'/ProcessIssue':''})And after waiting until the task has been completed:
\ntask = bardioc.read_vertex(task_id)\nprint ('Task status: ' + task['ogit/status'])\nprint ('Number of rescheduled meetings: ' + task['/NumberOfMeetingsRescheduled'])Task status: RESOLVED\n'Number of rescheduled meetings: 0To recap, we have learned how to submit an Automation Task to Bardioc™ for processing. An Automation Task is represented in Bardioc™ as a vertex of entity type ogit/Automation/AutomationIssue.\nThere are a few mandatory attributes that we need to specify for each task, i.e. task type, subject, and origin node.\nAttributes of an Automation Task are also called Variables, when used in Knowledge Items. There are two types of variables: Todo Variables and Information Variables.\nAs a developer you can use Information Variables to provide additional parameters for the task when sending it to Bardioc™, and to read out relevant results after the task has been processed.\nA submitted Automation Task will only be processed by Bardioc™, if we provide at least one Todo Variable (as an additional attribute) or else, Bardioc™ will mark it as RESOLVED without any actual action being performed.\nAfter entering a new task for the first time, there is typically no suitable knowledge in the knowledge base, so that a SME and an AI Expert will conduct a Teaching Session in the Bardioc™ Frontend, to teach Bardioc™ the required knowledge.\nThe next time we submit a task with the same contents, Bardioc™ will be able to solve it automatically.
Now you are ready to build your own connector to send new tasks to Bardioc™ for intelligent automation.
\nBardioc™’s database (Bardioc Graph) is a semantic graph database, which consists of vertices (containing attributes) and edges (that connect the vertices) as data items.
\nThis tutorial will demonstrate the basic graph operations that enable you to write data to the Bardioc graph database.
\nWrite a new vertex to the graph
\nRead a vertex and understand the vertex metadata
\nUpdate an existing vertex
\nCreate an edge between two vertices
\nGet related vertices
\nAPI access to a Bardioc instance
\nAuthenticated Bardioc session with valid access token
\nPlease follow the tutorial First Steps with Bardioc to authenticate before proceeding to use Bardioc’s Graph API.\nWe assume for this tutorial that you have created an authenticated bardioc session, which is available as bardioc_session object:
# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials.json')We will create an entity in Bardioc’s database called Person, together with some attributes, and then retrieve this information. To do this, we will define a function to create and read a vertex. Functions reduces repetition and make the codes reusable. By utilizing functions, any changes can be implemented in one place, without going through the whole code.
\nWe will define a helper function called create_vertex. This function will create a vertex of a specific type in Bardioc with some attributes that are passed as argument. The parameters to pass to Bardioc will be:
entity_type: The type of entity to be created which will be in OGIT form. Among the examples are person (ogit/Person), calendar (ogit/Schedule/Calendar), and event in a calendar (ogit/Schedule/Event).
attributes: The attributes attached to the entity which will be in OGIT form. Some examples are first name (ogit/firstName), last name (ogit/lastName) and email (ogit/Email).
scope: The Bardioc scope that should contain the vertex. This value will be written to the ogit/_scope attribute.
Since the entity type name contains special characters, remember to escape these special characters in the query string before sending it as URL query parameter.
\nIdeally you have an id for the 'data-scope' (environment) you want to interact with. If omitted the default scope of your account will be used. Please be aware, that this may lead to confusion if your account has access to multiple scopes. Therefore, it’s highly recommended defining your desired scope.
\nIf the vertex is successfully created, the function will return the vertex id to the console, so that we can use it for the next steps. We also print the vertex id to the console for now, so that we can easily see what is happening. If the write operation fails, we will print an error message to the console.
\ndef create_vertex(entity_type, attributes):\n if bardioc_session['scope']:\n attributes['ogit/_scope'] = bardioc_session['scope']\n escaped_type = entity_type.replace(':', '/').replace('/', '%2F')\n response = bardioc_session['session'].post(bardioc_session['graph_api'] + 'new/' + escaped_type, data=json.dumps(attributes))\n\n if response.ok:\n print('Vertex successfully written:' + response.json()['ogit/_id'])\n return response.json()['ogit/_id']\n else:\n print(str(response.status_code) + \" - \" + response.text)\n print('Failed to write vertex.')The function above can be used to write any type of vertex to the Bardioc graph database.\nNow we define a more specific helper function to create a ogit/Person entity in Bardioc Graph. This helper function will call the function create_vertex which was created earlier. The parameters that are being passed are:
last_name = last name of the person, to be written to the ogit/lastName attribute
email_address = email address of the person - this will be written as ogit/email attribute.
The entity type will be set to ogit/Person within the function.
This function will return the vertex id as received from calling the create_vertex function.
def create_person(last_name, email_address):\n person_attributes = {'ogit/lastName': last_name, 'ogit/email': email_address}\n return create_vertex('ogit/Person', person_attributes)As next step, we can write the first person entity to the Bardioc Graph by calling the create_person() function declared before. We will call the person 'Johnny' and give it the email address 'Johnny@test.com'.\nWhen the Person object is successfully written, it will return the vertex id of the object. The vertex id is a unique id generated by the graph database.
johnny = create_person('Johnny', 'johnny@test.com')\nif johnny:\n\tprint('Johnny is now known in Bardioc.')\nelse:\n\tprint('Could not add person vertex.')The result will be similar to below, which is the definition of the Person object that was created, together with its Vertex ID.
\nVertex successfully written: ckd73u0ul04jo01100j5dppq7_ckeu05eeajdvt01781ax1e8v6\nJohnny is now known in Bardioc.If everything succeeded the variable `johnny now contains vertex id of our created vertex.
\nTo retrieve the Person object definition, do a GET request by specifying the query string OGIT and printing the response code as well as the object definition in a JSON format.\nAfter creating a vertex in the previous step, we can read the vertex by using the GET request in order to retrieve the vertex.\nAgain, we define a helper function called read_vertex, so that we can read vertices more conveniently in the future.
def read_vertex (vertex_id):\n response = bardioc_session['session'].get(bardioc_session['graph_api'] + str(vertex_id))\n\n if response.ok:\n return response.json()\n else:\n print (str(response.status_code) + \" - \" + response.text)\n print ('Failed to read vertex.')\n return None# read vertex with given id\nresult = read_vertex(johnny)\npp.pprint(result)The response will be the object definition in JSON format, similar to below.
\n{ 'ogit/_created-on': 1599572471842,\n 'ogit/_creator': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_creator-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_graphtype': 'vertex',\n 'ogit/_id': 'ckd73u0ul04jo01100j5dppq7_ckeu05eeajdvt01781ax1e8v6',\n 'ogit/_is-deleted': False,\n 'ogit/_modified-by': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_modified-by-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_modified-on': 1599572471842,\n 'ogit/_organization': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nku1o70n01y50gw',\n 'ogit/_owner': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nks1o70ouhlsk6a',\n 'ogit/_scope': 'cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7',\n 'ogit/_type': 'ogit/Person',\n 'ogit/_v': 1,\n 'ogit/_v-id': '1599572471842-OluI9M',\n 'ogit/email': 'johnny@test.com',\n 'ogit/lastName': 'Johnny'}The information above shows the metadata for the person vertex that we created previously. In Step 2, we have specified the type of vertex to be created to be ogit/Person.
\nAttributes that start with ogit/_ are metadata attributes with a special meaning. Most of these metadata attributes are automatically generated by Bardioc; some can be set or modified by the user. Timestamps in metadata attributes use the EPOCH or UNIX timestamp. Please refer to the list below for more information on other metadata for the vertex that we created.
ogit/_creator-app and ogit/_modified-by-app : This is the ID that is referring to the Client ID when connecting to Bardioc’s API. This is the same Client ID that we had read from the credentials JSON file for authentication. This attribute is also helpful when identifying which connector has created or modified an entity.
ogit/_v, and ogit/_v-id : This is the indicator for version or history when the vertex is modified. One-time modification will cause the counter to increase by 1 and accompanied by its own _v-id.
ogit/_xid : This ID acts like a ‘foreign key’ in Bardioc database. It may contain the original ID made by an external app that has a different ID format than Bardioc database, but still incorporated in Bardioc as it may be crucial for the external app to refer to this vertex by this exact ID.
To update an existing vertex with new or updated attributes, we need a separate function. Define a function update_vertex, that will update a vertex by doing a POST request to the server.
def update_vertex (vertex_id, attributes):\n response = bardioc_session['session'].post(bardioc_session['graph_api'] + str(vertex_id), data=json.dumps(attributes))\n if response.ok:\n print('Vertex successfully updated:')\n pp.pprint(response.json())\n else:\n print(str(response.status_code) + \" - \" + response.text)\n print('Failed to update vertex.')\n return response.okTo update a particular object which is also called a vertex, call the update_vertex function and pass the parameters Vertex ID as well as the attributes to be updated or added together with their values. In the example below, the Vertex ID object to be updated is 'johnny@test.com', to which we will add the phone number as attribute ogit/mobilePhone with the value '+1 888 123456789'.
new_attributes = {'ogit/mobilePhone': '+1 888 123456789'}\nupdate_vertex (johnny, new_attributes)\n\n# verify update\nresult = read_vertex(johnny)\n print('updated vertex')\n pp.pprint(result)When the Vertex is successfully updated, it will respond with imformation about the modification.
\nVertex successfully updated:\n{ 'ogit/_graphtype': 'vertex',\n 'ogit/_id': 'ckd73u0ul04jo01100j5dppq7_ckeu05eeajdvt01781ax1e8v6',\n 'ogit/_is-deleted': False,\n 'ogit/_modified-by': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_modified-by-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_modified-on': 1599641083074,\n 'ogit/_v': 2,\n 'ogit/_v-id': '1599641083074-RZVqx4'}To verify our update we call read_vertex` to retrieve the object definition with the newly added attribute ogit/mobilePhone: '+1 888 123456789'. We print this to the console to verify that the phone number is now stored in the graph database.
updated vertex\n{ 'ogit/_created-on': 1599572471842,\n 'ogit/_creator': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_creator-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_graphtype': 'vertex',\n 'ogit/_id': 'ckd73u0ul04jo01100j5dppq7_ckeu05eeajdvt01781ax1e8v6',\n 'ogit/_is-deleted': False,\n 'ogit/_modified-by': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_modified-by-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_modified-on': 1599641570097,\n 'ogit/_organization': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nku1o70n01y50gw',\n 'ogit/_owner': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nks1o70ouhlsk6a',\n 'ogit/_scope': 'cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7',\n 'ogit/_type': 'ogit/Person',\n 'ogit/_v': 5,\n 'ogit/_v-id': '1599641570097-C1Of6P',\n 'ogit/email': 'johnny@test.com',\n 'ogit/lastName': 'Johnny',\n 'ogit/mobilePhone': '+1 888 123456789'}To demonstrate how two vertices can be related to each other with the Edge function, create another Person as a Vertex. The code below will call the helper function create_person.
We define the function create_edge which will accept the two vertices and the edge_type as parameters. The first Vertex will have a ‘line’ going out of it and the second Vertex will have a ‘line’ going into it.
def create_edge(vertex_1, vertex_2, edge_type):\n escaped_type = edge_type.replace(':','/').replace('/', '%2F')\n body = {'out': vertex_1,\n 'in': vertex_2}\n response = bardioc_session['session'].post(bardioc_session['graph_api'] + 'connect/' + escaped_type, json.dumps(body))\n return response.okIn the example below, the parameters being passed are:
\n\tvertex_1 = johnny\n\tvertex_2 = smith\n\tedge_type = ogit:follows\n
Which means that Johnny ‘follows’ Smith. The Edge can be verbs, like contains or likes.
\nsmith = create_person('Smith', 'smith@test.com', scope)\n\nif johnny and smith:\n result = create_edge(johnny, smith, 'ogit:follows')\n if result:\n print ('Successfully created edge')\n else:\n print('failed to create edge')If the edge is successfully created, a response like below can be expected.
\n`Successfully created edge`To validate that the edge has been created, we will ask the graph database to give us a list of all persons that Johnny follows.
\nTo receive related entities we use a gremlin query. For details on how to use please see GremlinDocs.\nThe following code retrieves all vertices that can be reached by a ogit:follows edge from our johnny entity.
gremlin = bardioc_session['graph_api'] + '/query/gremlin'\n query = 'query=out(\\'ogit%2Ffollows\\')'\n followers = bardioc_session['session'].get(f\"{gremlin}?root={johnny}&{query}\")\n pprint.pprint(followers.json())You will receive a list of followers vertices with their attributes.
\n{'items': [{'ogit/_created-on': 1599724886126,\n 'ogit/_creator': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_creator-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_graphtype': 'vertex',\n 'ogit/_id': 'ckd73u0ul04jo01100j5dppq7_ckewiw60ebt7e0178xrb984oh',\n 'ogit/_is-deleted': False,\n 'ogit/_modified-by': 'cjy5tvdfx0nkq1o7040e4mow0_cjl7uv0h3325tc506i5rv4ft8',\n 'ogit/_modified-by-app': 'cju16o7cg0001mz775fnoq66i_ckdyfzx3e92sk012669wa256x',\n 'ogit/_modified-on': 1599724886126,\n 'ogit/_organization': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nku1o70n01y50gw',\n 'ogit/_owner': 'cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nks1o70ouhlsk6a',\n 'ogit/_scope': 'cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7',\n 'ogit/_type': 'ogit/Person',\n 'ogit/_v': 1,\n 'ogit/_v-id': '1599724886126-DWPGBh',\n 'ogit/email': 'smith@test.com',\n 'ogit/lastName': 'Smith'}]}\nCongratulations! You have successfully written data to Bardioc, and are able to read it out.
\nIn this tutorial, we have learned the basic operations to work with data through the Bardioc API.\nIn the next tutorial, we will learn how to create automation tasks through the API.
\nBardioc™ is an automation tool based on a proprietary combination of artificial intelligence technologies, created by Almato AG. It can be used to automate both IT and business processes, enabling companies to utilise time and resources effectively.\nThese articles will give you a high-level overview of what Bardioc™ is, how Bardioc™ works, and how you as a developer can make best use of it.
\n\n\n\n\n\n
\n\nOverview\nIntelligent Automation with Bardioc™\nOverview: Intelligent Automation with Bardioc™
\n
You are new to Bardioc and are eager to get started. We have assembled some tutorials that guide you through the first steps with Bardioc, to facilitate the initial learning. After working though these tutorials, you will be able to connect with the Bardioc API…
\n\n\n\n\n\n
\n\nFirst Steps with Bardioc\nConnect with the Bardioc API and authenticate\nFirst Steps with Bardioc
\n
\n\n\n\n\n
\n\nBasic Data Operations\nWrite and read data to the graph\nWrite and read data to the graph
\n
\n\n\n\n\n
\n\nDeveloping a first connector\nYour first connector: synchronizing with Google Calendar\nWriting a first connector: Google Calendar synchronization to Bardioc
\n
\n\n\n\n\n
\n\nWorking with Automation Tasks\nWorking with Automation Tasks through the API\nWorking with Automation Tasks through the API
\n
\n\n\n\n\n
\n\nDeveloping a new Action Handler\nBuild a new Action Handler that executes commands\nDeveloping a new Action Handler
\n
\n\n\n\n\n
\n\nIncident handling via Domain Object Api\nFirst steps to send incidents via Domain Object Api\nFirst steps to send incidents via Domain Object Api
\n
In Bardioc™ 7 now you can build your own action handlers that can be deployed on the Bardioc™ SaaS environment or on your premises through the Action API.
\nFor details on how the Action API works please refer to: Action API Concepts
\nThis tutorial will demonstrate how to create a simple SSH Action Handler using the Action API
\nCreate a websocket connection with the Action API
\nListen to the websocket connection for the action to be executed
\nParse the parameters so that they can be used by the user to execute an action
\nSend the result back to Action API
\nAPI access to a Bardioc instance
\nAuthenticated Bardioc session with valid access token
\nPlease follow the tutorial First Steps with Bardioc to authenticate before proceeding to use Bardioc’s Graph API.\nWe assume for this tutorial that you have created an authenticated bardioc session, which is available as bardioc_session object:
# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials.json')Note - Please use the Action Handler Application credentials and not the instance / engine credentials to obtain the authentication token
\nYou will need the websocket-client library to create a websocket connection. In case you do not have it in your environment yet, install it with the pip command:
\npip install websocket-clientTo create a websocket connection with the Action API we will create the following functions:
on_message to receive the message sent by the server to our websocket client
\non_error to receive the error sent by the server in case of some issues encountered
\non_close to close the websocket connection
\non_open to open the websocket connection
\nfunc_websocket to ensure that the websocket is a long lived connection which stays open untill the token expires
\nimport websocket\n\ndef on_message(ws, message):\n print ('message received ..')\n print(message)\n\ndef on_error(ws, error):\n print ('error happened .. ')\n print (error)\n\ndef on_close(ws):\n print (\"The websocket has been closed!\")\n\ndef on_open(ws):\n print('Congrats! the websocket is now open')\n\ndef func_websocket(ws):\n ws.run_forever()Now we will create a Websocket App in the main function using the authentication token you have received previously. This Websocket App is a built in class in the websocket-client and will be used to call the functions that we defined before.
\nThe url that is used to make the websocket connection in Bardioc™ 7 is: wss://core.almato.com/api/action-ws/1/\nand the SubProtocol is: action-1.0.0.
The authentication token will be passed as a part of the subprotocol in the header in the format \"token-\"<token>.
Lastly we will call the func_websocket function defined above to open the websocket connection with the server.
\n# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials_ah.json')\nif bardioc_session['active'] == True:\n print('continue using the API ...')\n ws_token = bardioc_session['token']\n\n if __name__ == '__main__':\n ws_header = 'action-1.0.0, token-' + ws_token #header with the subprotocol and tokem\n ws = websocket.WebSocketApp(\n 'wss://core.almato.com/api/action-ws/1/',\n on_open=on_open,\n on_message=on_message,\n on_error=on_error,\n on_close=on_close,\n header={'Sec-WebSocket-Protocol': ws_header}\n )\n socket = func_websocket(ws) #function call to initiate the websocket connectionYou should see this if the websocket is successfully opened:
\nCongrats! the websocket is now openYou can use the Trace function just before the websocket class to enable debugging:
\nweb_trace = websocket.enableTrace(True)Congrats, you have successfully opened your websocket with the server. As next steps, we will learn how to listen to the websocket for the different types of messages.
\nNow we will modify the on_message function to listen to the websocket and respond according to the commands received. There can be two possible scenarios when we can receive a msg from the graph:
The websocket sends a submitAction type of message in the format below:
\n{\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\",\n \"scope\":\"$scope of your instance from which the KI was triggered\",\n \"parameters\":{\n \"host\":\"sshtest.almato.com\",\n \"command\":\"hostname\",\n \"user\":\"centos\",\n \"timeout\":60000000},\n \"type\":\"submitAction\",\n \"capability\":\"ExecuteCommand\",\n \"timeout\":60000000,\n \"handler\":\"$id of the handler\"}\nIn this case we will put the message in a global queue, so that it can be retrieved later in the main fucntion to extract the parameters and execute an SSH to the required hostname. We will then send a acknowledgement back to the server to imply that we have received the message with the action to be executed (otherwise the server will keep on sending the submitAction message untill the ack is received).
\nThe server sends an acknowledgement to the websocket after receiving the result. A sample ack message looks as follows:
\n{\n \"type\": \"acknowledged\",\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\",\n \"code\": 200,\n \"message\": \"\"\n}\nIn this case we will just catch the acknowledgement and print that the acknowledgement has been received.
\nSo the modified on_message function we will have will be as follows:
\nimport queue\n\nmsg_q = queue.Queue() #global queue to access websocket messages\n\ndef on_message(ws, message):\n print ('message received ..')\n print(message)\n message_object = json.loads(message)\n message_type = message_object['type']\n if (message_type == 'submitAction'): #if the message is a submitType action message\n message_id = message_object['id']\n print(\"message type is: \" + message_type)\n print(\"message id is: \" + message_id)\n\n ack = {\n \"type\": \"acknowledged\",\n \"id\": message_id,\n \"code\": 200,\n \"message\": \"Received the action\"\n }\n\n ack_msg = json.dumps(ack)\n ws.send(ack_msg) #sending an ack back if action is received\n msg_q.put(message)\n\n if (message_type == 'acknowledged'): #If the message sent by the server is an ack message\n print(\"result has been acknowledged\")Now that we have modified our on_message function to handle all the messages sent by the server, as next steps, we will now parse the submitAction message received from the server to extract the 'host' and 'user' parameters that we require to perform the SSH action.
\nTo parse the message we will first need to run our websocket on a separate thread. This will allow us to parallelly extract the parameters and use them for execution without closing the websocket. For more information on how threading works in Python please refer to the library on Threading.
\nFirst we will define a function 'extract_parameters' that will extract the required parameters for us and return them to main:
\ndef extract_parameters(message):\n message_object = json.loads(message)\n message_parameters = dict()\n message_parameters['id'] = message_object['id']\n message_parameters['hostname'] = message_object ['parameters']['host']\n message_parameters['user'] = message_object['parameters']['user']\n return message_parametersThen to keep the websocket running and extract the parameters parallelly we will modify the main function to run the websocket on a thread, get the message from the queue, and then extract the required parameters into variables using the above 'extract_parameters' function.
\nThe modified main will be:
\nimport threading\n\n# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials_ah.json')\nif bardioc_session['active'] == True:\n print('continue using the API ...')\n ws_token = bardioc_session['token']\n\n if __name__ == '__main__':\n ws_header = 'action-1.0.0, token-' + ws_token #header with the subprotocol and tokem\n ws = websocket.WebSocketApp(\n 'wss://core.almato.com/api/action-ws/1/',\n on_open=on_open,\n on_message=on_message,\n on_error=on_error,\n on_close=on_close,\n header={'Sec-WebSocket-Protocol': ws_header}\n )\n\n ws_thread= threading.Thread(target = func_websocket, args=[ws]) #Separate Thread to initiate the websocket, passing the websocket as a parameter\n ws_thread.start()\n while True: #Main Thread\n\n msg = msg_q.get()\n print(\"message is : \" + msg )\n\n message_parameters = extract_parameters(msg)\n message_id= message_parameters['id']\n print(\"The hostname is: \" + message_parameters['hostname'])\n print(\"the user is: \" + message_parameters['user'])Congrats you have now successfully extracted and printed the hostname and username sent from the server. You can now use these functions to perform an SSH on the target hostname. As next steps we will learn how to send a result back to the server.
\nWe will now define a function which will send the result back to the server. For the sake of simplicity we will assume that the SSH request performed on the target machine was successful, therefore, we will send a result with a successful message back to the server.
\nFirst we will define a function 'send_actionresult' which returns a result json to be sent in this format. The format of the json is as follows:
\n{\n \"type\": \"sendActionResult\",\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\",\n \"result\": {\n \"resultfield1\": \"resultvalue1\",\n \"resultfield2\": \"resultvalue2\"\n }\n}The function can be defined as follows:
\ndef send_actionresult(id):\n result = {\n \"type\": \"sendActionResult\",\n \"id\": id,\n \"result\": \"ssh was successful\",\n }\n message_result = json.dumps(result)\n return message_resultFor the sake of simplicity we are just sending a 'ssh was successful' msg without performing a real SSH using the parameters. The user can send the result according to the message he receives from the machine he is trying to SSH to and pass that as a parameter to this function.
\nWe will also modify the main to send the result back to the server through the websocket. The modified function is:
\n# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials_ah.json')\nif bardioc_session['active'] == True:\n print('continue using the API ...')\n ws_token = bardioc_session['token']\n\n if __name__ == '__main__':\n ws_header = 'action-1.0.0, token-' + ws_token #header with the subprotocol and tokem\n ws = websocket.WebSocketApp(\n 'wss://core.almato.com/api/action-ws/1/',\n on_open=on_open,\n on_message=on_message,\n on_error=on_error,\n on_close=on_close,\n header={'Sec-WebSocket-Protocol': ws_header}\n )\n\n ws_thread= threading.Thread(target = func_websocket, args=[ws])\n ws_thread.start()\n while True:\n\n msg = msg_q.get()\n print(\"message is : \" + msg )\n message_parameters = extract_parameters(msg)\n message_id= message_parameters['id']\n print(\"The hostname is: \" + message_parameters['hostname'])\n print(\"the user is: \" + message_parameters['user'])\n result = send_actionresult(message_id)\n print(result)\n ws.send(result)We will now refactor the code to add a couple of things to enable ease of use. First, we have modified the authentication function to also return the action-ws (Action API) path (in the scenario the base instance URL changes the code will not be affected). We have then replaced the https:// of the url to wss:// to change it to a websocket URL. We have also closed the websocket after 60 seconds of activity using ws_close. You can remove this once you eploy it to live to enable a long lived connection. The final refactored code can be used as follows:
\n# Imports\nimport json\nimport pprint\nimport requests\nimport ssl\nimport websocket\nimport queue\nimport threading\nimport time\n\npp = pprint.PrettyPrinter(indent=4)\n\nmsg_q = queue.Queue() #global queue to access websocket messages\n\n\n# Define authentication function\ndef initiate_bardioc_session(credentials_file_name):\n with open(credentials_file_name) as json_file:\n bardioc_credentials = json.load(json_file)\n bardioc_session_context = dict()\n bardioc_api_base = bardioc_credentials['api_url']\n # https://core.test.engine.datagroup.de/help/\n bardioc_session_context['versions'] = bardioc_api_base + '/api/version'\n bardioc_session_context['auth_api'] = bardioc_api_base + '/api/auth/6/'\n bardioc_session_context['graph_api'] = bardioc_api_base + 'graph/7/'\n bardioc_session_context['action_api'] = bardioc_api_base + '/api/action/1/'\n bardioc_session_context['action_ws_api'] = bardioc_api_base + '/api/action-ws/1/'\n\n\n\n# query_response = requests.get('https://ec2-63-33-203-84.eu-west-1.compute.amazonaws.com:8443/api/version', verify= False)\n#\n# pp.pprint(query_response.text)\n\n# # authenticate\n print('Authenticating with Bardioc Auth Service to receive an auth token ...')\n auth_data = {'client_id': bardioc_credentials['client_id'], 'client_secret': bardioc_credentials['client_secret'],\n 'username': bardioc_credentials['username'], 'password': bardioc_credentials['password']}\n bardioc_auth_api = str(bardioc_session_context['auth_api'])\n print(bardioc_auth_api)\n response = requests.post(bardioc_auth_api + 'app', data=json.dumps(auth_data), verify=False)\n\n print('Response code: ' + str(response))\n if response.ok:\n #print('You have successfully created a Bardioc access token and can start using the Bardioc API.')\n bardioc_user_token = response.json()['_TOKEN']\n print(bardioc_user_token)\n bardioc_session_context['token'] = bardioc_user_token\n bardioc_session_context['session'] = requests.Session()\n bardioc_session_context['session'].headers.update({'Authorization': 'Bearer ' + bardioc_user_token})\n bardioc_session_context['active'] = True\n else:\n print('Authentication error: ' + str(response.status_code) + ' - ' + response.reason)\n print('Error message: ' + response.text)\n print('Please check your credentials and try again.')\n bardioc_session_context['active'] = False\n\n return bardioc_session_context\n\ndef on_message(ws, message):\n print ('message received ..')\n print(message)\n message_object = json.loads(message)\n message_type = message_object['type']\n if (message_type == 'submitAction'):\n message_id = message_object['id']\n print(\"message type is: \" + message_type)\n print(\"message id is: \" + message_id)\n\n ack = {\n \"type\": \"acknowledged\",\n \"id\": message_id,\n \"code\": 200,\n \"message\": \"Received the action\"\n }\n\n ack_msg = json.dumps(ack)\n ws.send(ack_msg) #sending an ack back if action is received\n msg_q.put(message)\n\n if (message_type == 'acknowledged'):\n print(\"result has been acknowledged\")\n\n\n\ndef on_error(ws, error):\n print ('error happened .. ')\n print (error)\n\n\ndef on_close(ws):\n print (\"the websocket was closed\")\n\n\ndef on_open(ws):\n print('Congrats! the websocket is now open')\n\ndef func_websocket(ws):\n ws.run_forever()\n\ndef extract_parameters(message):\n message_object = json.loads(message)\n message_parameters = dict()\n message_parameters['id'] = message_object['id']\n message_parameters['hostname'] = message_object ['parameters']['host']\n message_parameters['user'] = message_object['parameters']['user']\n return message_parameters\n\ndef send_actionresult(id):\n result = {\n \"type\": \"sendActionResult\",\n \"id\": id,\n \"result\": \"ssh was successful\",\n }\n message_result = json.dumps(result)\n return message_result\n\n\n# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials_ah.json')\nif bardioc_session['active'] == True:\n print('continue using the API ...')\n ws_token = bardioc_session['token']\n\n if __name__ == '__main__':\n web_trace = websocket.enableTrace(False)\n https_url = bardioc_session['action_ws_api']\n ws_url = https_url.replace(\"https\", \"wss\")\n ws_header = '1.0, token-' + ws_token\n ws = websocket.WebSocketApp(\n ws_url,\n on_open=on_open,\n on_message=on_message,\n on_error=on_error,\n on_close=on_close,\n header={'Sec-WebSocket-Protocol': ws_header}\n )\n\n ws_thread= threading.Thread(target = func_websocket, args=[ws])\n ws_thread.start()\n while True:\n\n msg = msg_q.get()\n print(\"message is : \" + msg )\n\n message_parameters = extract_parameters(msg)\n message_id= message_parameters['id']\n print(\"The hostname is: \" + message_parameters['hostname'])\n print(\"the user is: \" + message_parameters['user'])\n result = send_actionresult(message_id)\n print(result)\n ws.send(result)\n time.sleep(60)\n ws.close()Congrats you have successfully created a SSH Action Handler using the Action API.
\nWe have performed the following steps for implementing this Action Handler:
\nCreated a websocket connection with the Action API
\nListened to the websocket connection for the action to be executed
\nParsed the parameters so that they can be used by the user to execute an action
\nSent the result back to Action API
\nNow that you have created your first Action Handler you can use this to SSH to a machine. You can also use this tutorial as a base to create another Action Handler with different capabilties.
\nThe Domain Object Api expects messages in sdf format. The sdf format is defined in views, e.g. the sdf for an incident is defined.
Before we can start sending incidents to Bardioc we need to have a model or representation of the environment which we want to automate in the system.\nThe smallest possible model is a single Node. Such a default node can be created by the Domain Object Api with
curl -kH 'Content-type:application/json' -X PUT 'https://doapi.almato.com/views/default/objects/defaultMachineId' -d '{\"$type\":\"configMachine\",\"name\":\"defaultMachine\",\"systemType\":\"Virtual\"}'The SDF message in the call to define the default node looks like:
\n{\n \"$type\": \"configMachine\",\n \"name\": \"defaultMachine\",\n \"systemType\":\"Virtual\"\n}In the following calls the defaultMachineId can be used to define the starting point in the model for newly created Automation Issues. An Automation Issue represent any kind of automation task. In the following we will take incident as an example.
To create an Automation Issue which represents an incident the following call can be made to the Domain Object Api:
\ncurl -kH 'Content-type:application/json' -X PUT 'https://doapi.almato.com/views/default/objects/inc-0001' -d' {\"$type\":\"incident\",\"subject\":\"My first incident\",\"originNode\":\"defaultMachineId\",\"summary\":\"This is the first incident created by me\",\"priority\":\"important\",\"description\":\"The incident was created for testing.\",\"urgency\":\"high\",\"sourceStatus\":\"open\"}'The SDF message in this call is
\n{\n \"$type\": \"incident\",\n \"subject\": \"My first incident\",\n \"originNode\": \"defaultMachineId\",\n \"summary\": \"This is the first incident created by me\",\n \"priority\": \"important\",\n \"description\": \"The incident was created for testing.\",\n \"urgency\": \"high\",\n \"sourceStatus\": \"open\"\n}In Bardioc the following AutomationIssue will be created:
\n{\n \"/ProcessIssue\": \"process me\",\n \"/actual_type\": \"IncidentType\",\n \"/description\": \"The incident was created for testing.\",\n \"/priority\": \"important\",\n \"/sourceStatus\": \"open\",\n \"/summary\": \"This is the first incident created by me\",\n \"/urgency\": \"high\",\n \"ogit/Automation/originNode\": \"defaultMachineId\",\n \"ogit/_graphtype\": \"vertex\",\n \"ogit/_id\": \"cjqzbn759dxq27f58egrs3ped\",\n \"ogit/_type\": \"ogit/Automation/AutomationIssue\",\n \"ogit/_xid\": \"prefix:inc-0001\",\n \"ogit/status\": \"PROCESSING\",\n \"ogit/subject\": \"My first incident\"\n}The issue will be processed by Bardioc. Different knowledge Items kis will be applied to solve the task at hand.
If the incident sdf does not contain required attributes, either new attributes can be requested on OGIT, or free attribute (starting with /) can be sent to the Domain Object Api.
{\n \"$type\": \"incident\",\n \"subject\": \"My first incident\",\n \"originNode\": \"defaultMachineId\",\n \"summary\": \"This is the first incident created by me\",\n \"description\": \"The incident was created for testing.\",\n \"/test\": \"this is a free test variable\"\n}The Domain Object Api has non-blocking calls. So the execution of a call to create or update an incident (and any other type of sdf) will return a message with a transaction link.
\n{\n \"link\": \"/views/default/transactions/0c6fc0cd-d6c9-4ad0-a965-859e6a3771bd\",\n \"object\": \"/views/default/objects/inc-0001\",\n \"status\": \"waiting\",\n \"requestedAt\": 1616745367187,\n \"updatedAt\": 1616745367187,\n \"startedAt\": -1,\n \"errors\": []\n}The transactions can be checked by the link or by
\ncurl https://doapi.almato.com/views/default/transactions {\n \"link\": \"/views/default/transactions/0c6fc0cd-d6c9-4ad0-a965-859e6a3771bd\",\n \"object\": \"/views/default/objects/inc-0001\",\n \"status\": \"done-success\",\n \"requestedAt\": 1616745367187,\n \"updatedAt\": 1616745369450,\n \"startedAt\": 1616745369335,\n \"errors\": []\n }If the transactions was done successfully the status of the transaction will show done-success. More details can be found in\ntransactions documentation.
It is also possible to subscribe to the transactions via websocket with transaction.done-success and transaction.done-failure respectively.
Once Bardioc starts working on the Automation Issue, every step will be documented. Every step will be exposed as an update message by the Domain Object Api.
\nTo check the updates, following call can be done with offset or iterator as a parameter.
curl https://doapi.almato.com/views/default/updates?offset=0The updates have the following format:
\n[\n {\n \"link\": \"/views/default/updates/0\",\n \"offset\": 0,\n \"object\": {\n \"summary\": \"The summary has been updated by Bardioc\",\n \"bardiocStatus\": \"PROCESSING\",\n \"$delta\": [\n \"summary\"\n ],\n \"comments\": {\n \"inc-0001-COMMENT\": {\n \"$delta\": [],\n \"comments\": []\n }\n },\n \"$type\": \"incident\",\n \"$id\": \"inc-0001\"\n }\n }\n]In $id the id of the incident for which the update is sent is shown.\nIn $delta the fields are shown which have changed by Bardioc.\nThe comments section shows the steps done by Bardioc.
It is also possible to subscribe to the updates via websocket with update.received.
Comment or work notes can be sent to the Domain Object API, on creation or while the incident is being processed by Bardioc. If an incident is created like described in Creating an Incident an additional comment can be added. For example a comment can be sent to stop processing:
curl -kH 'Content-type:application/json' -X PUT 'https://doapi.almato.com/views/default/objects/inc-0001' -d '{ \"$type\": \"incident\", \"comments\": { \"inc-0001-COMMENT\": { \"comments\": [{ \"timestamp\": 1584632631000, \"value\": \"[Bardioc] Please eject\" }] } } }'The SDF message in this call is:
\n{\n \"$type\": \"incident\",\n \"comments\": {\n \"inc-0001-COMMENT\": {\n \"comments\": [\n {\n \"timestamp\": 1584632631000,\n \"value\": \"[Bardioc] Please eject\"\n }\n ]\n }\n }\n}Now this is added to the /comments attribute in the Automation Issue. Additionally, it is stored in a timeseries vertex with the name UserComment.\nA ki can react on this comment. Bardioc will eject the Automation Issue, if the following ki is deployed:
ki\n title: \"Eject issue on request\"\n description: \"Eject issue on request\"\non\n ogit/_id\nwhen\n comments =~ \"[Bardioc].*eject\"\n ProcessIssue\ndo\n eject_issue(\"Issue has been ejected on request\")\n
This will result in a changed processing status of the Automation Issue. This is reflected in an update exposed on the Domain Object Api’s update endpoint:
\n {\n \"link\": \"/views/default/updates/1\",\n \"offset\": 1,\n \"object\": {\n \"summary\": \"The summary has been updated by Bardioc\",\n \"bardiocStatus\": \"TERMINATED\",\n \"$delta\": [\n \"bardiocStatus\"\n ],\n\n \"$type\": \"incident\",\n \"$id\": \"inc-0001\"\n }\n }Depending on the kis available in Bardioc different reactions can follow a comment in the incident.
\nIn this tutorial, we make first contact with the Bardioc API. We will understand which prerequisites are required to use the API, authenticate with our credentials, and the make first calls to the Bardioc API.
\nWe will perform the following steps to implement the connector:
\nPrepare prerequisites to connect with Bardioc
\nAuthenticate and retrieve an auth token
\nCall the Bardioc API to retrieve data
\nThe sample code in this tutorial is written in Python programming language. However, the Bardioc API follows web standards and therefore is language agnostic. You may use any programming language of your choice to interact with the Bardioc API.\nWe are using Jupyter to write the sample code to facilitate iterating and testing the code snippets (see screenshot below).
\n![\"Jupyter](\"/7.0/images/tutorials/jupyter-notebook-1.png\")
\nBefore we can start, there are a few prerequisites we need to prepare:
\nMake sure that you have access to a Bardioc instance. The Bardioc URL should be https://core.test.engine.datagroup.de/api/
\nMake sure that you have a valid user account and password with sufficient access permissions.
\nMake sure that you have received a registered application key (pair of client_id and client_secret)
\nIdeally you have an id for the 'data-scope' (environment) you want to interact with.\nIf omitted the default scope of your account will be used. Please be aware, that this may lead to confusion if your account has access to multiple scopes. Therefore, it’s highly recommended defining your desired scope.
\nConnectors typically use service accounts to connect with Bardioc. However, you may work with your personal Bardioc user account during development.
\nTo connect and authenticate ourselves with the Bardioc system, we need to provide a few parameters, i.e. server URL, user credentials and application credentials. For convenience and to keep credentials out of our code, we put them into a configuration file 'bardioc_credentials.json', so that we can read the configuration from file later.
\n{\n \"api_url\": \"https://core.test.engine.datagroup.de/api/\",\n \"scope\" : \"--INSERT SCOPE ID HERE--\",\n \"client_id\": \"--INSERT CLIENT ID HERE--\",\n \"client_secret\": \"--INSERT CLIENT SECRET HERE--\",\n \"username\": \"--INSERT YOUR USER NAME HERE--\",\n \"password\": \"--INSERT YOUR PASSWORD HERE--\"\n}Now we can import the credentials file, so that server URL and user credentials are available as variables. For convenience, we construct additional specific URLs for the Auth API (bardioc_auth_api) and Graph API (bardioc_auth_api).
\n# Imports\nimport requests\nimport json\nimport pprint\npp = pprint.PrettyPrinter(indent=4)\n\n# Create Bardioc Session\nbardioc_credentials_file = \"./bardioc_credentials.json\" #\nwith open(bardioc_credentials_file) as json_file:\n bardioc_credentials = json.load(json_file)\nbardioc_api_base = bardioc_credentials['api_url']\nbardioc_auth_api = bardioc_api_base + 'auth/6/'\nbardioc_graph_api = bardioc_api_base + 'graph/7/'As next step, we need to authenticate with the Bardioc server. This is done by sending a POST request to the Auth API, and sending the auth data as payload attributes. We must provide our user name, password, client id and client secret to successfully authenticate. The generated user token is then bound to the provided user account in combination with the specific application (client_id).
\n# Authenticate\nprint('Authenticating with Bardioc Auth Service to receive an auth token ...')\nauth_data = {'client_id': bardioc_credentials['client_id'], 'client_secret': bardioc_credentials['client_secret'], 'username': bardioc_credentials['username'], 'password': bardioc_credentials['password']}\nresponse = requests.post(bardioc_auth_api+'app', data=json.dumps(auth_data))After we have sent the authentication request, we want to know whether the authentication has succeeded, and react accordingly. In our sample code, we will print out the authentication status to the console.
\nFor further API use, we always need to pass on our auth token as header attribute in all HTTPS requests. We will prepare for that by creating a session object and add the header attribute to it. From now on, all requests in this session will automatically send the auth token.
\n# Inspect response\nprint('Response code: ' + str(response))\nif response.ok:\n bardioc_user_token = response.json()['_TOKEN']\n s = requests.Session()\n s.headers.update({'Authorization': 'Bearer ' + bardioc_user_token})\n print ('You have successfully created a Bardioc access token and can start using the Bardioc API.')\nelse:\n print ('Authentication error: '+ str(response.status_code) + ' - ' + response.reason)\n print ('Error message: ' + response.text)\n print ('Please check your credentials and try again.')The console output should look like this:
\nAuthenticating with Bardioc Auth Service to receive an auth token ...\nResponse code: <Response [200]>\nYou have successfully created a Bardioc access token and can start using the Bardioc API.If everything went well, we have a valid authentication token, created an HTTPS session, and are ready to work with the Bardioc API. If not, there was probably something wrong with your credentials. Go back, check the credentials, and retry.
\nBefore we continue, let’s refactor the authentication code, so that it will be reusable for further examples. We define a function for session initiation, which takes the file name of the credentials file as input parameter. The returned session object will contain the HTTPS session, the Bardioc URLs and the scope.
\n# Define authentication function\ndef initiate_bardioc_session(credentials_file_name):\n with open(credentials_file_name) as json_file:\n bardioc_credentials = json.load(json_file)\n bardioc_session_context = dict()\n bardioc_api_base = bardioc_credentials['api_url']\n bardioc_session_context['scope'] = bardioc_credentials['scope']\n bardioc_session_context['auth_api'] = bardioc_api_base + 'auth/6/'\n bardioc_session_context['graph_api'] = bardioc_api_base + 'graph/7/'\n\n # authenticate\n print('Authenticating with Bardioc Auth Service to receive an auth token ...')\n auth_data = {'client_id': bardioc_credentials['client_id'], 'client_secret': bardioc_credentials['client_secret'],\n 'username': bardioc_credentials['username'], 'password': bardioc_credentials['password']}\n bardioc_auth_api = str(bardioc_session_context['auth_api'])\n print(bardioc_auth_api)\n response = requests.post(bardioc_auth_api + 'app', data=json.dumps(auth_data))\n\n print('Response code: ' + str(response))\n if response.ok:\n print('You have successfully created a Bardioc access token and can start using the Bardioc API.')\n bardioc_user_token = response.json()['_TOKEN']\n bardioc_session_context['session'] = requests.Session()\n bardioc_session_context['session'].headers.update({'Authorization': 'Bearer ' + bardioc_user_token})\n bardioc_session_context['active'] = True\n else:\n print('Authentication error: ' + str(response.status_code) + ' - ' + response.reason)\n print('Error message: ' + response.text)\n print('Please check your credentials and try again.')\n bardioc_session_context['active'] = False\n\n return bardioc_session_context\n\n\nbardioc_session = initiate_bardioc_session('./bardioc_credentials.json')\nif bardioc_session['active'] == True:\n print('continue using the API ...')With this active Bardioc session, we can now work with the Bardioc API. As an example, we will try to submit a simple query to the Bardioc Graph.
\nThe Bardioc Graph supports different query modes. We use the vertices query mode to search for items of type ogit/Automation/AutomationIssue. Don’t worry, we will explain this data type later in details.
\nAs you may have noticed, we need to escape a few special characters in the query string before sending it as URL query parameter.
\nvertex_query_url = bardioc_session['graph_api'] + 'query/vertices?query='\nquery_string = '+ogit/_type:ogit/Automation/AutomationIssue AND ogit/_scope:'+bardioc_session['scope']\nescaped_query_string = query_string\\\n .replace('/', '%5C%2F')\\\n .replace(' ', '%20')\\\n .replace('\\\\', '%5C')\\\n .replace(':','%3A')\\\n .replace( '+', '%2B')\n\nquery_response = bardioc_session['session'].get(vertex_query_url + escaped_query_string)\nprint(query_response)\npp.pprint(query_response.json())This query has either returned a list of AutomationIssue vertices - if you already have some in your Bardioc instance - or alternatively an empty list. In case your Graph is still empty: we will soon learn how to populate it with data.
\nThe result data might look like this:
\n{\n \"items\": [\n {\n \"/DatePrintOutput\": \"2020-08-18 13:23:30\",\n \"ogit/Automation/deployStatus\": \"deployed\",\n \"ogit/Automation/issueType\": \"unknown\",\n \"ogit/Automation/originNode\": \"ckd73u0ul04jo01100j5dppq7_ckdzyc2kftth40126ws47ktio\",\n \"ogit/Automation/processingTimestamp\": \"1597757010332\",\n \"ogit/_created-on\": 1597757000390,\n \"ogit/_creator\": \"cjy5tvdfx0nkq1o7040e4mow0_cjl7za8hs3csfl1756lo90sen\",\n \"ogit/_creator-app\": \"cju16o7cg0001mz775fnoq66i_cjix82rxi000gu473w5kvkpqv\",\n \"ogit/_graphtype\": \"vertex\",\n \"ogit/_id\": \"ckd73u0ul04jo01100j5dppq7_ckdzz9jnqxrya0185e1e4zijb\",\n \"ogit/_is-deleted\": false,\n \"ogit/_modified-by\": \"cjy5tvdfx0nkq1o7040e4mow0_ckd73u30p04k00110vtx04pgg\",\n \"ogit/_modified-by-app\": \"cju16o7cf0000mz77pbwbhl3q_cjix82tev000ou473gko8jgey\",\n \"ogit/_modified-on\": 1597757011631,\n \"ogit/_organization\": \"cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nku1o70n01y50gw\",\n \"ogit/_owner\": \"cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nks1o70ouhlsk6a\",\n \"ogit/_scope\": \"cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7\",\n \"ogit/_type\": \"ogit/Automation/AutomationIssue\",\n \"ogit/_v\": 4,\n \"ogit/_v-id\": \"1597757011631-SwG5pa\",\n \"ogit/status\": \"RESOLVED\",\n \"ogit/subject\": \"Test\"\n },\n {\n \"/ProcessIssue\": \"todo\",\n \"ogit/Automation/deployStatus\": \"ExecIdle threshold (900) exceeded: more knowledge required?\",\n \"ogit/Automation/issueType\": \"unknown\",\n \"ogit/Automation/originNode\": \"ckd73u0ul04jo01100j5dppq7_ckdzyc2kftth40126ws47ktio\",\n \"ogit/Automation/processingTimestamp\": \"1597756624025\",\n \"ogit/_created-on\": 1597755613445,\n \"ogit/_creator\": \"cjy5tvdfx0nkq1o7040e4mow0_cjl7za8hs3csfl1756lo90sen\",\n \"ogit/_creator-app\": \"cju16o7cg0001mz775fnoq66i_cjix82rxi000gu473w5kvkpqv\",\n \"ogit/_graphtype\": \"vertex\",\n \"ogit/_id\": \"ckd73u0ul04jo01100j5dppq7_ckdzyfthhtuci01263h47hpo9\",\n \"ogit/_is-deleted\": false,\n \"ogit/_modified-by\": \"cjy5tvdfx0nkq1o7040e4mow0_ckd73u30p04k00110vtx04pgg\",\n \"ogit/_modified-by-app\": \"cju16o7cf0000mz77pbwbhl3q_cjix82tev000ou473gko8jgey\",\n \"ogit/_modified-on\": 1597756624107,\n \"ogit/_organization\": \"cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nku1o70n01y50gw\",\n \"ogit/_owner\": \"cjy5tvdfx0nkq1o7040e4mow0_cjy5tvdfx0nks1o70ouhlsk6a\",\n \"ogit/_scope\": \"cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7\",\n \"ogit/_type\": \"ogit/Automation/AutomationIssue\",\n \"ogit/_v\": 5,\n \"ogit/_v-id\": \"1597756624107-zXxQk6\",\n \"ogit/status\": \"STOPPED\",\n \"ogit/subject\": \"Test\"\n }\n ]\n}or an empty list:
\n{\n \"items\": []\n}Congratulations! You have successfully connected to Bardioc and run the first query against the graph database.
\nIn this tutorial, we have prepared the prerequisites to work with the Bardioc API, authenticated with the Auth API, and then used the auth token to submit a query to the Bardioc Graph.
\nIn the next tutorial, we will learn how to Write and read data to the Bardioc Graph.
\nIn this tutorial, we will show how to write a simple connector for Bardioc. We have picked Google Calendar as example application. The connector we develop in this tutorial will read events from a calendar and copy them to the Bardioc knowledge core. To keep the connector simple, we will copy the events only in one direction. Synchronization of data will be covered by another tutorial.
\nThe code examples are written in Python, but the Bardioc API can be used with any other programming language, as well.
\n![\"google](\"/7.0/images/tutorials/google_connector_architecture.png\")
\nWe will perform the following steps to implement the connector:
\nPrepare prerequisites in Google Calendar / Google Cloud
\nConnect with Bardioc
\nFetch events from Google Calendar
\nWrite retrieved events to Bardioc
\nSynchronization: only write new or updated events
\nCreate a loop to continuously poll events
\nWe want to use the Google API to read data from a Google calendar. In order to do this, we need user and application credentials, similiar to the Bardioc API. The required steps are:\n. Create a google cloud account\n. Create a new project\n. Create Service Account credentials new app/project
\nIf you already have the required accounts and credentials, you may skip to the next section. Otherwise, continue to read the step-by-step\ninstructions.
\nCreate a google cloud account
\nGo to https://cloud.google.com/ and sign in. If you don’t have a Google Cloud account, you have to register first.
\nCreate a new project
\nIn the Google Cloud Platform, users, credentials, and permissions are organized in projects. We will create a new project \"Bardioc-Connector\" in the Google Cloud.
\nProceed to the Google Cloud console: https://console.cloud.google.com/ , and click on the project drop-down box on top. Click on \"NEW PROJECT\" to create a new project. Now enter the name of your new project: \"Bardioc-Connector\".
\n![\"GCP](\"/7.0/images/tutorials/GCP-project-selection.png\")
\n![\"GCP](\"/7.0/images/tutorials/GCP-new-project.png\")
\nYou have created a new Google Cloud project. As next steps, we will create an API key for our application, and a service account.
\nCreate Service Account credentials new app/project
\nFrom the Google Cloud Console home screen, select \"Credentials\" from the \"API & Services menu\". Click on \"create credentials\", and then \"Create service account\".
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-1.png\")
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-2.png\")
\nWe enter a new service account name, which we call \"bardioc-connector\" and press create. On the next screen select the role as editor and click continue. On the last screen click done.
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-3.png\")
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-3-1.PNG\")
\nOn the service account page, click on the button next to key creation date and press create key.
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-3-2.PNG\")
\nThe key type should be JSON. Press the \"Create\" button, and you’ll be prompted to save the credentials file to disk. This file contains all necessary credentials data to connect to the API.
\n![\"GCP](\"/7.0/images/tutorials/GCP-create-credentials-4.png\")
\nTo grant calendar permissions to this service account, you will need the account’s email address later. Look it up in the GCP console while you are still there. It should look like this: bardioc-connector@bardioc-connector-123456.iam.gserviceaccount.com
\nWe will now create a new Google calendar to work with. You may of course also work with an existing calendar, if you prefer.
\nCreate a new Google calendar\nGo to Google Calendar (https://calendar.google.com/) and create a new calendar (\"Other calendars\" -→ \"+\" -→ \"Create new calendar\". Enter \"Bardioc-TEST\" as name.
\n![\"new](\"/7.0/images/tutorials/new-google-calendar.png\")
\nNext. we enter the calendar setting for the \"Bardioc-TEST\" calendar. We share our calendar with the service account bardioc-connector@bardioc-connector-123456.iam.gserviceaccount.com and provide it edit permissions.
\n![\"share](\"/7.0/images/tutorials/share-google-calendar.png\")
\nCopy the calendar ID from the settings page - you will need this later to access the calendar through the API.
\nEnable Calendar API for the new project (in Google Developer Console)
\nThere is one last step that we have to perform: enable the Calendar API for your new project. We do this in the Google Developer Console: https://console.developers.google.com/
\nSelect the \"Bardioc Connector\" project, and click on \"+ ENABLE APIS AND SERVICES\". Select \"Google Calendar API\", and enable it on the next screen. Your are ready now to connect via API to your calendar.
\n![\"enable](\"/7.0/images/tutorials/enable-calendar-api.png\")
\nYou will need two Python libraries for the Google API. In case you do not have them in your environment yet, install them with the pip command.
\nGoogle Oauth client:
\npip install google-authGoogle Python client library:
\npip install google-api-python-clientFinally, we initiate a Bardioc session, as seen in the First Steps with Bardioc tutorial:
\n# Initiate session\nbardioc_session = initiate_bardioc_session('./bardioc_credentials.json')We will also need the functions create_vertex, update_vertex and create_edge, which we have defined in the Basic Vertex Operations tutorial.
\nBefore we can read and write data via the Google API, we need to authenticate and create a session with the intended usage scope.\nWe load the service account credentials, which we had downloaded from the Google Cloud Platform Console before (see above), set the scope to 'https://www.googleapis.com/auth/calendar', and create an authenticated session.
\n# google api imports\nfrom google.oauth2 import service_account\nfrom google.auth.transport.requests import AuthorizedSession\nfrom googleapiclient.discovery import build\n\n# configuration\ngoogle_credentials_file = \"./forward-aura-168008-92a0f1f9cd3a.json\" #replace with your credentials file!\ngoogle_calendar_id = '7hfea2godbmajrspfp30l23q1o@group.calendar.google.com' #replace with the id of your calendar!\n\n# load credentials and authorize session\ncredentials = service_account.Credentials.from_service_account_file(google_credentials_file)\nscoped_credentials = credentials.with_scopes(['https://www.googleapis.com/auth/calendar'])\nauthed_session = AuthorizedSession(scoped_credentials)Once we are authenticated and have created a session with the Google API, we can instantiate a specific service for the Calendar API:
\n# Build Calendar API Service\nservice = build('calendar', 'v3', credentials=scoped_credentials)As next step, we will check that we can read calendar data through the Google API, to verify that we got everything in place correctly. As a test, we print out the calendar name to the console, and retrieve all calendar events.
\n# get calendar name\ncalendar = service.calendars().get(calendarId=google_calendar_id).execute()\nprint ('Calendar name: ' + calendar['summary']+ '\\n')\n\nprint('Getting all events')\nevents_result = service.events().list(calendarId=google_calendar_id, singleEvents=True, orderBy='startTime').execute()\nevents = events_result.get('items', [])\n\nif not events:\n print('No upcoming events found.')\nfor event in events:\n start = event['start'].get('dateTime', event['start'].get('date'))\n print(start, event['summary'])We have read data from Google Calendar and printed it out to the console. We are ready for the final step: writing the calendar data to Bardioc.
\nFor writing calendar data to Bardioc, we define two helper functions. The first function write_calendar() creates a node in the Bardioc Graph, which represents the specific calendar. We add the calendar id as _xid and calendar name as title attribute, so that we know which calendar it is.
\nThe second helper function write_event() creates a vertex of type ogit/Schedule/Event in Bardioc for the calendar event from Google. In this example, we write the event id, title, start and end time, description, location, and etag as attributes. You might want to extend this with additional attributes in the future. The new event vertex is connected with a ogit:contains edge to the calendar vertex.
\ndef create_calendar (calendar):\n vertex_data = {'ogit/title':calendar['summary'],\n 'ogit/_xid': 'CAL-' + calendar['id'],\n '/etag': calendar['etag']\n }\n\n return create_vertex('ogit/Schedule/Calendar', vertex_data)\n\ndef create_event (cal_id, event):\n\n vertex_data = {'ogit/title':event['summary'],\n 'ogit/Schedule/startTime': event['start'].get('dateTime', event['start'].get('date', '')),\n 'ogit/Schedule/endTime': event['end'].get('dateTime', event['end'].get('date','')),\n 'ogit/_xid': 'CAL-' + cal_id + '-' + event['id'],\n '/etag': event['etag']\n }\n\n if 'description' in event:\n vertex_data['ogit/description'] = event['description']\n if 'location' in event:\n vertex_data['ogit/Schedule/location'] = event['location']\n\n vertex_id = create_vertex('ogit/Schedule/Event', vertex_data)\n create_edge(cal_id, vertex_id, 'ogit:contains')\n\n return vertex_idNow we can retrieve the calendar data from Google again, and write the entries to Bardioc. We will first create a calendar item in Bardioc. Afterwards, we iterate over all calendar events, copy each event to Bardioc, and connect it to the calendar vertex.
\n# get calendar name\ncalendar = service.calendars().get(calendarId=google_calendar_id).execute()\n\n# create calendar vertex in Bardioc\nbardioc_cal_id = create_calendar(calendar)\n\n# retrieve all events from Google calendar\nevents_result = service.events().list(calendarId=google_calendar_id, singleEvents=True, orderBy='startTime').execute()\nevents = events_result.get('items', [])\n\nfor event in events:\n bardioc_event_id = create_event (bardioc_cal_id, event)If you check now, you will find your calendar and all events in the Bardioc Graph.
\nOf course, we don’t want to create new data objects every time we check the Google calendar, but we want to update the data in Bardioc when there are changes or new events in the Google calendar. Therefore, we need to first check whether there are already nodes in Bardioc for the calendar or event; and if they exist, we want to know whether there have been any changes that need to be updated.
\nBardioc offers a special 'ogit/_xid' attribute, which should be used to specify the external id that the item has in the original data source. If you write for instance the Google event id to this field, you will be able to check whether a specific event is already stored in Bardioc or not. There is also a convenience method in the Graph API that facilitates looking up vetices by external id.
\nExternal ids are supposed to be unique in the Bardioc database. Therefore, we do not just use the calendar or event ids in our example, but add a prefix, so that we reduce the probability of id conflicts. This is a good practice that you might want to adopt already in your first connector.
\nGoogle has introduced a nice feature for determining whether a data object has changed: there is an etag attribute, which is assigned a new random value when the object is changed. As we have already copied this attribute to the Bardioc vertices before, we can simply check whether the etag has changed. Thanks Google!
\nWe define helper methods to check whether the calendar and events already exist and whether there are changes:
\ndef update_calendar (vertex_id, calendar):\n vertex_data = {'ogit/title': calendar['summary'],\n 'ogit/description': calendar['description'],\n '/etag': calendar['etag']\n }\n\n return update_vertex(vertex_id, vertex_data)\n\ndef read_vertex_by_xid (xid):\n response = bardioc_session['session'].get(bardioc_session['graph_api'] + 'xid/' + xid )\n\n if response.ok:\n if len(response.json()['items'])==1:\n return response.json()['items'][0]\n else:\n print (str(response.status_code) + \" - \" + response.text)\n print ('Failed to read vertex.')\n return None\n\ndef create_or_update_calendar (calendar):\n xid = 'CAL-' + calendar['id']\n etag = calendar['etag']\n\n cal_vertex = read_vertex_by_xid (xid)\n\n if cal_vertex == None:\n return create_calendar (calendar)\n else:\n print (cal_vertex)\n bardioc_etag = cal_vertex.get('/etag', '')\n vertex_id = cal_vertex ['ogit/_id']\n if etag != bardioc_etag:\n update_calendar (vertex_id, calendar)\n return vertex_id\n\n\ndef update_event (vertex_id, cal_id, event):\n vertex_data = {'ogit/title':event['summary'],\n 'ogit/Schedule/startTime': event['start'].get('dateTime', event['start'].get('date', '')),\n 'ogit/Schedule/endTime': event['end'].get('dateTime', event['end'].get('date','')),\n '/etag': event['etag']\n }\n\n if 'description' in event:\n vertex_data['ogit/description'] = event['description']\n if 'location' in event:\n vertex_data['ogit/Schedule/location'] = event['location']\n\n return update_vertex(vertex_id, vertex_data)\n\n\ndef create_or_update_event (cal_id, event):\n xid = 'CAL-' + cal_id + '-' + event['id']\n etag = event['etag']\n\n event_vertex = read_vertex_by_xid (xid)\n\n if event_vertex == None:\n create_event (cal_id, event)\n else:\n bardioc_etag = event_vertex.get('/etag', '')\n vertex_id = event_vertex ['ogit/_id']\n if etag != bardioc_etag:\n update_event (vertex_id, cal_id, event)And now we can adapt our synchronization routine to utilize the new methods:
\nimport time\n\n# get calendar name\ncalendar = service.calendars().get(calendarId=google_calendar_id).execute()\n\n# create calendar vertex in Bardioc\nbardioc_cal_id = create_or_update_calendar(calendar)\n\n#endless loop\nwhile True:\n # retrieve all events from Google calendar\n events_result = service.events().list(calendarId=google_calendar_id, singleEvents=True, orderBy='startTime').execute()\n events = events_result.get('items', [])\n for event in events:\n bardioc_event_id = create_or_update_event (bardioc_cal_id, event)\n\n time.sleep(60)Try it out by adding new events and changing events in your Google calendar. Within the endless loop, the connector code checks once per minute for new or changed data. Only new or changed events will be written to the Bardioc Graph.
\n{\n \"/etag\" : \"3130664879208000\",\n \"ogit/Schedule/endTime\" : \"2019-08-09T10:30:00+02:00\",\n \"ogit/Schedule/location\" : \"somewhere else\",\n \"ogit/Schedule/startTime\" : \"2019-08-09T10:00:00+02:00\",\n \"ogit/_created-on\" : \"Fri, 09 Aug 2019 06:31:28 GMT\",\n \"ogit/_creator\" : \"user1@academy.local\",\n \"ogit/_creator-app\" : \"cjix82rxi000gu473w5kvkpqv\",\n \"ogit/_graphtype\" : \"vertex\",\n \"ogit/_id\" : \"cjz3qffjoci6bgp027kuzwx5g\",\n \"ogit/_is-deleted\" : \"false\",\n \"ogit/_modified-by\" : \"user1@academy.local\",\n \"ogit/_modified-by-app\" : \"cjix82rxi000gu473w5kvkpqv\",\n \"ogit/_modified-on\" : \"Fri, 09 Aug 2019 06:34:30 GMT\",\n \"ogit/_owner\" : \"academy.local\",\n \"ogit/_type\" : \"ogit/Schedule/Event\",\n \"ogit/_v\" : \"3\",\n \"ogit/_v-id\" : \"1565332470438-Swxvdw\",\n \"ogit/_xid\" : \"CAL-cjz1frals2bn2gp02iq46j9ex,-57f7qq54o0hf25sr3jcereti4b\",\n \"ogit/title\" : \"TEST\"\n}In this tutorial, we have implemented our first Bardioc connector.The connector imports calendar events from a Google calendar into the Bardioc Graph.
\nWe have performed the following steps for implementing this connector:
\nCreated a new project and a service account in Google Cloud Platform
\nCreated a new Google Calendar and configured permissions
\nEstablished an authenticated session with Bardioc
\nFetched events from Google Calendar
\nWritten retrieved calendar events to Bardioc
\nCreate a loop to continuously poll events and write changes to Bardioc
\nAs you probably have noticed, we have copied only a subset of the calendar event attributes to Bardioc. You may extend the code to make more attributes available.
\nNow that you have calendar data in Bardioc, you can automate some tasks to manage your calendar. If you haven’t read the tutorial about creating automation tasks yet, we suggest to continue there.
\nThe Action API has been introduced to separate the deployment of action handlers from the Bardioc™ Engine. The new Action API uses the graph as a \"broker\"\nbetween the Engine and action handlers and all the connections are now outbound (from customer network perspective) to the Bardioc SaaS system. This enables customers to deploy\nAction Handlers on premises and make an outbound connection to the Action API without opening an inbound port.
\nAlso, the action data is persisted in the SaaS infrastructure, so crashes or interruptions of network connectivity should not result in failed or repeated execution of the same\ncommand.
\nSystem Architecture
\n![\"actionhandler](\"/7.0/images/documentation/actionhandler_generic_overview.png\")
\nAn Action Handler is a separate component that has the capability to perform actions on the customer’s target systems. Depending on the requirements and the type of Action Handler, it can now be\neither deployed on the Bardioc™ SaaS platform itself or on the premises of the customer.
\nA capability describes a specific type of action (e.g. \"ExecuteCommand\") and the\nmandatory and optional parameters (e.g. \"Command\", \"Timeout\" or \"Host\").\nCapabilities are meant to be defined globally and should be considered as kind of a\n\"feature contract\" between Knowledge Item writers and Action Handler implementations. The\nsemantics of a capability and its parameters should be the same across all installations\nso that KIs making use of Action Handlers will continue to work even though underlying\nimplementations of the handlers might be completely different.
\nAn applicability binds a global capability to a specific Action Handler instance running\nalongside a single engine. It can optionally supply additional parameters to the actual\nhandler implementation not part of the capability definition but these will not be visible\nor directly accessible to KI writers. The applicability can limit the scope on which\nvertices this specific handler-binding will be available.
\nFor example an applicability could specify that an SSH based Action Handler provides the\ncapability ExecuteCommand but only on linux machines (represented in the environment model\nas vertices of the type ogit/MARS/Machine with a machineClass attribute \"Linux\")\nwhich have a \"SSHKeyID\" attribute as well. The SSHKeyID\nwould then be added to the parameter set sent to the action handler implicitly without\nKI writers needing to care about that.
\nStarting with version 2.3.0 the reference implementation of the Bardioc ActionHandler will support asymmetric\ncryptography for secure transportation of sensitive information through the platform. Authors of external\nActionHandlers are strongly encouraged to add support for this functionality as well.
\nIn order to support arbitrary lengths of data, S/MIME has been selected as the data format.
\nEncrypting capabilities should support the parameter \"EncryptionKey\" that specifies the logical name of the public\nkey to be used for encryption (translates to a locally stored filename atm, will be moved to Graph Key API when released).
\nThe command used to encrypt data in the reference implementation (it is advisable to store VALUE as explicit environment\nvariable before to avoid escaping problems, CERT_FILE should point to the S/MIME Certificate file specified by the\nEncryptionKey parameter):
\nprintf -- \"$VALUE\" | openssl smime -encrypt -aes256 -outform DER $CERT_FILE | base64 -w0ALL actionhandlers should automatically detect encrypted values contained within their input parameters and try to decrypt\nthese if the corresponding private key is available. The format of the encrypted data in the input parameters is
\n{{BardiocCRYPT/$KEYNAME:$PAYLOAD}}The command used to decrypt the PAYLOAD data in the reference implementation with KEYFILE name derived from KEYNAME:
\necho \"$PAYLOAD\" | base64 -d | openssl smime -decrypt -inform DER -inkey $KEYFILEThe Action Handler application can request the list of registered capabilities\nwith their parameter list from the global registry.
\nResponse Example
\n{\n \"ExecuteCommand\": {\n \"description\": \"this one executes commands\",\n \"mandatoryParameters\": {\n \"command\": {\n \"description\": \"command to execute\"\n },\n \"host\": {\n \"description\": \"hostname to execute command on\"\n }\n },\n \"optionalParameters\": {\n \"timeout\": {\n \"description\": \"timeout in seconds\",\n \"default\": \"120\"\n }\n }\n }\n}Application can request the list of registered applicabilities with their parameter list.
\n{\n \"HandlerID1\": {\n \"ExecuteCommand\": {\n \"on ogit/machineClass == \\\"linux\\\" ssh_keyfile ssh_options\": {\n \"ssh_keyfile\": \"${ssh_keyfile}\",\n \"ssh_options\": \"${ssh_options}\"\n },\n \"on ogit/machineClass == \\\"linux\\\" ssh_keyfile not ssh_options\": {\n \"ssh_keyfile\": \"${ssh_keyfile}\",\n \"ssh_options\": \"some default options here\"\n }\n },\n \"ParameterlessExecute\": [\n \"on ogit/machineClass == \\\"windows\\\"\"\n ]\n }\n}The websocket is a full duplex TCP connection which allows for the bi-directional communication between the Graph and the Action Handler. Below is the sequence of actions that take place from the engine → graph → the action handler.
\nURL: wss://core.almato.com/api/action-ws/1.0/
\nSubProtocol: action-1.0.0
Sample websocket connection request:
\nvar ws = new WebSocket('wss://core.almato.com/api/action-ws/1.0/', ['action-1.0.0', 'token-' + '$token'])![\"invocation](\"/7.0/images/documentation/invocation_sequence.png\")
\nPayload of messages that go from engine via action api to action handler and back are json encoded strings. All messages must have type argument plus additional arguments specific to that message type.\nOn top of that, all messages except hello also contain id argument. That one represents request id and is used for idempotency. Due to the distributed nature of the system, action api\nimplements sending \"at least once\" strategy, meaning that it might send the same message multiple times but action handler should check if that message id has already been processed or not and act accordingly.
Message types that are in use are:
\nhello
\nsubmitAction
\nsendActionResult
\nacknowledged
\nnegativeAcknowledged
\nOnce connection is successfully established, action handler will receive hello message from action api:
\n[WsConnection] Received hello message: %{\\\"client_id\\\" => \\\"cloei2yl2h1h4018358ez5g33_cm4ckvw679n5v0193cxogsqwj\\\", \\\"host\\\" => \\\"bardioc-graph-actionapi-774f985cc7-f48bl\\\", \\\"server_version\\\" => \\\"0.1.0\\\", \\\"type\\\" => \\\"hello\\\"}\",\"metadata\":{}}\nThe structure of hello message is:
\n{\n \"type\": \"hello\",\n \"host\": \"action api node that accepted connection\",\n \"server_version\": \"application version of the action api node\",\n \"client_id\": \"id of the client in the graph\"\n}Arguments in this message are of informational nature only.
\nAction API will send ws ping (not binary) message to connected clients and expects pong message back. If pong message is missing after 3 pings,\naction api will disconnect the client assuming that connection is hanging. Thus, clients should be ready to handle dropped connections and to reconnect.
\nThe same is advised for the clients. They should also send ws ping messages to the action api and reconnect if pong is missing couple of times repeatedly.
\nOn the successful execution of a KI which requires an action handler, the engine sends a submitAction message to the graph who in turn invokes the action handler and sends the message to it.
\nEngine → Graph → Action Handler
\nThe sample structure of the message sent by the graph to the action handler is as follows:
\n{\n \"type\": \"submitAction\",\n \"id\": \"the $requestId in App->Graph, the $appId:$requestId in Graph->AH\",\n \"handler\": \"handlerId\",\n \"capability\": \"capabilityName\",\n \"timeout\": 300000,\n \"parameters\": {\n \"parametername1\": \"parametervalue1\",\n \"parametername2\": \"parametervalue2\"\n }\n}All fields are mandatory but content of the \"parameters\" map is specific to the handler\nand may contain anything. timeout field is in milliseconds and handler field is not sent to the action handler.
Action API will send the same request each couple of seconds even if action handler acknowledged that request. In such situation, action handler should not execute action again\nbut it still has to acknowledge message.
\nThis behaviour is useful if during action execution action handler is restarted. If it doesn’t have a way to persist ongoing executions, it can rely that action api will resend request that it didn’t receive response for.
\nOnce the action handler is done executing the action it sends back a response to the graph which in turn is sent to the engine by the graph for further processing.
\nAction Handler → Graph → Engine
\nThe sample structure of the message sent by the action handler to the graph is as follows:
\n{\n \"type\": \"sendActionResult\",\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\",\n \"result\": {\n \"resultfield1\": \"resultvalue1\",\n \"resultfield2\": \"resultvalue2\"\n }\n}Again, the content of the result is specific to the handler and may have any content mapped to it.
\nIt is highly recommended though that result includes action_status which is non-negative number and action_error as nil or string describing why action execution didn’t succeed.\nIf action was executed and is returning result of the execution, action_status should be 0. This status shouldn’t be confused with execution status/code though.\nIt is ok to have http request that returns 500 status code for example, but action_status should still be 0 because response is the result of execution … whatever it is.\nThe same situation is for execution of the scripts or commands on a remote machine. action_status is not representation of exit code!
action_status can be used in the KI for debugging or adding some additional logic for the execution or retry.
Action handler should keep sending response to the action api until it gets acknowledged message back.
\n0: \"action executed\"
\n11: \"Action API didn’t ack request\"\n12: \"Action API didn’t respond\"\n13: \"ActionHandler didn’t respond. Last status in Action API was #{inspect(last_status)}\"\n14: \"ActionHandler responded with execution timeout\"
\n51: \"AH configuration problem (proxy misconfigured?)\"\n52: \"Request doesn’t match AH config (wrong cert requested?)\"\n53: \"Error preparing request in AH (ah can’t build request with provided args)\"\n54: \"Execution failed/crashed or there was an error with processing response\"
\n666: \"Unexpected error\"
\nThis is the acknowledgement sent to confirm to the sender that the message has been received in any of the following cases:
Sent back from graph once request has been persisted
Sent back from handler once request has been received
Sent back from graph once result has been persisted
Sent back from engine once result has been received
The structure of an ack message is:
\n{\n \"type\": \"acknowledged\",\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\"\n}This is the message sent to confirm to the sender that the message has not been received in any of the following cases:
Sent back from graph when request could not be persisted
Sent back from handler when request can not be handled
Sent back from graph when result could not be persisted
Sent back from engine when result can not be processed
The structure of an nack message is:
\n{\n \"type\": \"negativeAcknowledged\",\n \"id\": \"the $appId:$requestId in AH->Graph, the $requestId in Graph->App\",\n \"code\": \" the error_code \",\n \"message\": \"error description why request was nack'ed\"\n}code 404 should be returned from the action handler if it doesn’t support requested capability
This document will give you an overview about the Bardioc Graph, the\ngoverning concepts and the developer API.
\nAll requests(except authenticate) must contain a valid access token. Request a valid access token using /auth/ api.
All requests will be made against a base $url (e.g. https://core.test.engine.datagroup.de/api/).
\nMost of responses are in JSON (to see exception see specific api specs)
\nJSON response format: set header Accept to application/json
JSON request format (for requests with body): set header Content-Type to application/json
All requests payload unless defined differently in api specification must be utf-8 encoded string.
\nYou can access the Bardioc REST API browser on your Bardioc instance: https://core.test.engine.datagroup.de/help/specs/?url=definitions/graph.yaml.
Bardioc Graph uses standard HTTP error codes. Please refer to https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
\nThere might be different error codes, depending on which reverse proxy is configured to be in front of Bardioc Graph, please refer to the reverse proxy product documentation you are using.
\nError codes with special meaning for Bardioc Graph:
\n| Error Code | \nDescription | \nExplanation | \n
|---|---|---|
400 | \nBad Request | \nplease review request against api documentation | \n
401 | \nToken invalid, expired or missing | \nmake sure you use a valid token; get a new token | \n
403 | \nAccess denied | \naccess to resource is not granted by current set of policies | \n
404 | \nNot Found | \nsomething does not exist | \n
408 | \nInternal request timeout | \nrequest took too long; limit request or response size | \n
409 | \nConflict | \ne.g. if you try to create an already existing vertex | \n
500 | \nInternal Error | \ngeneric error, please contact us at support@bardioc.almato.com | \n
503 | \nService temporary unavailable | \ntry again later | \n
888 | \nTransaction failure / Upstream error | \nif two transactions collide, Bardioc Graph cannot decide what to do with the failed transaction. Check the condition of the items in the request and retry if still possible | \n
Because everything may fail (software, middleware, network, …) clients working against the Bardioc Graph API are expected to retry failed requests. The expectation, that all requests succeed in the age of the internet is wrong and unrealistic.
\nA good measure for when to retry is:
\nif (response.getStatusCode() > 499) {\n retryTheSameRequest();\n}All status code in the 4xx range require, that the client fixes something. Be that request format (400), new access token (401) etc pp. The request can e.g. be retried when a new token has been obtained.
\nBardioc Graph is a semantic graph processing platform.
\nBardioc Graph contains Entities (things) with Attributes (properties), Verbs (connections) as well as\nother data like Timeseries or BLOBs.\nThe semantic part is described here https://github.com/almato/OGIT.
\n| \n\n | \n\nOne must never depend on the format of the ID that Bardioc Graph generates.\n | \n
All type ids (attribute ids, entity ids, verb ids) in Bardioc Graph are namespaced.
\nTo ensure consistency and avoid ambiguity, these have a mandatory prefix http://www.purl.org/.\nEverything after this prefix is the shortened id, that will be by the graph, e.g. ogit/_id derives from http://www.purl.org/ogit/_id. (see http://www.purl.org/docs/index.html for further info). Replace \"/\" in \"_id\" with \"%2F\".
Attributes, that are not defined in OGIT have an empty namespace, e.g.: /IssueXML.
Free attributes have to begin with \"/\", e.g. \"/environmentType\": \"PROD\",.
\nFree attributes containing dot \".\" are not allowed.
\nAll attribute values must be of type string.
\nAll attributes are indexed with the keyword analyzer, so wildcards and submatches cannot be used on them, they are also case-sensitive.
\nSystem attributes start with ogit/_.
Changes to system attributes apart of described below are not allowed.
\nogit/_xid is an external ID which could be set on vertex creation used to map to an external system. Setting this id in a local cache will throw a 409 if another entity has the same ogit/_xid. Nevertheless multiple entities with the same ogit/_xid may exist at the same time if data is created with sync.
ogit/_content when written is indexed with the standard analyzer. It is also indexed with an ngram analyzer. a text like \"a sample text of things\" can be queried like ogit/_content:sample to find words in it, or ogit/_content.ngram:amp to find ngrams in it. This field is allowed for all entities and can be filled automatically by setting the indexed: property in the entity definition.
ogit/_content is the sum of all attribute values that are specified in OGIT under ogit:indexed-attributes in OGIT. e.g. https://github.com/almato/OGIT/blob/master/NTO/Automation/entities/MARSNode.ttl#L131
ogit/_tags when written is indexed as a list of keywords. The format when writing is \"some, tag, with spaces\" and internally is indexed as [\"some\", \"tag\", \"with spaces\"]. It can be searched like ogit/_tags:some to find full tags in the list. This field is allowed for all entities.
ogit/_owner could be set to team id to allow sharing data by policies. if not set in request default team from account profile (in case not set default for organization) would be used
ogit/_scope could be set on vertex creation to put vertex in specific data scope, if not default from context would be used
The length of attribute values must not exceed 60kB. If they are larger than 60kB, they will not be indexed. The following attributes can have an arbitrary content length, but can not be used to match in queries:
\nogit/message
ogit/content
ogit/description
ogit/comment
ogit/licenseKey
ogit/question
ogit/response
ogit/reason
ogit/serviceContract
ogit/taskLog
ogit/value
ogit/values
Free attributes can have any length but cannot be used in queries if over 60kB.
\nLimitations on data size (trying to create or update data bigger than allowed would end up with 400 error). For performance reasons it is recommended to build applications in the way that single data piece is not bigger than 1MB.
\nissue/task in engine - 1MB
\nvertex - 10MB
\ntimeseries value - 100MB
\nBLOB content - 100MB
\napi request payload 100MB
\nStream responses are used to transfer possibly bigger amount of data pieces like query or timeseries values response. each item it send from server separately and could be parsed by json streaming. e. g. {\"items\":[{$data1},{$data2},…,{\"error\":{\"code\":408,\"messge\":\"internal request timeout\"}}]}. Note: client shall check if data piece contain `\"error\"`and handle it (after \"error\" no more data would be send)
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
\nOAUTH2 compatible token flow \"/token\"
\ntimeseries values order and aggregation
\nquery for multiple timeseries values
\nallow to create immutable vertices with 'ogit/isPermanent'
\nblob flag in OGIT to support attachments on different vertices types
\ntimeseries write with ttl
\n\"/me/\" calls moved to auth api
\n\"logs\" calls
\nattachments versioning
\nimmutable timeseries
\n\"/_api/\" replaced with \"/api/version\"
\n\"/_health/\" replaced with \"/api/health/7.0/\"
\nreplaced \"/_me\" with \"/api/graph/7.0/me\"
\nreplaced \"/{id}/picture\" with \"/me/avatar\"
\nsplit \"/_me\" into \"me/account\", \"me/avatar\", \"me/password\", \"me/profile\", \"me/roles\", \"me/teams\"
\nintroduce internal data separation properties \"ogit/_organization\", \"ogit/_scope\"
\nreplace all ids strings with uuids like \"ogit/_owner\", \"ogit/_creator\"…
\nremoved property \"ogit/_reader\"
\ndo not store history for internal attributes updates
\nintroduce \"ogit/Auth/Account\" and \"ogit/Auth/AccountProfile\" to replace \"ogit/Person\" for storing identity information
\nCRUD calls moved to internal app-admin api
\n\"/config\" call for functional accounts
\nrefresh token
\ndevice auth flow
\nswitch token format to JWT
\n\"/me/\" calls moved from graph api
\ntoken count limit for application per account
\n\"consent\" calls
\nall api version 0.9 calls
\nconfigChanged push message
\nerror push message
\nadd ack/nack handling
\nall api version 0.9 calls
\nget applicabilities
\nget capabilities
\ndifferent objects storage
\nThis document will give you an overview about the Bardioc Audit API.
\nAudit logs are security-relevant chronological records that provide documentary evidence of the sequence of activities that have affected at any time a specific operation, procedure, or event.
\naccountId, action, ipAddress, orgId and timestamp are populated for every event, the other attributes depend on the action and are listed below
\n| Event(Action) | \nDescription | \nAttributes | \n
|---|---|---|
Login (action:Login) | \nAny login using bardioc login credentials. | \n\n |
Logout (action:Logout) | \nAny logout event from Bardioc | \n\n |
ResetPassword | \nAny Bardioc credentials password change | \n\n |
SearchKI (action:SearchKI) | \nSearch for a KI using Bardioc Desktop app Knowledge Item Manager | \nsearchString,desktopApp:kim, | \n
DeployKI (action:DeployKI) | \nDeploy a KI using Bardioc Desktop app Knowledge Item Manager | \nkiID,kiName,knowledgePoolId,knowledgePoolName,desktopApp:kim | \n
UndeployKI (action:UnddeployKI) | \nUndeploy a KI using Bardioc Desktop app Knowledge Item Manager | \nkiID,kiName,knowledgePoolId,knowledgePoolName,desktopApp:kim | \n
OpenTeachingSession (action:OpenTeachingSession) | \nOpening a Teaching Session triggered through Knowledge Item Manager | \nkiID,kiName,knowledgePoolId,knowledgePoolName,desktopApp:kim,sessionId,sessionName,taskId | \n
SearchKI (action:SearchKI) | \nSearch for a KI using Knowledge Aquistion Tool | \nsearchString,desktopApp:kat | \n
DeployKI (action:DeployKI) | \nDeploy a KI using Knowledge Aquistion Tool | \nkiId,kiName,desktopApp:kat,knowledgePoolId,knowledgePoolName | \n
UndeployKI (action:UndeployKI) | \nUndeploy a KI using Knowledge Aquistion Tool | \nkiId,kiName,desktopApp:kat,knowledgePoolId,knowledgePoolName | \n
WriteKI (action:WriteKI) | \nUndeploy a KI using Knowledge Aquistion Tool | \nkiId,kiName,desktopApp:kat | \n
ForkKI (action:ForkKI) | \nFork a KI (create a copy) using Knowledge Aquistion Tool | \nkiId,kiName,searchString | \n
SearchTeachingSession (action:SearchTeachingSession) | \nFork a KI (create a copy) using Knowledge Aquistion Tool | \nsearchString,searchString | \n
OpenTeachingSession (action:OpenTeachingSession) | \nOpen an existing Teaching Session | \nsessionId,sessionName,taskId,desktopRole,desktopApp:kat | \n
StartTeachingSession (action:StartTeachingSession) | \nStart a new existing Teaching Session | \nsessionId,sessionName,taskId,desktopRole,desktopApp:kat | \n
ContinueTeachingSession (action:ContinueTeachingSession) | \nContinue working on a new or existing Teaching Session, different to open where you can only view | \nsessionId,sessionName,taskId,desktopRole,desktopApp:kat | \n
StartConversionSession (action:StartConversionSession) | \nStart converting expert knowledge into machine readable knowledge | \nsessionId,sessionName,taskId,desktopRole,desktopApp:kat | \n
ContinueConversionSession (action:ContinueConversionSession) | \nContinue working on turning expert knowledge into machine readable knowledge | \nsessionId,sessionName,taskId,desktopRole,desktopApp:kat | \n
AssignKI (action:AssignKI) | \nAssign a KI to a Teaching Session | \nsessionId,sessionName,kiName,kiId,desktopApp:kat | \n
ArchiveTeachingSession (action:ArchiveTeachingSession) | \nAssign a KI to a Teaching Session | \nsessionId,sessionName,kiName,kiId,desktopApp:atq,taskId,desktopRole | \n
SearchTask (action:SearchTask) | \nSearch a Task using the Task Inspector app | \nsearchString,desktopApp:iv | \n
StartTeachingSession (action:StartTeachingSession) | \nStart a teaching session using the Task Inspector app | \nsessionId,sessionName,taskId,desktopRole:AIE, desktopApp:iv | \n
OpenTeachingSession (action:OpenTeachingSession) | \nOpen a Teaching Session using the Task Inspector app | \nsessionId,sessionName,taskId,desktopRole:AIE, desktopApp:iv | \n
OpenTeachingSession (action:OpenTeachingSession) | \na user, NOT THE OWNER, views a Teaching Session from the Task List app | \nsessionId,sessionName,taskId,desktopRole:AIE/SME, desktopApp:atq | \n
OwnTeachingSession (action:OwnTeachingSession) | \nTaking ownership of a teaching session if user is not owner, allows them to edit Knowledge | \nsessionId,sessionName,taskId,prevOwnerIddesktopRole:AIE/SME, desktopApp:atq | \n
StartTeachingSession (action:StartTeachingSession) | \nStarting a new Teaching Session from the Task List app | \nsessionId,sessionName,taskId,desktopRole:AIE/SME, desktopApp:atq | \n
ContinueTeachingSession (action:ContinueTeachingSession) | \nContinue working on a Teaching Session from the Task List app | \nsessionId,sessionName,taskId,desktopRole:AIE/SME, desktopApp:atq | \n
StartConversionSession (action:StartConversionSession) | \nStart a Conversion Session, only possible to Knowledge Experts | \nsessionId,sessionName,taskId,desktopRole:AIE, desktopApp:atq | \n
ContinueConversionSession (action:ContinueConversionSession) | \nContinue a Conversion Session, only possible to Knowledge Experts | \nsessionId,sessionName,taskId,desktopRole:AIE, desktopApp:atq | \n
SearchTeachingSession (action:SearchTeachingSession) | \nSearch for a specific Teaching Session within the Task List app a conversion session, only possible to Knowledge Experts | \nsearchString,desktopApp:atq | \n
ArchiveTeachingSession (action:ArchiveTeachingSession) | \nSearch for a specific Teaching Session within the Task List app a conversion session, only possible to Knowledge Experts | \nsessionId,taskId,,sessionName,desktopApp:atq,desktopRole | \n
OpenTeachingSession (action:OpenTeachingSession) | \nOpen a Teaching Session from the Bardioc Desktop dashboard | \nsessionId,taskId,,sessionName,desktopApp:hd,desktopRole | \n
StartTeachingSession (action:StartTeachingSession) | \nStart a Teaching Session from the Bardioc Desktop dashboard | \nsessionId,taskId,,sessionName,desktopApp:hd,desktopRole | \n
ContinueTeachingSession (action:ContinueTeachingSession) | \nContinue a Teaching Session from the Bardioc Desktop dashboard | \nsessionId,taskId,,sessionName,desktopApp:hd,desktopRole | \n
StartConversionSession (action:StartConversionSession) | \nStart a conversion of a Teaching Session from the Bardioc Desktop dashboard | \nsessionId,taskId,,sessionName,desktopApp:hd,desktopRole | \n
ContinueConversionSession (action:ContinueConversionSession) | \nContinue a conversion of a Teaching Session from the Bardioc Desktop dashboard | \nsessionId,taskId,,sessionName,desktopApp:hd,desktopRole | \n
Events are a returned as a list of json entries, Sample
\n{\"accountId\":\"xxxx\",\"action\":\"SearchKI\",\"appId\":\"cju16o7cg0001mz775fnoq66i_cjgs10d0w00bizp10t1udkdlm\",\"desktopApp\":\"kim\",\"instanceId\":\"xxxxx\",\"ipAddress\":\"xx.xxx.xxx.xxx\",\"orgId\":\"xxxxx\",\"searchString\":\"test string\",\"timestamp\":1618856857759}
\nOnly admins of an organisation. Please refer to https://guides.bardioc.almato.com/7.0/guides/admin-user-guide/ on how to grant admin access to users.
\nGet your token\nUse the following app and use your user bardioc login credentials (email/pw)
\nTo retrieve a token, you must run a Post request against https://core.test.engine.datagroup.de/api/auth/6/app.
\n{\n \"client_secret\": \"3017347653c9dab5cc78ab5e4c3c125a3faae1bcf97ff165684428b670b80fd6134589747d0f2b7a938c8f17fab3b46dc7ad7f3cb6a0c3df2f64ba54ef2d78a8\",\n \"client_id\": \"cju16o7cg0001mz775fnoq66i_cknrbvxfzsanh0168wdgijugd\",\n \"username\":\"\",\n \"password\": \"\"\n}Get your org id\nLogin to id.almato.com with your credentials. Open your browser tab\nhttps://id.almato.com/org/xxxx (←- your org id)
\nSend a GET request against\nhttps://core.test.engine.datagroup.de/api/audit/1.0/organization/YOURORGID/events?from=1617240656000&limit=1000
\nGiven the number and size of data, we do recommend to request smaller chunks (from/to) (setting up a daily cronjob)
\nParameters available
\n| Name | \nDescription | \n
|---|---|
org_id * | \nString (path) ogit/_id of ogit/Auth/Organization | \n
accountId | \nString (query) ogit/_id of ogit/Auth/Account | \n
appId | \nString (query) ogit/_id of ogit/Auth/Application | \n
ipAddress | \nString (query) IP Address of the user | \n
instanceId | \nString (query) ogit/_id of saas ogit/Auth/DataScope | \n
from | \ninteger($int64) (query) timestamp in ms where to start returning entries (default 1 hour ago) | \n
to | \ninteger($int64) (query) timestamp in ms where to end returning entries (default now) | \n
limit | \ninteger($int64) (query) limit of entries to return (default 1000) | \n
order | \nstring (query) order by a timestamp asc | \n
One of the supported query modes in Bardioc™ uses the Gremlin query language for\ngraph traversals.
\nThe official documentation of the Gremlin query language can be found at\nGremlinDocs.\nThe support version is tinkerpop ´3.2.6´.
\nThe Gremlin query interface in Bardioc has been implemented with the following\nlimitations:
\nGremlin queries are read-only.
\nAll Gremlin queries are filtered according to the user’s access control permissions (see below).
\nQueries have to start with a root vertex. One cannot query the graph with E() or V().
The following syntax elements cannot be used and end in an error message: V(), E(), addV(), addE(), addOutE(), addInE(), drop(), property(…)
The following is a list of the allowed steps:
\naggregate, and, as, barrier, both, bothE, bothV, by, cap, choose, coalesce, coin, constant, count, cyclicPath, dedup, emit, explain, fill, filter, flatMap, fold, group, groupCount, has, hasId, hasKey, hasLabel, hasNext, hasNot, hasValue, id, identity, in, inE, inV, inject, is, iterate, key, label, limit, local, loops, map, mapKeys, mapValues, max, mean, min, next, option, optional, or, order, otherV, out, outE, outV, pageRank, path, peerPressure, profile, program, project, promise, properties, propertyMap, range, repeat, sack, sample, select, simplePath, store, subgraph, sum, tail, timeLimit, times, to, toBulkSet, toE, toList, toSet, toV, tree, unfold, union, value, valueMap, values, where
Closures are restricted to default tinkerpop classes as well as java fundamentals e.g. Integer, Long, String
In the Bardioc™ Graph database, vertices and edges are authorized on a per vertex\ngranularity. For Gremlin queries, all vertices on the traversal path are checked\nfor proper data access permissions. Vertices, for which the user does not have\nproper permissions, are ignored by the query. That means these vertices are neither\nreturned in query result set, nor can there be graph traversals via these\nvertices.
\nThe Bardioc API requires API users to be authenticated. API users need to obtain an access token from the Bardioc Auth API first, which is then used for subsequent API calls.
\nThe Bardioc API distinguishes two types of API usage:
\nFrontend web applications that run in a web browser. These applications require the end user to login with his credentials.
\nTypically backend components or applications that run on a server. These applications use technical accounts and typically manage the credentials in the server application.
\nAt the moment, Bardioc’s Auth API provides two types of authentication flows:
\nPassword flow
\nFor apps acting on their own (normally non-UI, such as Backend Services or Server Applications)
\nRequires for the password to be sent directly to Bardioc in order to request for the access token.
\nUI flow
\nFor graphical interfaces, e.g.: browser apps
\nThe application will send the request for the token and Bardioc will respond accordingly. However, the user\nneeds to login and authenticated first and then only the access token will be granted to the application.
\nIn order to use Bardioc, you need to be authenticated and authorized. This means that you need to have a user\naccount that is tied to a username and password, which can be obtained from Almato AI.
\nThe same user account and password can also be used to authenticate via API, but a separate application key\nneeds to be supplied as well. The application key consists of client ID and client secret, that are also\nobtained from Almato AI. When authenticating via API, it will always be in the context of an application, which\nmeans that you are using the API as a user but through an application. This means that you will be identified\nas a user using a certain application to access Bardioc.
\nAfter authentication, the user will receive the AUTH token and this token can then be used (while it is valid)\nto make API calls. Auth tokens typically expire after 1 hour, unless configured differently.
\nFor each new application (maybe a Connector, Acton Handler or service) that is accessing Bardioc, a different application key\nmust be used, so that Bardioc knows which application is accessing the system and data. Applications can be\nrevoked, without affecting other applications that need to access Bardioc.
\nA backend application is an application which runs as a backend service. The backend application typically operates independent from the activities of individual frontend users.\nAuthentication for these types of applications use the OAUTH2 password flow to obtain access tokens.
In order to obtain a token, the following request must be executed (example using curl command):
\ncurl -X POST -H 'Content-type: application/json' --data-binary '{\"client_id\": \"$id\", \"client_secret\": \"$secret\", \"username\": \"$user\", \"password\": \"$password\"}' 'https://core.test.engine.datagroup.de/api/auth/6/app'with
\nclient_id being the id of the application
client_secret being the secret of the application
username being the username under which the application will operate
password being the password of the user
This will return the following result:
\n{\n \"_TOKEN\": \"$access token\",\n \"_APPLICATION\": \"$client_id\",\n \"_IDENTITY\": \"$ogit/name of the user\",\n \"_IDENTITY_ID\": \"$id of the user\",\n \"expires-at\": \"$expiration timestamp in ms\",\n \"type\": \"Bearer\"\n}Other option is to use OAUTH2 token flow which is same concept but use standard defined input and output
\ncurl -X POST -H 'Content-type: application/x-www-form-urlencoded' -H \"Authorization: Basic <<BASE64ENCODED($client_id:$client_secret)>>\" --data 'grant_type=password&username=$username&password=$password' 'https://core.test.engine.datagroup.de/api/auth/6/token'with
\nclient_id being the id of the application
client_secret being the secret of the application
username being the username under which the application will operate
password being the password of the user
This will return the following result:
\n{\n \"access_token\": \"$token\",\n \"expires_in\": \"$expiration time in seconds\",\n \"token_type\": \"Bearer\",\n \"refresh_token\": \"$refresh token\"\n}The application can use the token to access the Bardioc Graph API.
\nA UI application is an application which only runs in the browser. Authentication must be done with the\nOAUTH2 implicit flow.
In order to start this flow, redirect the browser to:
\nGET https://core.test.engine.datagroup.de/api/auth/6/ui/?client_id={CLIENT_ID}&redirect_url=https://another.example.com/my/app/with client_id being the id of the application, and redirect_url the URL that will be redirected to upon\nsuccessful authentication. Please make sure that the redirect_url is correctly assigned to the application\nin Bardioc IAM, so that the authentication flow works correctly. The Auth API will refuse to accept to unknown\nredirect URLs.
The user will be taken through the authentication process. If successful, the browser will finally be redirected to:
\nGET https://another.example.com/my/app/#accessoken={token}and the application can then parse the token from the # hash and remove it from the URL.
The Bardioc Desktop framework uses the mechanism for UI applications described above. The Bardioc Desktop SDK handles the token management for your application, so that you as developer do not need to take care of authentication flow.
\nFor a step by step example on how to authenticate via API, please refer to the tutorial First Steps with Bardioc.
\nRefresh token functionality allows to get next access token without providing credentials.\nTo get new access token client in initial call provides client credentials with password and as return get long living\naccess_token which may be used to obtain multiple access tokens.
\nobtaining access token would always return refresh_token (refresh_token would be the same unless it would expire before current access_token)
\nexample request:
\ncurl -X POST \"APIENDPOINT/auth/6/app\" -H \"Content-Type: application/json\" -d \"{ \\\"client_id\\\": \\\"c01234567890abcdefghijklm_c01234567890abcdefghijklm\\\", \\\"client_secret\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\", \\\"username\\\": \\\"user@company.co\\\", \\\"password\\\": \\\"12345678\\\"}\"example response:
\n{\n \"_TOKEN\": \"eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1ODg5MjY5OTcsInN1YiI6ImlkZW50aXR5SWQiLCJkYXRhIjp7InRlYW1zIjpbInRlYW1JZDEsIHRlYW1JZDIiXSwiZGVmYXVsdC1zY29wZSI6ImRlZmF1bHRTY29wZUlkIiwib3JnYW5pemF0aW9uIjoib3JnYW5pemF0aW9uSWQiLCJfQVBQTElDQVRJT04iOiJhcHBsaWNhdGlvbklkIiwiX0lERU5USVRZX0lEIjoiaWRlbnRpdHlJZCIsImV4cGlyZXMtYXQiOjE1ODg5MjY5OTc0NjgsIl9JREVOVElUWSI6ImlkZW50aXR5TmFtZSIsImNyZWF0ZWQtb24iOjE1ODg5MjY5ODc0NjgsImRlZmF1bHQtdGVhbSI6ImRlZmF1bHRUZWFtSWQifSwiaXNzIjoiaHR0cHM6XC9cL2FyYWdvLmNvIiwiYXVkIjoiYXBwbGljYXRpb25JZCIsImlhdCI6MTU4ODkyNjk4N30.$SIGNATURE\",\n \"_APPLICATION\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n \"_IDENTITY\": \"user@company.co\",\n \"_IDENTITY_ID\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n \"expires-at\": 1577711870081,\n \"refresh-token\": \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\",\n \"type\": \"Bearer\"\n}obtaining token using refresh_token
\nexample request:
\ncurl -X POST \"APIENDPOINT/auth/6/refresh\" -H \"Content-Type: application/json\" -d \"{ \\\"client_id\\\": \\\"c01234567890abcdefghijklm_c01234567890abcdefghijklm\\\", \\\"client_secret\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\", \\\"refresh_token\\\": \\\"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890ABCD\\\"}\"example response:
\n{\n \"_TOKEN\": \"eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE1ODg5MjY5OTcsInN1YiI6ImlkZW50aXR5SWQiLCJkYXRhIjp7InRlYW1zIjpbInRlYW1JZDEsIHRlYW1JZDIiXSwiZGVmYXVsdC1zY29wZSI6ImRlZmF1bHRTY29wZUlkIiwib3JnYW5pemF0aW9uIjoib3JnYW5pemF0aW9uSWQiLCJfQVBQTElDQVRJT04iOiJhcHBsaWNhdGlvbklkIiwiX0lERU5USVRZX0lEIjoiaWRlbnRpdHlJZCIsImV4cGlyZXMtYXQiOjE1ODg5MjY5OTc0NjgsIl9JREVOVElUWSI6ImlkZW50aXR5TmFtZSIsImNyZWF0ZWQtb24iOjE1ODg5MjY5ODc0NjgsImRlZmF1bHQtdGVhbSI6ImRlZmF1bHRUZWFtSWQifSwiaXNzIjoiaHR0cHM6XC9cL2FyYWdvLmNvIiwiYXVkIjoiYXBwbGljYXRpb25JZCIsImlhdCI6MTU4ODkyNjk4N30.$SIGNATURE\",\n \"_APPLICATION\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n \"_IDENTITY\": \"user@company.co\",\n \"_IDENTITY_ID\": \"c1234567890abcdefghijklmn_c1234567890abcdefghijklmn\",\n \"expires-at\": 1577711870081,\n \"type\": \"Bearer\"\n}if trying to refresh token using expired one it would return 401 and then one shall obtain fresh one
\naccess_token = 1h
\nrefresh_token = 24h
\nRevocation of refresh token works same way as for access token
\nThe list API allows one to maintain multiple values for one property.\nA property normally looks like:
\n{ \"ogit/name\": \"Bardioc\" }A listified property looks like
\n{\"ogit/name\": [{\"value\": \"foo\"}, {\"value\": \"bar\", \"created\": 1523360364631}]}whereas the inner structure is actually stored as stringified JSON:
\n{\"ogit/name\": [{\"value\":\"foo\"}, {\"value\":\"bar\", \"created\":1523360364631}]}In order to work with list values, the normal API calls can be used, with prefixed field names.\nIn order to read listified values as list, parameter listMeta should be used.
Once a value is converted to list it stays as list, but it is still allows to manipulate the list values\nas a normal value. In that case a list is replaced with a new one element list (see examples).
\nEXAMPLE of reading:
\nGET https://{url}/{id}?listMeta=trueIf created key was not set, it will be added automatically set to now in milliseconds.
By using = as the first key to a property name, one will set the values of the list removing all others.
BEFORE:
\n {\n \"ogit/name\": \"hello\"\n }UPDATE json:
\n {\n \"=ogit/name\": [{\"value\": \"foo\"}, {\"value\": \"bar\"}]\n }AFTER with listMeta:
{\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n }AFTER without listMeta:
{\n \"ogit/name\": \"[\\\"foo\\\", \\\"bar\\\"]\"\n }Update in backwards-compatible mode
\nBEFORE:
\n {\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}]\n }UPDATE json:
\n {\n \"ogit/name\": \"bar\"\n }AFTER with listMeta:
{\n \"ogit/name\": [{\"value\": \"bar\", \"created\": 1523360364635}]\n }AFTER without listMeta:
{\n // one element list is represented as scalar element\n \"ogit/name\": \"bar\"\n }Update, which doesn’t change meta of values:
\nBEFORE:
\n {\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}]\n }UPDATE json:
\n {\n // If 'created' field is not specified by update, and value exists in a list,\n // it will not get new `created` timestamp\n \"=ogit/name\": [{\"value\": \"foo\"}]\n // OR\n \"ogit/name\": \"foo\"\n }AFTER with listMeta:
{\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364000}\n }AFTER without listMeta:
{\n // one element list is represented as scalar element\n \"ogit/name\": \"foo\"\n }By using + as the first key to a property name, one can add one or more values.
BEFORE:
\n {\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n }UPDATE json:
\n {\n \"+ogit/name\": [{\"value\": \"foobar\"}]\n }AFTER with listMeta:
{\n \"ogit/name\": [\n {\"value\": \"foo\", \"created\": 1523360364631},\n {\"value\": \"bar\", \"created\": 1523360364631},\n {\"value\": \"foobar\", \"created\": 1523360364633}\n ]\n }AFTER without listMeta (order has no garanties):
{\n \"ogit/name\": \"[\\\"foobar\\\", \\\"foo\\\", \\\"bar\\\"]\"\n }By using - as the first key to a property name, one can remove one or more values.\nSpecifying properties in the removal call will only remove those items in the list, that match all properties specified by the item to remove.
BEFORE:
\n {\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n }UPDATE json:
\n {\n \"-ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 0}]\n }AFTER with listMeta:
{\n \"ogit/name\": [{\"value\": \"bar\", \"created\": 1523360364631}]\n }One can create a list by calling any of = on a scalar property value:
BEFORE:
\n {\n \"ogit/name\": \"foo\"\n }UPDATE json:
\n {\n \"=ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n }AFTER:
\n {\n \"ogit/name\": [{\"value\": \"foo\", \"created\": 1523360364631}, {\"value\": \"bar\", \"created\": 1523360364631}]\n }Removing existing scalar property with list API, if value has no created timestamp (not in a list form),\nvertex ogit/_created-on should be used instead:
BEFORE:
\n {\n \"ogit/name\": \"foo\",\n \"ogit/_created-on\": \"15233603640000\"\n }UPDATE json:
\n {\n \"-ogit/name\": [{\"value\": \"foo\", \"created\": 15233603640000}]\n }AFTER:
\n {\n }This document will give you an overview about the Bardioc Graph Developer WS API.
\nPlease be familiar with the Bardioc Graph and the Websocket Protocol.
\nAll Requirements of Bardioc Graph apply.
\n| \n\n | \n\nIn order to use the API you need to register an application, please drop us a line at support@bardioc.almato.com.\n | \n
All initial connect requests must contain a valid access token _TOKEN. Request a valid access token from the Bardioc IAM server.
\nAll requests will be made against a base $url (e.g. core.almato.com).
All further examples assume wss:// as the protocol.
The Streaming endpoint is located at /api/events-ws/.
The standard steps to follow are:
\nConnect
\nSubscribe to scope (if allscopes set to false)
\nRegister a filter
\nReceive data
\nconst ws = new WebSocket(`wss://${url}/api/events-ws/6/?groupId=&offset=`, ['events-1.0.0', 'token-' + token]);| Name | \nDescription | \nDefault | \n
|---|---|---|
groupId | \nsubscribe to the same event stream by opening multiple connections with the same groupId. The stream will be partitioned amongst all connections. If connection is lost, the groupId will allow you to receive any missed events. | \n'' | \n
offset | \n
| \n'' | \n
delta | \nOnly receive the changes to a vertex, not the whole vertex. Each a attribute in the event body is prefixed with | \nfalse | \n
allscopes | \nBy default, events from all scopes are subscribed to. Setting this to false, requires use of the | \ntrue | \n
const msg = {\n 'type': 'token',\n 'args': {\n _TOKEN: 'new token'\n }\n};\nws.send(JSON.stringify(msg));const msg = {\n 'type': 'subscribe',\n 'id': scope_id // The ogit/_id of the ogit/DataScope (i.e. the scope of your instance) you want to subscribe to\n};\nws.send(JSON.stringify(msg));const msg = {\n 'type': 'register',\n 'args': {\n 'filter-id': 'unique filter id for this websocket',\n 'filter-type': 'jfilter',\n 'filter-content': '(element.ogit/_type = ogit/Question)'\n }\n};\nws.send(JSON.stringify(msg));const msg = {\n 'type': 'unregister',\n 'args': {\n 'filter-id': 'unique filter id for this websocket'\n }\n};\nws.send(JSON.stringify(msg));const msg = {\n 'type': 'clear',\n 'args': {}\n};\nws.send(JSON.stringify(msg));Events contain the originator of the event, the action taken, and the contents.
\nBy default, the eventstream sends the entire body of the affected vertex.
\n{\n id: string; // ogit/_id from body\n body: {\n /* properties like ogit/_id */\n \"ogit/name\": \"My name\"\n },\n metadata: {\n \"ogit/_modified-by\": string;\n \"ogit/_modified-by-app\": string;\n \"ogit/_modified-on\": number;\n };\n nanotime: number;\n timestamp: number;\n type: \"CREATE\" | \"REPLACE\" | \"UPDATE\" | \"CONNECT\" | \"DISCONNECT\" | \"DELETE\" | \"WRITE_TIMESERIES\";\n}Delta events only contain the changes on the node. Each attribute is prefixed by +, -, =.
{\n id: string; // ogit/_id from body\n body: {\n /* properties like ogit/_id prefixed by change */\n \"+ogit/firstName\": \"My name\" // Added\n \"-ogit/lastName\": \"My name\" // Removed\n \"=ogit/email\": \"My name\" // Changed\n },\n metadata: {\n \"ogit/_modified-by\": string;\n \"ogit/_modified-by-app\": string;\n \"ogit/_modified-on\": number;\n };\n nanotime: number;\n timestamp: number;\n type: \"CREATE\" | \"REPLACE\" | \"UPDATE\" | \"CONNECT\" | \"DISCONNECT\" | \"DELETE\" | \"WRITE_TIMESERIES\";\n}In order to only receive certain events, filters can be registered. The filterType is currently only jfilter.
| Operator | \nDescription | \nSupported types | \nFilter example | \n
|---|---|---|---|
| \nequals to | \nString,\nNumber | \n
| \n
| \ndiffers from | \nString,\nNumber | \n
| \n
| \nmore than | \nNumber | \n
| \n
| \nmore or equals | \nNumber | \n
| \n
| \nless than | \nNumber | \n
| \n
| \nless or equals | \nNumber | \n
| \n
| \nnot | \nFilter | \n
| \n
| \nand | \nFilters | \n
| \n
| \nor | \nFilters | \n
| \n
wildcards | \nmatches all | \nString | \n
| \n
{\n 'filter-content': '&(element.ogit/_type=ogit/Question)(action=C*)'\n}The WS Graph API permits to do REST primitives over WS.\nThe WS Graph API endpoint is located at /api/graph-ws/.
| \n\n | \n\nBlobs can be fetched via this api, but they can only be stored via REST.\n | \n
const ws = new WebSocket(`wss://${url}/api/graph-ws/6/`, ['graph-2.0.0', 'token-' + token]);\nws.addEventListener(\"open\", function() {\n if (ws.protocol !== \"graph-2.0.0\") {\n throw new Error(\"Expecting WebSocket protocol 'graph-2.0.0', got \" + ws.protocol);\n }\n //do something with connection\n});Websocket API requests are JSON, and have the following structure:
\nconst request =\n{\n 'id': 'mandatory id for matching the reply',\n 'type': 'the type of the request, e.g. get, create, replace, connect, ...',\n '_TOKEN': 'optional, if none specified, the one from the establishing the websocket will be used',\n 'headers':\n {\n // headers for the request\n },\n 'body':\n {\n // body for the request\n }\n};ws.send(JSON.stringify(request));In order to do correct multiplexing in the websocket stream, all responses will be wrapped by an envelope.\nA client must buffer all messages until the flag more is false in an envelope.
Response Envelope:
\n{\n \"id\": \"id of the request\",\n \"more\": true|false // `false` if this is the last message for the response\n \"multi\": true|false // `true` if this response is fragmented, the stream of messages represents an array as the final result\n \"body\": []|{}|... // for responses with `multi=true` the body should be put to an array [] and when `more=false` the result should be the array with the assembled parts\n}In order to process these envelope which arrive intermixed with other response envelopes, one\nmust buffer the envelopes unti the last flag is true.
\nconst requests = {}; // holds all responses\n\nws.onmessage = function(msg)\n{\n const payload = JSON.parse(what);\n\n const request = requests[payload.id];\n if (!request) throw new Error(\"request could not be found \" + req.id);\n\n if (payload.error)\n {\n // an error must always be delivered\n request.cb(payload);\n delete(requests[payload.id]);\n } else if (!payload.multi && payload.more) {\n throw new Error(\"non-multi messages cannot be fragmented\");\n } else if (!payload.multi) {\n // thats a single response message\n request.cb(payload);\n delete(requests[payload.id]);\n } else {\n // thats a fragmented response, buffer up everything until payload.more = false\n if (payload.body !== null) request.buf.push(payload.body);request.buf.push(payload.body);\n\n if (!payload.more)\n {\n request.cb(request.buf);\n delete(requests[payload.id]);\n }\n };\n);{\n \"id\": \"request id\",\n \"type\": \"get\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"create\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_type\": \"type of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"update\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"replace\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\",\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"delete\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node/edge\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"connect\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_type\": \"type of the verb\"\n },\n \"body\":\n {\n \"out\": \"id of the outgoing node\",\n \"in\": \"id of the ingoing node\"\n }\n}{\n \"id\": \"request id\",\n \"type\": \"query\",\n /* other optional properties */\n \"headers\":\n {\n \"type\": \"type of the query, e.g. vertices\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"writets\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"streamts\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"history\",\n /* other optional properties */\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"me\",\n '_TOKEN': 'optional, if none specified, the one from the establishing the websocket will be used',\n \"headers\":\n {\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}{\n \"id\": \"request id\",\n \"type\": \"getcontent\",\n '_TOKEN': 'optional, if none specified, the one from the establishing the websocket will be used',\n \"headers\":\n {\n \"ogit/_id\": \"id of the node\"\n },\n \"body\":\n {\n // all parameters for the corresponding REST request are available here\n }\n}| \n\n | \n\nIn order to store blob content, the REST API must be used.\n | \n
The responses for receiving blob content are chunked envelopes looking like this, and the client needs to assemble these:
\n{\n \"id\": \"request id\",\n \"multi\": true,\n \"last\": true|false\n \"body\":\n {\n \"data\": \"chunk of blob data\",\n \"encoding\": \"base64\" // base64 is currently the only encoding possible\n }\n}All error codes of Bardioc Graph API apply.
\nAll error codes of Websocket Protocol apply.
\n| \n\n | \n\nOn Websocket close message Bardioc Graph error codes are not propagated and only Websocket Protocol codes are returned. If exists error from close message content should be used to recognize and implement handling. Example error response message:\n | \n
{\n \"error\": {\"message\": \"authentication required\"}\n}Automation in Bardioc™ is task-centric. Therefore, Automation Tasks are the\ncentral data objects to trigger the Bardioc™ Engine. Automation Tasks have a\nlifecycle - they are created, processed and finally either succeed or fail.\nThe following diagram illustrates the state machine of Automation Task status.
\n\nThe black lines indicate transitions performed by the Engine, whereas:
\nsome transitions will be triggered only be Engine’s internal task handling
\nsome transitions can be triggered by special KI language commands
\nThe transitions marked in red may be performed from the outside, i.e. by connectors\nor other applications.
\nNew task which is ready to be processed by the Bardioc™ Engine
\nFor compatibility reasons a missing status value is interpreted as NEW
Engine is currently working on this task to resolve it.
\nTask processing has finished successfully. Technically that means: through\napplication of KIs all ToDo variables have been deleted.
\nThis is a final state.
\nTask processing was suspended to wait for some external event (e.g. user approval).\nA task in that state must be set back to PROCESSING from the outside (by the\ncontrolling connector or other application).
\nTask processing has been stopped. In most cases this status means the Engine ran\nout of applicable knowledge.
\nThis is a final state.
\nTask processing has been forcefully terminated. This could be triggered internally\nby some error conditions (see below) or externally (e.g. Connector/CLI).
\nThis is a final state.
\n| From state | \nTo state | \nTrigger | \n
|---|---|---|
NEW | \nPROCESSING | \nsuccessfully loaded task for processing | \n
PROCESSING | \nRESOLVED | \nno remaining todo variable in task | \n
PROCESSING | \nWAITING | \nKI command | \n
PROCESSING | \nSTOPPED | \nKI command | \n
NEW / PROCESSING | \nTERMINATED | \nProcessing node does not exist or is not accessible | \n
| \n\n | \n\n \n \nThe Engine writes the reason of a status change into the\n | \n
The transitions listed below are allowed to be triggered by connectors or other\napplications:
\n| From state | \nTo state | \nTrigger/Reason | \n
|---|---|---|
PROCESSING | \nTERMINATED | \nExternal application (e.g. connector) decides then Engine\nshould not process that task anymore. | \n
WAITING | \nTERMINATED | \nExternal application (e.g. connector) decides then Engine\nshould not process that task anymore | \n
PROCESSING | \nWAITING | \nExternal application decides that Engine should (temporarily)\n pause processing that task (e.g. waiting for a user approval) | \n
WAITING | \nPROCESSING | \nExternal application decides that a task processing can now\ncontinue | \n
When a task status is STOPPED, this means that there was not sufficient knowledge\nto solve it. That’s why any task being in status STOPPED is a candidate for a\nnew knowledge acquisition session, and will be listed in the Task List in Bardioc™.\nThe responsible Subject Matter Expert should teach the system how this task can be\nsolved the next time.
The Bardioc API adheres to common web security standards. For browser-based applications, the HTTPS calls and response contain various security-related header attributes according to web security best practices.
\nA Bardioc Desktop application is typically hosted on the Bardioc server, served from the same URL (https://core.test.engine.datagroup.de) as the Bardioc API. During local application development, the application might be launched and tested locally on the developer’s PC. In such a case, the web security header attributes would indicate to the web browser that the requests are coming from a wrong origin and would block the application. These checks need to be bypassed for local application development.
\nIt is recommended to use a local reverse proxy to modify the header attributes, so that the application runs in the browser correctly during development. In general, any reverse proxy can be used, given that it supports modification of HTTPS header attributes. As an example, we show below how this can be done with nginx. Feel free to use another reverse proxy instead.
\nInstallation of nginx as reverse proxy:
\nDownload the current (either mainline or stable) nginx version for your operating system from http://nginx.org/en/download.html
\nUnzip the nginx archive (zip or tar.gz) on your local PC
\nModify the nginx.conf file in the “conf” sub folder as stated below
\nRun nginx locally (e.g. run “start nginx.exe” on Windows)
\nNow you can the configured local URL (e.g. “http://localhost:5080/” as graph URL in your Bardioc Desktop app
\nIn the example below, the URL http://localhost:5080 is forwarded to https://core.test.engine.datagroup.de. The 'Access-Control-Allow-Origin' header attribute is set to '*' to let the browser accept the API responses. Please note that the “/_g” location needs a slightly different configuration to support websocket connections.
\nhttp {\n include mime.types;\n default_type application/octet-stream;\n sendfile on;\n\n server {\n listen 5080;\n server_name localhost;\n\n\t\tlocation / {\n\t\t\tproxy_pass https://core.test.engine.datagroup.de ;\n\t\t\tadd_header 'Access-Control-Allow-Origin' '*' always;\n\t\t\tproxy_hide_header 'Access-Control-Allow-Origin';\n\t\t}\n\n\t\tlocation /_g {\n\t\t\tproxy_pass https://core.test.engine.datagroup.de/_g ;\n\t\t\tproxy_hide_header 'Access-Control-Allow-Origin';\n\t\t\tproxy_http_version 1.1;\n\t\t\tproxy_set_header Upgrade $http_upgrade;\n\t\t\tproxy_set_header Connection \"Upgrade\";\n\t\t}\n }\n}It is recommended to use the reverse proxy method described above. If for some reason it is not possible or not desired to run a local reverse proxy, there is a workaround available to temporarily deactivate the CORS check in your web browser via a plugin.\nFor security reasons, we recommend using a second browser for this method, so that only the application under development is run without active CORS check. For example, if your main browser is Chrome, you may use Fire-fox to locally test the application, or vice versa.\nYou may use, for example, the “CORS Everywhere” plugin for Firefox. As you can see in the screenshot in Figure 1, you may (and should) limit the plugin to a whitelist of URLs. Also the plugin is by default switched off after opening the web browser; it needs to be activated by pressing a button. At the next browser restart, the plugin is inactive again.
\n![\"Screenshot](\"/7.0/images/documentation/cors_plugin_settings.png\")
\n![\"CORS](\"/7.0/images/documentation/cors_plugin_activation.png\")
\nThe Bardioc platform is delivered as Software as a Service (SaaS) that is hosted by Almato and integrates with systems in the customers environment through an API layer.\nThere are two integration components of the Bardioc system:
\nConnectors
\nActionHandlers
\nA Connector is software running the integration between Bardioc and source system providing automatable tasks to Bardioc.\nAn Action Handler is software running the integration that Bardioc uses to invoke actions on target system.
\nAlmato provides a set of out of the box integrations.
\nMigrating from Bardioc™ 6 to Bardioc™ 7 provides you with new functionalities and a restructured API. The changes in the API’s required to move from Bardioc™ 6 to 7 are available in this document.
\nThere is now a common base url (https://core.test.engine.datagroup.de) for all customers and instances
\nEach Bardioc instance has its own scope which is used to manage access-permissions
The ogit/_owner attribute no longer needs to be set when writing to provide visibility and access
The structure of the path for calling the interfaces has been changed, swapping the position of the API version:
\n/api/$VERSION/graph/ (previous)
\n/api/graph/$VERSION/ (now)
\nfor all available APIs, please visit https://core.test.engine.datagroup.de/help/
The special treatment for ogit/Person (email address has also been used as the vertex id) has been removed.
To make your existing project work with Bardioc™ 7 you will need to:
\nNew authentication URL: https://core.test.engine.datagroup.de/api/auth/6/app
\nNew Graph-Api URL: https://core.test.engine.datagroup.de/api/graph/7/
\nChange your code to refer to your scope instead of an owner whenever you are performing a task:
\ne.g. when creating a new vertex set the attribute ogit/_scope
\ni.e ogit/_owner → ogit/_scope
\nFor details please read/follow the tutorial First Steps with Bardioc
Note - These API’s may be updated time to time. Latest API’s can be found at https://core.test.engine.datagroup.de/help/
\nIn Bardioc 6 Action Handlers were a part of the engine configuration and executed on the engine. Customers can now create their own on-premise action handlers using the Action API.
\nFor more information on the Action API, please visit Action API
\nCapabilities: https://core.test.engine.datagroup.de/api/action/1/capabilities
\nApplicabilities: https://core.test.engine.datagroup.de/api/action/1/applicabilities
URL: wss://core.almato.com/api/action-ws/1/
\nSubProtocol: action-1.0.0
\nSample websocket connection request:
const ws = new WebSocket('wss://core.almato.com/api/action-ws/1/', ['action-1.0.0', 'token-' + '$token'])Note - These API’s may be updated time to time. Latest API’s can be found at https://core.test.engine.datagroup.de/help/
\nThis section describes the Domain Object REST API from the point-of-view of a client of the API.
\n![\"DoapiConcept](\"/7.0/images/connector_images/DoapiConcept_Ticket.png\")
\n![\"DoapiConcept](\"/7.0/images/connector_images/DoapiConcept_Model.png\")
\nThe Domain Object API enables the client to:
\nWrite and update complex data structures to Bardioc DB were they will be mapped to a graph structure (defined by a view definition). The view is defined in OGIT.
Recieve information on the process of the write transactions (via the transactions endpoint).
Recieve updates in a complex data structure for ticket data (mapped to ogit/Automation/AutomationIssue and the related IssueHistory by a view definition) via the updates endpoint.
The Domain Object API exposes the content of the Bardioc Graph in terms of high-level domain-specific objects, such as Incident, House, etc, rather than in terms of low-level vertices and edges. In other words, a domain object is a sub-graph of the Bardioc graph expressed as a JSON object. Domain objects are identified by an identifier that is guaranteed by the client to be unique on the client’s side. Through this identifier, objects can be created/updated and deleted.
\nAs writing a domain object (that is, calling PUT /views/<viewid>/objects/<object-id>) can take a long time, these operations return a transaction. A transaction is a representation of the package of work implied by the operation, e.g., create vertex A, create vertex B, connect A with B through verb C. To get the current status of a transaction do GET /views/<viewid>/transaction/<transaction-id>.
Updates made to domain objects (made by some other user than the client) are readable at the /views/<viewid>/updates/<index> end-point on the REST API. This end-point can be read in three different ways. Either by explicitly indexing the update, e.g., GET /views/<viewid>/updates/<index>, or using a server-managed iterator, e.g., GET /views/<viewid>/updates/?iterator=<iterator-id>, or finally using websockets through the notification meachanism (see below). If the client needs to read updates in a random-access manner, use explicit indexing. If you prefer to read updates in a single bulk, use the iterator interface. Finally, if you wish to minimize latency use the websockets.
A client can create a notification subscription using POST /views/<viewid>/notifications, which will allow a client to receive notifications when a transaction or domain object has been updated. Outstanding notifications are handled by the server, thus, a client can disconnect and receive any updates occurring while disconnected upon reconnect.
To specifically mark an automation issue as \"monitoring\" issue that is only meant to verify proper operation of the platform, the ogit/subject attribute of such issues must start with the string BardiocMON (all uppercase).
\nAs BardiocMON issues are assumed to be purely for monitoring purpose, they will be handled slightly different by certain parts of the platform:
\nNo teaching sessions will be created out of these issues
\nThese issues will not be counted by statistics generated by the platform
\nIn order to see these issues in the Task Inspector, the \"Monitoring\" switch has to be enabled, otherwise they will be filtered from the list
\nNote that we use the word client in the sense of an entity identified by a username that access the REST API. That is, if multiple applications are accessing the Domain Object API using the same username, they are considered to represent a single client.
\nThe following REST operations are supported from the Domain Object API.
\nGET /views/<viewid> get the definition and configuration for a view that is available to the client.
GET /views get all definitions available to the client.
GET /views/<viewid>/status get the status of the view.
PUT /views/<viewid>/objects/<id>[?validateonly=true|false] creates/updates the object of the provided id and returns transaction. If the validateonly parameter is true (default false), then the object is only validated and not written (a dummy transaction object is returned).
GET /views/<viewid>/transactions/<transaction id> gets the status of the transaction of the provided id.
GET /views/<viewid>/transactions/[?count=<count>&sortBy=<sort-attribute>] gets the status of the count (default 100) most recently updated transactions. The parameter sortBy (default -requestedAt) is the attribute which is used to sort the transactions; the attribute name can be prefixed by - to reverse the order. Any other query parameters are used to match the returned JSON object. Thus, the query ?count=100&requestedAt=gt123456789 returns the 100 most recent transactions with a requestedAt greater than 123456789. See section Query parameters below for more information.
GET /views/<viewid>/updates[?offset=…&iterator=…&count=…] get an array of object updates. Indexes the queue of updates. If the parameter count is not given it defaults to 100. The query parameter offset can be set to head or latest as a synonym for the highest (current) index available. It is possible to filter the list of updates through query parameters starting with object, for example object.someField=thisValue will only return updates having someField equal to thisValue.
POST /views/<viewid>/notifications creates a new notification subscription.
GET /views/<viewid>/notifications gets all notification subscriptions created by the client.
GET /views/<viewid>/notifications/<id> gets a notification subscription created by the client.
PUT /views/<viewid>/notifications/<id> updates an existing notification subscription.
DELETE /views/<viewid>/notifications/<id> removes an existing notification subscription.
ws /views/<viewid>/notifications/<id>/ws stream notifications over websocket
All operations that return a list of results, i.e., GET /views/<viewid>/notifications, GET /views/<viewid>/transactions/[?state=<state>] etc, allows filtering by providing query parameters in the request. The name of these query parameters may contain periods (.), to navigate a nested object structure. For example, the following request returns all updates to a domain object with the name parameter set to Alice: curl -X GET 'http://doapi:8080/views/…/updates/?offset=0&object.name=Alice' Furthermore, numeric values can be compared using strict equals (foo=123), greater than (foo=gt123), and less than (foo=lt123).
Object updates are exposed as an indexable array of changes. The client can index this using a query parameter ?offset=378932, which is a stateless operation and will give the same result each time (unless Kafka cleans up the underlying topic). Additionally, the client can use ?iterator=<id> to get an iterator view of the array, which means that result will be the \"next\" object. This simply maps to a consumer group. The two parameters iterator and offset can be used in a single request to set the offset used for the iterator. The returned JSON objects contain the offset. The ids of iterators are local to each user (meaning wso2 user) and can thus not be shared between two different users.
A transaction is a package of work, e.g., a write of a domain object. When a the Domain Object API receives a PUT request to update an object, it creates a transaction object that looks something like this:
\n {\n \"link\": , \"/views/<viewid>/transactions/<transaction-id>\", // The link to this transaction.\n \"object\": \"/views/<viewid>/objects/<object-id>\", // The link to the object that is being written\n \"status\": \"waiting\", // waiting, in-progress, done-success, done-failure\n \"updatedAt\": <timestamp>, // When any field on the transaction was last updated.\n \"createdAt\": <timestamp>, // When the transaction was created (object was posted to the REST API).\n \"startedAt\": <timestamp>, // When the transaction started processing.\n \"errors\": [] // Any errors that occurred during processing.\n }This section contains example using curl to concretely illustrate how to use the Domain Object REST API. The API runs on the host doapi on port 8800 in the examples below.
Furthermore, to access the Domain Object REST API, you need an access token, which is obtained from the auth endpoint on the Bardioc Graph REST API. In the examples below we use the symbolic token <TOKEN> as a placeholder.
Finally, we will pretty-print the responses from curl to make it easier to read this documentation.
To read all available views, do GET /views, e.g.,
$ curl -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json' https://doapi.almato.com/viewsWe will consider the following SDF definition or view for all the Rest operation examples.
\n- sdf:\n id: personSDF\n entities:\n person:\n type: ogit/Person\n presence: root\n attributes:\n ogit/firstName: firstName\n ogit/lastName: lastName\n ogit/email: email\n friends:\n type: ogit/Person\n presence: many\n attributes:\n ogit/firstName: firstName\n ogit/lastName: lastName\n ogit/email: email\n verbs:\n - {id: ogit/likes, from: person, to: friends}A domain object is written by doing PUT /views/<view-id>/objects/<object-id>. For example, writing an object object-alice to the view created above is done as:
$ curl -X PUT https://doapi.almato.com/views/personSDF/objects/object-alice \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json' \\\n -d'{\"$type\": \"person\", \"firstName\": \"Alice\"}'{\n \"link\": \"/views/personSDF/transactions/8cdc0cd4-2cb5-4dd9-a835-5e46881250ee\",\n \"object\": \"/views/personSDF/objects/object-alice\",\n \"status\": \"waiting\",\n \"requestedAt\": 1563885381195,\n \"updatedAt\": 1563885381195,\n \"startedAt\": -1,\n \"errors\": []\n}Since writing an object can potentially take long time (if the object is large), the result of this operation is a transaction. When the transaction is in state done-success the object has been written to the graph.
A domain object in the graph can be updated, e.g., by a KI. Such updates can be read by doing GET /views/<view-id>/updates/<index>:
$ curl -X GET https://doapi.almato.com/views/personSDF/updates/0 -k \\\n -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'{\n \"link\": \"/views/personSDF/updates/0\",\n \"offset\": 0,\n \"object\": {\n \"firstName\": \"Alice Liddell\",\n \"$type\": \"person\",\n \"$id\": \"object-alice\",\n \"$delta\": [firstName]\n }\n}where the object field contains the actual domain object. The fields $type, $id, and $delta have special meaning. The field $type is the name of the SDF type for this object; the field $id is the id of the domain object; and the field $delta is the list of attribute that has changed since the last update.
Multiple updates can be read in a single request by passing the offset and count query parameters as GET /views/<view-id>/updates?offset=<start index>&count=<max updates to return>:
$ curl -X GET 'https://doapi.almato.com/views/personSDF/updates?offset=0&count=2' \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'[\n {\n \"link\": \"/views/personSDF/updates/0\",\n \"offset\": 0,\n \"object\": {\n \"firstName\": \"Alice Liddell\",\n \"$type\": \"person\",\n \"$id\": \"object-alice\",\n \"$delta\": [firstName]\n }\n },\n {\n \"link\": \"/views/personSDF/updates/1\",\n \"offset\": 1,\n \"object\": {\n \"firstName\": \"Bob\",\n \"$type\": \"person\",\n \"$id\": \"object-bob\",\n \"$delta\": [firstName]\n }\n }\n]If you don’t wish to keep track of the offset yourself, you can use an iterator instead by passing the iterator query parameter. The Domain Object API will maintain the offset for you. An iterator is identified by its name (myiterator in the example below), and you can use any number of iterators.
$ curl -X GET 'https://doapi.almato.com/views/personSDF/updates?iterator=myiterator&count=1' \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'[\n {\n \"link\": \"/views/personSDF/updates/0\",\n \"offset\": 0,\n \"object\": {\n \"firstName\": \"Alice Liddell\",\n \"$type\": \"person\",\n \"$id\": \"object-alice\",\n \"$delta\": [firstName]\n }\n }\n]$ curl -X GET 'https://doapi.almato.com/views/personSDF/updates?iterator=myiterator&count=1' \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'[\n {\n \"link\": \"/views/personSDF/updates/1\",\n \"offset\": 1,\n \"object\": {\n \"firstName\": \"Bob\",\n \"$type\": \"person\",\n \"$id\": \"object-bob\",\n \"$delta\": [firstName]\n }\n }\n]To reset the offset for an iterator, use the query parameter offset together with iterator. For example:
$ curl -X GET 'https://doapi.almato.com/views/personSDF/updates?iterator=myiterator&offset=0&count=0' \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'[]$ curl -X GET 'https://doapi.almato.com/views/personSDF/updates?iterator=myiterator&count=1' \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'[\n {\n \"link\": \"/views/personSDF/updates/0\",\n \"offset\": 0,\n \"object\": {\n \"firstName\": \"Alice Liddell\",\n \"$type\": \"person\",\n \"$id\": \"object-alice\",\n \"$delta\": [firstName]\n }\n }\n]Updates can also be read using websockets. This is described under \"Subscribe to notifications\" below.
\nRecall that when writing a domain object by doing PUT /views/<view-id>/objects/<object-id>, the response is a transaction. To get the current state of a transaction, e.g., to determine if the transaction has completed or if there were errors, do GET /views/<view-id>/transactions/<transaction-id>. The transaction contains a field link that links to itself.
$ curl -X PUT https://doapi.almato.com/views/personSDF/objects/object-alice \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json' \\\n -d'{\"$type\": \"person\", \"firstName\": \"Alice\"}'{\n \"link\": \"/views/personSDF/transactions/8cdc0cd4-2cb5-4dd9-a835-5e46881250ee\",\n \"object\": \"/views/personSDF/objects/object-alice\",\n \"status\": \"waiting\",\n \"requestedAt\": 1563885381195,\n \"updatedAt\": 1563885381195,\n \"startedAt\": -1,\n \"errors\": []\n} $ curl -X GET https://doapi.almato.com/views/personSDF/transactions/8cdc0cd4-2cb5-4dd9-a835-5e46881250ee \\\n -k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json'{\n \"link\": \"/views/personSDF/transactions/8cdc0cd4-2cb5-4dd9-a835-5e46881250ee\",\n \"object\": \"/views/personSDF/objects/object-alice\",\n \"status\": \"done-success\",\n \"requestedAt\": 1563885381195,\n \"updatedAt\": 1563885381197,\n \"startedAt\": 1563885381197,\n \"errors\": []\n}In this example, the transaction completed successfully (the status field has value done-success). If a transaction is not yet started, the status is waiting; if it is started but not finished, the status is processing; and if it is finished but there were errors, the status is done-failure. In the case of errors, these can be read from the errors fields.
Updates to domain objects and to transaction can be received over websocket in addition to the normal HTTP calls described in above sections. To do this, a subscription to a notification must be set up. The subscription is an entity maintained by the Domain Object API and is used to keep track of which notifications that has been sent to the client and which notifications are outstanding. Thus, a client can disconnect the websocket connnection to the Domain Object API and reconnect at some later point in time without missing any notifications.
\nCreate a subscription to listen the updates to domain objects:
\n$ curl -X POST https://doapi.almato.com/views/personSDF/notifications \\\n-k -H'Authorization: Bearer <TOKEN>' -H'Content-type: application/json' \\\n-d'{\"type\": \"update.received\"}'{\n \"link\": \"/views/personSDF/notifications/bc875e8d-94e4-4172-a72e-3fb6425b6ecf\",\n \"type\": \"update.received\",\n \"filter\": {},\n \"context\": null\n}The type fields provided in the request body determines what type of notification to subscribe to; update.received subscribes to domain object updates, transaction.done-success subscribes to successfully completed transactions, and transaction.done-failure subscribes to transactions that failed.
To read the actual notifications emitted by the above subscription, connect with websocket to https://doapi.almato.com/views/personSDF/notifications/bc875e8d-94e4-4172-a72e-3fb6425b6ecf/ws and provide the security token using Authorization: Bearer <token> in the header, just like when accessing the Domain Object API using HTTP.
A client can receive updates over websockets by creating a notification on POST https://doapi.almato.com/views/<viewid>/notifications. The REST server keeps track of updates that the client hasn’t received yet and sends those as soon as the client connects to https://doapi.almato.com/views/<viewid>/notifications/<id>/ws. In other words, a client can disconnect from the server and be sure that no notifications are missed.
The /views/<viewid>/updates?iterator=… endpoint provides similar functionality, however, the client must make a GET request to get updates. This is a polling mechanism while notifications are a push mechanism.
An emitted notification looks like:
\n {\n \"link\": <link to the notification subscription>,\n \"context\": <the string passed to 'context' when the notification subscription was created>,\n \"timestamp\": <time when the notification was emitted>,\n \"data\": <the actual data for the notification, e.g., updated domain object>\n}A notifiation subscription is created by doing POST /views/<viewid>/notifications with the following body:
{\n \"type\": <one of 'update.received', 'transaction.done-success', and 'transaction.done-failure'>,\n \"filter\": {<attribute>: <valule>},\n \"context\": <any string, will be passed back to client in every emitted notification>\n }The filter matches in a similar fashion as query parameters on the REST API and is applied to the data field on the emitted notification.
Though the primary use of notification is to receive updates to domain objects, there are a few more use-cases. The type field on the notification says when and what to emit. There are three notification types described below.
This notification is emitted when a change on a domain object is received. The emitted notification contains the change itself.
\nThis notification is emitted when a transaction (domain object write) has been completed successfully.
\nThis notification is emitted when a transaction failed to complete it for some reason.
\nAny API request requires an access token from Bardioc™ and once the token is obtained, the Bardioc™ backend\nwill always check whether the token is valid or not, whether the API request is to be granted or\ndenied. The access token contains the details of the user and application that is accessing the API.
\nIn Bardioc, the Auth API is used to obtain access tokens. When\na developer creates an application, the application needs to authenticate with the Auth API so that\nproper access can be granted to that application.
\nAs explained in more detail in the Authentication article, Bardioc provides 2 types of authentication flows:\npassword flow and UI flow.
\nIn Bardioc, data and access is governed by means of roles (or permission groups). Each account created will\nbe assigned to one or multiple roles. In Bardioc, the creation of roles provides two purposes:
\nto grant permissions to access data
\nto provide role-based control of available features and flows in the user interfaces.
\nBy default, for any Bardioc customer there is always one role defined that represents the whole customer\norganization (e.g. customer-domain.com). Data owned by this organization-wide role is available to all\nmembers of the organization. Customers may partition their data into multiple roles, e.g. per division\nor team, if data access should be further restricted. For example, team-based roles might be called\n it.customer-domain.com, hr.customer-domain.com, and finance.customer-domain.com.
\nUsers are also assigned IAM roles according to their user role in the Bardioc user interface, i.e.:
\nKnowledge Expert: knowledge-expert
Subject Matter Expert (SME): implicitly specified by absence of knowledge-expert role
Administrator: org-admin
As such, new user accounts are automatically assigned to the organization role (all members), and\nhave the SME role for the user interface, unless configured differently by the administrator.
\nData access is determined on a per-vertex level in Bardioc. In general, for most entity types the allowed\ndata access operations (whether creating, reading, updating or deleting) are determined by the vertex\nattibutes below:
\nogit/_owner=<account_or_role> \t: For the data to be shared (read and write)
\nogit/_reader=<account_or_role>\t: For data to be shared (read only)
\nIf the ogit/_owner attribute of a vertex contains a specific account name, only this user has read/write\naccess to this vertex. Be careful when you want to restrict data access to a single user account.\nTypically, the ogit/_owner attribute is set to a data access role of the whole organisation or a team\n(see above). In this case, any account that is assigned the role specified in the owner attribute will\nhave read/write access to that vertex. This user can modify the vertex and even delete the vertex.
In the same way, any account associated with the role specified in the ogit/_reader attribute will\nhave read permission for that vertex.
Attention: By default, if a vertex is created without specifying the ogit/_owner attribute, the owner\nwill be set to the account id of the creator, and the vertex will be accessible only to this user. Ensure\nthat you set the owner attribute correctly if you want other users (and the Bardioc Engine!) to see the data.
Each application using the Bardioc API needs to be registered and gets assigned an application key, consisting\nof client_ID and client_secret. This means that the username and password are used to identify and\nauthenticate the user, while the application key (consisting of client_ID and client_secret) is used to\nidentify the application.\nDuring the authentication flow, the application passes along the application key together with the user\ncredentials, and access tokens are always issued for the specific combination of user and application.
\nBy design, access tokens will expire after a few hours. If the access token is expired, Bardioc will return\nthe proper response (e.g. HTTP status code 401) to the application and the application must retrigger the\npassword flow in to receive the access token.
\nThe Bardioc libraries for Java and Javascript handle most token related operations internally when the\nproper settings are initialized.
\nAn example for non-UI applications are Connectors. Connectors transfer data from a customer’s existing\nsystem to Bardioc. Connectors are normally run as a backend service without dedicated user interface.
\nThe app identifiers (client_id and client_secret) will be provided and used for all API\ninteractions of the connector. As a best practice, a separate service user account should be registered\nfor each connector, so that the origin of data can be traced.
\nThe Bardioc Desktop framework provides an infrastructure to host different browser\napplications on the platform. So the web applications are hosted on the Bardioc ™\nSaaS Cloud and are delivered to the user’s web browser. The Bardioc Desktop framework\nalso takes care of listing and launching the available apps, handling the user\nlogin flows, and managing user sessions.\nBy running the UI applications inside the Bardioc Desktop framework, access tokens\nare fully-handled by the framework, which means that developers do not have to\nmanage the access tokens.
\nHowever, as a UI app developer, you need to take care of data access permissions by\nsetting the data owner (and reader) correctly when a vertex is created by the\napplication. An example would be when a Bardioc Desktop application has an input\nform for a user to enter data into Bardioc. The application needs to ensure to set\nthe ogit/_owner attribute on the new vertices correctly to the data access role\n(permission group) that should have read/write permissions.
When designing a new applications, the developer needs to consider and plan the\nintended data access permissions, and then implement it consistently.
\nHead over to Bardioc Auth API for examples on how to get a token.
\nIn most cases, when developing Connectors, the Graph REST API will be used.\nHowever, there are also other types of APIs that can be utilised, i.e. the Websocket API\nand Event Stream. For Websocket API and Event Stream, a special handling of\naccess tokens and token refresh is required. Websocket connections may stay active\nlonger than the token lifetime. Therefore, the Websocket API supports a mechanism\nto refresh expired tokens.
\nFor more information on the access token for Websocket API and Event Stream,\nplease refer to the Bardioc Websocket API Reference.
\nWhen data is injected to Bardioc™ by Connectors, this data should typically be\nprocessed by the Bardioc™ Engine for automation of tasks. Hence, to ensure that\nthe Bardioc™ Engine can access and work with the data injected by the Connector,\nit is important to set the ogit/owner attribute correctly when creating the\nvertices. As long as there are no special data access requirements, it is a good\npractice to set the the ogit/_owner field to the data access role of the\ncompany (e.g. _customer-domain.com). This will ensure that the Bardioc™ Engine can\nprocess the data, and that your end users can view the data in the Bardioc™ frontend.
The AskApprove capability allows decisions to be made by an \"Approver\" on whether a Task should be completed or not, and allows them to provide extra information into the Task based on a pre-defined template in the KI.
\nThe Approval Action Handler requires use of an Approval UI Application in Bardioc Desktop. For users to gain access to this application they must be part of the Task Approver Team, haasXXXXX_task_approver, for the given instance. Membership of the Team can be provided in Almato ID by an Organizational Admin.\nThe Approval Action Handler uses the SendEmail capabilities.
ki\n name: \"Approve Sample\"\n description: \"KI will ask approval\"\n version: \"1\"\non\n ogit/_id\nwhen\n ProcessIssue==\"true\"\n ogit/_id\ndo\n LOCAL::model = '{\n \"action\":\"approve\",\n \"task\":\"The task needs to be approved (Title)\",\n \"template\":\"Abhi test approval (Body)\",\n \"controls\":[\n {\n \"approve\":{\"/approve\":\"true\"},\n \"reject\":{\"/approve\":\"false\"}\n }\n ]\n }'\n exec: LOCAL::RESULT,\n stdout: LOCAL::OUTPUT,\n stderr: LOCAL::ERROR,\n exit: LOCAL::SYSTEMRC = action(\n capability: \"AskApprove\",\n user_email: \"consult@org.com\",\n issue_id: ISSUE::ogit/_id,\n question_model: model\n )\n log.info(LOCAL::RESULT)\n log.info(LOCAL::OUTPUT)\n log.error(LOCAL::ERROR)\n log.info(LOCAL::SYSTEMRC)\n\n delete(ProcessIssue)\n eject_issue(message: \"Wait for approve\", issue_id: ISSUE::ogit/_id)The capability should be set to AskApprove
The user_email is the recipient email address
The questions structure is defined in LOCAL::model (see below)
Before the Approval Email is sent, the KI should eject_issue. This puts the Task into a WAITING state. The Approval UI will then return the KI to PROCESSING. If the Task is not put into WAITING, the UI will not show the Task.
{\n \"action\": \"<ACTION>\",\n \"task\": \"<TASK>\",\n \"template\": \"<TEMPLATE>\",\n \"controls\": [ <CONTROL>, <CONTROL>, ...]\n}\"action\": \"<ACTION>\" The user friendly name of the action the user will perform, ie \"Approve\".
\"task\": \"<TASK>\" The user friendly name of the task the user will perform the action on, ie \"Add User to Security Group\".
\"template\": \"<TEMPLATE>\" The user friendly description of the task.
\"controls\": [ <CONTROL>, <CONTROL>, …] The array of questions / inputs the user needs to provide. The controls array can contain one or more <CONTROL> objects.
The <CONTROL> object is a single, or block of input questions for the user. These can be: \"Approve or Reject\", Text Inputs, or Dropdown Options.
The \"Approve or Reject\" object the only required object, and all other inputs will be available only if the user selects \"Approve\".
\n![\"Title\"](\"/7.0/images/actionhandler/approval_title.png\")
\nEach Control Object specifies which format to ask the question, and what data to save to the AutomationIssue Node.
\nFor \"Approve or Reject\" or Dropdown Options, the data is defined as a DataObject which will be saved directly into the AutomationIssue if the option is selected by the user. The DataObject’s key is the Attribute Name, and the value is the value to be saved in the graph. The DataObject can be empty, or have one or more Attribute Mappings.
\nFor Text options, the value is the Attribute Name, the user’s input will be saved to.
\nThe Control Object can be used for either the Approval or Rejection flow. By default they are for the Approval flow, but a key for can be specified to allow the Control Object to used in the Rejection flow.
{\n ..., //Control Object Parameters\n \"for\": \"reject\"\n}The Control Object can also be either required or optional. By default they are required, but a key required can be specified to allow this to be configurable.
{\n ..., //Control Object Parameters\n \"required\": false\n}{\n \"approve\": { \"/attribute\": \"value1\" },\n \"reject\": { \"/attribute\": \"value2\" }\n}\"approve\": Holds the DataObject to be saved on approval.
\"reject\": Holds the DataObject to be saved on rejection.
![\"Approve](\"/7.0/images/actionhandler/approval_approve.png\")
\n{\n \"text\": \"/attribute\"\n}\"text\": Holds the string Attribute Name, the user’s input will be saved to.
![\"Text](\"/7.0/images/actionhandler/approval_text2.png\")
\n{\n \"text\": [\n \"/attribute1\",\n \"/attribute2\"\n ]\n}\"text\": Holds an array of string Attribute Namea, the user’s inputs will be saved to.
\n{\n \"text\": { \"Example Label\": \"/attribute\" }\n}\"text\": Holds an object, Label to Attribute Name, the user’s input will be saved to.
{\n \"text\": {\n \"Example Label 1\": \"/attribute1\",\n \"Example Label 2\": \"/attribute2\"\n }\n}\"text\": Holds an object, Label to Attribute Name, the user’s input will be saved to.
{\n \"text\": \"/attribute\",\n \"header\": \"Header Text\",\n \"desc\": \"Description Text\",\n}\"header\": Optional Header text for this section.
\"desc\": Optional Description text for this section.
{\n \"options\": {\n \"Option1 Name\": { \"/attribute\": \"option_1_value\" },\n \"Option2 Name\": { \"/attribute\": \"option_2_value\" }\n }\n}\"options\": Holds an object, which contains Key, Dropdown Option Name, to the DataObject to be saved on selection.
There can be multiple Key, Value options.
\n![\"Dropdown](\"/7.0/images/actionhandler/approval_options1.png\")
\n{\n \"options\": {\n \"Option1 Name\": { \"/attribute\": \"option_1_value\" },\n \"Option2 Name\": { \"/attribute\": \"option_2_value\" }\n },\n \"header\": \"Header Text\",\n \"desc\": \"Description Text\",\n}\"header\": Optional Header text for this section.
\"desc\": Optional Description text for this section.
CSV ActionHandler converts an existing CSV file from the Bardioc Graph (blob on ogit/Attachment) to a proper JSON formatted table, represented by an ogit/Document/Spreadsheet. In this guide we will walk through the process from adding an attachment to Quering the JSON formated table created by CSV ActionHandler.
\nAuthenticate and retrieve a Graph Authentication token. Please refer to our documentation on Bardioc Graph Auth API.
\nId for the 'data-scope' (environment) you want to interact with. This value will be written to the ogit/_scope attribute. If omitted the default scope of your account will be used. Please be aware, that this may lead to confusion if your account has access to multiple scopes. Therefore, it’s highly recommended defining your desired scope.
\nHaving a CSV file as an attachment in the Bardioc graph. Please see below to create an attachment vertex and load the CSV data.
\nIn case you do not have an attachment vertex in the graph yet, a simple curl command is given below. Please refer to Bardioc Graph REST API to know more about the API. In the following command replace <TOKEN> and <SCOPE_ID>. In this document we run our requests against the stage graph, replace the url with https://core.test.engine.datagroup.de/ for global graph. When a valid scope and token is used, you are presented with a response. Make a note of \"ogit\\/_id\", this will be used in the steps to follow.
\ncurl -k --request POST --url https://eu-stagegraph.almato.com/api/graph/7.1/new/ogit%2fAttachment --header 'Authorization: Bearer $TOKEN' --header 'Content-Type: application/json' --data '{\"/name\": \"CSV\", \"ogit/_scope\": \"<SCOPE_ID>\"}'In this section we load the CSV data into the attachment created in the previous section. In the following curl command replace <ID> with \"ogit\\/_id\" from the previous step. The response is the contentId of the attachment. Please note, maximum size of csv file should not be bigger than maximum size of the vertex.
\ncurl --request POST --url https://eu-stagegraph.almato.com/api/graph/7.1/<ID>/content --header 'Authorization: Bearer $TOKEN' --header 'Content-Type: text/csv'\n--data 'h1,h2,h3,h4\n> 1,2,3,5\n> 6,7,8,9\n> 10,11,12,13'The table given below consists of parameters that can be used in the KI to achieve the desired structure of JSON.
\n| Parameter | \nDescription | \n
|---|---|
keys (optional) | \nIdentifier if keys are represented by rows or columns, default being row. Expected values: row or column. | \n
colOffset (optional) | \nOffset rows of the table. Entries before the offset are ignored. Default: 0 | \n
rowOffset (optional) | \nOffset columns of the table. Entries before the offset are ignored. Default: 0 | \n
delimiter (optional) | \nDelimiting character. Default:, or Comma | \n
In the following KI example, we use the default parameter values. When an issue with variable ConvertToSpreadsheet and SourceId is created, this KI is triggered and the corresponding CSV is converted to JSON.
on\n ogit/_id\nwhen\n ConvertToSpreadsheet\n SourceId\ndo\n code: LOCAL::STATUS,\n body: LOCAL::RESULT = action(\n capability: \"CSVtoSpreadsheet\",\n sourceId: SourceId\n )\n if LOCAL::STATUS == \"200\" then\n log(\"SUCCESS: Your CSV is has been formated ${LOCAL::RESULT#result}\")\n TargetId = \"${LOCAL::RESULT#result['target_id']}\"\n\tdelete(ConvertToSpreadsheet)\n else\n log(\"ERROR ${LOCAL::STATUS}: ${LOCAL::RESULT}\")\n endlog SUCCESS: Your CSV is has been formated {\"target_id\": \"${TARGET_ID}\"}\nYou can modify the KI to use column as identifier:
\ndo\n code: LOCAL::STATUS,\n body: LOCAL::RESULT = action(\n capability: \"CSVtoSpreadsheet\",\n sourceId: SourceId,\n keys: \"column\",\n )\n
On successful execution of the KI, you were presented with the TARGET_ID which holds the ogit/_id of the created ogit/Documents/Spreadsheet node.\nThis node holds the JSON fomated CSV.
\n Row \n | \n\n Column \n | \n
\n \n \n | \n\n \n \n | \n
The SendEmail capability is designed to send either a HTML or Plain email to one or more pre-defined recipients.
\nki\n name: \"Send an email\"\n description: \"Send an email\"\n version: \"1\"\non\n ogit/_id\nwhen\n ShouldSendEmail==\"true\"\ndo\n exec: LOCAL::RESULT,\n stdout: LOCAL::OUTPUT,\n stderr: LOCAL::ERROR,\n exit: LOCAL::SYSTEMRC = action(\n capability: \"SendEmail\",\n from: \"user@example.com\",\n to: \"user@example.com\",\n subject: \"Hello\",\n body: \"Hey dear customer! Click <a href=\\\"http://example.com\\\">this link</a>\",\n type: \"html\")\n log.info(LOCAL::RESULT)\n log.info(LOCAL::OUTPUT)\n log.error(LOCAL::ERROR)\n log.info(LOCAL::SYSTEMRC)\n delete(ShouldSendEmail)The capability should be set to SendEmail
The from email address needs to be authorised on the SMTP server with the SMTP credentials provided.
The to is the recipient email address. cc and bcc can also be provided
The body is the email content, and can be Plain or HTML
The type should be set to plain or html depending on the email body content
The csv connector ships with every Bardioc instance and enables you to create Automation issues and upload environment and monitoring data.\nIt makes use of Bardiocs Rest API using CSV files as input. We’ve put together sample csv files for each scenario to help you get started.
\nA token is mandatory to use any of the capabilities the csv connector offers. To retrieve a token, you must run a Post request against https://core.test.engine.datagroup.de/api/auth/6/app.
\n{\n \"client_secret\": \"ffc55c735c79d22441e941b09fbe9afbda839dc12012b7bd37f9d88b54fd13add74fdef8abf8194e9729a281bfbe68935950fef7a9dd690827082fc611f68492\",\n \"client_id\": \"cju16o7cf0000mz77pbwbhl3q_ckkwosk448atc01543wvzxvb4\",\n \"username\":\"\",\n \"password\": \"\"\n}Username and password is created for every Bardioc 7 instance that is provisioned for you. The login information is generated and can be found on id.almato.com. The organisation admin will be able to change the pregenerated password for the user that is called haas*-csv-connector.\nThe scope id, an id that identifies which Bardioc 7 instance the csv content can be found doing a GET request with the token from the username above against https://core.test.engine.datagroup.de/api/auth/6/me/account?profile=true\nThe scope can be found in \"ogit/Auth/Account/defaultScope\"
\nThe CSV Connector works with HTTP requests. All capabilities share the same base url (https://api.bardioc.almato.com/function/csv-connector) followed by the action after the slash, such as /vertices /edges /timeseries or /attachments. You can either run those request from command line or any tool of your choice (such as postman for instance)
\nPlease make sure to add the following header information to your requests
\nx-forwarded-authorization: Bearer ${your_token}\ncontent-type: text/csv\nAdditional header parameters control details of csv handling within the connector:
\n| Header | \nDescription | \n
|---|---|
| \nSet the csv dialect for the csv parser ( | \n
| \nBoolean value. When set to | \n
| \nTake the string given here as null keyword to set attributes for Bardioc explicitly to None. | \n
With the token in hand you can run a POST request against.
\nusing the following sample CSV file. Please make sure to add a value for scope. If you want to create more than one object, you can add more lines to the csv file.\nKeep in mind POST does not allow you to update existing objects. Please use a PUT request if you want to update.
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/MARS/Machine/class\",\"ogit/name\",\"ogit/MARS/Software/class\",\"ogit/MARS/Software/subClass\",\"ogit/_scope\"\n\"machine1\",\"ogit/MARS/Machine\",\"Linux\",\"machine a\",\"\",\"\",\"cjuwixjvq0xfc1q90xqn8jsvf_ckcd798hd7bji0r882l764ebl\"\n\"software1\",\"ogit/MARS/Software\",\"\", \"Software A\",\"DBMS\",\"MariaDB\",\"cjuwixjvq0xfc1q90xqn8jsvf_ckcd798hd7bji0r882l764ebl\"With the token in hand you can run a POST request against\nhttps://api.bardioc.almato.com/function/csv-connector/vertices
\nusing the following sample CSV file. Please make sure to add a value for scope and origin node. The origin node defines where the issue is bound to first, where knowledge can be applied (if available). If you do not have an origin Node, please check part 1 where we show you how to create one.
\n\"ogit/subject\",\"ogit/Automation/originNode\",\"/ProcessIssue\",\"ogit/_type\",\"ogit/_scope\"\n\"This is a test Issue\",\"node_id\",\"process_me\",\"ogit/Automation/AutomationIssue\",\"scope_id\"With the token in hand you can run a PUT request against\nhttps://api.bardioc.almato.com/function/csv-connector/combined
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/MARS/Machine/class\",\"ogit/name\",\"ogit/MARS/Software/classv,\"ogit/MARS/Software/subClass\",\"ogit/_scope\",\"issue:0:ogit/subject\",\"\"issue:0:/ProcessIssue\"\n\"machine1234\",\"ogit/MARS/Machine\",\"Linux\",\"machine a\",\"\",\"\",\"cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7\",\"\",\"\"\n\"software1123\",\"ogit/MARS/Software\",\"\",\"Software A\",\"DBMS\",\"MariaDB\",\"cjy5tvdfx0nkq1o7040e4mow0_ckd73u0ul04jo01100j5dppq7\",\"test issue\",\"processme\"With the token in hand you can run a POST request against\nhttps://api.bardioc.almato.com/function/csv-connector/edges
\nusing the following sample CSV file.
\n\"from:ogit/_xid\",\"verb\",\"to:ogit/_xid\"\n\"software1\",\"ogit/dependsOn\",\"machine1\"With the token in hand you can run a PUT request against\nhttps://api.bardioc.almato.com/function/csv-connector/combined
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/MARS/Machine/class\",\"ogit/name\",\"ogit/MARS/Software/class\",\"ogit/MARS/Software/subClass\",\"ogit/_scope\",\"edge:0:verb\",\"edge:0:direction\",\"edge:0:vertex_xid\"\n\"machine1\",\"ogit/MARS/Machine\",\"Linux\",\"machine a\",\"\",\"\",\"cjuwixjvq0xfc1q90xqn8jsvf_ckcd798hd7bji0r882l764ebl\",\"\",\"\",\"\"\n\"software1\",\"ogit/MARS/Software\",\"\",\"Software A\",\"DBMS\",\"MariaDB\",\"cjuwixjvq0xfc1q90xqn8jsvf_ckcd798hd7bji0r882l764ebl\",\"ogit/dependsOn\",\"out\",\"machine1\"First create a timeseries node\nWith the token in hand you can run a POST request against\nhttps://api.bardioc.almato.com/function/csv-connector/vertices
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/name\",\"ogit/_scope\"\n\"timeseries\",\"ogit/Timeseries\",\"tsname\",\"scopeid\"Then
\nWith the token in hand you can run a PUT request against\nhttps://api.bardioc.almato.com/function/csv-connector/timeseries
\n\"ogit/_xid\",\"timestamp\",\"value\"\n\"timeseries\",\"1442235678000\",\"45\"Feedback is provided if the csv file was processed successfully and how many objects of each type were populated.
\nA hard stop occurs incase the reading of a csv file encounters a malformed entry and the error is not recoverable. All items before the error will be processed.
\nIf the error is recoverable, an error message with status \"fail\" will be put onto the result data and the operation will continue.
\nSpecifications of the format of csv data so the CSV connector can parse the data correctly. Parsing is based of\nPythons' csv package.
\nGeneral format
\nThe encoding is UTF-8.
\nThe separator is a comma ,.
Each row must have the same number of values.\nRows must be filled with empty values if necessary.
\nEach value in the CSV must be enclosed in double-quotes ".\nQuotes are escaped via doubling, i.e. "I am ""quoted"".".
The CSV has to have a header row.\nFor vertices these are the ogit attribute names.
\nThe CSV will be transformed using Pythons' csv package with a special dialect called default (unless configured otherwise in header parameter x-connector-csv-dialect).\nThe settings for this dialect are:\nquoting=csv.QUOTE_ALL, skipinitialspace=True, strict=True
Each row below the header specifies a set of values for one entity (vertex, edge, timeseries or attachment).
\nThe strings parsed from each cell can be interpreted as JSON when header parameter x-connector-csv-json-strings is enabled.\nThe values of the CSV will then be enclosed in quotes and run through json.loads(escaped_value).\nIf this is set to true, special characters like \\, ", line-breaks or tabulator characters need to be properly escaped for JSON and remember that you still have to quote the " for CSV as well.
Examples of a CSV cell
\nwithout JSON Strings:
\n\"Hello \"\"friend\"\",\nhow are you? Look at C:\\Users\\Foo\\\"\n
with JSON Strings:
\n\"Hello \\\"\"friend\\\"\",\\nhow are you? Look at C:\\\\Users\\\\Foo\\\\\"\n
Format of the CSV data for vertices
\nRelevant REST endpoints:
\nPOST https://api.bardioc.almato.com/function/csv-connector/vertices\nPATCH https://api.bardioc.almato.com/function/csv-connector/vertices\nPUT https://api.bardioc.almato.com/function/csv-connector/vertices\nDELETE https://api.bardioc.almato.com/function/csv-connector/verticesThe header row contains ogit attribute names.
\nAn empty value "" in a row tells the connector to ignore the attribute specified by that column for this row instead of setting it to an empty value.
A string value of "null" (or whatever is currently configured in header parameter x-connector-csv-null-keyword) in a row will make the connector set the attribute specified by that column explicitly to JSON null.\nThis is needed to remove attributes of a vertex on an update.
Headers that start with xid: and contain ogit/_xid values are resolved to ogit/_id by querying Bardioc.
Example:
\nxid:ogit/Automation/originNode would treat all values below as ogit/_xid and resolve them to ogit/_id before using them as attribute ogit/Automation/originNode in the vertices to create or update.
Headers that start with =, + or - denote map value entries (see Bardioc attribute specification).\nValues within these columns are directly interpreted as JSON.
Example:
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/MARS/Machine/class\",\"ogit/name\",\"ogit/MARS/Machine/ram\",\"/admin_contact\"\n\"machine4\",\"ogit/MARS/Machine\",\"Linux\",\"machine 4\",\"2G\",\"info@admin.co\"\n\"machine5\",\"ogit/MARS/Machine\",\"Linux\",\"machine 5\",\"4G\",\"contact@admin.co\"\n\"machine6\",\"ogit/MARS/Machine\",\"Linux\",\"machine 5A\",\"8G\",\"info@admin.co\"\n\"machine7\",\"ogit/MARS/Machine\",\"Linux\",\"machine 4A\",\"4G\",\"contact@admin.co\"Format of the CSV data for edges
\nRelevant REST endpoints:
\nPOST https://api.bardioc.almato.com/function/csv-connector/edges\nDELETE https://api.bardioc.almato.com/function/csv-connector/edgesThe CSV has to have three headers:
\nfrom:ogit/_id or from:ogit/_xid
verb The ogit verb for the edge
to:ogit/_id or to:ogit/_xid
Example:
\n\"from:ogit/_xid\",\"verb\",\"to:ogit/_xid\"\n\"crew:NCC-1701-D:picard\",\"ogit/Forum/mentions\",\"crew:NCC-1701-D:data\"Format of the CSV data for timeseries
\nRelevant REST endpoints:
\nPUT https://api.bardioc.almato.com/function/csv-connector/timeseriesThe CSV has to have three headers:
\nogit/_id or ogit/_xid
timestamp for ms since epoch or time for an ISO time
value for the value for this timestamp.
Example:
\n\"ogit/_xid\",\"timestamp\",\"value\"\n\"timeseries:machine4\",\"1442235678000\",\"45\"\n\"timeseries:machine4\",\"1442235944000\",\"43\"\n\"timeseries:machine5\",\"1442235678000\",\"51\"\n\"timeseries:machine5\",\"1442235944000\",\"48\"or two headers:
\nogit/_id or ogit/_xid
items for a JSON list of objects containing the keys (timestamp or time) and value.
Example:
\n\"ogit/_xid\",\"items\"\n\"timeseries:machine4\",\"[{\"\"timestamp\"\": \"\"1442235678000\"\", \"\"value\"\":\"\"45\"\"},{\"\"timestamp\"\": \"\"1442235944000\"\", \"\"value\"\":\"\"51\"\"}]\"\n\"timeseries:machine5\",\"[{\"\"timestamp\"\": \"\"1442235678000\"\", \"\"value\"\":\"\"43\"\"},{\"\"timestamp\"\": \"\"1442235944000\"\", \"\"value\"\":\"\"48\"\"}]\"Format of the CSV data for attachments
\nRelevant REST endpoints:
\nPUT https://api.bardioc.almato.com/function/csv-connector/attachmentsThe CSV needs the following headers:
\nogit/_id or ogit/_xid
One of the following headers is required for the content of the attachment:
\ncontent:text: Content to upload as simple text in UTF-8.
content:base64: Content to upload as base64 encoded binary data.
content:mimetype: (optional) Content-Type of the content.
Example:
\n\"ogit/_xid\",\"content:mimetype\",\"content:text\",\"content:base64\"\n\"attachment:almato:test:0:lorem-ipsum\",\"text/plain\",\"Auch gibt es niemanden, der den Schmerz an sich liebt, sucht oder wünscht, nur, weil er Schmerz ist, es sei denn, es kommt zu zufälligen Umständen, in denen Mühen und Schmerz ihm große Freude bereiten können.\n\nUm ein triviales Beispiel zu nehmen, wer von uns unterzieht sich je anstrengender körperlicher Betätigung, außer um Vorteile daraus zu ziehen? Aber wer hat irgend ein Recht, einen Menschen zu tadeln, der die Entscheidung trifft, eine Freude zu genießen, die keine unangenehmen Folgen hat, oder einen, der Schmerz vermeidet, welcher keine daraus resultierende Freude nach sich zieht? Auch gibt es niemanden, der den Schmerz \",\"\"\n\"attachment:almato:test:1:lorem-ipsum\",\"text/plain\",\"\",\"QXVjaCBnaWJ0IGVzIG5pZW1hbmRlbiwgZGVyIGRlbiBTY2htZXJ6IGFuIHNpY2ggbGllYnQsIHN1\nY2h0IG9kZXIgd8O8bnNjaHQsIG51ciwgd2VpbCBlciBTY2htZXJ6IGlzdCwgZXMgc2VpIGRlbm4s\nIGVzIGtvbW10IHp1IHp1ZsOkbGxpZ2VuIFVtc3TDpG5kZW4sIGluIGRlbmVuIE3DvGhlbiB1bmQg\nU2NobWVyeiBpaG0gZ3Jvw59lIEZyZXVkZSBiZXJlaXRlbiBrw7ZubmVuLgoKVW0gZWluIHRyaXZp\nYWxlcyBCZWlzcGllbCB6dSBuZWhtZW4sIHdlciB2b24gdW5zIHVudGVyemllaHQgc2ljaCBqZSBh\nbnN0cmVuZ2VuZGVyIGvDtnJwZXJsaWNoZXIgQmV0w6R0aWd1bmcsIGF1w59lciB1bSBWb3J0ZWls\nZSBkYXJhdXMgenUgemllaGVuPyBBYmVyIHdlciBoYXQgaXJnZW5kIGVpbiBSZWNodCwgZWluZW4g\nTWVuc2NoZW4genUgdGFkZWxuLCBkZXIgZGllIEVudHNjaGVpZHVuZyB0cmlmZnQsIGVpbmUgRnJl\ndWRlIHp1IGdlbmllw59lbiwgZGllIGtlaW5lIHVuYW5nZW5laG1lbiBGb2xnZW4gaGF0LCBvZGVy\nIGVpbmVuLCBkZXIgU2NobWVyeiB2ZXJtZWlkZXQsIHdlbGNoZXIga2VpbmUgZGFyYXVzIHJlc3Vs\ndGllcmVuZGUgRnJldWRlIG5hY2ggc2ljaCB6aWVodD8gQXVjaCBnaWJ0IGVzIG5pZW1hbmRlbiwg\nZGVyIGRlbiBTY2htZXJ6IAo=\"Simultaneous handling of vertices, issues, edges and/or attachments
\nRelevant REST endpoints:
\nPUT https://api.bardioc.almato.com/function/csv-connector/combinedThe format of the CSV data for vertices applies here, see above.
\nEdges
\nThe format of an edge header is edge:[id]:[attribute]. [id] is an identifier to group edge commands together (most simple case: a number).\nThis [id] must not contain a : since this is used as separator.
edge:[id]:verb: (required) Verb for that edge for the vertex of the current row.
edge:[id]:direction: (\"in\"/\"out\") from the view of the current vertex of that row. \"in\" points towards, \"out\" points away from the current vertex.\nDefault is \"out\" if this column is missing.
One of the following headers is required to find the vertex to connect to:
\nedge:[id]:vertex_id: ogit/_id of the other vertex to connect to.
edge:[id]:vertex_xid: ogit/_xid of the other vertex to connect to.
Attachments
\nThe format of an attachment header is content:[attribute]:
One of the following headers is required for the content of the attachment:
\ncontent:text: Content to upload as simple text in UTF-8.
content:base64: Content to upload as base64 encoded binary data.
content:mimetype: (optional) Content-Type of the content.
Issues
\nThe format of an issue header is issue:[id]:[attribute]. [id] is an identifier to group issue commands together for multiple issues to be created. Some attributes of each issue will be set automatically:
ogit/_type: Will be set to ogit/Automation/AutomationIssue
\nogit/Automation/originNode: Will be set to the ogit/_id of the vertex that has been created on the same row.
\nExample:
\n\"ogit/_xid\",\"ogit/_type\",\"ogit/name\",\"ogit/Forum/username\",\"edge:0:verb\",\"edge:0:direction\",\"edge:0:vertex_xid\",\"edge:1:verb\",\"edge:1:direction\",\"edge:1:vertex_xid\"\n\"crew:NCC-1701-D:picard\",\"ogit/Forum/Profile\",\"Jean-Luc Picard\",\"Picard\",\"ogit/Forum/mentions\",\"out\",\"crew:NCC-1701-D:data\",\"ogit/Forum/mentions\",\"out\",\"crew:NCC-1701-D:worf\"\n\"crew:NCC-1701-D:worf\",\"ogit/Forum/Profile\",\"Worf\",\"Worf\",\"ogit/subscribes\",\"out\",\"crew:NCC-1701-D:picard\",\"\",\"\",\"\"\n\"crew:NCC-1701-D:data\",\"ogit/Forum/Profile\",\"Data\",\"Data\",\"ogit/Forum/mentions\",\"out\",\"crew:NCC-1701-D:worf\",\"ogit/subscribes\",\"in\",\"crew:NCC-1701-D:worf\"A complete API documentation is available under https://api.bardioc.almato.com/function/csv-connector/docs
\nThe Jira connector utilizes transformation maps to transform data before transmission to the Jira server and before transmission to Bardioc.
\nWhen sending information obtained from Bardioc, the Jira connector checks the transformation maps section defined in jira.endpoint.conf.xml configuration file. This transformation map will be used to transform Bardioc SDF format to a key:value pair format that can be understood by the connector’s writer mechanism when writing information to Jira.
This example defines maps for the Incident, Change and Requirement processes in the jira.endpoint.conf.xml configuration file. We can have separate mapping file for different processes or one mapping file for all processes. For simplicity reasons we use single mapping file.
<transformation>\n\t\t<maps>\n\t\t\t<map name=\"Incident\">\n\t\t\t\t<path>bardioc2jira___TOOL_MAP_SUFFIX__.map</path>\n\t\t\t</map>\n\t\t\t<map name=\"Change\">\n\t\t\t\t<path>bardioc2jira___TOOL_MAP_SUFFIX__.map</path>\n\t\t\t</map>\n \t\t\t<map name=\"Requirement\">\n <path>bardioc2jira___TOOL_MAP_SUFFIX__.map</path>\n </map>\n\t\t</maps>\n\t</transformation>When sending information obtained from Jira, the connector uses transformation maps defined in bardioc.endpoint.conf.xml configuration file. Connector transforms data coming from Jira to format understood by the connector’s writer mechanism when writing information to Bardioc.
This example defines maps for the Incident, Change and Requirement processes. Here attribute ticketPath is used to distinguish different processes in the mapping file. We will learn more about this in the next section.
<transformation>\n <maps>\n <map name=\"Incident\">\n <path>jira2bardioc___TOOL_MAP_SUFFIX__.map</path>\n <attributes>\n <attribute name=\"ticketPath\">incident</attribute>\n </attributes>\n </map>\n <map name=\"Change\">\n <path>jira2bardioc___TOOL_MAP_SUFFIX__.map</path>\n <attributes>\n <attribute name=\"ticketPath\">change</attribute>\n </attributes>\n </map>\n <map name=\"Requirement\">\n <path>jira2bardioc___TOOL_MAP_SUFFIX__.map</path>\n <attributes>\n <attribute name=\"ticketPath\">requirement</attribute>\n </attributes>\n </map>\n </maps>\n </transformation>The transformation map translates data bidirectionally. The data to be translated by the maps is different for each direction. When the data flow is from Bardioc to Jira, the source data available is determined by the Bardioc SDF view definition. A view describes how to map JSON documents to a graph structure and Vice versa.
\nWhen the data flow is from Jira to Bardioc the source data available to the transformation map is determined by the results aggregation of data from one or more Jira tables of which the field names are determined by the fields that comprise a particular table. Since data can be aggregated into hierarchical data structure the data is presented to the transformation map in a special format. The data is contained in one source field and is accessible using the [data] variable. The value of [data] is a JSON object and any mappings should use the $EVAL() function to parse the data as needed. The format of the JSON represents a hierarchical Record where Record has an id, has fields optionally has attachments, and optionally has relationship(s). A field is a representation of a key:value pair. A relationship is a representation of one or more Records that has some form of relationship to the parent Record, such as if the parent Record were an Incident and the relation was that of Records defining the Comments for the Incident.
The Record can be defined in JSON as:
\n{\n \"attachments\" [\n {\n \"path\": \"url\",\n \"creator\": \"aperson\",\n \"size\": 1234,\n \"created\": \"createdTimestamp\",\n \"name\": \"aFileName\",\n \"id\": \"attachmentId\",\n \"type\": \"mimeType\",\n \"content\": \"base64EncodedContent\"\n }\n ],\n \"id\": \"recordIdentifierSuchAsIncidentNumber\",\n \"fields\": [\n {\n \"name\": \"fieldName\",\n \"value\": \"valueOfTheField\"\n }\n ],\n \"relations\": [\n {\n \"nameOfRelation\":[\n {\n\t \"attachments\": [],\n\t \"id\": \"recordIdentifierSuchAsCommentId\",\n\t \"fields\": [\n {\n \"name\": \"fieldName\",\n \"value\": \"valueOfTheField\"\n }\n ],\n \"relations\": []\n\t }\n ]\n }\n ]\n}An example with data from Jira:
\n{\n\t\"attachments\": [{\n\t\t\"path\": \"https://edevtechdata.atlassian.net/secure/attachment/10127/test1.csv\",\n\t\t\"creator\": \"Bardioc Test User\",\n\t\t\"size\": 44,\n\t\t\"created\": \"2021-04-19T09:35:00.818-0500\",\n\t\t\"name\": \"test1.csv\",\n\t\t\"id\": \"10027\",\n\t\t\"type\": \"application/vnd.ms-excel\",\n\t\t\"content\": \"89374985739847589347589347895734897\"\n\t}],\n\t\"id\": \"DESK-401\",\n\t\"fields\": [{\n\t\t\"name\": \"key\",\n\t\t\"value\": \"DESK-401\"\n\t}, {\n\t\t\"name\": \"statuscategorychangedate\",\n\t\t\"value\": \"2021-02-16T13:31:18.405-0600\"\n\t}, {\n\t\t\"name\": \"issuetype.avatarId\",\n\t\t\"value\": \"10551\"\n\t}, {\n\t\t\"name\": \"issuetype.name\",\n\t\t\"value\": \"IT Help\"\n\t}, {\n\t\t\"name\": \"timespent\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"project.projectTypeKey\",\n\t\t\"value\": \"service_desk\"\n\t}, {\n\t\t\"name\": \"project.key\",\n\t\t\"value\": \"DESK\"\n\t}, {\n\t\t\"name\": \"customfield_10032\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"fixVersions\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.goalDuration.friendly\",\n\t\t\"value\": \"16h\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.goalDuration.millis\",\n\t\t\"value\": \"57600000\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.breachTime.iso8601\",\n\t\t\"value\": \"2021-02-18T19:31:17+0000\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.breachTime.friendly\",\n\t\t\"value\": \"18/Feb/21 7:31 PM\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.breachTime.jira\",\n\t\t\"value\": \"2021-02-18T13:31:17.490-0600\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.startTime.iso8601\",\n\t\t\"value\": \"2021-02-16T19:31:17+0000\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.startTime.friendly\",\n\t\t\"value\": \"16/Feb/21 7:31 PM\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.startTime.jira\",\n\t\t\"value\": \"2021-02-16T13:31:17.490-0600\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.elapsedTime.friendly\",\n\t\t\"value\": \"348h 5m\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.elapsedTime.millis\",\n\t\t\"value\": \"1253106414\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.remainingTime.friendly\",\n\t\t\"value\": \"-332h 5m\"\n\t}, {\n\t\t\"name\": \"customfield_10033.ongoingCycle.remainingTime.millis\",\n\t\t\"value\": \"-1195506414\"\n\t}, {\n\t\t\"name\": \"customfield_10033.name\",\n\t\t\"value\": \"Time to resolution\"\n\t}, {\n\t\t\"name\": \"customfield_10033.completedCycles\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"customfield_10033.id\",\n\t\t\"value\": \"1\"\n\t}, {\n\t\t\"name\": \"aggregatetimespent\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"customfield_10035.displayName\",\n\t\t\"value\": \"English\"\n\t}, {\n\t\t\"name\": \"customfield_10035.languageCode\",\n\t\t\"value\": \"en\"\n\t}, {\n\t\t\"name\": \"resolution\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"customfield_10037\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"resolutiondate\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"workratio\",\n\t\t\"value\": \"-1\"\n\t}, {\n\t\t\"name\": \"lastViewed\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"created\",\n\t\t\"value\": \"2021-02-16T13:31:17.490-0600\"\n\t}, {\n\t\t\"name\": \"customfield_10020\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"priority.name\",\n\t\t\"value\": \"Medium\"\n\t}, {\n\t\t\"name\": \"labels\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"customfield_10018.nonEditableReason.reason\",\n\t\t\"value\": \"PLUGIN_LICENSE_ERROR\"\n\t}, {\n\t\t\"name\": \"customfield_10018.nonEditableReason.message\",\n\t\t\"value\": \"The Parent Link is only available to Jira Premium users.\"\n\t}, {\n\t\t\"name\": \"assignee.accountId\",\n\t\t\"value\": \"5f7de2c5021acf0076f32de6\"\n\t}, {\n\t\t\"name\": \"assignee.displayName\",\n\t\t\"value\": \"Bardioc Test User\"\n\t}, {\n\t\t\"name\": \"updated\",\n\t\t\"value\": \"2021-04-19T09:35:01.374-0500\"\n\t}, {\n\t\t\"name\": \"status.name\",\n\t\t\"value\": \"Waiting for support\"\n\t}, {\n\t\t\"name\": \"timeoriginalestimate\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"description\",\n\t\t\"value\": \"test com .001\"\n\t}, {\n\t\t\"name\": \"summary\",\n\t\t\"value\": \"test com .001\"\n\t}, {\n\t\t\"name\": \"creator.accountId\",\n\t\t\"value\": \"5f7de2c5021acf0076f32de6\"\n\t}, {\n\t\t\"name\": \"creator.displayName\",\n\t\t\"value\": \"Bardioc Test User\"\n\t}, {\n\t\t\"name\": \"reporter.accountId\",\n\t\t\"value\": \"5f7de2c5021acf0076f32de6\"\n\t}, {\n\t\t\"name\": \"reporter.displayName\",\n\t\t\"value\": \"Bardioc Test User\"\n\t}, {\n\t\t\"name\": \"aggregateprogress.total\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"aggregateprogress.progress\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"environment\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"duedate\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"progress.total\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"progress.progress\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"updatedBy\",\n\t\t\"value\": \"\"\n\t}],\n\t\"relations\": [{\n\t\t\"COMMENT\": [{\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"10878\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"author.accountId\",\n\t\t\t\t\"value\": \"557058:dda9152f-9acf-4397-a25e-51f6ad954f94\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.emailAddress\",\n\t\t\t\t\"value\": \"eric.roys@techdata.com\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.displayName\",\n\t\t\t\t\"value\": \"Eric Roys\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"created\",\n\t\t\t\t\"value\": \"2021-02-16T13:32:17.089-0600\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"id\",\n\t\t\t\t\"value\": \"10878\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"body\",\n\t\t\t\t\"value\": \"Issue sent to Bardioc for processing.\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"updated\",\n\t\t\t\t\"value\": \"2021-02-16T13:32:17.089-0600\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t}, {\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"10879\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"author.accountId\",\n\t\t\t\t\"value\": \"557058:dda9152f-9acf-4397-a25e-51f6ad954f94\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.emailAddress\",\n\t\t\t\t\"value\": \"eric.roys@techdata.com\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.displayName\",\n\t\t\t\t\"value\": \"Eric Roys\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"created\",\n\t\t\t\t\"value\": \"2021-02-16T13:49:06.898-0600\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"id\",\n\t\t\t\t\"value\": \"10879\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"body\",\n\t\t\t\t\"value\": \"Bardioc unable to process. Need more knowledge\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"updated\",\n\t\t\t\t\"value\": \"2021-02-16T13:49:06.898-0600\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t}, {\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"10880\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"author.accountId\",\n\t\t\t\t\"value\": \"5f7de2c5021acf0076f32de6\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.displayName\",\n\t\t\t\t\"value\": \"Bardioc Test User\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"created\",\n\t\t\t\t\"value\": \"2021-02-16T14:08:19.100-0600\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"id\",\n\t\t\t\t\"value\": \"10880\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"body\",\n\t\t\t\t\"value\": \"Another comment\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"updated\",\n\t\t\t\t\"value\": \"2021-02-16T14:08:19.100-0600\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t}, {\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"10884\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"author.accountId\",\n\t\t\t\t\"value\": \"557058:dda9152f-9acf-4397-a25e-51f6ad954f94\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.emailAddress\",\n\t\t\t\t\"value\": \"eric.roys@techdata.com\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"author.displayName\",\n\t\t\t\t\"value\": \"Eric Roys\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"created\",\n\t\t\t\t\"value\": \"2021-02-17T04:33:51.110-0600\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"updateAuthor.accountId\",\n\t\t\t\t\"value\": \"557058:dda9152f-9acf-4397-a25e-51f6ad954f94\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"id\",\n\t\t\t\t\"value\": \"10884\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"body\",\n\t\t\t\t\"value\": \"Issue sent to Bardioc for processing.\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"updated\",\n\t\t\t\t\"value\": \"2021-02-17T04:33:51.110-0600\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t}]\n\t}]\n}An example with data from Bardioc:
\n{\n\t\"attachments\": [],\n\t\"id\": \"2919\",\n\t\"fields\": [{\n\t\t\"name\": \"summary\",\n\t\t\"value\": \"Test ticket to Bardioc .9\"\n\t}, {\n\t\t\"name\": \"sourceStatus\",\n\t\t\"value\": \"open\"\n\t}, {\n\t\t\"name\": \"bardiocStatus\",\n\t\t\"value\": \"RESOLVED\"\n\t}, {\n\t\t\"name\": \"comments\",\n\t\t\"value\": \"2919-COMMENT\"\n\t}, {\n\t\t\"name\": \"description\",\n\t\t\"value\": \"Test ticket to Bardioc .9\"\n\t}, {\n\t\t\"name\": \"$delta\",\n\t\t\"value\": \"bardiocStatus\"\n\t}, {\n\t\t\"name\": \"priority\",\n\t\t\"value\": \"4\"\n\t}, {\n\t\t\"name\": \"$type\",\n\t\t\"value\": \"incident\"\n\t}, {\n\t\t\"name\": \"$id\",\n\t\t\"value\": \"2919\"\n\t}],\n\t\"relations\": [{\n\t\t\"COMMENTS\": [{\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"8555e760-32bb-4945-8790-7b91c1a19df2\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"value\",\n\t\t\t\t\"value\": \"{\\\"Entries\\\":[{\\\"LogLevel\\\":\\\"info\\\",\\\"Message\\\":\\\"resolved\\\"}],\\\"Type\\\":\\\"finish\\\"}\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"timestamp\",\n\t\t\t\t\"value\": \"1579551276543\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t},\n\t\t{\n\t\t\t\"attachments\": [],\n\t\t\t\"id\": \"8555e760-32bb-4945-8790-7b91c1a19df3\",\n\t\t\t\"fields\": [{\n\t\t\t\t\"name\": \"value\",\n\t\t\t\t\"value\": \"{\\\"Entries\\\":[{\\\"LogLevel\\\":\\\"info\\\",\\\"Message\\\":\\\"another comment\\\"}],\\\"Type\\\":\\\"finish\\\"}\"\n\t\t\t}, {\n\t\t\t\t\"name\": \"timestamp\",\n\t\t\t\t\"value\": \"1579551276544\"\n\t\t\t}],\n\t\t\t\"relations\": []\n\t\t}]\n\t}]\n}Following are general maps used for Incident, Change and requirement transformation. Please note that, the actual (syntactically accurate) mapping is part of the connector package.
\nTransformation maps can be found in:
\nJira → Bardioc:
\n/opt/almato/connect/pluggable/plugins/bardioc/maps/jira2bardioc_TOOL_MAP_SUFFIX.map
Bardioc → Jira:
\n/opt/almato/connect/pluggable/plugins/jira/maps/bardioc2jira_TOOL_MAP_SUFFIX.map
| \n\n | \n\nWe strongly recommend NOT to change these names. If you must however, you can do so in:\n /opt/almato/connect/pluggable/plugins/bardioc/bardioc.endpoint.xml\n\n /opt/almato/connect/pluggable/plugins/jira/jira.endpoint.xml\n | \n
Source data is made available to the mapping via the 'data' field. The value of 'data' is the JSON representation of a Record as described in the Source Data section. Using JSON.parse('[data]');\nthis can be converted into JavaScript object where additional scripting can be used to obtain field values, attachments and relations as needed for mapping.
The transformation map for transformation from Incident, Change and Requirement to SDF looks as follows:
\n| \n\n | \n\nThese maps are meant for ease of modification so the map below may not be the final map.\n | \n
#*********************************************************##\n# CASE to determine which map will be used.......\n#*********************************************************##\nCASE nothing in\n *)\n GOTO MAP2Bardioc\n ;;\nESAC\n\n#*********************************************************##\n# MAP DEFINITION ##\n#*********************************************************##\n\nDEFINE MAP2Bardioc{\n\nid = $EVAL(\n var d = JSON.parse('[data]');\n\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n getFieldValue(\"key\", d.fields);\n)\n\ndata = $EVAL(\n\n var ticketType = \"[_const_ticketPath]\";\n var json = {\"$type\": ticketType};\n\n //convert json to javascript object\n var d = JSON.parse('[data]');\n\n //originNode default as jira doesn't have ci info\n json.originNode = \"machine1\";\n\n // Individual maps\n if (ticketType == \"incident\") {\n\n //associated change\n setFieldValue(\"customfield_0001.value\", \"/AssociatedChange\", d.fields);\n\n }\n\n if (ticketType == \"change\") {\n }\n\n if (ticketType == \"requirement\") {\n\n //ApprovalQuantity\n setFieldValue(\"customfield_0002\", \"/ApprovalQuantity\", d.fields, \"needed\");\n\n }\n\n // Common section for all ticket types\n\n //json.assignee = getFieldValue(\"assignment_group\", d.fields);\n json.assignee = getFieldValue(\"assignee\", d.fields);\n\n //subject\n var subject = getFieldValue(\"summary\", d.fields);\n if(subject == \"\"){ subject = \"<No Value>\"; }\n json.subject = subject;\n\n //description\n var description = getFieldValue(\"description\", d.fields);\n if(description == \"\" || description == null){\n description = getFieldValue(\"description.content\", d.fields);\n }\n // if(description == \"\"){ description = \"<No Value>\"; }\n json.description = description;\n\n //priority\n json.priority = getFieldValue(\"priority.name\", d.fields);\n\n //urgency\n json.urgency = getFieldValue(\"urgency\", d.fields);\n\n //sourceStatus\n json.sourceStatus = getFieldValue(\"status.name\", d.fields);\n\n //attachment\n var attachment = null;\n var ats = null;\n //if our data object has attachments, parse\n if((ats = d.attachments) != null){\n //attachment = ats[0].name;\n for(var i=0; i<ats.length; i++){\n var id = ats[i].id;\n var type = ats[i].type;\n var size = parseInt(ats[i].size);\n var data = ats[i].content;\n var name = ats[i].name;\n var url = ats[i].path;\n var ct = ats[i].created;\n //make sure we have necessary attribute values including the right file extension and size\n if(id != null && id != \"\" && name != null && name.endsWith(\".__TOOL_ATTACHMENT_EXTENSION__\") &&\n data != null && data != \"\" && !isNaN(size) && size > 0 ){\n if(attachment == null){ attachment = {}; }\n attachment[id] = {};\n attachment[id].name = name;\n attachment[id].url = url;\n attachment[id].type = type;\n attachment[id].size = String(size);\n attachment[id].data = data;\n attachment[id].upload_date = ct;\n }\n }\n }\n //add to the json message to send to doapi\n if(attachment != null)\n json.attachment = attachment;\n\n //add in comments\n var coms = getRelation(\"COMMENT\", d.relations).COMMENT;\n var comment = {};\n var new_comments = false;\n if(coms != null && coms != \"\"){\n var clength = coms.length;\n if(clength > 0){\n var c = getFieldValue(\"key\", d.fields) + \"-COMMENT\";\n comment[c] = {};\n var comments = [];\n for(var i=0;i<coms.length;i++){\n var id = coms[i].id;\n var com = {};\n var v = {};\n v.value = getFieldValue(\"body\", coms[i].fields);\n if(v.value == null || v.value == \"\"){\n v.value = getFieldValue(\"body.content\", coms[i].fields);\n }\n v.timestamp = Date.parse(getFieldValue(\"updated\", coms[i].fields));\n //ignore literal comment in bracket\n if(v.value.length == 9 && v.value.substring(1, (v.value.length - 1)) == \"comment\"){\n continue;\n }\n var author = getFieldValue(\"updateAuthor.accountId\", coms[i].fields);\n if(author != \"__TOOL_USER_ID__\") {\n comments.push(v);\n new_comments = true;\n }\n\n }\n comment[c].comments = comments;\n }\n if ( new_comments ) {\n json.comments = comment;\n }\n }\n\n\n /*********** FUNCTIONS ************/\n\n function setFieldValue(source, destination, object, options) {\n var myVal = getFieldValue(source, object);\n if(!myVal && options==\"needed\") {\n myVal=\"<No Value>\";\n }\n // empty fields can be deletions and need to propagate\n if(!myVal && myVal == \"\") {\n json[destination]='';\n }\n // any other values can propagate\n if(myVal) {\n json[destination]=myVal;\n }\n }\n\n\n //given a field name and field object, get a fields value\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value.replace(/\\r/g, '');\n }\n }\n //get relationObject\n function getRelation(name, relations){\n var rellength = relations.length;\n for(var i=0;i<rellength;i++){\n var rel = relations[i];\n var keys = Object.keys(rel);\n var kl = keys.length;\n for(var t=0;t<kl;t++){\n if(keys[t] == name){\n return relations[i];\n }\n }\n }\n return [];\n }\n /****** End Functions ******/\n\n result = JSON.stringify(json);\n )\n} ENDIn reading the map file, the transformation logic first looks for the CASE statement to determine which map to load. In the above mapping example here is only one possible option: MAP2Bardioc. Next the transformer logic will go to the DEFINE statement for MAP2Bardioc and evaluate each of the field mappings. To the left of = is the key (field) from Jira that will be assigned the value from the right.To the right of = is where the value can be defined. The value can be assigned from a field defined in the SDF by using the SDF field between begin and end blocks.
Fields which specific to a process is mapped in the corresponding process. In the following example, 'customfield_0001.value' which is unique to incident process is mapped to '/AssociatedChange'. Requirement process maps 'customfield_0002' to '/ApprovalQuantity'.
\n// Individual maps\n if (ticketType == \"incident\") {\n\n //associated change\n setFieldValue(\"customfield_0001.value\", \"/AssociatedChange\", d.fields);\n\n }\n\n if (ticketType == \"change\") {\n }\n\n if (ticketType == \"requirement\") {\n\n //ApprovalQuantity\n setFieldValue(\"customfield_0002\", \"/ApprovalQuantity\", d.fields, \"needed\");\n\n }\nFields which are common for all the processes are mapped outside the conditional loops.
\nThe id assignment uses the $EVAL() function, which interprets as JavaScript, whatever text is included between the parenthesis.
The $EVAL() function is defined by:
Function | \nPurpose | \nInput | \nOutput | \n
$EVAL | \nImplementation of java script allowing scripting within a java script context | \nAny source value denoted by [] may be used in the java script call | \nString | \n
\n \nExample: \n\n \n \noutputValue = $EVAL(\n var value = \"Example\";\n for(var i=0;i<10;i++){\n value += i;\n }\n result = value;\n )\n | \n|||
\n outputValue: Example0123456789 \n | \n
Function | \nPurpose | \nInput | \nOutput | \n
getFieldValue | \nTo find the value of the field to be mapped | \nJSON object | \nString | \n
\n \nExample: \n\n \n \nvar json = '{\"description\":\"Jira connector mapping example\", \"id\":42}';\nvar obj = JSON.parse(json);\nvar field = \"description\"\noutputValue = getFieldValue(field, obj){\n var x = obj.length;\n for(var i=0;i<x;i++){\n if(field == obj[i].name)\n return obj[i].value.replace(/\\r/g, '');\n }\n }\n | \n|||
\n outputValue: Jira connector mapping example \n | \n
Function | \nPurpose | \nInput | \nOutput | \n
getFieldValue | \nTo find the value of the field and to optionally assign a default value. | \nJSON object | \nString | \n
\n \nExample: \n\n \n \nvar json = '{\"customfield_0001\":\"CHG001\", \"customfield_0002\":\" \"}';\nvar obj = JSON.parse(json);\nvar field1 = customfield_0001.value\nvar dest1 = \"/AssociatedChange\"\nvar dest_json = {}\n\nsetFieldValue(field1,dest1,obj)\n\nfunction setFieldValue(source, destination, object, options) {\n var myVal = getFieldValue(source, object);\n if(!myVal && options==\"needed\") {\n myVal=\"<No Value>\";\n }\n // empty fields can be deletions and need to propagate\n if(!myVal && myVal == \"\") {\n json[destination]='';\n }\n // any other values can propagate\n if(myVal) {\n dest_json[destination]=myVal;\n }\n }\n | \n|||
\n dest_json = '{\"/AssociatedChange\":\"CHG001\"}' \n | \n|||
\n \nExample: \n\n \n \nvar json = '{\"customfield_0001\":\"CHG001\", \"customfield_0002\":\" \"}';\nvar obj = JSON.parse(json);\nvar field2 =customfield_0002\ndest2 = \"/ApprovalQuantity\"\noption = \"needed\"\n\nsetFieldValue(field2,dest2,obj,option)\n\nfunction setFieldValue(source, destination, object, options) {\n var myVal = getFieldValue(source, object);\n if(!myVal && options==\"needed\") {\n myVal=\"<No Value>\";\n }\n // empty fields can be deletions and need to propagate\n if(!myVal && myVal == \"\") {\n json[destination]='';\n }\n // any other values can propagate\n if(myVal) {\n dest_json[destination]=myVal;\n }\n }\n | \n|||
\n dest_json = '{\"/ApprovalQuantity\":\"<No Value>\"} \n | \n
The transformation map for transformation from SDF to Incident, Change and Requirement looks as follows:
\n| \n\n | \n\nThese maps are meant for ease of modification so the map below may not be the final map.\n | \n
#*********************************************************##\n# CASE to determine which map will be used ##\n#*********************************************************##\nCASE nothing in\n *)\n GOTO MAP2JIRA\n ;;\nESAC\n\n#*********************************************************##\n# MAP DEFINITION ##\n#*********************************************************##\n\n\nDEFINE MAP2JIRA{\n\n # need to define how this get processed (as transition or regular update)\n # this is required!!!\n processType = $EVAL(\n\n var d = JSON.parse('[data]');\n\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n\n var s = getFieldValue(\"bardiocStatus\", d.fields);\n var u = \"UPDATE\";\n var res = \"TRANSITION\";\n //should always be UPDATE unless resolving or otherwise\n //changing the ticket status\n if(s == null || s == \"\" || s != \"RESOLVED\"){\n res = u;\n }\n result = res;\n )\n\n ## The id used in the call update/transition a ticket\n ## this is required!!!\n id = $EVAL(\n var d = JSON.parse('[data]');\n\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n getFieldValue(\"$id\", d.fields);\n )\n\n ## data is the actual message to send to jira. Since\n ## there are variances between update and transition messages\n ## the logic should account for either.\n data = $EVAL(\n var d = JSON.parse('[data]');\n //figure out what message to build\n var s = getFieldValue(\"bardiocStatus\", d.fields);\n var t = \"TRANSITION\";\n var delta = getFieldValue(\"$delta\", d.fields);\n var ticketType = \"[$type]\";\n if(s == null || s == \"\" || s != \"RESOLVED\"){\n t = \"UPDATE\";\n }\n\n var res = {};\n\n /** Process UPDATE message **/\n if(t == \"UPDATE\"){\n res = {};\n var update = {};\n var fields = {};\n\n // Individual maps\n if (ticketType == \"incident\") {\n }\n\n if (ticketType == \"change\") {\n }\n\n if (ticketType == \"requirement\") {\n }\n\n //Add in comments. For v2 Comments structure is\n // \"comment\":[{\"add\":{{\"body\":\"<commentText>\"}}]\n //\n update = getComments(update);\n\n // send update only if attribute was part of the delta array\n delta.indexOf('subject') > -1 ? fields.summary = getFieldValue(\"subject\", d.fields): null ;\n delta.indexOf('description') > -1 ? fields.description = getFieldValue(\"description\", d.fields): null ;\n delta.indexOf('priority') > -1 ? fields.priority = getFieldValue(\"priority\", d.fields): null ;\n\n\n /** Assignment on rejection from Bardioc **/\n if(delta.indexOf('bardiocStatus') > -1) {\n if(s == \"STOPPED\" || s == \"TERMINATED\" || s == \"WAITING\") {\n /* need assignee account id */\n fields.assignee = {accountId: \"TOOL_FALLBACK_INDIV_ID\"};\n }\n\n /** Some notes for Stopped request **/\n if(s == \"STOPPED\"){\n update = addComment(\"Bardioc unable to process. Need more knowledge\", update);\n }\n /** Some notes for Terminated Requests **/\n if(s == \"TERMINATED\"){\n update = addComment(\"Bardioc unable to process due to issue\", update);\n }\n if(s == \"PROCESSING\"){\n update = addComment(\"Issue sent to Bardioc for processing.\", update);\n }\n }\n //add in resolution notes to comments if there are any\n\n var r = getFieldValue(\"closeNotes\", d.fields);\n\n res.update = update;\n res.fields = fields;\n }\n\n /** Process TRANSITION (Resolution) message **/\n if(t == \"TRANSITION\"){\n res = {};\n var update = {};\n var transition = {};\n\n //add in comments\n update = getComments(update);\n\n //add in resolution notes to comments if there are any\n var r = getFieldValue(\"closeNotes\", d.fields);\n if(r != null && r != \"\"){\n update = addComment(r, update);\n }\n\n //resolution\n update.resolution = [{ set : { name : \"Done\"}}];\n\n //transition code\n transition.id = \"761\";\n\n res.update = update;\n res.transition = transition;\n }\n\n /************** functions ****************/\n\n\n /* Get a field value from fields object */\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n\n /* Add a comment to the update object */\n function addComment(comToAdd, update){\n if(update == null){\n update = {};\n }\n\n var f = null;\n var isAdd = null;\n var txt = null;\n if((f = update.comment) != null && update.comment.length > 0 &&\n (isAdd = update.comment[0].add) != null && (txt = update.comment[0].add) != null &&\n (txt = update.comment[0].add.body) != null){\n update.comment[0].add = { body : txt + \"\\n\" + comToAdd };\n return update;\n }\n\n update.comment = [{ add : { body : comToAdd }}];\n return update;\n\n }\n\n //get relationObject\n function getRelation(name, relations){\n var rellength = relations.length;\n for(var i=0;i<rellength;i++){\n var rel = relations[i];\n var keys = Object.keys(rel);\n var kl = keys.length;\n for(var t=0;t<kl;t++){\n if(keys[t] == name){\n return relations[i];\n }\n }\n }\n return [];\n }\n\n /* Parse comments from relations object, formats, and adds to update object */\n function getComments(update){\n var c = getRelation(\"COMMENTS\", d.relations);\n var tout = \"No comment!!\";\n var cres = [];\n if(c != null){\n var comArr = c.COMMENTS;\n if(comArr != null && comArr.length > 0){\n for(var i=0; i<comArr.length; i++){\n var ts = getFieldValue(\"timestamp\", comArr[i].fields);\n var txt = JSON.parse(getFieldValue(\"value\", comArr[i].fields));\n var actual = null;\n var e = [];\n if(txt != null && (e = txt.Entries) != null){\n for(t=0; t<e.length; t++){\n if(e[t].LogLevel == \"info\"){\n actual = e[t].Message;\n }\n }\n }\n var dt = new Date(0);\n dt.setUTCMilliseconds(ts);\n var ds = dt.toISOString();\n //format it to '\"2020-01-20T20:14:36.543Z : resolved\"'\n cres.push(ds + \" : \" + actual);\n }\n }\n }\n for(var ii=0;ii<cres.length;ii++){\n addComment(cres[ii], update);\n }\n return update;\n }\n\n /***************** end functions ***************/\n\n result = JSON.stringify(res);\n )\n} ENDLogin as a admin user
\nNavigate to \"System Update Sets\" menu and click on the \"Local Update Sets\".
\n![\"Local](\"/7.0/images/connector_images/Rollback_LocalUpdateSets.png\")
\nClick on the recently committed ConnectIt update set xml file.
\nMake sure that the current application scope is set from Global to ConnectIt (Otherwise the Back Out option won’t be available)
\nClick on \"Back Out\" in the upper right corner and wait for the process to finish (may take a few minutes)
\n![\"BackOut\"](\"/7.0/images/connector_images/Rollback_BackOut.png\")
\nWait a few minutes while the Back Out is processing
\n![\"Back](\"/7.0/images/connector_images/Rollback_Running.png\")
\n| \n\n | \n\nThe following two items will only occur if any problems with backing out are found. These occur if there were any changes done to the data after commiting the Update Set.\n | \n
If the process finds any problems, go through them and decide individually what would be the best solution. (for example changeing the password of bardioc-connect User may lead to Backout Problems)
\nOnce all problems are taken care of, click again on the Back Out button.
\nAfter the process is completed navigate to \"System Update Sets\" menu and click on the \"Retrieved Update Sets\".
\n![\"Retrieved](\"/7.0/images/connector_images/Rollback_Retrieved.png\")
\nSelect Connectit
\nClick on the Delete button in the upper right corner, you may have to type 'delete' in an upcoming popup to confirm
\n![\"Delete\"](\"/7.0/images/connector_images/Rollback_Delete.png\")
\nAfter a few minutes you should see the successful delete message.
\n![\"Success\"](\"/7.0/images/connector_images/Rollback_Success.png\")
\nAction Handlers are integration components of the Bardioc™ system. They are used to\ninvoke actions on target systems. This document walks you through the configuration procedure of the Bardioc™ SAP™ Action Handler.
\nFrom a technical perspective, the SAP™ Action Handler is an additional capability using the Bardioc™ HTTP Action Handler, which is included in the Standard Docker image for Action Handlers.
\nBefore you can configure the SAP Action Handler, make sure the following prerequisites are fulfilled:
\nYou have configured your SAP according to the Bardioc™ for SAP Operations - Implementation Guide. This document will be provided to you by us in the implementation phase of your project.
\nYou have followed the instructions in Standard Docker image for Action Handlers to setup the Action Handler Docker container. Please ensure that you are able to process HTTP requests from Bardioc.
\nAlmato has a SAP demo instance, which customers may use on request for testing purposes. We can provide you with the IP and credentials for this demo instance.
\nIn order to make use of the SAP™ Action Handler capability, you need to add the following handler definition to your docker composition file:
\nenvironment:\n AH_CONFIG: >\n {\n \"handlers\": [\n {\n \"name\": \"SAPHandler\",\n \"capability\": \"SAPRequest\",\n \"implementation\": \"HTTP\",\n \"url\": \"https://<IP of your SAP System>:<Port>/jsonbc/$${function}\",\n \"params\": \"$${destination}\",\n \"body\": \"$${parameters}\",\n \"insecure\": \"false\",\n \"method\": \"post\",\n }\n ]\n }Please refer to How to configure capabilities in the standard Action Handler (Docker image) for details on the configuration map.
\nIn case your SAP System requires a secure connection using certificates, you need to include these in your handler configuration as well:
\nenvironment:\n AH_CONFIG: >\n {\n \"handlers\": [\n {\n \"name\": \"SAPHandler\",\n \"capability\": \"SAPRequest\",\n [...]\n \"client_certificate\": \"/<virtual path to certificate>/cert.crt\",\n \"client_key\": \"/<virtual path to certificate>/cert.key\"\n }\n ]\n }Also, please ensure the certificates are either included in your docker image, or accessible as volumes or alike.\nHere is an example using volumes in docker-compose.yml:
environment:\n AH_CONFIG: >\n {...}\nvolumes:\n - type: bind\n source: /<actual path to certificate>/cert.crt\n target: /<virtual path to certificate>/cert.crt\n - type: bind\n source: /<actual path to certificate>/cert.key\n target: /<virtual path to certificate>/cert.keyOnce you have successfully configured and started the Action Handler, you can test it by triggering the follow KI from Bardioc™:
\non\n ogit/_id\nwhen\n ProcessIssue == \"TestSAPRequest\"\ndo\n stdout: LOCAL::OUTPUT,\n stderr: LOCAL::ERROR,\n rc: LOCAL::SYSTEMRC = action(\"SAPRequest\",\n function :\"RFC_GET_SYSTEM_INFO\"\n )\n if LOCAL::SYSTEMRC == 0 then\n log(\"SUCCESS: ${LOCAL::OUTPUT}\")\n else\n log(\"ERROR ${LOCAL::ERROR}\")\n end\n\n stdout: LOCAL::OUTPUT,\n stderr: LOCAL::ERROR,\n rc: LOCAL::SYSTEMRC = action(\"SAPRequest\",\n function :\"RFC_READ_TABLE\",\n parameters: '{\n \"QUERY_TABLE\": \"T000\"\n }'\n )\n if LOCAL::SYSTEMRC == 0 then\n log(\"SUCCESS: ${LOCAL::OUTPUT}\")\n else\n log(\"ERROR ${LOCAL::ERROR}\")\n end\n\n delete(ProcessIssue)This guide contains definitions and examples for functions available via the mapping file mechanisms used in data transformation within the ServiceNow connector.
\nThere are a few functions used within the various maps that require some additional understanding. The available functions, syntax, I/O specifications, and example(s) are provided below.
The transformation interpreter has special meaning for commas. If the using a function other than $EVAL() any comma in the data may cause truncation or unexpected results.
Workaround: If the source data to transform “may” contain commas use $EVAL() function to handle the transformation.
For functions other than $EVAL() line breaks cause truncation of data.
Workaround: If the source data to transform “may” contain line breaks use $EVAL() function to handle the transformation
Function | \nPurpose | \nInput | \nOutput | \n
$EQUAL | \nDetermines the equality of two values | \nString 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 0 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$GREATER_EQUAL | \nChecks if one value is greater than or equal to another | \nvalue 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 0 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$LESS_EQUAL | \nChecks if one value is less than or equal to another | \nvalue 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 1 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$LESS_THAN | \nChecks if one value is less than another | \nvalue 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 1 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$GREATER_THAN | \nChecks if one value is greater than another | \nvalue 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 0 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$NOT_EQUAL | \nChecks if one value is not equal to another | \nvalue 1, | \n0 for false | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is 1 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$TOLOWER | \nConverts value to lower case | \nInput value | \nLower case string | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is abcxyz.1.2.3 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$TOUPPER | \nConverts value to upper case | \nInput value | \nUpper case string | \n
Example: Assume [Name] is “AbcXyz.1.2.3” Output is ABCXYZ.1.2.3 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$STR2JSONSTR | \nConverts a string to properly formatted JSON string | \n
| \nJSON formatted string | \n
Example: $ STR2JSONSTR (affectedPerson, [TicketOwner]) Assuming: Output: (JSON object in string representation)\n{“affectedPerson”: “John Doe”} | \n
Function | \nPurpose | \nInput | \nOutput | \n
$LOOKUP | \nJava equivellant of a CASE statement. Used to convert known input values to other values | \nString value | \nConverted string value | \n
Example: \n----\nassume [status] is Work In Progress\n myStatus = $LOOKUP([Status])\n { Open → New;\n New → New;\n Accepted →Assigned;\n Work In Progress → Assigned;\n Pending* → Pending;\n Closed → Closed;\n Referred → Escalated;\n Replaced Problem → Assigned;\n Resolved → Resolved);\n Rejected → Closed;\n }, myStatus)\n---- \nAssigned would be the value assigned to | \n
Function | \nPurpose | \nInput | \nOutput | \n
$STR2JSONARRAY | \nConverts string into JSON array string | \nParam1: string value | \nJSON formatted string | \n
Example: $STR2JSONARRAY(affectedPerson, [TicketOwner]) Assuming: Output: (JSON array in string representation) | \n
Function | \nPurpose | \nInput | \nOutput | \n
$SUBSTRCHAR | \nGets the data between two parameters | \nParam1: string to manipulate | \nString | \n
Example: $SUBSTRCHAR([affectedPerson],\",\") Assuming: Output: The result of grabbing text between the double quotes | \n
Function | \nPurpose | \nInput | \nOutput | \n
$REPLACE | \nReplaces string with another string | \nParam1: originating string | \nString | \n
Example: Assume [Name] is “AbcXyz.1.2.3”\n$REPLACE ([Name], “.”, “‐“) \nOutput: AbcXyz‐1‐2‐3 | \n
Function | \nPurpose | \nInput | \nOutput | \n
$GUID | \nProduces a random UUID | \nnone | \nUUID string | \n
Function | \nPurpose | \nInput | \nOutput | \n
$IFCONTAINSTHENSET | \nCheck if a value is contained in a list and if so returns the specified value | \nParam1:Comma separated list | \nString value or “” | \n
Example: $ IFCONTAINSTHENSET ([a, b, c, 1, 2, 3], c, myValue) Output: Since “c” is in | \n
Function | \nPurpose | \nInput | \nOutput | \n
$IFEQUALTHENSET | \nCheck if a value is equal to another and if so returns the specified value | \nParam1: string to compare | \nString | \n
Example: $IFEQUALTHENSET(Contains, [RelationshipSubtype], [myValue]) Assuming: Output: Since value of | \n
Function | \nPurpose | \nInput | \nOutput | \n
$FORMAT | \nImplementation of String.format() or printf | \nVarious formatting parameters | \nFormatted string | \n
Example: Assuming: Output: | \n
Function | \nPurpose | \nInput | \nOutput | \n
$EVAL | \nImplementation of java script allowing scripting within a java script context | \nAny source value denoted by [] may be used in the java script call | \nString | \n
\n \nExample: \n\n \n\n \noutputValue = $EVAL(\n var value = \"Example\";\n for(var i=0;i<10;i++){\n value += i;\n }\n result = value;\n )\n\n \noutputValue: Example0123456789 \n\n \nNote: The interpreter expects the value being passed from javascript be assigned to the “result” variable. \n\n \nNote: Within the mapping construct \n \nLimitations:\nUse of \n Additionally, obtaining a value from an array leveraging the | \n
Function | \nPurpose | \nInput | \nOutput | \n
$DATEFORMAT | \nFormats a date from one date time and timezone to another date time and timezone | \nParam1: source date time to convert | \nString | \n
Example: $DATEFORMAT([scheduledFinishAt], yyyy-MM-dd’T’HH:mm:ss’Z', UTC, yyyy-MM-dd hh:mm:ss, UTC) Assuming: Output: 1999-07-11 01:45:12 | \n
Configuration of ServiceNow Instance consists of creating of a bardioc-connect user and the Bardioc Usergroup and assigning appropriate roles to the user. The ServiceNow connector supports two opration pipelines:
forward operation
\nbacksync operation
\nThe forward mode fetches ITIL items from ServiceNow and creates complementary issues or CI nodes in Bardioc. In case changes on items in Bardioc require to be synced back by the connector, the backsync operation needs to be configured and enabled.
\nThis guide assumes that you have
\nAccess to a ServiceNow Instance for testing purposes, including admin privileges for configuration
\nServiceNow Version San Diego, Quebec, Rome and Paris, with firewall allowing messages from ServiceNow.
\n| \n\n | \n\nPlease note that ServiceNow as a cloud service can use different IPs for incoming and outgoing messages. A ping your-servicenow-instance.com may not give you the IP you will need for the firewall configuration. See: https://hi.service-now.com/kb_view.do?sysparm_article=KB0538621\n | \n
Connector will send messages and queries to ServiceNow. So a connection needs to be possible. This includes that the hostname of your ServiceNow instance must be resolvable on the ServiceNow connector container.
\nThe upload of an Update Set is only required if the connector will be set up for backsync operation. Please skip this step if you plan to use the connector in forward operation only. The Update Set contains the necessary configuration changes, ACLs and business rules to allow the Connector to implement changes in ServiceNow. This step requires a user with admin-privileges.
\nYou can find the UpdateSet here.
\nTo import the Update Set:
\nGo to Retrieved Update Sets and click on \"Import Update Set from XML\"
\n![\"Update](\"/7.0/images/connector_images/snow_updateset.png\")
\nChoose the File ConnectIt-UpdateSet.xml (might also contain a version number, when in doubt, pick the newest version), that should be part of the Bardioc connect delivery.
After uploading click on the 'Connectit' Update Set
\n![\"Loaded](\"/7.0/images/connector_images/UpdateSets.png\")
\nPreview the Update-Set
\nCommit the Update-Set
\nYou should be able to find a new SubMenu when searching ConnectIT (this contains the import tables)
\n![\"Bardioc\"](\"/7.0/images/connector_images/SubMenu.png\")
\nBardioc will only work on Incidents and Change Requests that are assigned to the Bardioc-User group. This group does not actually contain any users, it is just used as a trigger for Bardioc.
\n| \n\n | \n\nMake sure to use the exact string given in the following instructions, so that the triggers will work properly. The Strings are \"Bardioc\" and \"Bardioc_Admin\" for the group names and \"bardioc-connect\" for the username.\n | \n
Go to the menu System Security → Groups and create a new Group with name Bardioc
\n![\"Bardioc\"](\"/7.0/images/connector_images/Bardioc_Group.png\")
\nFor backsync operation, we also recommend to create a second Group called Bardioc_Admin. This group will be assigned to incidents that come back as ejected, i.e. not solvable by Bardioc with the current knowledge. It should contain human users, that are able to access the Bardioc Frontend to analyze these issues and take care that they are resolved in some way.
Next go to the menu System Security → Users and create the bardioc-connect user. This is a technical user to access the API and which should not be used by a human. You can activate \"Web service access only\" to make sure that no one can use the user to login to the ServiceNow GUI. Note down the password, as you will need it later in the Installation.
NOTE:\"UserID\" needs to be filled out exactly as in the example. The other fields do not have an effect on the Connector.
\n![\"Create](\"/7.0/images/connector_images/CreateUser.png\")
\nUser needs to have the appropriate roles to read and write into ServiceNow. For this, click on the bardioc-connect user and scroll down to the Roles section and click on Edit.
![\"Edit](\"/7.0/images/connector_images/EditRoles.png\")
\nSearch for the role and itil. Add it to the Roles list and save.
If you have uploaded an UpdateSet to the system, also assign the user to the group x_almato_connectit_user
![\"Edit](\"/7.0/images/connector_images/AddRoles.png\")
\n![\"Add](\"/7.0/images/connector_images/add_itil.png\")
\nThese roles are required to access the ITIL-related data and to be able to create import tables to get data back into ServiceNow.
\nIf you have uploaded the Update Set, all ACL’s are set automatically and you can skip this step.\nFor operating in forward operation only, you need to add the read permission for the sys_journal_field table to the itil role in order to receive work notes and comments from Service Now.
Click on the logged in user and choose Elevate Roles
Make sure the security_admin option is activated:
![\"Security](\"/7.0/images/connector_images/SecurityAdmin.png\")
\nGo to the menu System Security → Access Control (ACL) and click on NEW to create a new ACL
\nchoose record for the Type
\nchoose read for Operation
\nchoose sys_journal_field for Name
\n![\"Create](\"/7.0/images/connector_images/AddACL.png\")
\nIn the Requires role section, double click on Insert a new row.. and add the itil role
![\"Add](\"/7.0/images/connector_images/AddRole.png\")
\nclick on Submit to save the new ACL
\nBesides simple authentication, the connector also supports OAUTH2 access token based authentication. Admin privileges are needed to add an OAUTH2 application.
\nOpen application registry and click on New to add an application.
\n![\"Application](\"/7.0/images/connector_images/AppRegistry.png\")
\nChoose Create an OAuth API endpoint for external clients
\n![\"OAUTH](\"/7.0/images/connector_images/KindOfOauth.png\")
\nProvide a name and a client secret. You can adjust refresh token and token lifespan if needed.
\n![\"OAUTH](\"/7.0/images/connector_images/OauthDetails.png\")
\nClick on Submit to apply changes.
\nThis guide contains the information necessary to help the user of the ServiceNow Connector to understand the superficial architecture, functionality, and use of the connector.
\nIf you haven’t yet, it is recommended to launch a container configured with Pluggable Framework and ServiceNow plugin. Instructions can be found in the ServiceNowPluggable Connector Commissioning Guide.
\nThe ServiceNow connector is a Java based connector meant to run within the connector container. The connector provides for the following objectives:
\nGet incident information changed or newly created from ServiceNow system.
\nA poller mechanism polls for information based on a configurable query and configurable interval.
\nUse the transformation API to transform data to be written to ServiceNow and write the data to the ServiceNow system
\nUses transformation map(s) common to the pluggable framework, which incorporates the ability of the user to manage transformation in text instead of code
\nCommunication with the ServiceNow system is done via RESTFul web services
\nThe number of threads used in the writing of information is configurable
\nThe connector is easy to install and configure. Key benefits include:
\nMulti-threaded to boost performance (adjustable).
\nAllows users to define data transformation via map files so no code change is required
\nFlexible configuration & mapping
\nSupported Platforms:
\nLinux
\nThe file system structure for the ServiceNow connector is relatively straight-forward. You can have a look at the file structure using container shell.
\nOpen the container’s shell using docker exec -it <mycontainer> bash
/opt/almato/connect/pluggable
The directory where connector configuration files and folders will be placed along with applicable libraries utilized by the connectors. We will call it as <install_dir> in the future steps.
<install_dir>/config.env
This is a config file which contains connector specific parameters. This is explained in detail in our commissioning guide.
\n<install_dir>/lib
The directory where all applicable connector libraries and dependencies are placed for ServiceNow connector.
\n<install_dir>/plugin
The main ServiceNow connector directory
\n<install_dir>/plugin/snow/snow.endpoint.conf.xml
The configuration file for the ServiceNow connector.
\n<install_dir>/plugin/snow/maps
The map folder contains the map files used for data transformation
\nThe snow.endpoint.conf.xml file is used by the connector to understand how to connect with an ServiceNow system, manage polled reading of information from ServiceNow, manage multi-threaded writing to ServiceNow, define data transformation mapping, and define parameters specific to modules. Within the file is inline documentation about its use, but will be documented here as well. Note: It is recommended to define the paramenters in this file using config.env.
| Term | \nDefinition | \n
|---|---|
Module | \nIn the context of the Almato integration strategy between Bardioc Connect and IT Service Management systems, a module is defined as a specific ITSM module such as Incident, Change, Config | \n
Consumer | \nIn the context of this connector, the consumer is the mechanism responsible for reading information from the ServiceNow system and placing it on the connector internal queue. | \n
Consumer Polling Interval | \nDefines the interval, in seconds, that the consumer will poll for new updates from ServiceNow | \n
Producer | \nIn the context of this connector, the producer is the mechanism responsible for reading information from the connector internal queue and then writing that information to ServiceNow. | \n
Producer Threads | \nDetermines the number of threads to create to process write operations to push information to ServiceNow. | \n
Producer Polling Interval | \nThe producer pulls records waiting to be processed from a shared data queue. How often the producer checks the queue is determined by the polling interval (measured in seconds). | \n
Query | \nThe connector consumer utilizes a query mechanism for reading records from ServiceNow on an interval. The query should reflect a valid query in ServiceNow syntax with appropriate operators (see Operators_Available_for_Filters_and_Queries) \nThe poller mechanism inserts the last run time of the run into the query at run time. The date/time used is read from | \n
serviceUrl | \nThe service url of the ServiceNow instance (i.e. | \n
dateFormatServer | \nThe date format of the server, in this case, the host where the connector will run. | \n
timezoneServer | \nThe timezone of the server where the connector runs (i.e. UTC or CST or EST, etc) | \n
Consumer/uri | \nFor each module a consumer uri is used to determine where to read information during each polling cycle. Syntax is “table”/<module>\ne.g. incident would be | \n
Producer/uri | \nFor each module a producer uri is used to determine where to write information. It is recommended by ServiceNow to write to import sets instead of directly to the main table, so this uri should reflect the appropriate import set table for the particular module. Syntax is: | \n
userName | \nThe ServiceNow service account to use when reading/writing/updating information | \n
Password | \nAn encrypted password for the ServiceNow user account (see Password Encryption section) | \n
The consumer is responsible for reading of records from ServiceNow. The Consumer is designed to poll a ServiceNow instance based on an interval defined in the snow.endpoint.conf.xml configuration file. The consumer knows what records to pull using a combination to two bits of data to define the query:
In the snow.endpoint.conf.xml configuration file, for each module’s consumer a query may be defined to appropriately determine which records to pull.
When the consumer runs, the query defined will be augmented with an additional query parameter based on the last poll time retrieved from the module’s dat file (i.e. incident.dat, ci.dat, change.dat).
Example: If query is defined as number=INC0000000044, and incident.dat has 2016-03-03 01:00:00Z, when the consumer polls ServiceNow, the query used will be:\n?sysparm_query=number= INC0000000044^sys_updated_on>=2016-03-03 01:00:00Z
After each polling cycle, where the poll returned record(s) from ServiceNow, the appropriate dat file is updated with the date/time of the last poll. If no records were pulled, the dat file retains the date/time of previous polling cycle.
\nThis guide provides all technical details to commission and configure the Pluggable Framework and ServiceNow connector plugin for production use.\nThe information below is applicable for Pluggable Connector version v2.0.1
\nThe ServiceNow pluggable requires the Domain Object API with delta SDF support. It is intended to be deployed as Docker containers running the Pluggable Framework based on Ubuntu Linux. All required files are located in https://github.com/almato/avnet-connector/tree/master/docker/snow
\nFor the build of both components please use the following Docker files:
\nDockerfile.snow\n
You will end up with with one deployable image:
\nbardioc-pluggable-snow
\nThe pluggable connector will establish a network connection to several services that need to be available once launching the containers:
\nDomain Object API, Version 0.1.0 or above supporting delta generation
\nBardioc Authentication Backend
\nServiceNow Web Service
\nThe pluggable connector will check availability of the authentication backend as well as the ServiceNow web interface. If one of the services is not available at container start, the sequence will pause until all services are reachable.
\nBesides the tool endpoint the pluggable connects to the Graph for authentication and configuration. It only exposes a single port for monitoring (health checks).
\nPort | \nComponent(s) | \nType | \nDescription | \nPublic/Private | \n
8443 | \npluggable-snow | \noutbound | \nHTTPS communication the authentication backend | \nprivate | \n
8800 | \npluggable-snow | \noutbound | \nHTTP communication to the Domain Object API | \nprivate | \n
9191 | \npluggable-snow | \ninbound | \nHealth check port, unauthenticated | \nprivate | \n
During startup, the container is launched with a set of bootstrap parameters. These credentials are used to pick the configuration from the graph that is assigned to this specific user. In a second step, the actual container configuration is pulled by a GET on the config API /api/app/7.0/config. The container expects a base64 encoded and gzipped tarball payload that will be extracted into the container file system during startup. This tar ball should hold at least the config.env file.
To create a valid configuration payload, run the following command:
\ntar cz config.env | base64 -w0 > payload\n
This payload needs to be uploaded to the Graph for the functional user connector.
In order for the container to pull the configuration, it needs some bootstrap credentials to be passed as environment variables during startup:
\nBardioc_ENDPOINT | \nGraph endpoint for authentication and central configuration | \n
Bardioc_CLIENTID | \nClient ID | \n
Bardioc_CLIENTSECRET | \nClient secret | \n
Bardioc_USER | \nFunctional user | \n
Bardioc_PASS | \nPassword | \n
The following parameters are connector specific stored in a central config file config.env. Functional user credentials are reused from the bootstrap configuration.
Option | \nDescription | \n
CERT_SUBJ | \nCertificate details used for self signed cert creation eg. CN=pluggable.local, OU=bardioc-connect, O=Almato, L=connect, S=bardioc, C=DE (currently cert store is created during startup but not used) | \n
KEYALIAS | \nPrivate key alias for SSL operation if an external keystore is used | \n
TRUST_CERTS | \nNeeds to be set to true if endpoint is using self signed certificates | \n
Bardioc_DOAPI_ENDPOINT | \nURL of the RestAPI of the Domain Object API | \n
TOOL_SERVICEURL | \nEndpoint for ServiceNow web interface | \n
TOOL_USER | \nUser to be used to logon to ServiceNow | \n
TOOL_PASS | \nServiceNow user password | \n
LOCAL_TZ | \nLocal timezone (eg. UTC) | \n
TOOL_TZ | \nTimezone of ServiceNow tool | \n
TOOL_FALLBACK_GROUP | \nFallback group for not resolved issues (eg. Bardioc_Admin) | \n
TOOL_GROUP | \nGroup of issues being picked up by the pluggable from ServiceNow | \n
TOOL_INC_START | \nStart date of Incidents to be picked up (eg. \"2020-05-01T09:00:00Z\") | \n
TOOL_CHG_START | \nStart date of Changes to be picked up (eg. \"2020-05-01T09:00:00Z\") | \n
TOOL_CI_START | \nStart date of CI’s to be picked up (eg. \"2020-05-01T09:00:00Z\") | \n
TOOL_POLLINGINTERVAL | \nInterval for checking for new issues in ServiceNow in seconds | \n
TOOL_QUERY | \nQuery to run against ServiceNow (eg. \"type:ticket group_id:TOOL_GROUPID\") | \n
TOOL_TIMEOFFSET | \nOffest to be applied for picking up issues from ServiceNow | \n
LOGGER | \nWhere to redirect logs to (console, console_plain) | \n
LOGLEVEL | \nLoglevel for logs (TRACE, DEBUG, INFO) | \n
INC2SNOW | \nBacksync of Incidents (true, false) | \n
INC2Bardioc | \nSync Incidents from ServiceNow to Bardioc (true, false) | \n
CHG2SNOW | \nBacksync of Changes (true, false) | \n
CHG2Bardioc | \nSync Changes from ServiceNow to Bardioc (true, false) | \n
CI2SNOW | \nBacksync of CI’s (true, false) | \n
CI2Bardioc | \nSync CI’s from ServiceNow to Bardioc (true, false) | \n
The ServiceNow connector is designed to enable communication between Bardioc and ServiceNow. It provides an easy to deploy solution to enable our customers to connect their business processes with Bardioc. The connector supports latest and most used versions of ServiceNow: Paris, Quebec and Rome. It works with these versions without any extra effort.
The connector can be used for any of the most commonly used IT processes such as Incident, Change or Config Items. The beauty of this connector is that it is configurable for most of the features. The customers can enable or disable any of the IT processes using a simple configuration file.
| \n\n | \n\nThe connector is designed for a vanilla ServiceNow installation. You need to make sure that your customization in ServiceNow works with the connector. We do not support ServiceNow customizations in the connector.\n | \n
Target System | \nServiceNow | \n
Supported Versions | \n
| \n
Supported Processes | \nIncident, Change and Config | \n
The working mechanism of the connector is based on the data polling technique. The connector keeps track of changes on ServiceNow and Bardioc, if any change is detected, it forwards them to the responsible component. The connector tracks changes in data based on timestamps (supported by ServiceNow). It also keeps track of the last successful record sent so that in case of any loss of data due to network error or any physical incident, the connector can be configured to grab data from the last successful point. This feature is also quite useful when synchronizing history data between or from a certain date time.
\nOne of the biggest challenges with connectors is the data transformation and data mapping. Bardioc understands the \"Almato Standard Data Format\" (SDF) and provides a large list of attributes that covers almost all ITSM tools. ServiceNow has its own data format and communicates accordingly. The connector transforms data from SDF to ServiceNow format and vice versa using a mapping scheme. The most important feature here is the configurable mapping scheme. The connector maps data between both components using an external mapping file. The customers can provide their own mapping logic for data transformation and can decide how the data should be mapped. Note that the connector package also provides a default mapping designed based on expert views.
\nThe connector architecture is designed to support parallel working model (or multi-threaded). The number of parallel processes are easily configured using the configuration file so that the customers can decide based on underlying environment.
\nThe connector package contains an Intro video, the Install guide, the technical guide and the guide for writing transformation files.
\nBardioc™ comes with a Docker image of a standard Action Handler. This Action\nHandler can be configured to perform different types of actions (capabilities).\nThis guide describes how to configure the standard Action Handler via the\ndocker-compose.yml configuration file.
Before you can configure the Action Handler, make sure the following prerequisites\nare fulfilled:
\nYou have followed the instructions in Standard Docker image for Action Handlers\nto setup the Action Handler Docker container. Please make sure that the Action\nHandler correctly connects to the Bardioc API.
\nYou have configured the desired capabilities in the Bardioc™ SaaS system.\nThis is currently done by our SaaS team for you - please open a ticket.
\nOnce you have setup the basic Docker container for the Action Handler, and the\ncapabilities are correctly assigned in the Bardioc™ system, you can proceed with\nthe steps below.
\nThe standard Action Handler comes as a Docker image. You need to use docker-compose\nto configure the Docker container for you individual use. This is done in a file\ncalled docker-compose.yml. The docker-compose tool reads this file to instantiate\nyour Docker container from the image.
For the basic steps how to create the docker-compose.yml file and run docker-compose\nplease see Standard Docker image for Action Handlers.
The Action Handler comes equipped with a default configuration for the most basic capabilities.\nTo use the default configuration, you need to set the environment variable USE_DEFAULT_AH_CONFIGS.\nThe following capabilities have a default configuration assigned:
ExecuteCommand
\nHTTPRequest
\n environment:\n USE_DEFAULT_AH_CONFIGS: ExecuteCommand,HTTPRequestWithin the docker-compose.yml file we specify an environment variable AH_CONFIG.\nThis parameter contains the configuration of the Action Handler regarding which\ncapabilities to execute, and how to execute them.
As example, the AH_CONFIG in your docker-compose.yml might look like this:
environment:\n AH_CONFIG: >\n {\n \"handlers\":[\n {\n \"name\":\"SSH Remote Handler\",\n \"capability\":\"ExecuteCommand\",\n \"implementation\":\"SSH\",\n \"exec\":\"$${command}\",\n \"user\":\"$${user}\",\n \"host\":\"$${host}\"\n },\n {\n \"name\":\"HTTP Handler\",\n \"capability\":\"HTTPRequest\",\n \"implementation\":\"HTTP\",\n \"method\":\"$${method}\",\n \"url\":\"$${url}\",\n \"params\":\"$${params}\",\n \"body\":\"$${body}\",\n \"insecure\":\"$${insecure}\"\n }\n ]\n }As you can see, the configuration specifies two handlers: SSH Remote Handler\nand HTTP Handler. Each handler is specified with a set of attributes, of which\nsome are common and some are specific to the type of implementation.
To begin with, three parameters are generic and mandatory for all capabilities:
\nname - this is a descriptive name you give your action handler
\ncapability - the identifier of the capability (action type), which the handler\nexecutes
\nimplementation - selects one of the existing implementations for executing\nactions (e.g. SSH, HTTP). See below for a list of available implementations.
\nThe further parameters depend on the chosen implementation. For instance, the HTTP\nimplementation requires parameters such as method, url and params.
Parameters from capabilities can be referenced via ${name}, so that you can make\nuse of the parameters sent by Bardioc in the actions. The specific parameter values\nset by the Bardioc ™ Engine through Knowledge Items (action statement) are filled\nin at run-time.
Please note: parameter references need to be escaped by $$ in the configuration\nfile. For instance, you need to write $${url}, which gets transformed into ${url}\nby docker-compose.
Two additional optional parameters were introduced with version 0.21.7 of the action handler container:
\nextract_fields can be used to specify if any of the return parameter fields should be processed by a JSON parser and the result be added to the result parameter set. A typical example for this would be \"body\" for an HTTP actionhandler returning a JSON map with multiple result fields which should be directly accessible from the calling KI
\nsupply_token can be used to specify a parameter name which will be internally added before processing. The value of that parameter will be a freshly generated graph token that can be passed along to external handlers to allow access back to the graph.
\nPlease check the Capabilities List for a list of existing capabilities.
\nAt the moment, the standard Action Handler supports the following implementations:
\nSSH
\nHTTP
\nREST
\nLOCAL
\nThe SSH implementation executes remote commands via SSH protocol. The HTTP\nimplementation executes generic HTTP(s) calls to web endpoints while the REST\nimplementation execute calls to web services conforming to the REST ActionHandler\nprotocol specification of Bardioc 6. The LOCAL implementation invokes a local shell\ncommand within the docker container - this can e.g. be used to extend the standard\ndocker image with custom scripts.
\nBeyond using these implementations for plain SSH or HTTPS calls, you can also\nuse them to invoke any custom implementations. To do so, you may capsulate your\ncustom code either as a web service (with HTTPS interface) or as a console script\nthat can be invoked by the SSH action handler implementation. In order to hide the\n\"internals\" it is advised to return proper json maps on one of the standard return\nchannels and process them with the extract_fields configuration parameter so that\nthe calling KI does not have to know about the actual invocation method.
\nThe SSH handler implementation executes a command via ssh on a remote host.
\nSupported input parameters:
\n| Parameter | \nDescription | \n
|---|---|
host | \nhostname to connect to | \n
port | \nport to connect to | \n
user | \nuser to connect as | \n
password | \noptional password to use for login | \n
user_dir | \noptional path where id_rsa and known_hosts are located | \n
rsa_pass_phrase | \noptional passphrase for id_rsa | \n
connect_timeout | \ntimeout for establishing a connection | \n
Provided return values:
\n| Parameter | \nDescription | \n
|---|---|
stdout | \nstdout output of the command | \n
stderr | \nstderr output of the command | \n
exit | \nexit code of the command | \n
Configuration example:
\n{\n \"name\":\"SSH Remote Handler\",\n \"capability\":\"ExecuteCommand\",\n \"implementation\":\"SSH\",\n \"exec\":\"$${command}\",\n \"user\":\"$${user}\",\n \"host\":\"$${host}\"\n},The HTTP implementation executes an HTTPS or HTTP request to a web server.
\nSupported input parameters:
\n| Parameter | \nDescription | \n
|---|---|
method | \nhttp method, which should be executed (GET/POST/PUT/DELETE/…) | \n
url | \nurl to which the request is to be sent | \n
params | \nparameters to be included in the url | \n
body | \npayload to be sent | \n
headers | \nheaders for the request in form of 'name=value\\\\n' | \n
tls_version | \nspecify the TLS version to use. This parameter is optional - the default TLS version is | \n
username | \nusername for basic auth | \n
password | \npassword for basic auth | \n
client_certificate | \nabsolute path to the file location of an SSL client certificate file | \n
client_key | \nabsolute path to the file location of an SSL client certificate key file | \n
key_passphrase | \npassphrase for SSL client certificate file | \n
oauth | \nidentfier of a specified OAuth configuration to apply (authenticate via OAuth first, and then use a bearer token for the actual HTTPS call) | \n
insecure | \nset to \"true\" to ignore invalid https signatures (NOT RECOMMENDED) | \n
Provided return values:
\n| Parameter | \nDescription | \n
|---|---|
exec | \nexecuted http request in a format: \"${method} ${url} ${body}\" | \n
code | \nhttp response code | \n
body | \nhttp response body | \n
headers | \nhttp response headers | \n
Configuration examples:
\nHere is an example of a generic HTTP configuration, which passes all parameters through as sent from a Knowledge Item:
\n{\n \"name\":\"HTTP Handler\",\n \"capability\":\"HTTPRequest\",\n \"implementation\":\"HTTP\",\n \"method\":\"$${method}\",\n \"url\":\"$${url}\",\n \"params\":\"$${params}\",\n \"body\":\"$${body}\",\n}The next example shows how to use a specific URL to invoke a web service, using the supply_token option to pass on a static authentication token, and extracting fields from the returned response body.
{\n \"name\":\"My Custom REST Handler\",\n \"capability\":\"MyCustomCapability\",\n \"implementation\":\"HTTP\",\n \"supply_token\":\"bardioctoken\",\n \"extract_fields\":[\"body\"],\n \"headers\":\"Authorization=Bearer ${bardioctoken}\",\n \"url\":\"https://my-custom-service.local\"\n}If this service now returns a json map in the result body that looks like
\n{\n \"customresult\":\"My Custom Handler result 1\",\n \"customcode\":\"A custom handler code\"\n}then the KI using it would be able to call it using
\n customresult: LOCAL::CustomResultVar, customcode: LOCAL::CustomResultVar = action(\"MyCustomCapability\")If you want to connect to an API which requires authentication via OAuth, you can\nconfigure an OAuth endpoint, so that the HTTPS action handler retrieves a bearer\ntoken via OAuth first, before making the final HTTPS call.
\nFor example, the handler and OAuth flow configuration to use OAuth with a\nServiceNow REST API could be specified like this:
\n{\n \"handlers\": [{\n \"name\": \"HttpsWithBearer\",\n \"capability\": \"HttpsWithBearer\",\n \"implementation\": \"HTTP\",\n \"headers\": \"${headers}\",\n \"method\": \"${method}\",\n \"url\": \"${url}\",\n \"params\": \"${params}\",\n \"body\": \"${body}\",\n \"oauth\": \"${oauth}\"\n }\n ],\n \"oauths\": {\n \"service_now\": {\n \"url\": \"https://devNNNNN.service-now.com/oauth_token.do\",\n \"method\": \"post\",\n \"headers\": [\n \"content-type: application/x-www-form-urlencoded\"\n ],\n \"body\": \"grant_type=password&client_id=<CLIENT_ID>&client_secret=<CLIENT_SECRET>&username=<USER>&password=<PASS>\",\n \"response\": {\n \"ok_status\": 200,\n \"stop_statuses\": [401],\n \"access_token_field\": \"access_token\",\n \"expires_in_field\": \"expires_in\"\n }\n }\n }\n}In this example, the identifier of the oauth set (service_now) needs to be passed\nas parameter in the action command from the Knowledge Item.
The REST handler is a specialized version of the HTTP handler only for use with servers implementing the Bardioc 6 REST ActionHandler protocol. With this ActionHandler, all parameters included in the call are passed on to the destination. So there cannot, but also does not need to be any parameter definition in the handler section.
\nSupported input parameters:
\n| Parameter | \nDescription | \n
|---|---|
url | \nendpoint url to which the request is to be sent | \n
* | \nany paramter received is passed on | \n
Provided return values:
\n| Parameter | \nDescription | \n
|---|---|
exec | \nexecuted http request in a format: \"${method} ${url} ${body}\" | \n
code | \nhttp response code | \n
body | \nhttp response body | \n
Configuration example:
\n{\n \"name\":\"My Custom REST Handler\",\n \"capability\":\"MyCustomCapability\",\n \"implementation\":\"REST\",\n \"url\":\"https://my-custom-service.local\",\n}The local handler implementation executes a local shell command within the\ndocker container. It is recommended to use this implementation only if you extend the docker image by additional layers. For instance, you may add an additional docker layer with a script file, which gets executed via the local implementation.
Supported input parameters:
\n| Parameter | \nDescription | \n
|---|---|
exec | \nlocal shell command to execute | \n
Provided return values:
\n| Parameter | \nDescription | \n
|---|---|
exec | \npresentation of executed command | \n
stdout | \nstdout output of the command | \n
stderr | \nstderr output of the command | \n
exit | \nexit code of the command | \n
Configuration example:
\n{\n \"name\":\"Custom Script Handler\",\n \"capability\":\"MyCustomCapability\",\n \"implementation\":\"local\",\n \"exec\":\"python3 -u /scripts/my_script.py $${param1} $${param2}\"\n},ActionHandlers are integration components of the Bardioc system. They are used to\ninvoke actions on target systems. The ActionHandler establishes a websocket\nconnection with the Bardioc Action-API.\nAn ActionHandler can be deployed either on our SaaS platform or can be hosted on\na machine in your network. The latter has the advantage of not needing to open\ninbound ports on firewall. This document is for our customers who choose the latter.
\nThe installation requires three steps:
\nSetting up docker
\nDefining docker composition (docker-compose.yml)
\nStarting the ActionHandler container
\nThe Bardioc standard Action Handlers (SSH and HTTP) are provided using a docker image.\nThis image must be mounted in a maschine in your network running docker.\nFor general information on docker, please refer to the help pages on\nDockerHub. We assume you’ve installed docker and docker-compose.\nYou can verify by checking the versions:
\n$ docker -v\nDocker version xx.xx.xx, build xxxxxxxxxx\n$ docker-compose -v\ndocker-compose version x.xx.x, build xxxxxxxxAll Almato docker images are Linux based. The Docker image is published on our DockerHub repository. Please ensure that your docker installation can run linux based images.\nYou can confirm by pulling the latest image and check for error messages.
\ndocker pull almatoai/bardioc-actionhandler:latestIn case you are presented with an error message about Linux images not usable on your platform, please refer to the DockerHub help pages and adjust your installation.
\nThe docker composition defines which image and how the container is started. It is defined in a configuration file in YAML format and holds the information about for your docker image, the Bardioc instance and the type of actions you seek to execute.
\nversion: \"3.7\"\nservices:\n actionhandler:\n image: almatoai/bardioc-actionhandler:latest # Please update version number to the most recent tagged version\n container_name: actionhandler\n env_file: ~/[path to your environment file]/config.env\n restart: always\n volumes: #required for SSH only\n - type: bind\n source: [absolute path]/[private key file]\n target: /home/bardioc/.ssh/id_rsa\n environment:\n USE_DEFAULT_AH_CONFIGS: ExecuteCommand,HTTPRequest\n AH_CONFIG: >\n {}The next sections walk you through the required adjustments: We will pass an environment variable file with Bardioc credentials, mount the SSH private key and pass environment (when required) and define the Action Handler configuration map.
\nYou need to create an ActionHandler environment variable file for the docker image, typically named config.env. This file holds the credentials for your Bardioc instance.
Bardioc_USER=XXXXXXX\nBardioc_PASS=XXXXXXX\nBardioc_EXTERNAL_USER=XXXXXXX\nBardioc_EXTERNAL_PASS=XXXXXXXEach ActionHandler should have a dedicated service user account for the respective HaaS instance.\nIn case you do not have the credentials ready, please login to the Almato account management application Almato ID,\nnavigate to Member tab and search for users named 'actionhandler'.
\n![\"Search](\"/7.0/images/actionhandler/search_user.png\")
\nIf a dedicated ActionHandler user does not exist for your haas-instance yet, please contact\nyour organization admin. Make a note of the username and password and enter them in the environment variable file for Bardioc_USER and Bardioc_PASS. You can change the password by clicking the\noptions icon and select Edit Profile. In case of questions, you can also contact the Bardioc Support.
The Bardioc_EXTERNAL_USER and Bardioc_EXTERNAL_PASS environment variables are optional if the \"supply_token\" functionality is required and the token passed to the actual handler should use a different user account than the ActionHandler itself.
If you want to invoke SSH commands using the ActionHandler, you need to mount an RSA private key into the container and exchange the public key with the target system.\nThe key needs to be in pkcs8 format and should not have a passphrase. You can generate a new key pair with the following command:
\nssh-keygen -m pkcs8Save the key pair to the server running docker and set the source attributes in the docker composition to the location of the private key- and cert-file. Make sure the files are readable for the ActionHandler (by default, the ActionHandler is run as user bardioc with id 1000).\nDo not forget to add the content of the generated public key into ~/.ssh/authorized_keys on your the target system.
Please note: From a container perspective, even the local host is a remote target system, so you should be following the same steps. However, you might find some shortcuts in the DockerHub help pages for network configuration.
\nYour connector needs a configuration of which actions or capabilities to\nprocess and how to execute them. This is configured in a configuration variable\ncalled AH_CONFIG.
Please refer to How to configure capabilities in the standard Action Handler (Docker image)\nfor details on the configuration map.
\nOnce the composition is defined, you can start the ActionHandler docker container by issuing the following command:
\ndocker-compose upPlease make sure you are issuing this command from the same directory your docker-compose.yml file is located in. Upon sucess, you should see the following log entries:
[...]\nCreating network \"docker_default\" with the default driver\nCreating actionhandler ... done\nAttaching to actionhandler\nactionhandler_1 | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"Loaded configuration for capabilities: [\\\"HTTPRequest\\\"]\",\"metadata\":{}}\n[...]\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"Authenticating...\",\"metadata\":{}}\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"Successfully authenticated.\",\"metadata\":{}}\n[...]\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"Connected to core.almato.com using http\",\"metadata\":{}}\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"Upgrading connection...\",\"metadata\":{}}\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"WebSocket upgrade succeeded.\",\"metadata\":{}}\nactionhandler | {\"time\":\"...\",\"severity\":\"info\",\"message\":\"[ActionHandler] New ActionWS status: :ready\",\"metadata\":{}}\n[...]In case of generic docker problems, please refer to the DockerHub help pages. On problems related to the ActionHandler docker image, please contact Bardioc Support.
\nThe command above composes a docker container attached to your current console. In other words: If you close the console, the container will be terminated. To compose a detached container, please issue the following command:
\ndocker-compose up --detachMore information on attached and detached containers and their lifespan can be found on the DockerHub help pages.
\nYou can test your ActionHandler by executing the follow KIs from Bardioc™:
\non\n ogit/_id\nwhen\n ProcessIssue == \"TestHTTPRequest\"\ndo\n code: LOCAL::STATUS,\n body: LOCAL::RESULT = action(\n\tcapability: \"HTTPRequest\",\n\tparams: \"format=json\",\n\turl: \"https://api64.ipify.org/\",\n\ttimeout: \"10\"\n )\n if LOCAL::STATUS == \"200\" then\n log(\"SUCCESS: Your IP adress is ${LOCAL::RESULT}\")\n else\n log(\"ERROR ${LOCAL::STATUS}: ${LOCAL::RESULT}\")\n end\n delete(ProcessIssue)action action executed: GET https://api64.ipify.org/?format=json\ninfo\naction arguments: {\"Arguments\":{\"params\":\"format=json\",\"timeout\":\"10\",\"url\":\"https://api64.ipify.org/\"},\"Capability\":\"HTTPRequest\"}, results: {\"body\":\"{\\\"ip\\\":\\\"52.30.30.78\\\"}\",\"code\":200,\"exec\":\"GET https://api64.ipify.org/?format=json \",\"headers\":\"{\\\"Connection\\\":\\\"keep-alive\\\",\\\"Content-Length\\\":\\\"20\\\",\\\"Content-Type\\\":\\\"application/json\\\",\\\"Date\\\":\\\"Mon, 04 Oct 2021 12:41:42 GMT\\\",\\\"Server\\\":\\\"nginx/1.19.7\\\",\\\"Vary\\\":\\\"Origin\\\"}\"}\ndebug\nlog SUCCESS: Your IP adress is xxx.xxx.xxx.xxx\ninfoon\n ogit/_id\nwhen\n ProcessIssue == \"TestSSH\"\ndo\n stdout: LOCAL::OUTPUT,\n stderr: LOCAL::ERROR,\n exit: LOCAL::SYSTEMRC = action(\"ExecuteCommand\", command: \"echo Hello World\", host: \"{ip of your target system}\", user: \"{user for your target system}\", timeout: \"20\")\n if LOCAL::SYSTEMRC == \"0\" then\n log(\"SUCCESS: ${LOCAL::OUTPUT}\")\n else\n log(\"ERROR ${LOCAL::SYSTEMRC}: ${LOCAL::ERROR}\")\n end\n delete(ProcessIssue)Bardioc™ comes with a Docker image of a standard Action Handler. This Action\nHandler can be configured to perform different types of actions (capabilities).\nThis guide describes how to extend the standard image with own Action Handler\nfunctionality.
\nWe want to extend the standard docker image to process action handler commands\nwith a custom Python script. In this article, we will show you the following\nsteps to achieve this goal:
\nSetup folder structure for docker project
\nImplement a custom Python script
\nAdd your script as additional docker layer
\nBuild and use your extended docker image with docker-compose
\nBefore you can configure the Action Handler, make sure the following prerequisites\nare fulfilled:
\nMake sure you have installed docker and docker-compose on your PC.
\nYou have configured the desired capabilities in the Bardioc™ SaaS system.\nThis is currently done by our SaaS team for you - please open a ticket.
\nFor our sample project, we will create a simple folder structure in a root folder\nwhich we call project. Within this folder, we need one sub folder with the name\nmy_handler.
In the most basic version, we need a Python script, a requirements file, a Dockerfile and docker-compose.yml. Additionally, we recommend to store access credentials not directly in docker-compose.yml, but in a separate ActionHandler.env file.
After creating the files, the structure should look like this:
\nproject/\n my_handler/\n Dockerfile\n requirements.txt\n my_script.py\n ActionHandler.env\n docker-compose.ymlWe write a simple Hello World script, which prints out Hello World! and the received parameters. You find the source code for this script below.
import sys\n\ndef main():\n\tprint ('Hello World! \\n')\n\tprint ('Parameter 1: ' + sys.argv[1])\n\tprint ('Parameter 2: ' + sys.argv[2])\n sys.exit(0)\n\nif __name__ == \"__main__\":\n\tif len(sys.argv) > 2:\n\t\tmain()The requirements.txt file will remain empty for now. However, it is good practise to add it from the beginning, to add dependencies later.
We now create the Dockerfile with the following contents:
# syntax=docker/dockerfile:1\n\nFROM almatoai/bardioc-actionhandler:1.2.0\n# Please change version number to the most recent version from https://hub.docker.com/r/almatoai/bardioc-actionhandler/tags?page=1&ordering=last_updated\n\nUSER root\nCOPY . /scripts\nRUN apk add --no-cache python3 py3-pip \\\n\t&& pip3 install --no-cache-dir -r scripts/requirements.txt\n\nUSER bardiocWith the FROM statement we tell Docker to use the docker image almatoai/bardioc-actionhandler as base image. Please make sure that you pull the most recent version tag. You can find the tagged versions of the docker image here: https://hub.docker.com/r/almatoai/bardioc-actionhandler/tags?page=1&ordering=last_updated
On top of the base layer we copy our script to the /scripts folder in the\ndocker image. Afterwards, we install python and pip with the apk add command,\nand install dependencies with pip3 install.
By default, the base image operates as user bardioc. The above steps need to be\nperformed as root user. Afterwards, we need to set the user back to bardioc, so\nthat the action handler can run correctly.
Finally, we create a docker-compose file in the project directory to use the\nnew image and configure the action handler.
\nWe tell docker-compose to build a docker image from the ./my_handler folder. In the AH_CONFIG environment variable we specify our handler for a capability of our choice and tell it to execute the local script.
version: \"3.7\"\nservices:\n\n actionhandler:\n build:\n context: ./my_handler\n env_file: ./ActionHandler.env\n restart: always\n environment:\n AH_CONFIG: >\n {\"handlers\":[\n {\n \"name\":\"My custom action handler\",\n \"capability\":\"MyCustomCapability\",\n \"implementation\":\"local\",\n \"exec\":\"python3 -u /scripts/my_script.py $${param1} $${param2}\"\n }]}To build and run our new action handler, enter the following commands in your shell:
\ndocker-compose build\ndocker-compose up --no-start\ndocker-compose startIf everything works correctly, the action handler should now connect to Bardioc™ and listen for actions to execute.
\nBardioc™ enables you to connect Action Handlers to the Bardioc™ system to execute\nactions. These can be standard Action Handlers provided by Almato, or custom\nAction Handlers developed by yourself or third-party consultants. As this is a\ndistributed system, there can be some pitfalls in configuration and connectivity\nthat might prevent your Action Handlers from working right away. This guide helps\nyou to understand typical pitfalls and how to detect root causes.
\nIn general, there are two phases in which errors can occur:
\nWhile setting up and connecting an Action Handler to Bardioc™
\nWhen the Bardioc™ Engine processes automation tasks and sends actions to an\nAction Handler for execution
\nFor various debugging steps you need to know the container_id of your current container. This can be retrieved by calling the following command from a connected shell:
docker ps -aYou can also execute commands from within a running container using docker exec <container-id> COMMAND. You can also use docker exec to open a remote shell of the container:
docker exec -it <container-id> /bin/bashPlease also familiarize yourself with the DockerHub help pages on general information of docker containers and the commands available.
\nPlease refer to the DockerHub help pages on general information on logging of docker container.\nIf you have not altered the logging settings of the Action Handler container, by default docker is creating a JSON-based logging to this location:
\n/var/lib/docker/containers/<container_id>/<container_id>-json.logIn case you are using a docker-compose file to define your container (as proposed in our Action Handler Installation Guide), the most convenient way to retrieve the log file is calling:
\ndocker-compose logsPlease note this command needs to be issued from the same location/folder the docker-compose file is stored.
\nAttaching to actionhandler_actionhandler_1\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.470Z\",\"severity\":\"info\",\"message\":\"Loaded configuration for capabilities: [\\\"HTTPRequest\\\"]\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.474Z\",\"severity\":\"info\",\"message\":\"Getting supported Graph API versions...\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.478Z\",\"severity\":\"info\",\"message\":\"Running ActionHandler.RESTService.Endpoint with cowboy 2.8.0 at 0.0.0.0:8080 (http)\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.479Z\",\"severity\":\"info\",\"message\":\"Access ActionHandler.RESTService.Endpoint at http://localhost:8080\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.499Z\",\"severity\":\"info\",\"message\":\"Authenticating...\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.561Z\",\"severity\":\"info\",\"message\":\"Successfully authenticated.\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.561Z\",\"severity\":\"info\",\"message\":\"Connecting to core.almato.com:443 with %{connect_timeout: 60000, http2_opts: %{keepalive: :infinity}, http_opts: %{keepalive: :infinity}, protocols: [:http], retry: 10, retry_timeout: 100, transport: :tls}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.577Z\",\"severity\":\"info\",\"message\":\"Connected to core.almato.com using http\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.577Z\",\"severity\":\"info\",\"message\":\"Upgrading connection...\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.581Z\",\"severity\":\"info\",\"message\":\"WebSocket upgrade succeeded.\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.581Z\",\"severity\":\"info\",\"message\":\"[ActionHandler] New ActionWS status: :ready\",\"metadata\":{}}\n[...]\nactionhandler_1 | {\"time\":\"2021-09-27T12:29:12.418Z\",\"severity\":\"info\",\"message\":\"[ActionHandler] Executing \\\"HTTPRequest\\\": %{\\\"allow_insecure_https\\\" => \\\"false\\\", \\\"body\\\" => \\\"\\\", \\\"headers\\\" => \\\"Content-Type=application/json\\\", \\\"method\\\" => \\\"GET\\\", \\\"params\\\" => \\\"format=json\\\", \\\"timeout\\\" => 10000, \\\"url\\\" => \\\"https://api64.ipify.org/\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-09-27T12:29:13.074Z\",\"severity\":\"info\",\"message\":\"[ActionHandler] Sending result\",\"metadata\":{\"req_id\":\"xxxxx\"}}\nactionhandler_1 | {\"time\":\"2021-09-27T12:29:13.146Z\",\"severity\":\"info\",\"message\":\"[ActionHandler.Responder] Response acked\",\"metadata\":{\"req_id\":\"xxxxx\"}}In case debugging is required, you can lower the log level of the ActionHandler to debug. This is done by performing the following command from within the container:
action_handler/bin/action_handler rpc \"Logger.configure level: :debug\"As logging in debug is very intensive, remember to raise the log level to info once debugging is completed.
debugactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.709Z\",\"severity\":\"debug\",\"message\":\"[WsConnection] Just received text message on action-ws:\\n%{\\\"capability\\\" => \\\"HTTPRequest\\\", \\\"handler\\\" => \\\"xxxxx\\\", \\\"id\\\" => \\\"xxxxx\\\", \\\"parameters\\\" => %{\\\"allow_insecure_https\\\" => \\\"false\\\", \\\"body\\\" => \\\"\\\", \\\"headers\\\" => \\\"Content-Type=application/json\\\", \\\"method\\\" => \\\"GET\\\", \\\"params\\\" => \\\"format=json\\\", \\\"timeout\\\" => 10000, \\\"url\\\" => \\\"https://api64.ipify.org/\\\"}, \\\"timeout\\\" => 10000, \\\"type\\\" => \\\"submitAction\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.709Z\",\"severity\":\"debug\",\"message\":\"[ActionHandler] Received message: %{\\\"capability\\\" => \\\"HTTPRequest\\\", \\\"handler\\\" => \\\"xxxxx\\\", \\\"id\\\" => \\\"xxxx\\\", \\\"parameters\\\" => %{\\\"allow_insecure_https\\\" => \\\"false\\\", \\\"body\\\" => \\\"\\\", \\\"headers\\\" => \\\"Content-Type=application/json\\\", \\\"method\\\" => \\\"GET\\\", \\\"params\\\" => \\\"format=json\\\", \\\"timeout\\\" => 10000, \\\"url\\\" => \\\"https://api64.ipify.org/\\\"}, \\\"timeout\\\" => 10000, \\\"type\\\" => \\\"submitAction\\\"}\",\"metadata\":{\"req_id\":\"xxxxx\"}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.710Z\",\"severity\":\"debug\",\"message\":\"[WsConnection] Pushing message to action-ws:\\n%{code: 200, id: \\\"xxxxx\\\", message: \\\"\\\", type: \\\"acknowledged\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.710Z\",\"severity\":\"debug\",\"message\":\"[GraphConn.WS] Pushing \\\"{\\\\\\\"code\\\\\\\":200,\\\\\\\"id\\\\\\\":\\\\\\\"xxxxx\\\\\\\",\\\\\\\"message\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"acknowledged\\\\\\\"}\\\"\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.710Z\",\"severity\":\"info\",\"message\":\"[ActionHandler] Executing \\\"HTTPRequest\\\": %{\\\"allow_insecure_https\\\" => \\\"false\\\", \\\"body\\\" => \\\"\\\", \\\"headers\\\" => \\\"Content-Type=application/json\\\", \\\"method\\\" => \\\"GET\\\", \\\"params\\\" => \\\"format=json\\\", \\\"timeout\\\" => 10000, \\\"url\\\" => \\\"https://api64.ipify.org/\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:04.710Z\",\"severity\":\"debug\",\"message\":\"Sending headers [{\\\"Content-Type\\\", \\\"application/json\\\"}]\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.357Z\",\"severity\":\"debug\",\"message\":\"Received header [{\\\"Server\\\", \\\"nginx/1.19.7\\\"}, {\\\"Date\\\", \\\"Mon, 04 Oct 2021 12:34:05 GMT\\\"}, {\\\"Content-Type\\\", \\\"application/json\\\"}, {\\\"Content-Length\\\", \\\"20\\\"}, {\\\"Connection\\\", \\\"keep-alive\\\"}, {\\\"Vary\\\", \\\"Origin\\\"}]\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.358Z\",\"severity\":\"debug\",\"message\":\"GET https://api64.ipify.org/?format=json => 200: {\\\"ip\\\":\\\"xxx.xxx.xxx.xxx\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.358Z\",\"severity\":\"info\",\"message\":\"[ActionHandler] Sending result\",\"metadata\":{\"req_id\":\"xxxxx\"}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.358Z\",\"severity\":\"debug\",\"message\":\"[WsConnection] Pushing message to action-ws:\\n%{id: \\\"xxxxx\\\", result: \\\"{\\\\\\\"body\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"xxx.xxx.xxx.xxx\\\\\\\\\\\\\\\"}\\\\\\\",\\\\\\\"code\\\\\\\":200,\\\\\\\"exec\\\\\\\":\\\\\\\"GET https://api64.ipify.org/?format=json \\\\\\\",\\\\\\\"headers\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"Connection\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"keep-alive\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Content-Length\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"20\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Content-Type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"application/json\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Date\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"Mon, 04 Oct 2021 12:34:05 GMT\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Server\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"nginx/1.19.7\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Vary\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"Origin\\\\\\\\\\\\\\\"}\\\\\\\"}\\\", type: \\\"sendActionResult\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.359Z\",\"severity\":\"debug\",\"message\":\"[GraphConn.WS] Pushing \\\"{\\\\\\\"id\\\\\\\":\\\\\\\"xxxxx\\\\\\\",\\\\\\\"result\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"body\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"xxx.xxx.xxx.xxx\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\\"exec\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"GET https://api64.ipify.org/?format=json \\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"headers\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Connection\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"keep-alive\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Content-Length\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"20\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Content-Type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"application/json\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Date\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Mon, 04 Oct 2021 12:34:05 GMT\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Server\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"nginx/1.19.7\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Vary\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Origin\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\"}\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"sendActionResult\\\\\\\"}\\\"\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.406Z\",\"severity\":\"debug\",\"message\":\"[WsConnection] Just received text message on action-ws:\\n%{\\\"code\\\" => 200, \\\"id\\\" => \\\"xxxxx\\\", \\\"message\\\" => \\\"\\\", \\\"type\\\" => \\\"acknowledged\\\"}\",\"metadata\":{}}\nactionhandler_1 | {\"time\":\"2021-10-04T12:34:05.407Z\",\"severity\":\"info\",\"message\":\"[ActionHandler.Responder] Response acked\",\"metadata\":{\"req_id\":\"xxxxx\"}}A list of all loaded capability configurations of the Action Handler is written to the log file upon creation of the container:
\nactionhandler_1 | {\"time\":\"2021-09-27T11:56:51.470Z\",\"severity\":\"info\",\"message\":\"Loaded configuration for capabilities: [\\\"HTTPRequest\\\"]\",\"metadata\":{}}This gives you an easy way to verify that the docker composition and Action Handler configuration was loaded successfully.\nIn case no capability configuration is specified, the container will refuse to start with the following log entries:
\nactionhandler_1 | {\"time\":\"2021-10-27T13:14:11.392Z\",\"severity\":\"info\",\"message\":\"Application action_handler exited: exited in: ActionHandler.start(:normal, [])\n ** (EXIT) an exception was raised:\n ** (ActionHandler.Configuration.Error) AH_CONFIG is empty and nothing is specified in USE_DEFAULT_AH_CONFIGS\n (action_handler 0.1.0) lib/action_handler/configuration.ex:36: ActionHandler.Configuration.capabilities/0\n (action_handler 0.1.0) lib/action_handler.ex:12: ActionHandler.start/2\n (kernel 6.5.2.3) application_master.erl:277: :application_master.start_it_old/4\",\"metadata\":{}}In case you seek further information about the configuration, you can check the environment variables by performing the following command from within the container:
\nprintenvAmong other information, you should be presented with your AH_CONFIG handler definition from your composition file.\nIn case your handler definition was not loaded successfully, please re-visit your docker composition and verify your setup.
You can also check the actual capability configuration used by the Action Handler by performing the following commands from within the container:
\n#open remote command shell of AH\n/action_handler/bin/action_handler remote\n#print configuration for given capability\nActionHandler.Configuration.for_capability \"HTTPRequest\"Please note that this command cannot be invoked from a connected shell using docker exec as the printout is not passed along.
For each Bardioc™ instance, there is a configuration which capabilities (action\ntypes) are enabled, and which Action Handler will process which types of actions.\nWhen the Bardioc™ Engine executes an action from a Knowledge Item, it looks up\nwhich Action Handler to dispatch the action. If there is no Action Handler\nconfigured for the specified capability, the Engine™ cannot dispatch the\naction. In this case, you will find the following error message in the Engine log\nin the Task Inspector:
\naction action failed: handlers for capability ExecuteLocalCommand not found\n_warn_\n
If you encounter this error message, please check the applicability configuration\nfor your Bardioc™ instance with our SaaS Ops Department.
\nIn case your applicability is defined correctly, each action call is dispatched to an Action Handler container.\nIf however your Action Handler container is not configured to execute the action, you will find the following error message in the Engine log in the Task Inspector:
\naction failed: handler errors [{%{\"code\" => 404, \"message\" => \"Unhandled capability \\\"ExecuteLocalCommand\\\"\"}}]\n_warn_\nIf you encounter this error message, please check the configuration of your Action Handler container as described in How to configure capabilities.
\nAction Handlers are integration components of the Bardioc™ system. They are used to invoke actions on target systems. This document walks you through the configuration procedure of the Bardioc™ WinRM/Powershell Action Handler.
\nFrom a technical perspective, the Bardioc™ WinRM/Powershell Action Handler is a python based custom extension script to the standard Bardioc™ Action Handler Docker image.
\nBefore you can configure the Action Handler, make sure the following prerequisites\nare fulfilled:
\nYou have followed the instructions in Standard Docker image for Action Handlers\nto setup the Action Handler Docker container. Please make sure that the Action\nHandler correctly connects to the Bardioc API.
\nYou have received the WinRM/Powershell Action Handler custom extension. You can obtain the package from the Bardioc Support team.
\nYou have a Windows® machine with administrator priviledges and Powershell®, accessible from the Action Handler host
\nThe WinRM/Powershell Action Handler is using the capabilitiy ExecuteWindowsCommand. You need to register this capability for your Action Handler user.\nRegistration is currently done by the Bardioc Support team - please open a ticket, naming the capabilitiy and the Ation Handler user you would like to register it for.
Once the capabilities are correctly assigned in the Bardioc™ system, you can proceed with\nthe steps below.
\nThe standard Action Handler comes as a Docker image. You need to use docker-compose\nto configure the Docker container for you individual use. This is done in a file\ncalled docker-compose.yml. The docker-compose tool reads this file to instantiate\nyour Docker container from the image.
Rather than using the provided Action Handler Docker image directly, you need to add a custom build command to include the WinRM/Powershell extension.
\ndocker-compose.yml including the custom build commandversion: \"3.7\"\nservices:\n actionhandler:\n image: almatoai/bardioc-actionhandler:latest #Please choose the version which serves your purpose.\n build:\n context: ./buildAH\n\tenv_file: BardiocUser.env\n\t[...]Make sure you place the content of the custom extension package (the buildAH folder in particular) to the same location as your docker-compose.yml.
ExecuteWindowsCommand capability configuration{\n\t\"name\": \"Windows Remote Commands\",\n\t\"capability\": \"ExecuteWindowsCommand\",\n\t\"implementation\": \"local\",\n\t\"exec\": \"python3 -u /scripts/windows_remote.py $${host} $${command_type} '$${command}' '$${arguments}'\"\n}BardiocUser.envBardioc_USER=ENTER_USERNAME_HERE\nBardioc_PASS=ENTER_PASSWORD_HERE\nWINRM_PASSWORD=ENTER_WINDOWS_PASSWORD_HERE\nWINRM_USERNAME=ENTER_WINDOWS_USERNAME_HERE\n
on\n ogit/_id\nwhen\n ProcessIssue == \"Execute Powershell command\"\n ? command := \"dir\"\n ? arguments := \"C:\\ \"\n host\ndo\n stdout: OUTPUT, stderr: LOCAL::ERROR, exit: LOCAL::RC = action(\n capability: \"ExecuteWindowsCommand\",\n host: \"${host}\",\n command:\"${command}\",\n arguments:\"${arguments}\"\n )\n log(OUTPUT)\n log.error(LOCAL::ERROR)\n\n delete(ProcessIssue)Once you’ve received a predicted category from the classifier, we do recommend a root cause analysis to validate correctness.\nThis feedback in the form of InputString / correctCategory needs to be provided to the classifier for additional training.\nAs adding one feedback item won’t have an immediate impact on the classifier, we have configured the default value for retraining the classifier\nto be 100 (feedback entries). See the section below to find out how to change this value or even turn off automatic retraining from user feedback.
\nIn order to learn from an issue where the classifier was used but category was manually adjusted, the following attributes must be stored on those issues:
\nclassifierName: Name of the classifier model used (used as classifier_name in the action call)
\nInputString: The string used to obtain the inital category (used as input_string in the action call)
\nclassifierVersion: Version of the classifier used (model_version as returned from the classifier action call)
\ncorrectCategory: Category that was manually set
\non\n ogit/_id\nwhen\n ProcessIssue == \"test classifier\" #Put proper ToDo var here\n description\ndo\n classifierName = \"tickets_pipeline\"\n InputString = description\n category: ClassificationCategory,\n probability: ClassificationProbability,\n other_categories: ClassifierCategories,\n model_version: classifierVersion,\n exit: LOCAL::SYSTEMRC = action(\n capability: \"ClassifierPredict\",\n classifier_name: classifierName,\n input_string: InputString,\n timeout: 3000\n )\n add(ClassifierCategories = ClassificationCategory)\n\n if LOCAL::SYSTEMRC == 0 then\n EvaluateCategorization = ProcessIssue\n delete(ProcessIssue)\n endAll feedback entries can be viewed throught the classifier app. Once the the threshold (default 100) is reached all feedback entries for a given classifier\nwill be combined with the existing training data into a new training data and the retraining is triggered. This will result in a new version with new performance metrics.
\nThere are two setups possible to determinne the point at which feedback is processed and retraining is checked.
\nIn this setup, no additional ToDo-variables are needed on the issue.\nAt any point in time, a classifier maintanance task can be created separatly (ie. daily via cron-job).\nThe task should be created on the ogit/ML/PredictionModel representing the classifier.\nThe maintanance process will identify issues with training information, create the feedback nodes, and initiate the training process if treshhold is exceeded.
{\n \"ogit/_scope\": \"{{scope}}\",\n \"ogit/Automation/originNode\": \"{{id of PredictionModel}}\",\n \"/CheckNewTrainings\": \"{{name of PredictionModel}}\",\n \"/CheckClassifierRetrain\": \"{{name of PredictionModel}}\",\n \"ogit/subject\": \"Check retrain of {{name of PredictionModel}}\",\n \"ogit/Automation/issueType\": \"ogit/ML/Event\"\n}Please note that in sheduled training mode, only one feedback item is supported from each issue in Bardioc.\nIn case you use multiple classifiers calls on the same issue, please ensure the correct classifierName attribut to generate the feedback node.
In case a feedback item should be created immediatelly with each new teaching, the ToDo-variable CreateNewMLFeedback needs to be added to the issue (value could be the classifier name).\nAlso adding the ToDo-variable CheckClassifierRetrain will trigger the creation of a sub-issue, initiating the classifier maintanance process right away.
In the Bardioc graph, the ogit/ML/PredictionModel representing the classifier has the option to provide a training treshhold (attribut FeedbackRetryInterval).\nIn case the current number of feedback nodes for the active classifier version exceeds this number, the training process is triggered.\nIf you prefer not to retrain the model automatically, please omit the ToDo-variable CheckClassifierRetrain on issues.
The list of all available categories from a classifier model can be checked in the GUI and is also given as an output of the Action Handler call (return value other_categories). Even though it is possible to put any category name into a feedback node, we do recommend to only use existing categories to ensures reliable prediction results. In case you wish to add additional categories, please ensure sufficient training data.
The Ticket Classifier is an application for data scientist that allows the management of classifiers. A classifier takes uncategorized data and predicts a category from any given input String.\nIn order for a classifier to work, they must be trained first, which happens when you upload training data.
\nIn order to access the Bardioc Desktop application Ticket Classifier, a user must be assigned to the correct team. If the classifier is enabled for your instance, you will find a team\ncalled haasXXXX_ticket_classifier in id.almato.com. Your organisation admin will be able to add you to this team.
\nAs described in detail in the section below, the csv file must consist of a list of descriptions and categories.\nIf the csv file doesnt match the required format, the the ticket classifier application will notifiy you. If successfull, a new classifier is immediately being trained.\nDepending on the size of the classifier, it may take a few minutes for the training to be complete. Only trained classifiers can be used to predict the category.
\nThe name of the trainingdata is used in the Knowledge Item to reference the classifier
\n action(capability: \"ClassifierPredict\", classifier_name: \"swedish\", input_string: InputString, timeout: 3000)In case you want to create a new version of an existing classifier (because you want to add more samples to your training data) simply add content to your existing file and and upload it (keep the filename).\nThe new version will automatically be set as the active one.\nActive means that this version will be used by the Knowledge Items that have reference this classifier_name.\nEach classifier can only ever have one active version. However you can choose which version you want to activate by using the toggle button.
\n![\"versions\"](\"/7.0/images/ticket_classifier/versions.png\")
\nA trained classifier provides you with the following information
\n![\"details\"](\"/7.0/images/ticket_classifier/details.png\")
\nModel Accuracy:
\nDownload: Ability to download the training data (as csv)
\nDuration: How long it took to train the model
\nDropdown for each category from the trainingdata including one entry for all categories
\nPrecision: The higher the precision, the less false positives.\nRecall: The higher the recall, the less false negatives.\nF1 Score: F1 Score is a weighed average between precision and recall.
\nPlease make sure that you have at least on classifier created using the Bardioc Desktop app Ticket Classifier.
\nThe following KI snippet illustrates how to use a trained classifier to predict a category from any given input String
\nki\n name: \"Classify\"\n description: \"KI to test Ticket Classifier\"\n version: \"....\"\non\n ogit/_type\nwhen\n InputString\n not ClassificationCategory\ndo\n category: ClassificationCategory,\n probability: ClassificationProbability,\n other_categories: OtherClassificationCategories,\n exitcode: LOCAL::SYSTEMRC = action(capability: \"ClassifierPredict\", classifier_name: \"swedish\", input_string: InputString, timeout: 3000)They key parameters here are
\nthe classifier_name, which is the name of your classifier created in the classifier app.
\nthe input_string: in this example the variable called Inputstring
\nThe output will be
\ncategory: the predicted category
\nprobability: the probability of the predicted category
\nother_categories: a list of all available categories (excluding the predicted one)
\n500: the classifier_name does not exist (there’s no trained model for this name, please create one or check the spelling)
\n200: prediction successful
\nWhen writing a domain object (SDF) to the REST API, it creates a transaction to represent the task of performing the write in the graph. The reason for this is that a domain object can correspond to many operations on the graph (queries, create new object, update object, disconnect/connect edges, timeseries, attachments). As such, any of these operations can fail, take long time, etc. The transaction is a way for the client to check the state of the write (waiting, in progress, failure, success).
\nThe transactions can be checked by
\ncurl https://doapi.almato.com/$LINKwhere SERVERNAME is the name of the server the api is running on and LINK is the link returned from the creation call.
\nThe call will return:
\n| Parameter | \nDescription | \n
|---|---|
link | \nThe link to the transaction. It can be used to check the status of the transaction. | \n
object | \nThe link to the object. It can be used to query the object. | \n
status | \nStatus of the message (waiting, in-progress, done-success, done-failure). In the beginning it will be waiting. | \n
Example to check an transaction from the server the api is running on:
\ncurl -H 'Authorization: Bearer <TOKEN>' https://doapi.almato.com/views/default/transactions/c512dd99-f711-4b79-bb39-c91d5bba8080Example output for a successful transaction :
\n{\n \"link\": \"/views/default/transactions/3344b3e8-452e-4b73-925c-c23b8e1356c0\",\n \"object\": \"/views/default/objects/inc-0001\",\n \"status\": \"done-success\",\n \"errors\": []\n}Example output for a transaction where the validation in the Bardioc Graph Database failed
\n{\n \"link\": \"/views/default/transactions/4bcff845-9783-4c40-abde-1abf01633081\",\n \"object\": \"/views/default/objects/m2\",\n \"status\": \"done-failure\",\n \"errors\": [\n \"validation failed\"\n ]\n}The classifier provides a supervised machine learning categorizer. Training data must be provided as annotated data samples; i.e. a \"Ticket description\" as input sample and an according output category.
\nFor example, a ticket description \"Unable to find RDP client at citrix desktop\" could be classified as category Citrix Issue.
\nWhen sampling training data, one should take care of these recommendations:
\nCategories should be precise and non-overlapping.
\nWe recommend a maximum of 20-40 categories in total.
\nThe dataset should not be too imbalanced; i.e. there should not be a few categories containing the majority of ticket descriptions. Each category should contain at least a few dozen example tickets. Any category must not have less than 10 example tickets.
\nFurthermore, a category named other should be introduced. This should contain example texts that don’t fit any of the desired above ticket categories. This serves the purpose to reduce the probability of a false positive categorization.
\nWhen retraining the model with new additional data, care should be taken of temporal drift. Categorization types can change with time, and old training data can get outdated. A mechanism to track ticket dates and to discard outdated tickets should be implemented.
\nExample categories for a 4-class categorization model (with additional 'other' class):
\n\"Citrix Issue\"\n\"VPN Issue\"\n\"Windows Password\"\n\"MFA Password\"\n\"Other\"Training data should be provided in .csv file format. The file should contain one training sample per line, in the format:
\"description\",\"category\"
and should contain this as the first line in the CSV file as the csv header.
\nFormat requirements:
\nNeither description and category entries should contain any newlines or other ASCII control codes.
The entries should be encoded in UTF-8 format.
The CSV fields are separated with a comma (,) character.
The CSV fields are quoted with double quotes (\").
The description entry contains the input ticket description text.
The category entry contains the according classification category, in plain text.
Example:
\n\"description\",\"category\"\n\"Citrix login issue\",\"Citrix Issue\"\n\"Die Anforderung wurde abgeschlossen\",\"Other\"\n\"General Incident - Usuario VPN\",\"VPN Issue\"\n\"VM hardware update\",\"Other\"\n\"VPN funktioniert nicht\",\"VPN Issue\"\n\"Windows User gesperrt\",\"Windows Password\"\n\"General Incident - CITRIX login \",\"Citrix Issue\"\n\"Incident - VPN need phone code\",\"VPN Issue\"\n\"Unable to find RDP client at citrix desktop\",\"Citrix Issue\"\n\"User kann im VPN nicht anmelden\",\"VPN Issue\"\n...The following call can be used to update/create a domain object.
\ncurl -kH 'Content-type:application/json' -H 'Authorization: Bearer <TOKEN>' -X PUT \\\n'http://'$SERVERNAME':'$PORT'/views/'$VIEWID'/objects/'$EXTERNALID -d 'SDFMESSAGE'| Parameter | \nDescription | \n
|---|---|
SERVERNAME | \nName of the server where the api is running | \n
PORT | \nPort of the api | \n
VIEWID | \nId of view | \n
EXTERNALID | \nExternal id of the object to be send to | \n
SDFMESSAGE | \nSDF message | \n
The SDF message contains
\n| Parameter | \nDescription | \n
|---|---|
$type | \nSDF type, with the SDFID as value | \n
| \n | Key value pairs of the sdf attributes and the corresponding values | \n
The call will return
\n| Parameter | \nDescription | \n
|---|---|
link | \nThe link to the transaction. It can be used to check the status of the transaction. | \n
object | \nThe link to the object. It can be used to query the object. | \n
status | \nStatus of the message (waiting, in-progress, done-success, done-failure). In the beginning it will be waiting. | \n
numTotal | \nNumber of actions to be handled by the Domain Object API | \n
results | \nResults of the actions to be handle by the Domain Object API. In the beginning {}. | \n
When default view for machine and software are used, the following call can be used to create a machine corresponding to a software node:
\ncurl -kH 'Content-type:application/json' -H 'Authorization: Bearer <TOKEN>' -X PUT \\\n'https://doapi.almato.com/views/default/objects/machine_01' \\\n-d'{\"$type\":\"configMachine\",\"name\":\"MACHINE\",\"systemType\":\"Linux\",\"software\":{\"soft1\":{\"name\":\"SOFTWARE\",\"softwareClass\":\"Database\",\"softwareSubClass\":\"MySQL\"}}}'The sdf message:
\n{\n \"$type\": \"configMachine\",\n \"name\": \"MACHINE\",\n \"systemType\":\"Linux\",\n \"software\": {\n \"soft1\": {\n \"name\": \"SOFTWARE\",\n \"softwareClass\":\"Database\",\n \"softwareSubClass\":\"MySQL\"\n }\n }\n}Will create the following two nodes, which are connected via a ogit/relates edge.
{\n \"ogit/_type\": \"ogit/Automation/MARSNode\",\n \"ogit/name\": \"SOFTWARE\",\n \"ogit/_xid\": \"xcvbjkiuytfcvbnjkuytfbjkiuygvb~~~soft1\"\n}\n\n{\n \"ogit/_v-id\": \"1547557953991-U1yD6Y\",\n \"ogit/_xid\": \"xcvbjkiuytfcvbnjkuytfbjkiuygvb~~~machine_01\",\n \"ogit/name\": \"MACHINE\"\n}The call will return a message like:
\n{\n \"link\": \"/views/default/transactions/ebec3a3b-3f77-4906-b6bc-2110b6efa805\",\n \"object\": \"/views/default/objects/machine_01\",\n \"status\": \"waiting\",\n \"errors\": []\n}When the default view for a incident is used, the following call can be used to create a Incident:
\ncurl -kH 'Content-type:application/json' -H 'Authorization: Bearer <TOKEN>' -X PUT \\\n'https://doapi.almato.com/views/default/objects/inc-0001' \\\n-d'{\"$type\":\"incident\", \"subject\": \"Testing\", \"originNode\": \"machine_01\", \"summary\": \"This is the summary\", \"priority\": \"important\", \"description\": \"This is the description\", \"urgency\": \"high\", \"sourceStatus\": \"open\"}'The SDF message in this call is
\n{\n \"$type\": \"incident\",\n \"subject\": \"Testing\",\n \"originNode\": \"externalModelId\",\n \"summary\": \"This is the summary\",\n \"priority\": \"important\",\n \"description\": \"This is the description\",\n \"urgency\": \"high\",\n \"sourceStatus\": \"open\"\n}In Bardioc the following AutomationIssue will be created:
\n{\n \"/ProcessIssue\": \"process me\",\n \"/actual_type\": \"IncidentType\",\n \"/description\": \"This is the description\",\n \"/priority\": \"important\",\n \"/sourceStatus\": \"open\",\n \"/summary\": \"This is the summary\",\n \"/urgency\": \"high\",\n \"ogit/Automation/originNode\": \"externalModelId\",\n \"ogit/_graphtype\": \"vertex\",\n \"ogit/_id\": \"cjqzbn759dxq27f58egrs3ped\",\n \"ogit/_type\": \"ogit/Automation/AutomationIssue\",\n \"ogit/_xid\": \"xcvbjkiuytfcvbnjkuytfbjkiuygvb~~~inc-0001\",\n \"ogit/status\": \"PROCESSING\",\n \"ogit/subject\": \"Testing\"\n}The value used in the originNode must be known external id from the model Node. E.g. the id of the machine in the connected tool, which already was created in Bardioc.
The call will return a message like:
\n{\n \"link\": \"/views/default/transactions/ebec3a3b-3f77-4906-b6bc-2110b6efa805\",\n \"object\": \"/views/default/objects/inc-0001\",\n \"status\": \"waiting\",\n \"numTotal\": 1,\n \"results\": {}\n}$ curl -s -H \"Authorization: Bearer <TOKEN>\" https://doapi.almato.com/actuator/healthHealth check parameteres are:
\ndiskSpace
\ndoapiframework
\nbardiocgraph
\nping
\n{\"status\":\"UP\",\"components\":{\"diskSpace\":{\"status\":\"UP\",\"details\":{\"total\":32199651328,\"free\":21511225344,\"threshold\":10485760}},\"bardiocgraph\":{\"status\":\"UP\"},\"ping\":{\"status\":\"UP\"}}}DiskSpace reports the current state of the disk and ping checks the ping endpoint of the application. * If the status is down for ping and diskSpace, the REST API will be unable to handle requests and the container needs a restart.
\nIf the bardiocgraph status is down, this is mostly due to network or infrastructure issue.
\nUpdates on objects sent back from the Domain Object API for the VIEWID can be checked by the following REST call:
\ncurl https://doapi.almato.com/views/$VIEWID/updates/$UPDATENUMBERThe call will return:
\n| Parameter | \nDescription | \n
|---|---|
link | \nThe link to the update. | \n
object | \nThe object as json. | \n
offset | \nThe offset in the updates. | \n
Example to check the first update on the server the Domain Object API runs.
\ncurl -H 'Authorization: Bearer <TOKEN>' https://doapi.almato.com/views/default/updates/1The command will give a result like:
\n{\n \"link\": \"/views/default/updates/1\",\n \"offset\": 1,\n \"object\": {\n \"softwarename\": \"SOFTWARE\",\n \"$type\": \"SimpleConf\",\n \"$id\": \"soft1\"\n }\n}In Bardioc™ you can use action handlers to performs activities in other\napplications and systems. Available commands are specified as Capabilities in\nthe Bardioc™ platform. In the list below you can find the specified capabilities,\nsorted by application area.
Create Query in DBM
\n{\n \"ogit/Automation/mandatoryParameters\": {},\n \"ogit/Automation/optionalParameters\": {\n \"dataRange\": {\n \"description\": \"dataRange\"\n },\n \"title\": {\n \"description\": \"title\"\n },\n \"queryType\": {\n \"description\": \"queryType\",\n \"default\": \"TYPE_GENERAL\"\n },\n \"groupBys\": {\n \"description\": \"groupBys\",\n \"default\": \"FILTER_ADVERTISER_CURRENCY\"\n },\n \"filters\": {\n \"description\": \"filters\"\n },\n \"metrics\": {\n \"description\": \"metrics\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Download Report from DBM
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"linkLatestReport\": {\n \"description\": \"Link to the latest report\"\n },\n \"target_xid\": {\n \"description\": \"Xid of node to put the report into\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"startTimeMs\": {\n \"description\": \"startTimeMs\",\n \"default\": \"\"\n }\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Get Query from DBM
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"queryId\": {\n \"description\": \"Id of query\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"startTimeMs\": {\n \"description\": \"startTimeMs\",\n \"default\": \"\"\n }\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Run Query in DBM
\n{\n \"ogit/Automation/mandatoryParameters\": {},\n \"ogit/Automation/optionalParameters\": {\n \"dataRange\": {\n \"description\": \"dataRange\"\n },\n \"startTimeMs\": {\n \"description\": \"startTimeMs\",\n \"default\": \"\"\n },\n \"endTimeMs\": {\n \"description\": \"endTimeMs\",\n \"default\": \"\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Check Updated InsertionOrders from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"filter\": {\n \"description\": \"filter for request\",\n \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n },\n \"lastUpdate\": {\n \"description\": \"Timestamp of last update\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Check Updated LineItems from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"insertionOrderId\": {\n \"description\": \"id of insertionOrder\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"filter\": {\n \"description\": \"filter for request\",\n \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n },\n \"lastUpdate\": {\n \"description\": \"Timestamp of last update\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create and import InsertionOrder from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"campaignId\": {\n \"description\": \"id of campaign\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"displayName\": {\n \"description\": \"displayName\"\n },\n \"entityStatus\": {\n \"description\": \"entityStatus\",\n \"default\": \"ENTITY_STATUS_DRAFT\"\n },\n \"pacingPeriod\": {\n \"description\": \"pacingPeriod\"\n },\n \"pacingType\": {\n \"description\": \"pacingType\"\n },\n \"timeUnit\": {\n \"description\": \"timeUnit\"\n },\n \"timeUnitCount\": {\n \"description\": \"timeUnitCount\"\n },\n \"maxImpressions\": {\n \"description\": \"maxImpressions\"\n },\n \"performanceGoalType\": {\n \"description\": \"performanceGoalType\"\n },\n \"performanceGoalAmountMicros\": {\n \"description\": \"performanceGoalAmountMicros\"\n },\n \"budgetUnit\": {\n \"description\": \"budgetUnit\"\n },\n \"budgetAmountMicros\": {\n \"description\": \"budgetAmountMicros\"\n },\n \"startDate\": {\n \"description\": \"startDate\"\n },\n \"endDate\": {\n \"description\": \"endDate\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create and import LineItem from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"insertionOrderId\": {\n \"description\": \"id of insertionOrder\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"displayName\": {\n \"description\": \"displayName\"\n },\n \"lineItemType\": {\n \"description\": \"lineItemType\"\n },\n \"entityStatus\": {\n \"description\": \"entityStatus\",\n \"default\": \"ENTITY_STATUS_DRAFT\"\n },\n \"flightDateType\": {\n \"description\": \"flightDateType\"\n },\n \"startDate\": {\n \"description\": \"startDate\"\n },\n \"endDate\": {\n \"description\": \"endDate\"\n },\n \"budgetAllocationType\": {\n \"description\": \"budgetAllocationType\"\n },\n \"maxAmount\": {\n \"description\": \"maxAmount\"\n },\n \"pacingPeriod\": {\n \"description\": \"pacingPeriod\"\n },\n \"pacingType\": {\n \"description\": \"pacingType\"\n },\n \"timeUnit\": {\n \"description\": \"timeUnit\"\n },\n \"timeUnitCount\": {\n \"description\": \"timeUnitCount\"\n },\n \"maxImpressions\": {\n \"description\": \"maxImpressions\"\n },\n \"markupType\": {\n \"description\": \"markupType\"\n },\n \"markupAmount\": {\n \"description\": \"markupAmount\"\n },\n \"budgetAmountMicros\": {\n \"description\": \"budgetAmountMicros\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Advertiser by Id from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Advertisers by Partner from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"partnerId\": {\n \"description\": \"id of partner\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"filter\": {\n \"description\": \"filter for request\",\n \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n },\n \"fields\": {\n \"description\": \"fields for request\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import InsertionOrder by Id from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"insertionOrderId\": {\n \"description\": \"id of insertionOrder\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import InsertionOrders by Advertiser from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"filter\": {\n \"description\": \"filter for request\",\n \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n },\n \"fields\": {\n \"description\": \"fields for request\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import LineItem by Id from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"lineItemId\": {\n \"description\": \"id of lineItem\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import LineItems by InsertionOrder from DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"insertionOrderId\": {\n \"description\": \"id of insertionOrder\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"filter\": {\n \"description\": \"filter for request\",\n \"default\": \"entityStatus= \\\"ENTITY_STATUS_ACTIVE\\\"\"\n },\n \"fields\": {\n \"description\": \"fields for request\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Patch InsertionOrder in DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"insertionOrderId\": {\n \"description\": \"id of insertionOrder\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"xid\": {\n \"description\": \"xid\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Patch LineItem in DV360
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"advertiserId\": {\n \"description\": \"id of advertiser\"\n },\n \"lineItemId\": {\n \"description\": \"id of lineItem\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"xid\": {\n \"description\": \"xid\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Check Updated AdGroups in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"CampaignId\": {\n \"description\": \"id of campaign\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"LastChangeTrackingVersion\": {\n \"description\": \"LastChangeTrackingVersion\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Check Updated Campaigns from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"AdvertiserId\": {\n \"description\": \"id of advertiser\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"LastChangeTrackingVersion\": {\n \"description\": \"LastChangeTrackingVersion\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create AdGroup in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"CampaignId\": {\n \"description\": \"CampaignId\"\n },\n \"AdGroupName\": {\n \"description\": \"AdGroupName\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"IsEnabled\": {\n \"description\": \"IsEnabled\"\n },\n \"IsHighFillRate\": {\n \"description\": \"IsHighFillRate\"\n },\n \"IndustryCategoryId\": {\n \"description\": \"IndustryCategoryId\"\n },\n \"CurrencyCode\": {\n \"description\": \"CurrencyCode\"\n },\n \"Budget\": {\n \"description\": \"Budget\"\n },\n \"BudgetInImpressions\": {\n \"description\": \"BudgetInImpressions\"\n },\n \"DailyBudget\": {\n \"description\": \"DailyBudget\"\n },\n \"DailyBudgetInImpressions\": {\n \"description\": \"DailyBudgetInImpressions\"\n },\n \"PacingMode\": {\n \"description\": \"PacingMode\"\n },\n \"AutoAllocatorPriority\": {\n \"description\": \"AutoAllocatorPriority\"\n },\n \"BaseBidCPM\": {\n \"description\": \"BaseBidCPM\"\n },\n \"MaxBidCPM\": {\n \"description\": \"MaxBidCPM\"\n },\n \"Description\": {\n \"description\": \"Description\"\n },\n \"Availability\": {\n \"description\": \"Availability\"\n },\n \"PredictiveClearingEnabled\": {\n \"description\": \"PredictiveClearingEnabled\"\n },\n \"CreativeId\": {\n \"description\": \"CreativeId\"\n },\n \"BidListId\": {\n \"description\": \"BidListId\"\n },\n \"IsClassic\": {\n \"description\": \"IsClassic\"\n },\n \"AudienceId\": {\n \"description\": \"AudienceId\"\n },\n \"FrequencyCap\": {\n \"description\": \"FrequencyCap\"\n },\n \"FrequencyPeriodInMinutes\": {\n \"description\": \"FrequencyPeriodInMinutes\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create BidList in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Name\": {\n \"description\": \"Name of BidList\"\n },\n \"BidListAdjustmentType\": {\n \"description\": \"BidListAdjustmentType\"\n },\n \"BidListOwner\": {\n \"description\": \"BidListOwner\"\n },\n \"BidListOwnerId\": {\n \"description\": \"BidListOwnerId\"\n },\n \"ResolutionType\": {\n \"description\": \"ResolutionType\"\n },\n \"IsAvailableForLibraryUse\": {\n \"description\": \"IsAvailableForLibraryUse\"\n },\n \"BidLines\": {\n \"description\": \"BidLines\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create Campaigns in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"AdvertiserId\": {\n \"description\": \"AdvertiserId\"\n },\n \"CampaignName\": {\n \"description\": \"CampaignName\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"AutoallocatorEnabled\": {\n \"description\": \"AutoallocatorEnabled\"\n },\n \"AutoPrioritizationEnabled\": {\n \"description\": \"AutoPrioritizationEnabled\"\n },\n \"PacingMode\": {\n \"description\": \"PacingMode\"\n },\n \"StartDate\": {\n \"description\": \"StartDate\"\n },\n \"EndDate\": {\n \"description\": \"EndDate\"\n },\n \"Budget\": {\n \"description\": \"Budget\"\n },\n \"CurrencyCode\": {\n \"description\": \"CurrencyCode\"\n },\n \"BudgetInImpressions\": {\n \"description\": \"BudgetInImpressions\"\n },\n \"DailyBudget\": {\n \"description\": \"DailyBudget\"\n },\n \"DailyBudgetInImpressions\": {\n \"description\": \"DailyBudgetInImpressions\"\n },\n \"CampaignType\": {\n \"description\": \"CampaignType\"\n },\n \"Description\": {\n \"description\": \"Description\"\n },\n \"CustomLabelId\": {\n \"description\": \"CustomLabelId\"\n },\n \"Availability\": {\n \"description\": \"Availability\"\n },\n \"PartnerCostPercentageFee\": {\n \"description\": \"PartnerCostPercentageFee\"\n },\n \"PurchaseOrderNumber\": {\n \"description\": \"PurchaseOrderNumber\"\n },\n \"TimeZone\": {\n \"description\": \"TimeZone\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Download Report from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"target_xid\": {\n \"description\": \"The ogit\\/_xid of the target vertex for the report.\"\n },\n \"DownloadURI\": {\n \"description\": \"URI in Tradedesk to download the report from.\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Get Query in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"ReportScheduleIds\": {\n \"description\": \"The Schedule IDs of Report Executions to retrieve.\"\n },\n \"AdvertiserIds\": {\n \"description\": \"The ID of the Advertisers for whom to retrieve Report Executions. Each execution that contains data for at least one of these Advertisers will match the query.\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import AdGroup by Id from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"AdgroupIdList\": {\n \"description\": \"id of adgroup\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Advertiser by Id from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"AdvertiserIdList\": {\n \"description\": \"id or list of ids of advertisers\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Advertisers by Partner from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {},\n \"ogit/Automation/optionalParameters\": {\n \"PartnerId\": {\n \"description\": \"id of partner\"\n },\n \"Availabilities\": {\n \"description\": \"the Availabilities\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import BidList By Id in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"BidListId\": {\n \"description\": \"id of BidList\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Campaigns by Id from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"CampaignIdList\": {\n \"description\": \"id or list of ids of campaigns\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Import Campaigns by Id from TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"CampaignId\": {\n \"description\": \"id of campaign\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Patch AdGroup
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"xid\": {\n \"description\": \"The XID of the campaign\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Patch Campaign
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"xid\": {\n \"description\": \"ogit\\/_xid of the associated vertex\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Run Query in TradeDesk
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"ReportTemplateId\": {\n \"description\": \"The ID of the Report Template to which this Report Schedule applies. Use the myreports\\/reporttemplateheader\\/query endpoint to obtain a suitable template ID if you do not have one.\"\n },\n \"ReportScheduleName\": {\n \"description\": \"The name of the Report Schedule.\"\n },\n \"ReportDateRange\": {\n \"description\": \"The date range for the Report Schedule. If this is LastXDays, ReportDaysPrevious field must be supplied. If this is Custom, ReportStartDate and ReportEndDate must be supplied.\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"CampaignFilters\": {\n \"description\": \"The list of campaigns on which to filter the report. Exactly one of PartnerFilters, AdvertiserFilters, CampaignFilters or AdGroupFilters must be set.\",\n \"default\": \"\"\n },\n \"AdGroupFilters\": {\n \"description\": \"The list of ad groups on which to filter the report.\",\n \"default\": \"\"\n },\n \"ReportFileFormat\": {\n \"description\": \"The file format for the report.\",\n \"default\": \"CSV\"\n },\n \"ReportFrequency\": {\n \"description\": \"The frequency of the report schedule. Once is always valid; Daily and Weekly are valid for all ReportDateRange except LastMonth and Custom; Month is valid for MonthToDate, QuarterToDate and LastMonth.\",\n \"default\": \"Once\"\n },\n \"ReportDateFormat\": {\n \"description\": \"The format used for dates.\",\n \"default\": \"Sortable\"\n },\n \"ReportNumericFormat\": {\n \"description\": \"The format used for numeric values.\",\n \"default\": \"US\"\n },\n \"TimeZone\": {\n \"description\": \"The Olson timezone of the Report Schedule.Note that UTC is represented by \\\"UTC\\\" instead of the official Olson timezone string of \\\"Etc\\/UTC\\\".\",\n \"default\": \"UTC\"\n },\n \"IncludeHeaders\": {\n \"description\": \"Whether or not to include column headers in the report. Only valid for Text reports.\",\n \"default\": \"true\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 300000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Request prediction for training model
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"classifier_name\": {\n \"description\": \"Name of prediction model\"\n },\n \"input_string\": {\n \"description\": \"The value for which the category should be calculated\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"Request timeout\",\n \"default\": 3000\n }\n },\n \"ogit/Automation/resultParameters\": {\n \"exitcode\": {\n \"description\": \"exit status of command (0 is success)\"\n },\n \"category\": {\n \"description\": \"The predicted category\"\n },\n \"probability\": {\n \"description\": \"The confidence level of prediction\"\n }\n }\n}Send train request
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"trainingdata_id\": {\n \"description\": \"ogit\\/_id of ogit\\/ML\\/TrainedModel\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"Request timeout\",\n \"default\": 3000\n }\n },\n \"ogit/Automation/resultParameters\": {\n \"exitcode\": {\n \"description\": \"exit status of command (0 is success)\"\n },\n \"message\": {\n \"description\": \"Training response message\"\n }\n }\n}Ask approve to process the issue
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"user_email\": {\n \"description\": \"User's email to ask\"\n },\n \"issue_id\": {\n \"description\": \"processing issue id\"\n },\n \"question_model\": {\n \"description\": \"Special question model to generate a question\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 10000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Convert csv to spreadsheet
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"sourceId\": {\n \"description\": \"ogit\\/_id of the ogit\\/Attachment that contains the CSV blob\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"keys\": {\n \"description\": \"Identifier if keys are represented by rows or columns\",\n \"default\": \"row\"\n },\n \"colOffset\": {\n \"description\": \"Offset columns of the table. Entries before the offset are ignored.\",\n \"default\": \"0\"\n },\n \"rowOffset\": {\n \"description\": \"Offset rows of the table. Entries before the offset are ignored.\",\n \"default\": \"0\"\n },\n \"delimiter\": {\n \"description\": \"Delimiting character\",\n \"default\": \",\"\n },\n \"targetXid\": {\n \"description\": \"ogit\\/_xid of the node where the result is to be stored\",\n \"default\": \"\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 10000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Converts a date from an initial format to another
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"date_string\": {\n \"description\": \"date_string parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"in_format\": {\n \"description\": \"in_format parameter\"\n },\n \"out_format\": {\n \"description\": \"out_format parameter\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Make HTTP request
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"url\": {\n \"description\": \"Request URL\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"method\": {\n \"description\": \"HTTP request type (GET,POST,PUT,DELETE)\",\n \"default\": \"GET\"\n },\n \"body\": {\n \"description\": \"Body to send for post requests\",\n \"default\": \"\"\n },\n \"headers\": {\n \"description\": \"Headers to send\",\n \"default\": \"Content-Type= application\\/json\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 10000\n },\n \"certname\":\n {\n \"description\": \"Name of the client certificate to use\",\n \"default\": \"\"\n },\n \"username\":\n {\n \"description\": \"Username for basic auth\",\n \"default\": \"\"\n },\n \"password\":\n {\n \"description\": \"Password for basic auth\",\n \"default\": \"\"\n },\n \"oauth\": {\n \"description\": \"Identifier of an OAuth configuration set\",\n \"default\": \"\"\n },\n \"allow_insecure_https\": {\n \"description\": \"Allow unverified SSL connections\",\n \"default\": \"false\"\n }\n },\n \"ogit/Automation/resultParameters\": {\n \"body\": {\n \"description\": \"HTTP result body\"\n },\n \"code\": {\n \"description\": \"HTTP response code\"\n },\n \"headers\": {\n \"description\": \"HTTP response headers\"\n }\n }\n}Send an email with KI
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"from\": {\n \"description\": \"Who sends an email\"\n },\n \"to\": {\n \"description\": \"Who is a receiver\"\n },\n \"subject\": {\n \"description\": \"Subject of an email\"\n },\n \"body\": {\n \"description\": \"Body of an email\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"type\": {\n \"description\": \"Type of the content pain or html\",\n \"default\": \"plain\"\n },\n \"cc\": {\n \"description\": \"cc receivers\",\n \"default\": \"\"\n },\n \"bcc\": {\n \"description\": \"bcc receivers\",\n \"default\": \"\"\n },\n \"timeout\": {\n \"description\": \"HTTP request timeout\",\n \"default\": 10000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}API to send SMS messages
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Arguments\": {\n \"description\": \"Arguments parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"issue\": {\n \"description\": \"issue parameter\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}execute soap call on remote host
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"SOAPRequest\": {\n \"description\": \"soap request payload\"\n },\n \"SOAPEndpoint\": {\n \"description\": \"endpoint url of soap service\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Execute a JobTemplate in AWX
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"templateName\": {\n \"description\": \"templateName\"\n },\n \"hostname\": {\n \"description\": \"hostname\"\n },\n \"taskId\": {\n \"description\": \"taskId\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"extraVariables\": {\n \"description\": \"extraVariables\",\n \"default\": \"{}\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}execute a command on a remote host
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"command\": {\n \"description\": \"command to execute\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"host\": {\n \"description\": \"hostname to execute command on\",\n \"default\": \"\"\n },\n \"user\": {\n \"description\": \"user to run the command as\",\n \"default\": \"\"\n },\n \"timeout\": {\n \"description\": \"timeout in seconds\",\n \"default\": \"120\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}ExecuteLocalCommand
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Command\": {\n \"description\": \"Command parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"timeout parameter\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Execute Mysql Queries
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"query\": {\n \"description\": \"Query string that will be execute on the Mysql DB\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"SHH request timeout\",\n \"default\": 10000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Execute Oracle Queries
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"query\": {\n \"description\": \"Query string that will be execute on the Oracle DB\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"SHH request timeout\",\n \"default\": 10000\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Executes command over PS-Remoting on Windows endpoint
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"host\": {\n \"description\": \"Target endpoint Windows system\"\n },\n \"command_type\": {\n \"description\": \"Type of command CMD or PowerShell\"\n },\n \"command\": {\n \"description\": \"Cmdlet name or command\"\n },\n \"arguments\": {\n \"description\": \"Space-separated list of command arguments\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Retrieves information about a specific VM
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"vmname\": {\n \"description\": \"vmname\"\n },\n \"vcenter\": {\n \"description\": \"vcenter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}RunLocalScript
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Command\": {\n \"description\": \"Command\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}this one executes scripts
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"command\": {\n \"description\": \"script to run\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"timeout\": {\n \"description\": \"timeout in seconds\",\n \"default\": \"120\"\n },\n \"workdir\": {\n \"description\": \"working directory for the script\",\n \"default\": \"\\/tmp\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}run script on remote host
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Command\": {\n \"description\": \"script to execute\"\n },\n \"Hostname\": {\n \"description\": \"host to execute script on\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"User\": {\n \"description\": \"target user\"\n },\n \"SshOpts\": {\n \"description\": \"SSH options\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}calculate the number of seconds between two dates
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"endDate\": {\n \"description\": \"endDate parameter\"\n },\n \"currentDate\": {\n \"description\": \"currentDate parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Query AutomatizaStringSet from SAP
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"I_Trax\": {\n \"description\": \"I_Trax\",\n \"default\": \"\"\n },\n \"I_Vista\": {\n \"description\": \"I_Vista\",\n \"default\": \"\"\n },\n \"I_Batch\": {\n \"description\": \"I_Batch\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Query OT data set from SAP
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"QueryOtSet1\": {\n \"description\": \"First parameter of QueryOtSet\",\n \"default\": \"ot\"\n },\n \"QueryOtSet2\": {\n \"description\": \"Second parameter of QueryOtSet\",\n \"default\": \"\"\n },\n \"QueryOtSet3\": {\n \"description\": \"Third parameter of QueryOtSet\",\n \"default\": \"break\"\n },\n \"QueryOtSet4\": {\n \"description\": \"Fourth parameter of QueryOtSet\",\n \"default\": \"0\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Query data set from SAP
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"TabQuerySet\": {\n \"description\": \"JSON structure for the SAP query\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Request an SAP Remote Function Call (RFC) execution
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"function\": {\n \"description\": \"Remote Function Call (RFC)\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"destination\": {\n \"description\": \"SAP destination\",\n \"default\": \"\"\n },\n \"parameters\": {\n \"description\": \"Parameters for the RFC\",\n \"default\": \"{}\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Get the details of a user in SAP
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"SID\": {\n \"description\": \"SID\"\n },\n \"CLIENT\": {\n \"description\": \"CLIENT\"\n },\n \"USER\": {\n \"description\": \"USER\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Unlock a user in SAP
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"SID\": {\n \"description\": \"SID\"\n },\n \"CLIENT\": {\n \"description\": \"CLIENT\"\n },\n \"USER\": {\n \"description\": \"USER\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Create a Jira Issue
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Project\": {\n \"description\": \"Unique id of the Jira project for the new issue (project: {key: Project})\",\n \"default\": \"\"\n },\n \"IncidentType\": {\n \"description\": \"Id of the type of issue to be created in Jira (issuetype: {name: IncidentType})\",\n \"default\": \"\"\n },\n \"Subject\": {\n \"description\": \"Title of the Jira issue (summary)\",\n \"default\": \"\"\n },\n \"Description\": {\n \"description\": \"Body of the Jira issue (description)\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"IncidentStatus\": {\n \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n },\n \"IncidentStatusId\": {\n \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n },\n \"PriorityId\": {\n \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n },\n \"InformerId\": {\n \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n },\n \"Informer\": {\n \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n },\n \"InformerKey\": {\n \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n },\n \"ResponsibleId\": {\n \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n },\n \"Responsible\": {\n \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n },\n \"ResponsibleKey\": {\n \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n },\n \"CreatorId\": {\n \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n },\n \"Creator\": {\n \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n },\n \"CreatorKey\": {\n \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n },\n \"TicketKey\": {\n \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\"\n },\n \"Comment\": {\n \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n },\n \"Impact\": {\n \"description\": \"customfield_10500\"\n },\n \"Phone\": {\n \"description\": \"customfield_12803\"\n },\n \"Urgency\": {\n \"description\": \"customfield_10501\"\n },\n \"Classification\": {\n \"description\": \"customfield_11396\"\n },\n \"ApplicantId\": {\n \"description\": \"customfield_12900\"\n },\n \"ApplicantOrganization\": {\n \"description\": \"customfield_11614\"\n },\n \"City\": {\n \"description\": \"customfield_12804\"\n },\n \"FirstName\": {\n \"description\": \"customfield_11365\"\n },\n \"WaitTime\": {\n \"description\": \"customfield_11110\"\n },\n \"TicketTypeId\": {\n \"description\": \"customfield_11349: { id: TicketTypeId }\"\n },\n \"TicketType\": {\n \"description\": \"customfield_11349: { value: TicketType }\"\n },\n \"Email\": {\n \"description\": \"customfield_11333\"\n },\n \"Provider\": {\n \"description\": \"customfield_11332\"\n },\n \"ApprovalStatus\": {\n \"description\": \"customfield_11325\"\n },\n \"ClosingReason\": {\n \"description\": \"customfield_11320\"\n },\n \"AssignedGroup\": {\n \"description\": \"customfield_11310\"\n },\n \"Sla\": {\n \"description\": \"customfield_11312\"\n },\n \"Product\": {\n \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n },\n \"Product1\": {\n \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n },\n \"Product2\": {\n \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n },\n \"Product3\": {\n \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n },\n \"ActionId\": {\n \"description\": \"customfield_11308: { id: ActionId }\"\n },\n \"Action\": {\n \"description\": \"customfield_11308: { value: Action }\"\n },\n \"SupportOrganizationId\": {\n \"description\": \"customfield_11309: { id: OrganizationId }\"\n },\n \"SupportOrganization\": {\n \"description\": \"customfield_11309: { value: Organization }\"\n },\n \"SubSupportOrganizationId\": {\n \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n },\n \"SubSupportOrganization\": {\n \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n },\n \"RequestType\": {\n \"description\": \"customfield_11302\"\n },\n \"ProviderNumber\": {\n \"description\": \"customfield_11403\"\n },\n \"Process\": {\n \"description\": \"customfield_11607\"\n },\n \"AssociatedChange\": {\n \"description\": \"customfield_11606\"\n },\n \"Authorizer\": {\n \"description\": \"customfield_11390\"\n },\n \"AmountChangesEnd\": {\n \"description\": \"customfield_11619\"\n },\n \"AmountChangesTime\": {\n \"description\": \"customfield_11620\"\n },\n \"AmountReopen\": {\n \"description\": \"customfield_11317\"\n },\n \"ChangeCause\": {\n \"description\": \"customfield_11908\"\n },\n \"ApproverQuery\": {\n \"description\": \"customfield_11823\"\n },\n \"ApproverQueryURL\": {\n \"description\": \"customfield_11820\"\n },\n \"ScheduledFinishAt\": {\n \"description\": \"customfield_11359\"\n },\n \"ScheduledStartAt\": {\n \"description\": \"customfield_11386\"\n },\n \"SubTask\": {\n \"description\": \"subtasks\"\n },\n \"RequirementAction\": {\n \"description\": \"customfield_11608\"\n },\n \"Department\": {\n \"description\": \"customfield_11328\"\n },\n \"Company\": {\n \"description\": \"customfield_11327\"\n },\n \"TargetStartAt\": {\n \"description\": \"customfield_11602\"\n },\n \"TargetFinishAt\": {\n \"description\": \"customfield_11615\"\n },\n \"OriginalEndDate\": {\n \"description\": \"customfield_11618\"\n },\n \"ExecutionOrder\": {\n \"description\": \"customfield_11319\"\n },\n \"ReportedSourceId\": {\n \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n },\n \"ReportedSource\": {\n \"description\": \"customfield_11352: { value: ReportedSource }\"\n },\n \"Labels\": {\n \"description\": \"labels: [ Labels as csv ]\"\n },\n \"ResolutionMethod\": {\n \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n },\n \"ResolutionDetail\": {\n \"description\": \"customfield_11345\"\n },\n \"RequirementType\": {\n \"description\": \"customfield_11901\"\n },\n \"LinkedTicket\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n },\n \"LinkedTicketType\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n },\n \"TransportOrder\": {\n \"description\": \"customfield_11398\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Create Operations Manager Request
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"antragsart\": {\n \"description\": \"\"\n },\n \"database\": {\n \"description\": \"\"\n },\n \"server\": {\n \"description\": \"\"\n },\n \"url\": {\n \"description\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"parameters\": {\n \"description\": \"additional parameters\",\n \"default\": \"\"\n },\n \"environment\": {\n \"description\": \"environment of target systems\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Get the status of an Operations Manager Request
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"requestid\": {\n \"description\": \"id of the OM request to query\"\n },\n \"database\": {\n \"description\": \"\"\n },\n \"server\": {\n \"description\": \"\"\n },\n \"url\": {\n \"description\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"environment\": {\n \"description\": \"environment of the target systems\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Add a Worklog entry to a ticket in Remedy
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"remedyId\": {\n \"description\": \"remedyId\"\n },\n \"message\": {\n \"description\": \"message\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"viewAccess\": {\n \"description\": \"viewAccess\",\n \"default\": \"Public\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Get ticket from remedy
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"remedyId\": {\n \"description\": \"remedyId\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"env\": {\n \"description\": \"which environment to connect to? (PROD\\/DEV)\",\n \"default\": \"PROD\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Set Assignee of a ticket in Remedy
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"remedyId\": {\n \"description\": \"remedyId\"\n },\n \"assignee\": {\n \"description\": \"assignee\"\n },\n \"assigneeLoginId\": {\n \"description\": \"assigneeLoginId\"\n },\n \"message\": {\n \"description\": \"message\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"bardiocProcessed\": {\n \"description\": \"issueId\",\n \"default\": \"Yes\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Change Status of a ticket in Remedy
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"remedyId\": {\n \"description\": \"remedyId\"\n },\n \"status\": {\n \"description\": \"status\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"statusReason\": {\n \"description\": \"statusReason\",\n \"default\": \"\"\n },\n \"resolution\": {\n \"description\": \"resolution\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Transist a Jira Issue to a new state. This is also used to resolve a ticket.
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"TicketId\": {\n \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\",\n \"default\": \"\"\n },\n \"TransitionId\": {\n \"description\": \"Id of the transition state that this ticket shall move to. (transition: {id: TransitionId}})\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"IncidentStatus\": {\n \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n },\n \"IncidentStatusId\": {\n \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n },\n \"Comment\": {\n \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n },\n \"Resolution\": {\n \"description\": \"Text describing the resolution (resolution)\"\n },\n \"Resolved\": {\n \"description\": \"Date of resolution (resolutiondate)\"\n },\n \"PriorityId\": {\n \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n },\n \"Subject\": {\n \"description\": \"Title of the Jira issue (summary)\"\n },\n \"Description\": {\n \"description\": \"Body of the Jira issue (description)\"\n },\n \"InformerId\": {\n \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n },\n \"Informer\": {\n \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n },\n \"InformerKey\": {\n \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n },\n \"ResponsibleId\": {\n \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n },\n \"Responsible\": {\n \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n },\n \"ResponsibleKey\": {\n \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n },\n \"CreatorId\": {\n \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n },\n \"Creator\": {\n \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n },\n \"CreatorKey\": {\n \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n },\n \"Impact\": {\n \"description\": \"customfield_10500\"\n },\n \"Phone\": {\n \"description\": \"customfield_12803\"\n },\n \"Urgency\": {\n \"description\": \"customfield_10501\"\n },\n \"Classification\": {\n \"description\": \"customfield_11396\"\n },\n \"ApplicantId\": {\n \"description\": \"customfield_12900\"\n },\n \"ApplicantOrganization\": {\n \"description\": \"customfield_11614\"\n },\n \"City\": {\n \"description\": \"customfield_12804\"\n },\n \"FirstName\": {\n \"description\": \"customfield_11365\"\n },\n \"WaitTime\": {\n \"description\": \"customfield_11110\"\n },\n \"TicketTypeId\": {\n \"description\": \"customfield_11349: { id: TicketTypeId }\"\n },\n \"TicketType\": {\n \"description\": \"customfield_11349: { value: TicketType }\"\n },\n \"Email\": {\n \"description\": \"customfield_11333\"\n },\n \"Provider\": {\n \"description\": \"customfield_11332\"\n },\n \"ApprovalStatus\": {\n \"description\": \"customfield_11325\"\n },\n \"ClosingReason\": {\n \"description\": \"customfield_11320\"\n },\n \"AssignedGroup\": {\n \"description\": \"customfield_11310\"\n },\n \"Sla\": {\n \"description\": \"customfield_11312\"\n },\n \"Product\": {\n \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n },\n \"Product1\": {\n \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n },\n \"Product2\": {\n \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n },\n \"Product3\": {\n \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n },\n \"ActionId\": {\n \"description\": \"customfield_11308: { id: ActionId }\"\n },\n \"Action\": {\n \"description\": \"customfield_11308: { value: Action }\"\n },\n \"SupportOrganizationId\": {\n \"description\": \"customfield_11309: { id: OrganizationId }\"\n },\n \"SupportOrganization\": {\n \"description\": \"customfield_11309: { value: Organization }\"\n },\n \"SubSupportOrganizationId\": {\n \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n },\n \"SubSupportOrganization\": {\n \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n },\n \"RequestType\": {\n \"description\": \"customfield_11302\"\n },\n \"ProviderNumber\": {\n \"description\": \"customfield_11403\"\n },\n \"Process\": {\n \"description\": \"customfield_11607\"\n },\n \"AssociatedChange\": {\n \"description\": \"customfield_11606\"\n },\n \"Authorizer\": {\n \"description\": \"customfield_11390\"\n },\n \"AmountChangesEnd\": {\n \"description\": \"customfield_11619\"\n },\n \"AmountChangesTime\": {\n \"description\": \"customfield_11620\"\n },\n \"AmountReopen\": {\n \"description\": \"customfield_11317\"\n },\n \"ChangeCause\": {\n \"description\": \"customfield_11908\"\n },\n \"ApproverQuery\": {\n \"description\": \"customfield_11823\"\n },\n \"ApproverQueryURL\": {\n \"description\": \"customfield_11820\"\n },\n \"ScheduledFinishAt\": {\n \"description\": \"customfield_11359\"\n },\n \"ScheduledStartAt\": {\n \"description\": \"customfield_11386\"\n },\n \"SubTask\": {\n \"description\": \"subtasks\"\n },\n \"RequirementAction\": {\n \"description\": \"customfield_11608\"\n },\n \"Department\": {\n \"description\": \"customfield_11328\"\n },\n \"Company\": {\n \"description\": \"customfield_11327\"\n },\n \"TargetStartAt\": {\n \"description\": \"customfield_11602\"\n },\n \"TargetFinishAt\": {\n \"description\": \"customfield_11615\"\n },\n \"OriginalEndDate\": {\n \"description\": \"customfield_11618\"\n },\n \"ExecutionOrder\": {\n \"description\": \"customfield_11319\"\n },\n \"ReportedSourceId\": {\n \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n },\n \"ReportedSource\": {\n \"description\": \"customfield_11352: { value: ReportedSource }\"\n },\n \"Labels\": {\n \"description\": \"labels: [ Labels as csv ]\"\n },\n \"ResolutionMethod\": {\n \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n },\n \"ResolutionDetail\": {\n \"description\": \"customfield_11345\"\n },\n \"RequirementType\": {\n \"description\": \"customfield_11901\"\n },\n \"LinkedTicket\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n },\n \"LinkedTicketType\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n },\n \"EstimatedHours\": {\n \"description\": \"customfield_11601\"\n },\n \"ConstructionClassification\": {\n \"description\": \"customfield_11622\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Update a Jira Issue
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"TicketId\": {\n \"description\": \"Key of the type of Jira issue (issuekey: {key: TicketKey})\",\n \"default\": \"\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"IncidentStatus\": {\n \"description\": \"Name of a status for an issue (status: {name: IncidentStatus}}\"\n },\n \"IncidentStatusId\": {\n \"description\": \"Id number of a status for an issue (status: {id: IncidentStatusId}}\"\n },\n \"Comment\": {\n \"description\": \"Add a comment to the issue (comment: {add: {body: Comment}}}\"\n },\n \"Resolution\": {\n \"description\": \"Text describing the resolution (resolution)\"\n },\n \"Resolved\": {\n \"description\": \"Date of resolution (resolutiondate)\"\n },\n \"PriorityId\": {\n \"description\": \"Id number of a Jira priority (priority: {id: PriorityId}}\"\n },\n \"Subject\": {\n \"description\": \"Title of the Jira issue (summary)\"\n },\n \"Description\": {\n \"description\": \"Body of the Jira issue (description)\"\n },\n \"InformerId\": {\n \"description\": \"Set issue reporter via accountId of a Jira user (reporter: {key: InformerId})\"\n },\n \"Informer\": {\n \"description\": \"Set issue reporter via name of a Jira user (reporter: {name: Informer})\"\n },\n \"InformerKey\": {\n \"description\": \"Set issue reporter via key of a Jira user (reporter: {key: InformerKey})\"\n },\n \"ResponsibleId\": {\n \"description\": \"Set issue assignee via accountId of a Jira user (assignee: {id: ResponsibleId}}\"\n },\n \"Responsible\": {\n \"description\": \"Set issue assignee via name of a Jira user (assignee: {name: Responsible}}\"\n },\n \"ResponsibleKey\": {\n \"description\": \"Set issue assignee via key of a Jira user (assignee: {key: ResponsibleKey}}\"\n },\n \"CreatorId\": {\n \"description\": \"Set issue creator via accountId of a Jira user (creator: {id: CreatorId}}\"\n },\n \"Creator\": {\n \"description\": \"Set issue creator via name of a Jira user (creator: {name: Creator}}\"\n },\n \"CreatorKey\": {\n \"description\": \"Set issue creator via key of a Jira user (creator: {key: CreatorKey}}\"\n },\n \"Impact\": {\n \"description\": \"customfield_10500\"\n },\n \"Phone\": {\n \"description\": \"customfield_12803\"\n },\n \"Urgency\": {\n \"description\": \"customfield_10501\"\n },\n \"Classification\": {\n \"description\": \"customfield_11396\"\n },\n \"ApplicantId\": {\n \"description\": \"customfield_12900\"\n },\n \"ApplicantOrganization\": {\n \"description\": \"customfield_11614\"\n },\n \"City\": {\n \"description\": \"customfield_12804\"\n },\n \"FirstName\": {\n \"description\": \"customfield_11365\"\n },\n \"WaitTime\": {\n \"description\": \"customfield_11110\"\n },\n \"TicketTypeId\": {\n \"description\": \"customfield_11349: { id: TicketTypeId }\"\n },\n \"TicketType\": {\n \"description\": \"customfield_11349: { value: TicketType }\"\n },\n \"Email\": {\n \"description\": \"customfield_11333\"\n },\n \"Provider\": {\n \"description\": \"customfield_11332\"\n },\n \"ApprovalStatus\": {\n \"description\": \"customfield_11325\"\n },\n \"ClosingReason\": {\n \"description\": \"customfield_11320\"\n },\n \"AssignedGroup\": {\n \"description\": \"customfield_11310\"\n },\n \"Sla\": {\n \"description\": \"customfield_11312\"\n },\n \"Product\": {\n \"description\": \"customfield_11307: [ { value: Product }, ... ]\"\n },\n \"Product1\": {\n \"description\": \"customfield_11307: [ { value: Product1 }, ... ]\"\n },\n \"Product2\": {\n \"description\": \"customfield_11307: [ { value: Product2 }, ... ]\"\n },\n \"Product3\": {\n \"description\": \"customfield_11307: [ { value: Product3 }, ... ]\"\n },\n \"ActionId\": {\n \"description\": \"customfield_11308: { id: ActionId }\"\n },\n \"Action\": {\n \"description\": \"customfield_11308: { value: Action }\"\n },\n \"SupportOrganizationId\": {\n \"description\": \"customfield_11309: { id: OrganizationId }\"\n },\n \"SupportOrganization\": {\n \"description\": \"customfield_11309: { value: Organization }\"\n },\n \"SubSupportOrganizationId\": {\n \"description\": \"customfield_11309: { child: { id: SubOrganizationId } }\"\n },\n \"SubSupportOrganization\": {\n \"description\": \"customfield_11309: { child: { value: SubOrganization } }\"\n },\n \"RequestType\": {\n \"description\": \"customfield_11302\"\n },\n \"ProviderNumber\": {\n \"description\": \"customfield_11403\"\n },\n \"Process\": {\n \"description\": \"customfield_11607\"\n },\n \"AssociatedChange\": {\n \"description\": \"customfield_11606\"\n },\n \"Authorizer\": {\n \"description\": \"customfield_11390\"\n },\n \"AmountChangesEnd\": {\n \"description\": \"customfield_11619\"\n },\n \"AmountChangesTime\": {\n \"description\": \"customfield_11620\"\n },\n \"AmountReopen\": {\n \"description\": \"customfield_11317\"\n },\n \"ChangeCause\": {\n \"description\": \"customfield_11908\"\n },\n \"ApproverQuery\": {\n \"description\": \"customfield_11823\"\n },\n \"ApproverQueryURL\": {\n \"description\": \"customfield_11820\"\n },\n \"ScheduledFinishAt\": {\n \"description\": \"customfield_11359\"\n },\n \"ScheduledStartAt\": {\n \"description\": \"customfield_11386\"\n },\n \"SubTask\": {\n \"description\": \"subtasks\"\n },\n \"RequirementAction\": {\n \"description\": \"customfield_11608\"\n },\n \"Department\": {\n \"description\": \"customfield_11328\"\n },\n \"Company\": {\n \"description\": \"customfield_11327\"\n },\n \"TargetStartAt\": {\n \"description\": \"customfield_11602\"\n },\n \"TargetFinishAt\": {\n \"description\": \"customfield_11615\"\n },\n \"OriginalEndDate\": {\n \"description\": \"customfield_11618\"\n },\n \"ExecutionOrder\": {\n \"description\": \"customfield_11319\"\n },\n \"ReportedSourceId\": {\n \"description\": \"customfield_11352: { id: ReportedSourceId }\"\n },\n \"ReportedSource\": {\n \"description\": \"customfield_11352: { value: ReportedSource }\"\n },\n \"Labels\": {\n \"description\": \"labels: [ Labels as csv ]\"\n },\n \"ResolutionMethod\": {\n \"description\": \"customfield_11344: { value: ResolutionMethod }\"\n },\n \"ResolutionDetail\": {\n \"description\": \"customfield_11345\"\n },\n \"RequirementType\": {\n \"description\": \"customfield_11901\"\n },\n \"LinkedTicket\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { outwardIssue: { key: LinkedTicket }}}]}\"\n },\n \"LinkedTicketType\": {\n \"description\": \"issuelinks update: { issuelinks: [{ add: { type: { name: LinkedTicketType }}}]}\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}Call FE NBI functions
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"function\": {\n \"description\": \"name of the function to call\"\n },\n \"arguments\": {\n \"description\": \"arguments for the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call FE RPA functions
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"function\": {\n \"description\": \"name of the function to call\"\n },\n \"arguments\": {\n \"description\": \"arguments for the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call SDE functions
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"function\": {\n \"description\": \"name of the function to call\"\n },\n \"arguments\": {\n \"description\": \"arguments for the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}execute script to query the NDB
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Site\": {\n \"description\": \"Site parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Query to check if the current date (or the date optional in input) is an Holiday day or not
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"ruotaRep\": {\n \"description\": \"ruotaRep parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {\n \"checkDate\": {\n \"description\": \"checkDate parameter\"\n }\n },\n \"ogit/Automation/resultParameters\": {}\n}run a script that sends an email
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Subject\": {\n \"description\": \"Subject parameter\"\n },\n \"Content\": {\n \"description\": \"Content parameter\"\n },\n \"Receiver\": {\n \"description\": \"Receiver parameter\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call UME_BoardPowerON function
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Input\": {\n \"description\": \"json passed to the the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call UME_EnablePA function
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Input\": {\n \"description\": \"json passed to the the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call UME_GetProductCode function
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Input\": {\n \"description\": \"json passed to the the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call UME_NodeRestart function
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Input\": {\n \"description\": \"json passed to the the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}Call UME_RestartBoard function
\n{\n \"ogit/Automation/mandatoryParameters\": {\n \"Input\": {\n \"description\": \"json passed to the the function\"\n }\n },\n \"ogit/Automation/optionalParameters\": {},\n \"ogit/Automation/resultParameters\": {}\n}The ServiceNow connector utilizes transformation maps to transform incoming data before transmission to the ServiceNow server and to transform outgoing data before transmission to Bardioc.
\nWhen sending information obtained from Bardioc, the ServiceNow connector checks the transformation maps section defined in snow.endpoint.conf.xml configuration file. This transformation map will be used to transform Bardioc SDF format to a key:value pair format that can be understood by the connector’s writer mechanism when writing information to ServiceNow.
This example defines maps for the Incident and Change processes in the snow.endpoint.conf.xml configuration file. Each map has a submap to handle comment transformation.\nNote: The ServiceNow connector does not attempt to create new CIs or update CIs in ServiceNow, therefore there is no need for a tranformation map to be declared.
<transformation>\n <maps>\n <map name=\"Incident\">\n <path>bardioc2snow___TOOL_MAP_SUFFIX__.map</path>\n <subMaps>\n <subMap name=\"COMMENTS\">\n <path>bardioc2comments.map</path>\n <inline>true</inline>\n <inlineField>comments</inlineField>\n </subMap>\n </subMaps>\n </map>\n <map name=\"Change\">\n <path>bardioc2snow___TOOL_MAP_SUFFIX__.map</path>\n <subMaps>\n <subMap name=\"COMMENTS\">\n <path>bardioc2comments.map</path>\n <inline>true</inline>\n <inlineField>comments</inlineField>\n </subMap>\n </subMaps>\n </map>\n <!--\n <map name=\"CI\">\n <path>bardioc2snow___TOOL_MAP_SUFFIX__.map</path>\n </map>-->\n </maps>\n </transformation>When sending information obtained from ServiceNow, the connector uses transformation maps defined in bardioc.endpoint.conf.xml configuration file. Connector transforms data coming from ServiceNow to format understood by the connector’s writer mechanism when writing information to Bardioc.
This example defines maps for the Incident, Change and Config processes. Here attribute `ticketPath`is used to distinguish different processes in the mapping file. We will learn more about this in the next section.
\n <transformation>\n <maps>\n <map name=\"Incident\">\n <path>snow2bardioc___TOOL_MAP_SUFFIX__.map</path>\n <attributes>\n <attribute name=\"ticketPath\">incident</attribute>\n </attributes>\n\n </map>\n <map name=\"Change\">\n <path>snow2bardioc___TOOL_MAP_SUFFIX__.map</path>\n <attributes>\n <attribute name=\"ticketPath\">change</attribute>\n </attributes>\n\n </map>\n <map name=\"Config\">\n <path>snowCiToBardiocCi.map</path>\n <attributes>\n <attribute name=\"ticketPath\">ci</attribute>\n </attributes>\n </map>\n </maps>\n\n </transformation>A tranformation map has two components, a CASE statement and one or more DEFINE statements.
Case StatementA CASE statement is a unix based CASE statement syntax and is used to determine which DEFINE statement to use for tranformation mapping.
CASE [ciType]::[basicConfigId] in\n Machine::cmdb_ci_computer)\n GOTO COMPUTER\n ;;\n Machine::cmdb_ci_server)\n GOTO SERVER\n ;;\n Machine::)\n GOTO COMPUTER\n ;;\nESACThe value of [ciType] and [basicConfigId] variables are concatenated with :: and the result is compared to the various IN criteria until it finds a match or a default. If there is a match or default, the GOTO XXXX is then called.\nThe GOTO XXXX statement represents calling a map where XXXX is the map name.
DEFINE StatementA DEFINE statement defines a map. A map is a mapping between source data fields and target fields. DEFINE statements are hierarchical so a map may inherit mappings from a parent map.
Maps are defined using the syntax:
\nDEFINE <<MAPNAME>> : <<PARENTMAP>>{\n #target field mapped to value of sourceField1 value\n targetField1 = [sourceField1]\n\n #targetField is mapped to hard coded value\n targetField2 = myValueHardcoded\n\n #targetField is mapped to value returned from a function\n targetField3 = $<function>()\n ...\n}ENDA snippet of a hierarchical map would look like this:
\n#A map that will be inherited by other maps\nDEFINE BASE {\n correlation_id = [sourceCiId]\n name = [name]\n}END\n\n#Hardware mapping which inherits Base mapping\nDEFINE HARDWARE : BASE {\n hardwareStatus = [status]\n...\n}END\n\n#Computer mapping which inherits Hardware and Base mapping\nDEFINE COMPUTER : HARDWARE {\n chassis_type = [systemType]\n cpu_core_count = [cpuCoreCount]\n cpu_core_thread = [cpuCoreThread]\n cpu_count = [cpuCount]\n cpu_manufacturer = [cpuManufacturer]\n}ENDIn the example, COMPUTER, HARDWARE, and BASE are the names of the defined maps. The COMPUTER map inherits all the mappings defined in the parent HARDWARE map and the HARDARE map inherits all the mappings defined in the BASE mapping. The COMPUTER map can be used in the GOTO <map> statement in the CASE statement, whereas the others should not because they would not provide a complete mapping and are intended for purposes of inheritence only.
| \n\n | \n\nThe functions available via the transform maps are sensitive to commas and line breaks. Commas hold a special meaning in the context of transformation maps for delineation of function parameters. Where commas and line breaks are possible in data values utilize the $EVAL() function in place of others to preserve commas and line breaks within the data.\n | \n
| \n\n | \n\nBlock brackets [ ] have special meaning and are used by the transformation logic to replace the field within, with the field’s value. For example, if you have the following statement: number = [sourceTicketId] the transformer will assign number the value of the sdf field sourceTicketId. If block brackets are used for assignment in the $EVAL() statement, they must be wrapped in double quotes (i.e. $EVAL( var a = “[sourceTicketId]”;).\n | \n
The transformation maps translates data bidirectionally. The data to be translated by the maps is different for each direction. When the data flow is from Bardioc to ServiceNow, the source data available is determined by the Bardioc SDF view definition. A view describes how to map JSON documents to a graph structure and Vice versa.
\nWhen the data flow is from ServiceNow to Bardioc the source data available to the tranformation map is determined by the results agregation of data from one or more ServiceNow tables of which the field names are determined by the fields that comprise a particular table. Since data can be aggregated into hierarchical data structure the data is presented to the transformation map in a special format. The data is contained in one source field and is accessible using the [data] variable. The value of [data] is a json object and any mappings should use the $EVAL() function to parse the data as needed. The format of the json represents a hierarchical record data model defined as:
{\n\t\"id\": \"recordUniqueIdentifier\",\n\t\"attachments\": [],\n\t\"fields\": [{\n\t\t\t\"name\": \"sourceFieldName1\",\n\t\t\t\"value\": \"sourceFieldName1Value\"\n\t\t},\n\t\t{\n\t\t\t\"name\": \"sourceFieldName2\",\n\t\t\t\"value\": \"sourceFieldName2Value\"\n\t\t}\n\t],\n\t\"relations\": [{\n\t\t\"<relationType\": [{\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"recordUniqueIdentifier\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"sourceFieldName1\",\n\t\t\t\t\t\"value\": \"sourceFieldNameValue1\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sourceFieldName2\",\n\t\t\t\t\t\"value\": \"sourceFieldNameValue2\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": []\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"recordUniqueIdentifier\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"sourceFieldName1\",\n\t\t\t\t\t\"value\": \"sourceFieldName1Value\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sourceFieldName2\",\n\t\t\t\t\t\"value\": \"sourceFieldName2Value\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": []\n\t\t\t}\n\t\t]\n\t}]\n}ServiceNow source data representation of an Incident with comments and aggregated CI information.
\n{\n\t\"attachments\": [],\n\t\"id\": \"8e4b000fdb840010ee6d1fc7689619d0\",\n\t\"fields\": [{\n\t\t\"name\": \"parent\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"made_sla\",\n\t\t\"value\": \"true\"\n\t}, {\n\t\t\"name\": \"caused_by\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"watch_list\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_upon_reject\",\n\t\t\"value\": \"Cancel all future Tasks\"\n\t}, {\n\t\t\"name\": \"upon_reject\",\n\t\t\"value\": \"cancel\"\n\t}, {\n\t\t\"name\": \"label_sys_updated_on\",\n\t\t\"value\": \"2019-09-26 12:47:15\"\n\t}, {\n\t\t\"name\": \"sys_updated_on\",\n\t\t\"value\": \"2019-09-26 19:47:15\"\n\t}, {\n\t\t\"name\": \"child_incidents\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"hold_reason\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"approval_history\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"number\",\n\t\t\"value\": \"INC0010005\"\n\t}, {\n\t\t\"name\": \"resolved_by\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"sys_updated_by\",\n\t\t\"value\": \"bardioc-connect\"\n\t}, {\n\t\t\"name\": \"label_opened_by\",\n\t\t\"value\": \"System Administrator\"\n\t}, {\n\t\t\"name\": \"opened_by\",\n\t\t\"value\": \"6816f79cc0a8016401c5a33be04be441\"\n\t}, {\n\t\t\"name\": \"user_input\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_sys_created_on\",\n\t\t\"value\": \"2019-09-26 12:31:06\"\n\t}, {\n\t\t\"name\": \"sys_created_on\",\n\t\t\"value\": \"2018-08-31 21:35:45\"\n\t}, {\n\t\t\"name\": \"sys_domain\",\n\t\t\"value\": \"global\"\n\t}, {\n\t\t\"name\": \"label_state\",\n\t\t\"value\": \"In Progress\"\n\t}, {\n\t\t\"name\": \"state\",\n\t\t\"value\": \"2\"\n\t}, {\n\t\t\"name\": \"sys_created_by\",\n\t\t\"value\": \"admin\"\n\t}, {\n\t\t\"name\": \"knowledge\",\n\t\t\"value\": \"false\"\n\t}, {\n\t\t\"name\": \"order\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"calendar_stc\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"closed_at\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"cmdb_ci\",\n\t\t\"value\": \"53958ff0c0a801640171ec76aa0c8f86\"\n\t}, {\n\t\t\"name\": \"label_impact\",\n\t\t\"value\": \"3 - Low\"\n\t}, {\n\t\t\"name\": \"impact\",\n\t\t\"value\": \"3\"\n\t}, {\n\t\t\"name\": \"active\",\n\t\t\"value\": \"true\"\n\t}, {\n\t\t\"name\": \"work_notes_list\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"business_service\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_priority\",\n\t\t\"value\": \"5 - Planning\"\n\t}, {\n\t\t\"name\": \"priority\",\n\t\t\"value\": \"5\"\n\t}, {\n\t\t\"name\": \"sys_domain_path\",\n\t\t\"value\": \"/\"\n\t}, {\n\t\t\"name\": \"rfc\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"time_worked\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"expected_start\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_opened_at\",\n\t\t\"value\": \"2019-09-26 12:29:31\"\n\t}, {\n\t\t\"name\": \"opened_at\",\n\t\t\"value\": \"2019-09-26 19:29:31\"\n\t}, {\n\t\t\"name\": \"business_duration\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"group_list\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"work_end\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_caller_id\",\n\t\t\"value\": \"Alejandra Prenatt\"\n\t}, {\n\t\t\"name\": \"caller_id\",\n\t\t\"value\": \"22826bf03710200044e0bfc8bcbe5dec\"\n\t}, {\n\t\t\"name\": \"reopened_time\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"resolved_at\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"approval_set\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_subcategory\",\n\t\t\"value\": \"Email\"\n\t}, {\n\t\t\"name\": \"subcategory\",\n\t\t\"value\": \"email\"\n\t}, {\n\t\t\"name\": \"work_notes\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"short_description\",\n\t\t\"value\": \"_eTest001\"\n\t}, {\n\t\t\"name\": \"close_code\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"correlation_display\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"work_start\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_assignment_group\",\n\t\t\"value\": \"Bardioc\"\n\t}, {\n\t\t\"name\": \"assignment_group\",\n\t\t\"value\": \"0da62576db000010ee6d1fc76896193c\"\n\t}, {\n\t\t\"name\": \"additional_assignee_list\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"business_stc\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"description\",\n\t\t\"value\": \"_eTest001_Descriptions\"\n\t}, {\n\t\t\"name\": \"calendar_duration\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"close_notes\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_notify\",\n\t\t\"value\": \"Do Not Notify\"\n\t}, {\n\t\t\"name\": \"notify\",\n\t\t\"value\": \"1\"\n\t}, {\n\t\t\"name\": \"label_sys_class_name\",\n\t\t\"value\": \"Incident\"\n\t}, {\n\t\t\"name\": \"sys_class_name\",\n\t\t\"value\": \"incident\"\n\t}, {\n\t\t\"name\": \"closed_by\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"follow_up\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"parent_incident\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"sys_id\",\n\t\t\"value\": \"8e4b000fdb840010ee6d1fc7689619d0\"\n\t}, {\n\t\t\"name\": \"label_contact_type\",\n\t\t\"value\": \"Email\"\n\t}, {\n\t\t\"name\": \"contact_type\",\n\t\t\"value\": \"email\"\n\t}, {\n\t\t\"name\": \"reopened_by\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_incident_state\",\n\t\t\"value\": \"In Progress\"\n\t}, {\n\t\t\"name\": \"incident_state\",\n\t\t\"value\": \"2\"\n\t}, {\n\t\t\"name\": \"label_urgency\",\n\t\t\"value\": \"3 - Low\"\n\t}, {\n\t\t\"name\": \"urgency\",\n\t\t\"value\": \"3\"\n\t}, {\n\t\t\"name\": \"problem_id\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_company\",\n\t\t\"value\": \"ACME France\"\n\t}, {\n\t\t\"name\": \"company\",\n\t\t\"value\": \"81fbfe03ac1d55eb286d832de58ae1fd\"\n\t}, {\n\t\t\"name\": \"reassignment_count\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"activity_due\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_assigned_to\",\n\t\t\"value\": \"Fred Luddy\"\n\t}, {\n\t\t\"name\": \"assigned_to\",\n\t\t\"value\": \"5137153cc611227c000bbd1bd8cd2005\"\n\t}, {\n\t\t\"name\": \"label_severity\",\n\t\t\"value\": \"3 - Low\"\n\t}, {\n\t\t\"name\": \"severity\",\n\t\t\"value\": \"3\"\n\t}, {\n\t\t\"name\": \"comments\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_approval\",\n\t\t\"value\": \"Not Yet Requested\"\n\t}, {\n\t\t\"name\": \"approval\",\n\t\t\"value\": \"not requested\"\n\t}, {\n\t\t\"name\": \"sla_due\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"comments_and_work_notes\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"due_date\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"sys_mod_count\",\n\t\t\"value\": \"2\"\n\t}, {\n\t\t\"name\": \"reopen_count\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"sys_tags\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_escalation\",\n\t\t\"value\": \"Normal\"\n\t}, {\n\t\t\"name\": \"escalation\",\n\t\t\"value\": \"0\"\n\t}, {\n\t\t\"name\": \"label_upon_approval\",\n\t\t\"value\": \"Proceed to Next Task\"\n\t}, {\n\t\t\"name\": \"upon_approval\",\n\t\t\"value\": \"proceed\"\n\t}, {\n\t\t\"name\": \"correlation_id\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"location\",\n\t\t\"value\": \"\"\n\t}, {\n\t\t\"name\": \"label_category\",\n\t\t\"value\": \"Inquiry / Help\"\n\t}, {\n\t\t\"name\": \"category\",\n\t\t\"value\": \"inquiry\"\n\t}],\n\t\"relations\": [{\n\t\t\t\"CIS\": [{\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"53958ff0c0a801640171ec76aa0c8f86\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"firewall_status\",\n\t\t\t\t\t\"value\": \"Intranet\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"os_address_width\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_operational_status\",\n\t\t\t\t\t\"value\": \"Operational\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"operational_status\",\n\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"os_service_pack\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_core_thread\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_cpu_manufacturer\",\n\t\t\t\t\t\"value\": \"Intel\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_manufacturer\",\n\t\t\t\t\t\"value\": \"7aad6d00c611228400f00e0f80b67d2d\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_updated_on\",\n\t\t\t\t\t\"value\": \"2019-09-20 07:10:19\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_updated_on\",\n\t\t\t\t\t\"value\": \"2019-09-20 14:10:19\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"discovery_source\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"first_discovered\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"due_in\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"used_for\",\n\t\t\t\t\t\"value\": \"Production\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"gl_account\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"invoice_number\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\"value\": \"glide.maint\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_ram\",\n\t\t\t\t\t\"value\": \"2,048\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"ram\",\n\t\t\t\t\t\"value\": \"2048\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"warranty_expiration\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_name\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_cpu_speed\",\n\t\t\t\t\t\"value\": \"2,800\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_speed\",\n\t\t\t\t\t\"value\": \"2800\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"owned_by\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"checked_out\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"kernel_release\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"classification\",\n\t\t\t\t\t\"value\": \"Production\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"disk_space\",\n\t\t\t\t\t\"value\": \"40\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_domain_path\",\n\t\t\t\t\t\"value\": \"\\/\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"object_id\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"maintenance_schedule\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cost_center\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"dns_domain\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_assigned\",\n\t\t\t\t\t\"value\": \"2019-03-19 00:00:00\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"assigned\",\n\t\t\t\t\t\"value\": \"2019-03-19 07:00:00\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"purchase_date\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cd_speed\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"short_description\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"floppy\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_managed_by\",\n\t\t\t\t\t\"value\": \"Lynda Caraway\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"managed_by\",\n\t\t\t\t\t\"value\": \"8a826bf03710200044e0bfc8bcbe5d72\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"os_domain\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"can_print\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"last_discovered\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_class_name\",\n\t\t\t\t\t\"value\": \"Linux Server\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_class_name\",\n\t\t\t\t\t\"value\": \"cmdb_ci_linux_server\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_count\",\n\t\t\t\t\t\"value\": \"2\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_manufacturer\",\n\t\t\t\t\t\"value\": \"Iris\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"manufacturer\",\n\t\t\t\t\t\"value\": \"c115c2f737e3100044e0bfc8bcbe5d46\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_vendor\",\n\t\t\t\t\t\"value\": \"Cloudward Inc\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"vendor\",\n\t\t\t\t\t\"value\": \"3efe8c4c37423000158bbfc8bcbe5d7d\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"model_number\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"assigned_to\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"start_date\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"os_version\",\n\t\t\t\t\t\"value\": \"2.6.9-22.0.1.ELsmp\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"serial_number\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cd_rom\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"support_group\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"correlation_id\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"unverified\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"attributes\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_asset\",\n\t\t\t\t\t\"value\": \"P1000165 - Iris 5875\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"asset\",\n\t\t\t\t\t\"value\": \"1bc1fa8837f3100044e0bfc8bcbe5d17\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_core_count\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"form_factor\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"skip_sync\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_updated_by\",\n\t\t\t\t\t\"value\": \"system\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\"value\": \"2006-07-09 06:59:06\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\"value\": \"2006-07-09 13:59:06\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cpu_type\",\n\t\t\t\t\t\"value\": \"Intel\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_domain\",\n\t\t\t\t\t\"value\": \"global\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_install_date\",\n\t\t\t\t\t\"value\": \"2018-11-14 00:00:00\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"install_date\",\n\t\t\t\t\t\"value\": \"2018-11-14 08:00:00\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"asset_tag\",\n\t\t\t\t\t\"value\": \"P1000165\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"dr_backup\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"hardware_substatus\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"fqdn\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"change_control\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"delivery_date\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"hardware_status\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_install_status\",\n\t\t\t\t\t\"value\": \"Installed\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"install_status\",\n\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"supported_by\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\"value\": \"lnux100\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"subcategory\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"default_gateway\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"chassis_type\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"virtual\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"assignment_group\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\"value\": \"53958ff0c0a801640171ec76aa0c8f86\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"po_number\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"checked_in\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_class_path\",\n\t\t\t\t\t\"value\": \"\\/!!\\/!2\\/!(\\/!!\\/!0\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"mac_address\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_company\",\n\t\t\t\t\t\"value\": \"ACME Corporation\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"company\",\n\t\t\t\t\t\"value\": \"e7c1f3d53790200044e0bfc8bcbe5deb\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"justification\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"department\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"comments\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_cost\",\n\t\t\t\t\t\"value\": \"45,557.5\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cost\",\n\t\t\t\t\t\"value\": \"45557.5\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"os\",\n\t\t\t\t\t\"value\": \"Linux Red Hat\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_mod_count\",\n\t\t\t\t\t\"value\": \"23\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"monitor\",\n\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"ip_address\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_model_id\",\n\t\t\t\t\t\"value\": \"Iris 5875\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"model_id\",\n\t\t\t\t\t\"value\": \"5f5fbcc3c0a8010e00f3b27814f3b96b\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"duplicate_of\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"cost_cc\",\n\t\t\t\t\t\"value\": \"USD\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"order_date\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"schedule\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"due\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_location\",\n\t\t\t\t\t\"value\": \"322 West 52nd Street, New York,NY\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"location\",\n\t\t\t\t\t\"value\": \"25ab9f690a0a0bb3001c5fec1d0d7bcb\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"category\",\n\t\t\t\t\t\"value\": \"Do not migrate to asset\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"fault_count\",\n\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"host_name\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"lease_id\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": [{\n\t\t\t\t\t\"RELATION\": [{\n\t\t\t\t\t\t\"attachments\": [],\n\t\t\t\t\t\t\"id\": \"451047c6c0a8016400de0ae6df9b9d76\",\n\t\t\t\t\t\t\"fields\": [{\n\t\t\t\t\t\t\t\"name\": \"parent\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"skip_sync\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"aliases\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_operational_status\",\n\t\t\t\t\t\t\t\"value\": \"Operational\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"operational_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2010-11-26 01:39:26\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2010-11-26 09:39:26\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"discovery_source\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"first_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"service_level_requirement\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_by\",\n\t\t\t\t\t\t\t\"value\": \"felix.bait\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-06 11:18:50\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-06 18:18:50\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain\",\n\t\t\t\t\t\t\t\"value\": \"global\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"used_for\",\n\t\t\t\t\t\t\t\"value\": \"Production\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"gl_account\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"invoice_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\t\t\"value\": \"glide.maint\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitoring_requirements\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"warranty_expiration\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset_tag\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"user_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fqdn\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_change_control\",\n\t\t\t\t\t\t\t\"value\": \"IT Finance CAB\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"change_control\",\n\t\t\t\t\t\t\t\"value\": \"5f63e48fc0a8010e00eeaad81cd4dd37\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sla\",\n\t\t\t\t\t\t\t\"value\": \"Finance 99.99\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sla\",\n\t\t\t\t\t\t\t\"value\": \"5f78c96cc0a8010e01299db51d651a29\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_owned_by\",\n\t\t\t\t\t\t\t\"value\": \"John Retak\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"owned_by\",\n\t\t\t\t\t\t\t\"value\": \"5f675796c0a8010e0132f67844388c58\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_out\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unit_description\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_relation_manager\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_review_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"version\",\n\t\t\t\t\t\t\t\"value\": \"3.0.7\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_contact\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"compatibility_dependencies\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_maintenance_schedule\",\n\t\t\t\t\t\t\t\"value\": \"Weekends\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"maintenance_schedule\",\n\t\t\t\t\t\t\t\"value\": \"a618d80e0a0a0b53150f5245edbeb5b6\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_install_status\",\n\t\t\t\t\t\t\t\"value\": \"Installed\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_center\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"supported_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"dns_domain\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\t\t\"value\": \"Bond Trading\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"purchase_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"subcategory\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"price_model\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_need\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_manager\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"end_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"short_description\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"busines_criticality\",\n\t\t\t\t\t\t\t\"value\": \"1 - most critical\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assignment_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_managed_by\",\n\t\t\t\t\t\t\t\"value\": \"Davin Czukowski\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"managed_by\",\n\t\t\t\t\t\t\t\"value\": \"5f64f1dac0a8010e0020272962540240\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"can_print\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"Service\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"cmdb_ci_service\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"manufacturer\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"prerequisites\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\t\t\"value\": \"451047c6c0a8016400de0ae6df9b9d76\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"po_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/!!\\/#C\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"mac_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"vendor\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"company\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"justification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"department\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned_to\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"start_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"comments\",\n\t\t\t\t\t\t\t\"value\": \"Bond trading application used by the folks on Water street and in central London.\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_mod_count\",\n\t\t\t\t\t\t\t\"value\": \"9\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitor\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"serial_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"ip_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"duplicate_of\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_cc\",\n\t\t\t\t\t\t\t\"value\": \"USD\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"price_unit\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"order_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_support_group\",\n\t\t\t\t\t\t\t\"value\": \"IT Securities\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"support_group\",\n\t\t\t\t\t\t\t\"value\": \"5f6441efc0a8010e0177fcb589156352\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"correlation_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unverified\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"attributes\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_location\",\n\t\t\t\t\t\t\t\"value\": \"450 Lexington Avenue, New York,NY\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"location\",\n\t\t\t\t\t\t\t\"value\": \"5f669b59c0a8010e00209343c0c6f9c1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_asset\",\n\t\t\t\t\t\t\t\"value\": \"Unknown\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset\",\n\t\t\t\t\t\t\t\"value\": \"c4c13e8837f3100044e0bfc8bcbe5d4b\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"category\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fault_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"lease_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"service_classification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"relation_type\",\n\t\t\t\t\t\t\t\"value\": \"Depends on::Used by\"\n\t\t\t\t\t\t}],\n\t\t\t\t\t\t\"relations\": []\n\t\t\t\t\t}, {\n\t\t\t\t\t\t\"attachments\": [],\n\t\t\t\t\t\t\"id\": \"5f5c4854c0a8010e00c202b418f5b73b\",\n\t\t\t\t\t\t\"fields\": [{\n\t\t\t\t\t\t\t\"name\": \"parent\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"skip_sync\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"aliases\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_operational_status\",\n\t\t\t\t\t\t\t\"value\": \"Operational\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"operational_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2012-01-21 11:00:12\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2012-01-21 19:00:12\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"discovery_source\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"first_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"service_level_requirement\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_by\",\n\t\t\t\t\t\t\t\"value\": \"admin\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 13:51:58\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 20:51:58\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain\",\n\t\t\t\t\t\t\t\"value\": \"global\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"used_for\",\n\t\t\t\t\t\t\t\"value\": \"Production\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"gl_account\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"invoice_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\t\t\"value\": \"glide.maint\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitoring_requirements\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"warranty_expiration\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset_tag\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"user_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fqdn\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_change_control\",\n\t\t\t\t\t\t\t\"value\": \"ITSM Engineering\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"change_control\",\n\t\t\t\t\t\t\t\"value\": \"5f721d93c0a8010e015533746de18bf9\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sla\",\n\t\t\t\t\t\t\t\"value\": \"Finance 99.99\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sla\",\n\t\t\t\t\t\t\t\"value\": \"5f78c96cc0a8010e01299db51d651a29\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_owned_by\",\n\t\t\t\t\t\t\t\"value\": \"James Vittolo\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"owned_by\",\n\t\t\t\t\t\t\t\"value\": \"5f728212c0a8010e004a13c7588047dd\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_out\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unit_description\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_relation_manager\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_review_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"version\",\n\t\t\t\t\t\t\t\"value\": \"7\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_contact\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"compatibility_dependencies\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"maintenance_schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_install_status\",\n\t\t\t\t\t\t\t\"value\": \"Installed\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_center\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"supported_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"dns_domain\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\t\t\"value\": \"Client Services\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"purchase_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"subcategory\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"price_model\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"business_need\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_manager\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"end_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"short_description\",\n\t\t\t\t\t\t\t\"value\": \"Client Services Description\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"busines_criticality\",\n\t\t\t\t\t\t\t\"value\": \"1 - most critical\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assignment_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_managed_by\",\n\t\t\t\t\t\t\t\"value\": \"Roger Rasmussen\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"managed_by\",\n\t\t\t\t\t\t\t\"value\": \"5f72e70ac0a8010e003e479c72d75d47\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"can_print\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"Service\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"cmdb_ci_service\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"manufacturer\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"prerequisites\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\t\t\"value\": \"5f5c4854c0a8010e00c202b418f5b73b\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"po_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/!!\\/#C\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"mac_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"vendor\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"company\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"justification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"department\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned_to\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"start_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"comments\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_mod_count\",\n\t\t\t\t\t\t\t\"value\": \"14\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitor\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"serial_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"ip_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_model_id\",\n\t\t\t\t\t\t\t\"value\": \"Unknown\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_id\",\n\t\t\t\t\t\t\t\"value\": \"e8aaeb3f3763100044e0bfc8bcbe5d20\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"duplicate_of\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_cc\",\n\t\t\t\t\t\t\t\"value\": \"USD\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"price_unit\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"order_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_support_group\",\n\t\t\t\t\t\t\t\"value\": \"ITSM Engineering\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"support_group\",\n\t\t\t\t\t\t\t\"value\": \"5f721d93c0a8010e015533746de18bf9\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"correlation_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unverified\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"attributes\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_location\",\n\t\t\t\t\t\t\t\"value\": \"450 West 14th Avenue, Denver,CO\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"location\",\n\t\t\t\t\t\t\t\"value\": \"5f715265c0a8010e00f046fefa466a9c\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_asset\",\n\t\t\t\t\t\t\t\"value\": \"Unknown\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset\",\n\t\t\t\t\t\t\t\"value\": \"c0c13e8837f3100044e0bfc8bcbe5d50\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"category\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fault_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"lease_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"service_classification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"relation_type\",\n\t\t\t\t\t\t\t\"value\": \"Depends on::Used by\"\n\t\t\t\t\t\t}],\n\t\t\t\t\t\t\"relations\": []\n\t\t\t\t\t}, {\n\t\t\t\t\t\t\"attachments\": [],\n\t\t\t\t\t\t\"id\": \"5f8af237c0a8010e01a932999468b83a\",\n\t\t\t\t\t\t\"fields\": [{\n\t\t\t\t\t\t\t\"name\": \"tcp_port\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"skip_sync\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_operational_status\",\n\t\t\t\t\t\t\t\"value\": \"Operational\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"operational_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"running_process_command\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"pid\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 14:42:56\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 21:42:56\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"type\",\n\t\t\t\t\t\t\t\"value\": \"Apache\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"running_process_key_parameters\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"rp_command_hash\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"discovery_source\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"first_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_by\",\n\t\t\t\t\t\t\t\"value\": \"glide.maint\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_directory\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 14:42:56\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2006-07-11 21:42:56\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain\",\n\t\t\t\t\t\t\t\"value\": \"global\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"used_for\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"is_clustered\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"gl_account\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"invoice_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\t\t\"value\": \"glide.maint\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"warranty_expiration\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset_tag\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fqdn\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"change_control\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"owned_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_out\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"rp_key_parameters_hash\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"version\",\n\t\t\t\t\t\t\t\"value\": \"6.0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"maintenance_schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_install_status\",\n\t\t\t\t\t\t\t\"value\": \"Installed\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_center\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"supported_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"dns_domain\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\t\t\"value\": \"apache linux den 200\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"provided_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"purchase_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"subcategory\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"short_description\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assignment_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"managed_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"edition\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"can_print\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"Web Server\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"cmdb_ci_web_server\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"manufacturer\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\t\t\"value\": \"5f8af237c0a8010e01a932999468b83a\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"po_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cl_port\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/!!\\/!(\\/!3\\/!#\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"mac_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"vendor\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"company\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"justification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"department\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"config_file\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned_to\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"start_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"comments\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_mod_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitor\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"serial_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"ip_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"duplicate_of\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_cc\",\n\t\t\t\t\t\t\t\"value\": \"USD\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"order_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_support_group\",\n\t\t\t\t\t\t\t\"value\": \"IT Securities\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"support_group\",\n\t\t\t\t\t\t\t\"value\": \"5f6441efc0a8010e0177fcb589156352\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"correlation_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unverified\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"attributes\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"location\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_asset\",\n\t\t\t\t\t\t\t\"value\": \"P1000892 - Unknown\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset\",\n\t\t\t\t\t\t\t\"value\": \"84c13e8837f3100044e0bfc8bcbe5d53\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"category\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fault_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"config_directory\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"lease_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"relation_type\",\n\t\t\t\t\t\t\t\"value\": \"Runs on::Runs\"\n\t\t\t\t\t\t}],\n\t\t\t\t\t\t\"relations\": []\n\t\t\t\t\t}, {\n\t\t\t\t\t\t\"attachments\": [],\n\t\t\t\t\t\t\"id\": \"8dfc095bdb200010d9adf53a299619d7\",\n\t\t\t\t\t\t\"fields\": [{\n\t\t\t\t\t\t\t\"name\": \"skip_sync\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_operational_status\",\n\t\t\t\t\t\t\t\"value\": \"Operational\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"operational_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2019-10-22 23:00:11\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_on\",\n\t\t\t\t\t\t\t\"value\": \"2019-10-23 06:00:11\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_count\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"discovery_source\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"first_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_updated_by\",\n\t\t\t\t\t\t\t\"value\": \"system\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2019-10-22 08:26:49\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\t\t\"value\": \"2019-10-22 15:26:49\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain\",\n\t\t\t\t\t\t\t\"value\": \"global\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"gl_account\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"invoice_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\t\t\"value\": \"admin\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"part_of\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"warranty_expiration\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset_tag\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fqdn\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"license_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"change_control\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"owned_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_out\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_domain_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"version\",\n\t\t\t\t\t\t\t\"value\": \"1.0.0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"delivery_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"maintenance_schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_install_status\",\n\t\t\t\t\t\t\t\"value\": \"Installed\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"install_status\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_center\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"supported_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"dns_domain\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\t\t\"value\": \"soft1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"purchase_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"subcategory\",\n\t\t\t\t\t\t\t\"value\": \"Package\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"short_description\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assignment_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"managed_by\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"can_print\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"last_discovered\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"Software\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_name\",\n\t\t\t\t\t\t\t\"value\": \"cmdb_ci_spkg\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_manufacturer\",\n\t\t\t\t\t\t\t\"value\": \"ACME Americas\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"manufacturer\",\n\t\t\t\t\t\t\t\"value\": \"98c37b193790200044e0bfc8bcbe5dbe\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\t\t\"value\": \"8dfc095bdb200010d9adf53a299619d7\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"po_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"checked_in\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_class_path\",\n\t\t\t\t\t\t\t\"value\": \"\\/!!\\/#*\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"mac_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"vendor\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"company\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"justification\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"department\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"key\",\n\t\t\t\t\t\t\t\"value\": \"soft1_:::_1.0.0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"assigned_to\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"start_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"msft_sms_id\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"comments\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"license_available\",\n\t\t\t\t\t\t\t\"value\": \"-1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_mod_count\",\n\t\t\t\t\t\t\t\"value\": \"1\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"monitor\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"serial_number\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"ip_address\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"label_model_id\",\n\t\t\t\t\t\t\t\"value\": \"Unknown\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"model_id\",\n\t\t\t\t\t\t\t\"value\": \"5c1dcd1bdb200010d9adf53a29961980\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"duplicate_of\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"cost_cc\",\n\t\t\t\t\t\t\t\"value\": \"USD\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"order_date\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"schedule\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"support_group\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"due\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"package_name\",\n\t\t\t\t\t\t\t\"value\": \"soft1 1.0.0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"correlation_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"unverified\",\n\t\t\t\t\t\t\t\"value\": \"false\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"attributes\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"location\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"asset\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"category\",\n\t\t\t\t\t\t\t\"value\": \"Software\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"fault_count\",\n\t\t\t\t\t\t\t\"value\": \"0\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"lease_id\",\n\t\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t\t}, {\n\t\t\t\t\t\t\t\"name\": \"relation_type\",\n\t\t\t\t\t\t\t\"value\": \"Runs on::Runs\"\n\t\t\t\t\t\t}],\n\t\t\t\t\t\t\"relations\": []\n\t\t\t\t\t}]\n\t\t\t\t}]\n\t\t\t}]\n\t\t},\n\t\t{\n\t\t\t\"COMMENTS\": [{\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"795fc88fdb840010ee6d1fc768961940\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\"value\": \"795fc88fdb840010ee6d1fc768961940\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 12:47:15\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 19:47:15\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\"value\": \"incident\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element_id\",\n\t\t\t\t\t\"value\": \"8e4b000fdb840010ee6d1fc7689619d0\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"value\",\n\t\t\t\t\t\"value\": \"[comment]\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\"value\": \"bardioc-connect\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element\",\n\t\t\t\t\t\"value\": \"work_notes\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": []\n\t\t\t}, {\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"cdabc8cbdb840010ee6d1fc7689619a4\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\"value\": \"cdabc8cbdb840010ee6d1fc7689619a4\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 12:31:06\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 19:31:06\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\"value\": \"incident\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element_id\",\n\t\t\t\t\t\"value\": \"8e4b000fdb840010ee6d1fc7689619d0\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"value\",\n\t\t\t\t\t\"value\": \"Some work notes for Daniel. Daniel lives for work notes (and sometimes beer). \"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\"value\": \"admin\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element\",\n\t\t\t\t\t\"value\": \"work_notes\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": []\n\t\t\t}, {\n\t\t\t\t\"attachments\": [],\n\t\t\t\t\"id\": \"e0bb080fdb840010ee6d1fc7689619d7\",\n\t\t\t\t\"fields\": [{\n\t\t\t\t\t\"name\": \"sys_id\",\n\t\t\t\t\t\"value\": \"e0bb080fdb840010ee6d1fc7689619d7\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"label_sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 12:31:19\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_on\",\n\t\t\t\t\t\"value\": \"2019-09-26 19:31:19\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"name\",\n\t\t\t\t\t\"value\": \"incident\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element_id\",\n\t\t\t\t\t\"value\": \"8e4b000fdb840010ee6d1fc7689619d0\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_tags\",\n\t\t\t\t\t\"value\": \"\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"value\",\n\t\t\t\t\t\"value\": \"[comment]\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"sys_created_by\",\n\t\t\t\t\t\"value\": \"bardioc-connect\"\n\t\t\t\t}, {\n\t\t\t\t\t\"name\": \"element\",\n\t\t\t\t\t\"value\": \"work_notes\"\n\t\t\t\t}],\n\t\t\t\t\"relations\": []\n\t\t\t}]\n\t\t}\n\t]\n}Following are general maps used for Incident and Change transformation. Please note that, the actual (syntactically accurate) mapping is part of the connector package.
\nTransformation maps can be found in:
\nServiceNow → Bardioc:
\n/opt/almato/connect/pluggable/plugins/bardioc/maps/snow2bardioc_TOOL_MAP_SUFFIX.map
Bardioc → ServiceNow:
\n/opt/almato/connect/pluggable/plugins/jira/maps/bardioc2snow_TOOL_MAP_SUFFIX.map
| \n\n | \n\nWe strongly recommend NOT to change these names. If you must however, you can do so in:\n /opt/almato/connect/pluggable/plugins/bardioc/bardioc.endpoint.xml\n /opt/almato/connect/pluggable/plugins/snow/snow.endpoint.xml\n | \n
The incident transformation map for transformation from an Incident SDF to Snow Incident looks as follows:
\n| \n\n | \n\nThese maps are meant for ease of modification so the map below may not be the final map.\n | \n
#*********************************************************##\n# CASE to determine which map will be used.......\n#*********************************************************##\nCASE nothing in\n *)\n GOTO MAP2Bardioc\n ;;\nESAC\n\n#*********************************************************##\n# MAP DEFINITION ##\n#*********************************************************##\n\n\nDEFINE MAP2Bardioc{\n\nid = $EVAL(\n var d = JSON.parse('[data]');\n\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n getFieldValue(\"number\", d.fields);\n)\n\ndata = $EVAL(\n\n var ticketType = \"[_const_ticketPath]\";\n var json = {\"$type\": ticketType};\n\n //convert json to javascript object\n var d = JSON.parse('[data]');\n\n // TODO: conditional mapping if cmdb_ci is empty\n //json.originNode = getFieldValue(\"cmdb_ci\", d.fields);\n json.originNode = \"machine1\";\n\n // Individual maps\n if (ticketType == \"incident\") {\n //associated change\n setFieldValue(\"customfield_0001.value\", \"/AssociatedChange\", d.fields);\n }\n\n if (ticketType == \"change\") {\n //ApprovalQuantity\n setFieldValue(\"customfield_0002\", \"/ApprovalQuantity\", d.fields, \"needed\");\n\n }\n\n // Common section for all ticket types\n\n\n //obsolete: processIssue set by DoApi with issue creation\n //json.processIssue = \"process me\";\n\n //converted normalized status\n //json.sourceStatus = getStatus(getFieldValue(\"state\", d.fields));\n\n //assign group\n json.assignee = getFieldValue(\"assignment_group\", d.fields);\n\n //subject\n var subject = getFieldValue(\"short_description\", d.fields);\n if(subject == \"\"){ subject = \"<No Value>\"; }\n json.subject = subject.replace(/\\r/g, '');\n\n //description\n var description = getFieldValue(\"description\", d.fields);\n if(description == \"\"){ description = \"<No Value>\"; }\n json.description = description.replace(/\\r/g, '');\n\n //priority\n json.priority = getFieldValue(\"priority\", d.fields);\n\n //urgency\n json.urgency = getFieldValue(\"urgency\", d.fields);\n\n //sourceStatus\n json.sourceStatus = getFieldValue(\"state\", d.fields);\n\n //impact\n //json.impact = getFieldValue(\"impact\", d.fields);\n\n //risk\n json.risk = getFieldValue(\"risk\", d.fields);\n\n //justification\n json.justification = getFieldValue(\"justification\", d.fields);\n\n //add in comments\n var coms = getRelation(\"COMMENTS\", d.relations).COMMENTS;\n var comment = {};\n if(coms != null && coms != \"\"){\n var clength = coms.length;\n if(clength > 0){\n var c = getFieldValue(\"number\", d.fields) + \"-COMMENT\";\n comment[c] = {};\n var comments = [];\n for(var i=0;i<coms.length;i++){\n var id = coms[i].id;\n var com = {};\n var v = {};\n\n v.value = getFieldValue(\"value\", coms[i].fields);\n if(v.value != null){ v.value = v.value.replace(/\\r/g, ''); }\n if(v.value == null || v.value == \"\"){\n v.value = getFieldValue(\"body.content\", coms[i].fields);\n if(v.value != null){ v.value = v.value.replace(/\\r/g, ''); }\n }\n v.timestamp = Date.parse(getFieldValue(\"sys_created_on\", coms[i].fields));\n //ignore literal comment in bracket\n if(v.value.length == 9 && v.value.substring(1, (v.value.length - 1)) == \"comment\"){\n continue;\n }\n comments.push(v);\n }\n comment[c].comments = comments;\n }\n json.comments = comment;\n }\n\n /*********** FUNCTIONS ************/\n\n //given a field name and field object, get a fields value\n function getFieldValue(name, object){\n var x = object.length;\n for(var i=0;i<x;i++){\n if(name == object[i].name)\n return object[i].value;\n }\n }\n //get relationObject\n function getRelation(name, relations){\n var rellength = relations.length;\n for(var i=0;i<rellength;i++){\n var rel = relations[i];\n var keys = Object.keys(rel);\n var kl = keys.length;\n for(var t=0;t<kl;t++){\n if(keys[t] == name){\n return relations[i];\n }\n }\n }\n return [];\n }\n\n //getPerson\n function getPerson(name){\n var cid = {\"none\" : {\"connector\": {\"snow-connector\": {}}}};\n var id = {};\n id[name] = {};\n id[name].ci = cid;\n return id;\n }\n\n //get a transformed status\n function getStatus(state){\n var s = \"\";\n switch(state){\n case \"1\":\n s = \"New\";\n break;\n case \"2\":\n s = \"Assigned\";\n break;\n case \"3\":\n s = \"Pending\";\n break;\n case \"4\":\n s = \"Pending\";\n break;\n case \"5\":\n s = \"Pending\";\n break;\n case \"6\":\n s = \"Resolved\";\n break;\n case \"7\":\n s = \"Closed\";\n break;\n case \"8\":\n s = \"Closed\";\n break;\n }\n return s;\n }\n\n result = JSON.stringify(json);\n )\n} ENDIn reading the map file, the transformation logic first looks for the CASE statement to determine which map to load. In the above mapping example here is only one possible option: MAP2Bardioc. Next the transformer logic will go to the DEFINE statement for MAP2Bardioc and evaluate each of the field mappings. To the left of = is the key (field) from Jira that will be assigned the value from the right.To the right of = is where the value can be defined. The value can be assigned from a field defined in the SDF by using the SDF field between begin and end blocks.
Fields which specific to a process is mapped in the corresponding process. In the following example, 'customfield_0001.value' which is unique to incident process is mapped to '/AssociatedChange'. Requirement process maps 'customfield_0002' to '/ApprovalQuantity'.
\n// Individual maps\n if (ticketType == \"incident\") {\n\n //associated change\n setFieldValue(\"customfield_0001.value\", \"/AssociatedChange\", d.fields);\n\n }\n\n if (ticketType == \"change\") {\n\n //ApprovalQuantity\n setFieldValue(\"customfield_0002\", \"/ApprovalQuantity\", d.fields, \"needed\");\n\n }\nFields which are common for all the processes are mapped outside the conditional loops.
\nThe id assignment uses the $EVAL() function, which interprets as javascript, whatever text is included between the parenthesis.
The $EVAL() function is defined by:
Function | \nPurpose | \nInput | \nOutput | \n
$EVAL | \nImplementation of java script allowing scripting within a java script context | \nAny source value denoted by [] may be used in the java script call | \nString | \n
\n \nExample: \n\n \n \noutputValue = $EVAL(\n var value = \"Example\";\n for(var i=0;i<10;i++){\n value += i;\n }\n result = value;\n )\n | \n|||
\n outputValue: Example0123456789 \n | \n
Function | \nPurpose | \nInput | \nOutput | \n
getFieldValue | \nTo find the value of the field to be mapped | \nJSON object | \nString | \n
\n \nExample: \n\n \n \nvar json = '{\"description\":\"Jira connector mapping example\", \"id\":42}';\nvar obj = JSON.parse(json);\nvar field = \"description\"\noutputValue = getFieldValue(field, obj){\n var x = obj.length;\n for(var i=0;i<x;i++){\n if(field == obj[i].name)\n return obj[i].value.replace(/\\r/g, '');\n }\n }\n | \n|||
\n outputValue: Jira connector mapping example \n | \n
Function | \nPurpose | \nInput | \nOutput | \n
getFieldValue | \nTo find the value of the field and to optionally assign a default value. | \nJSON object | \nString | \n
\n \nExample: \n\n \n \nvar json = '{\"customfield_0001\":\"CHG001\", \"customfield_0002\":\" \"}';\nvar obj = JSON.parse(json);\nvar field1 = customfield_0001.value\nvar dest1 = \"/AssociatedChange\"\nvar dest_json = {}\n\nsetFieldValue(field1,dest1,obj)\n\nfunction setFieldValue(source, destination, object, options) {\n var myVal = getFieldValue(source, object);\n if(!myVal && options==\"needed\") {\n myVal=\"<No Value>\";\n }\n // empty fields can be deletions and need to propagate\n if(!myVal && myVal == \"\") {\n json[destination]='';\n }\n // any other values can propagate\n if(myVal) {\n dest_json[destination]=myVal;\n }\n }\n | \n|||
\n dest_json = '{\"/AssociatedChange\":\"CHG001\"}' \n | \n|||
\n \nExample: \n\n \n \nvar json = '{\"customfield_0001\":\"CHG001\", \"customfield_0002\":\" \"}';\nvar obj = JSON.parse(json);\nvar field2 =customfield_0002\ndest2 = \"/ApprovalQuantity\"\noption = \"needed\"\n\nsetFieldValue(field2,dest2,obj,option)\n\nfunction setFieldValue(source, destination, object, options) {\n var myVal = getFieldValue(source, object);\n if(!myVal && options==\"needed\") {\n myVal=\"<No Value>\";\n }\n // empty fields can be deletions and need to propagate\n if(!myVal && myVal == \"\") {\n json[destination]='';\n }\n // any other values can propagate\n if(myVal) {\n dest_json[destination]=myVal;\n }\n }\n | \n|||
\n dest_json = '{\"/ApprovalQuantity\":\"<No Value>\"} \n | \n
The transformation map for transformation from SDF to Incident and Change looks as follows:
\n| \n\n | \n\nThese maps are meant for ease of modification so the map below may not be the final map.\n | \n
#*********************************************************##\n# CASE to determine which map will be used.......\n#*********************************************************##\nCASE nothing in\n *)\n GOTO MAP2SNOW\n ;;\nESAC\n\n#*********************************************************##\n# MAP DEFINITION ##\n#*********************************************************##\n\nDEFINE MAP2SNOW{\n number = [$id]\n description = $EVAL(\n var x = \"[description]\";\n if(x == \"<No value>\"){\n x = \"<*<IGNORE>*>\";\n }\n result = x;\n )\n priority = [priority]\n short_description = [subject]\n state = $EVAL(\n var s = \"[bardiocStatus]\";\n var res = \"<*<IGNORE>*>\";\n # set to review\n if(s == \"RESOLVED\"){ res = \"6\";}\n result = res;\n\n )\n\n close_code = $EVAL(\n var s = \"[bardiocStatus]\";\n var res = \"<*<IGNORE>*>\";\n if(s == \"RESOLVED\"){\n res = \"Solved (Permanently)\";\n }\n if(s == \"STOPPED\" || s == \"TERMINATED\"){\n res = \"Not Solved (Not Reproducible)\";\n\n }\n result = res;\n )\n\n #Re-assigned to Bardioc ADMIN when bardioc can't sort the issue\n assignment_group = $EVAL(\n var s = \"[bardiocStatus]\";\n var res = \"<*<IGNORE>*>\";\n if(s == \"STOPPED\" || s == \"TERMINATED\"){\n res = \"__TOOL_FALLBACK_GROUP__\";\n\n }\n if(s == \"WAITING\"){\n res = \"__TOOL_FALLBACK_GROUP__\";\n\n }\n result = res;\n )\n close_notes = \"[closeNotes]\";\n\n\n work_notes = $EVAL(\n var comment = '\"[comment]\"';\n var res = \"\"; //<*<IGNORE>*>\";\n if(comment != \"\" && comment != \"\\\"\\[comment\\]\\\"\"){\n var ar = comment.split(\"@@@@\");\n var i = 0;\n\n //sort by date so in right order\n ar.sort(function(a,b){\n var aa = a.split(\"::\");\n var bb = b.split(\"::\");\n aaa = aa.shift().trim();\n bbb = bb.shift().trim();\n return Date.parse(aaa) - Date.parse(bbb);\n });\n\n var t = ar.length;\n var x = \"\";\n for(i=0;i<t;i++){\n if((x = ar[i]) != \"\"){\n res += x + \"\\n\";\n }\n }\n }\n if(res == \"\"){ res = \"<*<IGNORE>*>\";}\n result = res;\n )\n}\nENDIncident and Change SDF can contain multiple comment SDFs. These separate comments are run through a separate transformation map (shown below), concatenated together, and assigned to the comment field as explained in Transformation Maps section.
\n#*********************************************************##\n# CASE to determine which map will be used\n#*********************************************************##\nCASE nothing in\n COMMENTS)\n GOTO COMMENTS\n ;;\n *)\n GOTO COMMENTS\n ;;\nESAC\n\n#*********************************************************##\n# MAP DEFINITION ##\n#*********************************************************##\n\nDEFINE COMMENTS{\n\n##This passes a bardioc comment concatenated string of time and\n##comment to parent map (e.g 2017-12-02'T'12:00:00Z :: SomeCommentContent)\n\n##If there are more than one comments they are concatenated together\n##before being consumed by the parent map and therefore will need\n##applicable parsing (i.e. @@@@ used as delimiter)\n\ncomment = $EVAL(\n var ts = \"[timestamp]\";\n var d = JSON.parse('[value]');\n var res = \"<*<IGNORE>*>\";\n\n if(ts != null && ts != \"\"){\n // var comment = JSON.stringify(d.Entries[0].Message); //\"[value]\";\n var comments = d.Entries; //\"[value]\";\n var comment = \"\";\n for (var i = 0; i < comments.length; i++) {\n if (comments[i].LogLevel == \"info\") {\n comment=comments[i].Message;\n }\n }\n var d = new Date(0);\n d.setUTCMilliseconds(ts);\n var ds = d.toISOString();\n res = \"Bardioc \" + ds + \" : \" + comment;\n }\n result = res;\n )\n} ENDThe comment field can then be used by the main change and incident map for further transformation to sort the comments by order of date as seen in the $EVAL() statement.