SharePoint

Konektor SharePoint menyediakan akses SQL ke server dan layanan SharePoint.

Versi yang didukung

Konektor ini mendukung Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 dan yang lebih baru, serta SharePoint Online.

Sebelum memulai

Sebelum menggunakan konektor SharePoint, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

  1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Buat baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor meliputi:

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Berikutnya.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih SharePoint dari menu drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. Secara opsional, masukkan Description untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Secara opsional, konfigurasikan Setelan node koneksi:

      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default, node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    8. Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
    9. Klik Berikutnya.
  5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
    1. Jenis Tujuan: Pilih Jenis Tujuan. Misalnya, alamat host adalah https://xxxxx.sharepoint.com.
      • Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
      • Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

      Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.

    2. Klik Berikutnya.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi SharePoint:

      • Kredensial Windows. Pilih opsi ini jika Anda menggunakan edisi SharePoint on-premise.
      • AzureAD. Pilih ini jika Anda menggunakan SharePoint edisi online.
      • Kredensial klien OAuth 2.0 dengan pembawa JWT. Pilih opsi ini jika Anda menggunakan kredensial klien OAuth 2.0 dengan pembawa JWT untuk autentikasi.
      • Kredensial klien OAuth 2.0 dengan rahasia klien. Pilih opsi ini jika Anda menggunakan kredensial klien OAuth 2.0 dengan rahasia klien untuk autentikasi.

      2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

    2. Klik Berikutnya.
  7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  8. Klik Create.

Mengonfigurasi autentikasi

Konektor SharePoint mendukung jenis autentikasi berikut:

Jenis autentikasi kredensial Windows

Untuk mengaktifkan jenis autentikasi kredensial Windows, Anda harus menyelesaikan langkah-langkah berikut:
  1. Konfigurasikan PSC dan buat lampiran endpoint.
  2. Menentukan kredensial di Google Cloud.

Mengonfigurasi PSC dan membuat lampiran endpoint

  1. Buat grup instance dengan IP tempat SharePoint dihosting.
  2. Buat load balancer jaringan passthrough internal dan gunakan grup instance yang Anda buat sebagai backend. Load balancer internal TCP harus mengaktifkan akses global.
  3. Publikasikan load balancer di Private Service Connect. Lampiran layanan dibuat setelah load balancer dipublikasikan.
  4. Publikasikan layanan dan tentukan load balancer yang Anda buat.
  5. Gunakan lampiran layanan untuk membuat lampiran endpoint.
  6. Setelah membuat lampiran endpoint, buat koneksi SharePoint dengan IP lampiran endpoint.

    7. Untuk informasi selengkapnya tentang cara membuat lampiran endpoint, lihat Membuat lampiran endpoint.

Menentukan detail kredensial Windows di Google Cloud

Saat membuat koneksi di Konektor Integrasi , Anda harus menentukan detail berikut:

Di bagian Authentication, pilih Windows credentials sebagai jenis autentikasi, lalu masukkan detail berikut:

  • Nama pengguna: Masukkan nama pengguna.
  • Sandi: Pilih sandi.
  • Secret version: Masukkan versi secret.

Jenis koneksi kredensial Windows

Tabel berikut mencantumkan contoh nilai konfigurasi untuk jenis koneksi kredensial Windows.
Nama kolom Detail
Wilayah us-central1
Konektor SharePoint
Versi konektor 1
Nama Koneksi sharepoint-staging-psc
Akun Layanan SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Jenis Tujuan Alamat host
host 1 http://192.0.2.0
port 1 24
Authentication Kredensial Windows
Nama pengguna USER_NAME
Sandi PASSWORD
Versi Secret 1

Jenis autentikasi Azure AD

Untuk mengaktifkan jenis autentikasi Azure AD, Anda harus menyelesaikan langkah-langkah berikut:
  1. Daftarkan aplikasi Anda dan dapatkan OAuthClientId dan OAuthClientSecret.
  2. Menentukan kredensial di Google Cloud.
  3. Berikan otorisasi ke koneksi di Google Cloud.
  4. Menambahkan URL pengalihan ke aplikasi Anda.

