The Itential TMF641 Service Ordering Management adapter is a pre-built integration that connects the Itential Automation Platform (IAP) with the TMF641 Service Ordering Management system. It enables organizations to automate and orchestrate service order operations by leveraging the TMF641 API within their network and IT workflows. [Source]
With this adapter, you can perform service order operations as defined by the TMF641 Service Ordering Management API. This includes creating, updating, and managing service orders programmatically through the Itential Automation Platform. [Source]
This adapter is categorized under Data Center and Network Services, making it suitable for automating service order management in these environments. [Source]
The adapter integrates with the TMF641 Service Ordering Management system using REST APIs, ensuring modern, standards-based connectivity. [Source]
The open-source repository for the TMF641 Service Ordering Management adapter is available on GitLab: View Repository.
The vendor for this adapter is TM Forum, which provides the TMF641 Service Ordering Management API specification. [Source]
This integration is classified as an Adapter, designed to connect the Itential Platform with external systems via standardized APIs. [Source]
The official TMF641 Service Ordering Management API User Guide is available from TM Forum at this link.
Technical documentation for the TMF641 Service Ordering Management adapter is available on GitLab: Documentation. Additional troubleshooting guides are available at docs.itential.com.
The ReadMe file provides essential information on installing, configuring, and using the TMF641 Service Ordering Management adapter. It is generated from various Markdown files to ensure comprehensive coverage. [Source]
The Swagger (OpenAPI) specification for the TMF641 Service Ordering Management adapter is available at this link.
Contributions are welcome via the Contributing Guide available at this link. Please follow the guidelines for submitting updates or improvements.
Troubleshooting steps include verifying credentials, enabling debug and authentication logging in Itential Platform Admin Essentials, and reviewing request/response logs. For detailed troubleshooting, refer to the official troubleshooting guide.
Dynamic Token Authentication is a method where the adapter requests a token using a username and password, then uses that token for API requests. The TMF641 Service Ordering Management adapter requires this authentication method for secure integration. [Source]
Sample properties include host, port, protocol, base_path, version, and authentication details such as username, password, and token settings. These must be customized for your environment. See the documentation for a full sample properties JSON. [Source]
Authentication is performed using Dynamic Token Authentication. You must provide a username and password, and the adapter will request a token to use in API calls. Detailed steps are available in the documentation. [Source]
If the adapter fails to go online, verify your authentication properties, check for typos in credentials, enable debug and auth_logging, and review logs for errors. Credentials should be masked for security. [Source]
The adapter is designed to mask credentials in logs. Always verify that sensitive information is not exposed, and turn off auth_logging after troubleshooting. [Source]
Enable debug level logs and auth_logging in the Itential Platform Admin Essentials for detailed troubleshooting. Remember to disable auth_logging after resolving issues to avoid logging sensitive data. [Source]
After updating the adapter properties (such as authentication or connectivity settings), restart the adapter to apply changes. If configured correctly, the adapter should go online. [Source]
Frequently asked questions about adapters are available at docs.itential.com under the FAQ section.
The default base path for the TMF641 Service Ordering Management API is /tmf-api/serviceOrdering. This can be customized in the adapter properties as needed. [Source]
The adapter supports version v4 of the TMF641 Service Ordering Management API, as specified in the sample properties. [Source]
To configure a secure connection, set the protocol to https and provide any necessary SSL certificate details in the adapter properties. Refer to the documentation for SSL configuration options. [Source]
Yes, the adapter uses RESTful APIs to integrate with the TMF641 Service Ordering Management system, enabling modern, standards-based automation. [Source]
Yes, you can automate service order tasks such as creating, updating, and managing service orders within the Itential Automation Platform using this adapter. [Source]
The adapter is designed to work with version v4 of the TMF641 Service Ordering Management API. For updates, refer to the repository and documentation. [Source]
Yes, you can customize properties such as host, port, protocol, authentication, and more to match your environment's requirements. [Source]
The adapter includes configuration options for health checks, such as frequency and query objects, to monitor adapter status. [Source]
Logs include full request, body, and call return logs, which help diagnose issues with authentication, payloads, and API responses. [Source]
If your company changes authentication methods, update the authentication section in the adapter properties and contribute changes back to the adapter repository to keep documentation current. [Source]
Yes, the adapter properties include configuration options for proxy servers, including host, port, protocol, username, and password. [Source]
Comprehensive documentation is available, including installation guides, API references, and troubleshooting resources. Access the documentation at docs.itential.com and the adapter's GitLab repository. [Source]
Sample configuration files are provided in the documentation and the adapter's repository. These samples help you set up the adapter for your environment. [Source]
The adapter's API documentation, including the OpenAPI (Swagger) specification, is available in the repository at this link.
The contributing guide is available at this link, providing instructions for contributing to the adapter project.
Related content and demos, such as the Dynamic Edge Enabled Application Automation (TMF), are available at this link.
Itential's pricing model is based on software licenses (including the platform, adapters, and applications) and device/node element licenses. There are no charges for users, transactions, workflows, or API calls. For details, visit the Itential pricing page.
There are no additional charges for users, transactions, workflows, or API calls. Pricing is based on the number of devices or node elements managed. For a tailored quote, contact Itential or visit the pricing page.
The adapter supports secure authentication (Dynamic Token Authentication), SSL/TLS for encrypted connections, and credential masking in logs. These features help ensure secure integration with TMF641 systems. [Source]
Yes, the Itential Platform is SOC 2 Type 2 compliant, ensuring high standards for security, availability, confidentiality, and processing integrity. [Source]
Yes, Itential adheres to GDPR and CCPA, ensuring compliance with global data privacy regulations. [Source]
Network engineers, IT managers, and DevOps teams in data center and network services environments can benefit from automating service order management using this adapter. [Source]
The main benefits include streamlined service order automation, reduced manual effort, improved accuracy, and seamless integration with the Itential Automation Platform for end-to-end orchestration. [Source]
The adapter supports compliance and governance by enabling automated, auditable service order workflows and integrating with the Itential Platform's compliance-native features. [Source]
Yes, the Itential Platform and its adapters are designed for hybrid and multi-cloud environments, enabling automation across diverse infrastructure. [Source]
TMF641 Service Ordering Management
Data Center
Network Services
Adapter
This adapter is used to integrate the Itential Platform with the tmf641_service_ordering_management System. The API that was used to build the adapter for tmf641_service_ordering_management is usually available in the report directory of this adapter. The adapter utilizes the tmf641_service_ordering_management API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
The TMF641 Service Ordering Management adapter from Itential is used to integrate the Itential Platform with TMF641 Service Ordering Management.
With this adapter you have the ability to perform operations with TMF641 Service Ordering Management such as:
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
This document will go through the steps for authenticating the TMF641 Service Ordering Management adapter with Dynamic Token Authentication. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication HERE.
Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
The TMF641 Service Ordering Management adapter requires Dynamic Token Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
STEPS
Ensure you have access to a TMF641 Service Ordering Management server and that it is running
Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
Use the properties below for the properties.authentication field
"authentication": {
"auth_method": "request_token",
"username": "<username>",
"password": "<password>",
"token_timeout": 1800000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.Authorization",
"auth_field_format": "Bearer {token}",
"auth_logging": false
}you can leave all of the other properties in the authentication section, they will not be used for dynamic token authentication.
Restart the adapter. If your properties were set correctly, the adapter should go online.
Sample Properties can be used to help you configure the adapter in the Itential Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
"properties": {
"host": "localhost",
"port": 443,
"choosepath": "",
"base_path": "/tmf-api/serviceOrdering",
"version": "v4",
"cache_location": "none",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": true,
"protocol": "https",
"authentication": {
"auth_method": "request_token",
"username": "username",
"password": "password",
"token": "token",
"token_timeout": 600000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.Authorization",
"auth_field_format": "Bearer {token}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"auth_request_datatype": "",
"auth_response_datatype": "",
"token_response_placement": "",
"sensitive": [],
"sso": {
"protocol": "",
"host": "",
"port": 0
},
"multiStepAuthCalls": [
{
"name": "",
"requestFields": {},
"responseFields": {},
"successfullResponseCode": 200
}
]
},
"healthcheck": {
"type": "none",
"frequency": 60000,
"query_object": {},
"addlHeaders": {}
},
"throttle": {
"throttle_enabled": false,
"number_pronghorns": 1,
"sync_async": "sync",
"max_in_queue": 1000,
"concurrent_max": 1,
"expire_timeout": 0,
"avg_runtime": 200,
"priorities": [
{
"value": 0,
"percent": 100
}
]
},
"request": {
"number_redirects": 0,
"number_retries": 3,
"limit_retry_error": [
0
],
"failover_codes": [],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": true,
"return_raw": false,
"archiving": false,
"return_request": false,
"keep_alive_interval": 0
},
"proxy": {
"enabled": false,
"host": "",
"port": 1,
"protocol": "http",
"username": "",
"password": ""
},
"ssl": {
"ecdhCurve": "",
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"ca_file_content": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"url": "",
"host": "",
"port": 0,
"database": "",
"dbAuth": false,
"username": "",
"password": "",
"replSet": "",
"addSrv": false,
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"enabled": false,
"getDevice": [
{
"path": "/not/mapped",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"insample": "{port}"
},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}"
}
}
],
"getDevicesFiltered": [
{
"path": "/not/mapped",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}",
"id": "{myid}"
}
}
],
"isAlive": [
{
"path": "/not/mapped/{devID}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"devID": "{id}"
},
"responseDatakey": "",
"responseFields": {
"status": "return2xx",
"statusValue": "AD.200"
}
}
],
"getConfig": [
{
"path": "/not/mapped/{devID}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"devID": "{id}"
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/not/mapped",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "device",
"frequency": 3600,
"flushOnFail": false,
"limit": 10000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "/not/mapped",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}",
"id": "{myid}"
}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}