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
Inputs
Xurrent Markdown Text: The text input should be in Xurrent markdown syntax. This allows for rich formatting options, which will be accurately converted to HTML.
Outputs
HTML Output: The resulting HTML output generated from the markdown input. This HTML can be used directly within applications for formatted display or embedded within other documents or web content.
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).
Outputs
Note Added: Confirmation output that indicates the note has been successfully added to the request. This output may include a success message or details about the added note.
Sample Output
{"id":343086572}
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.
Note
The Xurrent Markdown Note input supports advanced formatting and is ideal for creating rich, detailed notes that enhance readability and provide clarity within request documentation.
Warning
When using Storage Files for attachments, verify that the files are properly stored and referenced to avoid errors in the attachment process.
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.
Inputs
Name: The name of the new site to be created within Xurrent. This field is required and should uniquely identify the location being added.
Outputs
Site Details: Provides the details of the newly created site, confirming its successful addition to the system. This output may include information such as the site ID, name, and any relevant configuration data.
Create 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.
Inputs
Name: The name of the organization to be created. This input is required to uniquely identify the new organization entity within Xurrent.
Outputs
Organization Details: Provides the details of the newly created organization, confirming its successful addition to the system. This output may include information such as the organization ID, name, and other relevant configuration details.
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.
Inputs
Product: The product associated with the configuration item. This input is required to accurately categorize the item in the CMDB.
Status: The current status of the configuration item, indicating its lifecycle stage or availability.
Outputs
Xurrent_resp: The response generated from the creation process, typically containing details of the newly created configuration item. This output confirms successful creation and provides additional information about the item.
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.
Outputs
Xurrent_resp: The response from the creation process, typically containing details of the newly created person record. This output confirms the successful creation and provides additional information about the person.
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.
Outputs
Xurrent_resp: The response generated from the creation process, typically containing details of the newly created product. This output confirms successful creation and provides additional information about the product entity.
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.
Outputs
Request Result: The response generated after creating the request, containing confirmation and details of the newly created service 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.
Inputs
Service: The name or identifier of the existing service. This input links the new instance to the correct parent service.
Name: The name assigned to the new service instance, serving as its unique identifier within the system.
Outputs
Xurrent_resp: The response generated after the service instance is created. This output confirms the creation and may contain details about the instance for reference.
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.
Inputs
Request ID: The unique identifier of the request. This input is required to access the correct request for note retrieval.
Outputs
Output Header: Contains header or metadata details about the note retrieval process.
Output: Contains the content of the last note added to the specified request, offering users the latest update or communication on 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.
Inputs
Note ID: The unique identifier of the note. This input is required to ensure that the correct note is accessed for attachment retrieval.
Outputs
Note Attachments: Contains any attachments linked to the specified note. This output provides access to files associated with the note for further review or download.
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.
Inputs
Site ID: The unique identifier of the site to be retrieved. This input is required to access the correct site within Xurrent.
Note: Ensure that the Site ID is correctly entered to accurately retrieve information for the intended site.
Outputs
Site Details: The detailed information retrieved for the specified site, including attributes and configurations related to the site.
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.
Inputs
Organization ID: The unique identifier of the organization to be retrieved. This input is required to ensure that the correct organization is accessed within Xurrent.
Outputs
Organization Details: The detailed information retrieved for the specified organization, including attributes and configurations related to the 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.
Inputs
CI ID: The unique identifier of the configuration item. This input is mandatory to access the correct item within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent after retrieving the configuration item, which contains detailed information and the current status of the item.
HTML to Xurrent Markdown Formatter
Description and Purpose
The HTML to Xurrent Markdown Formatter action enables users to convert HTML content into Xurrent-compatible Markdown format. This is particularly useful for adapting HTML-based content for use within Xurrent, ensuring that the content is displayed correctly and adheres to Xurrent's Markdown standards.
Usage Instructions
Input HTML Content
HTML Data: Provide the HTML content you wish to convert. This content will be transformed into Markdown format compatible with Xurrent.
Execute Conversion
Run the action to process the HTML data and generate the corresponding Xurrent Markdown format. This conversion ensures that the HTML content is adapted for Xurrent's Markdown rendering.
Review Xurrent Markdown Output
After execution, check the Xurrent Markdown Output to view the formatted result. This output contains the converted Markdown content, ready for use within Xurrent.
Inputs
HTML Data: The HTML content that needs to be converted into Xurrent-compatible Markdown format. This input is required for the action to process the content accurately.
Outputs
Xurrent Markdown Output: The result of the HTML-to-Markdown conversion, providing the content in a format suitable for use within Xurrent.
List notes of request
Description and Purpose
The List Notes of Request action enables users to retrieve all notes associated with a specific request within Xurrent. This action provides a complete history of communications or updates related to the request, giving users a clear view of any discussions, decisions, or actions taken.
Usage Instructions
Specify Request ID
Request ID: Enter the unique identifier of the request for which you want to list all associated notes. This ensures that the action retrieves notes from the correct request within Xurrent.
Execute Note Retrieval
Run the action to retrieve the list of all notes associated with the specified request. Xurrent will fetch and return the full set of notes for that request.
Review Request Notes
After execution, check the Request Notes output to view the list of all notes. This output will contain each note, providing a detailed history of updates and communications related to the request.
Inputs
Request ID: The unique identifier of the request. This input is required to retrieve notes for the correct request in Xurrent.
Outputs
Request Notes: The list of all notes associated with the specified request, providing a complete history of communications and updates.
Update Site
Description and Purpose
The Update a Site action allows users to modify details of an existing site within Xurrent. This action is essential for maintaining accurate and up-to-date site information, helping users manage site attributes as changes occur.
Usage Instructions
Specify Site ID
Site ID: Enter the unique identifier of the site you wish to update. This ensures that the action targets the correct site within Xurrent for modifications.
Execute Site Update
Run the action to apply updates to the specified site. Xurrent will use the provided Site ID to locate the site and apply any changes specified in the input fields.
Review Update Result
After execution, check the Update Result output to confirm the success of the update. This output will contain details of the changes applied or any system response regarding the update.
Inputs
Site ID: The unique identifier of the site you want to update. This input is required to target the correct site for modifications within Xurrent.
Outputs
Update Result: The response generated by Xurrent after applying the updates to the site, confirming success or providing feedback on the action.
Update Organization
Description and Purpose
The Update Organization action enables users to modify details of an existing organization within Xurrent. This action is crucial for maintaining accurate and up-to-date organization information, allowing users to manage organizational data as changes occur.
Usage Instructions
Specify Organization ID
Organization ID: Enter the unique identifier of the organization you want to update. This ensures that the action targets the correct organization within Xurrent for modifications.
Execute Organization Update
Run the action to apply updates to the specified organization. Xurrent will use the provided Organization ID to locate the organization and apply any changes specified in the input fields.
Review Update Result
After execution, check the Update Result output to confirm the success of the update. This output will provide details about the update process, including confirmation of success or information about any issues encountered.
Inputs
Organization ID: The unique identifier of the organization you wish to update. This input is required to target the correct organization for modifications within Xurrent.
Outputs
Update Result: The response from Xurrent after applying updates to the organization, indicating success or detailing any issues encountered during the update.
Update Configuration Item
Description and Purpose
The Update Configuration Item action allows users to modify details of an existing configuration item within Xurrent. This action is essential for managing and updating configuration item information, ensuring accuracy and relevance of the data within the configuration management system.
Usage Instructions
Specify Configuration Item ID
CI ID: Enter the unique identifier of the configuration item you want to update. This ID ensures that the action targets the correct configuration item within Xurrent for modification.
Execute Configuration Item Update
Run the action to apply updates to the specified configuration item. Xurrent will use the provided CI ID to locate the item and implement the changes specified.
Review Update Response
After execution, check the Xurrent_resp output to confirm the update's success. This output will contain information about the result of the update process, including confirmation or details of any issues encountered.
Inputs
CI ID: The unique identifier of the configuration item to be updated. This input is required to ensure the correct item is accessed and modified within Xurrent.
Outputs
Xurrent_resp: The system response after applying updates to the configuration item, providing confirmation or information about any issues.
Update Person
Description and Purpose
The Update Person action enables users to modify details of an existing person record within Xurrent. This action is essential for managing and updating individual information, ensuring that personal records remain accurate and up to date within the system.
Usage Instructions
Specify Person Identifier
People: Enter the unique identifier of the person you want to update. This ensures that the action targets the correct person record within Xurrent for modification.
Execute Person Update
Run the action to apply updates to the specified person record. Xurrent will use the provided identifier to locate the individual and apply the specified changes.
Review Update Response
After execution, check the Xurrent_resp output to confirm the success of the update. This output will contain information about the result of the update process, including confirmation or details of any issues encountered.
Inputs
People: The unique identifier of the person being updated. This input is required to access and modify the correct person record within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent after attempting the update, providing confirmation of success or details of any issues encountered.
Update Request
Description and Purpose
The Update Request action allows users to modify details of an existing service request within Xurrent. This action is crucial for managing and updating service request information, ensuring that all relevant details are accurate and up to date.
Usage Instructions
Specify Request ID
Request ID: Enter the unique identifier of the service request you want to update. This ID ensures that the action targets the correct request within Xurrent for modification.
Execute Request Update
Run the action to apply updates to the specified service request. Xurrent will use the provided Request ID to locate the request and implement the changes specified.
Review Update Response
After execution, check the Xurrent_resp output to confirm the success of the update. This output will contain information about the result of the update process, including confirmation of the update or details of any issues encountered.
Inputs
Request ID: The unique identifier of the request to be updated. This input is required to ensure that the correct service request is accessed and modified within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent after attempting the update, providing confirmation of success or details of any issues encountered.
Update Service
Description and Purpose
The Update Service action enables users to modify details of an existing service within Xurrent. This action is essential for managing and updating service information, ensuring that all relevant data about the service remains accurate and up to date.
Usage Instructions
Specify Service ID
Services: Enter the unique identifier of the service you wish to update. This ID ensures that the action targets the correct service within Xurrent for modification.
Execute Service Update
Run the action to apply updates to the specified service. Xurrent will use the provided Service ID to locate the service and implement the specified changes.
Review Update Response
After execution, check the Xurrent_resp output to confirm the success of the update. This output will contain information about the result of the update process, including confirmation of the update or details of any issues encountered.
Inputs
Services: The unique identifier of the service to be updated. This input is required to target the correct service within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent following the update, providing confirmation of success or information about any issues.
Update Service Instance
Description and Purpos
The Update Service Instance action allows users to modify details of an existing service instance within Xurrent. This action is critical for managing and updating specific service instance information, ensuring that all relevant details for each instance remain accurate and up to date.
Usage Instructions
Specify Service Instance ID
Service Instances: Enter the unique identifier of the service instance you wish to update. This ID ensures that the action targets the correct service instance within Xurrent for modification.
Execute Service Instance Update
Run the action to apply updates to the specified service instance. Xurrent will use the provided Service Instance ID to locate the instance and implement the specified changes.
Review Update Response
After execution, check the Xurrent_resp output to confirm the success of the update. This output will provide information about the update’s result, including confirmation of the update or details of any issues encountered.
Inputs
Service Instances: The unique identifier of the service instance to be updated. This input is required to ensure the correct service instance is accessed within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent following the update operation, confirming success or providing information about any issues.
Upload Files to Storage
Description and Purpose
The Upload Files to Storage action enables users to upload files or data directly to the storage within Xurrent. This action is valuable for attaching documents or files to specific requests or notes, enhancing the availability of relevant information within the system.
Usage Instructions
Provide File Contents
Attachment Contents: Enter the data or contents of the files you wish to upload. This input should include the file data in a compatible format for Xurrent's storage system.
Execute File Upload
Run the action to upload the provided files to Xurrent's storage. The system will process the files and store them as attachments or documents for later reference.
Review Upload Result
After execution, check the Uploaded Files output to confirm the success of the upload operation. This output provides feedback on the result of the upload, including any information about successfully stored file
Inputs
Attachment Contents: The data or contents of the files to be uploaded. This input is required to specify which files are being stored within Xurrent.
Outputs
Uploaded Files: The result of the upload operation, confirming the successful storage of files or indicating any issues encountered during the process.
View Person
Description and Purpose
The View Person action enables users to retrieve detailed information about an existing individual within the Xurrent system. This action is essential for accessing up-to-date information about individuals, facilitating tasks such as verification, review, or profile management.
Usage Instructions
Specify Person Identifier
People: Enter the unique identifier of the person whose details you want to view. This ensures that the action targets the correct individual within Xurrent.
Execute View Person Action
Run the action to retrieve the information associated with the specified person. The system will process the identifier and return the requested details.
Review Person Details
After execution, check the Xurrent_resp output to view the details of the person. This output includes comprehensive information provided by the system, such as contact information, organizational role, and other relevant data.
Inputs
People: The unique identifier of the person you wish to view. This input is required to retrieve the correct person details within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent containing the requested details of the specified person.
View Request
Description and Purpose
The View Request action allows users to retrieve detailed information about an existing service request within Xurrent. This action is essential for accessing and reviewing specific service request details, which is helpful for monitoring request status, verifying information, or assessing next steps.
Usage Instructions
Specify Request Identifier
Services: Enter the unique identifier of the service request you wish to view. This input ensures that the action targets the correct request within Xurrent.
Execute View Request Action
Run the action to retrieve information associated with the specified service request. The system processes the identifier and returns the requested request details.
Review Request Details
After execution, check the Xurrent_resp output to view the detailed information of the request. This output includes comprehensive information, such as request status, summary, and any associated data.
Inputs
Services: The unique identifier of the service request to be viewed. This input is required to retrieve the correct request details within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent containing the requested details of the specified service request.
View Service
Description and Purpose
The View Service action enables users to retrieve detailed information about an existing service within Xurrent. This action is crucial for accessing and reviewing specific service information, allowing users to verify service details, check availability, and manage service-related tasks effectively.
Usage Instructions
Specify Service Identifier
Services: Enter the unique identifier of the service you wish to view. This input ensures that the action retrieves information for the correct service within Xurrent.
Execute View Service Action
Run the action to retrieve information associated with the specified service. The system will process the identifier and return the requested service details.
Review Service Details
After execution, check the Xurrent_resp output to view detailed information about the service. This output includes relevant service data, such as service description, availability, and any associated parameters.
Inputs
Services: The unique identifier of the service to be viewed. This input is required to ensure accurate retrieval of the specific service details within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent containing the requested details of the specified service.
View Service Instance
Description and Purpose
The View Service Instance action allows users to retrieve detailed information about an existing service instance within Xurrent. This action is essential for accessing specific service instance details, aiding in monitoring, verification, and effective management of individual service instances.
Usage Instructions
Specify Service Instance Identifier
Service Instances: Enter the unique identifier of the service instance you wish to view. This input ensures that the action targets the correct service instance within Xurrent.
Execute View Service Instance Action
Run the action to retrieve information associated with the specified service instance. The system will process the identifier and return the requested instance details.
Review Service Instance Details
After execution, check the Xurrent_resp output to view detailed information about the service instance. This output includes relevant data, such as the instance description, status, and any associated attributes.
Inputs
Service Instances: The unique identifier of the service instance to be viewed. This input is required to ensure accurate retrieval of the specific instance details within Xurrent.
Outputs
Xurrent_resp: The response from Xurrent containing the requested details of the specified service instance.
View Enums
Description and Purpose
The View Enum action in Autom Mate provides a straightforward method for users to view all enumerations defined by the system in Xurrent. Enumerations are fields with a fixed list of selectable values, allowing users to choose one option from predefined options. This action utilizes the Enumerations API to fetch and display these enumerations, simplifying access to available options within the system.
Usage Instructions
Select Credentials During Action Setup
While configuring the action, select the previously defined Xurrent credentials. No additional input values are required for this action, making the setup process simple and efficient.
Select Credentials During Action Setup
While configuring the action, select the previously defined Xurrent credentials. No additional input values are required for this action, making the setup process simple and efficient.
Execute the Action
Once the credentials are selected, execute the View Enum action. The system will retrieve and display all enumerations defined within Xurrent without further configuration.
Inputs
The response from Xurrent, which includes all enumerations available in the system. Users can view each enumeration option provided by Xurrent for easy reference.
View Object with ID
Description and Purpose
This action allows users to configure and interact with objects within an integrated application by selecting credentials and defining object parameters. This setup is essential for users who need to retrieve, display, or manipulate specific data objects within the Autom Mate environment.
Usage Instructions
Define Object
Choose the Object field to specify the desired object.
You have two options to define the object:
Select: Use the drop-down menu to pick an object from a list. Note that objects will be available here only if the necessary connections and permissions are granted within the integrated application (e.g., Xurrent).
Text: Enter the object name manually in the text area, if it isn’t available in the drop-down list.
Enter Object ID
After selecting or entering the object, provide the Object ID that corresponds to the selected object. This is essential for identifying and interacting with the specific data entry.
Configure Display Message (Optional)
Add a Display Message to output and review the selected object’s information.
Paste the output variable into the display message field to view the output data after executing the action.
Inputs
Application Credential: The credential needed to access and interact with the application.
Object: The name or identifier of the object you wish to work with, selectable via a drop-down or text field.
Object ID: A unique identifier associated with the selected object.
Outputs
Output Variable: Displays the data retrieved from the selected object. This allows the user to confirm that the action has successfully retrieved and displayed the expected information.
Add Inline Attachment Comment from Topdesk
Description and Purpose
This action allows users to add a comment with an attached file to a specific request in Topdesk. It is useful for enriching requests with additional documentation, images, or other relevant attachments.
Usage Instructions
Specify the Request ID to identify the Topdesk request where the comment should be added.
Provide the Request Field from Topdesk that will contain the attachment comment.
Attach the file(s) using the Attachment Array Content, ensuring the format is supported.
Inputs
Request ID (Required) – The unique identifier of the request.
Request Field from Topdesk (Required) – The field where the comment and attachment will be added.
Attachment Array Content (Required) – The file(s) to be attached in the request.
Outputs
Confirmation that the comment with the attachment has been successfully added to the specified request.
Create Reservation
Description & Purpose
Creates a new reservation for a specified configuration item in the system. This action is useful for managing asset reservations, scheduling equipment, or tracking resource allocation.
Usage Instructions
Enter the Configuration Item ID to associate the reservation with a specific asset.
Provide the Name of the reservation.
Specify the Person ID of the individual making the reservation.
Set the Status of the reservation (e.g., active, pending, completed).
Define the Start At and End At timestamps for the reservation period.
Inputs
Configuration Item ID (Required) – The asset being reserved.
Name (Required) – The reservation title.
Person ID (Required) – The person associated with the reservation.
Status (Required) – The current status of the reservation.
Start At (Required) – The start time of the reservation.
End At (Required) – The end time of the reservation.
Outputs
Confirmation that the reservation has been successfully created, including the reservation details.
Export Records
Description & Purpose
Exports records from the system into a specified file format (CSV or XLSX). This action is useful for generating reports, archiving data, or integrating records into external systems.
Usage Instructions
Select the Record Type to determine which type of records to export.
Provide a File Name for the exported file.
Choose the Export Format (CSV or XLSX).
Specify the Folder Path where the file should be saved.
Set whether to Overwrite if File Exists (Yes/No).
(Optional) Define a From date to filter records created or updated after this date.
(Optional) Set the Line Separator format (LF or CRLF).
Inputs
Record Type (Required) – Type of records to be exported.
File Name (Required) – Name of the exported file.
Export Format (Required) – Format of the exported file (CSV or XLSX).
Folder Path (Required) – Directory where the file will be stored.
Overwrite if File Exists (Required) – Determines whether to overwrite an existing file (Yes/No).
From (Optional) – Filters records by creation/update date.
Line Separator (Optional) – Defines the line separator format (LF or CRLF).
Get Any Object with ID
Description & Purpose
Retrieves an object based on its unique ID. This action is useful for fetching specific records, configurations, or assets in the system.
Usage Instructions
Select the Object type to specify the category of data being retrieved.
Enter the Object ID to fetch the required object.
Inputs
Object (Required) – The category/type of the object to retrieve.
Object ID (Required) – The unique identifier of the object.
Get Import Status
Description & Purpose
Checks the status of an ongoing import process using a given token. This is useful for monitoring large data imports and ensuring successful completion.
Usage Instructions
Provide the Token associated with the import process.
Get Product with ID
Description & Purpose
Retrieves a product’s details using its unique ID. Useful for viewing product specifications, inventory tracking, or integrating product information into workflows.
Usage Instructions
Specify or select the Product ID from the dropdown (lists up to 100 products).
Outputs
The retrieved product details, including name, description, price, stock level, and other relevant data.
GraphQL Query
Description & Purpose
Executes a GraphQL query on a specified service URL. This action is useful for retrieving structured data efficiently from GraphQL APIs.
Usage Instructions
Provide the GraphQL Service URL where the query will be executed.
Construct the query using GraphQL syntax.
List All Objects Using Filter Without Pagination
Description & Purpose
Retrieves a list of objects based on a specified filter without applying pagination. This is useful for fetching complete datasets without breaking them into multiple pages.
Usage Instructions
Specify the Object List to define the type of objects being retrieved.
Apply any necessary filters to refine the results.
Update Product
Description & Purpose
Updates the details of an existing product based on its unique ID. This is useful for modifying product attributes such as price, stock, and description.
Usage Instructions
Enter the Product ID of the product to be updated.
Specify the fields that need to be modified.
Update Reservation
Description & Purpose
Modifies an existing reservation based on its ID. This is useful for updating reservation details such as time, status, or assigned person.
Usage Instructions
Enter the Reservation ID of the reservation to be updated.
Provide the updated details, such as new start/end time or status changes.
Upload File to Storage Attachment
Description & Purpose
Uploads a file to storage using a file path. This action is useful for storing attachments or documents in a structured location.
Usage Instructions
Provide the File Path of the file to be uploaded.
Upload Files to Storage with Base64
Description & Purpose
Uploads one or multiple files to storage using a Base64-encoded format. This is useful for handling file uploads when working with APIs that require Base64 encoding.
Usage Instructions
Provide the Attachments Array containing the Base64-encoded files.
Outputs
Confirmation that the files have been uploaded successfully, including metadata such as file name and storage location.
Additional Tips
Last updated
Was this helpful?