Mendaftarkan aplikasi dan mendapatkan OAuthClientId dan OAuthClientSecret

Untuk mendaftarkan aplikasi dan mendapatkan OAuthClientId dan OAuthClientSecret untuk aplikasi Anda, lakukan hal berikut:
  1. Login ke Portal Azure.
  2. Di Azure Services, pilih App Registrations, lalu New registration.
  3. Masukkan nama aplikasi, lalu pilih Tenant Microsoft Entra ID apa pun - Multi-tenant. Gambar berikut menunjukkan halaman Daftarkan aplikasi:
  4. Setelah membuat aplikasi, buka bagian Sertifikat & Rahasia, buat rahasia klien untuk aplikasi, dan simpan nilai rahasia klien. Gambar berikut menampilkan halaman Certificates & Secrets:
  5. Di API Permissions, pilih Izin aplikasi dan Izin yang didelegasikan yang diperlukan. Agar koneksi aktif, Anda harus memberikan izin minimum berikut:AllSites.Manage

    Tabel berikut mencantumkan izin yang diperlukan untuk melakukan operasi di aplikasi.

    Izin yang didelegasikan Izin aplikasi
    ConsentRequest.Read.All AllSites.FullControl
    ConsentRequest.ReadWrite.All AllSites.Manage
    DelegatedAdminRelationship.Read.All AllSites.Read
    DelegatedAdminRelationship.ReadWrite.All AllSites.Write
    DelegatedPermissionGrant.Read.All EnterpriseResource.Read
    DelegatedPermissionGrant.ReadWrite.All EnterpriseResource.Write
    Files.Read.All MyFiles.Read
    Files.ReadWrite.All MyFiles.Write
    Group.Create Project.Read
    Group.Read.All Project.Write
    Group.ReadWrite.All ProjectWebApp.FullControl
    Sites.FullControl.All ProjectWebAppReporting.Read
    Sites.FullControl.All Sites.FullControl.All
    Sites.Manage.All Sites.Manage.All
    Sites.Read.All Sites.Read.All
    Sites.ReadWrite.All Sites.ReadWrite.All
    Sites.Selected Sites.Search.All
    User.Export.All Sites.Selected
    User.Read TaskStatus.Submit
    User.Read.All TermStore.Read.All
    User.ReadWrite.All TermStore.Read.All
    TermStore.ReadWrite.All
    TermStore.ReadWrite.All
    User.Read.All
    User.Read.All
    User.ReadWrite.All
    User.ReadWrite.All
  6. Simpan perubahan Anda.
  7. Jika telah memilih untuk menggunakan izin yang memerlukan izin admin, Anda dapat memberikannya dari tenant saat ini di halaman Izin API. Gambar berikut menampilkan halaman izin API:
  8. Untuk menambahkan cakupan, buka bagian Expose an API dan tambahkan cakupan AllSites.Manage, Sites.FullControl.All, lalu pilih siapa yang dapat mengontrol (Admin dan pengguna). Gambar berikut menampilkan halaman Mengekspos API:
  9. Klik Simpan.

Menentukan kredensial di Google Cloud

Saat membuat koneksi di Konektor Integrasi , Anda harus menentukan detail berikut:

Di bagian Authentication, pilih AzureAD sebagai jenis autentikasi, lalu masukkan detail berikut:

  • Client ID: Masukkan client ID yang digunakan untuk meminta token akses.
  • Cakupan: Masukkan daftar cakupan yang diinginkan yang dipisahkan koma. Misalnya, Sites.FullControl.All
  • Rahasia klien: Masukkan secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
  • Versi secret: Versi secret untuk secret yang dipilih di atas.
  • URL otorisasi: URL otorisasi yang dibuat saat membuat klien. Masukkan URL dalam format berikut: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Misalnya, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.

