[en] Want to build your own Acrolinx custom integration? Here's what the process entails:
 |
[en] The process from kickoff to API compatibility certification.
[en] To learn more about each of the steps in the diagram above, read on:
[en] Here are some good questions to think about:
-
[en] What kind of integration do you want to develop?
[en] Acrolinx Integration into your editing tool to help your writers
[en] Automated check analyzes all the content in your CMS (content management system) and provides Scorecards for each document
[en] Both
-
[en] What kind of application do you want to use with Acrolinx?
-
[en] Authoring tool
[en] Is your tool a desktop or web application?
[en] Are the APIs sufficient for integrating Acrolinx?
[en] If web application, do you use a rich text editor (RTE) like TinyMCE, CKEditor, CodeMirror, or a customer-built editor?
-
[en] Server-based application
[en] Is it a CMS?
[en] Is it web based?
[en] What language is it in: Java, .NET, JavaScript, other?
[en] Is it a proprietary CMS or a known CMS vendor like Ixiasoft, Astoria, SDL?
[en] Is it hosted in the public cloud, private cloud, or on-premise behind the firewall?
[en] Can you use the APIs to integrate Acrolinx?
-
-
[en] What's the native file format of the content that you want Acrolinx to analyze?
[en] See the supported input types.
[en] Acrolinx supports some file types natively.
[en] If a file type isn't supported natively, it's transformed to a native format that Acrolinx supports
[en] If Acrolinx doesn't support your file type, you can also transform it as part of your custom integration
-
[en] Who are the target users of the Acrolinx Integration?
[en] Writers - guidance in authoring tools
[en] Managers - governance in Analytics dashboards
[en] Project managers - governance or quality gate for a workflow, for example, readiness of content for publishing or translation
-
[en] How would you like users to sign in?
[en] Acrolinx sign-in - Users need to sign in before they can use the Sidebar or any integration
[en] Single sign-on (SSO) - Users or API integrations are signed in automatically without having to enter their sign-in details. Learn how to set up Acrolinx for single sign-on.
[en] Use SAML and PingFederate to Authenticate Users - Connect Acrolinx to your identity provider so you don't have to manage users and passwords in Acrolinx
[en] Use an API token for authentication - Create an API token to authenticate your automated check integration instead of using a username and password
-
[en] How will Acrolinx run?
Anmerkung
[en] This only applies to integrations that offer an automated check option.
[en] Regularly by interval
[en] Workflow step starts automated check
[en] Initiated manually by a person
[en] Acrolinx carefully chooses which integrations to own and build. It's a big engineering investment to learn an entirely new application.
[en] Sometimes it makes more sense to partner with experts who have all the domain knowledge. That's why Acrolinx also has an ecosystem of partners that help us address a wider range of needs. Learn more about becoming an Acrolinx partner.
[en] As part of the developer program, we schedule a project kickoff with you and your developers to answer questions upfront. We'll explain the basics of Acrolinx and:
[en] Where and how do you want to embed Acrolinx?
[en] Agree on scope and timeline
[en] Make sure that the developer can get started
[en] Sign SDK usage contract
Hinweis
[en] Acrolinx doesn’t do a comprehensive certification of all functionality of the integration. The developer is responsible for the feature scope and testing.
[en] Developer integrates Acrolinx, makes sure it's working, and makes sure the integration is API compatible before release.
[en] Develop
[en] Start with a PoC (proof of concept)
[en] Use SDKs in GitHub
[en] Follow best practices in the developer documentation
[en] Review the checklist in the Acrolinx coding guidance before requesting API compatibility certification
[en] Use the debug button in the Sidebar to review the integration properties and document check request
[en] Test
[en] Complete standard test cases and uses the Request Validator for feedback.
[en] Developer is responsible for complete testing
[en] Certify
[en] Developer demonstrates the integration with the latest version of the Acrolinx Platform
[en] Developer shows that the integration meets the minimum requirements
[en] Acrolinx reviews document structure and other configurations
-
[en] Acrolinx makes sure that you can use the integration
[en] Basic authoring
[en] Content reference in Analytics
[en] Acrolinx verifies that the integration follows the license model
[en] Acrolinx gives the developer a permanent signature for the integration so writers can use it