Bagikan melalui

Buat Bantuan Berpanduan untuk aplikasi Antarmuka Terpadu Anda

  • Artikel

Gunakan panel bantuan kustom dan tugas terpandu untuk memberikan aplikasi Antarmuka Terpadu pengalaman dalam produk kustom yang disesuaikan dengan organisasi anda. Gunakan panel bantuan kustom untuk menyediakan bantuan dan panduan tabel, formulir, dan khusus bahasa yang mencakup teks kaya, tautan konten, Gambar, dan tautan video.

Penting

  • Panel bantuan kustom menggantikan fitur bantuan berpanduan jalur pembelajaran sebelumnya yang digunakan dengan aplikasi klien web lama.
  • Panel bantuan kustom tidak berfungsi dengan aplikasi Antarmuka Terpadu yang berjalan di perangkat seluler, seperti Android tablet dan iOS ponsel cerdas.

Panel bantuan kustom dan jalur pembelajaran

Penerapan panel bantuan kustom baru terpandu berbeda dari fitur bantuan terpandu jalur pembelajaran sebelumnya. Kedua fitur memungkinkan Anda membuat bantuan kustom untuk aplikasi Anda. Namun, panel bantuan kustom dioptimalkan untuk skenario bantuan terpandu yang paling umum.

Panel bantuan kustom menyediakan fitur kunci berikut yang tidak tersedia dengan jalur pembelajaran:

  • Teks kaya formulir bebas, termasuk butir dan penomoran.
  • Tanda pelatih yang bertautan jelas dan balon bantuan.
  • Pilihan lainnya untuk sumber video, termasuk sumber pribadi.
  • Penyimpanan konten bantuan di Microsoft Dataverse sebagai bagian dari solusi Anda.

Panel bantuan kustom tidak menyediakan fitur kunci berikut yang tersedia dengan jalur pembelajaran:

  • Balon bantuan berurutan.
  • Halaman Bantuan per peran.
  • Halaman bantuan untuk bentuk dan ukuran per perangkat, seperti smartphone.

Prasyarat

Untuk menggunakan fitur panel bantuan kustom, lingkungan Anda memerlukan yang berikut:

Aktifkan panel bantuan kustom untuk lingkungan Anda

  1. Buka aplikasi berdasarkan model, lalu pada bilah perintah, pilih Pengaturan Pengaturan. > Pengaturan Lanjutan.

  2. Buka Pengaturan > Sistem > Administrasi.

  3. Di halaman Administrasi, pilih Pengaturan Sistem.

  4. Pada tab umum, di dalam Atur URL bantuan kustom, pilih ya untuk mengaktifkan panel bantuan kustom dan tugas terpandu, lalu pilih OK.

    Aktifkan panel bantuan kustom.

Penting

  • Anda dapat mengaktifkan panel bantuan kustom atau Bantuan disesuaikan, tetapi tidak keduanya pada saat yang sama. Konfirmasikan bahwa Gunakan bantuan kustom untuk tabel yang apar disesuaikan dan Lampirkan parameter ke URL diatur ke Tidak.
  • Beberapa lingkungan mungkin mengharuskan Anda juga mengatur Aktifkan jalur pembelajaran ke ya.

Hak Istimewa yang diperlukan

  • Untuk menulis panel bantuan, pembuat aplikasi memerlukan hak istimewa global buat, baca, tulis, hapus, lampirkan, dan lampirkan kepada tabel Halaman Bantuan. Secara default, peran keamanan Penyesuai Sistem dan Administrator sistem sama-sama memiliki hak istimewa ini.
  • Untuk melihat panel bantuan dalam aplikasi, pengguna memerlukan hak baca istimewa pada tabel Halaman Bantuan. Secara default, peran keamanan Konsumen Halaman Bantuan memiliki hak istimewa. Secara default, peran keamanan pengguna Dasar tidak memiliki hak istimewa pada tabel Halaman Bantuan.

Informasi lebih lanjut: peran keamanan dan hak istimewa

Bantuan kustom yang peka terhadap konteks

Setiap panel bantuan unik untuk konteks ini:

  • Aplikasi
  • Tabel
  • Formulir
  • Bahasa

