SharePoint

Konektor SharePoint memungkinkan Anda mengelola file, folder, dan lampiran di 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

Di project Google Cloud Anda, lakukan tugas berikut:

  • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
  • Berikan peran IAM roles/secretmanager.viewer dan roles/secretmanager.secretAccessor ke akun layanan yang ingin Anda gunakan untuk konektor:
  • Aktifkan secretmanager.googleapis.com (Secret Manager API) dan connectors.googleapis.com (Connectors API). Untuk mengetahui informasi selengkapnya, lihat Mengaktifkan layanan.

Membuat koneksi SharePoint

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Buat baru untuk membuka halaman Buat koneksi.
  3. Di bagian Lokasi, pilih lokasi dari daftar Wilayah, lalu klik Berikutnya.

    Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

  4. Di bagian Detail koneksi, selesaikan langkah-langkah berikut:
    1. Pilih SharePoint dari daftar konektor.
    2. Pilih versi konektor dari daftar Versi konektor.
    3. Di kolom Nama koneksi, masukkan nama untuk instance koneksi. Nama koneksi dapat berisi huruf kecil, angka, atau tanda hubung. Nama harus diawali dengan huruf dan diakhiri dengan huruf atau angka, serta tidak boleh lebih dari 49 karakter.
    4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
    6. Di kolom Service account, pilih akun yang memiliki peran yang diperlukan.
    7. Jika perlu, konfigurasikan Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah node maksimum: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. 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. Atau, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    9. Klik Berikutnya.
  5. Di bagian Tujuan, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan, lalu klik Berikutnya.
  6. Di kolom Jenis tujuan, pilih jenis tujuan. Misalnya, alamat host adalah https://<SITE_NAME>.sharepoint.com.

    • Untuk menentukan nama host atau alamat IP tujuan, pilih Alamat host dan masukkan alamat di kolom Host 1.
    • Untuk membuat koneksi pribadi, pilih Endpoint attachment dan pilih lampiran yang diperlukan dari daftar Endpoint Attachment.

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

    Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.

  7. 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 opsi ini jika Anda menggunakan edisi online SharePoint.
      • Kredensial klien OAuth 2.0 dengan pembawa JWT. Pilih opsi ini jika Anda menggunakan kredensial klien OAuth 2.0 dengan JWT bearer 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.

    3. Klik Berikutnya.
  8. Di bagian Tinjau, tinjau detail koneksi dan autentikasi Anda.
  9. Klik Buat.

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. Konfigurasi PSC dan buat lampiran endpoint.
  2. Tentukan 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 mengetahui informasi selengkapnya tentang cara membuat lampiran endpoint, lihat Membuat lampiran endpoint.

Tentukan detail kredensial Windows di Google Cloud

Saat membuat koneksi di Integration Connectors , 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.
  • Versi rahasia: Masukkan versi rahasia.

Jenis koneksi kredensial Windows

Tabel berikut mencantumkan nilai konfigurasi contoh 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
Autentikasi Kredensial Windows
Nama pengguna USER_NAME
Sandi PASSWORD
Versi rahasia 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. Tentukan kredensial di Google Cloud.
  3. Otorisasi koneksi di Google Cloud.
  4. Tambahkan URL pengalihan ke aplikasi Anda.

Daftarkan aplikasi Anda dan dapatkan OAuthClientId dan OAuthClientSecret

Untuk mendaftarkan aplikasi dan mendapatkan OAuthClientId serta OAuthClientSecret untuk aplikasi Anda, lakukan hal berikut:

  1. Login ke Azure Portal.
  2. Di Azure services, pilih App registrations, lalu New registration.
  3. Masukkan nama aplikasi, lalu pilih Tenant Microsoft Entra ID apa pun - Multi-tenant.
  4. Klik Daftar.
  5. Setelah membuat aplikasi, buka bagian Certificates & secrets, buat rahasia klien untuk aplikasi, dan simpan nilai rahasia klien.
  6. Di Izin API, pilih Izin aplikasi dan Izin yang didelegasikan yang diperlukan. Agar koneksi aktif, Anda harus memberikan izin minimum berikut:Sites.Read.All.

    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
  7. Simpan perubahan.
  8. Jika Anda telah memilih untuk menggunakan izin yang memerlukan izin admin, Anda dapat memberikannya dari tenant saat ini di halaman Izin API.
  9. Untuk menambahkan cakupan, buka bagian Expose an API, tambahkan cakupan AllSites.Manage, Sites.FullControl.All, lalu pilih siapa yang dapat mengontrol (Admin dan pengguna).
  10. Klik Simpan.

