درحال نصب سرویس‌های درآمدزایی

Edge for Private Cloud نسخه ۴.۱۷.۰۹

«سرویس‌های درآمدزایی» افزونه‌ای برای Apigee Edge است، بنابراین به‌عنوان فرایندی مستقل اجرا نمی‌شود. این برنامه در هر راه‌اندازی Apigee Edge موجود اجرا می‌شود.

شرایط درآمدزایی

  • اگر «درآمدزایی» را در توپولوژی Edge نصب می‌کنید که از چند گره «سرور مدیریت» استفاده می‌کند، مثلاً نصب ۱۳ گره، باید هر دو گره «سرور مدیریت» Edge را قبل‌از نصب «درآمدزایی» نصب کنید.
  • برای نصب Monetization on Edge در جایی که نصب Edge چندین گره Postgres دارد، گره‌های Postgres باید در حالت Master/Standby پیکربندی شوند. اگر چند گره اصلی Postgres داشته باشید، نمی‌توانید «درآمدزایی» را در Edge نصب کنید. برای اطلاعات بیشتر، راه‌اندازی تکرار اصلی-آماده‌به‌کار برای Postgres را ببینید.

نمای کلی نصب

مراحل زیر نحوه افزودن «خدمات درآمدزایی» را در نصب Apigee Edge موجود نشان می‌دهد:

  • از ابزار کمکی apigee-setup برای به‌روزرسانی گره «سرور مدیریت Apigee» استفاده کنید تا «سرویس‌های درآمدزایی» فعال شود، برای مثال، مدیریت کاتالوگ، پیکربندی محدودیت‌ها و اعلان‌ها، صورت‌حساب، و گزارش‌دهی.

    اگر چند گره «سرور مدیریت» دارید، مثلاً نصب ۱۳ گره، باید هر دو گره «سرور مدیریت Edge» را قبل‌از نصب «درآمدزایی» نصب کنید.
  • از ابزار کمکی apigee-setup برای به‌روزرسانی «پردازشگر پیام Apigee» استفاده کنید تا مؤلفه‌های زمان اجرای «سرویس‌های درآمدزایی» (برای مثال، خط‌مشی ثبت تراکنش و اجرای محدودیت) فعال شود. اگر چند «پردازشگر پیام» دارید، «درآمدزایی» را در همه آن‌ها نصب کنید.
  • فرایند آماده‌سازی «درآمدزایی» را برای سازمان‌های Edge خود انجام دهید.
  • درگاه «خدمات توسعه‌دهنده» را برای پشتیبانی از درآمدزایی پیکربندی کنید. برای اطلاعات بیشتر، به http://apigee.com/docs/monetization/content/configure-monetization-developer-portal مراجعه کنید.

درحال ایجاد فایل پیکربندی بی‌صدا برای «درآمدزایی»

در زیر نمونه‌ای از فایل پیکربندی بی‌صدا برای نصب «درآمدزایی» نشان داده شده است. این فایل را درصورت لزوم برای پیکربندی‌تان ویرایش کنید. از گزینه f- برای setup.sh استفاده کنید تا این فایل را اضافه کنید.

توجه: معمولاً این ویژگی‌ها را به همان فایل پیکربندی‌ای اضافه می‌کنید که برای نصب Edge استفاده کرده‌اید، همان‌طور که در نصب مؤلفه‌های Edge در گره نشان داده شده است.

# Edge configuration properties
# Specify IP address or DNS name of node.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra
IP2=192.168.1.2  # ZooKeeper, Cassandra
IP3=192.168.1.3  # ZooKeeper, Cassandra
IP4=192.168.1.4  # Router, Message Processor
IP5=192.168.1.5  # Router, Message Processor
IP6=192.168.1.6  # Qpid
IP7=192.168.1.7  # Qpid
IP8=192.168.1.8  # Postgres
IP9=192.168.1.9  # Postgres

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Edge sys admin credentials
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Specify the Management Server port.
APIGEE_PORT_HTTP_MS=8080

#
# Monetization configuration properties.
#
# Postgres credentials from Edge installation.
PG_USER=apigee    # Default from Edge installation
PG_PWD=postgres    # Default from Edge installation

# Specify Postgres server.
MO_PG_HOST="$IP8"    # Only specify one Postgres node.

# Create a Postgres user for Monetization.
# Default username is "postgre". 
# If you specify a different user, that user must already exist.
MO_PG_USER=postgre    
MO_PG_PASSWD=moUserPWord

# Specify one ZooKeeper host.
# Ensure this is a ZooKeeper leader node in a multi-datacenter environment.
ZK_HOSTS="$IP2"

# Specify Cassandra information.
# Ensure CASS_HOSTS is set to the same value as when you installed Edge.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