Navigasi Panel Bantuan

Secara default, panel bantuan tetap terbuka dan pada konten bantuan yang pertama kali Anda buka bahkan saat Anda menavigasi ke formulir lain. Hal ini memungkinkan untuk konten bantuan tetap utuh saat Anda mengarahkan pengguna ke berbagai bagian aplikasi.

Untuk menulis konten panel bantuan

  1. Untuk melihat panel bantuan, buka aplikasi berdasarkan model, lalu pada bilah perintah, pilih bantuan.

    bantuan.

  2. Pada panel bantuan, pilih elipsis vertikal, lalu pilih Edit.

    Edit bantuan.

    Panel bantuan sekarang berada di mode edit dan kursor diposisikan pada judul panel bantuan.

  3. Dari panel edit, Anda dapat melakukan tugas berikut:

    • Memasukkan teks dengan mengetik langsung di area panel bantuan.
    • Format teks melalui kemampuan teks kaya dan menambahkan daftar bernomor, bagian, video, gambar, tautan, tanda pelatih, dan bantuan balon.

  4. Pilih Simpan untuk menyimpan perubahan.

Teks bentuk bebas

Teks dapat ditempatkan di mana pun di panel bantuan. Masukkan teks bentuk bebas sebelum, di, atau setelah bagian. Teks mendukung format font Bold, Italic, underline, dan strikeout. Cut, copy, dan paste dapat digunakan juga serta mengurungkan multilevel.

Butir dan daftar bernomor

Memilih ikon butir atau nomor akan mengalihkan baris saat ini menjadi berbutir atau bernomor. Jika Anda telah memilih beberapa baris dalam daftar, setiap baris menjadi berbutir atau bernomor. Membuat tab dan inden subnomor sejajar dalam daftar.

Bagian

Bagian adalah kotak teks yang dapat diciutkan. Anda dapat memasukkan tautan atau teks bentuk bebas di dalamnya. Gunakan bagian untuk mengelompokkan item serupa. Bagian dapat berupa terbuka atau tertutup secara default.

Gambar statis dan video

Anda dapat memasukkan video dan gambar statis ke panel bantuan. Video dan gambar adalah tautan ke konten di internet. Panel bantuan kustom tidak menyimpan file video dan gambar di panel bantuan. Bila panel bantuan dibuka, panel bantuan kustom akan menampilkan konten dari tautan untuk menampilkannya. Anda dapat menggunakan tautan ke video Microsoft Stream jika Anda ingin mereferensi konten pribadi perusahaan.

Tip

Ingatlah untuk menyalin URL tautan untuk video atau gambar yang Anda inginkan sehingga Anda dapat merekatkannya ke panel bantuan.

Panel bantuan kustom mendukung sumber video berikut:

  • Microsoft Stream (Klasik) (digunakan untuk konten pribadi)
  • YouTube
  • Facebook
  • Vimeo

Tautan dapat berupa ke situs web dan terbuka di jendela yang sama (default) atau terbuka di jendela terpisah. Kemampuan untuk menautkan ke halaman bantuan yang ada belum diaktifkan.

Balon dan tanda pelatih

Balon dan tanda pelatih dapat digunakan untuk menunjuk elemen UI tertentu. Balon dapat memiliki teks di dalamnya.

Sisipkan balon

Tanda pelatih hanya menyorot elemen dengan penunjuk pelatih untuk menarik perhatian pengguna ke elemen UI tersebut.

Sisipkan Tanda Pelatih

Penulis harus menentukan target melalui kemampuan tarik dan lepaskan di properti balon dan tanda pelatih. Penulis dapat memasukkan teks untuk judul dan deskripsi untuk tanda pelatih.

Tarik dan lepas

Catatan

  • Balon dan tanda pelatih tidak berfungsi dengan baik dengan komponen kustom. Fitur ini hanya berlaku untuk komponen UI Antarmuka Terpadu default.
  • Balon bantuan berurutan dan tanda pelatih belum didukung.

Solusi dan konten panel bantuan kustom