Memberi otorisasi koneksi di Google Cloud

  1. Di halaman Koneksi, cari koneksi yang baru dibuat.

    Status untuk konektor baru akan menjadi Otorisasi diperlukan.

  2. Klik Otorisasi diperlukan.

    Tindakan ini akan menampilkan panel Edit otorisasi.

  3. Salin nilai Redirect URI ke aplikasi eksternal Anda. Untuk mengetahui informasi selengkapnya, lihat Menambahkan URL pengalihan ke aplikasi Anda.
  4. Verifikasi detail otorisasi.
  5. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Menambahkan URL alihan ke aplikasi Anda

  1. Di portal Azure, klik Azure services > App registrations.
  2. Klik nama Aplikasi Anda.
  3. Klik tambahkan URI pengalihan.
  4. Klik Tambahkan platform.
  5. Di dialog Web, tempel URI pengalihan yang Anda salin saat memberi otorisasi koneksi di Google Cloud.

Jenis koneksi Azure AD

Tabel berikut mencantumkan contoh nilai konfigurasi untuk jenis koneksi Azure AD:
Nama kolom Detail
Wilayah us-central1
Konektor SharePoint
Versi konektor 1
Nama Koneksi sharepoint-google-cloud-con
Akun Layanan SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Jenis Tujuan Alamat host
host 1 http://z8**.sharepoint.com
Autentikasi AzureAD
ID klien CLIENT_ID
Cakupan Sites.FullControl.All
Rahasia klien CLIENT_SECRET
Versi Secret 1
URL otorisasi https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 - kredensial klien dengan jenis autentikasi pembawa JWT

Untuk mengaktifkan OAuth 2.0 - kredensial klien dengan jenis autentikasi pembawa JWT, Anda harus menyelesaikan langkah-langkah berikut:
  1. Buat sertifikat.
  2. Upload sertifikat ke portal Azure.
  3. Dapatkan kunci pribadi.
  4. Selesaikan penyiapan.
  5. Menentukan kredensial pembawa JWT OAuth 2.0 di Google Cloud.

Untuk mengaktifkan jenis autentikasi pembawa JWT, Anda harus membuat sertifikat, menguploadnya ke portal Azure, lalu mendapatkan kunci pribadi.

Membuat sertifikat

  1. Buat folder kosong di komputer Anda.
  2. Buat file teks di folder.
  3. Salin skrip PowerShell dari halaman Memberikan akses melalui halaman Khusus Aplikasi Azure AD dan tempelkan ke dalam file teks.
  4. Ganti nama file teks menjadi nama berikut: Create-SelfSignedCertificate.ps1.
  5. Jalankan Windows PowerShell di folder.
  6. Buka direktori yang berisi file teks.
  7. Salin perintah berikut: .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    Masukkan nama unik untuk CERTIFICATE_NAME. Ubah StartDate ke tanggal saat ini dan EndDate ke tanggal pilihan Anda.

  8. Tempel perintah yang disalin dengan perubahan Anda ke Windows PowerShell, lalu tekan Enter.

    Windows PowerShell meminta untuk Memasukkan sandi guna melindungi Kunci Pribadi. Pastikan untuk menyimpan sandi untuk digunakan nanti.

    Windows PowerShell membuat dua file: MyCertificate.pfx dan MyCertificate.cer.

Mengupload sertifikat ke portal Azure

  1. Login ke Azure Portal dan daftarkan aplikasi baru dengan menentukan detail berikut:
    • Nama: masukkan nama untuk aplikasi.
    • Supported account types: pilih Accounts in this organizational directory only (Account name only - Single tenant).
  2. Buka Izin API > Tambahkan izin > Minta izin API > SharePoint.
  3. Pilih Izin aplikasi, lalu tambahkan izin yang diperlukan.
  4. Pilih Grant admin consent, lalu pilih Yes.
  5. Setelah membuat aplikasi, buka bagian Sertifikat & Secret.
  6. Pilih Upload Sertifikat, lalu upload sertifikat CER dari komputer Anda. Setelah upload selesai, pilih Tambahkan.

    Jangan tambahkan rahasia klien di aplikasi karena akan mengganggu alur autentikasi berbasis sertifikat.

  7. Buka Manifes, temukan KeyCredentials, lalu salin customKeyIdentifier sebagai Thumbprint. Anda akan menggunakannya nanti. Sekarang Anda telah mendaftarkan aplikasi dan menautkan sertifikat.