# Default is "Apigee", unless it was changed during Edge install.  
CASS_CLUSTERNAME=Apigee

# Cassandra uname/pword required only if you enabled Cassandra authentication. 
# CASS_USERNAME= 
# CASS_PASSWORD= 

# Specify the region. 
# Default is dc-1 unless you are in a multi-datacenter environment. 
REGION=dc-1 

# If your Edge config file did not specify SMTP information, add it. 
# Monetization requires an SMTP server. 
SMTPHOST=smtp.gmail.com 
SMTPPORT=465 
SMTPUSER=your@email.com 
SMTPPASSWORD=yourEmailPassword 
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"
نکته‌ها:
  • اگر فایل پیکربندی Edge شما اطلاعات SMTP را مشخص نکرده است، آن را اضافه کنید. درآمدزایی به سرور SMTP نیاز دارد.
  • در نصب مرکز داده تکی، همه گره‌های ZooKeeper به‌طور پیش‌فرض به‌عنوان رهبر پیکربندی می‌شوند. وقتی Edge را در چندین مرکز داده نصب می‌کنید، برخی‌از گره‌های ZooKeeper به‌عنوان ناظر پیکربندی خواهند شد. مطمئن شوید که ویژگی ZK_HOSTS در بالا گره رهبر را در نصب مرکز داده چندگانه مشخص می‌کند.
  • اگر اصالت‌سنجی Cassandra را فعال کنید، می‌توانید نام کاربری و گذرواژه Cassandra را بااستفاده از ویژگی‌های زیر ارسال کنید:
    CASS_USERNAME
    CASS_PASSWORD

ادغام کردن «خدمات درآمدزایی» با همه «سرورهای مدیریت»

از روال زیر برای ادغام درآمدزایی در گره‌های «سرور مدیریت» استفاده کنید.

  1. اگر «درآمدزایی» را در توپولوژی Edge نصب می‌کنید که از چند گره «سرور مدیریت» استفاده می‌کند، مثلاً نصب ۱۳ گره، مطمئن شوید که هر دو گره «سرور مدیریت» را قبل‌از نصب «درآمدزایی» نصب کرده‌اید.
  2. در گره «سرور مدیریت»، دستورگان راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    گزینه «-p mo» مشخص می‌کند که «درآمدزایی» ادغام شود.

    فایل پیکربندی باید برای کاربر «apigee» قابل‌دسترسی یا خواندن باشد.
  3. اگر «درآمدزایی» را در چندین گره «سرور مدیریت» نصب می‌کنید، مرحله ۲ را در گره دوم «سرور مدیریت» تکرار کنید.

درصورت پیکربندی موفق، طرح‌واره RDBMS برای «سرویس‌های درآمدزایی» در پایگاه داده PostgreSQL ایجاد می‌شود. با این کار، ادغام «سرویس‌های درآمدزایی» و مؤلفه‌های مرتبط با آن با Postgres Server تکمیل می‌شود.

ادغام کردن «سرویس‌های درآمدزایی» با همه «پردازشگرهای پیام»

از روال زیر برای ادغام درآمدزایی در همه گره‌های «پردازشگر پیام» استفاده کنید.

  1. در اولین گره «پردازشگر پیام»، در خط فرمان، دستورگان راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    گزینه «-p mo» مشخص می‌کند که «درآمدزایی» ادغام شود.

    فایل پیکربندی باید برای کاربر «apigee» قابل‌دسترسی یا خواندن باشد.
  2. این فرایند را در همه گره‌های «پردازشگر پیام» تکرار کنید.

پس‌از پیکربندی موفق، «پردازشگر پیام» با «سرویس‌های درآمدزایی» به‌روز می‌شود. با این کار، ادغام «سرویس‌های درآمدزایی» و مؤلفه‌های مرتبط با آن با «پردازشگرهای پیام» تکمیل می‌شود.

آماده‌سازی درآمدزایی

برای ایجاد سازمان جدیدی که درآمدزایی در آن فعال باشد، ابتدا سازمان را همان‌طور که برای هر سازمان جدیدی انجام می‌دهید ایجاد می‌کنید. برای اطلاعات بیشتر، به آماده‌سازی سازمان مراجعه کنید.

آماده‌سازی بیشتر برای فعال کردن «درآمدزایی» برای سازمان

برای تکمیل آماده‌سازی درآمدزایی سازمان، باید:

  1. گروه درآمدزایی را ایجاد کنید: mxgroup.
  2. Qpid را به گروه اضافه کنید.
  3. درآمدزایی را برای سازمان فعال کنید.
  4. تنظیمات اعلان را برای سازمان فعال کنید.
  5. این فرایند را برای همه سازمان‌هایی که می‌خواهید «درآمدزایی» را در آن‌ها فعال کنید تکرار کنید.