Semua konten bantuan disimpan di komponen halaman bantuan di Dataverse sebagai bagian dari solusi Anda. Bila Anda memindahkan solusi dari satu lingkungan ke lingkungan lain, misalnya dari pengujian hingga produksi, Anda dapat menentukan bahwa baris bantuan diekspor sehingga disertakan dalam solusi. Dengan demikian, Anda dapat tetap mensinkronisasi konten bantuan dengan fitur dalam solusi saat bergerak ke lingkungan yang berbeda. Sebagai bagian dari solusi Anda, panel bantuan kustom mendukung semua fitur aplikasi manajemen siklus hidup (ALM) solusi standar.

Memindahkan konten melalui solusi

Secara default, semua halaman bantuan baru akan muncul dalam solusi default. Jika Anda ingin memindahkan konten ke lingkungan lain, terlebih dahulu Tambahkan halaman bantuan yang ada ke solusi yang tidak terkelola sebelum Anda mengekspornya. Untuk menambahkan halaman bantuan ke solusi yang tidak terkelola, ikuti langkah berikut:

  1. Masuk ke Power Apps.
  2. Di panel navigasi kiri, pilih Solusi. Jika item tidak ada di panel pada panel sisi, pilih …Lainnya, lalu pilih item yang diinginkan.
  3. Buka solusi tidak terkelola yang diinginkan.
  4. Pilih tambah yang ada pada bilah perintah, lalu pilih halaman bantuan.
  5. Pilih halaman bantuan yang ingin ditambahkan, lalu pilih Tambahkan. Informasi selengkapnya: Ekspor solusi

Otomatisasi dokumentasi halaman bantuan

Anda mungkin ingin mencadangkan atau menyimpan konten dalam sistem kontrol kode sumber. Anda juga mungkin ingin menggunakan alat otomatisasi dokumentasi, seperti alat terjemahan atau Checker, di konten panel bantuan. Data panel bantuan kustom disimpan langsung di Dataverse dan dapat diekspor serta diimpor untuk tujuan ini.

Panel bantuan kustom mendukung format XML kustom. Format ini didokumentasikan di bawah ini. Informasi lebih lanjut: definisi XML bantuan kustom

Saat diekspor, setiap halaman bantuan diekspor sebagai file terpisah.

Tentang solusi terkelola bantuan kontekstual

Panel bantuan kustom dan fitur tugas terpandu terdiri dari komponen solusi dalam fungsi solusi terkelola Bantuan Kontekstual. Menyesuaikan atau membuat rekaman menggunakan tabel di luar panel bantuan kustom dan fitur tugas terpandu tidak didukung.

Perhatikan bahwa beberapa aplikasi, seperti Dynamics 365 Sales, dan Dynamics 365 Service, mencakup pengalaman menjalankan pertama yang dibangun menggunakan tabel yang tercakup dalam bantuan Kontekstual solusi terkelola. Contohnya, tabel Halaman Bantuan (msdyn_helppage) dan Tur (msdyn_tour) digunakan dalam pembuatan pengalaman jalankan pertama ini. Saat ini, panel bantuan kustom dan fitur tugas terpandu tidak mendukung pembuatan pengalaman menjalankan pertama ini.

Tanya jawab

Bagian ini membahas tanya jawab tentang halaman bantuan kustom.

Apakah Halaman Bantuan kustom sama dengan bantuan disesuaikan?

Panel bantuan kustom dan tugas terpandu adalah pilihan di bagian URL bantuan kustom yang diatur dalam pengaturan sistem. Panel bantuan kustom dan tugas terpandu mengaktifkan panel bantuan yang dapat disesuaikan yang muncul tepat di sebelah formulir pengguna. Pilihan lain dalam pengaturan sistem ini mengatur agar bagian bantuan kustom terdiri dari fitur bantuan yang dapat disesuaikan. Semua itu memungkinkan Anda untuk menimpa Bantuan aplikasi default dan mengarahkan pengguna di organisasi Anda ke URL yang berbeda untuk Bantuan. Atau, Anda dapat menimpa bantuan untuk tabel yang sangat disesuaikan sehingga Anda dapat lebih baik menggambarkan alur kerja Anda.

Untuk informasi lebih lanjut tentang Bantuan disesuaikan, lihat Mengaktifkan dan menggunakan bantuan yang disesuaikan.

