Xurrent
Xurrent İntegration Guide
Introduction
Explore the integration between Autom Mate and Xurrent, detailing the available actions in Autom Mate for interacting with Xurrent functionalities.
This document delves into the seamless integration between Autom Mate, a powerful workflow automation platform, and Xurrent, an advanced IT service management (ITSM) solution. It provides insights into the actions within Autom Mate that empower users to interact with the diverse functionalities offered by Xurrent.
What is Xurrent?
Xurrent is a robust ITSM product designed to optimize service delivery for organizations, government agencies, and managed service providers (MSPs). It offers an extensive suite of functionalities to streamline IT service management processes, including:
Processes to identify, diagnose, and resolve unexpected interruptions to IT services.
Autom Mate Integration with Xurrent
Autom Mate offers a seamless integration with Xurrent through a collection of pre-built actions. These actions empower users to Autom Mate various tasks within their workflows by harnessing the capabilities of Xurrent.
Some examples include:
Automatically creating service requests in Xurrent upon receiving emails from customers.
Updating configuration item statuses in Xurrent based on predefined criteria.
Adding notes to existing requests within Xurrent workflows.
Credentials
Steps to establish a secure connection between Autom Mate and Xurrent using credentials.
How to Create Credentials: To utilize the actions within Autom Mate , you need to establish a credential that connects to your Xurrent account/instance. This credential acts as a secure bridge, enabling Autom Mate to interact seamlessly with your Xurrent data. You can add your credentials at Vault page.
Step 1: Specify Connector Name
Connector Name: Enter a friendly and descriptive name for the connector. This name will be used globally within your Autom Mate environment to identify this connection.
Step 2: Choose Authentication Type
Authentication Type: Select between Personal Access Token or OAuth 2.0 Client Credentials Grant based on your security and access requirements.
Step 3: Configure Personal Access Token (If Chosen)
If you selected Personal Access Token as the Authentication Type:
API URL: Enter the Xurrent API entry point URL specific to your environment and region.
Personal Access Token: Input the token value you created in your 4me Server.
Account Name: Specify the name of your 4me environment’s account.
Step 4: Configure OAuth 2.0 Client Credentials Grant (If Chosen)
If you selected OAuth 2.0 Client Credentials Grant as the Authentication Type:
API OAuth Service URL: Provide the OAuth service URL that references your environment and region. This URL enables secure communication for OAuth requests.
API URL: Enter the Xurrent API entry point URL specific to your environment and region.
Account Name: Specify the name of your 4me environment’s account.
Client ID: Enter the OAuth 2.0 client ID.
Client Secret: Provide the OAuth 2.0 client secret for authentication.
Step 5: Save and Confirm
Review all entered details to ensure accuracy.
Click Save to store the new application credentials.
Warning: OAuth connections are not supported in Xurrent versions below 2.6.8. Users with older versions will not be able to use the OAuth feature.
How To Use Actions
Detailed instructions on using specific actions available in the Autom Mate - Xurrent integration.
Xurrent Markdown text to HTML
Description and Purpose
The Convert Xurrent Markdown to HTML action allows users to transform text written in Xurrent markdown syntax into HTML format. This action is particularly useful for displaying formatted text in applications or for further processing within workflows.
Usage Instructions
Add Note
Description and Purpose
The Add Note to Request action allows users to attach a note to a specific request within Xurrent, streamlining documentation and enhancing communication. This action is ideal for keeping records of updates or important information related to a request, with additional options for internal notes and notification control.
Usage Instructions
Identify the Request
Request ID (Required): Select or enter the unique identifier of the request to which the note will be added. You can select from a dropdown list of up to 100 requests or manually enter the Request ID.
Compose the Note
Note Text (Required): Write the content of the note in this field. This text will be attached to the specified request as an official note.
Configure Optional Settings
Internal Note: Choose whether to make the note internal:
Yes: Marks the note as internal, visible only to specified users.
No: Default setting, making the note visible to all with access to the request.
Suppress Notifications: Choose whether to suppress the notification for this note addition:
Yes: Suppresses the notification, preventing others from receiving an alert about this note.
No: Default setting, which allows the notification to be sent.
Execute the Action
Run the action to attach the note to the specified request based on the provided inputs and optional configurations.
Verify Note Addition
Review the Note Added output to confirm successful note addition. This output will indicate that the note has been successfully added to the request with the desired settings.
Inputs
Request ID (Required): The unique identifier of the request. Either select from a dropdown list of 100 recent requests or manually enter the ID.
Note Text (Required): The content of the note to be added to the request.
Internal Note: Optional setting to make the note internal:
Yes: Internal note, only accessible to select users.
No: Visible to all with access to the request (default).
Suppress Notifications: Optional setting to control notification alerts:
Yes: Suppresses notifications for the added note.
No: Sends notifications as usual (default).
Hint
This action provides flexible options for documenting updates on requests, including the ability to restrict visibility and control notifications.
Note: Be sure the Request ID is correct to ensure the note is added to the intended request. Use the Internal Note setting carefully, as it limits visibility to specific users only.
Add Note with Markdown
Description and Purpose
The Add Formatted Note with Attachments to Request action enables users to add a detailed, formatted note to a specific request within Xurrent, using Xurrent markdown syntax. This action is particularly useful for adding rich-text notes, with support for attachments, to enhance documentation and communication around requests.
Usage Instructions
Specify the Request
Request ID (Required): Enter the unique identifier of the request where the note should be added. This ID specifies the exact request to which the note and attachments will be linked.
Compose the Markdown Note
Xurrent Markdown Note (Required): Enter the note content in Xurrent markdown syntax. This markdown note can include formatted text, lists, links, and other markdown-supported features, allowing for a structured and readable note.
Attach Files
Storage Files (Optional): Provide references to any stored files that need to be attached with the note. These files could be relevant documents, images, or any other attachments that add context to the note. Ensure the files are stored within the system and accessible via the provided references.
Execute the Action
Run the action to attach the formatted note and any specified files to the designated request. This will add the note in markdown format, allowing for structured, formatted content to be displayed in the request.
Verify Note Addition
After executing, confirm that the note was added successfully by checking the Note Added output, which provides a confirmation, and additional details of the note added.
Inputs
Request ID (Required): The unique identifier for the request where the note will be added. Ensure the ID is correct to prevent misplacement.
4me Markdown Note (Required): The content of the note, entered in Xurrent markdown syntax for structured formatting.
Storage Files (Optional): References to files stored in the system that need to be attached with the note.
Outputs
Note Added: A confirmation message or details of the note added, including verification that the note content and any attachments were successfully applied to the specified request.
Create Site
Description and Purpose
The Create Site action allows users to add a new physical or virtual location within the Xurrent platform. This action is useful for expanding the system’s operational scope by introducing new sites, whether they represent actual locations or virtual environments.
Usage Instructions
Enter Site Name
Name: Specify the name of the site to be created. This name will be used to identify the site within the platform.
Execute Site Creation
Run the action to initiate the creation of the new site in the system. Once executed, Xurrent will generate and register the site based on the provided name.
Review Site Details
Upon successful execution, view the details of the new site to confirm it has been created accurately and is now available for further configuration or use.
Create an Organization
Description and Purpose
The Create New Organization Entity action enables users to add new organizational units or entities within Xurrent. This action is essential for expanding the organizational structure within the platform, allowing users to manage and organize different units, departments, or entities as needed.
Usage Instructions
Enter Organization Name
Name: Specify the name of the organization to be created. This name will serve as the identifier for the new entity within Xurrent.
Execute Organization Creation
Run the action to initiate the creation of the new organization in the system. Once executed, Xurrent will register the organization based on the provided name.
Review Organization Details
After successful creation, review the details of the newly added organization to confirm its setup. This confirmation ensures that the organization is properly registered and ready for use within the platform.
Create Configuration Item
Description and Purpose
The Create New Configuration Item action enables users to add new items to the configuration management database (CMDB) within Xurrent. This action is essential for expanding and managing the configuration items, allowing for better tracking and control over assets or resources associated with various products.
Usage Instructions
Specify Product
Product: Enter the name of the product associated with the configuration item. This helps categorize the item within the configuration management database.
Define Item Status
Status: Set the current status of the configuration item, such as "Active," "Inactive," or any other relevant status. This status helps track the item’s lifecycle and availability.
Execute Item Creation
Run the action to create the new configuration item. Once executed, Xurrent will add the item to the CMDB based on the provided product and status information.
Review Creation Response
After the action completes, check the response to verify that the configuration item was successfully created. This includes any additional details about the item’s setup in the CMDB.
Create Person
Description and Purpose
The Create New Person Record action enables users to add new individuals to the Xurrent system. This action is essential for building and maintaining a directory of people, allowing for efficient management of users, contacts, or personnel associated with various organizations within the platform.
Usage Instructions
Enter Primary Email Address
Primary Email: Provide the primary email address of the individual. This email will be used to uniquely identify the person within the system.
Provide Full Name
Name: Enter the full name of the individual. This will serve as the main identifier and display name for the person’s record in the system.
Specify Organization
Organization: Indicate the organization with which the person is associated. This information helps categorize and manage records according to organizational structure.
Execute Record Creation
Run the action to create the new person record. Once executed, Xurrent will add the person based on the provided details.
Review Creation Response
After execution, check the response to confirm that the person record has been successfully created. The response will include additional details about the new person’s setup.
Inputs
Primary Email: The primary email address of the person. This input is required to uniquely identify and contact the individual within Xurrent.
Name: The full name of the person being added to the system.
Organization: The organization with which the person is associated, providing context within the system.
Create Product
Description and Purpose
The Create New Product Entity action enables users to add new products or services to the Xurrent system. This action is ideal for expanding the catalog of products or services managed within the platform, allowing users to organize and categorize offerings by model, category, brand, and name.
Usage Instructions
Specify Model Designation
Model: Enter the model designation of the product. This field identifies the specific version or type of the product within the system.
Define Product Category
Category: Choose or specify the category to which the product belongs, such as “Software,” “Hardware,” or any relevant classification. This helps in organizing and categorizing the product for easier management.
Provide Brand Information
Brand: Enter the brand name of the product. This field distinguishes the product’s origin or manufacturer, allowing for brand-based organization.
Enter Product Name
Name: Provide the name of the product. This name will be used as the primary identifier of the product in the Xurrent system.
Execute Product Creation
Run the action to create the new product entity. Once executed, the product will be added to Xurrent’s product catalog based on the details provided.
Review Creation Response
After the action completes, check the response to verify that the product was successfully created. The response will include details about the new product, confirming its setup within the system.
Inputs
Model: The model designation of the product. This input is essential for identifying specific types or versions within the product line.
Category: The category to which the product belongs, aiding in its organization within the catalog.
Brand: The brand name of the product, distinguishing its origin or manufacturer.
Name: The name of the product, used as the primary display identifier within the system.
Create Request
Description and Purpose
The Create New Service Request action enables users to submit new requests for IT services or assistance within Xurrent. This action is essential for reporting issues, requesting support, or initiating service tasks, ensuring that each request is documented and directed to the appropriate team or individual for resolution.
Usage Instructions
Enter Request Subject
Subject (Required): Provide a brief description of the request. This serves as the main identifier and gives a concise overview of the issue or service needed. (Example: "Test Request")
Select Category
Category (Required): Choose the category that best describes the request type, such as Incident - Request for Incident Resolution. This categorization helps organize and route the request accurately.
Specify Service Instance
Service Instance: Select the relevant service instance. This links the request to a specific service or system within Xurrent, ensuring that it reaches the correct support team. (Example: "asdadasd")
Define Impact Level
Impact: Choose the impact level based on the extent to which the service instance is affected. For example, Low - Service Degraded for One User. This setting helps prioritize requests by indicating their urgency and importance.
Add Additional Notes
Note: Provide any additional details that might aid in resolving the request or a summary of actions taken so far. This field is helpful for offering context or previous troubleshooting steps.
Attach Relevant Files (Optional)
Note Attachments: Attach any files that may be useful for handling the request. Use attachment keys to link files, such as {"key":"yourkey1"} or [{"key":"yourkey1"},{"key":"yourkey2"}] for multiple files.
Specify Template ID (Optional)
Template ID: Select or specify a Template ID if using UI Extensions. Defining the Template ID correctly is essential when incorporating UI Extensions, as they will not function without it.
Execute Request Creation
Run the action to submit the service request. Xurrent will process and record the request with all provided details.
Review Request Result
After submission, review the Request Result output to confirm that the service request was created successfully. The response will include details of the request, providing additional information or status updates.
Inputs
Subject (Required): A short description of the service request.
Category (Required): The request category, helping to organize and route the request.
Service Instance: The specific service instance related to the request.
Impact: The impact level, indicating the severity of the issue.
Note: Additional information or history of actions taken related to the request.
Note Attachments: Optional attachments related to the request. Use specified attachment keys to include files.
Template ID: Optional Template ID, necessary when using UI Extensions.
This action provides a structured method for submitting service requests, ensuring that issues are documented, prioritized, and directed to the appropriate support channels within Xurrent.
Note: Ensure that the Template ID is specified correctly when using UI Extensions to enable custom functionality for the request.
Create Service Instance
Description and Purpose
The Create New Service Instance action enables users to add new instances or versions of a service within Xurrent. This action is valuable for managing and organizing service variations, allowing users to create and track distinct instances of existing services as needed.
Usage Instructions
Specify Service
Service: Enter the name or unique identifier of the service for which you want to create a new instance. This links the new instance to the appropriate parent service within Xurrent.
Provide Instance Name
Name: Enter a name for the new service instance. This name serves as the main identifier for the instance within the system, helping users differentiate it from other service instances.
Execute Instance Creation
Run the action to initiate the creation of the new service instance. Once executed, Xurrent will add the instance to its records based on the provided service and instance name.
Review Creation Response
After execution, check the Xurrent_resp output to confirm that the new service instance was successfully created. This output provides details of the instance setup and any additional information generated by the system.
Get Last Note of Request
Description and Purpose
The Get Last Note of Request action allows users to retrieve the most recent note added to a specific request within Xurrent. This action is useful for viewing the latest communication, updates, or details associated with a request, ensuring that users are informed of the most recent developments.
Usage Instructions
Specify Request ID
Request ID: Enter the unique identifier of the request from which you want to retrieve the last note. This ensures that the note is retrieved from the correct request in Xurrent.
Execute Note Retrieval
Run the action to obtain the most recent note associated with the specified request. Xurrent will fetch and return the latest note added to the request.
Review Last Note
After execution, check the Last Note output to view the content of the most recent note related to the request.
Get Note Attachments
Description and Purpose
The Get Note Attachments action allows users to access any files or documents linked to a specific note within Xurrent. This action is useful for retrieving attachments, such as supporting files or additional documentation, that are associated with notes on requests or records.
Usage Instructions
Specify Note ID
Note ID: Enter the unique identifier of the note from which you want to retrieve attachments. This ID ensures that the action targets the correct note within Xurrent for attachment retrieval.
Execute Attachment Retrieval
Run the action to retrieve any files or documents attached to the specified note. Xurrent will search for attachments linked to the note and return them in the output.
Review Note Attachments
After execution, check the Note Attachments output to view the retrieved files. This output will contain any documents or files associated with the note, allowing for easy access to linked resources.
This action provides a straightforward method for retrieving files or documents attached to notes, allowing users to easily access relevant information stored in Xurrent.
Note: Ensure the Note ID is correctly entered to avoid retrieving incorrect attachments.
Get Site with ID
Description and Purpose
The Get Site with ID action enables users to retrieve detailed information about a specific site within Xurrent by using its unique identifier. This action is ideal for accessing essential data about a particular site, providing insights or specifics about the location within the platform.
Usage Instructions
Specify Site ID
Site ID: Enter the unique identifier of the site you want to retrieve information about. This ID ensures that the action targets the correct site within Xurrent.
Execute Site Retrieval
Run the action to fetch information about the specified site. Xurrent will use the provided Site ID to locate and retrieve detailed information about the site.
Review Site Details
After execution, check the Site Details output to view the retrieved information. This output will contain relevant data about the site, including any specific attributes or settings.
Get Organization with ID
Description and Purpose
The Get Organization with ID action allows users to retrieve detailed information about a specific organization within Xurrent by using its unique identifier. This action is essential for accessing key details about an organization, providing insights or specific information that supports effective management and review within the platform.
Usage Instructions
Specify Organization ID
Organization ID: Enter the unique identifier of the organization you want to retrieve information about. This ID ensures that the action targets the correct organization within Xurrent.
Execute Organization Retrieval
Run the action to fetch information about the specified organization. Xurrent will use the provided Organization ID to locate and retrieve detailed information about the organization.
Review Organization Details
After execution, check the Organization Details output to view the retrieved information. This output will contain relevant data about the organization, including any specific attributes or configurations.
This action provides a streamlined way to access specific information about organizations within Xurrent, enabling users to obtain essential data and insights for more effective organizational management.
Note: Ensure that the Organization ID is accurately entered to retrieve information for the correct organization.
Get Configuration Item
Description and Purpose
The Get Configuration Item action allows users to retrieve detailed information about a specific configuration item within Xurrent by using its unique identifier. This action is essential for viewing key details and the current status of a configuration item, aiding in efficient configuration management and troubleshooting within the platform.
Usage Instructions
Specify Configuration Item ID
CI ID: Enter the unique identifier for the configuration item you wish to retrieve. This ensures that the action targets the correct configuration item within Xurrent.
Execute Configuration Item Retrieval
Run the action to fetch the details of the specified configuration item. Xurrent will use the provided CI ID to locate and retrieve the relevant information.
Review Configuration Item Details
After execution, check the Xurrent_resp output to view the retrieved details. This output includes comprehensive information about the configuration item and its current status.