از فرمان enable-monetization برای انجام همه این کارها استفاده کنید. این دستورگان فایل پیکربندی‌ای را می‌گیرد که حاوی ویژگی‌های زیر است:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

نکته‌ها:

  • CASS_HOSTS و REGION را روی همان مقادیری تنظیم کنید که هنگام نصب «درآمدزایی» استفاده کردید.
  • اگر «درآمدزایی» را در پیکربندی چند مرکز داده فعال می‌کنید:
    • باید فرایند آماده‌سازی را در «سرور مدیریت» در هر مرکز داده تکرار کنید.
    • فایل پیکربندی باید فقط گره‌های Qpid را در مرکز داده‌ای که درحال پیکربندی است فهرست کند.

برای اجرای اسکریپت:

  1. فراخوانی اسکریپت:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    فایل پیکربندی باید برای کاربر «apigee» قابل‌دسترسی یا خواندن باشد.

    اگر چند «سرور مدیریت» دارید، فقط باید این اسکریپت را در یکی‌از آن‌ها اجرا کنید.

    این اسکریپت سازمان، محصولات، توسعه‌دهندگان، و برنامه‌ها را از پایگاه داده Cassandra به پایگاه داده Monetization PostgreSQL تکرار می‌کند. پس‌از نصب موفقیت‌آمیز «سرویس‌های درآمدزایی»، داده‌ها به‌طور خودکار همگام‌سازی می‌شوند.
  2. این روال را برای هر سازمانی که می‌خواهید «درآمدزایی» را در آن فعال کنید تکرار کنید.
  3. اگر در محیطی با چند مرکز داده هستید، این فرایند را در «سرور مدیریت» در مرکز داده دیگر تکرار کنید. مطمئن شوید که فایل پیکربندی فقط گره‌های Qpid را در مرکز داده‌ای که پیکربندی می‌شود فهرست کند.

وقتی دفعه بعد به Edge UI وارد می‌شوید، ورودی «درآمدزایی» را در منو سطح بالا برای سازمان می‌بینید:

پیکربندی درگاه «سرویس‌های توسعه‌دهنده»

برای پیکربندی درگاه Developer Services جهت پشتیبانی از درآمدزایی، به http://apigee.com/docs/monetization/content/configure-monetization-developer-portal مراجعه کنید.

افزودن گره سرور مدیریت به نصب درآمدزایی

اگر «سرور مدیریت» را به نصب Edge موجود اضافه می‌کنید، باید مطمئن شوید که سرویس‌های «درآمدزایی» را به «سرور مدیریت» جدید اضافه می‌کنید و همه «سرورهای مدیریت» را پیکربندی می‌کنید تا بتوانند ارتباط برقرار کنند.

برای افزودن «سرور مدیریت»:

  1. Management Server جدید را نصب کنید.
  2. «درآمدزایی» را در «سرور مدیریت» جدید نصب کنید.
  3. در «سرور مدیریت» اصلی، موارد زیر را فراخوانی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. «سرور مدیریت» اصلی را بازراه‌اندازی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. در Management Server جدید، موارد زیر را فراخوانی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. «سرور مدیریت» جدید را بازراه‌اندازی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

پیکربندی اضافی

اسناد صورت‌حساب را به‌صورت فایل PDF ارائه دهید

«درآمدزایی» اسناد صورت‌حساب را در قالب HTML به کاربران نهایی نشان می‌دهد. برای ارائه اسناد صورت‌حساب به‌صورت فایل PDF، می‌توانید «آماده‌سازی برای درآمدزایی» را با سیستم صورت‌حسابی که تولید PDF را ارائه می‌دهد ادغام کنید یا برای کتابخانه PDF طرف سوم پشتیبانی‌شده پروانه بگیرید.

پیکربندی تنظیمات سازمان

تنظیمات باطن: جدول زیر مشخصه‌های سطح سازمان را فهرست می‌کند که برای پیکربندی سازمان mint دردسترس هستند. می‌توانید از تماس PUT برای افزودن/به‌روزرسانی این مشخصه‌ها استفاده کنید، همان‌طور که در زیر نشان داده شده است:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

برای مثال، خروجی فرمان CURL بالا چیزی شبیه به این خواهد بود:

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

مشخصه‌ها

شرح

MINT_TAX_MODEL

مقادیر پذیرفتنی عبارت‌اند از DISCLOSED،

UNDISCLOSED،‏ HYBRID (پیش‌فرض تهی است)

MINT_CURRENCY

کد ارز ISO (پیش‌فرض تهی است)

MINT_TAX_NEXUS

پیوند مالیاتی (پیش‌فرض تهی است)

MINT_DEFAULT_PROD_TAX_CATEGORY