Mendapatkan kunci pribadi

Anda bisa mendapatkan kunci pribadi dengan mengonversi file PFX menjadi file PEM menggunakan OpenSSL.

  1. Dari command prompt, buka folder yang berisi file PFX Anda dan jalankan perintah berikut: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Masukkan sandi PFX yang Anda gunakan dalam proses pembuatan sertifikat.
  3. Buka file PEM di editor teks dan salin bagian kunci pribadi berikut: 
    -----BEGIN PRIVATE KEY----- 

-----END PRIVATE KEY-----

Menyelesaikan penyiapan

  1. Salin Client ID dan Tenant ID dari aplikasi yang baru didaftarkan di portal Azure.
  2. Login dengan autentikasi Akun Utama Layanan Daftar SharePoint dengan kredensial berikut:
    • ID Klien
    • ID Tenant
    • Kunci pribadi
    • Thumbprint (sandi kunci pribadi)

Menentukan kredensial pembawa JWT OAuth 2.0 di Google Cloud

Saat membuat koneksi di Konektor Integrasi , Anda harus menentukan detail berikut:

Di bagian Authentication, pilih OAuth 2.0 client credentials with JWT bearer sebagai jenis autentikasi, lalu masukkan detail berikut:

  • Client ID: Masukkan client ID yang digunakan untuk meminta token akses. Ini adalah kunci konsumen yang dibuat saat Anda mendaftarkan aplikasi di portal Azure.
  • Kunci pribadi: Pilih secret Secret Manager yang berisi konten file kunci pribadi dalam format PEM. Kunci pribadi harus cocok dengan kunci publik/sertifikat yang diberikan ke Konektor.
  • Versi secret: Versi secret untuk secret yang dipilih di atas.
  • Private Key Password: Pilih Secret Manager Secret yang berisi sandi (parafrase) file kunci pribadi.
  • Versi secret: Versi secret untuk secret yang dipilih di atas.
  • Tenant Azure: Tenant Microsoft Online yang digunakan untuk mengakses data.

Jenis koneksi JWT Bearer Certificate

Tabel berikut mencantumkan contoh nilai konfigurasi untuk jenis koneksi OAuth 2.0 JWT Bearer Certificate.
Nama kolom Detail
Wilayah europe-west1
Konektor SharePoint
Versi konektor 1
Nama Koneksi sharepoint-jwt-certificate
Akun Layanan SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Jenis Tujuan Alamat host
host 1 http://z8**.sharepoint.com
port 1 ****
Authentication Kredensial klien OAuth 2.0 dengan pembawa JWT
Client ID OAuth CLIENT_ID
Kunci Pribadi KEY
Versi Secret 1
Sandi Kunci Pribadi PASSWORD
Versi Secret 1
Tenant Azure AZURE_TENANT_ID

OAuth 2.0 - jenis koneksi rahasia klien

Untuk mengaktifkan jenis koneksi rahasia klien OAuth 2.0, Anda harus menyelesaikan langkah-langkah berikut:

  1. Daftarkan add-in.
  2. Berikan izin ke add-in.
  3. Menentukan kredensial klien OAuth 2.0 di Google Cloud
  4. Otorisasi ulang untuk kode otorisasi

Mendaftarkan add-in

  1. Buka halaman Register Add-In menggunakan URL berikut: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. Di bagian App Information, buat client ID dan rahasia klien.
  3. Tentukan nilai untuk Judul, Domain Aplikasi, dan URI Alihan.
  4. Klik Create.Add-in akan didaftarkan, dan Aplikasi SharePoint akan menampilkan informasi yang dibuat.