Tentukan kredensial di Google Cloud

Saat membuat koneksi di Integration Connectors , 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 dengan koma. Misalnya, Sites.FullControl.All
  • Rahasia klien: Masukkan rahasia 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 Anda buat saat membuat klien OAuth. Masukkan URL dalam format berikut: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Misalnya, https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent.

Otorisasi koneksi di Google Cloud

  1. Di halaman Koneksi, temukan 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 pengalihan 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 mengizinkan koneksi di Google Cloud.

Jenis koneksi Azure AD

Tabel berikut mencantumkan nilai konfigurasi sampel 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. Tentukan kredensial pembawa JWT OAuth 2.0 di Google Cloud.

Membuat sertifikat

  1. Buat folder kosong di komputer Anda.
  2. Buat file teks di folder.
  3. Salin skrip PowerShell dari Granting access via Azure AD App-Only page 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 akan meminta Anda untuk Memasukkan sandi untuk melindungi Kunci Pribadi. Pastikan untuk menyimpan sandi untuk digunakan nanti.

    Windows PowerShell akan 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 API Permissions > Add permission > Request API permissions > SharePoint.
  3. Pilih Izin aplikasi, lalu tambahkan izin yang diperlukan.
  4. Pilih Grant admin consent, lalu pilih Yes.
  5. Setelah membuat aplikasi, buka bagian Certificates & Secrets.
  6. Pilih Upload Sertifikat, lalu upload sertifikat CER Anda dari komputer. Setelah upload selesai, pilih Tambahkan.

    Jangan menambahkan 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. Anda kini telah mendaftarkan aplikasi dan menautkan sertifikat.

Mendapatkan kunci pribadi

Anda dapat memperoleh kunci pribadi dengan mengonversi file PFX menjadi file PEM menggunakan OpenSSL.

  1. Dari command prompt, buka folder dengan 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 seluruh teks, yang merupakan kunci pribadi Anda.

Selesaikan penyiapan

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

Tentukan kredensial pembawa JWT OAuth 2.0 di Google Cloud

Saat membuat koneksi di Integration Connectors , Anda harus menentukan detail berikut:

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

  • Di kolom Client ID, masukkan client ID yang digunakan untuk meminta token akses. Ini adalah kunci konsumen yang dihasilkan saat Anda mendaftarkan aplikasi di portal Azure.
  • Di kolom Private key, pilih secret Secret Manager yang berisi konten file kunci pribadi dalam format PEM. Kunci pribadi harus cocok dengan kunci publik/sertifikat yang diberikan ke Connector.
  • Di kolom Versi secret, pilih versi untuk secret yang dipilih di atas.
  • Di kolom Private key password, pilih rahasia Secret Manager yang berisi sandi (parafrasa) file kunci pribadi. Gunakan sandi yang sama yang Anda tetapkan untuk melindungi kunci pribadi saat Anda membuat sertifikat.
  • Di kolom Versi secret, pilih versi untuk secret yang dipilih di atas.
  • Di kolom Azure Tenant, masukkan tenant online Microsoft yang digunakan untuk mengakses data.

Jenis koneksi Sertifikat Bearer JWT

Tabel berikut mencantumkan nilai konfigurasi contoh untuk jenis koneksi Sertifikat Pembawa JWT OAuth 2.0.

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 ****
Autentikasi Kredensial klien OAuth 2.0 dengan token pembawa JWT
ID klien OAuth CLIENT_ID
Kunci pribadi KUNCI
Versi rahasia 1
Sandi kunci pribadi PASSWORD
Versi rahasia 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. Beri izin ke add-in.
  3. Tentukan 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 Informasi aplikasi, buat client ID dan rahasia klien.
  3. Tentukan nilai untuk Judul, Domain aplikasi, dan URI pengalihan.
  4. Klik Buat.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 ID Aplikasi, masukkan ID klien yang Anda buat sebelumnya, lalu klik Cari. Nilai untuk Judul, Domain Aplikasi, dan URL Pengalihan akan diisi.
  3. Masukkan permintaan izin berikut dalam format XML:
          <AppPermissionRequests AllowAppOnlyPolicy="true">
          <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
          </AppPermissionRequests>
            
  4. Klik Buat. Aplikasi Sharepoint menampilkan dialog izin.
  5. Klik Percayai.

Tentukan kredensial klien OAuth 2.0 di Google Cloud