دسته مالیاتی محصول پیش‌فرض (پیش‌فرض تهی است)

MINT_IS_GROUP_ORG

سازمان گروه IS (پیش‌فرض نادرست است)

MINT_HAS_BROKER

خراب است (پیش‌فرض نادرست است)

MINT_TIMEZONE

منطقه زمانی (پیش‌فرض تهی است)

MINT_TAX_ENGINE_EXTERNAL_ID

شناسه موتور مالیاتی (پیش‌فرض تهی است)

MINT_COUNTRY

کشور سازمان (پیش‌فرض null است)

MINT_REG_NO

شماره ثبت سازمان، بریتانیا شماره‌ای متفاوت از شناسه مالیاتی ارائه می‌دهد (پیش‌فرض null است)

MINT_BILLING_CYCLE_TYPE

PRORATED, CALENDAR_MONTH (default is CALENDAR_MONTH)

MINT_SUPPORTED_BILLING_TYPE

PREPAID/POSTPAID/BOTH (پیش‌فرض PREPAID است)

MINT_IS_SEPARATE_INV_FOR_FEES

نشان می‌دهد که آیا باید صورت‌حساب کارمزد جداگانه‌ای تولید شود (پیش‌فرض نادرست است)

MINT_ISSUE_NETTING_STMT

نشان می‌دهد که آیا صورت‌حساب خالص‌سازی باید صادر شود یا نه (پیش‌فرض نادرست است)

MINT_NETTING_STMT_PER_CURRENCY

نشان می‌دهد که آیا صورت‌حساب تهاتر باید برای هر ارز تولید شود یا نه (پیش‌فرض نادرست است)

MINT_HAS_SELF_BILLING

نشان می‌دهد که آیا سازمان صورت‌حساب خودکار دارد یا نه (پیش‌فرض نادرست است)

MINT_SELF_BILLING_FOR_ALL_DEV

نشان می‌دهد که آیا سازمان برای همه توسعه‌دهندگان صورت‌حساب خودکار دارد یا نه(پیش‌فرض نادرست است)

MINT_HAS_SEPARATE_INV_FOR_PROD

نشان می‌دهد که آیا سازمان برای هر محصول صورت‌حساب جداگانه دارد یا نه (پیش‌فرض نادرست است)

MINT_HAS_BILLING_ADJUSTMENT

نشان می‌دهد که آیا سازمان از اصلاح صورت‌حساب پشتیبانی می‌کند یا نه (پیش‌فرض «نادرست» است)

features.isMonetizationEnabled

توسط میانای کاربر مدیریت برای نمایش منو خاص درآمدزایی استفاده می‌شود (پیش‌فرض نادرست است)

ui.config.isOperator

توسط میانای کاربر مدیریت برای نمایش ارائه‌دهنده به‌عنوان «اپراتور» درمقابل «سازمان» استفاده می‌شود

(پیش‌فرض true است)

برای پیکربندی تنظیمات سازمان کسب‌وکار بااستفاده از میانای کاربری مدیریت، به http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services مراجعه کنید.

توجه: اگر از ویژگی‌های «اعلان‌ها و محدودیت‌های سرویس‌های درآمدزایی» استفاده می‌کنید، لطفاً به توسعه‌دهندگان خود دستور دهید که یک «خط‌مشی محدودیت» را در جریان پیشکار پس‌از خط‌مشی اعتبارسنجی کد دسترسی پیوست کنند.

«خط‌مشی محدودیت» خط‌مشی صریحی است که برای مسدود کردن فراخوانی میانای برنامه‌سازی کاربردی درصورت رسیدن به محدودیت خاصی طراحی شده است. این خط‌مشی محدودیت‌های کسب‌وکار را بررسی می‌کند و اگر محدودیتی از مقدار پیکربندی‌شده فراتر رود، خطا ایجاد می‌کند. این افزونه‌ای از خط‌مشی ایجاد خطا است اما شرایط از متغیرهای کسب‌وکار مشتق شده است.

یک الگوی واسط کاربر در واسط کاربر مدیریت برای توسعه‌دهندگان پراکسی دردسترس است. توسعه‌دهنده پراکسی باید خط‌مشی mint را در جریان پیام پیوست کند. پس‌از اجرای این خط‌مشی، خطا با پاسخ خطا طبق خط‌مشی مطرح خواهد شد. اگر ContinueOnError روی true تنظیم شده باشد، خطا ایجاد نخواهد شد و متغیرهای جریان «mint.limitsViolated»، «mint.isDeveloperSuspended»، و «mint.limitsPolicyError» تنظیم خواهند شد که درصورت نیاز می‌توان از آن‌ها برای رسیدگی بیشتر به استثنا استفاده کرد.