Memberikan izin ke add-in

  1. Buka situs SharePoint menggunakan URL berikut: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Anda akan dialihkan ke halaman Berikan Izin.
  2. Di kolom App Id, masukkan client ID yang Anda buat sebelumnya, lalu klik Lookup. Nilai untuk Judul, Domain Aplikasi, dan URL Alihan diisi.
  3. Masukkan permintaan izin berikut dalam format XML: 
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>
  4. Klik Buat. Aplikasi Sharepoint menampilkan dialog izin.
  5. Klik Percayai.

Menentukan kredensial klien OAuth 2.0 di Google Cloud

Saat membuat koneksi di Konektor Integrasi , Anda harus menentukan detail berikut:

Di bagian Authentication, pilih OAuth 2.0 client credentials with client secret sebagai jenis autentikasi, lalu masukkan detail berikut:

  • Client ID: Masukkan client ID yang disediakan oleh konektor untuk aplikasi yang Anda buat.
  • Rahasia Klien: Pilih secret Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
  • Versi secret: Pilih versi secret klien.

Otorisasi ulang untuk kode otorisasi

Jika menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi apa pun di aplikasi SharePoint, Anda harus memberikan otorisasi ulang ke koneksi SharePoint. Untuk memberikan otorisasi ulang pada koneksi, lakukan langkah-langkah berikut:

  1. Klik koneksi yang diperlukan di halaman Koneksi.

    Tindakan ini akan membuka halaman detail koneksi.

  2. Klik Edit untuk mengedit detail koneksi.
  3. Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.

    Jika diperlukan, buat perubahan yang diperlukan.

  4. Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
  5. Klik Edit authorization di bagian Authentication. Tindakan ini akan menampilkan panel Authorize.
  6. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Jenis koneksi kredensial klien

Tabel berikut mencantumkan contoh nilai konfigurasi untuk jenis koneksi kredensial klien OAuth 2.0.
Nama kolom Detail
Wilayah europe-west1
Konektor SharePoint
Versi konektor 1
Nama Koneksi sharepoint-client-credentials
Akun Layanan SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Jumlah minimum node 2
Jumlah maksimum node 50
Jenis Tujuan Alamat host
host 1 http://z8**.sharepoint.com
port 1 ****
Autentikasi Kredensial klien OAuth 2.0 dengan rahasia klien
ID Klien CLIENT_ID
Rahasia Klien CLIENT_SECRET
Versi Secret 1

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

  • Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

    Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:

    Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

  • Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Tindakan

Bagian ini mencantumkan beberapa tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Tindakan DeleteAttachment

Tindakan ini akan menghapus lampiran.

Parameter input tindakan DeleteAttachment

Nama parameter Jenis data Wajib Deskripsi
ListTitle String Ya Judul item daftar.
ItemId String Ya ID item daftar.
FileName String Ya Nama file yang akan dihapus dari library dokumen.

Untuk memahami cara mengonfigurasi tindakan DeleteAttachment, lihat Contoh tindakan.

Tindakan CheckInDocument

Tindakan ini memungkinkan Anda memeriksa dokumen.

Parameter input tindakan CheckInDocument

Nama parameter Jenis data Wajib Deskripsi
RelativeURL String Ya URL relatif folder.
DocumentName String Ya Nama file yang akan diperiksa.
Komentar String Tidak Pesan check in opsional.

Untuk memahami cara mengonfigurasi tindakan CheckInDocument, lihat Contoh tindakan.

Tindakan CheckOutDocument

Tindakan ini memungkinkan Anda memeriksa file.

Parameter input tindakan CheckOutDocument

Nama parameter Jenis data Wajib Deskripsi
RelativeURL String Ya URL relatif folder.
DocumentName String Ya Nama file yang akan diperiksa.