Bagaimana cara memigrasi data saya dari jalur pembelajaran ke halaman bantuan kustom?

Jalur pembelajaran memiliki dua jenis bantuan: Bantuan panel dan balon bantuan berurutan. Lokasi balon bantuan sekuensial terintegrasi secara mendalam dengan UI klien web lama dan tidak dapat dialihkan ke panel bantuan kustom baru.

Tergantung pada seberapa banyak teks yang Anda miliki dalam bantuan terpandu Anda mungkin paling mudah untuk hanya menyalin informasi secara langsung dari antarmuka pengguna jalur pembelajaran ke antarmuka pengguna panel bantuan kustom yang baru. Namun, Anda juga dapat mengekspor konten bantuan jalur pembelajaran. Cara termudah untuk melakukannya adalah dengan mengekspor konten menggunakan fitur jalurpembelajaran > Pustaka Konten > lokalkan > ekspor. Pilih baris yang diinginkan, lalu ekspor. Ini membuat file XLIFF untuk setiap panel bantuan dan tugas terpandu. Kemudian, gunakan editor XLIFF yang tersedia untuk publik atau XLIFF ke HTML Converter untuk mengambil konten Anda.

Definisi XML Bantuan kustom

Bagian ini menjelaskan definisi XML bantuan kustom.

PPHML

<pphml>
    <h1>FAQ</h1>
    <collapsible title="What is PPHML?">
        <p>PPHML is a domain specific language for help content. It is used to create help content that includes elements such as images, videos, balloons, coach marks, etc.</p>
    </collapsible>
    <collapsible title="What does PPHML stand for?">
        <p>PPHML stands for Power Platform Help Markup Language</p>
    </collapsible>
</pphml>

Definisi dan penggunaan

Elemen <pphml> memberitahu browser bantuan bahwa ini adalah dokumen PPHML.

Elemen <pphml> mewakili akar dari dokumen PPHML.

Elemen <pphml> adalah wadah untuk semua elemen PPHML lainnya.

Judul

Menyajikan judul di halaman bantuan.

<h1>This will be displayed at the top of the help page</h1>

Definisi dan penggunaan

Elemen <h1> mendefinisikan judul halaman bantuan.

<h1> Ini harus menjadi elemen pertama di dalam <pphml>.

Gambar

Menyajikan gambar di halaman bantuan.

<img src="smiley.gif" alt="Smiley face" title="Smiley face"/>

Definisi dan penggunaan

Elemen <img> akan menyematkan gambar di halaman bantuan.

Atribut

  • src: Menentukan URL gambar. Atribut ini harus ada.

  • title: Menentukan judul untuk ditampilkan bersama dengan gambar, biasanya sebagai tooltip saat meletakkan mouse di atasnya.

  • alt: Menentukan teks alternatif untuk gambar. Teks ini digunakan oleh pembaca layar.

Video

Menyajikan video di halaman bantuan.

<video src="https://www.youtube.com/watch?v=WSWmn7WM3i4" />

Definisi dan penggunaan

Elemen <video> akan menyematkan video, seperti tutorial atau film pelatihan, di halaman bantuan.

Sumber yang didukung
  • Microsoft Stream
  • YouTube
  • Facebook
  • Vimeo

Atribut

  • src: Menentukan URL video. Atribut ini harus ada.

  • allowFullScreen: Menentukan apakah pengguna dapat mengalihkan video ke layar penuh. Nilai yang mungkin adalah "true" atau "false". Atribut ini tidak didukung untuk semua sumber video.

  • autoplay: Menentukan bahwa video akan mulai diputar segera setelah halaman bantuan dimuat. Nilai yang mungkin adalah "true" atau "false". Atribut ini tidak didukung untuk semua sumber video.

  • startTime: Menentukan, dalam hitungan detik, dari titik mana untuk mulai memutar video.

Paragraf

Menyajikan paragraf di halaman bantuan.

<p>This is some text in a paragraph.</p>

Definisi dan penggunaan

Elemen <p> mendefinisikan paragraf.

Teks di dalam paragraf dapat dihias dengan cara berikut:

  • Bold, dengan elemen <strong>
  • Italic, dengan elemen <em>
  • Strikethrough, dengan elemen <del>
  • Garis bawah, dengan elemen <u>

