Last modified by Erik Bakker on 2024/09/02 16:11
From version 27.2
edited by Erik Bakker
on 2024/02/01 08:47
Change comment: Update document after refactoring.
To version 48.1
edited by Erik Bakker
on 2024/02/01 16:32
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -fundamental-emagiz-docs-introduction
1 +Documentation Portal Introduced
Content
... ... @@ -1,78 +1,79 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will introduce the eMagiz platform. The focus will be to address the fundamental concepts of the platform. Please refer to other Fundamentals to learn more about related items and look at the relevant microlearnings available to learn how to work in eMagiz.
2 +In this microlearning, we will introduce the eMagiz documentation platform. The focus will be to address the fundamental concepts of the documentation platform. Please refer to other Fundamentals to learn more about related items and look at the relevant microlearnings available to learn how to work in eMagiz.
3 3  
4 4  Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
6 6  == 1. Prerequisites ==
7 -* Some context on integration platforms will be helpful.
7 +* An interest in learning more about the eMagiz platform.
8 8  
9 9  == 2. Key concepts ==
10 10  All concepts are discussed in the section below.
11 11  
12 -== 3. Introducing eMagiz ==
12 +== 3. Introducing the eMagiz documentation platform ==
13 13  
14 -eMagiz is an integration platform as a service (iPaaS) designed to streamline and enhance enterprise integration processes. It provides a comprehensive set of tools and features to connect various applications, systems, and data sources within an organization. The platform facilitates seamless communication and data exchange, enabling businesses to optimize workflows, improve efficiency, and adapt to evolving technological landscapes.
14 +The eMagiz documentation platform is an add-on to the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]. Within the documentation portal, we have four distinct categories of information for you to utilize. Should this be your first visit to the eMagiz documentation portal, we urge you to check out the tour. You can start this tour from the home page by clicking the "Show tour" icon in the bottom right-hand corner of your screen.
15 15  
16 -=== 3.1 What does eMagiz offer ===
16 +=== 3.1 Academy ===
17 17  
18 -==== 3.1.1 Integration Capabilities ====
19 -eMagiz bridges disparate systems, applications, and databases, allowing for smooth data transfer and communication. It supports cloud-based and on-premises integrations, ensuring flexibility in connecting diverse environments.
18 +In this segment, you can learn about the platform. To make your learning experience manageable, we have divided this segment into three categories. It starts with the [[Fundamental>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]] section that explains the eMagiz platform, the documentation portal, and the key features of the eMagiz platform for you to utilize.
20 20  
21 -==== 3.1.2 Scalability and Flexibility ====
22 -The platform is designed to scale alongside the growing needs of an enterprise. It accommodates a variety of integration scenarios, from simple point-to-point connections to complex, multi-system interactions.
20 +On top of that, we have the [[Microlearnings>>doc:Main.eMagiz Academy.Microlearnings.WebHome||target="blank"]] section that explains all components of the platform from a user perspective (i.e., what do I need to do to act eMagiz) in bite-size pieces. In this section, we divide the knowledge into various levels from Platform & Pattern [[Crash Courses>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] to courses per level of experience in the platform (i.e. [[Novice Level - eMagiz>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]) so you can learn to use the platform in a structured way.
23 23  
24 -==== 3.1.3 Store Library ====
25 -eMagiz offers a wide array of pre-built connectors for popular applications, databases, and services. These connectors simplify the integration process, reducing development time and effort. Additionally, it allows for easy customization to meet specific business requirements.
22 +Apart from the learnings in this section, it also details our [[certification program>>doc:Main.eMagiz Academy.Get Certified.WebHome||target="blank"]], including requirements and how to sign up for a certification.
26 26  
27 -==== 3.1.4 Real-time Monitoring and Analytics ====
28 -The platform provides real-time monitoring tools, allowing enterprises to track the performance of their integrations. Detailed analytics and reporting features enable users to gain insights into system behavior, troubleshoot issues, and optimize processes.
24 +=== 3.2 Store ===
29 29  
30 -==== 3.1.5 Best of suite ====
31 -eMagiz leverages three patterns that can be used in unison through a uniform and standardized method. Firstly, it provides an event-driven architecture, enabling organizations to respond rapidly to changes in data or system states. This approach enhances agility and supports the development of responsive, real-time applications. Secondly, the platform provides tools for managing APIs, allowing enterprises to expose and consume APIs securely. This helps the creation of API ecosystems within and outside the organization. Thirdly, it provides the standard functionality of a messaging platform for the seamless exchange of real-time data and events across applications, systems, and services, facilitating efficient communication and coordination to enhance enterprise integration processes.
26 +This segment documents all store components managed by eMagiz. We have divided these store items into two categories called [[accelerators>>doc:Main.eMagiz Store.Accelerators.WebHome||target="blank"]] and [[system connectors>>doc:Main.eMagiz Store.System Connectors.WebHome||target="blank"]]. Here, you can browse through (and search for) specific store solutions that you can use within your model. If you want more information on the store, please check out this [[fundamental>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-store.WebHome||target="blank"]].
32 32  
33 -==== 3.1.6 Security and Compliance ====
34 -Security is a top priority for eMagiz. The platform includes robust security measures, such as encryption and authentication protocols, to safeguard data during transit and at rest. It also assists enterprises in meeting compliance requirements by providing features for auditing and governance.
28 +=== 3.3 Support ===
35 35  
36 -==== 3.1.7 Collaboration Tools ====
37 -eMagiz offers collaborative features that enable development teams to work together seamlessly. Version control, role-based access, and collaborative workflows enhance integration development and maintenance efficiency.
30 +This segment houses information that supports you in case you need to migrate via the help of our [[migration paths>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]] and in case you are facing a problem in one of your environments, via the help of our [[RCA knowledge base>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]. On top of that, we provide an easy link to our support portal when you need to register a ticket with our support department. If you are still determining whether you need to register our ticket or communicate another way, please check out this [[fundamental>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-assistance-needed.WebHome||target="blank"]].
38 38  
39 -=== 3.2 What can eMagiz do for you ===
32 +=== 3.4 Release Information ===
40 40  
41 -==== 3.1.1 Streamlined Business Processes ====
42 -eMagiz enables enterprises to streamline business processes by connecting various systems and automating data flows. This results in improved operational efficiency and reduced manual intervention.
34 +This segment houses all our release information on the platform. Here, you can find the technical [[release notes>>doc:Main.Release Information.Portal.WebHome||target="blank"]] of the eMagiz platform, our [[infrastructure>>doc:Main.Release Information.Runtime Images.WebHome||target="blank"]], and our [[cloud>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]] as well as more functional release blogs on the [[platform>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]] and the [[documentation portal>>doc:Main.Release Information.Documentation Portal.WebHome||target="blank"]]. This category intends to inform our users of what changes in every release so they can adapt.
43 43  
44 -==== 3.1.2 Accelerated Time-to-Market ====
45 -With a library of pre-built connectors and a visual development environment, eMagiz accelerates the integration development process. This allows enterprises to bring new products and services to market faster.
36 +=== 3.4 Navigation ===
46 46  
47 -==== 3.1.3 Enhanced Data Accuracy ====
48 -By ensuring consistent and timely data exchange between systems, eMagiz contributes to improved data accuracy. This is critical for decision-making processes and maintaining a single source of truth across the organization.
38 +There are three ways to find your way around the documentation portal. For each example we are going to navigate to the list of release notes that are published bi-weekly. The first one is by clicking through the various cards to get to the right information as shown below.
49 49  
50 -==== 3.1.4 Adaptability to Change ====
51 -eMagiz's event-driven architecture and flexibility in integration scenarios enable enterprises to adapt quickly to changes in business requirements or technology landscapes. This agility is crucial in today's rapidly evolving business environment.
40 +{{video attachment="left-panel-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
52 52  
53 -==== 3.1.5 Improved Collaboration ====
54 -The collaboration tools provided by eMagiz facilitate better communication and coordination among development teams. This mainly benefits large enterprises with distributed teams working on integration projects.
42 +Secondly you could use the breadcrumb navigation on the top of the page to get to the same location as is shown below.
55 55  
56 -==== 3.1.6 Enhanced Visibility and Control ====
57 -Real-time monitoring and analytics features empower enterprises to have better visibility into their integration landscape. This leads to proactive issue resolution, improved system performance, and better decision-making.
44 +{{video attachment="breadcrumb-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
58 58  
59 -==== 3.1.7 Compliance and Security ====
60 -eMagiz's robust security measures and compliance features help enterprises meet regulatory requirements. This is essential in industries where data privacy and security are paramount concerns.
46 +Thirdly you could use the navigation on the left of the page to get to the desired location.
61 61  
62 -==== 3.1.8 Cost Efficiency ====
63 -The platform's ability to streamline integration processes, reduce development time, and minimize manual efforts contributes to enterprise cost efficiency. It optimizes resource utilization and lowers the total cost of ownership.
48 +{{video attachment="card-navigation-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
64 64  
65 -In conclusion, eMagiz is a versatile and powerful integration platform that empowers enterprises to overcome the challenges of connecting diverse systems and applications. Its comprehensive feature set, collaboration tools, and focus on security make it a valuable asset for organizations aiming to enhance their integration capabilities, drive efficiency, and stay competitive in a dynamic business landscape.
50 +=== 3.5 Search ===
66 66  
52 +In case you are new or unsure how to navigate, as you don't know exactly where to look you can use the search functionality in the documentation portal to search for keyphrases. You can access the search functionality on the top-left hand corner of your page by typing in a keyphrase and pressing Enter. This will lead you to the overview of your search results. Once you have found the information in question you can click on the result to navigate to the page.
53 +
54 +{{video attachment="search-functionality-doc-portal.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
55 +
56 +{{info}}
57 +* The search searches through all information available on the documentation portal.
58 +* Once you are in the search overview you can drill down to specific parts of the documentation portal (as demonstrated in the video)
59 +* Searching for partial words will not result in any hits.
60 +* In the above video I could also have clicked directly on the link to "New Equilibrium"{{/info}}
61 +
67 67  == 4. Key takeaways ==
68 68  
69 -* eMagiz is an integration platform as a service (iPaaS) designed to streamline and enhance enterprise integration processes.
70 -* eMagiz's comprehensive feature set, collaboration tools, and focus on security make it a valuable asset for organizations.
71 -* eMagiz provides a wide array of pre-built components and connectors that accelerate the development of integrations.
72 -* eMagiz leverages a visual development environment that follows a similar workflow regardless of the chosen integration pattern, focusing on clarity, consistency, and reliability.
64 +* The eMagiz documentation platform is an add-on to the [[eMagiz platform>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-introduction.WebHome||target="blank"]]
65 +* It consists of four main categories of information
66 +** Academy
67 +** Store
68 +** Support
69 +** Release Information
70 +* You can follow a tour to understand better how to navigate the eMagiz documentation portal.
73 73  
74 74  == 5. Suggested Additional Readings ==
75 75  
76 -* [[eMagiz website>>https://emagiz.com/en/||target="blank"]]
74 +* [[Academy>>doc:Main.eMagiz Academy.WebHome||target="blank"]]
75 +* [[Store>>doc:Main.eMagiz Store.WebHome||target="blank"]]
76 +* [[Support>>doc:Main.eMagiz Support.WebHome||target="blank"]]
77 +* [[Release Information>>doc:Main.Release Information.WebHome||target="blank"]]
77 77  
78 78  )))((({{toc/}}))){{/container}}{{/container}}