Untuk memahami cara mengonfigurasi tindakan CheckOutDocument, lihat Contoh tindakan.

Tindakan DiscardCheckOutDocument

Tindakan ini memungkinkan Anda mengurungkan check out file.

Parameter input tindakan DiscardCheckOutDocument

Nama parameter Jenis data Wajib Deskripsi
RelativeURL String Ya URL relatif folder.
DocumentName String Ya Nama file yang check out-nya harus diurungkan.

Untuk memahami cara mengonfigurasi tindakan DiscardCheckOutDocument, lihat Contoh tindakan.

Tindakan CopyDocument

Tindakan ini memungkinkan Anda menyalin file dari satu lokasi ke lokasi lain.

Parameter input tindakan CopyDocument

Nama parameter Jenis data Wajib Deskripsi
SourceFileRelativeUrl String Ya URL relatif file sumber.
DestFileRelativeUrl String Ya URL relatif file tujuan.

Untuk memahami cara mengonfigurasi tindakan CopyDocument, lihat Contoh tindakan.

Tindakan UploadDocument

Tindakan ini memungkinkan Anda mengupload file.

Parameter input tindakan UploadDocument

Nama parameter Jenis data Wajib Deskripsi
FileName String Ya Nama file yang akan diupload.
RelativeUrl String Ya URL relatif folder.
Konten String Tidak Konten yang akan diupload sebagai file.
ContentBytes String Tidak Konten byte (sebagai string Base64) untuk diupload sebagai file. Gunakan ini untuk mengupload data biner.
HasBytes Boolean Tidak Menentukan apakah konten yang akan diupload bersifat biner. Nilai defaultnya adalah false.

Untuk memahami cara mengonfigurasi tindakan UploadDocument, lihat Contoh tindakan.

Tindakan DownloadDocument

Tindakan ini memungkinkan Anda mendownload file.

Parameter input tindakan DownloadDocument

Nama parameter Jenis data Wajib Deskripsi
RemoteFile String Ya URL lengkap file yang akan didownload.
Library String Ya Nama library di server SharePoint.
HasBytes Boolean Tidak Menentukan apakah konten harus didownload sebagai byte. Nilai defaultnya adalah false.

Untuk memahami cara mengonfigurasi tindakan DownloadDocument, lihat Contoh tindakan.

Tindakan MoveAttachmentOrDocument

Tindakan ini memungkinkan Anda memindahkan file dari satu folder ke folder lain.

Parameter input tindakan MoveAttachmentOrDocument

Nama parameter Jenis data Wajib Deskripsi
SourceFileURL String Ya URL file sumber yang harus dipindahkan.
DestinationFolderURL String Ya URL folder tujuan.

Untuk memahami cara mengonfigurasi tindakan MoveAttachmentOrDocument, lihat Contoh tindakan.

Tindakan CreateFolder

Tindakan ini memungkinkan Anda membuat folder.

Parameter input tindakan CreateFolder

Nama parameter Jenis data Wajib Deskripsi
RelativeURL String Ya URL relatif folder.
FolderName String Ya Nama folder yang akan dibuat.

Untuk memahami cara mengonfigurasi tindakan CreateFolder, lihat Contoh tindakan.

Tindakan AddAttachments

Tindakan ini memungkinkan Anda menambahkan lampiran.

Parameter input tindakan AddAttachments

Nama parameter Jenis data Wajib Deskripsi
ListTitle String Ya Nama daftar lampiran.
FileName String Ya Nama file lampiran.
ItemId String Ya ID lampiran yang akan ditambahkan.
Konten String Ya Konten lampiran.
ContentBytes String Tidak Konten byte (sebagai string Base64) untuk diupload sebagai lampiran. Gunakan ini untuk mengupload data biner.
HasBytes Boolean Tidak Menentukan apakah konten yang akan diupload bersifat biner. Nilai defaultnya adalah false.

Untuk memahami cara mengonfigurasi tindakan AddAttachments, lihat Contoh tindakan.