Dekorasi ini dapat dikombinasikan. Misalnya, buat fragmen teks yang tebal dan bergaris bawah.

Daftar Butir

Menyajikan daftar butir di halaman bantuan.

<ul>
    <li>Coffee</li>
    <li>Tea</li>
    <li>Milk</li>
</ul>

Definisi dan penggunaan

Elemen <ul> mendefinisikan daftar butir.

Gunakan elemen <ul> bersama dengan elemen <li> untuk membuat daftar butir.

Daftar Bernomor

Menyajikan daftar bernomor di halaman bantuan.

<ol>
    <li>First step</li>
    <li>Second step</li>
    <li>Third step</li>
</ol>

Definisi dan penggunaan

Elemen <ol> mendefinisikan daftar yang diurutkan (bernomor). Gunakan tag <ol> bersama dengan elemen <li> untuk membuat daftar bernomor.

Diciutkan

Menyajikan bagian yang diciutkan di halaman bantuan.

<collapsible title="This is a Section">
    <p>This is a paragraph inside a section</p>
    <img src=smiley.gif" title="This is an image inside a section" />
</collapsible>

Definisi dan penggunaan

Elemen <collapsible> mendefinisikan bagian konten yang pengguna dapat lihat atau sembunyikan sesuai keinginan.

Atribut

  • collapsed: Menentukan apakah bagian tersebut diciutkan atau diperluas pada awalnya. Nilai yang mungkin adalah "true"(diciutkan) atau "false" (diperluas).

Menyajikan tautan di halaman bantuan.

Tautan ke situs web yang terbuka di jendela browser baru:

<a href="https://www.microsoft.com" target="_blank">Microsoft Home Page</a>

Tautan ke halaman bantuan lainnya:

<a href="./LearnMore">Learn More</a>

Definisi dan penggunaan

Tag <a> mendefinisikan tautan, yang memungkinkan pengguna menavigasi dari halaman bantuan ke situs web, atau ke halaman bantuan lainnya.

Atribut

  • href: Menentukan URL situs web atau halaman bantuan yang akan dinavigasi. Atribut ini harus ada.
  • target: Menentukan lokasi untuk membuka URL yang ditautkan.
    • Jika tidak ada atau _self, tautan diasumsikan ke halaman bantuan lain dan dibuka di browser bantuan.
    • Jika _blank, tautan dibuka di jendela browser baru.
    • Jika _top, tautan dibuka di jendela browser saat ini.
    • Jika nilai adalah nama dari iframe, tautan dibuka di iframe tersebut.

Tanda pelatih

Menyajikan tanda pelatih di halaman bantuan.

<coachmark target="#my-html-button">Click to highlight the HTML element with id [my-html-button]</coachmark>

Definisi dan penggunaan

Tanda pelatih adalah elemen interaktif yang dapat digunakan untuk menarik perhatian pengguna ke titik tertentu di UI aplikasi yang menghosting browser bantuan.

Atribut

  • target: pemilih CSS yang menentukan elemen HTML yang akan ditampilkan tanda pelatih. Atribut ini harus ada.

Balon

Menyajikan balon di halaman bantuan.

<balloon target="#my-html-button" title="This button submits the form" details="Please click this button to continue and submit the form">Click to show a balloon over the HTML element with id [my-html-button]</balloon>

Definisi dan penggunaan

Balon adalah elemen interaktif yang dapat digunakan untuk membantu pengguna melakukan tindakan di UI aplikasi yang menghosting browser bantuan.

Atribut

  • target: pemilih CSS yang menentukan elemen HTML yang akan ditampilkan tautan balon. Atribut ini harus ada.
  • title: Menentukan judul balon.
  • details: Menentukan konten yang akan ditampilkan di dalam balon.

Catatan

Apa bahasa dokumentasi yang Anda inginkan? Lakukan survei singkat. (perlu diketahui bahwa survei ini dalam bahasa Inggris)

Survei akan berlangsung kurang lebih selama tujuh menit. Tidak ada data pribadi yang dikumpulkan (pernyataan privasi).