Saat membuat koneksi di Integration Connectors, Anda harus menentukan detail berikut:

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

  • Di kolom Client ID, masukkan client ID yang disediakan oleh konektor untuk aplikasi yang Anda buat.
  • Di kolom Client Secret, pilih secret Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
  • Di kolom Secret version, pilih versi secret klien.

Otorisasi ulang untuk kode otorisasi

Jika Anda menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi apa pun di aplikasi SharePoint, Anda harus memberikan kembali otorisasi koneksi SharePoint. Untuk memberikan kembali otorisasi 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 otorisasi di bagian Autentikasi. 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 nilai konfigurasi sampel 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 rahasia 1

Menggunakan koneksi SharePoint dalam integrasi

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

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 pustaka dokumen.

Tindakan CheckInDocument

Tindakan ini memungkinkan Anda check in dokumen.

Parameter input tindakan CheckInDocument

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

Tindakan CheckOutDocument

Tindakan ini memungkinkan Anda melakukan checkout file.

Parameter input tindakan CheckOutDocument

Nama parameter Jenis data Wajib Deskripsi
RelativeURL String Ya URL relatif folder.
DocumentName String Ya Nama file yang akan di-check out.

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 dibatalkan.

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.

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) yang akan diupload sebagai file. Gunakan ini untuk mengupload data biner.
HasBytes Boolean Tidak Menentukan apakah konten yang akan diupload bersifat biner. Nilai defaultnya adalah false.

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 pustaka di server SharePoint.
HasBytes Boolean Tidak Menentukan apakah konten harus didownload sebagai byte. Nilai defaultnya adalah false.

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.

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.

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) yang akan diupload sebagai lampiran. Gunakan ini untuk mengupload data biner.
HasBytes Boolean Tidak Menentukan apakah konten yang akan diupload bersifat biner. Nilai defaultnya adalah false.

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.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Menghapus lampiran

Contoh ini menghapus file yang ditentukan.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Check in dalam dokumen

Contoh ini mencatat dokumen.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Melihat file

Contoh ini akan memeriksa file.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Membatalkan check out

Contoh ini membatalkan check out file.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Menyalin file

Contoh ini menyalin file dari satu lokasi ke lokasi lain.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Mengupload file teks

Contoh ini mengupload file teks ke lokasi yang ditentukan.

  1. Dalam 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 ini:

    [{
    "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 berenkode Base64.

  1. Dalam 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 ini:

    [{
    "Status": "Success"
    }]

Contoh - Mendownload file

Contoh ini mendownload file.

  1. Dalam 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 ini:

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

Contoh - Mendownload file biner

Contoh ini mendownload file biner.

  1. Dalam 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 ini:

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

Contoh - Mendownload file dari situs tertentu

Contoh ini mendownload file dari situs tertentu.

  1. Dalam 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": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
      "Library": "Docs",
      "HasBytes": true
    }
    
  4. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DownloadDocument akan memiliki nilai yang mirip dengan berikut:

    [
      {
        "Success": "True",
        "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
      }
    ]

    Untuk mendownload file dari situs tertentu, Anda harus memberikan alamat lengkap file jarak jauh.

Contoh - Memindahkan lampiran

Contoh ini memindahkan lampiran dari satu lokasi ke lokasi lain.

  1. Dalam 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 ini:

    [{
    "Result": "Success"
    }]

Contoh - Membuat folder

Contoh ini membuat folder di lokasi yang ditentukan.

  1. Dalam 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 ini:

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

Contoh - Menambahkan lampiran

Contoh ini menambahkan lampiran ke daftar yang ditentukan.

  1. Dalam 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 ini:

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

Contoh - Menambahkan lampiran biner

Contoh ini menambahkan lampiran biner ke daftar yang ditentukan.

  1. Dalam 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 ini:

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

Contoh - Mendownload lampiran

Contoh ini mendownload lampiran.

  1. Dalam 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 ini:

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

Contoh - Mendownload lampiran biner

Contoh ini mendownload lampiran biner.

  1. Dalam 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 ini:

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

Contoh operasi entity

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

Contoh - Mencantumkan semua file

Contoh ini mencantumkan semua file dalam entitas Files.

  1. Dalam 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 kumpulan 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. Dalam 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 catatan

Contoh ini membuat data dalam entitas My Lists.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih My Lists dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  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 di entitas My Lists.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih My Lists dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 2 di kolom Default Value.
  • 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 Forum Cloud.

Langkah berikutnya