Tindakan DownloadAttachments

Tindakan ini memungkinkan Anda mendownload lampiran.

Parameter input tindakan DownloadAttachments

Nama parameter Jenis data Wajib Deskripsi
RemoteFile String Ya URL relatif file.
HasBytes Boolean Tidak Menentukan apakah konten yang akan didownload adalah biner. Nilai defaultnya adalah false.

Untuk memahami cara mengonfigurasi tindakan DownloadAttachments, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Menghapus lampiran

Contoh ini menghapus file yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DeleteAttachment, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DeleteAttachment akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mencatat dokumen masuk

Contoh ini memeriksa dokumen.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CheckInDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CheckInDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Melihat file

Contoh ini memeriksa file.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CheckOutDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CheckOutDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Menghapus check out

Contoh ini akan mengembalikan check out file.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DiscardCheckOutDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DiscardCheckOutDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Menyalin file

Contoh ini menyalin file dari satu lokasi ke lokasi lain.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CopyDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CopyDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mengupload file teks

Contoh ini mengupload file teks ke lokasi yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan UploadDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UploadDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mengupload file biner

Contoh ini mengupload file biner ke lokasi yang ditentukan. Saat mengupload file biner, tentukan konten yang akan diupload sebagai string yang dienkode Base64.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan UploadDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas UploadDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Status": "Success"
}]

Contoh - Mendownload file

Contoh ini mendownload file.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Success": "True",
"Content": "Test File",
}]

Contoh - Mendownload file biner

Contoh ini mendownload file biner.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Contoh - Memindahkan lampiran

Contoh ini memindahkan lampiran dari satu lokasi ke lokasi lain.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan MoveAttachmentOrDocument, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas MoveAttachmentOrDocument akan memiliki nilai yang mirip dengan berikut:

    [{
"Result": "Success"
}]

Contoh - Membuat folder

Contoh ini membuat folder di lokasi yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateFolder, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CreateFolder akan memiliki nilai yang mirip dengan berikut:

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Contoh - Menambahkan lampiran

Contoh ini menambahkan lampiran ke daftar yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan AddAttachments, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AddAttachments akan memiliki nilai yang mirip dengan berikut:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Contoh - Menambahkan lampiran biner

Contoh ini menambahkan lampiran biner ke daftar yang ditentukan.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan AddAttachments, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AddAttachments akan memiliki nilai yang mirip dengan berikut:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Contoh - Mendownload lampiran

Contoh ini mendownload lampiran.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachments, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadAttachments akan memiliki nilai yang mirip dengan berikut:

    [{
"Success": "True",
"Content": "Test File",
}]

Contoh - Mendownload lampiran biner

Contoh ini mendownload lampiran biner.

  1. Pada dialog Configure connector task, klik Actions.
  2. Pilih tindakan DownloadAttachments, lalu klik Selesai.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadAttachments akan memiliki nilai yang mirip dengan berikut:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entity di konektor ini.

Contoh - Mencantumkan semua file

Contoh ini mencantumkan semua file dalam entitas Files.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Files dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter set hasil dengan menentukan klausa filter. Anda juga dapat menentukan beberapa kondisi filter menggunakan operator logika.

Contoh - Mendapatkan daftar

Contoh ini mendapatkan daftar dengan ID yang ditentukan dari entitas My Lists.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih My Lists dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 3 di kolom Default Value.

    Di sini, 3 adalah nilai kunci utama dalam entity My Lists.

Contoh - Membuat data

Contoh ini membuat data di entitas My Lists.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih My Lists dari daftar Entity.
  3. Pilih operasi Create, lalu klik Done.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

    [{
"ID": 3.0
}]

Contoh - Menghapus data

Contoh ini menghapus data dengan ID yang ditentukan dalam entitas My Lists.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih My Lists dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Done.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 2 di kolom Default Value.

Menggunakan koneksi SharePoint dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
  • Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya